blob: ef0515c36e0cc8d9910aef38194a59f79540c00d [file] [log] [blame]
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001//===------- CGObjCMac.cpp - Interface to Apple Objective-C Runtime -------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
Chris Lattner57540c52011-04-15 05:22:18 +000010// This provides Objective-C code generation targeting the Apple runtime.
Daniel Dunbar303e2c22008-08-11 02:45:11 +000011//
12//===----------------------------------------------------------------------===//
13
14#include "CGObjCRuntime.h"
John McCallad7c5c12011-02-08 08:22:06 +000015#include "CGBlocks.h"
John McCalled1ae862011-01-28 11:13:47 +000016#include "CGCleanup.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "CGRecordLayout.h"
18#include "CodeGenFunction.h"
19#include "CodeGenModule.h"
Daniel Dunbar8b8683f2008-08-12 00:12:39 +000020#include "clang/AST/ASTContext.h"
Daniel Dunbar221fa942008-08-11 04:54:23 +000021#include "clang/AST/Decl.h"
Daniel Dunbarb036db82008-08-13 03:21:16 +000022#include "clang/AST/DeclObjC.h"
Anders Carlsson15b73de2009-07-18 19:43:29 +000023#include "clang/AST/RecordLayout.h"
Chris Lattnerf0b64d72009-04-26 01:32:48 +000024#include "clang/AST/StmtObjC.h"
Daniel Dunbar3ad53482008-08-11 21:35:06 +000025#include "clang/Basic/LangOptions.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000026#include "clang/CodeGen/CGFunctionInfo.h"
Chandler Carruth85098242010-06-15 23:19:56 +000027#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000028#include "llvm/ADT/DenseSet.h"
29#include "llvm/ADT/SetVector.h"
30#include "llvm/ADT/SmallPtrSet.h"
31#include "llvm/ADT/SmallString.h"
Chandler Carruthc80ceea2014-03-04 11:02:08 +000032#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000033#include "llvm/IR/DataLayout.h"
34#include "llvm/IR/InlineAsm.h"
35#include "llvm/IR/IntrinsicInst.h"
36#include "llvm/IR/LLVMContext.h"
37#include "llvm/IR/Module.h"
Daniel Dunbard027a922009-09-07 00:20:42 +000038#include "llvm/Support/raw_ostream.h"
Torok Edwindb714922009-08-24 13:25:12 +000039#include <cstdio>
Daniel Dunbar303e2c22008-08-11 02:45:11 +000040
41using namespace clang;
Daniel Dunbar41cf9de2008-09-09 01:06:48 +000042using namespace CodeGen;
Daniel Dunbar303e2c22008-08-11 02:45:11 +000043
44namespace {
Daniel Dunbar8b8683f2008-08-12 00:12:39 +000045
Daniel Dunbar59e476b2009-08-03 17:06:42 +000046// FIXME: We should find a nicer way to make the labels for metadata, string
47// concatenation is lame.
Daniel Dunbarb036db82008-08-13 03:21:16 +000048
Fariborz Jahanian279eda62009-01-21 22:04:16 +000049class ObjCCommonTypesHelper {
Owen Anderson170229f2009-07-14 23:10:40 +000050protected:
51 llvm::LLVMContext &VMContext;
Daniel Dunbar59e476b2009-08-03 17:06:42 +000052
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000053private:
John McCall9dc0db22011-05-15 01:53:33 +000054 // The types of these functions don't really matter because we
55 // should always bitcast before calling them.
56
57 /// id objc_msgSend (id, SEL, ...)
58 ///
59 /// The default messenger, used for sends whose ABI is unchanged from
60 /// the all-integer/pointer case.
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000061 llvm::Constant *getMessageSendFn() const {
John McCall31168b02011-06-15 23:02:42 +000062 // Add the non-lazy-bind attribute, since objc_msgSend is likely to
63 // be called a lot.
Chris Lattnera5f58b02011-07-09 17:41:47 +000064 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
Bill Wendling8594fcb2013-01-31 00:30:05 +000065 return
66 CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
67 params, true),
68 "objc_msgSend",
69 llvm::AttributeSet::get(CGM.getLLVMContext(),
70 llvm::AttributeSet::FunctionIndex,
71 llvm::Attribute::NonLazyBind));
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000072 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +000073
John McCall9dc0db22011-05-15 01:53:33 +000074 /// void objc_msgSend_stret (id, SEL, ...)
75 ///
76 /// The messenger used when the return value is an aggregate returned
77 /// by indirect reference in the first argument, and therefore the
78 /// self and selector parameters are shifted over by one.
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000079 llvm::Constant *getMessageSendStretFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +000080 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall9dc0db22011-05-15 01:53:33 +000081 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.VoidTy,
82 params, true),
83 "objc_msgSend_stret");
Daniel Dunbar59e476b2009-08-03 17:06:42 +000084
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000085 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +000086
John McCall9dc0db22011-05-15 01:53:33 +000087 /// [double | long double] objc_msgSend_fpret(id self, SEL op, ...)
88 ///
89 /// The messenger used when the return value is returned on the x87
90 /// floating-point stack; without a special entrypoint, the nil case
91 /// would be unbalanced.
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000092 llvm::Constant *getMessageSendFpretFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +000093 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
Chris Lattnerece04092012-02-07 00:39:47 +000094 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.DoubleTy,
95 params, true),
John McCall9dc0db22011-05-15 01:53:33 +000096 "objc_msgSend_fpret");
Daniel Dunbar59e476b2009-08-03 17:06:42 +000097
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000098 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +000099
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000100 /// _Complex long double objc_msgSend_fp2ret(id self, SEL op, ...)
101 ///
102 /// The messenger used when the return value is returned in two values on the
103 /// x87 floating point stack; without a special entrypoint, the nil case
104 /// would be unbalanced. Only used on 64-bit X86.
105 llvm::Constant *getMessageSendFp2retFn() const {
106 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
107 llvm::Type *longDoubleType = llvm::Type::getX86_FP80Ty(VMContext);
108 llvm::Type *resultType =
Reid Kleckneree7cf842014-12-01 22:02:27 +0000109 llvm::StructType::get(longDoubleType, longDoubleType, nullptr);
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000110
111 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(resultType,
112 params, true),
113 "objc_msgSend_fp2ret");
114 }
115
John McCall9dc0db22011-05-15 01:53:33 +0000116 /// id objc_msgSendSuper(struct objc_super *super, SEL op, ...)
117 ///
118 /// The messenger used for super calls, which have different dispatch
119 /// semantics. The class passed is the superclass of the current
120 /// class.
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000121 llvm::Constant *getMessageSendSuperFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000122 llvm::Type *params[] = { SuperPtrTy, SelectorPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000123 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000124 params, true),
125 "objc_msgSendSuper");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000126 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000127
John McCall9dc0db22011-05-15 01:53:33 +0000128 /// id objc_msgSendSuper2(struct objc_super *super, SEL op, ...)
129 ///
130 /// A slightly different messenger used for super calls. The class
131 /// passed is the current class.
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000132 llvm::Constant *getMessageSendSuperFn2() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000133 llvm::Type *params[] = { SuperPtrTy, SelectorPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000134 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000135 params, true),
136 "objc_msgSendSuper2");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000137 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000138
John McCall9dc0db22011-05-15 01:53:33 +0000139 /// void objc_msgSendSuper_stret(void *stretAddr, struct objc_super *super,
140 /// SEL op, ...)
141 ///
142 /// The messenger used for super calls which return an aggregate indirectly.
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000143 llvm::Constant *getMessageSendSuperStretFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000144 llvm::Type *params[] = { Int8PtrTy, SuperPtrTy, SelectorPtrTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000145 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000146 llvm::FunctionType::get(CGM.VoidTy, params, true),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000147 "objc_msgSendSuper_stret");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000148 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000149
John McCall9dc0db22011-05-15 01:53:33 +0000150 /// void objc_msgSendSuper2_stret(void * stretAddr, struct objc_super *super,
151 /// SEL op, ...)
152 ///
153 /// objc_msgSendSuper_stret with the super2 semantics.
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000154 llvm::Constant *getMessageSendSuperStretFn2() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000155 llvm::Type *params[] = { Int8PtrTy, SuperPtrTy, SelectorPtrTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000156 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000157 llvm::FunctionType::get(CGM.VoidTy, params, true),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000158 "objc_msgSendSuper2_stret");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000159 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000160
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000161 llvm::Constant *getMessageSendSuperFpretFn() const {
162 // There is no objc_msgSendSuper_fpret? How can that work?
163 return getMessageSendSuperFn();
164 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000165
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000166 llvm::Constant *getMessageSendSuperFpretFn2() const {
167 // There is no objc_msgSendSuper_fpret? How can that work?
168 return getMessageSendSuperFn2();
169 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000170
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000171protected:
172 CodeGen::CodeGenModule &CGM;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000173
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000174public:
Chris Lattnera5f58b02011-07-09 17:41:47 +0000175 llvm::Type *ShortTy, *IntTy, *LongTy, *LongLongTy;
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000176 llvm::Type *Int8PtrTy, *Int8PtrPtrTy;
Tim Northover238b5082014-03-29 13:42:40 +0000177 llvm::Type *IvarOffsetVarTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000178
Daniel Dunbar5d715592008-08-12 05:28:47 +0000179 /// ObjectPtrTy - LLVM type for object handles (typeof(id))
Chris Lattnera5f58b02011-07-09 17:41:47 +0000180 llvm::Type *ObjectPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000181
Fariborz Jahanian406b1172008-11-18 20:18:11 +0000182 /// PtrObjectPtrTy - LLVM type for id *
Chris Lattnera5f58b02011-07-09 17:41:47 +0000183 llvm::Type *PtrObjectPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000184
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000185 /// SelectorPtrTy - LLVM type for selector handles (typeof(SEL))
Chris Lattnera5f58b02011-07-09 17:41:47 +0000186 llvm::Type *SelectorPtrTy;
Douglas Gregor020de322012-01-17 18:36:30 +0000187
188private:
Daniel Dunbarb036db82008-08-13 03:21:16 +0000189 /// ProtocolPtrTy - LLVM type for external protocol handles
190 /// (typeof(Protocol))
Chris Lattnera5f58b02011-07-09 17:41:47 +0000191 llvm::Type *ExternalProtocolPtrTy;
Douglas Gregor020de322012-01-17 18:36:30 +0000192
193public:
194 llvm::Type *getExternalProtocolPtrTy() {
195 if (!ExternalProtocolPtrTy) {
196 // FIXME: It would be nice to unify this with the opaque type, so that the
197 // IR comes out a bit cleaner.
198 CodeGen::CodeGenTypes &Types = CGM.getTypes();
199 ASTContext &Ctx = CGM.getContext();
200 llvm::Type *T = Types.ConvertType(Ctx.getObjCProtoType());
201 ExternalProtocolPtrTy = llvm::PointerType::getUnqual(T);
202 }
203
204 return ExternalProtocolPtrTy;
205 }
206
Daniel Dunbarc722b852008-08-30 03:02:31 +0000207 // SuperCTy - clang type for struct objc_super.
208 QualType SuperCTy;
209 // SuperPtrCTy - clang type for struct objc_super *.
210 QualType SuperPtrCTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000211
Daniel Dunbarf6397fe2008-08-23 04:28:29 +0000212 /// SuperTy - LLVM type for struct objc_super.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000213 llvm::StructType *SuperTy;
Daniel Dunbar97ff50d2008-08-23 09:25:55 +0000214 /// SuperPtrTy - LLVM type for struct objc_super *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000215 llvm::Type *SuperPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000216
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000217 /// PropertyTy - LLVM type for struct objc_property (struct _prop_t
218 /// in GCC parlance).
Chris Lattnera5f58b02011-07-09 17:41:47 +0000219 llvm::StructType *PropertyTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000220
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000221 /// PropertyListTy - LLVM type for struct objc_property_list
222 /// (_prop_list_t in GCC parlance).
Chris Lattnera5f58b02011-07-09 17:41:47 +0000223 llvm::StructType *PropertyListTy;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000224 /// PropertyListPtrTy - LLVM type for struct objc_property_list*.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000225 llvm::Type *PropertyListPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000226
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000227 // MethodTy - LLVM type for struct objc_method.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000228 llvm::StructType *MethodTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000229
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000230 /// CacheTy - LLVM type for struct objc_cache.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000231 llvm::Type *CacheTy;
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000232 /// CachePtrTy - LLVM type for struct objc_cache *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000233 llvm::Type *CachePtrTy;
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +0000234
Chris Lattnerce8754e2009-04-22 02:44:54 +0000235 llvm::Constant *getGetPropertyFn() {
236 CodeGen::CodeGenTypes &Types = CGM.getTypes();
237 ASTContext &Ctx = CGM.getContext();
238 // id objc_getProperty (id, SEL, ptrdiff_t, bool)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000239 SmallVector<CanQualType,4> Params;
John McCall2da83a32010-02-26 00:48:12 +0000240 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
241 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
Chris Lattnerce8754e2009-04-22 02:44:54 +0000242 Params.push_back(IdType);
243 Params.push_back(SelType);
David Chisnall08a45252011-03-22 20:03:13 +0000244 Params.push_back(Ctx.getPointerDiffType()->getCanonicalTypeUnqualified());
Chris Lattnerce8754e2009-04-22 02:44:54 +0000245 Params.push_back(Ctx.BoolTy);
Chris Lattner2192fe52011-07-18 04:24:23 +0000246 llvm::FunctionType *FTy =
Peter Collingbournef7706832014-12-12 23:41:25 +0000247 Types.GetFunctionType(Types.arrangeLLVMFunctionInfo(
248 IdType, false, false, Params, FunctionType::ExtInfo(),
249 RequiredArgs::All));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000250 return CGM.CreateRuntimeFunction(FTy, "objc_getProperty");
251 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000252
Chris Lattnerce8754e2009-04-22 02:44:54 +0000253 llvm::Constant *getSetPropertyFn() {
254 CodeGen::CodeGenTypes &Types = CGM.getTypes();
255 ASTContext &Ctx = CGM.getContext();
256 // void objc_setProperty (id, SEL, ptrdiff_t, id, bool, bool)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000257 SmallVector<CanQualType,6> Params;
John McCall2da83a32010-02-26 00:48:12 +0000258 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
259 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
Chris Lattnerce8754e2009-04-22 02:44:54 +0000260 Params.push_back(IdType);
261 Params.push_back(SelType);
David Chisnall08a45252011-03-22 20:03:13 +0000262 Params.push_back(Ctx.getPointerDiffType()->getCanonicalTypeUnqualified());
Chris Lattnerce8754e2009-04-22 02:44:54 +0000263 Params.push_back(IdType);
264 Params.push_back(Ctx.BoolTy);
265 Params.push_back(Ctx.BoolTy);
Chris Lattner2192fe52011-07-18 04:24:23 +0000266 llvm::FunctionType *FTy =
Peter Collingbournef7706832014-12-12 23:41:25 +0000267 Types.GetFunctionType(Types.arrangeLLVMFunctionInfo(
268 Ctx.VoidTy, false, false, Params, FunctionType::ExtInfo(),
269 RequiredArgs::All));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000270 return CGM.CreateRuntimeFunction(FTy, "objc_setProperty");
271 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000272
Ted Kremeneke65b0862012-03-06 20:05:56 +0000273 llvm::Constant *getOptimizedSetPropertyFn(bool atomic, bool copy) {
274 CodeGen::CodeGenTypes &Types = CGM.getTypes();
275 ASTContext &Ctx = CGM.getContext();
276 // void objc_setProperty_atomic(id self, SEL _cmd,
277 // id newValue, ptrdiff_t offset);
278 // void objc_setProperty_nonatomic(id self, SEL _cmd,
279 // id newValue, ptrdiff_t offset);
280 // void objc_setProperty_atomic_copy(id self, SEL _cmd,
281 // id newValue, ptrdiff_t offset);
282 // void objc_setProperty_nonatomic_copy(id self, SEL _cmd,
283 // id newValue, ptrdiff_t offset);
284
285 SmallVector<CanQualType,4> Params;
286 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
287 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
288 Params.push_back(IdType);
289 Params.push_back(SelType);
290 Params.push_back(IdType);
291 Params.push_back(Ctx.getPointerDiffType()->getCanonicalTypeUnqualified());
292 llvm::FunctionType *FTy =
Peter Collingbournef7706832014-12-12 23:41:25 +0000293 Types.GetFunctionType(Types.arrangeLLVMFunctionInfo(
294 Ctx.VoidTy, false, false, Params, FunctionType::ExtInfo(),
295 RequiredArgs::All));
Ted Kremeneke65b0862012-03-06 20:05:56 +0000296 const char *name;
297 if (atomic && copy)
298 name = "objc_setProperty_atomic_copy";
299 else if (atomic && !copy)
300 name = "objc_setProperty_atomic";
301 else if (!atomic && copy)
302 name = "objc_setProperty_nonatomic_copy";
303 else
304 name = "objc_setProperty_nonatomic";
305
306 return CGM.CreateRuntimeFunction(FTy, name);
307 }
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000308
309 llvm::Constant *getCopyStructFn() {
310 CodeGen::CodeGenTypes &Types = CGM.getTypes();
311 ASTContext &Ctx = CGM.getContext();
312 // void objc_copyStruct (void *, const void *, size_t, bool, bool)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000313 SmallVector<CanQualType,5> Params;
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000314 Params.push_back(Ctx.VoidPtrTy);
315 Params.push_back(Ctx.VoidPtrTy);
316 Params.push_back(Ctx.LongTy);
317 Params.push_back(Ctx.BoolTy);
318 Params.push_back(Ctx.BoolTy);
Chris Lattner2192fe52011-07-18 04:24:23 +0000319 llvm::FunctionType *FTy =
Peter Collingbournef7706832014-12-12 23:41:25 +0000320 Types.GetFunctionType(Types.arrangeLLVMFunctionInfo(
321 Ctx.VoidTy, false, false, Params, FunctionType::ExtInfo(),
322 RequiredArgs::All));
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000323 return CGM.CreateRuntimeFunction(FTy, "objc_copyStruct");
324 }
325
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +0000326 /// This routine declares and returns address of:
327 /// void objc_copyCppObjectAtomic(
328 /// void *dest, const void *src,
329 /// void (*copyHelper) (void *dest, const void *source));
330 llvm::Constant *getCppAtomicObjectFunction() {
331 CodeGen::CodeGenTypes &Types = CGM.getTypes();
332 ASTContext &Ctx = CGM.getContext();
333 /// void objc_copyCppObjectAtomic(void *dest, const void *src, void *helper);
334 SmallVector<CanQualType,3> Params;
335 Params.push_back(Ctx.VoidPtrTy);
336 Params.push_back(Ctx.VoidPtrTy);
337 Params.push_back(Ctx.VoidPtrTy);
338 llvm::FunctionType *FTy =
Peter Collingbournef7706832014-12-12 23:41:25 +0000339 Types.GetFunctionType(Types.arrangeLLVMFunctionInfo(Ctx.VoidTy, false, false,
Reid Kleckner4982b822014-01-31 22:54:50 +0000340 Params,
341 FunctionType::ExtInfo(),
John McCall8dda7b22012-07-07 06:41:13 +0000342 RequiredArgs::All));
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +0000343 return CGM.CreateRuntimeFunction(FTy, "objc_copyCppObjectAtomic");
344 }
345
Chris Lattnerce8754e2009-04-22 02:44:54 +0000346 llvm::Constant *getEnumerationMutationFn() {
Daniel Dunbar9d82da42009-07-11 20:32:50 +0000347 CodeGen::CodeGenTypes &Types = CGM.getTypes();
348 ASTContext &Ctx = CGM.getContext();
Chris Lattnerce8754e2009-04-22 02:44:54 +0000349 // void objc_enumerationMutation (id)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000350 SmallVector<CanQualType,1> Params;
John McCall2da83a32010-02-26 00:48:12 +0000351 Params.push_back(Ctx.getCanonicalParamType(Ctx.getObjCIdType()));
Chris Lattner2192fe52011-07-18 04:24:23 +0000352 llvm::FunctionType *FTy =
Peter Collingbournef7706832014-12-12 23:41:25 +0000353 Types.GetFunctionType(Types.arrangeLLVMFunctionInfo(
354 Ctx.VoidTy, false, false, Params, FunctionType::ExtInfo(),
355 RequiredArgs::All));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000356 return CGM.CreateRuntimeFunction(FTy, "objc_enumerationMutation");
357 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000358
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000359 /// GcReadWeakFn -- LLVM objc_read_weak (id *src) function.
Chris Lattnerce8754e2009-04-22 02:44:54 +0000360 llvm::Constant *getGcReadWeakFn() {
361 // id objc_read_weak (id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000362 llvm::Type *args[] = { ObjectPtrTy->getPointerTo() };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000363 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000364 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattnerce8754e2009-04-22 02:44:54 +0000365 return CGM.CreateRuntimeFunction(FTy, "objc_read_weak");
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000366 }
367
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000368 /// GcAssignWeakFn -- LLVM objc_assign_weak function.
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000369 llvm::Constant *getGcAssignWeakFn() {
370 // id objc_assign_weak (id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000371 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000372 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000373 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000374 return CGM.CreateRuntimeFunction(FTy, "objc_assign_weak");
375 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000376
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000377 /// GcAssignGlobalFn -- LLVM objc_assign_global function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000378 llvm::Constant *getGcAssignGlobalFn() {
379 // id objc_assign_global(id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000380 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000381 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000382 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000383 return CGM.CreateRuntimeFunction(FTy, "objc_assign_global");
384 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000385
Fariborz Jahanian217af242010-07-20 20:30:03 +0000386 /// GcAssignThreadLocalFn -- LLVM objc_assign_threadlocal function.
387 llvm::Constant *getGcAssignThreadLocalFn() {
388 // id objc_assign_threadlocal(id src, id * dest)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000389 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Fariborz Jahanian217af242010-07-20 20:30:03 +0000390 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000391 llvm::FunctionType::get(ObjectPtrTy, args, false);
Fariborz Jahanian217af242010-07-20 20:30:03 +0000392 return CGM.CreateRuntimeFunction(FTy, "objc_assign_threadlocal");
393 }
394
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000395 /// GcAssignIvarFn -- LLVM objc_assign_ivar function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000396 llvm::Constant *getGcAssignIvarFn() {
Fariborz Jahanian7a95d722009-09-24 22:25:38 +0000397 // id objc_assign_ivar(id, id *, ptrdiff_t)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000398 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo(),
399 CGM.PtrDiffTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000400 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000401 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000402 return CGM.CreateRuntimeFunction(FTy, "objc_assign_ivar");
403 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000404
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +0000405 /// GcMemmoveCollectableFn -- LLVM objc_memmove_collectable function.
406 llvm::Constant *GcMemmoveCollectableFn() {
407 // void *objc_memmove_collectable(void *dst, const void *src, size_t size)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000408 llvm::Type *args[] = { Int8PtrTy, Int8PtrTy, LongTy };
John McCall9dc0db22011-05-15 01:53:33 +0000409 llvm::FunctionType *FTy = llvm::FunctionType::get(Int8PtrTy, args, false);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +0000410 return CGM.CreateRuntimeFunction(FTy, "objc_memmove_collectable");
411 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000412
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000413 /// GcAssignStrongCastFn -- LLVM objc_assign_strongCast function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000414 llvm::Constant *getGcAssignStrongCastFn() {
Fariborz Jahanian217af242010-07-20 20:30:03 +0000415 // id objc_assign_strongCast(id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000416 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000417 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000418 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000419 return CGM.CreateRuntimeFunction(FTy, "objc_assign_strongCast");
420 }
Anders Carlsson9ab53d12009-02-16 22:59:18 +0000421
422 /// ExceptionThrowFn - LLVM objc_exception_throw function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000423 llvm::Constant *getExceptionThrowFn() {
424 // void objc_exception_throw(id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000425 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattner0a696a422009-04-22 02:38:11 +0000426 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000427 llvm::FunctionType::get(CGM.VoidTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000428 return CGM.CreateRuntimeFunction(FTy, "objc_exception_throw");
429 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000430
Fariborz Jahanian3336de12010-05-28 17:34:43 +0000431 /// ExceptionRethrowFn - LLVM objc_exception_rethrow function.
432 llvm::Constant *getExceptionRethrowFn() {
433 // void objc_exception_rethrow(void)
John McCall9dc0db22011-05-15 01:53:33 +0000434 llvm::FunctionType *FTy = llvm::FunctionType::get(CGM.VoidTy, false);
Fariborz Jahanian3336de12010-05-28 17:34:43 +0000435 return CGM.CreateRuntimeFunction(FTy, "objc_exception_rethrow");
436 }
437
Daniel Dunbar94ceb612009-02-24 01:43:46 +0000438 /// SyncEnterFn - LLVM object_sync_enter function.
Chris Lattnerdcceee72009-04-06 16:53:45 +0000439 llvm::Constant *getSyncEnterFn() {
Aaron Ballman9c004462012-09-06 16:44:16 +0000440 // int objc_sync_enter (id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000441 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattnerdcceee72009-04-06 16:53:45 +0000442 llvm::FunctionType *FTy =
Aaron Ballman9c004462012-09-06 16:44:16 +0000443 llvm::FunctionType::get(CGM.IntTy, args, false);
Chris Lattnerdcceee72009-04-06 16:53:45 +0000444 return CGM.CreateRuntimeFunction(FTy, "objc_sync_enter");
445 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000446
Daniel Dunbar94ceb612009-02-24 01:43:46 +0000447 /// SyncExitFn - LLVM object_sync_exit function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000448 llvm::Constant *getSyncExitFn() {
Aaron Ballman9c004462012-09-06 16:44:16 +0000449 // int objc_sync_exit (id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000450 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattner0a696a422009-04-22 02:38:11 +0000451 llvm::FunctionType *FTy =
Aaron Ballman9c004462012-09-06 16:44:16 +0000452 llvm::FunctionType::get(CGM.IntTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000453 return CGM.CreateRuntimeFunction(FTy, "objc_sync_exit");
454 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000455
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000456 llvm::Constant *getSendFn(bool IsSuper) const {
457 return IsSuper ? getMessageSendSuperFn() : getMessageSendFn();
458 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000459
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000460 llvm::Constant *getSendFn2(bool IsSuper) const {
461 return IsSuper ? getMessageSendSuperFn2() : getMessageSendFn();
462 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000463
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000464 llvm::Constant *getSendStretFn(bool IsSuper) const {
465 return IsSuper ? getMessageSendSuperStretFn() : getMessageSendStretFn();
466 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000467
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000468 llvm::Constant *getSendStretFn2(bool IsSuper) const {
469 return IsSuper ? getMessageSendSuperStretFn2() : getMessageSendStretFn();
470 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000471
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000472 llvm::Constant *getSendFpretFn(bool IsSuper) const {
473 return IsSuper ? getMessageSendSuperFpretFn() : getMessageSendFpretFn();
474 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000475
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000476 llvm::Constant *getSendFpretFn2(bool IsSuper) const {
477 return IsSuper ? getMessageSendSuperFpretFn2() : getMessageSendFpretFn();
478 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000479
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000480 llvm::Constant *getSendFp2retFn(bool IsSuper) const {
481 return IsSuper ? getMessageSendSuperFn() : getMessageSendFp2retFn();
482 }
483
484 llvm::Constant *getSendFp2RetFn2(bool IsSuper) const {
485 return IsSuper ? getMessageSendSuperFn2() : getMessageSendFp2retFn();
486 }
487
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000488 ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000489};
Daniel Dunbarf6397fe2008-08-23 04:28:29 +0000490
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000491/// ObjCTypesHelper - Helper class that encapsulates lazy
492/// construction of varies types used during ObjC generation.
493class ObjCTypesHelper : public ObjCCommonTypesHelper {
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000494public:
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000495 /// SymtabTy - LLVM type for struct objc_symtab.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000496 llvm::StructType *SymtabTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000497 /// SymtabPtrTy - LLVM type for struct objc_symtab *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000498 llvm::Type *SymtabPtrTy;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000499 /// ModuleTy - LLVM type for struct objc_module.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000500 llvm::StructType *ModuleTy;
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000501
Daniel Dunbarb036db82008-08-13 03:21:16 +0000502 /// ProtocolTy - LLVM type for struct objc_protocol.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000503 llvm::StructType *ProtocolTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000504 /// ProtocolPtrTy - LLVM type for struct objc_protocol *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000505 llvm::Type *ProtocolPtrTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000506 /// ProtocolExtensionTy - LLVM type for struct
507 /// objc_protocol_extension.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000508 llvm::StructType *ProtocolExtensionTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000509 /// ProtocolExtensionTy - LLVM type for struct
510 /// objc_protocol_extension *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000511 llvm::Type *ProtocolExtensionPtrTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000512 /// MethodDescriptionTy - LLVM type for struct
513 /// objc_method_description.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000514 llvm::StructType *MethodDescriptionTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000515 /// MethodDescriptionListTy - LLVM type for struct
516 /// objc_method_description_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000517 llvm::StructType *MethodDescriptionListTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000518 /// MethodDescriptionListPtrTy - LLVM type for struct
519 /// objc_method_description_list *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000520 llvm::Type *MethodDescriptionListPtrTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000521 /// ProtocolListTy - LLVM type for struct objc_property_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000522 llvm::StructType *ProtocolListTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000523 /// ProtocolListPtrTy - LLVM type for struct objc_property_list*.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000524 llvm::Type *ProtocolListPtrTy;
Daniel Dunbar938a77f2008-08-22 20:34:54 +0000525 /// CategoryTy - LLVM type for struct objc_category.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000526 llvm::StructType *CategoryTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000527 /// ClassTy - LLVM type for struct objc_class.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000528 llvm::StructType *ClassTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000529 /// ClassPtrTy - LLVM type for struct objc_class *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000530 llvm::Type *ClassPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000531 /// ClassExtensionTy - LLVM type for struct objc_class_ext.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000532 llvm::StructType *ClassExtensionTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000533 /// ClassExtensionPtrTy - LLVM type for struct objc_class_ext *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000534 llvm::Type *ClassExtensionPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000535 // IvarTy - LLVM type for struct objc_ivar.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000536 llvm::StructType *IvarTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000537 /// IvarListTy - LLVM type for struct objc_ivar_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000538 llvm::Type *IvarListTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000539 /// IvarListPtrTy - LLVM type for struct objc_ivar_list *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000540 llvm::Type *IvarListPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000541 /// MethodListTy - LLVM type for struct objc_method_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000542 llvm::Type *MethodListTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000543 /// MethodListPtrTy - LLVM type for struct objc_method_list *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000544 llvm::Type *MethodListPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000545
Anders Carlsson9ff22482008-09-09 10:10:21 +0000546 /// ExceptionDataTy - LLVM type for struct _objc_exception_data.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000547 llvm::Type *ExceptionDataTy;
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +0000548
Anders Carlsson9ff22482008-09-09 10:10:21 +0000549 /// ExceptionTryEnterFn - LLVM objc_exception_try_enter function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000550 llvm::Constant *getExceptionTryEnterFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000551 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000552 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000553 llvm::FunctionType::get(CGM.VoidTy, params, false),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000554 "objc_exception_try_enter");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000555 }
Anders Carlsson9ff22482008-09-09 10:10:21 +0000556
557 /// ExceptionTryExitFn - LLVM objc_exception_try_exit function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000558 llvm::Constant *getExceptionTryExitFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000559 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000560 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000561 llvm::FunctionType::get(CGM.VoidTy, params, false),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000562 "objc_exception_try_exit");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000563 }
Anders Carlsson9ff22482008-09-09 10:10:21 +0000564
565 /// ExceptionExtractFn - LLVM objc_exception_extract function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000566 llvm::Constant *getExceptionExtractFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000567 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000568 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000569 params, false),
Chris Lattnerc6406db2009-04-22 02:26:14 +0000570 "objc_exception_extract");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000571 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000572
Anders Carlsson9ff22482008-09-09 10:10:21 +0000573 /// ExceptionMatchFn - LLVM objc_exception_match function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000574 llvm::Constant *getExceptionMatchFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000575 llvm::Type *params[] = { ClassPtrTy, ObjectPtrTy };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000576 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000577 llvm::FunctionType::get(CGM.Int32Ty, params, false),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000578 "objc_exception_match");
579
Chris Lattnerc6406db2009-04-22 02:26:14 +0000580 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000581
Anders Carlsson9ff22482008-09-09 10:10:21 +0000582 /// SetJmpFn - LLVM _setjmp function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000583 llvm::Constant *getSetJmpFn() {
John McCall9dc0db22011-05-15 01:53:33 +0000584 // This is specifically the prototype for x86.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000585 llvm::Type *params[] = { CGM.Int32Ty->getPointerTo() };
Bill Wendling8594fcb2013-01-31 00:30:05 +0000586 return
587 CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.Int32Ty,
588 params, false),
589 "_setjmp",
590 llvm::AttributeSet::get(CGM.getLLVMContext(),
591 llvm::AttributeSet::FunctionIndex,
592 llvm::Attribute::NonLazyBind));
Chris Lattnerc6406db2009-04-22 02:26:14 +0000593 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000594
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000595public:
596 ObjCTypesHelper(CodeGen::CodeGenModule &cgm);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000597};
598
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000599/// ObjCNonFragileABITypesHelper - will have all types needed by objective-c's
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000600/// modern abi
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000601class ObjCNonFragileABITypesHelper : public ObjCCommonTypesHelper {
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000602public:
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000603
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000604 // MethodListnfABITy - LLVM for struct _method_list_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000605 llvm::StructType *MethodListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000606
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000607 // MethodListnfABIPtrTy - LLVM for struct _method_list_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000608 llvm::Type *MethodListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000609
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000610 // ProtocolnfABITy = LLVM for struct _protocol_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000611 llvm::StructType *ProtocolnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000612
Daniel Dunbar8de90f02009-02-15 07:36:20 +0000613 // ProtocolnfABIPtrTy = LLVM for struct _protocol_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000614 llvm::Type *ProtocolnfABIPtrTy;
Daniel Dunbar8de90f02009-02-15 07:36:20 +0000615
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000616 // ProtocolListnfABITy - LLVM for struct _objc_protocol_list
Chris Lattnera5f58b02011-07-09 17:41:47 +0000617 llvm::StructType *ProtocolListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000618
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000619 // ProtocolListnfABIPtrTy - LLVM for struct _objc_protocol_list*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000620 llvm::Type *ProtocolListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000621
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000622 // ClassnfABITy - LLVM for struct _class_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000623 llvm::StructType *ClassnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000624
Fariborz Jahanian71394042009-01-23 23:53:38 +0000625 // ClassnfABIPtrTy - LLVM for struct _class_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000626 llvm::Type *ClassnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000627
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000628 // IvarnfABITy - LLVM for struct _ivar_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000629 llvm::StructType *IvarnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000630
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000631 // IvarListnfABITy - LLVM for struct _ivar_list_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000632 llvm::StructType *IvarListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000633
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000634 // IvarListnfABIPtrTy = LLVM for struct _ivar_list_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000635 llvm::Type *IvarListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000636
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000637 // ClassRonfABITy - LLVM for struct _class_ro_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000638 llvm::StructType *ClassRonfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000639
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000640 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000641 llvm::Type *ImpnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000642
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000643 // CategorynfABITy - LLVM for struct _category_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000644 llvm::StructType *CategorynfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000645
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000646 // New types for nonfragile abi messaging.
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000647
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000648 // MessageRefTy - LLVM for:
649 // struct _message_ref_t {
650 // IMP messenger;
651 // SEL name;
652 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +0000653 llvm::StructType *MessageRefTy;
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000654 // MessageRefCTy - clang type for struct _message_ref_t
655 QualType MessageRefCTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000656
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000657 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000658 llvm::Type *MessageRefPtrTy;
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000659 // MessageRefCPtrTy - clang type for struct _message_ref_t*
660 QualType MessageRefCPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000661
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000662 // SuperMessageRefTy - LLVM for:
663 // struct _super_message_ref_t {
664 // SUPER_IMP messenger;
665 // SEL name;
666 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +0000667 llvm::StructType *SuperMessageRefTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000668
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000669 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000670 llvm::Type *SuperMessageRefPtrTy;
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +0000671
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000672 llvm::Constant *getMessageSendFixupFn() {
673 // id objc_msgSend_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000674 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000675 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000676 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000677 "objc_msgSend_fixup");
678 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000679
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000680 llvm::Constant *getMessageSendFpretFixupFn() {
681 // id objc_msgSend_fpret_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000682 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000683 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000684 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000685 "objc_msgSend_fpret_fixup");
686 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000687
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000688 llvm::Constant *getMessageSendStretFixupFn() {
689 // id objc_msgSend_stret_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000690 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000691 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000692 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000693 "objc_msgSend_stret_fixup");
694 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000695
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000696 llvm::Constant *getMessageSendSuper2FixupFn() {
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000697 // id objc_msgSendSuper2_fixup (struct objc_super *,
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000698 // struct _super_message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000699 llvm::Type *params[] = { SuperPtrTy, SuperMessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000700 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000701 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000702 "objc_msgSendSuper2_fixup");
703 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000704
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000705 llvm::Constant *getMessageSendSuper2StretFixupFn() {
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000706 // id objc_msgSendSuper2_stret_fixup(struct objc_super *,
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000707 // struct _super_message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000708 llvm::Type *params[] = { SuperPtrTy, SuperMessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000709 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000710 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000711 "objc_msgSendSuper2_stret_fixup");
712 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000713
Chris Lattnera7c00b42009-04-22 02:15:23 +0000714 llvm::Constant *getObjCEndCatchFn() {
John McCall9dc0db22011-05-15 01:53:33 +0000715 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.VoidTy, false),
Chris Lattnera7c00b42009-04-22 02:15:23 +0000716 "objc_end_catch");
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000717
Chris Lattnera7c00b42009-04-22 02:15:23 +0000718 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000719
Chris Lattnera7c00b42009-04-22 02:15:23 +0000720 llvm::Constant *getObjCBeginCatchFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000721 llvm::Type *params[] = { Int8PtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000722 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(Int8PtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000723 params, false),
Chris Lattnera7c00b42009-04-22 02:15:23 +0000724 "objc_begin_catch");
725 }
Daniel Dunbarb1559a42009-03-01 04:46:24 +0000726
Chris Lattnera5f58b02011-07-09 17:41:47 +0000727 llvm::StructType *EHTypeTy;
728 llvm::Type *EHTypePtrTy;
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +0000729
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000730 ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000731};
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000732
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000733class CGObjCCommonMac : public CodeGen::CGObjCRuntime {
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000734public:
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000735 class SKIP_SCAN {
Daniel Dunbar7b89ace2009-05-03 13:44:42 +0000736 public:
737 unsigned skip;
738 unsigned scan;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000739 SKIP_SCAN(unsigned _skip = 0, unsigned _scan = 0)
Daniel Dunbar7b89ace2009-05-03 13:44:42 +0000740 : skip(_skip), scan(_scan) {}
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000741 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000742
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000743 /// opcode for captured block variables layout 'instructions'.
744 /// In the following descriptions, 'I' is the value of the immediate field.
745 /// (field following the opcode).
746 ///
747 enum BLOCK_LAYOUT_OPCODE {
748 /// An operator which affects how the following layout should be
749 /// interpreted.
750 /// I == 0: Halt interpretation and treat everything else as
751 /// a non-pointer. Note that this instruction is equal
752 /// to '\0'.
753 /// I != 0: Currently unused.
754 BLOCK_LAYOUT_OPERATOR = 0,
755
756 /// The next I+1 bytes do not contain a value of object pointer type.
757 /// Note that this can leave the stream unaligned, meaning that
758 /// subsequent word-size instructions do not begin at a multiple of
759 /// the pointer size.
760 BLOCK_LAYOUT_NON_OBJECT_BYTES = 1,
761
762 /// The next I+1 words do not contain a value of object pointer type.
763 /// This is simply an optimized version of BLOCK_LAYOUT_BYTES for
764 /// when the required skip quantity is a multiple of the pointer size.
765 BLOCK_LAYOUT_NON_OBJECT_WORDS = 2,
766
767 /// The next I+1 words are __strong pointers to Objective-C
768 /// objects or blocks.
769 BLOCK_LAYOUT_STRONG = 3,
770
771 /// The next I+1 words are pointers to __block variables.
772 BLOCK_LAYOUT_BYREF = 4,
773
774 /// The next I+1 words are __weak pointers to Objective-C
775 /// objects or blocks.
776 BLOCK_LAYOUT_WEAK = 5,
777
778 /// The next I+1 words are __unsafe_unretained pointers to
779 /// Objective-C objects or blocks.
780 BLOCK_LAYOUT_UNRETAINED = 6
781
782 /// The next I+1 words are block or object pointers with some
783 /// as-yet-unspecified ownership semantics. If we add more
784 /// flavors of ownership semantics, values will be taken from
785 /// this range.
786 ///
787 /// This is included so that older tools can at least continue
788 /// processing the layout past such things.
789 //BLOCK_LAYOUT_OWNERSHIP_UNKNOWN = 7..10,
790
791 /// All other opcodes are reserved. Halt interpretation and
792 /// treat everything else as opaque.
793 };
794
795 class RUN_SKIP {
796 public:
797 enum BLOCK_LAYOUT_OPCODE opcode;
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000798 CharUnits block_var_bytepos;
799 CharUnits block_var_size;
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000800 RUN_SKIP(enum BLOCK_LAYOUT_OPCODE Opcode = BLOCK_LAYOUT_OPERATOR,
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000801 CharUnits BytePos = CharUnits::Zero(),
802 CharUnits Size = CharUnits::Zero())
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +0000803 : opcode(Opcode), block_var_bytepos(BytePos), block_var_size(Size) {}
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000804
805 // Allow sorting based on byte pos.
806 bool operator<(const RUN_SKIP &b) const {
807 return block_var_bytepos < b.block_var_bytepos;
808 }
809 };
810
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000811protected:
Owen Andersonae86c192009-07-13 04:10:07 +0000812 llvm::LLVMContext &VMContext;
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000813 // FIXME! May not be needing this after all.
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000814 unsigned ObjCABI;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000815
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000816 // arc/mrr layout of captured block literal variables.
817 SmallVector<RUN_SKIP, 16> RunSkipBlockVars;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000818
Daniel Dunbarc61d0e92008-08-25 06:02:07 +0000819 /// LazySymbols - Symbols to generate a lazy reference for. See
820 /// DefinedSymbols and FinishModule().
Daniel Dunbard027a922009-09-07 00:20:42 +0000821 llvm::SetVector<IdentifierInfo*> LazySymbols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000822
Daniel Dunbarc61d0e92008-08-25 06:02:07 +0000823 /// DefinedSymbols - External symbols which are defined by this
824 /// module. The symbols in this list and LazySymbols are used to add
825 /// special linker symbols which ensure that Objective-C modules are
826 /// linked properly.
Daniel Dunbard027a922009-09-07 00:20:42 +0000827 llvm::SetVector<IdentifierInfo*> DefinedSymbols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000828
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000829 /// ClassNames - uniqued class names.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +0000830 llvm::StringMap<llvm::GlobalVariable*> ClassNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000831
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000832 /// MethodVarNames - uniqued method variable names.
833 llvm::DenseMap<Selector, llvm::GlobalVariable*> MethodVarNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000834
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +0000835 /// DefinedCategoryNames - list of category names in form Class_Category.
Rafael Espindolacd676622015-11-18 06:54:13 +0000836 llvm::SmallSetVector<std::string, 16> DefinedCategoryNames;
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +0000837
Daniel Dunbarb036db82008-08-13 03:21:16 +0000838 /// MethodVarTypes - uniqued method type signatures. We have to use
839 /// a StringMap here because have no other unique reference.
840 llvm::StringMap<llvm::GlobalVariable*> MethodVarTypes;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000841
Daniel Dunbar3c76cb52008-08-26 21:51:14 +0000842 /// MethodDefinitions - map of methods which have been defined in
843 /// this translation unit.
844 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*> MethodDefinitions;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000845
Daniel Dunbar80a840b2008-08-23 00:19:03 +0000846 /// PropertyNames - uniqued method variable names.
847 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> PropertyNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000848
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000849 /// ClassReferences - uniqued class references.
850 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> ClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000851
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000852 /// SelectorReferences - uniqued selector references.
853 llvm::DenseMap<Selector, llvm::GlobalVariable*> SelectorReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000854
Daniel Dunbarb036db82008-08-13 03:21:16 +0000855 /// Protocols - Protocols for which an objc_protocol structure has
856 /// been emitted. Forward declarations are handled by creating an
857 /// empty structure whose initializer is filled in when/if defined.
858 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> Protocols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000859
Daniel Dunbarc475d422008-10-29 22:36:39 +0000860 /// DefinedProtocols - Protocols which have actually been
861 /// defined. We should not need this, see FIXME in GenerateProtocol.
862 llvm::DenseSet<IdentifierInfo*> DefinedProtocols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000863
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000864 /// DefinedClasses - List of defined classes.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000865 SmallVector<llvm::GlobalValue*, 16> DefinedClasses;
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +0000866
867 /// ImplementedClasses - List of @implemented classes.
868 SmallVector<const ObjCInterfaceDecl*, 16> ImplementedClasses;
Daniel Dunbar9a017d72009-05-15 22:33:15 +0000869
870 /// DefinedNonLazyClasses - List of defined "non-lazy" classes.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000871 SmallVector<llvm::GlobalValue*, 16> DefinedNonLazyClasses;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000872
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000873 /// DefinedCategories - List of defined categories.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000874 SmallVector<llvm::GlobalValue*, 16> DefinedCategories;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000875
Daniel Dunbar9a017d72009-05-15 22:33:15 +0000876 /// DefinedNonLazyCategories - List of defined "non-lazy" categories.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000877 SmallVector<llvm::GlobalValue*, 16> DefinedNonLazyCategories;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000878
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000879 /// GetNameForMethod - Return a name for the given method.
880 /// \param[out] NameOut - The return value.
881 void GetNameForMethod(const ObjCMethodDecl *OMD,
882 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000883 SmallVectorImpl<char> &NameOut);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000884
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000885 /// GetMethodVarName - Return a unique constant for the given
886 /// selector's name. The return value has type char *.
887 llvm::Constant *GetMethodVarName(Selector Sel);
888 llvm::Constant *GetMethodVarName(IdentifierInfo *Ident);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000889
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000890 /// GetMethodVarType - Return a unique constant for the given
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000891 /// method's type encoding string. The return value has type char *.
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000892
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000893 // FIXME: This is a horrible name.
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000894 llvm::Constant *GetMethodVarType(const ObjCMethodDecl *D,
895 bool Extended = false);
Daniel Dunbarf5c18462009-04-20 06:54:31 +0000896 llvm::Constant *GetMethodVarType(const FieldDecl *D);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000897
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000898 /// GetPropertyName - Return a unique constant for the given
899 /// name. The return value has type char *.
900 llvm::Constant *GetPropertyName(IdentifierInfo *Ident);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000901
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000902 // FIXME: This can be dropped once string functions are unified.
903 llvm::Constant *GetPropertyTypeString(const ObjCPropertyDecl *PD,
904 const Decl *Container);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000905
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +0000906 /// GetClassName - Return a unique constant for the given selector's
Fariborz Jahanian451b92a2014-07-16 16:16:04 +0000907 /// runtime name (which may change via use of objc_runtime_name attribute on
908 /// class or protocol definition. The return value has type char *.
909 llvm::Constant *GetClassName(StringRef RuntimeName);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000910
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +0000911 llvm::Function *GetMethodDefinition(const ObjCMethodDecl *MD);
912
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +0000913 /// BuildIvarLayout - Builds ivar layout bitmap for the class
914 /// implementation for the __strong or __weak case.
915 ///
John McCall460ce582015-10-22 18:38:17 +0000916 /// \param hasMRCWeakIvars - Whether we are compiling in MRC and there
917 /// are any weak ivars defined directly in the class. Meaningless unless
918 /// building a weak layout. Does not guarantee that the layout will
919 /// actually have any entries, because the ivar might be under-aligned.
Fariborz Jahanian1bf72882009-03-12 22:50:49 +0000920 llvm::Constant *BuildIvarLayout(const ObjCImplementationDecl *OI,
John McCall3fd13f062015-10-21 18:06:47 +0000921 CharUnits beginOffset,
922 CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +0000923 bool forStrongLayout,
924 bool hasMRCWeakIvars);
925
926 llvm::Constant *BuildStrongIvarLayout(const ObjCImplementationDecl *OI,
927 CharUnits beginOffset,
928 CharUnits endOffset) {
929 return BuildIvarLayout(OI, beginOffset, endOffset, true, false);
930 }
931
932 llvm::Constant *BuildWeakIvarLayout(const ObjCImplementationDecl *OI,
933 CharUnits beginOffset,
934 CharUnits endOffset,
935 bool hasMRCWeakIvars) {
936 return BuildIvarLayout(OI, beginOffset, endOffset, false, hasMRCWeakIvars);
937 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +0000938
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000939 Qualifiers::ObjCLifetime getBlockCaptureLifetime(QualType QT, bool ByrefLayout);
Fariborz Jahanian2dd78192012-11-02 22:51:18 +0000940
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000941 void UpdateRunSkipBlockVars(bool IsByref,
942 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000943 CharUnits FieldOffset,
944 CharUnits FieldSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000945
946 void BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000947 CharUnits BytePos, bool &HasUnion,
948 bool ByrefLayout=false);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000949
950 void BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
951 const RecordDecl *RD,
952 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000953 CharUnits BytePos, bool &HasUnion,
954 bool ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000955
Fariborz Jahanian23290b02012-11-01 18:32:55 +0000956 uint64_t InlineLayoutInstruction(SmallVectorImpl<unsigned char> &Layout);
957
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000958 llvm::Constant *getBitmapBlockLayout(bool ComputeByrefLayout);
959
Fariborz Jahanian01dff422009-03-05 19:17:31 +0000960 /// GetIvarLayoutName - Returns a unique constant for the given
961 /// ivar layout bitmap.
962 llvm::Constant *GetIvarLayoutName(IdentifierInfo *Ident,
963 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000964
Fariborz Jahanian066347e2009-01-28 22:18:42 +0000965 /// EmitPropertyList - Emit the given property list. The return
966 /// value has type PropertyListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000967 llvm::Constant *EmitPropertyList(Twine Name,
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000968 const Decl *Container,
Fariborz Jahanian066347e2009-01-28 22:18:42 +0000969 const ObjCContainerDecl *OCD,
970 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000971
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000972 /// EmitProtocolMethodTypes - Generate the array of extended method type
973 /// strings. The return value has type Int8PtrPtrTy.
974 llvm::Constant *EmitProtocolMethodTypes(Twine Name,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +0000975 ArrayRef<llvm::Constant*> MethodTypes,
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000976 const ObjCCommonTypesHelper &ObjCTypes);
977
Fariborz Jahanian751c1e72009-12-12 21:26:21 +0000978 /// PushProtocolProperties - Push protocol's property on the input stack.
Bill Wendlinga515b582012-02-09 22:16:49 +0000979 void PushProtocolProperties(
980 llvm::SmallPtrSet<const IdentifierInfo*, 16> &PropertySet,
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000981 SmallVectorImpl<llvm::Constant*> &Properties,
Bill Wendlinga515b582012-02-09 22:16:49 +0000982 const Decl *Container,
Aaron Ballmandc4bea42014-03-13 18:47:37 +0000983 const ObjCProtocolDecl *Proto,
Bill Wendlinga515b582012-02-09 22:16:49 +0000984 const ObjCCommonTypesHelper &ObjCTypes);
Fariborz Jahanian751c1e72009-12-12 21:26:21 +0000985
Fariborz Jahanian56b3b772009-01-29 19:24:30 +0000986 /// GetProtocolRef - Return a reference to the internal protocol
987 /// description, creating an empty one if it has not been
988 /// defined. The return value has type ProtocolPtrTy.
989 llvm::Constant *GetProtocolRef(const ObjCProtocolDecl *PD);
Fariborz Jahanian67726212009-03-08 20:18:37 +0000990
John McCall3fd13f062015-10-21 18:06:47 +0000991public:
Daniel Dunbar30c65362009-03-09 20:09:19 +0000992 /// CreateMetadataVar - Create a global variable with internal
993 /// linkage for use by the Objective-C runtime.
994 ///
995 /// This is a convenience wrapper which not only creates the
996 /// variable, but also sets the section and alignment and adds the
Chris Lattnerf56501c2009-07-17 23:57:13 +0000997 /// global to the "llvm.used" list.
Daniel Dunbar463cc8a2009-03-09 20:50:13 +0000998 ///
999 /// \param Name - The variable name.
1000 /// \param Init - The variable initializer; this is also used to
1001 /// define the type of the variable.
Alp Toker541d5072014-06-07 23:30:53 +00001002 /// \param Section - The section the variable should go into, or empty.
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001003 /// \param Align - The alignment for the variable, or 0.
1004 /// \param AddToUsed - Whether the variable should be added to
Daniel Dunbar4527d302009-04-14 17:42:51 +00001005 /// "llvm.used".
Alp Toker541d5072014-06-07 23:30:53 +00001006 llvm::GlobalVariable *CreateMetadataVar(Twine Name, llvm::Constant *Init,
John McCall7f416cc2015-09-08 08:05:57 +00001007 StringRef Section, CharUnits Align,
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001008 bool AddToUsed);
Daniel Dunbar30c65362009-03-09 20:09:19 +00001009
John McCall3fd13f062015-10-21 18:06:47 +00001010protected:
John McCall9e8bb002011-05-14 03:10:52 +00001011 CodeGen::RValue EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1012 ReturnValueSlot Return,
1013 QualType ResultType,
1014 llvm::Value *Sel,
1015 llvm::Value *Arg0,
1016 QualType Arg0Ty,
1017 bool IsSuper,
1018 const CallArgList &CallArgs,
1019 const ObjCMethodDecl *OMD,
John McCall1e3157b2015-09-10 22:27:50 +00001020 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00001021 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbarf5c18462009-04-20 06:54:31 +00001022
Daniel Dunbar5e639272010-04-25 20:39:01 +00001023 /// EmitImageInfo - Emit the image info marker used to encode some module
1024 /// level information.
1025 void EmitImageInfo();
1026
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001027public:
Owen Andersonae86c192009-07-13 04:10:07 +00001028 CGObjCCommonMac(CodeGen::CodeGenModule &cgm) :
John McCalla729c622012-02-17 03:33:10 +00001029 CGObjCRuntime(cgm), VMContext(cgm.getLLVMContext()) { }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001030
John McCall3fd13f062015-10-21 18:06:47 +00001031 bool isNonFragileABI() const {
1032 return ObjCABI == 2;
1033 }
1034
John McCall7f416cc2015-09-08 08:05:57 +00001035 ConstantAddress GenerateConstantString(const StringLiteral *SL) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001036
Craig Topper4f12f102014-03-12 06:41:41 +00001037 llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
Craig Topper8a13c412014-05-21 05:09:00 +00001038 const ObjCContainerDecl *CD=nullptr) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001039
1040 void GenerateProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001041
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001042 /// GetOrEmitProtocol - Get the protocol object for the given
1043 /// declaration, emitting it if necessary. The return value has type
1044 /// ProtocolPtrTy.
1045 virtual llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD)=0;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001046
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001047 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1048 /// object for the given declaration, emitting it if needed. These
1049 /// forward references will be filled in with empty bodies if no
1050 /// definition is seen. The return value has type ProtocolPtrTy.
1051 virtual llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD)=0;
Craig Topper4f12f102014-03-12 06:41:41 +00001052 llvm::Constant *BuildGCBlockLayout(CodeGen::CodeGenModule &CGM,
1053 const CGBlockInfo &blockInfo) override;
1054 llvm::Constant *BuildRCBlockLayout(CodeGen::CodeGenModule &CGM,
1055 const CGBlockInfo &blockInfo) override;
1056
1057 llvm::Constant *BuildByrefLayout(CodeGen::CodeGenModule &CGM,
1058 QualType T) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001059};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001060
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001061class CGObjCMac : public CGObjCCommonMac {
1062private:
1063 ObjCTypesHelper ObjCTypes;
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001064
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001065 /// EmitModuleInfo - Another marker encoding module level
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001066 /// information.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001067 void EmitModuleInfo();
1068
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001069 /// EmitModuleSymols - Emit module symbols, the list of defined
1070 /// classes and categories. The result has type SymtabPtrTy.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001071 llvm::Constant *EmitModuleSymbols();
1072
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001073 /// FinishModule - Write out global data structures at the end of
1074 /// processing a translation unit.
1075 void FinishModule();
Daniel Dunbarb036db82008-08-13 03:21:16 +00001076
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001077 /// EmitClassExtension - Generate the class extension structure used
1078 /// to store the weak ivar layout and properties. The return value
1079 /// has type ClassExtensionPtrTy.
John McCall3fd13f062015-10-21 18:06:47 +00001080 llvm::Constant *EmitClassExtension(const ObjCImplementationDecl *ID,
John McCall460ce582015-10-22 18:38:17 +00001081 CharUnits instanceSize,
1082 bool hasMRCWeakIvars);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001083
1084 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1085 /// for the given class.
John McCall882987f2013-02-28 19:01:20 +00001086 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001087 const ObjCInterfaceDecl *ID);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001088
John McCall882987f2013-02-28 19:01:20 +00001089 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00001090 IdentifierInfo *II);
Craig Topper4f12f102014-03-12 06:41:41 +00001091
1092 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
1093
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001094 /// EmitSuperClassRef - Emits reference to class's main metadata class.
1095 llvm::Value *EmitSuperClassRef(const ObjCInterfaceDecl *ID);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001096
1097 /// EmitIvarList - Emit the ivar list for the given
1098 /// implementation. If ForClass is true the list of class ivars
1099 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1100 /// interface ivars will be emitted. The return value has type
1101 /// IvarListPtrTy.
1102 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00001103 bool ForClass);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001104
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001105 /// EmitMetaClass - Emit a forward reference to the class structure
1106 /// for the metaclass of the given interface. The return value has
1107 /// type ClassPtrTy.
1108 llvm::Constant *EmitMetaClassRef(const ObjCInterfaceDecl *ID);
1109
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001110 /// EmitMetaClass - Emit a class structure for the metaclass of the
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001111 /// given implementation. The return value has type ClassPtrTy.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001112 llvm::Constant *EmitMetaClass(const ObjCImplementationDecl *ID,
1113 llvm::Constant *Protocols,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001114 ArrayRef<llvm::Constant*> Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001115
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001116 llvm::Constant *GetMethodConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001117
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001118 llvm::Constant *GetMethodDescriptionConstant(const ObjCMethodDecl *MD);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001119
1120 /// EmitMethodList - Emit the method list for the given
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001121 /// implementation. The return value has type MethodListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001122 llvm::Constant *EmitMethodList(Twine Name,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00001123 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001124 ArrayRef<llvm::Constant*> Methods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001125
1126 /// EmitMethodDescList - Emit a method description list for a list of
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001127 /// method declarations.
Daniel Dunbarb036db82008-08-13 03:21:16 +00001128 /// - TypeName: The name for the type containing the methods.
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001129 /// - IsProtocol: True iff these methods are for a protocol.
1130 /// - ClassMethds: True iff these are class methods.
Daniel Dunbarb036db82008-08-13 03:21:16 +00001131 /// - Required: When true, only "required" methods are
1132 /// listed. Similarly, when false only "optional" methods are
1133 /// listed. For classes this should always be true.
1134 /// - begin, end: The method list to output.
1135 ///
1136 /// The return value has type MethodDescriptionListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001137 llvm::Constant *EmitMethodDescList(Twine Name,
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001138 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001139 ArrayRef<llvm::Constant*> Methods);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001140
Daniel Dunbarc475d422008-10-29 22:36:39 +00001141 /// GetOrEmitProtocol - Get the protocol object for the given
1142 /// declaration, emitting it if necessary. The return value has type
1143 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001144 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001145
1146 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1147 /// object for the given declaration, emitting it if needed. These
1148 /// forward references will be filled in with empty bodies if no
1149 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001150 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001151
Daniel Dunbarb036db82008-08-13 03:21:16 +00001152 /// EmitProtocolExtension - Generate the protocol extension
1153 /// structure used to store optional instance and class methods, and
1154 /// protocol properties. The return value has type
1155 /// ProtocolExtensionPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001156 llvm::Constant *
1157 EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001158 ArrayRef<llvm::Constant*> OptInstanceMethods,
1159 ArrayRef<llvm::Constant*> OptClassMethods,
1160 ArrayRef<llvm::Constant*> MethodTypesExt);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001161
1162 /// EmitProtocolList - Generate the list of referenced
1163 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001164 llvm::Constant *EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00001165 ObjCProtocolDecl::protocol_iterator begin,
1166 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001167
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001168 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1169 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001170 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1171 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001172
1173public:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001174 CGObjCMac(CodeGen::CodeGenModule &cgm);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001175
Craig Topper4f12f102014-03-12 06:41:41 +00001176 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001177
Craig Topper4f12f102014-03-12 06:41:41 +00001178 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1179 ReturnValueSlot Return,
1180 QualType ResultType,
1181 Selector Sel, llvm::Value *Receiver,
1182 const CallArgList &CallArgs,
1183 const ObjCInterfaceDecl *Class,
1184 const ObjCMethodDecl *Method) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001185
Craig Topper4f12f102014-03-12 06:41:41 +00001186 CodeGen::RValue
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001187 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001188 ReturnValueSlot Return, QualType ResultType,
1189 Selector Sel, const ObjCInterfaceDecl *Class,
1190 bool isCategoryImpl, llvm::Value *Receiver,
1191 bool IsClassMessage, const CallArgList &CallArgs,
1192 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001193
Craig Topper4f12f102014-03-12 06:41:41 +00001194 llvm::Value *GetClass(CodeGenFunction &CGF,
1195 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001196
John McCall7f416cc2015-09-08 08:05:57 +00001197 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
1198 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001199
1200 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1201 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001202 llvm::Value *GetSelector(CodeGenFunction &CGF,
1203 const ObjCMethodDecl *Method) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001204
Craig Topper4f12f102014-03-12 06:41:41 +00001205 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001206
Craig Topper4f12f102014-03-12 06:41:41 +00001207 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001208
Craig Topper4f12f102014-03-12 06:41:41 +00001209 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001210
Craig Topper4f12f102014-03-12 06:41:41 +00001211 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001212
Craig Topper4f12f102014-03-12 06:41:41 +00001213 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1214 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001215
Craig Topper4f12f102014-03-12 06:41:41 +00001216 llvm::Constant *GetPropertyGetFunction() override;
1217 llvm::Constant *GetPropertySetFunction() override;
1218 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1219 bool copy) override;
1220 llvm::Constant *GetGetStructFunction() override;
1221 llvm::Constant *GetSetStructFunction() override;
1222 llvm::Constant *GetCppAtomicObjectGetFunction() override;
1223 llvm::Constant *GetCppAtomicObjectSetFunction() override;
1224 llvm::Constant *EnumerationMutationFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001225
Craig Topper4f12f102014-03-12 06:41:41 +00001226 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1227 const ObjCAtTryStmt &S) override;
1228 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1229 const ObjCAtSynchronizedStmt &S) override;
John McCallbd309292010-07-06 01:34:17 +00001230 void EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF, const Stmt &S);
Craig Topper4f12f102014-03-12 06:41:41 +00001231 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1232 bool ClearInsertionPoint=true) override;
1233 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001234 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001235 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001236 llvm::Value *src, Address dst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001237 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001238 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001239 bool threadlocal = false) override;
1240 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001241 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001242 llvm::Value *ivarOffset) override;
1243 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001244 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001245 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001246 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001247 llvm::Value *size) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001248
Craig Topper4f12f102014-03-12 06:41:41 +00001249 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1250 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1251 unsigned CVRQualifiers) override;
1252 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1253 const ObjCInterfaceDecl *Interface,
1254 const ObjCIvarDecl *Ivar) override;
1255
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001256 /// GetClassGlobal - Return the global variable for the Objective-C
1257 /// class of the given name.
Rafael Espindola554256c2014-02-26 22:25:45 +00001258 llvm::GlobalVariable *GetClassGlobal(const std::string &Name,
Craig Toppera798a9d2014-03-02 09:32:10 +00001259 bool Weak = false) override {
David Blaikie83d382b2011-09-23 05:06:16 +00001260 llvm_unreachable("CGObjCMac::GetClassGlobal");
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001261 }
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001262};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001263
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001264class CGObjCNonFragileABIMac : public CGObjCCommonMac {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001265private:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001266 ObjCNonFragileABITypesHelper ObjCTypes;
Fariborz Jahanian71394042009-01-23 23:53:38 +00001267 llvm::GlobalVariable* ObjCEmptyCacheVar;
1268 llvm::GlobalVariable* ObjCEmptyVtableVar;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001269
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001270 /// SuperClassReferences - uniqued super class references.
1271 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> SuperClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001272
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001273 /// MetaClassReferences - uniqued meta class references.
1274 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> MetaClassReferences;
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001275
1276 /// EHTypeReferences - uniqued class ehtype references.
1277 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> EHTypeReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001278
John McCall9e8bb002011-05-14 03:10:52 +00001279 /// VTableDispatchMethods - List of methods for which we generate
1280 /// vtable-based message dispatch.
1281 llvm::DenseSet<Selector> VTableDispatchMethods;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001282
Fariborz Jahanian67260552009-11-17 21:37:35 +00001283 /// DefinedMetaClasses - List of defined meta-classes.
1284 std::vector<llvm::GlobalValue*> DefinedMetaClasses;
1285
John McCall9e8bb002011-05-14 03:10:52 +00001286 /// isVTableDispatchedSelector - Returns true if SEL is a
1287 /// vtable-based selector.
1288 bool isVTableDispatchedSelector(Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001289
Fariborz Jahanian71394042009-01-23 23:53:38 +00001290 /// FinishNonFragileABIModule - Write out global data structures at the end of
1291 /// processing a translation unit.
1292 void FinishNonFragileABIModule();
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001293
Daniel Dunbar19573e72009-05-15 21:48:48 +00001294 /// AddModuleClassList - Add the given list of class pointers to the
1295 /// module with the provided symbol and section names.
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001296 void AddModuleClassList(ArrayRef<llvm::GlobalValue*> Container,
Daniel Dunbar19573e72009-05-15 21:48:48 +00001297 const char *SymbolName,
1298 const char *SectionName);
1299
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001300 llvm::GlobalVariable * BuildClassRoTInitializer(unsigned flags,
1301 unsigned InstanceStart,
1302 unsigned InstanceSize,
1303 const ObjCImplementationDecl *ID);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001304 llvm::GlobalVariable * BuildClassMetaData(const std::string &ClassName,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001305 llvm::Constant *IsAGV,
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00001306 llvm::Constant *SuperClassGV,
Fariborz Jahanian82208252009-01-31 00:59:10 +00001307 llvm::Constant *ClassRoGV,
Rafael Espindola554256c2014-02-26 22:25:45 +00001308 bool HiddenVisibility,
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00001309 bool Weak);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001310
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001311 llvm::Constant *GetMethodConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001312
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00001313 llvm::Constant *GetMethodDescriptionConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001314
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001315 /// EmitMethodList - Emit the method list for the given
1316 /// implementation. The return value has type MethodListnfABITy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001317 llvm::Constant *EmitMethodList(Twine Name,
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001318 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001319 ArrayRef<llvm::Constant*> Methods);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00001320 /// EmitIvarList - Emit the ivar list for the given
1321 /// implementation. If ForClass is true the list of class ivars
1322 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1323 /// interface ivars will be emitted. The return value has type
1324 /// IvarListnfABIPtrTy.
1325 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001326
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001327 llvm::Constant *EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00001328 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00001329 unsigned long int offset);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001330
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001331 /// GetOrEmitProtocol - Get the protocol object for the given
1332 /// declaration, emitting it if necessary. The return value has type
1333 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001334 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001335
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001336 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1337 /// object for the given declaration, emitting it if needed. These
1338 /// forward references will be filled in with empty bodies if no
1339 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001340 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001341
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001342 /// EmitProtocolList - Generate the list of referenced
1343 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001344 llvm::Constant *EmitProtocolList(Twine Name,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001345 ObjCProtocolDecl::protocol_iterator begin,
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00001346 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001347
John McCall9e8bb002011-05-14 03:10:52 +00001348 CodeGen::RValue EmitVTableMessageSend(CodeGen::CodeGenFunction &CGF,
1349 ReturnValueSlot Return,
1350 QualType ResultType,
1351 Selector Sel,
1352 llvm::Value *Receiver,
1353 QualType Arg0Ty,
1354 bool IsSuper,
1355 const CallArgList &CallArgs,
1356 const ObjCMethodDecl *Method);
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001357
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00001358 /// GetClassGlobal - Return the global variable for the Objective-C
1359 /// class of the given name.
Rafael Espindola554256c2014-02-26 22:25:45 +00001360 llvm::GlobalVariable *GetClassGlobal(const std::string &Name,
Craig Toppera798a9d2014-03-02 09:32:10 +00001361 bool Weak = false) override;
Rafael Espindola554256c2014-02-26 22:25:45 +00001362
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00001363 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001364 /// for the given class reference.
John McCall882987f2013-02-28 19:01:20 +00001365 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001366 const ObjCInterfaceDecl *ID);
John McCall31168b02011-06-15 23:02:42 +00001367
John McCall882987f2013-02-28 19:01:20 +00001368 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001369 IdentifierInfo *II, bool Weak,
1370 const ObjCInterfaceDecl *ID);
Craig Topper4f12f102014-03-12 06:41:41 +00001371
1372 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001373
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001374 /// EmitSuperClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1375 /// for the given super class reference.
John McCall882987f2013-02-28 19:01:20 +00001376 llvm::Value *EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001377 const ObjCInterfaceDecl *ID);
1378
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001379 /// EmitMetaClassRef - Return a Value * of the address of _class_t
1380 /// meta-data
John McCall882987f2013-02-28 19:01:20 +00001381 llvm::Value *EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00001382 const ObjCInterfaceDecl *ID, bool Weak);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001383
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001384 /// ObjCIvarOffsetVariable - Returns the ivar offset variable for
1385 /// the given ivar.
1386 ///
Daniel Dunbara1060522009-04-19 00:31:15 +00001387 llvm::GlobalVariable * ObjCIvarOffsetVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001388 const ObjCInterfaceDecl *ID,
1389 const ObjCIvarDecl *Ivar);
1390
Fariborz Jahanian74b77222009-02-11 20:51:17 +00001391 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1392 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001393 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1394 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001395
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001396 /// GetInterfaceEHType - Get the cached ehtype for the given Objective-C
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001397 /// interface. The return value has type EHTypePtrTy.
John McCall2ca705e2010-07-24 00:37:23 +00001398 llvm::Constant *GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001399 bool ForDefinition);
Daniel Dunbar15894b72009-04-07 05:48:37 +00001400
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001401 const char *getMetaclassSymbolPrefix() const {
Daniel Dunbar15894b72009-04-07 05:48:37 +00001402 return "OBJC_METACLASS_$_";
1403 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001404
Daniel Dunbar15894b72009-04-07 05:48:37 +00001405 const char *getClassSymbolPrefix() const {
1406 return "OBJC_CLASS_$_";
1407 }
1408
Daniel Dunbar961202372009-05-03 12:57:56 +00001409 void GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00001410 uint32_t &InstanceStart,
1411 uint32_t &InstanceSize);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001412
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001413 // Shamelessly stolen from Analysis/CFRefCount.cpp
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001414 Selector GetNullarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001415 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1416 return CGM.getContext().Selectors.getSelector(0, &II);
1417 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001418
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001419 Selector GetUnarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001420 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1421 return CGM.getContext().Selectors.getSelector(1, &II);
1422 }
Daniel Dunbar554fd792009-04-19 23:41:48 +00001423
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001424 /// ImplementationIsNonLazy - Check whether the given category or
1425 /// class implementation is "non-lazy".
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00001426 bool ImplementationIsNonLazy(const ObjCImplDecl *OD) const;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001427
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001428 bool IsIvarOffsetKnownIdempotent(const CodeGen::CodeGenFunction &CGF,
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001429 const ObjCIvarDecl *IV) {
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001430 // Annotate the load as an invariant load iff inside an instance method
1431 // and ivar belongs to instance method's class and one of its super class.
1432 // This check is needed because the ivar offset is a lazily
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001433 // initialised value that may depend on objc_msgSend to perform a fixup on
1434 // the first message dispatch.
1435 //
1436 // An additional opportunity to mark the load as invariant arises when the
1437 // base of the ivar access is a parameter to an Objective C method.
1438 // However, because the parameters are not available in the current
1439 // interface, we cannot perform this check.
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001440 if (const ObjCMethodDecl *MD =
1441 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurFuncDecl))
Fariborz Jahanian7a583022014-03-04 22:57:32 +00001442 if (MD->isInstanceMethod())
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001443 if (const ObjCInterfaceDecl *ID = MD->getClassInterface())
1444 return IV->getContainingInterface()->isSuperClassOf(ID);
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001445 return false;
1446 }
1447
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001448public:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001449 CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian71394042009-01-23 23:53:38 +00001450 // FIXME. All stubs for now!
Craig Topper4f12f102014-03-12 06:41:41 +00001451 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001452
Craig Topper4f12f102014-03-12 06:41:41 +00001453 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1454 ReturnValueSlot Return,
1455 QualType ResultType, Selector Sel,
1456 llvm::Value *Receiver,
1457 const CallArgList &CallArgs,
1458 const ObjCInterfaceDecl *Class,
1459 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001460
Craig Topper4f12f102014-03-12 06:41:41 +00001461 CodeGen::RValue
Fariborz Jahanian71394042009-01-23 23:53:38 +00001462 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001463 ReturnValueSlot Return, QualType ResultType,
1464 Selector Sel, const ObjCInterfaceDecl *Class,
1465 bool isCategoryImpl, llvm::Value *Receiver,
1466 bool IsClassMessage, const CallArgList &CallArgs,
1467 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001468
Craig Topper4f12f102014-03-12 06:41:41 +00001469 llvm::Value *GetClass(CodeGenFunction &CGF,
1470 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001471
John McCall7f416cc2015-09-08 08:05:57 +00001472 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override
1473 { return EmitSelector(CGF, Sel); }
1474 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override
1475 { return EmitSelectorAddr(CGF, Sel); }
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001476
1477 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1478 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001479 llvm::Value *GetSelector(CodeGenFunction &CGF,
1480 const ObjCMethodDecl *Method) override
John McCall882987f2013-02-28 19:01:20 +00001481 { return EmitSelector(CGF, Method->getSelector()); }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001482
Craig Topper4f12f102014-03-12 06:41:41 +00001483 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001484
Craig Topper4f12f102014-03-12 06:41:41 +00001485 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
David Chisnall92d436b2012-01-31 18:59:20 +00001486
Craig Topper4f12f102014-03-12 06:41:41 +00001487 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001488
Craig Topper4f12f102014-03-12 06:41:41 +00001489 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1490 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001491
Craig Topper4f12f102014-03-12 06:41:41 +00001492 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001493
Craig Topper4f12f102014-03-12 06:41:41 +00001494 llvm::Constant *GetPropertyGetFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001495 return ObjCTypes.getGetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001496 }
Craig Topper4f12f102014-03-12 06:41:41 +00001497 llvm::Constant *GetPropertySetFunction() override {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001498 return ObjCTypes.getSetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001499 }
Craig Topper4f12f102014-03-12 06:41:41 +00001500
1501 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1502 bool copy) override {
Ted Kremeneke65b0862012-03-06 20:05:56 +00001503 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
1504 }
Craig Topper4f12f102014-03-12 06:41:41 +00001505
1506 llvm::Constant *GetSetStructFunction() override {
David Chisnall168b80f2010-12-26 22:13:16 +00001507 return ObjCTypes.getCopyStructFn();
1508 }
Craig Topper4f12f102014-03-12 06:41:41 +00001509 llvm::Constant *GetGetStructFunction() override {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00001510 return ObjCTypes.getCopyStructFn();
1511 }
Craig Topper4f12f102014-03-12 06:41:41 +00001512 llvm::Constant *GetCppAtomicObjectSetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +00001513 return ObjCTypes.getCppAtomicObjectFunction();
1514 }
Craig Topper4f12f102014-03-12 06:41:41 +00001515 llvm::Constant *GetCppAtomicObjectGetFunction() override {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00001516 return ObjCTypes.getCppAtomicObjectFunction();
1517 }
Craig Topper4f12f102014-03-12 06:41:41 +00001518
1519 llvm::Constant *EnumerationMutationFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001520 return ObjCTypes.getEnumerationMutationFn();
Daniel Dunbard73ea8162009-02-16 18:48:45 +00001521 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001522
Craig Topper4f12f102014-03-12 06:41:41 +00001523 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1524 const ObjCAtTryStmt &S) override;
1525 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1526 const ObjCAtSynchronizedStmt &S) override;
1527 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1528 bool ClearInsertionPoint=true) override;
1529 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001530 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001531 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001532 llvm::Value *src, Address edst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001533 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001534 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001535 bool threadlocal = false) override;
1536 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001537 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001538 llvm::Value *ivarOffset) override;
1539 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001540 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001541 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001542 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001543 llvm::Value *size) override;
1544 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1545 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1546 unsigned CVRQualifiers) override;
1547 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1548 const ObjCInterfaceDecl *Interface,
1549 const ObjCIvarDecl *Ivar) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001550};
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001551
1552/// A helper class for performing the null-initialization of a return
1553/// value.
1554struct NullReturnState {
1555 llvm::BasicBlock *NullBB;
Craig Topper8a13c412014-05-21 05:09:00 +00001556 NullReturnState() : NullBB(nullptr) {}
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001557
John McCall3d1e2c92013-02-12 05:53:35 +00001558 /// Perform a null-check of the given receiver.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001559 void init(CodeGenFunction &CGF, llvm::Value *receiver) {
John McCall3d1e2c92013-02-12 05:53:35 +00001560 // Make blocks for the null-receiver and call edges.
1561 NullBB = CGF.createBasicBlock("msgSend.null-receiver");
1562 llvm::BasicBlock *callBB = CGF.createBasicBlock("msgSend.call");
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001563
1564 // Check for a null receiver and, if there is one, jump to the
John McCall3d1e2c92013-02-12 05:53:35 +00001565 // null-receiver block. There's no point in trying to avoid it:
1566 // we're always going to put *something* there, because otherwise
1567 // we shouldn't have done this null-check in the first place.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001568 llvm::Value *isNull = CGF.Builder.CreateIsNull(receiver);
1569 CGF.Builder.CreateCondBr(isNull, NullBB, callBB);
1570
1571 // Otherwise, start performing the call.
1572 CGF.EmitBlock(callBB);
1573 }
1574
John McCall3d1e2c92013-02-12 05:53:35 +00001575 /// Complete the null-return operation. It is valid to call this
1576 /// regardless of whether 'init' has been called.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001577 RValue complete(CodeGenFunction &CGF, RValue result, QualType resultType,
1578 const CallArgList &CallArgs,
1579 const ObjCMethodDecl *Method) {
John McCall3d1e2c92013-02-12 05:53:35 +00001580 // If we never had to do a null-check, just use the raw result.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001581 if (!NullBB) return result;
John McCall3d1e2c92013-02-12 05:53:35 +00001582
1583 // The continuation block. This will be left null if we don't have an
1584 // IP, which can happen if the method we're calling is marked noreturn.
Craig Topper8a13c412014-05-21 05:09:00 +00001585 llvm::BasicBlock *contBB = nullptr;
1586
John McCall3d1e2c92013-02-12 05:53:35 +00001587 // Finish the call path.
1588 llvm::BasicBlock *callBB = CGF.Builder.GetInsertBlock();
1589 if (callBB) {
1590 contBB = CGF.createBasicBlock("msgSend.cont");
1591 CGF.Builder.CreateBr(contBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001592 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001593
John McCall3d1e2c92013-02-12 05:53:35 +00001594 // Okay, start emitting the null-receiver block.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001595 CGF.EmitBlock(NullBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001596
John McCall3d1e2c92013-02-12 05:53:35 +00001597 // Release any consumed arguments we've got.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001598 if (Method) {
1599 CallArgList::const_iterator I = CallArgs.begin();
1600 for (ObjCMethodDecl::param_const_iterator i = Method->param_begin(),
1601 e = Method->param_end(); i != e; ++i, ++I) {
1602 const ParmVarDecl *ParamDecl = (*i);
1603 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1604 RValue RV = I->RV;
1605 assert(RV.isScalar() &&
1606 "NullReturnState::complete - arg not on object");
John McCallcdda29c2013-03-13 03:10:54 +00001607 CGF.EmitARCRelease(RV.getScalarVal(), ARCImpreciseLifetime);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001608 }
1609 }
1610 }
John McCall3d1e2c92013-02-12 05:53:35 +00001611
1612 // The phi code below assumes that we haven't needed any control flow yet.
1613 assert(CGF.Builder.GetInsertBlock() == NullBB);
1614
1615 // If we've got a void return, just jump to the continuation block.
1616 if (result.isScalar() && resultType->isVoidType()) {
1617 // No jumps required if the message-send was noreturn.
1618 if (contBB) CGF.EmitBlock(contBB);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001619 return result;
1620 }
1621
John McCall3d1e2c92013-02-12 05:53:35 +00001622 // If we've got a scalar return, build a phi.
1623 if (result.isScalar()) {
1624 // Derive the null-initialization value.
1625 llvm::Constant *null = CGF.CGM.EmitNullConstant(resultType);
1626
1627 // If no join is necessary, just flow out.
1628 if (!contBB) return RValue::get(null);
1629
1630 // Otherwise, build a phi.
1631 CGF.EmitBlock(contBB);
1632 llvm::PHINode *phi = CGF.Builder.CreatePHI(null->getType(), 2);
1633 phi->addIncoming(result.getScalarVal(), callBB);
1634 phi->addIncoming(null, NullBB);
1635 return RValue::get(phi);
1636 }
1637
1638 // If we've got an aggregate return, null the buffer out.
1639 // FIXME: maybe we should be doing things differently for all the
1640 // cases where the ABI has us returning (1) non-agg values in
1641 // memory or (2) agg values in registers.
1642 if (result.isAggregate()) {
1643 assert(result.isAggregate() && "null init of non-aggregate result?");
John McCall7f416cc2015-09-08 08:05:57 +00001644 CGF.EmitNullInitialization(result.getAggregateAddress(), resultType);
John McCall3d1e2c92013-02-12 05:53:35 +00001645 if (contBB) CGF.EmitBlock(contBB);
1646 return result;
1647 }
1648
1649 // Complex types.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001650 CGF.EmitBlock(contBB);
John McCall3d1e2c92013-02-12 05:53:35 +00001651 CodeGenFunction::ComplexPairTy callResult = result.getComplexVal();
1652
1653 // Find the scalar type and its zero value.
1654 llvm::Type *scalarTy = callResult.first->getType();
1655 llvm::Constant *scalarZero = llvm::Constant::getNullValue(scalarTy);
1656
1657 // Build phis for both coordinates.
1658 llvm::PHINode *real = CGF.Builder.CreatePHI(scalarTy, 2);
1659 real->addIncoming(callResult.first, callBB);
1660 real->addIncoming(scalarZero, NullBB);
1661 llvm::PHINode *imag = CGF.Builder.CreatePHI(scalarTy, 2);
1662 imag->addIncoming(callResult.second, callBB);
1663 imag->addIncoming(scalarZero, NullBB);
1664 return RValue::getComplex(real, imag);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001665 }
1666};
1667
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001668} // end anonymous namespace
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001669
1670/* *** Helper Functions *** */
1671
1672/// getConstantGEP() - Help routine to construct simple GEPs.
Owen Anderson170229f2009-07-14 23:10:40 +00001673static llvm::Constant *getConstantGEP(llvm::LLVMContext &VMContext,
David Blaikiee3b172a2015-04-02 18:55:21 +00001674 llvm::GlobalVariable *C, unsigned idx0,
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001675 unsigned idx1) {
1676 llvm::Value *Idxs[] = {
Owen Anderson41a75022009-08-13 21:57:51 +00001677 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx0),
1678 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx1)
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001679 };
David Blaikiee3b172a2015-04-02 18:55:21 +00001680 return llvm::ConstantExpr::getGetElementPtr(C->getValueType(), C, Idxs);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001681}
1682
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001683/// hasObjCExceptionAttribute - Return true if this class or any super
1684/// class has the __objc_exception__ attribute.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001685static bool hasObjCExceptionAttribute(ASTContext &Context,
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001686 const ObjCInterfaceDecl *OID) {
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001687 if (OID->hasAttr<ObjCExceptionAttr>())
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001688 return true;
1689 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001690 return hasObjCExceptionAttribute(Context, Super);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001691 return false;
1692}
1693
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001694/* *** CGObjCMac Public Interface *** */
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001695
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001696CGObjCMac::CGObjCMac(CodeGen::CodeGenModule &cgm) : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00001697 ObjCTypes(cgm) {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001698 ObjCABI = 1;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001699 EmitImageInfo();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001700}
1701
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +00001702/// GetClass - Return a reference to the class for the given interface
1703/// decl.
John McCall882987f2013-02-28 19:01:20 +00001704llvm::Value *CGObjCMac::GetClass(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001705 const ObjCInterfaceDecl *ID) {
John McCall882987f2013-02-28 19:01:20 +00001706 return EmitClassRef(CGF, ID);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001707}
1708
1709/// GetSelector - Return the pointer to the unique'd string for this selector.
John McCall7f416cc2015-09-08 08:05:57 +00001710llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, Selector Sel) {
1711 return EmitSelector(CGF, Sel);
1712}
1713Address CGObjCMac::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
1714 return EmitSelectorAddr(CGF, Sel);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001715}
John McCall882987f2013-02-28 19:01:20 +00001716llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, const ObjCMethodDecl
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001717 *Method) {
John McCall882987f2013-02-28 19:01:20 +00001718 return EmitSelector(CGF, Method->getSelector());
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001719}
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001720
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001721llvm::Constant *CGObjCMac::GetEHType(QualType T) {
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001722 if (T->isObjCIdType() ||
1723 T->isObjCQualifiedIdType()) {
1724 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001725 CGM.getContext().getObjCIdRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001726 }
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001727 if (T->isObjCClassType() ||
1728 T->isObjCQualifiedClassType()) {
1729 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001730 CGM.getContext().getObjCClassRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001731 }
1732 if (T->isObjCObjectPointerType())
1733 return CGM.GetAddrOfRTTIDescriptor(T, /*ForEH=*/true);
1734
John McCall2ca705e2010-07-24 00:37:23 +00001735 llvm_unreachable("asking for catch type for ObjC type in fragile runtime");
John McCall2ca705e2010-07-24 00:37:23 +00001736}
1737
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001738/// Generate a constant CFString object.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001739/*
1740 struct __builtin_CFString {
1741 const int *isa; // point to __CFConstantStringClassReference
1742 int flags;
1743 const char *str;
1744 long length;
1745 };
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001746*/
1747
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001748/// or Generate a constant NSString object.
1749/*
1750 struct __builtin_NSString {
1751 const int *isa; // point to __NSConstantStringClassReference
1752 const char *str;
1753 unsigned int length;
1754 };
1755*/
1756
John McCall7f416cc2015-09-08 08:05:57 +00001757ConstantAddress CGObjCCommonMac::GenerateConstantString(
David Chisnall481e3a82010-01-23 02:40:42 +00001758 const StringLiteral *SL) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001759 return (CGM.getLangOpts().NoConstantCFStrings == 0 ?
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001760 CGM.GetAddrOfConstantCFString(SL) :
Fariborz Jahanian50c925f2010-10-19 17:19:29 +00001761 CGM.GetAddrOfConstantString(SL));
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001762}
1763
Ted Kremeneke65b0862012-03-06 20:05:56 +00001764enum {
1765 kCFTaggedObjectID_Integer = (1 << 1) + 1
1766};
1767
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001768/// Generates a message send where the super is the receiver. This is
1769/// a message send to self with special delivery semantics indicating
1770/// which class's method should be called.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001771CodeGen::RValue
1772CGObjCMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001773 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001774 QualType ResultType,
1775 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001776 const ObjCInterfaceDecl *Class,
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001777 bool isCategoryImpl,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001778 llvm::Value *Receiver,
Daniel Dunbarc722b852008-08-30 03:02:31 +00001779 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001780 const CodeGen::CallArgList &CallArgs,
1781 const ObjCMethodDecl *Method) {
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001782 // Create and init a super structure; this is a (receiver, class)
1783 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00001784 Address ObjCSuper =
1785 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
1786 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001787 llvm::Value *ReceiverAsObject =
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001788 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00001789 CGF.Builder.CreateStore(
1790 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00001791 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001792
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001793 // If this is a class message the metaclass is passed as the target.
1794 llvm::Value *Target;
1795 if (IsClassMessage) {
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001796 if (isCategoryImpl) {
1797 // Message sent to 'super' in a class method defined in a category
1798 // implementation requires an odd treatment.
1799 // If we are in a class method, we must retrieve the
1800 // _metaclass_ for the current class, pointed at by
1801 // the class's "isa" pointer. The following assumes that
1802 // isa" is the first ivar in a class (which it must be).
John McCall882987f2013-02-28 19:01:20 +00001803 Target = EmitClassRef(CGF, Class->getSuperClass());
David Blaikie1ed728c2015-04-05 22:45:47 +00001804 Target = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, Target, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001805 Target = CGF.Builder.CreateAlignedLoad(Target, CGF.getPointerAlign());
Mike Stump658fe022009-07-30 22:28:39 +00001806 } else {
David Blaikie1ed728c2015-04-05 22:45:47 +00001807 llvm::Constant *MetaClassPtr = EmitMetaClassRef(Class);
1808 llvm::Value *SuperPtr =
1809 CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, MetaClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00001810 llvm::Value *Super =
1811 CGF.Builder.CreateAlignedLoad(SuperPtr, CGF.getPointerAlign());
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001812 Target = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001813 }
David Blaikie1ed728c2015-04-05 22:45:47 +00001814 } else if (isCategoryImpl)
John McCall882987f2013-02-28 19:01:20 +00001815 Target = EmitClassRef(CGF, Class->getSuperClass());
Fariborz Jahanianda2efb02009-11-14 02:18:31 +00001816 else {
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001817 llvm::Value *ClassPtr = EmitSuperClassRef(Class);
David Blaikie1ed728c2015-04-05 22:45:47 +00001818 ClassPtr = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, ClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00001819 Target = CGF.Builder.CreateAlignedLoad(ClassPtr, CGF.getPointerAlign());
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001820 }
Mike Stump18bb9282009-05-16 07:57:57 +00001821 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
1822 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00001823 llvm::Type *ClassTy =
Daniel Dunbarc722b852008-08-30 03:02:31 +00001824 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
Daniel Dunbarc475d422008-10-29 22:36:39 +00001825 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
John McCall7f416cc2015-09-08 08:05:57 +00001826 CGF.Builder.CreateStore(Target,
1827 CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
John McCall9e8bb002011-05-14 03:10:52 +00001828 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00001829 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00001830 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00001831 true, CallArgs, Method, Class, ObjCTypes);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001832}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001833
1834/// Generate code for a message send expression.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001835CodeGen::RValue CGObjCMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001836 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001837 QualType ResultType,
1838 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001839 llvm::Value *Receiver,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001840 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00001841 const ObjCInterfaceDecl *Class,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001842 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00001843 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00001844 EmitSelector(CGF, Sel),
John McCall9e8bb002011-05-14 03:10:52 +00001845 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00001846 false, CallArgs, Method, Class, ObjCTypes);
1847}
1848
1849static bool isWeakLinkedClass(const ObjCInterfaceDecl *ID) {
1850 do {
1851 if (ID->isWeakImported())
1852 return true;
1853 } while ((ID = ID->getSuperClass()));
1854
1855 return false;
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00001856}
1857
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001858CodeGen::RValue
John McCall9e8bb002011-05-14 03:10:52 +00001859CGObjCCommonMac::EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1860 ReturnValueSlot Return,
1861 QualType ResultType,
1862 llvm::Value *Sel,
1863 llvm::Value *Arg0,
1864 QualType Arg0Ty,
1865 bool IsSuper,
1866 const CallArgList &CallArgs,
1867 const ObjCMethodDecl *Method,
John McCall1e3157b2015-09-10 22:27:50 +00001868 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00001869 const ObjCCommonTypesHelper &ObjCTypes) {
Daniel Dunbarc722b852008-08-30 03:02:31 +00001870 CallArgList ActualArgs;
Fariborz Jahanian969bc682009-04-24 21:07:43 +00001871 if (!IsSuper)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001872 Arg0 = CGF.Builder.CreateBitCast(Arg0, ObjCTypes.ObjectPtrTy);
Eli Friedman43dca6a2011-05-02 17:57:46 +00001873 ActualArgs.add(RValue::get(Arg0), Arg0Ty);
1874 ActualArgs.add(RValue::get(Sel), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00001875 ActualArgs.addFrom(CallArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001876
John McCalla729c622012-02-17 03:33:10 +00001877 // If we're calling a method, use the formal signature.
1878 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001879
Anders Carlsson280e61f12010-06-21 20:59:55 +00001880 if (Method)
Alp Toker314cc812014-01-25 16:55:45 +00001881 assert(CGM.getContext().getCanonicalType(Method->getReturnType()) ==
1882 CGM.getContext().getCanonicalType(ResultType) &&
Anders Carlsson280e61f12010-06-21 20:59:55 +00001883 "Result type mismatch!");
1884
John McCall1e3157b2015-09-10 22:27:50 +00001885 bool ReceiverCanBeNull = true;
1886
1887 // Super dispatch assumes that self is non-null; even the messenger
1888 // doesn't have a null check internally.
1889 if (IsSuper) {
1890 ReceiverCanBeNull = false;
1891
1892 // If this is a direct dispatch of a class method, check whether the class,
1893 // or anything in its hierarchy, was weak-linked.
1894 } else if (ClassReceiver && Method && Method->isClassMethod()) {
1895 ReceiverCanBeNull = isWeakLinkedClass(ClassReceiver);
1896
1897 // If we're emitting a method, and self is const (meaning just ARC, for now),
1898 // and the receiver is a load of self, then self is a valid object.
1899 } else if (auto CurMethod =
1900 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl)) {
1901 auto Self = CurMethod->getSelfDecl();
1902 if (Self->getType().isConstQualified()) {
1903 if (auto LI = dyn_cast<llvm::LoadInst>(Arg0->stripPointerCasts())) {
1904 llvm::Value *SelfAddr = CGF.GetAddrOfLocalVar(Self).getPointer();
1905 if (SelfAddr == LI->getPointerOperand()) {
1906 ReceiverCanBeNull = false;
1907 }
1908 }
1909 }
1910 }
1911
John McCall5880fb82011-05-14 21:12:11 +00001912 NullReturnState nullReturn;
1913
Craig Topper8a13c412014-05-21 05:09:00 +00001914 llvm::Constant *Fn = nullptr;
Tim Northovere77cc392014-03-29 13:28:05 +00001915 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall1e3157b2015-09-10 22:27:50 +00001916 if (ReceiverCanBeNull) nullReturn.init(CGF, Arg0);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00001917 Fn = (ObjCABI == 2) ? ObjCTypes.getSendStretFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001918 : ObjCTypes.getSendStretFn(IsSuper);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001919 } else if (CGM.ReturnTypeUsesFPRet(ResultType)) {
1920 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFpretFn2(IsSuper)
1921 : ObjCTypes.getSendFpretFn(IsSuper);
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001922 } else if (CGM.ReturnTypeUsesFP2Ret(ResultType)) {
1923 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFp2RetFn2(IsSuper)
1924 : ObjCTypes.getSendFp2retFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00001925 } else {
Tim Northovere77cc392014-03-29 13:28:05 +00001926 // arm64 uses objc_msgSend for stret methods and yet null receiver check
1927 // must be made for it.
Ahmed Bougachaa3df87b2015-10-02 22:41:59 +00001928 if (ReceiverCanBeNull && CGM.ReturnTypeUsesSRet(MSI.CallInfo))
Tim Northovere77cc392014-03-29 13:28:05 +00001929 nullReturn.init(CGF, Arg0);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00001930 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001931 : ObjCTypes.getSendFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00001932 }
John McCall1e3157b2015-09-10 22:27:50 +00001933
1934 // Emit a null-check if there's a consumed argument other than the receiver.
1935 bool RequiresNullCheck = false;
1936 if (ReceiverCanBeNull && CGM.getLangOpts().ObjCAutoRefCount && Method) {
Aaron Ballman43b68be2014-03-07 17:50:17 +00001937 for (const auto *ParamDecl : Method->params()) {
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001938 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1939 if (!nullReturn.NullBB)
1940 nullReturn.init(CGF, Arg0);
John McCall1e3157b2015-09-10 22:27:50 +00001941 RequiresNullCheck = true;
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001942 break;
1943 }
1944 }
John McCall1e3157b2015-09-10 22:27:50 +00001945 }
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001946
John McCall1e3157b2015-09-10 22:27:50 +00001947 llvm::Instruction *CallSite;
John McCalla729c622012-02-17 03:33:10 +00001948 Fn = llvm::ConstantExpr::getBitCast(Fn, MSI.MessengerType);
John McCall1e3157b2015-09-10 22:27:50 +00001949 RValue rvalue = CGF.EmitCall(MSI.CallInfo, Fn, Return, ActualArgs,
Samuel Antao798f11c2015-11-23 22:04:44 +00001950 CGCalleeInfo(), &CallSite);
John McCall1e3157b2015-09-10 22:27:50 +00001951
1952 // Mark the call as noreturn if the method is marked noreturn and the
1953 // receiver cannot be null.
1954 if (Method && Method->hasAttr<NoReturnAttr>() && !ReceiverCanBeNull) {
1955 llvm::CallSite(CallSite).setDoesNotReturn();
1956 }
1957
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001958 return nullReturn.complete(CGF, rvalue, ResultType, CallArgs,
John McCall1e3157b2015-09-10 22:27:50 +00001959 RequiresNullCheck ? Method : nullptr);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001960}
1961
John McCall3fd13f062015-10-21 18:06:47 +00001962static Qualifiers::GC GetGCAttrTypeForType(ASTContext &Ctx, QualType FQT,
1963 bool pointee = false) {
1964 // Note that GC qualification applies recursively to C pointer types
1965 // that aren't otherwise decorated. This is weird, but it's probably
1966 // an intentional workaround to the unreliable placement of GC qualifiers.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001967 if (FQT.isObjCGCStrong())
1968 return Qualifiers::Strong;
John McCall3fd13f062015-10-21 18:06:47 +00001969
1970 if (FQT.isObjCGCWeak())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001971 return Qualifiers::Weak;
John McCall3fd13f062015-10-21 18:06:47 +00001972
1973 if (auto ownership = FQT.getObjCLifetime()) {
1974 // Ownership does not apply recursively to C pointer types.
1975 if (pointee) return Qualifiers::GCNone;
1976 switch (ownership) {
1977 case Qualifiers::OCL_Weak: return Qualifiers::Weak;
1978 case Qualifiers::OCL_Strong: return Qualifiers::Strong;
1979 case Qualifiers::OCL_ExplicitNone: return Qualifiers::GCNone;
1980 case Qualifiers::OCL_Autoreleasing: llvm_unreachable("autoreleasing ivar?");
1981 case Qualifiers::OCL_None: llvm_unreachable("known nonzero");
1982 }
1983 llvm_unreachable("bad objc ownership");
1984 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001985
John McCall3fd13f062015-10-21 18:06:47 +00001986 // Treat unqualified retainable pointers as strong.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001987 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
1988 return Qualifiers::Strong;
1989
John McCall3fd13f062015-10-21 18:06:47 +00001990 // Walk into C pointer types, but only in GC.
1991 if (Ctx.getLangOpts().getGC() != LangOptions::NonGC) {
1992 if (const PointerType *PT = FQT->getAs<PointerType>())
1993 return GetGCAttrTypeForType(Ctx, PT->getPointeeType(), /*pointee*/ true);
1994 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001995
1996 return Qualifiers::GCNone;
1997}
1998
John McCall3fd13f062015-10-21 18:06:47 +00001999namespace {
2000 struct IvarInfo {
2001 CharUnits Offset;
2002 uint64_t SizeInWords;
2003 IvarInfo(CharUnits offset, uint64_t sizeInWords)
2004 : Offset(offset), SizeInWords(sizeInWords) {}
2005
2006 // Allow sorting based on byte pos.
2007 bool operator<(const IvarInfo &other) const {
2008 return Offset < other.Offset;
2009 }
2010 };
2011
2012 /// A helper class for building GC layout strings.
2013 class IvarLayoutBuilder {
2014 CodeGenModule &CGM;
2015
2016 /// The start of the layout. Offsets will be relative to this value,
2017 /// and entries less than this value will be silently discarded.
2018 CharUnits InstanceBegin;
2019
2020 /// The end of the layout. Offsets will never exceed this value.
2021 CharUnits InstanceEnd;
2022
2023 /// Whether we're generating the strong layout or the weak layout.
2024 bool ForStrongLayout;
2025
2026 /// Whether the offsets in IvarsInfo might be out-of-order.
2027 bool IsDisordered = false;
2028
2029 llvm::SmallVector<IvarInfo, 8> IvarsInfo;
2030 public:
2031 IvarLayoutBuilder(CodeGenModule &CGM, CharUnits instanceBegin,
2032 CharUnits instanceEnd, bool forStrongLayout)
2033 : CGM(CGM), InstanceBegin(instanceBegin), InstanceEnd(instanceEnd),
2034 ForStrongLayout(forStrongLayout) {
2035 }
2036
2037 void visitRecord(const RecordType *RT, CharUnits offset);
2038
2039 template <class Iterator, class GetOffsetFn>
2040 void visitAggregate(Iterator begin, Iterator end,
2041 CharUnits aggrOffset,
2042 const GetOffsetFn &getOffset);
2043
2044 void visitField(const FieldDecl *field, CharUnits offset);
2045
2046 /// Add the layout of a block implementation.
2047 void visitBlock(const CGBlockInfo &blockInfo);
2048
2049 /// Is there any information for an interesting bitmap?
2050 bool hasBitmapData() const { return !IvarsInfo.empty(); }
2051
2052 llvm::Constant *buildBitmap(CGObjCCommonMac &CGObjC,
2053 llvm::SmallVectorImpl<unsigned char> &buffer);
2054
2055 static void dump(ArrayRef<unsigned char> buffer) {
2056 const unsigned char *s = buffer.data();
2057 for (unsigned i = 0, e = buffer.size(); i < e; i++)
2058 if (!(s[i] & 0xf0))
2059 printf("0x0%x%s", s[i], s[i] != 0 ? ", " : "");
2060 else
2061 printf("0x%x%s", s[i], s[i] != 0 ? ", " : "");
2062 printf("\n");
2063 }
2064 };
2065}
2066
John McCall351762c2011-02-07 10:33:21 +00002067llvm::Constant *CGObjCCommonMac::BuildGCBlockLayout(CodeGenModule &CGM,
2068 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002069
Chris Lattnerece04092012-02-07 00:39:47 +00002070 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
John McCall460ce582015-10-22 18:38:17 +00002071 if (CGM.getLangOpts().getGC() == LangOptions::NonGC)
John McCall351762c2011-02-07 10:33:21 +00002072 return nullPtr;
2073
John McCall3fd13f062015-10-21 18:06:47 +00002074 IvarLayoutBuilder builder(CGM, CharUnits::Zero(), blockInfo.BlockSize,
2075 /*for strong layout*/ true);
2076
2077 builder.visitBlock(blockInfo);
2078
2079 if (!builder.hasBitmapData())
2080 return nullPtr;
2081
2082 llvm::SmallVector<unsigned char, 32> buffer;
2083 llvm::Constant *C = builder.buildBitmap(*this, buffer);
John McCallf5ea0722015-10-29 23:36:14 +00002084 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
John McCall3fd13f062015-10-21 18:06:47 +00002085 printf("\n block variable layout for block: ");
2086 builder.dump(buffer);
2087 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002088
John McCall3fd13f062015-10-21 18:06:47 +00002089 return C;
2090}
2091
2092void IvarLayoutBuilder::visitBlock(const CGBlockInfo &blockInfo) {
Fariborz Jahaniancfddabf2010-09-09 00:21:45 +00002093 // __isa is the first field in block descriptor and must assume by runtime's
2094 // convention that it is GC'able.
John McCall3fd13f062015-10-21 18:06:47 +00002095 IvarsInfo.push_back(IvarInfo(CharUnits::Zero(), 1));
John McCall351762c2011-02-07 10:33:21 +00002096
2097 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2098
John McCall351762c2011-02-07 10:33:21 +00002099 // Ignore the optional 'this' capture: C++ objects are not assumed
2100 // to be GC'ed.
2101
John McCall3fd13f062015-10-21 18:06:47 +00002102 CharUnits lastFieldOffset;
2103
John McCall351762c2011-02-07 10:33:21 +00002104 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002105 for (const auto &CI : blockDecl->captures()) {
2106 const VarDecl *variable = CI.getVariable();
John McCall351762c2011-02-07 10:33:21 +00002107 QualType type = variable->getType();
2108
2109 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2110
2111 // Ignore constant captures.
2112 if (capture.isConstant()) continue;
2113
John McCall3fd13f062015-10-21 18:06:47 +00002114 CharUnits fieldOffset = capture.getOffset();
2115
2116 // Block fields are not necessarily ordered; if we detect that we're
2117 // adding them out-of-order, make sure we sort later.
2118 if (fieldOffset < lastFieldOffset)
2119 IsDisordered = true;
2120 lastFieldOffset = fieldOffset;
John McCall351762c2011-02-07 10:33:21 +00002121
2122 // __block variables are passed by their descriptor address.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002123 if (CI.isByRef()) {
John McCall3fd13f062015-10-21 18:06:47 +00002124 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
Fariborz Jahanian933c6722010-09-11 01:27:29 +00002125 continue;
John McCall351762c2011-02-07 10:33:21 +00002126 }
2127
2128 assert(!type->isArrayType() && "array variable should not be caught");
2129 if (const RecordType *record = type->getAs<RecordType>()) {
John McCall3fd13f062015-10-21 18:06:47 +00002130 visitRecord(record, fieldOffset);
Fariborz Jahanian903aba32010-08-05 21:00:25 +00002131 continue;
2132 }
Fariborz Jahanianf95e3582010-08-06 16:28:55 +00002133
John McCall351762c2011-02-07 10:33:21 +00002134 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), type);
John McCall351762c2011-02-07 10:33:21 +00002135
John McCall3fd13f062015-10-21 18:06:47 +00002136 if (GCAttr == Qualifiers::Strong) {
2137 assert(CGM.getContext().getTypeSize(type)
2138 == CGM.getTarget().getPointerWidth(0));
2139 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
2140 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002141 }
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00002142}
2143
John McCall3fd13f062015-10-21 18:06:47 +00002144
Fariborz Jahanian2c96d302012-11-04 18:19:40 +00002145/// getBlockCaptureLifetime - This routine returns life time of the captured
2146/// block variable for the purpose of block layout meta-data generation. FQT is
2147/// the type of the variable captured in the block.
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002148Qualifiers::ObjCLifetime CGObjCCommonMac::getBlockCaptureLifetime(QualType FQT,
2149 bool ByrefLayout) {
John McCall460ce582015-10-22 18:38:17 +00002150 // If it has an ownership qualifier, we're done.
2151 if (auto lifetime = FQT.getObjCLifetime())
2152 return lifetime;
2153
2154 // If it doesn't, and this is ARC, it has no ownership.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002155 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall460ce582015-10-22 18:38:17 +00002156 return Qualifiers::OCL_None;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002157
John McCall460ce582015-10-22 18:38:17 +00002158 // In MRC, retainable pointers are owned by non-__block variables.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002159 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002160 return ByrefLayout ? Qualifiers::OCL_ExplicitNone : Qualifiers::OCL_Strong;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002161
2162 return Qualifiers::OCL_None;
2163}
2164
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002165void CGObjCCommonMac::UpdateRunSkipBlockVars(bool IsByref,
2166 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002167 CharUnits FieldOffset,
2168 CharUnits FieldSize) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002169 // __block variables are passed by their descriptor address.
2170 if (IsByref)
2171 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_BYREF, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002172 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002173 else if (LifeTime == Qualifiers::OCL_Strong)
2174 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_STRONG, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002175 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002176 else if (LifeTime == Qualifiers::OCL_Weak)
2177 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_WEAK, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002178 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002179 else if (LifeTime == Qualifiers::OCL_ExplicitNone)
2180 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_UNRETAINED, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002181 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002182 else
2183 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_NON_OBJECT_BYTES,
2184 FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002185 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002186}
2187
2188void CGObjCCommonMac::BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
2189 const RecordDecl *RD,
2190 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002191 CharUnits BytePos, bool &HasUnion,
2192 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002193 bool IsUnion = (RD && RD->isUnion());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002194 CharUnits MaxUnionSize = CharUnits::Zero();
Craig Topper8a13c412014-05-21 05:09:00 +00002195 const FieldDecl *MaxField = nullptr;
2196 const FieldDecl *LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002197 CharUnits MaxFieldOffset = CharUnits::Zero();
2198 CharUnits LastBitfieldOrUnnamedOffset = CharUnits::Zero();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002199
2200 if (RecFields.empty())
2201 return;
John McCallc8e01702013-04-16 22:48:15 +00002202 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002203
2204 for (unsigned i = 0, e = RecFields.size(); i != e; ++i) {
2205 const FieldDecl *Field = RecFields[i];
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002206 // Note that 'i' here is actually the field index inside RD of Field,
2207 // although this dependency is hidden.
2208 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002209 CharUnits FieldOffset =
2210 CGM.getContext().toCharUnitsFromBits(RL.getFieldOffset(i));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002211
2212 // Skip over unnamed or bitfields
2213 if (!Field->getIdentifier() || Field->isBitField()) {
2214 LastFieldBitfieldOrUnnamed = Field;
2215 LastBitfieldOrUnnamedOffset = FieldOffset;
2216 continue;
2217 }
Craig Topper8a13c412014-05-21 05:09:00 +00002218
2219 LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002220 QualType FQT = Field->getType();
2221 if (FQT->isRecordType() || FQT->isUnionType()) {
2222 if (FQT->isUnionType())
2223 HasUnion = true;
2224
2225 BuildRCBlockVarRecordLayout(FQT->getAs<RecordType>(),
2226 BytePos + FieldOffset, HasUnion);
2227 continue;
2228 }
2229
2230 if (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2231 const ConstantArrayType *CArray =
2232 dyn_cast_or_null<ConstantArrayType>(Array);
2233 uint64_t ElCount = CArray->getSize().getZExtValue();
2234 assert(CArray && "only array with known element size is supported");
2235 FQT = CArray->getElementType();
2236 while (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2237 const ConstantArrayType *CArray =
2238 dyn_cast_or_null<ConstantArrayType>(Array);
2239 ElCount *= CArray->getSize().getZExtValue();
2240 FQT = CArray->getElementType();
2241 }
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002242 if (FQT->isRecordType() && ElCount) {
2243 int OldIndex = RunSkipBlockVars.size() - 1;
2244 const RecordType *RT = FQT->getAs<RecordType>();
2245 BuildRCBlockVarRecordLayout(RT, BytePos + FieldOffset,
2246 HasUnion);
2247
2248 // Replicate layout information for each array element. Note that
2249 // one element is already done.
2250 uint64_t ElIx = 1;
2251 for (int FirstIndex = RunSkipBlockVars.size() - 1 ;ElIx < ElCount; ElIx++) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002252 CharUnits Size = CGM.getContext().getTypeSizeInChars(RT);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002253 for (int i = OldIndex+1; i <= FirstIndex; ++i)
2254 RunSkipBlockVars.push_back(
2255 RUN_SKIP(RunSkipBlockVars[i].opcode,
2256 RunSkipBlockVars[i].block_var_bytepos + Size*ElIx,
2257 RunSkipBlockVars[i].block_var_size));
2258 }
2259 continue;
2260 }
2261 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002262 CharUnits FieldSize = CGM.getContext().getTypeSizeInChars(Field->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002263 if (IsUnion) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002264 CharUnits UnionIvarSize = FieldSize;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002265 if (UnionIvarSize > MaxUnionSize) {
2266 MaxUnionSize = UnionIvarSize;
2267 MaxField = Field;
2268 MaxFieldOffset = FieldOffset;
2269 }
2270 } else {
2271 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002272 getBlockCaptureLifetime(FQT, ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002273 BytePos + FieldOffset,
2274 FieldSize);
2275 }
2276 }
2277
2278 if (LastFieldBitfieldOrUnnamed) {
2279 if (LastFieldBitfieldOrUnnamed->isBitField()) {
2280 // Last field was a bitfield. Must update the info.
2281 uint64_t BitFieldSize
2282 = LastFieldBitfieldOrUnnamed->getBitWidthValue(CGM.getContext());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002283 unsigned UnsSize = (BitFieldSize / ByteSizeInBits) +
Eli Friedman8cbca202012-11-06 22:15:52 +00002284 ((BitFieldSize % ByteSizeInBits) != 0);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002285 CharUnits Size = CharUnits::fromQuantity(UnsSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002286 Size += LastBitfieldOrUnnamedOffset;
2287 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002288 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2289 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002290 BytePos + LastBitfieldOrUnnamedOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002291 Size);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002292 } else {
2293 assert(!LastFieldBitfieldOrUnnamed->getIdentifier() &&"Expected unnamed");
2294 // Last field was unnamed. Must update skip info.
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002295 CharUnits FieldSize
2296 = CGM.getContext().getTypeSizeInChars(LastFieldBitfieldOrUnnamed->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002297 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002298 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2299 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002300 BytePos + LastBitfieldOrUnnamedOffset,
2301 FieldSize);
2302 }
2303 }
2304
2305 if (MaxField)
2306 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002307 getBlockCaptureLifetime(MaxField->getType(), ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002308 BytePos + MaxFieldOffset,
2309 MaxUnionSize);
2310}
2311
2312void CGObjCCommonMac::BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002313 CharUnits BytePos,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002314 bool &HasUnion,
2315 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002316 const RecordDecl *RD = RT->getDecl();
Aaron Ballman62e47c42014-03-10 13:43:55 +00002317 SmallVector<const FieldDecl*, 16> Fields(RD->fields());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002318 llvm::Type *Ty = CGM.getTypes().ConvertType(QualType(RT, 0));
2319 const llvm::StructLayout *RecLayout =
2320 CGM.getDataLayout().getStructLayout(cast<llvm::StructType>(Ty));
2321
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002322 BuildRCRecordLayout(RecLayout, RD, Fields, BytePos, HasUnion, ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002323}
2324
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002325/// InlineLayoutInstruction - This routine produce an inline instruction for the
2326/// block variable layout if it can. If not, it returns 0. Rules are as follow:
2327/// If ((uintptr_t) layout) < (1 << 12), the layout is inline. In the 64bit world,
2328/// an inline layout of value 0x0000000000000xyz is interpreted as follows:
2329/// x captured object pointers of BLOCK_LAYOUT_STRONG. Followed by
2330/// y captured object of BLOCK_LAYOUT_BYREF. Followed by
2331/// z captured object of BLOCK_LAYOUT_WEAK. If any of the above is missing, zero
2332/// replaces it. For example, 0x00000x00 means x BLOCK_LAYOUT_STRONG and no
2333/// BLOCK_LAYOUT_BYREF and no BLOCK_LAYOUT_WEAK objects are captured.
2334uint64_t CGObjCCommonMac::InlineLayoutInstruction(
2335 SmallVectorImpl<unsigned char> &Layout) {
2336 uint64_t Result = 0;
2337 if (Layout.size() <= 3) {
2338 unsigned size = Layout.size();
2339 unsigned strong_word_count = 0, byref_word_count=0, weak_word_count=0;
2340 unsigned char inst;
2341 enum BLOCK_LAYOUT_OPCODE opcode ;
2342 switch (size) {
2343 case 3:
2344 inst = Layout[0];
2345 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2346 if (opcode == BLOCK_LAYOUT_STRONG)
2347 strong_word_count = (inst & 0xF)+1;
2348 else
2349 return 0;
2350 inst = Layout[1];
2351 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2352 if (opcode == BLOCK_LAYOUT_BYREF)
2353 byref_word_count = (inst & 0xF)+1;
2354 else
2355 return 0;
2356 inst = Layout[2];
2357 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2358 if (opcode == BLOCK_LAYOUT_WEAK)
2359 weak_word_count = (inst & 0xF)+1;
2360 else
2361 return 0;
2362 break;
2363
2364 case 2:
2365 inst = Layout[0];
2366 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2367 if (opcode == BLOCK_LAYOUT_STRONG) {
2368 strong_word_count = (inst & 0xF)+1;
2369 inst = Layout[1];
2370 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2371 if (opcode == BLOCK_LAYOUT_BYREF)
2372 byref_word_count = (inst & 0xF)+1;
2373 else if (opcode == BLOCK_LAYOUT_WEAK)
2374 weak_word_count = (inst & 0xF)+1;
2375 else
2376 return 0;
2377 }
2378 else if (opcode == BLOCK_LAYOUT_BYREF) {
2379 byref_word_count = (inst & 0xF)+1;
2380 inst = Layout[1];
2381 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2382 if (opcode == BLOCK_LAYOUT_WEAK)
2383 weak_word_count = (inst & 0xF)+1;
2384 else
2385 return 0;
2386 }
2387 else
2388 return 0;
2389 break;
2390
2391 case 1:
2392 inst = Layout[0];
2393 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2394 if (opcode == BLOCK_LAYOUT_STRONG)
2395 strong_word_count = (inst & 0xF)+1;
2396 else if (opcode == BLOCK_LAYOUT_BYREF)
2397 byref_word_count = (inst & 0xF)+1;
2398 else if (opcode == BLOCK_LAYOUT_WEAK)
2399 weak_word_count = (inst & 0xF)+1;
2400 else
2401 return 0;
2402 break;
2403
2404 default:
2405 return 0;
2406 }
2407
2408 // Cannot inline when any of the word counts is 15. Because this is one less
2409 // than the actual work count (so 15 means 16 actual word counts),
2410 // and we can only display 0 thru 15 word counts.
2411 if (strong_word_count == 16 || byref_word_count == 16 || weak_word_count == 16)
2412 return 0;
2413
2414 unsigned count =
2415 (strong_word_count != 0) + (byref_word_count != 0) + (weak_word_count != 0);
2416
2417 if (size == count) {
2418 if (strong_word_count)
2419 Result = strong_word_count;
2420 Result <<= 4;
2421 if (byref_word_count)
2422 Result += byref_word_count;
2423 Result <<= 4;
2424 if (weak_word_count)
2425 Result += weak_word_count;
2426 }
2427 }
2428 return Result;
2429}
2430
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002431llvm::Constant *CGObjCCommonMac::getBitmapBlockLayout(bool ComputeByrefLayout) {
2432 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2433 if (RunSkipBlockVars.empty())
2434 return nullPtr;
John McCallc8e01702013-04-16 22:48:15 +00002435 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2436 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002437 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2438
2439 // Sort on byte position; captures might not be allocated in order,
2440 // and unions can do funny things.
2441 llvm::array_pod_sort(RunSkipBlockVars.begin(), RunSkipBlockVars.end());
2442 SmallVector<unsigned char, 16> Layout;
2443
2444 unsigned size = RunSkipBlockVars.size();
2445 for (unsigned i = 0; i < size; i++) {
2446 enum BLOCK_LAYOUT_OPCODE opcode = RunSkipBlockVars[i].opcode;
2447 CharUnits start_byte_pos = RunSkipBlockVars[i].block_var_bytepos;
2448 CharUnits end_byte_pos = start_byte_pos;
2449 unsigned j = i+1;
2450 while (j < size) {
2451 if (opcode == RunSkipBlockVars[j].opcode) {
2452 end_byte_pos = RunSkipBlockVars[j++].block_var_bytepos;
2453 i++;
2454 }
2455 else
2456 break;
2457 }
2458 CharUnits size_in_bytes =
2459 end_byte_pos - start_byte_pos + RunSkipBlockVars[j-1].block_var_size;
2460 if (j < size) {
2461 CharUnits gap =
2462 RunSkipBlockVars[j].block_var_bytepos -
2463 RunSkipBlockVars[j-1].block_var_bytepos - RunSkipBlockVars[j-1].block_var_size;
2464 size_in_bytes += gap;
2465 }
2466 CharUnits residue_in_bytes = CharUnits::Zero();
2467 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES) {
2468 residue_in_bytes = size_in_bytes % WordSizeInBytes;
2469 size_in_bytes -= residue_in_bytes;
2470 opcode = BLOCK_LAYOUT_NON_OBJECT_WORDS;
2471 }
2472
2473 unsigned size_in_words = size_in_bytes.getQuantity() / WordSizeInBytes;
2474 while (size_in_words >= 16) {
2475 // Note that value in imm. is one less that the actual
2476 // value. So, 0xf means 16 words follow!
2477 unsigned char inst = (opcode << 4) | 0xf;
2478 Layout.push_back(inst);
2479 size_in_words -= 16;
2480 }
2481 if (size_in_words > 0) {
2482 // Note that value in imm. is one less that the actual
2483 // value. So, we subtract 1 away!
2484 unsigned char inst = (opcode << 4) | (size_in_words-1);
2485 Layout.push_back(inst);
2486 }
2487 if (residue_in_bytes > CharUnits::Zero()) {
2488 unsigned char inst =
2489 (BLOCK_LAYOUT_NON_OBJECT_BYTES << 4) | (residue_in_bytes.getQuantity()-1);
2490 Layout.push_back(inst);
2491 }
2492 }
2493
John McCall7f416cc2015-09-08 08:05:57 +00002494 while (!Layout.empty()) {
2495 unsigned char inst = Layout.back();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002496 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2497 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES || opcode == BLOCK_LAYOUT_NON_OBJECT_WORDS)
2498 Layout.pop_back();
2499 else
2500 break;
2501 }
2502
2503 uint64_t Result = InlineLayoutInstruction(Layout);
2504 if (Result != 0) {
2505 // Block variable layout instruction has been inlined.
2506 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2507 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002508 printf("\n Inline BYREF variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002509 else
John McCall7f416cc2015-09-08 08:05:57 +00002510 printf("\n Inline block variable layout: ");
2511 printf("0x0%" PRIx64 "", Result);
2512 if (auto numStrong = (Result & 0xF00) >> 8)
2513 printf(", BL_STRONG:%d", (int) numStrong);
2514 if (auto numByref = (Result & 0x0F0) >> 4)
2515 printf(", BL_BYREF:%d", (int) numByref);
2516 if (auto numWeak = (Result & 0x00F) >> 0)
2517 printf(", BL_WEAK:%d", (int) numWeak);
2518 printf(", BL_OPERATOR:0\n");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002519 }
Vedant Kumar3ed0df02015-12-21 19:43:25 +00002520 return llvm::ConstantInt::get(CGM.IntPtrTy, Result);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002521 }
2522
2523 unsigned char inst = (BLOCK_LAYOUT_OPERATOR << 4) | 0;
2524 Layout.push_back(inst);
2525 std::string BitMap;
2526 for (unsigned i = 0, e = Layout.size(); i != e; i++)
2527 BitMap += Layout[i];
2528
2529 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2530 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002531 printf("\n Byref variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002532 else
John McCall7f416cc2015-09-08 08:05:57 +00002533 printf("\n Block variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002534 for (unsigned i = 0, e = BitMap.size(); i != e; i++) {
2535 unsigned char inst = BitMap[i];
2536 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2537 unsigned delta = 1;
2538 switch (opcode) {
2539 case BLOCK_LAYOUT_OPERATOR:
2540 printf("BL_OPERATOR:");
2541 delta = 0;
2542 break;
2543 case BLOCK_LAYOUT_NON_OBJECT_BYTES:
2544 printf("BL_NON_OBJECT_BYTES:");
2545 break;
2546 case BLOCK_LAYOUT_NON_OBJECT_WORDS:
2547 printf("BL_NON_OBJECT_WORD:");
2548 break;
2549 case BLOCK_LAYOUT_STRONG:
2550 printf("BL_STRONG:");
2551 break;
2552 case BLOCK_LAYOUT_BYREF:
2553 printf("BL_BYREF:");
2554 break;
2555 case BLOCK_LAYOUT_WEAK:
2556 printf("BL_WEAK:");
2557 break;
2558 case BLOCK_LAYOUT_UNRETAINED:
2559 printf("BL_UNRETAINED:");
2560 break;
2561 }
2562 // Actual value of word count is one more that what is in the imm.
2563 // field of the instruction
2564 printf("%d", (inst & 0xf) + delta);
2565 if (i < e-1)
2566 printf(", ");
2567 else
2568 printf("\n");
2569 }
2570 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002571
2572 llvm::GlobalVariable *Entry = CreateMetadataVar(
2573 "OBJC_CLASS_NAME_",
2574 llvm::ConstantDataArray::getString(VMContext, BitMap, false),
John McCall7f416cc2015-09-08 08:05:57 +00002575 "__TEXT,__objc_classname,cstring_literals", CharUnits::One(), true);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002576 return getConstantGEP(VMContext, Entry, 0, 0);
2577}
2578
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002579llvm::Constant *CGObjCCommonMac::BuildRCBlockLayout(CodeGenModule &CGM,
2580 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002581 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2582
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002583 RunSkipBlockVars.clear();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002584 bool hasUnion = false;
2585
John McCallc8e01702013-04-16 22:48:15 +00002586 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2587 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002588 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2589
2590 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2591
2592 // Calculate the basic layout of the block structure.
2593 const llvm::StructLayout *layout =
2594 CGM.getDataLayout().getStructLayout(blockInfo.StructureType);
2595
2596 // Ignore the optional 'this' capture: C++ objects are not assumed
2597 // to be GC'ed.
Fariborz Jahanian4cf177e2012-12-04 17:20:57 +00002598 if (blockInfo.BlockHeaderForcedGapSize != CharUnits::Zero())
2599 UpdateRunSkipBlockVars(false, Qualifiers::OCL_None,
2600 blockInfo.BlockHeaderForcedGapOffset,
2601 blockInfo.BlockHeaderForcedGapSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002602 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002603 for (const auto &CI : blockDecl->captures()) {
2604 const VarDecl *variable = CI.getVariable();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002605 QualType type = variable->getType();
2606
2607 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2608
2609 // Ignore constant captures.
2610 if (capture.isConstant()) continue;
2611
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002612 CharUnits fieldOffset =
2613 CharUnits::fromQuantity(layout->getElementOffset(capture.getIndex()));
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002614
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002615 assert(!type->isArrayType() && "array variable should not be caught");
Aaron Ballman9371dd22014-03-14 18:34:04 +00002616 if (!CI.isByRef())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002617 if (const RecordType *record = type->getAs<RecordType>()) {
2618 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion);
2619 continue;
2620 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002621 CharUnits fieldSize;
Aaron Ballman9371dd22014-03-14 18:34:04 +00002622 if (CI.isByRef())
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002623 fieldSize = CharUnits::fromQuantity(WordSizeInBytes);
2624 else
2625 fieldSize = CGM.getContext().getTypeSizeInChars(type);
Aaron Ballman9371dd22014-03-14 18:34:04 +00002626 UpdateRunSkipBlockVars(CI.isByRef(), getBlockCaptureLifetime(type, false),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002627 fieldOffset, fieldSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002628 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002629 return getBitmapBlockLayout(false);
2630}
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002631
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002632
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002633llvm::Constant *CGObjCCommonMac::BuildByrefLayout(CodeGen::CodeGenModule &CGM,
2634 QualType T) {
2635 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2636 assert(!T->isArrayType() && "__block array variable should not be caught");
2637 CharUnits fieldOffset;
2638 RunSkipBlockVars.clear();
2639 bool hasUnion = false;
2640 if (const RecordType *record = T->getAs<RecordType>()) {
2641 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion, true /*ByrefLayout */);
2642 llvm::Constant *Result = getBitmapBlockLayout(true);
Vedant Kumar2f5bb1152015-12-21 20:21:15 +00002643 if (isa<llvm::ConstantInt>(Result))
2644 Result = llvm::ConstantExpr::getIntToPtr(Result, CGM.Int8PtrTy);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002645 return Result;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002646 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002647 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2648 return nullPtr;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002649}
2650
John McCall882987f2013-02-28 19:01:20 +00002651llvm::Value *CGObjCMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00002652 const ObjCProtocolDecl *PD) {
Daniel Dunbar7050c552008-09-04 04:33:15 +00002653 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002654 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbar7050c552008-09-04 04:33:15 +00002655 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2656
Owen Andersonade90fd2009-07-29 18:54:39 +00002657 return llvm::ConstantExpr::getBitCast(GetProtocolRef(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00002658 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002659}
2660
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002661void CGObjCCommonMac::GenerateProtocol(const ObjCProtocolDecl *PD) {
Mike Stump18bb9282009-05-16 07:57:57 +00002662 // FIXME: We shouldn't need this, the protocol decl should contain enough
2663 // information to tell us whether this was a declaration or a definition.
Daniel Dunbarc475d422008-10-29 22:36:39 +00002664 DefinedProtocols.insert(PD->getIdentifier());
2665
2666 // If we have generated a forward reference to this protocol, emit
2667 // it now. Otherwise do nothing, the protocol objects are lazily
2668 // emitted.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002669 if (Protocols.count(PD->getIdentifier()))
Daniel Dunbarc475d422008-10-29 22:36:39 +00002670 GetOrEmitProtocol(PD);
2671}
2672
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002673llvm::Constant *CGObjCCommonMac::GetProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002674 if (DefinedProtocols.count(PD->getIdentifier()))
2675 return GetOrEmitProtocol(PD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002676
Daniel Dunbarc475d422008-10-29 22:36:39 +00002677 return GetOrEmitProtocolRef(PD);
2678}
2679
Daniel Dunbarb036db82008-08-13 03:21:16 +00002680/*
Rafael Espindolaf9e1e5e2014-02-20 14:09:04 +00002681// Objective-C 1.0 extensions
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002682struct _objc_protocol {
2683struct _objc_protocol_extension *isa;
2684char *protocol_name;
2685struct _objc_protocol_list *protocol_list;
2686struct _objc__method_prototype_list *instance_methods;
2687struct _objc__method_prototype_list *class_methods
2688};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002689
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002690See EmitProtocolExtension().
Daniel Dunbarb036db82008-08-13 03:21:16 +00002691*/
Daniel Dunbarc475d422008-10-29 22:36:39 +00002692llvm::Constant *CGObjCMac::GetOrEmitProtocol(const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00002693 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbarc475d422008-10-29 22:36:39 +00002694
2695 // Early exit if a defining object has already been generated.
2696 if (Entry && Entry->hasInitializer())
2697 return Entry;
2698
Douglas Gregora715bff2012-01-01 19:51:50 +00002699 // Use the protocol definition, if there is one.
2700 if (const ObjCProtocolDecl *Def = PD->getDefinition())
2701 PD = Def;
2702
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002703 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002704 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002705 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2706
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002707 // Construct method lists.
2708 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
2709 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002710 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002711 for (const auto *MD : PD->instance_methods()) {
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002712 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002713 if (!C)
2714 return GetOrEmitProtocolRef(PD);
2715
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002716 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2717 OptInstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002718 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002719 } else {
2720 InstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002721 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002722 }
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002723 }
2724
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002725 for (const auto *MD : PD->class_methods()) {
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002726 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002727 if (!C)
2728 return GetOrEmitProtocolRef(PD);
2729
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002730 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2731 OptClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002732 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002733 } else {
2734 ClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002735 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002736 }
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002737 }
2738
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002739 MethodTypesExt.insert(MethodTypesExt.end(),
2740 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
2741
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002742 llvm::Constant *Values[] = {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002743 EmitProtocolExtension(PD, OptInstanceMethods, OptClassMethods,
2744 MethodTypesExt),
2745 GetClassName(PD->getObjCRuntimeNameAsString()),
2746 EmitProtocolList("OBJC_PROTOCOL_REFS_" + PD->getName(),
2747 PD->protocol_begin(), PD->protocol_end()),
2748 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_" + PD->getName(),
2749 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2750 InstanceMethods),
2751 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_" + PD->getName(),
2752 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2753 ClassMethods)};
Owen Anderson0e0189d2009-07-27 22:29:56 +00002754 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbarb036db82008-08-13 03:21:16 +00002755 Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002756
Daniel Dunbarb036db82008-08-13 03:21:16 +00002757 if (Entry) {
Rafael Espindola5d117f32014-03-06 01:10:46 +00002758 // Already created, update the initializer.
Rafael Espindolab3262952014-05-09 00:43:37 +00002759 assert(Entry->hasPrivateLinkage());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002760 Entry->setInitializer(Init);
2761 } else {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002762 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2763 false, llvm::GlobalValue::PrivateLinkage,
2764 Init, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002765 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002766 // FIXME: Is this necessary? Why only for protocol?
2767 Entry->setAlignment(4);
John McCallf9582a72012-03-30 21:29:05 +00002768
2769 Protocols[PD->getIdentifier()] = Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002770 }
Rafael Espindola060062a2014-03-06 22:15:10 +00002771 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbarc475d422008-10-29 22:36:39 +00002772
2773 return Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002774}
2775
Daniel Dunbarc475d422008-10-29 22:36:39 +00002776llvm::Constant *CGObjCMac::GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00002777 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
2778
2779 if (!Entry) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002780 // We use the initializer as a marker of whether this is a forward
2781 // reference or not. At module finalization we add the empty
2782 // contents for protocols which were referenced but never defined.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002783 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2784 false, llvm::GlobalValue::PrivateLinkage,
2785 nullptr, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002786 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002787 // FIXME: Is this necessary? Why only for protocol?
2788 Entry->setAlignment(4);
2789 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002790
Daniel Dunbarb036db82008-08-13 03:21:16 +00002791 return Entry;
2792}
2793
2794/*
2795 struct _objc_protocol_extension {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002796 uint32_t size;
2797 struct objc_method_description_list *optional_instance_methods;
2798 struct objc_method_description_list *optional_class_methods;
2799 struct objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002800 const char ** extendedMethodTypes;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002801 };
2802*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002803llvm::Constant *
2804CGObjCMac::EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002805 ArrayRef<llvm::Constant*> OptInstanceMethods,
2806 ArrayRef<llvm::Constant*> OptClassMethods,
2807 ArrayRef<llvm::Constant*> MethodTypesExt) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002808 uint64_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00002809 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolExtensionTy);
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002810 llvm::Constant *Values[] = {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002811 llvm::ConstantInt::get(ObjCTypes.IntTy, Size),
2812 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_OPT_" + PD->getName(),
2813 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2814 OptInstanceMethods),
2815 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_OPT_" + PD->getName(),
2816 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2817 OptClassMethods),
2818 EmitPropertyList("OBJC_$_PROP_PROTO_LIST_" + PD->getName(), nullptr, PD,
2819 ObjCTypes),
2820 EmitProtocolMethodTypes("OBJC_PROTOCOL_METHOD_TYPES_" + PD->getName(),
2821 MethodTypesExt, ObjCTypes)};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002822
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002823 // Return null if no extension bits are used.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002824 if (Values[1]->isNullValue() && Values[2]->isNullValue() &&
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002825 Values[3]->isNullValue() && Values[4]->isNullValue())
Owen Anderson0b75f232009-07-31 20:28:54 +00002826 return llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002827
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002828 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00002829 llvm::ConstantStruct::get(ObjCTypes.ProtocolExtensionTy, Values);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002830
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00002831 // No special section, but goes in llvm.used
Alp Toker541d5072014-06-07 23:30:53 +00002832 return CreateMetadataVar("\01l_OBJC_PROTOCOLEXT_" + PD->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00002833 StringRef(), CGM.getPointerAlign(), true);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002834}
2835
2836/*
2837 struct objc_protocol_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00002838 struct objc_protocol_list *next;
2839 long count;
2840 Protocol *list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00002841 };
2842*/
Daniel Dunbardec75f82008-08-21 21:57:41 +00002843llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002844CGObjCMac::EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00002845 ObjCProtocolDecl::protocol_iterator begin,
2846 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002847 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002848
Daniel Dunbardec75f82008-08-21 21:57:41 +00002849 for (; begin != end; ++begin)
2850 ProtocolRefs.push_back(GetProtocolRef(*begin));
Daniel Dunbarb036db82008-08-13 03:21:16 +00002851
2852 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002853 if (ProtocolRefs.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00002854 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002855
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002856 // This list is null terminated.
Owen Anderson0b75f232009-07-31 20:28:54 +00002857 ProtocolRefs.push_back(llvm::Constant::getNullValue(ObjCTypes.ProtocolPtrTy));
Daniel Dunbarb036db82008-08-13 03:21:16 +00002858
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002859 llvm::Constant *Values[3];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002860 // This field is only used by the runtime.
Owen Anderson0b75f232009-07-31 20:28:54 +00002861 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002862 Values[1] = llvm::ConstantInt::get(ObjCTypes.LongTy,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002863 ProtocolRefs.size() - 1);
2864 Values[2] =
2865 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolPtrTy,
2866 ProtocolRefs.size()),
Daniel Dunbarb036db82008-08-13 03:21:16 +00002867 ProtocolRefs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002868
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002869 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002870 llvm::GlobalVariable *GV =
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00002871 CreateMetadataVar(Name, Init, "__OBJC,__cat_cls_meth,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00002872 CGM.getPointerAlign(), false);
Owen Andersonade90fd2009-07-29 18:54:39 +00002873 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002874}
2875
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002876void CGObjCCommonMac::
2877PushProtocolProperties(llvm::SmallPtrSet<const IdentifierInfo*,16> &PropertySet,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002878 SmallVectorImpl<llvm::Constant *> &Properties,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002879 const Decl *Container,
Aaron Ballmandc4bea42014-03-13 18:47:37 +00002880 const ObjCProtocolDecl *Proto,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002881 const ObjCCommonTypesHelper &ObjCTypes) {
Aaron Ballman0f6e64d2014-03-13 22:58:06 +00002882 for (const auto *P : Proto->protocols())
2883 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes);
Aaron Ballmand174edf2014-03-13 19:11:50 +00002884 for (const auto *PD : Proto->properties()) {
David Blaikie82e95a32014-11-19 07:49:47 +00002885 if (!PropertySet.insert(PD->getIdentifier()).second)
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002886 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002887 llvm::Constant *Prop[] = {
2888 GetPropertyName(PD->getIdentifier()),
2889 GetPropertyTypeString(PD, Container)
2890 };
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002891 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy, Prop));
2892 }
2893}
2894
Daniel Dunbarb036db82008-08-13 03:21:16 +00002895/*
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002896 struct _objc_property {
Bill Wendlinga515b582012-02-09 22:16:49 +00002897 const char * const name;
2898 const char * const attributes;
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002899 };
2900
2901 struct _objc_property_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00002902 uint32_t entsize; // sizeof (struct _objc_property)
2903 uint32_t prop_count;
2904 struct _objc_property[prop_count];
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002905 };
2906*/
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002907llvm::Constant *CGObjCCommonMac::EmitPropertyList(Twine Name,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002908 const Decl *Container,
2909 const ObjCContainerDecl *OCD,
2910 const ObjCCommonTypesHelper &ObjCTypes) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002911 SmallVector<llvm::Constant *, 16> Properties;
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002912 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weber08c93332015-12-03 17:44:51 +00002913
2914 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
2915 llvm::Constant *Prop[] = {GetPropertyName(PD->getIdentifier()),
2916 GetPropertyTypeString(PD, Container)};
2917 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy, Prop));
2918 };
2919 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD))
2920 for (const ObjCCategoryDecl *ClassExt : OID->known_extensions())
2921 for (auto *PD : ClassExt->properties()) {
2922 PropertySet.insert(PD->getIdentifier());
2923 AddProperty(PD);
2924 }
Aaron Ballmand174edf2014-03-13 19:11:50 +00002925 for (const auto *PD : OCD->properties()) {
Nico Weber08c93332015-12-03 17:44:51 +00002926 // Don't emit duplicate metadata for properties that were already in a
2927 // class extension.
2928 if (!PropertySet.insert(PD->getIdentifier()).second)
2929 continue;
2930 AddProperty(PD);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002931 }
Nico Weber08c93332015-12-03 17:44:51 +00002932
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002933 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD)) {
Aaron Ballmana9f49e32014-03-13 20:55:22 +00002934 for (const auto *P : OID->all_referenced_protocols())
2935 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002936 }
2937 else if (const ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(OCD)) {
Aaron Ballman19a41762014-03-14 12:55:57 +00002938 for (const auto *P : CD->protocols())
2939 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002940 }
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002941
2942 // Return null for empty list.
2943 if (Properties.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00002944 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002945
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002946 unsigned PropertySize =
Micah Villmowdd31ca12012-10-08 16:25:52 +00002947 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.PropertyTy);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002948 llvm::Constant *Values[3];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002949 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, PropertySize);
2950 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Properties.size());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002951 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.PropertyTy,
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002952 Properties.size());
Owen Anderson47034e12009-07-28 18:33:04 +00002953 Values[2] = llvm::ConstantArray::get(AT, Properties);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002954 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002955
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002956 llvm::GlobalVariable *GV =
2957 CreateMetadataVar(Name, Init,
2958 (ObjCABI == 2) ? "__DATA, __objc_const" :
Daniel Dunbarb25452a2009-04-15 02:56:18 +00002959 "__OBJC,__property,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00002960 CGM.getPointerAlign(),
Daniel Dunbarb25452a2009-04-15 02:56:18 +00002961 true);
Owen Andersonade90fd2009-07-29 18:54:39 +00002962 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002963}
2964
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002965llvm::Constant *
2966CGObjCCommonMac::EmitProtocolMethodTypes(Twine Name,
2967 ArrayRef<llvm::Constant*> MethodTypes,
2968 const ObjCCommonTypesHelper &ObjCTypes) {
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002969 // Return null for empty list.
2970 if (MethodTypes.empty())
2971 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrPtrTy);
2972
2973 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
2974 MethodTypes.size());
2975 llvm::Constant *Init = llvm::ConstantArray::get(AT, MethodTypes);
2976
Alp Toker541d5072014-06-07 23:30:53 +00002977 llvm::GlobalVariable *GV = CreateMetadataVar(
2978 Name, Init, (ObjCABI == 2) ? "__DATA, __objc_const" : StringRef(),
John McCall7f416cc2015-09-08 08:05:57 +00002979 CGM.getPointerAlign(), true);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002980 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.Int8PtrPtrTy);
2981}
2982
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002983/*
Daniel Dunbarb036db82008-08-13 03:21:16 +00002984 struct objc_method_description_list {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002985 int count;
2986 struct objc_method_description list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00002987 };
2988*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002989llvm::Constant *
2990CGObjCMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002991 llvm::Constant *Desc[] = {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002992 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002993 ObjCTypes.SelectorPtrTy),
2994 GetMethodVarType(MD)
2995 };
Douglas Gregora9d84932011-05-27 01:19:52 +00002996 if (!Desc[1])
Craig Topper8a13c412014-05-21 05:09:00 +00002997 return nullptr;
2998
Owen Anderson0e0189d2009-07-27 22:29:56 +00002999 return llvm::ConstantStruct::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003000 Desc);
3001}
Daniel Dunbarb036db82008-08-13 03:21:16 +00003002
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003003llvm::Constant *
3004CGObjCMac::EmitMethodDescList(Twine Name, const char *Section,
3005 ArrayRef<llvm::Constant*> Methods) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00003006 // Return null for empty list.
3007 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003008 return llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003009
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003010 llvm::Constant *Values[2];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003011 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003012 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbarb036db82008-08-13 03:21:16 +00003013 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003014 Values[1] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003015 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003016
John McCall7f416cc2015-09-08 08:05:57 +00003017 llvm::GlobalVariable *GV =
3018 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003019 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbarb036db82008-08-13 03:21:16 +00003020 ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003021}
3022
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003023/*
3024 struct _objc_category {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003025 char *category_name;
3026 char *class_name;
3027 struct _objc_method_list *instance_methods;
3028 struct _objc_method_list *class_methods;
3029 struct _objc_protocol_list *protocols;
3030 uint32_t size; // <rdar://4585769>
3031 struct _objc_property_list *instance_properties;
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003032 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003033*/
Daniel Dunbar92992502008-08-15 22:20:32 +00003034void CGObjCMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00003035 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategoryTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003036
Mike Stump18bb9282009-05-16 07:57:57 +00003037 // FIXME: This is poor design, the OCD should have a pointer to the category
3038 // decl. Additionally, note that Category can be null for the @implementation
3039 // w/o an @interface case. Sema should just create one for us as it does for
3040 // @implementation so everyone else can live life under a clear blue sky.
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003041 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003042 const ObjCCategoryDecl *Category =
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003043 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003044
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003045 SmallString<256> ExtName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003046 llvm::raw_svector_ostream(ExtName) << Interface->getName() << '_'
3047 << OCD->getName();
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003048
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003049 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003050 for (const auto *I : OCD->instance_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003051 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003052 InstanceMethods.push_back(GetMethodConstant(I));
3053
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003054 for (const auto *I : OCD->class_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003055 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003056 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003057
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003058 llvm::Constant *Values[7];
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003059 Values[0] = GetClassName(OCD->getName());
3060 Values[1] = GetClassName(Interface->getObjCRuntimeNameAsString());
Fariborz Jahaniane55f8662009-04-29 20:40:05 +00003061 LazySymbols.insert(Interface->getIdentifier());
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003062 Values[2] = EmitMethodList("OBJC_CATEGORY_INSTANCE_METHODS_" + ExtName.str(),
3063 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
3064 InstanceMethods);
3065 Values[3] = EmitMethodList("OBJC_CATEGORY_CLASS_METHODS_" + ExtName.str(),
3066 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
3067 ClassMethods);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003068 if (Category) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003069 Values[4] =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003070 EmitProtocolList("OBJC_CATEGORY_PROTOCOLS_" + ExtName.str(),
3071 Category->protocol_begin(), Category->protocol_end());
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003072 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003073 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003074 }
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003075 Values[5] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003076
3077 // If there is no category @interface then there can be no properties.
3078 if (Category) {
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003079 Values[6] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
Fariborz Jahanian066347e2009-01-28 22:18:42 +00003080 OCD, Category, ObjCTypes);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003081 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003082 Values[6] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003083 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003084
Owen Anderson0e0189d2009-07-27 22:29:56 +00003085 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.CategoryTy,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003086 Values);
3087
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003088 llvm::GlobalVariable *GV =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003089 CreateMetadataVar("OBJC_CATEGORY_" + ExtName.str(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003090 "__OBJC,__category,regular,no_dead_strip",
3091 CGM.getPointerAlign(), true);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003092 DefinedCategories.push_back(GV);
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00003093 DefinedCategoryNames.insert(ExtName.str());
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003094 // method definition entries must be clear for next implementation.
3095 MethodDefinitions.clear();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003096}
3097
John McCallef19dbb2012-10-17 04:53:23 +00003098enum FragileClassFlags {
John McCall460ce582015-10-22 18:38:17 +00003099 /// Apparently: is not a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003100 FragileABI_Class_Factory = 0x00001,
John McCall460ce582015-10-22 18:38:17 +00003101
3102 /// Is a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003103 FragileABI_Class_Meta = 0x00002,
John McCall460ce582015-10-22 18:38:17 +00003104
3105 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003106 FragileABI_Class_HasCXXStructors = 0x02000,
John McCall460ce582015-10-22 18:38:17 +00003107
3108 /// Has hidden visibility.
John McCall09ec1ec2015-10-21 22:06:03 +00003109 FragileABI_Class_Hidden = 0x20000,
John McCall460ce582015-10-22 18:38:17 +00003110
3111 /// Class implementation was compiled under ARC.
3112 FragileABI_Class_CompiledByARC = 0x04000000,
3113
3114 /// Class implementation was compiled under MRC and has MRC weak ivars.
3115 /// Exclusive with CompiledByARC.
3116 FragileABI_Class_HasMRCWeakIvars = 0x08000000,
John McCallef19dbb2012-10-17 04:53:23 +00003117};
3118
3119enum NonFragileClassFlags {
3120 /// Is a meta-class.
3121 NonFragileABI_Class_Meta = 0x00001,
3122
3123 /// Is a root class.
3124 NonFragileABI_Class_Root = 0x00002,
3125
John McCall460ce582015-10-22 18:38:17 +00003126 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003127 NonFragileABI_Class_HasCXXStructors = 0x00004,
3128
3129 /// Has hidden visibility.
3130 NonFragileABI_Class_Hidden = 0x00010,
3131
3132 /// Has the exception attribute.
3133 NonFragileABI_Class_Exception = 0x00020,
3134
3135 /// (Obsolete) ARC-specific: this class has a .release_ivars method
3136 NonFragileABI_Class_HasIvarReleaser = 0x00040,
3137
3138 /// Class implementation was compiled under ARC.
John McCall0d54a172012-10-17 04:53:31 +00003139 NonFragileABI_Class_CompiledByARC = 0x00080,
3140
3141 /// Class has non-trivial destructors, but zero-initialization is okay.
John McCall460ce582015-10-22 18:38:17 +00003142 NonFragileABI_Class_HasCXXDestructorOnly = 0x00100,
3143
3144 /// Class implementation was compiled under MRC and has MRC weak ivars.
3145 /// Exclusive with CompiledByARC.
3146 NonFragileABI_Class_HasMRCWeakIvars = 0x00200,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003147};
3148
John McCall460ce582015-10-22 18:38:17 +00003149static bool hasWeakMember(QualType type) {
3150 if (type.getObjCLifetime() == Qualifiers::OCL_Weak) {
3151 return true;
3152 }
3153
3154 if (auto recType = type->getAs<RecordType>()) {
3155 for (auto field : recType->getDecl()->fields()) {
3156 if (hasWeakMember(field->getType()))
3157 return true;
3158 }
3159 }
3160
3161 return false;
3162}
3163
3164/// For compatibility, we only want to set the "HasMRCWeakIvars" flag
3165/// (and actually fill in a layout string) if we really do have any
3166/// __weak ivars.
3167static bool hasMRCWeakIvars(CodeGenModule &CGM,
3168 const ObjCImplementationDecl *ID) {
3169 if (!CGM.getLangOpts().ObjCWeak) return false;
3170 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
3171
3172 for (const ObjCIvarDecl *ivar =
3173 ID->getClassInterface()->all_declared_ivar_begin();
3174 ivar; ivar = ivar->getNextIvar()) {
3175 if (hasWeakMember(ivar->getType()))
3176 return true;
3177 }
3178
3179 return false;
3180}
3181
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003182/*
3183 struct _objc_class {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003184 Class isa;
3185 Class super_class;
3186 const char *name;
3187 long version;
3188 long info;
3189 long instance_size;
3190 struct _objc_ivar_list *ivars;
3191 struct _objc_method_list *methods;
3192 struct _objc_cache *cache;
3193 struct _objc_protocol_list *protocols;
3194 // Objective-C 1.0 extensions (<rdr://4585769>)
3195 const char *ivar_layout;
3196 struct _objc_class_ext *ext;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003197 };
3198
3199 See EmitClassExtension();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003200*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003201void CGObjCMac::GenerateClass(const ObjCImplementationDecl *ID) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003202 DefinedSymbols.insert(ID->getIdentifier());
3203
Chris Lattner86d7d912008-11-24 03:54:41 +00003204 std::string ClassName = ID->getNameAsString();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003205 // FIXME: Gross
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003206 ObjCInterfaceDecl *Interface =
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003207 const_cast<ObjCInterfaceDecl*>(ID->getClassInterface());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003208 llvm::Constant *Protocols =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003209 EmitProtocolList("OBJC_CLASS_PROTOCOLS_" + ID->getName(),
3210 Interface->all_referenced_protocol_begin(),
3211 Interface->all_referenced_protocol_end());
John McCallef19dbb2012-10-17 04:53:23 +00003212 unsigned Flags = FragileABI_Class_Factory;
John McCall0d54a172012-10-17 04:53:31 +00003213 if (ID->hasNonZeroConstructors() || ID->hasDestructors())
John McCallef19dbb2012-10-17 04:53:23 +00003214 Flags |= FragileABI_Class_HasCXXStructors;
John McCall09ec1ec2015-10-21 22:06:03 +00003215
John McCall460ce582015-10-22 18:38:17 +00003216 bool hasMRCWeak = false;
3217
John McCall09ec1ec2015-10-21 22:06:03 +00003218 if (CGM.getLangOpts().ObjCAutoRefCount)
3219 Flags |= FragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00003220 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
3221 Flags |= FragileABI_Class_HasMRCWeakIvars;
John McCall09ec1ec2015-10-21 22:06:03 +00003222
John McCall3fd13f062015-10-21 18:06:47 +00003223 CharUnits Size =
3224 CGM.getContext().getASTObjCImplementationLayout(ID).getSize();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003225
3226 // FIXME: Set CXX-structors flag.
John McCall457a04e2010-10-22 21:05:15 +00003227 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003228 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003229
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003230 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003231 for (const auto *I : ID->instance_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003232 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003233 InstanceMethods.push_back(GetMethodConstant(I));
3234
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003235 for (const auto *I : ID->class_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003236 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003237 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003238
Aaron Ballmand85eff42014-03-14 15:02:45 +00003239 for (const auto *PID : ID->property_impls()) {
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003240 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
3241 ObjCPropertyDecl *PD = PID->getPropertyDecl();
3242
3243 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
3244 if (llvm::Constant *C = GetMethodConstant(MD))
3245 InstanceMethods.push_back(C);
3246 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
3247 if (llvm::Constant *C = GetMethodConstant(MD))
3248 InstanceMethods.push_back(C);
3249 }
3250 }
3251
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003252 llvm::Constant *Values[12];
Daniel Dunbarccf61832009-05-03 08:56:52 +00003253 Values[ 0] = EmitMetaClass(ID, Protocols, ClassMethods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003254 if (ObjCInterfaceDecl *Super = Interface->getSuperClass()) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003255 // Record a reference to the super class.
3256 LazySymbols.insert(Super->getIdentifier());
3257
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003258 Values[ 1] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003259 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003260 ObjCTypes.ClassPtrTy);
3261 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003262 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003263 }
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003264 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003265 // Version is always 0.
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003266 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3267 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
John McCall3fd13f062015-10-21 18:06:47 +00003268 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size.getQuantity());
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003269 Values[ 6] = EmitIvarList(ID, false);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003270 Values[7] = EmitMethodList("OBJC_INSTANCE_METHODS_" + ID->getName(),
3271 "__OBJC,__inst_meth,regular,no_dead_strip",
3272 InstanceMethods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003273 // cache is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003274 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003275 Values[ 9] = Protocols;
John McCall460ce582015-10-22 18:38:17 +00003276 Values[10] = BuildStrongIvarLayout(ID, CharUnits::Zero(), Size);
3277 Values[11] = EmitClassExtension(ID, Size, hasMRCWeak);
Owen Anderson0e0189d2009-07-27 22:29:56 +00003278 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003279 Values);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003280 std::string Name("OBJC_CLASS_");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003281 Name += ClassName;
3282 const char *Section = "__OBJC,__class,regular,no_dead_strip";
3283 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003284 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003285 if (GV) {
3286 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3287 "Forward metaclass reference has incorrect type.");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003288 GV->setInitializer(Init);
3289 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003290 GV->setAlignment(CGM.getPointerAlign().getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00003291 CGM.addCompilerUsedGlobal(GV);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003292 } else
John McCall7f416cc2015-09-08 08:05:57 +00003293 GV = CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003294 DefinedClasses.push_back(GV);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00003295 ImplementedClasses.push_back(Interface);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003296 // method definition entries must be clear for next implementation.
3297 MethodDefinitions.clear();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003298}
3299
3300llvm::Constant *CGObjCMac::EmitMetaClass(const ObjCImplementationDecl *ID,
3301 llvm::Constant *Protocols,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003302 ArrayRef<llvm::Constant*> Methods) {
John McCallef19dbb2012-10-17 04:53:23 +00003303 unsigned Flags = FragileABI_Class_Meta;
Micah Villmowdd31ca12012-10-08 16:25:52 +00003304 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003305
John McCall457a04e2010-10-22 21:05:15 +00003306 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003307 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003308
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003309 llvm::Constant *Values[12];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003310 // The isa for the metaclass is the root of the hierarchy.
3311 const ObjCInterfaceDecl *Root = ID->getClassInterface();
3312 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
3313 Root = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003314 Values[ 0] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003315 llvm::ConstantExpr::getBitCast(GetClassName(Root->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003316 ObjCTypes.ClassPtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003317 // The super class for the metaclass is emitted as the name of the
3318 // super class. The runtime fixes this up to point to the
3319 // *metaclass* for the super class.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003320 if (ObjCInterfaceDecl *Super = ID->getClassInterface()->getSuperClass()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003321 Values[ 1] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003322 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003323 ObjCTypes.ClassPtrTy);
3324 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003325 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003326 }
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003327 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003328 // Version is always 0.
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003329 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3330 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
3331 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size);
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003332 Values[ 6] = EmitIvarList(ID, true);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003333 Values[7] =
3334 EmitMethodList("OBJC_CLASS_METHODS_" + ID->getNameAsString(),
3335 "__OBJC,__cls_meth,regular,no_dead_strip", Methods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003336 // cache is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003337 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003338 Values[ 9] = Protocols;
3339 // ivar_layout for metaclass is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003340 Values[10] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003341 // The class extension is always unused for metaclasses.
Owen Anderson0b75f232009-07-31 20:28:54 +00003342 Values[11] = llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00003343 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003344 Values);
3345
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003346 std::string Name("OBJC_METACLASS_");
Benjamin Kramer1bbcbd02012-07-31 11:45:39 +00003347 Name += ID->getName();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003348
3349 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003350 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003351 if (GV) {
3352 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3353 "Forward metaclass reference has incorrect type.");
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003354 GV->setInitializer(Init);
3355 } else {
Owen Andersonc10c8d32009-07-08 19:05:04 +00003356 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003357 llvm::GlobalValue::PrivateLinkage,
Owen Andersonc10c8d32009-07-08 19:05:04 +00003358 Init, Name);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003359 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003360 GV->setSection("__OBJC,__meta_class,regular,no_dead_strip");
Daniel Dunbarae333842009-03-09 22:18:41 +00003361 GV->setAlignment(4);
Rafael Espindola060062a2014-03-06 22:15:10 +00003362 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003363
3364 return GV;
3365}
3366
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003367llvm::Constant *CGObjCMac::EmitMetaClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003368 std::string Name = "OBJC_METACLASS_" + ID->getNameAsString();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003369
Mike Stump18bb9282009-05-16 07:57:57 +00003370 // FIXME: Should we look these up somewhere other than the module. Its a bit
3371 // silly since we only generate these while processing an implementation, so
3372 // exactly one pointer would work if know when we entered/exitted an
3373 // implementation block.
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003374
3375 // Check for an existing forward reference.
Fariborz Jahanian475831b2009-01-07 20:11:22 +00003376 // Previously, metaclass with internal linkage may have been defined.
3377 // pass 'true' as 2nd argument so it is returned.
Rafael Espindola21039aa2014-02-27 16:26:32 +00003378 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3379 if (!GV)
3380 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003381 llvm::GlobalValue::PrivateLinkage, nullptr,
3382 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003383
3384 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3385 "Forward metaclass reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003386 return GV;
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003387}
3388
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003389llvm::Value *CGObjCMac::EmitSuperClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003390 std::string Name = "OBJC_CLASS_" + ID->getNameAsString();
Rafael Espindola21039aa2014-02-27 16:26:32 +00003391 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3392
3393 if (!GV)
3394 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003395 llvm::GlobalValue::PrivateLinkage, nullptr,
3396 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003397
3398 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3399 "Forward class metadata reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003400 return GV;
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003401}
3402
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003403/*
John McCall3fd13f062015-10-21 18:06:47 +00003404 Emit a "class extension", which in this specific context means extra
3405 data that doesn't fit in the normal fragile-ABI class structure, and
3406 has nothing to do with the language concept of a class extension.
3407
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003408 struct objc_class_ext {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003409 uint32_t size;
3410 const char *weak_ivar_layout;
3411 struct _objc_property_list *properties;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003412 };
3413*/
3414llvm::Constant *
John McCall3fd13f062015-10-21 18:06:47 +00003415CGObjCMac::EmitClassExtension(const ObjCImplementationDecl *ID,
John McCall460ce582015-10-22 18:38:17 +00003416 CharUnits InstanceSize, bool hasMRCWeakIvars) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003417 uint64_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00003418 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003419
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003420 llvm::Constant *Values[3];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003421 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
John McCall460ce582015-10-22 18:38:17 +00003422 Values[1] = BuildWeakIvarLayout(ID, CharUnits::Zero(), InstanceSize,
3423 hasMRCWeakIvars);
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003424 Values[2] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ID->getName(),
Fariborz Jahanian066347e2009-01-28 22:18:42 +00003425 ID, ID->getClassInterface(), ObjCTypes);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003426
3427 // Return null if no extension bits are used.
3428 if (Values[1]->isNullValue() && Values[2]->isNullValue())
Owen Anderson0b75f232009-07-31 20:28:54 +00003429 return llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003430
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003431 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00003432 llvm::ConstantStruct::get(ObjCTypes.ClassExtensionTy, Values);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003433 return CreateMetadataVar("OBJC_CLASSEXT_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003434 "__OBJC,__class_ext,regular,no_dead_strip",
3435 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003436}
3437
3438/*
3439 struct objc_ivar {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003440 char *ivar_name;
3441 char *ivar_type;
3442 int ivar_offset;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003443 };
3444
3445 struct objc_ivar_list {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003446 int ivar_count;
3447 struct objc_ivar list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003448 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003449*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003450llvm::Constant *CGObjCMac::EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003451 bool ForClass) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003452 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003453
3454 // When emitting the root class GCC emits ivar entries for the
3455 // actual class structure. It is not clear if we need to follow this
3456 // behavior; for now lets try and get away with not doing it. If so,
3457 // the cleanest solution would be to make up an ObjCInterfaceDecl
3458 // for the class.
3459 if (ForClass)
Owen Anderson0b75f232009-07-31 20:28:54 +00003460 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003461
Jordy Rosea91768e2011-07-22 02:08:32 +00003462 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003463
Jordy Rosea91768e2011-07-22 02:08:32 +00003464 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00003465 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00003466 // Ignore unnamed bit-fields.
3467 if (!IVD->getDeclName())
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003468 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003469 llvm::Constant *Ivar[] = {
3470 GetMethodVarName(IVD->getIdentifier()),
3471 GetMethodVarType(IVD),
3472 llvm::ConstantInt::get(ObjCTypes.IntTy,
Eli Friedman8cbca202012-11-06 22:15:52 +00003473 ComputeIvarBaseOffset(CGM, OID, IVD))
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003474 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00003475 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarTy, Ivar));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003476 }
3477
3478 // Return null for empty list.
3479 if (Ivars.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003480 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003481
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003482 llvm::Constant *Values[2];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003483 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00003484 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003485 Ivars.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003486 Values[1] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003487 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003488
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003489 llvm::GlobalVariable *GV;
3490 if (ForClass)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003491 GV =
3492 CreateMetadataVar("OBJC_CLASS_VARIABLES_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003493 "__OBJC,__class_vars,regular,no_dead_strip",
3494 CGM.getPointerAlign(), true);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003495 else
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003496 GV = CreateMetadataVar("OBJC_INSTANCE_VARIABLES_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003497 "__OBJC,__instance_vars,regular,no_dead_strip",
3498 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003499 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003500}
3501
3502/*
3503 struct objc_method {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003504 SEL method_name;
3505 char *method_types;
3506 void *method;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003507 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003508
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003509 struct objc_method_list {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003510 struct objc_method_list *obsolete;
3511 int count;
3512 struct objc_method methods_list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003513 };
3514*/
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003515
3516/// GetMethodConstant - Return a struct objc_method constant for the
3517/// given method if it has been defined. The result is null if the
3518/// method has not been defined. The return value has type MethodPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003519llvm::Constant *CGObjCMac::GetMethodConstant(const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00003520 llvm::Function *Fn = GetMethodDefinition(MD);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003521 if (!Fn)
Craig Topper8a13c412014-05-21 05:09:00 +00003522 return nullptr;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003523
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003524 llvm::Constant *Method[] = {
Owen Andersonade90fd2009-07-29 18:54:39 +00003525 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003526 ObjCTypes.SelectorPtrTy),
3527 GetMethodVarType(MD),
3528 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
3529 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00003530 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003531}
3532
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003533llvm::Constant *CGObjCMac::EmitMethodList(Twine Name,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003534 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003535 ArrayRef<llvm::Constant*> Methods) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003536 // Return null for empty list.
3537 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003538 return llvm::Constant::getNullValue(ObjCTypes.MethodListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003539
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003540 llvm::Constant *Values[3];
Owen Anderson0b75f232009-07-31 20:28:54 +00003541 Values[0] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003542 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00003543 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003544 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003545 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003546 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003547
John McCall7f416cc2015-09-08 08:05:57 +00003548 llvm::GlobalVariable *GV =
3549 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003550 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListPtrTy);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003551}
3552
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00003553llvm::Function *CGObjCCommonMac::GenerateMethod(const ObjCMethodDecl *OMD,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003554 const ObjCContainerDecl *CD) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003555 SmallString<256> Name;
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00003556 GetNameForMethod(OMD, CD, Name);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003557
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00003558 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00003559 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00003560 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003561 llvm::Function *Method =
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00003562 llvm::Function::Create(MethodTy,
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003563 llvm::GlobalValue::InternalLinkage,
Daniel Dunbard2386812009-10-19 01:21:19 +00003564 Name.str(),
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003565 &CGM.getModule());
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003566 MethodDefinitions.insert(std::make_pair(OMD, Method));
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003567
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003568 return Method;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003569}
3570
Alp Toker541d5072014-06-07 23:30:53 +00003571llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
3572 llvm::Constant *Init,
3573 StringRef Section,
John McCall7f416cc2015-09-08 08:05:57 +00003574 CharUnits Align,
Alp Toker541d5072014-06-07 23:30:53 +00003575 bool AddToUsed) {
Chris Lattner2192fe52011-07-18 04:24:23 +00003576 llvm::Type *Ty = Init->getType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003577 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00003578 new llvm::GlobalVariable(CGM.getModule(), Ty, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003579 llvm::GlobalValue::PrivateLinkage, Init, Name);
Alp Toker541d5072014-06-07 23:30:53 +00003580 if (!Section.empty())
Daniel Dunbar30c65362009-03-09 20:09:19 +00003581 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003582 GV->setAlignment(Align.getQuantity());
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00003583 if (AddToUsed)
Rafael Espindola060062a2014-03-06 22:15:10 +00003584 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar30c65362009-03-09 20:09:19 +00003585 return GV;
3586}
3587
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003588llvm::Function *CGObjCMac::ModuleInitFunction() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00003589 // Abuse this interface function as a place to finalize.
3590 FinishModule();
Craig Topper8a13c412014-05-21 05:09:00 +00003591 return nullptr;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003592}
3593
Chris Lattnerd4808922009-03-22 21:03:39 +00003594llvm::Constant *CGObjCMac::GetPropertyGetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003595 return ObjCTypes.getGetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003596}
3597
Chris Lattnerd4808922009-03-22 21:03:39 +00003598llvm::Constant *CGObjCMac::GetPropertySetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003599 return ObjCTypes.getSetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003600}
3601
Ted Kremeneke65b0862012-03-06 20:05:56 +00003602llvm::Constant *CGObjCMac::GetOptimizedPropertySetFunction(bool atomic,
3603 bool copy) {
3604 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
3605}
3606
David Chisnall168b80f2010-12-26 22:13:16 +00003607llvm::Constant *CGObjCMac::GetGetStructFunction() {
3608 return ObjCTypes.getCopyStructFn();
3609}
3610llvm::Constant *CGObjCMac::GetSetStructFunction() {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00003611 return ObjCTypes.getCopyStructFn();
3612}
3613
David Chisnall0d75e062012-12-17 18:54:24 +00003614llvm::Constant *CGObjCMac::GetCppAtomicObjectGetFunction() {
3615 return ObjCTypes.getCppAtomicObjectFunction();
3616}
3617llvm::Constant *CGObjCMac::GetCppAtomicObjectSetFunction() {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00003618 return ObjCTypes.getCppAtomicObjectFunction();
3619}
3620
Chris Lattnerd4808922009-03-22 21:03:39 +00003621llvm::Constant *CGObjCMac::EnumerationMutationFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003622 return ObjCTypes.getEnumerationMutationFn();
Anders Carlsson3f35a262008-08-31 04:05:03 +00003623}
3624
John McCallbd309292010-07-06 01:34:17 +00003625void CGObjCMac::EmitTryStmt(CodeGenFunction &CGF, const ObjCAtTryStmt &S) {
3626 return EmitTryOrSynchronizedStmt(CGF, S);
3627}
3628
3629void CGObjCMac::EmitSynchronizedStmt(CodeGenFunction &CGF,
3630 const ObjCAtSynchronizedStmt &S) {
3631 return EmitTryOrSynchronizedStmt(CGF, S);
3632}
3633
John McCall65bea082010-07-21 06:59:36 +00003634namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00003635 struct PerformFragileFinally final : EHScopeStack::Cleanup {
John McCall65bea082010-07-21 06:59:36 +00003636 const Stmt &S;
John McCall7f416cc2015-09-08 08:05:57 +00003637 Address SyncArgSlot;
3638 Address CallTryExitVar;
3639 Address ExceptionData;
John McCall65bea082010-07-21 06:59:36 +00003640 ObjCTypesHelper &ObjCTypes;
3641 PerformFragileFinally(const Stmt *S,
John McCall7f416cc2015-09-08 08:05:57 +00003642 Address SyncArgSlot,
3643 Address CallTryExitVar,
3644 Address ExceptionData,
John McCall65bea082010-07-21 06:59:36 +00003645 ObjCTypesHelper *ObjCTypes)
John McCall2dd7d442010-08-04 05:59:32 +00003646 : S(*S), SyncArgSlot(SyncArgSlot), CallTryExitVar(CallTryExitVar),
John McCall65bea082010-07-21 06:59:36 +00003647 ExceptionData(ExceptionData), ObjCTypes(*ObjCTypes) {}
3648
Craig Topper4f12f102014-03-12 06:41:41 +00003649 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall65bea082010-07-21 06:59:36 +00003650 // Check whether we need to call objc_exception_try_exit.
3651 // In optimized code, this branch will always be folded.
3652 llvm::BasicBlock *FinallyCallExit =
3653 CGF.createBasicBlock("finally.call_exit");
3654 llvm::BasicBlock *FinallyNoCallExit =
3655 CGF.createBasicBlock("finally.no_call_exit");
3656 CGF.Builder.CreateCondBr(CGF.Builder.CreateLoad(CallTryExitVar),
3657 FinallyCallExit, FinallyNoCallExit);
3658
3659 CGF.EmitBlock(FinallyCallExit);
John McCall882987f2013-02-28 19:01:20 +00003660 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryExitFn(),
John McCall7f416cc2015-09-08 08:05:57 +00003661 ExceptionData.getPointer());
John McCall65bea082010-07-21 06:59:36 +00003662
3663 CGF.EmitBlock(FinallyNoCallExit);
3664
3665 if (isa<ObjCAtTryStmt>(S)) {
3666 if (const ObjCAtFinallyStmt* FinallyStmt =
John McCallcebe0ca2010-08-11 00:16:14 +00003667 cast<ObjCAtTryStmt>(S).getFinallyStmt()) {
John McCall638d4f52013-04-03 00:56:07 +00003668 // Don't try to do the @finally if this is an EH cleanup.
3669 if (flags.isForEHCleanup()) return;
3670
John McCallcebe0ca2010-08-11 00:16:14 +00003671 // Save the current cleanup destination in case there's
3672 // control flow inside the finally statement.
3673 llvm::Value *CurCleanupDest =
3674 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot());
3675
John McCall65bea082010-07-21 06:59:36 +00003676 CGF.EmitStmt(FinallyStmt->getFinallyBody());
3677
John McCallcebe0ca2010-08-11 00:16:14 +00003678 if (CGF.HaveInsertPoint()) {
3679 CGF.Builder.CreateStore(CurCleanupDest,
3680 CGF.getNormalCleanupDestSlot());
3681 } else {
3682 // Currently, the end of the cleanup must always exist.
3683 CGF.EnsureInsertPoint();
3684 }
3685 }
John McCall65bea082010-07-21 06:59:36 +00003686 } else {
3687 // Emit objc_sync_exit(expr); as finally's sole statement for
3688 // @synchronized.
John McCall2dd7d442010-08-04 05:59:32 +00003689 llvm::Value *SyncArg = CGF.Builder.CreateLoad(SyncArgSlot);
John McCall882987f2013-02-28 19:01:20 +00003690 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncExitFn(), SyncArg);
John McCall65bea082010-07-21 06:59:36 +00003691 }
3692 }
3693 };
John McCall42227ed2010-07-31 23:20:56 +00003694
3695 class FragileHazards {
3696 CodeGenFunction &CGF;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003697 SmallVector<llvm::Value*, 20> Locals;
John McCall42227ed2010-07-31 23:20:56 +00003698 llvm::DenseSet<llvm::BasicBlock*> BlocksBeforeTry;
3699
3700 llvm::InlineAsm *ReadHazard;
3701 llvm::InlineAsm *WriteHazard;
3702
3703 llvm::FunctionType *GetAsmFnType();
3704
3705 void collectLocals();
3706 void emitReadHazard(CGBuilderTy &Builder);
3707
3708 public:
3709 FragileHazards(CodeGenFunction &CGF);
John McCall2dd7d442010-08-04 05:59:32 +00003710
John McCall42227ed2010-07-31 23:20:56 +00003711 void emitWriteHazard();
John McCall2dd7d442010-08-04 05:59:32 +00003712 void emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00003713 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00003714}
John McCall42227ed2010-07-31 23:20:56 +00003715
3716/// Create the fragile-ABI read and write hazards based on the current
3717/// state of the function, which is presumed to be immediately prior
3718/// to a @try block. These hazards are used to maintain correct
3719/// semantics in the face of optimization and the fragile ABI's
3720/// cavalier use of setjmp/longjmp.
3721FragileHazards::FragileHazards(CodeGenFunction &CGF) : CGF(CGF) {
3722 collectLocals();
3723
3724 if (Locals.empty()) return;
3725
3726 // Collect all the blocks in the function.
3727 for (llvm::Function::iterator
3728 I = CGF.CurFn->begin(), E = CGF.CurFn->end(); I != E; ++I)
3729 BlocksBeforeTry.insert(&*I);
3730
3731 llvm::FunctionType *AsmFnTy = GetAsmFnType();
3732
3733 // Create a read hazard for the allocas. This inhibits dead-store
3734 // optimizations and forces the values to memory. This hazard is
3735 // inserted before any 'throwing' calls in the protected scope to
3736 // reflect the possibility that the variables might be read from the
3737 // catch block if the call throws.
3738 {
3739 std::string Constraint;
3740 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3741 if (I) Constraint += ',';
3742 Constraint += "*m";
3743 }
3744
3745 ReadHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3746 }
3747
3748 // Create a write hazard for the allocas. This inhibits folding
3749 // loads across the hazard. This hazard is inserted at the
3750 // beginning of the catch path to reflect the possibility that the
3751 // variables might have been written within the protected scope.
3752 {
3753 std::string Constraint;
3754 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3755 if (I) Constraint += ',';
3756 Constraint += "=*m";
3757 }
3758
3759 WriteHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3760 }
3761}
3762
3763/// Emit a write hazard at the current location.
3764void FragileHazards::emitWriteHazard() {
3765 if (Locals.empty()) return;
3766
John McCall882987f2013-02-28 19:01:20 +00003767 CGF.EmitNounwindRuntimeCall(WriteHazard, Locals);
John McCall42227ed2010-07-31 23:20:56 +00003768}
3769
John McCall42227ed2010-07-31 23:20:56 +00003770void FragileHazards::emitReadHazard(CGBuilderTy &Builder) {
3771 assert(!Locals.empty());
John McCall882987f2013-02-28 19:01:20 +00003772 llvm::CallInst *call = Builder.CreateCall(ReadHazard, Locals);
3773 call->setDoesNotThrow();
3774 call->setCallingConv(CGF.getRuntimeCC());
John McCall42227ed2010-07-31 23:20:56 +00003775}
3776
3777/// Emit read hazards in all the protected blocks, i.e. all the blocks
3778/// which have been inserted since the beginning of the try.
John McCall2dd7d442010-08-04 05:59:32 +00003779void FragileHazards::emitHazardsInNewBlocks() {
John McCall42227ed2010-07-31 23:20:56 +00003780 if (Locals.empty()) return;
3781
John McCall7f416cc2015-09-08 08:05:57 +00003782 CGBuilderTy Builder(CGF, CGF.getLLVMContext());
John McCall42227ed2010-07-31 23:20:56 +00003783
3784 // Iterate through all blocks, skipping those prior to the try.
3785 for (llvm::Function::iterator
3786 FI = CGF.CurFn->begin(), FE = CGF.CurFn->end(); FI != FE; ++FI) {
3787 llvm::BasicBlock &BB = *FI;
3788 if (BlocksBeforeTry.count(&BB)) continue;
3789
3790 // Walk through all the calls in the block.
3791 for (llvm::BasicBlock::iterator
3792 BI = BB.begin(), BE = BB.end(); BI != BE; ++BI) {
3793 llvm::Instruction &I = *BI;
3794
3795 // Ignore instructions that aren't non-intrinsic calls.
3796 // These are the only calls that can possibly call longjmp.
3797 if (!isa<llvm::CallInst>(I) && !isa<llvm::InvokeInst>(I)) continue;
3798 if (isa<llvm::IntrinsicInst>(I))
3799 continue;
3800
3801 // Ignore call sites marked nounwind. This may be questionable,
3802 // since 'nounwind' doesn't necessarily mean 'does not call longjmp'.
3803 llvm::CallSite CS(&I);
3804 if (CS.doesNotThrow()) continue;
3805
John McCall2dd7d442010-08-04 05:59:32 +00003806 // Insert a read hazard before the call. This will ensure that
3807 // any writes to the locals are performed before making the
3808 // call. If the call throws, then this is sufficient to
3809 // guarantee correctness as long as it doesn't also write to any
3810 // locals.
John McCall42227ed2010-07-31 23:20:56 +00003811 Builder.SetInsertPoint(&BB, BI);
3812 emitReadHazard(Builder);
3813 }
3814 }
3815}
3816
3817static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, llvm::Value *V) {
3818 if (V) S.insert(V);
3819}
3820
John McCall7f416cc2015-09-08 08:05:57 +00003821static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, Address V) {
3822 if (V.isValid()) S.insert(V.getPointer());
3823}
3824
John McCall42227ed2010-07-31 23:20:56 +00003825void FragileHazards::collectLocals() {
3826 // Compute a set of allocas to ignore.
3827 llvm::DenseSet<llvm::Value*> AllocasToIgnore;
3828 addIfPresent(AllocasToIgnore, CGF.ReturnValue);
3829 addIfPresent(AllocasToIgnore, CGF.NormalCleanupDest);
John McCall42227ed2010-07-31 23:20:56 +00003830
3831 // Collect all the allocas currently in the function. This is
3832 // probably way too aggressive.
3833 llvm::BasicBlock &Entry = CGF.CurFn->getEntryBlock();
3834 for (llvm::BasicBlock::iterator
3835 I = Entry.begin(), E = Entry.end(); I != E; ++I)
3836 if (isa<llvm::AllocaInst>(*I) && !AllocasToIgnore.count(&*I))
3837 Locals.push_back(&*I);
3838}
3839
3840llvm::FunctionType *FragileHazards::GetAsmFnType() {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003841 SmallVector<llvm::Type *, 16> tys(Locals.size());
John McCall9dc0db22011-05-15 01:53:33 +00003842 for (unsigned i = 0, e = Locals.size(); i != e; ++i)
3843 tys[i] = Locals[i]->getType();
3844 return llvm::FunctionType::get(CGF.VoidTy, tys, false);
John McCall65bea082010-07-21 06:59:36 +00003845}
3846
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003847/*
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003848
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003849 Objective-C setjmp-longjmp (sjlj) Exception Handling
3850 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003851
John McCallbd309292010-07-06 01:34:17 +00003852 A catch buffer is a setjmp buffer plus:
3853 - a pointer to the exception that was caught
3854 - a pointer to the previous exception data buffer
3855 - two pointers of reserved storage
3856 Therefore catch buffers form a stack, with a pointer to the top
3857 of the stack kept in thread-local storage.
3858
3859 objc_exception_try_enter pushes a catch buffer onto the EH stack.
3860 objc_exception_try_exit pops the given catch buffer, which is
3861 required to be the top of the EH stack.
3862 objc_exception_throw pops the top of the EH stack, writes the
3863 thrown exception into the appropriate field, and longjmps
3864 to the setjmp buffer. It crashes the process (with a printf
3865 and an abort()) if there are no catch buffers on the stack.
3866 objc_exception_extract just reads the exception pointer out of the
3867 catch buffer.
3868
3869 There's no reason an implementation couldn't use a light-weight
3870 setjmp here --- something like __builtin_setjmp, but API-compatible
3871 with the heavyweight setjmp. This will be more important if we ever
3872 want to implement correct ObjC/C++ exception interactions for the
3873 fragile ABI.
3874
3875 Note that for this use of setjmp/longjmp to be correct, we may need
3876 to mark some local variables volatile: if a non-volatile local
3877 variable is modified between the setjmp and the longjmp, it has
3878 indeterminate value. For the purposes of LLVM IR, it may be
3879 sufficient to make loads and stores within the @try (to variables
3880 declared outside the @try) volatile. This is necessary for
3881 optimized correctness, but is not currently being done; this is
3882 being tracked as rdar://problem/8160285
3883
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003884 The basic framework for a @try-catch-finally is as follows:
3885 {
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003886 objc_exception_data d;
3887 id _rethrow = null;
Anders Carlssonda0e4562009-02-07 21:26:04 +00003888 bool _call_try_exit = true;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003889
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003890 objc_exception_try_enter(&d);
3891 if (!setjmp(d.jmp_buf)) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003892 ... try body ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003893 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003894 // exception path
3895 id _caught = objc_exception_extract(&d);
3896
3897 // enter new try scope for handlers
3898 if (!setjmp(d.jmp_buf)) {
3899 ... match exception and execute catch blocks ...
3900
3901 // fell off end, rethrow.
3902 _rethrow = _caught;
3903 ... jump-through-finally to finally_rethrow ...
3904 } else {
3905 // exception in catch block
3906 _rethrow = objc_exception_extract(&d);
3907 _call_try_exit = false;
3908 ... jump-through-finally to finally_rethrow ...
3909 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003910 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003911 ... jump-through-finally to finally_end ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003912
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003913 finally:
Anders Carlssonda0e4562009-02-07 21:26:04 +00003914 if (_call_try_exit)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003915 objc_exception_try_exit(&d);
Anders Carlssonda0e4562009-02-07 21:26:04 +00003916
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003917 ... finally block ....
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003918 ... dispatch to finally destination ...
3919
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003920 finally_rethrow:
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003921 objc_exception_throw(_rethrow);
3922
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003923 finally_end:
3924 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003925
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003926 This framework differs slightly from the one gcc uses, in that gcc
3927 uses _rethrow to determine if objc_exception_try_exit should be called
3928 and if the object should be rethrown. This breaks in the face of
3929 throwing nil and introduces unnecessary branches.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003930
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003931 We specialize this framework for a few particular circumstances:
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003932
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003933 - If there are no catch blocks, then we avoid emitting the second
3934 exception handling context.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003935
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003936 - If there is a catch-all catch block (i.e. @catch(...) or @catch(id
3937 e)) we avoid emitting the code to rethrow an uncaught exception.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003938
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003939 - FIXME: If there is no @finally block we can do a few more
3940 simplifications.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003941
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003942 Rethrows and Jumps-Through-Finally
3943 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003944
John McCallbd309292010-07-06 01:34:17 +00003945 '@throw;' is supported by pushing the currently-caught exception
3946 onto ObjCEHStack while the @catch blocks are emitted.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003947
John McCallbd309292010-07-06 01:34:17 +00003948 Branches through the @finally block are handled with an ordinary
3949 normal cleanup. We do not register an EH cleanup; fragile-ABI ObjC
3950 exceptions are not compatible with C++ exceptions, and this is
3951 hardly the only place where this will go wrong.
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003952
John McCallbd309292010-07-06 01:34:17 +00003953 @synchronized(expr) { stmt; } is emitted as if it were:
3954 id synch_value = expr;
3955 objc_sync_enter(synch_value);
3956 @try { stmt; } @finally { objc_sync_exit(synch_value); }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003957*/
3958
Fariborz Jahanianc2ad6dc2008-11-21 00:49:24 +00003959void CGObjCMac::EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
3960 const Stmt &S) {
3961 bool isTry = isa<ObjCAtTryStmt>(S);
John McCallbd309292010-07-06 01:34:17 +00003962
3963 // A destination for the fall-through edges of the catch handlers to
3964 // jump to.
3965 CodeGenFunction::JumpDest FinallyEnd =
3966 CGF.getJumpDestInCurrentScope("finally.end");
3967
3968 // A destination for the rethrow edge of the catch handlers to jump
3969 // to.
3970 CodeGenFunction::JumpDest FinallyRethrow =
3971 CGF.getJumpDestInCurrentScope("finally.rethrow");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003972
Daniel Dunbar94ceb612009-02-24 01:43:46 +00003973 // For @synchronized, call objc_sync_enter(sync.expr). The
3974 // evaluation of the expression must occur before we enter the
John McCall2dd7d442010-08-04 05:59:32 +00003975 // @synchronized. We can't avoid a temp here because we need the
3976 // value to be preserved. If the backend ever does liveness
3977 // correctly after setjmp, this will be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00003978 Address SyncArgSlot = Address::invalid();
Daniel Dunbar94ceb612009-02-24 01:43:46 +00003979 if (!isTry) {
John McCall2dd7d442010-08-04 05:59:32 +00003980 llvm::Value *SyncArg =
Daniel Dunbar94ceb612009-02-24 01:43:46 +00003981 CGF.EmitScalarExpr(cast<ObjCAtSynchronizedStmt>(S).getSynchExpr());
3982 SyncArg = CGF.Builder.CreateBitCast(SyncArg, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00003983 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncEnterFn(), SyncArg);
John McCall2dd7d442010-08-04 05:59:32 +00003984
John McCall7f416cc2015-09-08 08:05:57 +00003985 SyncArgSlot = CGF.CreateTempAlloca(SyncArg->getType(),
3986 CGF.getPointerAlign(), "sync.arg");
John McCall2dd7d442010-08-04 05:59:32 +00003987 CGF.Builder.CreateStore(SyncArg, SyncArgSlot);
Daniel Dunbar94ceb612009-02-24 01:43:46 +00003988 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003989
John McCall2dd7d442010-08-04 05:59:32 +00003990 // Allocate memory for the setjmp buffer. This needs to be kept
3991 // live throughout the try and catch blocks.
John McCall7f416cc2015-09-08 08:05:57 +00003992 Address ExceptionData = CGF.CreateTempAlloca(ObjCTypes.ExceptionDataTy,
3993 CGF.getPointerAlign(),
3994 "exceptiondata.ptr");
John McCall2dd7d442010-08-04 05:59:32 +00003995
John McCall42227ed2010-07-31 23:20:56 +00003996 // Create the fragile hazards. Note that this will not capture any
3997 // of the allocas required for exception processing, but will
3998 // capture the current basic block (which extends all the way to the
3999 // setjmp call) as "before the @try".
4000 FragileHazards Hazards(CGF);
4001
John McCallbd309292010-07-06 01:34:17 +00004002 // Create a flag indicating whether the cleanup needs to call
4003 // objc_exception_try_exit. This is true except when
4004 // - no catches match and we're branching through the cleanup
4005 // just to rethrow the exception, or
4006 // - a catch matched and we're falling out of the catch handler.
John McCall2dd7d442010-08-04 05:59:32 +00004007 // The setjmp-safety rule here is that we should always store to this
4008 // variable in a place that dominates the branch through the cleanup
4009 // without passing through any setjmps.
John McCall7f416cc2015-09-08 08:05:57 +00004010 Address CallTryExitVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(),
4011 CharUnits::One(),
4012 "_call_try_exit");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004013
John McCall9916e3f2010-10-04 23:42:51 +00004014 // A slot containing the exception to rethrow. Only needed when we
4015 // have both a @catch and a @finally.
John McCall7f416cc2015-09-08 08:05:57 +00004016 Address PropagatingExnVar = Address::invalid();
John McCall9916e3f2010-10-04 23:42:51 +00004017
John McCallbd309292010-07-06 01:34:17 +00004018 // Push a normal cleanup to leave the try scope.
John McCall638d4f52013-04-03 00:56:07 +00004019 CGF.EHStack.pushCleanup<PerformFragileFinally>(NormalAndEHCleanup, &S,
John McCall2dd7d442010-08-04 05:59:32 +00004020 SyncArgSlot,
John McCallcda666c2010-07-21 07:22:38 +00004021 CallTryExitVar,
4022 ExceptionData,
4023 &ObjCTypes);
John McCallbd309292010-07-06 01:34:17 +00004024
4025 // Enter a try block:
4026 // - Call objc_exception_try_enter to push ExceptionData on top of
4027 // the EH stack.
Nico Weber6307cf02015-02-26 20:43:00 +00004028 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004029 ExceptionData.getPointer());
John McCallbd309292010-07-06 01:34:17 +00004030
4031 // - Call setjmp on the exception data buffer.
4032 llvm::Constant *Zero = llvm::ConstantInt::get(CGF.Builder.getInt32Ty(), 0);
4033 llvm::Value *GEPIndexes[] = { Zero, Zero, Zero };
David Blaikie6b2a8302015-04-03 17:47:16 +00004034 llvm::Value *SetJmpBuffer = CGF.Builder.CreateGEP(
John McCall7f416cc2015-09-08 08:05:57 +00004035 ObjCTypes.ExceptionDataTy, ExceptionData.getPointer(), GEPIndexes,
4036 "setjmp_buffer");
Nico Weber6307cf02015-02-26 20:43:00 +00004037 llvm::CallInst *SetJmpResult = CGF.EmitNounwindRuntimeCall(
4038 ObjCTypes.getSetJmpFn(), SetJmpBuffer, "setjmp_result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004039 SetJmpResult->setCanReturnTwice();
John McCallbd309292010-07-06 01:34:17 +00004040
4041 // If setjmp returned 0, enter the protected block; otherwise,
4042 // branch to the handler.
Daniel Dunbar75283ff2008-11-11 02:29:29 +00004043 llvm::BasicBlock *TryBlock = CGF.createBasicBlock("try");
4044 llvm::BasicBlock *TryHandler = CGF.createBasicBlock("try.handler");
John McCallbd309292010-07-06 01:34:17 +00004045 llvm::Value *DidCatch =
John McCallcebe0ca2010-08-11 00:16:14 +00004046 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4047 CGF.Builder.CreateCondBr(DidCatch, TryHandler, TryBlock);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004048
John McCallbd309292010-07-06 01:34:17 +00004049 // Emit the protected block.
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004050 CGF.EmitBlock(TryBlock);
John McCall2dd7d442010-08-04 05:59:32 +00004051 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004052 CGF.EmitStmt(isTry ? cast<ObjCAtTryStmt>(S).getTryBody()
John McCallbd309292010-07-06 01:34:17 +00004053 : cast<ObjCAtSynchronizedStmt>(S).getSynchBody());
John McCall2dd7d442010-08-04 05:59:32 +00004054
4055 CGBuilderTy::InsertPoint TryFallthroughIP = CGF.Builder.saveAndClearIP();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004056
John McCallbd309292010-07-06 01:34:17 +00004057 // Emit the exception handler block.
Daniel Dunbar7f086782008-09-27 23:30:04 +00004058 CGF.EmitBlock(TryHandler);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004059
John McCall42227ed2010-07-31 23:20:56 +00004060 // Don't optimize loads of the in-scope locals across this point.
4061 Hazards.emitWriteHazard();
4062
John McCallbd309292010-07-06 01:34:17 +00004063 // For a @synchronized (or a @try with no catches), just branch
4064 // through the cleanup to the rethrow block.
4065 if (!isTry || !cast<ObjCAtTryStmt>(S).getNumCatchStmts()) {
4066 // Tell the cleanup not to re-pop the exit.
John McCall2dd7d442010-08-04 05:59:32 +00004067 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004068 CGF.EmitBranchThroughCleanup(FinallyRethrow);
John McCallbd309292010-07-06 01:34:17 +00004069
4070 // Otherwise, we have to match against the caught exceptions.
4071 } else {
John McCall2dd7d442010-08-04 05:59:32 +00004072 // Retrieve the exception object. We may emit multiple blocks but
4073 // nothing can cross this so the value is already in SSA form.
4074 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004075 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004076 ExceptionData.getPointer(), "caught");
John McCall2dd7d442010-08-04 05:59:32 +00004077
John McCallbd309292010-07-06 01:34:17 +00004078 // Push the exception to rethrow onto the EH value stack for the
4079 // benefit of any @throws in the handlers.
4080 CGF.ObjCEHValueStack.push_back(Caught);
4081
Douglas Gregor96c79492010-04-23 22:50:49 +00004082 const ObjCAtTryStmt* AtTryStmt = cast<ObjCAtTryStmt>(&S);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004083
Craig Topper8a13c412014-05-21 05:09:00 +00004084 bool HasFinally = (AtTryStmt->getFinallyStmt() != nullptr);
John McCallbd309292010-07-06 01:34:17 +00004085
Craig Topper8a13c412014-05-21 05:09:00 +00004086 llvm::BasicBlock *CatchBlock = nullptr;
4087 llvm::BasicBlock *CatchHandler = nullptr;
John McCall2dd7d442010-08-04 05:59:32 +00004088 if (HasFinally) {
John McCall9916e3f2010-10-04 23:42:51 +00004089 // Save the currently-propagating exception before
4090 // objc_exception_try_enter clears the exception slot.
4091 PropagatingExnVar = CGF.CreateTempAlloca(Caught->getType(),
John McCall7f416cc2015-09-08 08:05:57 +00004092 CGF.getPointerAlign(),
John McCall9916e3f2010-10-04 23:42:51 +00004093 "propagating_exception");
4094 CGF.Builder.CreateStore(Caught, PropagatingExnVar);
4095
John McCall2dd7d442010-08-04 05:59:32 +00004096 // Enter a new exception try block (in case a @catch block
4097 // throws an exception).
John McCall882987f2013-02-28 19:01:20 +00004098 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004099 ExceptionData.getPointer());
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004100
John McCall2dd7d442010-08-04 05:59:32 +00004101 llvm::CallInst *SetJmpResult =
John McCall882987f2013-02-28 19:01:20 +00004102 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSetJmpFn(),
4103 SetJmpBuffer, "setjmp.result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004104 SetJmpResult->setCanReturnTwice();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004105
John McCall2dd7d442010-08-04 05:59:32 +00004106 llvm::Value *Threw =
4107 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4108
4109 CatchBlock = CGF.createBasicBlock("catch");
4110 CatchHandler = CGF.createBasicBlock("catch_for_catch");
4111 CGF.Builder.CreateCondBr(Threw, CatchHandler, CatchBlock);
4112
4113 CGF.EmitBlock(CatchBlock);
4114 }
4115
4116 CGF.Builder.CreateStore(CGF.Builder.getInt1(HasFinally), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004117
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004118 // Handle catch list. As a special case we check if everything is
4119 // matched and avoid generating code for falling off the end if
4120 // so.
4121 bool AllMatched = false;
Douglas Gregor96c79492010-04-23 22:50:49 +00004122 for (unsigned I = 0, N = AtTryStmt->getNumCatchStmts(); I != N; ++I) {
4123 const ObjCAtCatchStmt *CatchStmt = AtTryStmt->getCatchStmt(I);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004124
Douglas Gregor46a572b2010-04-26 16:46:50 +00004125 const VarDecl *CatchParam = CatchStmt->getCatchParamDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00004126 const ObjCObjectPointerType *OPT = nullptr;
Daniel Dunbar523208f2008-09-27 07:36:24 +00004127
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004128 // catch(...) always matches.
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004129 if (!CatchParam) {
4130 AllMatched = true;
4131 } else {
John McCall9dd450b2009-09-21 23:43:11 +00004132 OPT = CatchParam->getType()->getAs<ObjCObjectPointerType>();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004133
John McCallbd309292010-07-06 01:34:17 +00004134 // catch(id e) always matches under this ABI, since only
4135 // ObjC exceptions end up here in the first place.
Daniel Dunbar86919f42008-09-27 22:21:14 +00004136 // FIXME: For the time being we also match id<X>; this should
4137 // be rejected by Sema instead.
Eli Friedman55179ca2009-07-11 00:57:02 +00004138 if (OPT && (OPT->isObjCIdType() || OPT->isObjCQualifiedIdType()))
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004139 AllMatched = true;
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004140 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004141
John McCallbd309292010-07-06 01:34:17 +00004142 // If this is a catch-all, we don't need to test anything.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004143 if (AllMatched) {
John McCallbd309292010-07-06 01:34:17 +00004144 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
4145
Anders Carlsson9396a892008-09-11 09:15:33 +00004146 if (CatchParam) {
John McCall1c9c3fd2010-10-15 04:57:14 +00004147 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004148 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
John McCallbd309292010-07-06 01:34:17 +00004149
4150 // These types work out because ConvertType(id) == i8*.
John McCall17f02752015-10-30 00:56:02 +00004151 EmitInitOfCatchParam(CGF, Caught, CatchParam);
Anders Carlsson9396a892008-09-11 09:15:33 +00004152 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004153
Anders Carlsson9396a892008-09-11 09:15:33 +00004154 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004155
4156 // The scope of the catch variable ends right here.
4157 CatchVarCleanups.ForceCleanup();
4158
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004159 CGF.EmitBranchThroughCleanup(FinallyEnd);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004160 break;
4161 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004162
Steve Naroff7cae42b2009-07-10 23:34:53 +00004163 assert(OPT && "Unexpected non-object pointer type in @catch");
John McCall96fa4842010-05-17 21:00:27 +00004164 const ObjCObjectType *ObjTy = OPT->getObjectType();
John McCallbd309292010-07-06 01:34:17 +00004165
4166 // FIXME: @catch (Class c) ?
John McCall96fa4842010-05-17 21:00:27 +00004167 ObjCInterfaceDecl *IDecl = ObjTy->getInterface();
4168 assert(IDecl && "Catch parameter must have Objective-C type!");
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004169
4170 // Check if the @catch block matches the exception object.
John McCall882987f2013-02-28 19:01:20 +00004171 llvm::Value *Class = EmitClassRef(CGF, IDecl);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004172
John McCall882987f2013-02-28 19:01:20 +00004173 llvm::Value *matchArgs[] = { Class, Caught };
John McCallbd309292010-07-06 01:34:17 +00004174 llvm::CallInst *Match =
John McCall882987f2013-02-28 19:01:20 +00004175 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionMatchFn(),
4176 matchArgs, "match");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004177
John McCallbd309292010-07-06 01:34:17 +00004178 llvm::BasicBlock *MatchedBlock = CGF.createBasicBlock("match");
4179 llvm::BasicBlock *NextCatchBlock = CGF.createBasicBlock("catch.next");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004180
4181 CGF.Builder.CreateCondBr(CGF.Builder.CreateIsNotNull(Match, "matched"),
Daniel Dunbar7f086782008-09-27 23:30:04 +00004182 MatchedBlock, NextCatchBlock);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004183
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004184 // Emit the @catch block.
4185 CGF.EmitBlock(MatchedBlock);
John McCallbd309292010-07-06 01:34:17 +00004186
4187 // Collect any cleanups for the catch variable. The scope lasts until
4188 // the end of the catch body.
John McCall2dd7d442010-08-04 05:59:32 +00004189 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
John McCallbd309292010-07-06 01:34:17 +00004190
John McCall1c9c3fd2010-10-15 04:57:14 +00004191 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004192 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004193
John McCallbd309292010-07-06 01:34:17 +00004194 // Initialize the catch variable.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004195 llvm::Value *Tmp =
4196 CGF.Builder.CreateBitCast(Caught,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004197 CGF.ConvertType(CatchParam->getType()));
John McCall17f02752015-10-30 00:56:02 +00004198 EmitInitOfCatchParam(CGF, Tmp, CatchParam);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004199
Anders Carlsson9396a892008-09-11 09:15:33 +00004200 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004201
4202 // We're done with the catch variable.
4203 CatchVarCleanups.ForceCleanup();
4204
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004205 CGF.EmitBranchThroughCleanup(FinallyEnd);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004206
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004207 CGF.EmitBlock(NextCatchBlock);
4208 }
4209
John McCallbd309292010-07-06 01:34:17 +00004210 CGF.ObjCEHValueStack.pop_back();
4211
John McCall2dd7d442010-08-04 05:59:32 +00004212 // If nothing wanted anything to do with the caught exception,
4213 // kill the extract call.
4214 if (Caught->use_empty())
4215 Caught->eraseFromParent();
4216
4217 if (!AllMatched)
4218 CGF.EmitBranchThroughCleanup(FinallyRethrow);
4219
4220 if (HasFinally) {
4221 // Emit the exception handler for the @catch blocks.
4222 CGF.EmitBlock(CatchHandler);
4223
4224 // In theory we might now need a write hazard, but actually it's
4225 // unnecessary because there's no local-accessing code between
4226 // the try's write hazard and here.
4227 //Hazards.emitWriteHazard();
4228
John McCall9916e3f2010-10-04 23:42:51 +00004229 // Extract the new exception and save it to the
4230 // propagating-exception slot.
John McCall7f416cc2015-09-08 08:05:57 +00004231 assert(PropagatingExnVar.isValid());
John McCall9916e3f2010-10-04 23:42:51 +00004232 llvm::CallInst *NewCaught =
John McCall882987f2013-02-28 19:01:20 +00004233 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004234 ExceptionData.getPointer(), "caught");
John McCall9916e3f2010-10-04 23:42:51 +00004235 CGF.Builder.CreateStore(NewCaught, PropagatingExnVar);
4236
John McCall2dd7d442010-08-04 05:59:32 +00004237 // Don't pop the catch handler; the throw already did.
4238 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004239 CGF.EmitBranchThroughCleanup(FinallyRethrow);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004240 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004241 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004242
John McCall42227ed2010-07-31 23:20:56 +00004243 // Insert read hazards as required in the new blocks.
John McCall2dd7d442010-08-04 05:59:32 +00004244 Hazards.emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00004245
John McCallbd309292010-07-06 01:34:17 +00004246 // Pop the cleanup.
John McCall2dd7d442010-08-04 05:59:32 +00004247 CGF.Builder.restoreIP(TryFallthroughIP);
4248 if (CGF.HaveInsertPoint())
4249 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
John McCallbd309292010-07-06 01:34:17 +00004250 CGF.PopCleanupBlock();
John McCall2dd7d442010-08-04 05:59:32 +00004251 CGF.EmitBlock(FinallyEnd.getBlock(), true);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004252
John McCallbd309292010-07-06 01:34:17 +00004253 // Emit the rethrow block.
John McCall42227ed2010-07-31 23:20:56 +00004254 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
John McCallad5d61e2010-07-23 21:56:41 +00004255 CGF.EmitBlock(FinallyRethrow.getBlock(), true);
John McCallbd309292010-07-06 01:34:17 +00004256 if (CGF.HaveInsertPoint()) {
John McCall9916e3f2010-10-04 23:42:51 +00004257 // If we have a propagating-exception variable, check it.
4258 llvm::Value *PropagatingExn;
John McCall7f416cc2015-09-08 08:05:57 +00004259 if (PropagatingExnVar.isValid()) {
John McCall9916e3f2010-10-04 23:42:51 +00004260 PropagatingExn = CGF.Builder.CreateLoad(PropagatingExnVar);
John McCall2dd7d442010-08-04 05:59:32 +00004261
John McCall9916e3f2010-10-04 23:42:51 +00004262 // Otherwise, just look in the buffer for the exception to throw.
4263 } else {
4264 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004265 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004266 ExceptionData.getPointer());
John McCall9916e3f2010-10-04 23:42:51 +00004267 PropagatingExn = Caught;
4268 }
4269
John McCall882987f2013-02-28 19:01:20 +00004270 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionThrowFn(),
4271 PropagatingExn);
John McCallbd309292010-07-06 01:34:17 +00004272 CGF.Builder.CreateUnreachable();
Fariborz Jahaniane2caaaa2008-11-21 19:21:53 +00004273 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004274
John McCall42227ed2010-07-31 23:20:56 +00004275 CGF.Builder.restoreIP(SavedIP);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004276}
4277
4278void CGObjCMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004279 const ObjCAtThrowStmt &S,
4280 bool ClearInsertionPoint) {
Anders Carlssone005aa12008-09-09 16:16:55 +00004281 llvm::Value *ExceptionAsObject;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004282
Anders Carlssone005aa12008-09-09 16:16:55 +00004283 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00004284 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004285 ExceptionAsObject =
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004286 CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
Anders Carlssone005aa12008-09-09 16:16:55 +00004287 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004288 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004289 "Unexpected rethrow outside @catch block.");
Anders Carlssonbf8a1be2009-02-07 21:37:21 +00004290 ExceptionAsObject = CGF.ObjCEHValueStack.back();
Anders Carlssone005aa12008-09-09 16:16:55 +00004291 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004292
John McCall882987f2013-02-28 19:01:20 +00004293 CGF.EmitRuntimeCall(ObjCTypes.getExceptionThrowFn(), ExceptionAsObject)
John McCallbd309292010-07-06 01:34:17 +00004294 ->setDoesNotReturn();
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004295 CGF.Builder.CreateUnreachable();
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004296
4297 // Clear the insertion point to indicate we are in unreachable code.
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004298 if (ClearInsertionPoint)
4299 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004300}
4301
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004302/// EmitObjCWeakRead - Code gen for loading value of a __weak
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004303/// object: objc_read_weak (id *src)
4304///
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004305llvm::Value * CGObjCMac::EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004306 Address AddrWeakObj) {
4307 llvm::Type* DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004308 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj,
4309 ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004310 llvm::Value *read_weak =
4311 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004312 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00004313 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004314 return read_weak;
4315}
4316
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004317/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
4318/// objc_assign_weak (id src, id *dst)
4319///
4320void CGObjCMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004321 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004322 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004323 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004324 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004325 assert(Size <= 8 && "does not support size > 8");
4326 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004327 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004328 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4329 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004330 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4331 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004332 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004333 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
4334 args, "weakassign");
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004335 return;
4336}
4337
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004338/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
4339/// objc_assign_global (id src, id *dst)
4340///
4341void CGObjCMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004342 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00004343 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004344 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004345 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004346 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004347 assert(Size <= 8 && "does not support size > 8");
4348 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004349 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004350 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4351 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004352 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4353 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004354 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00004355 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00004356 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
4357 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00004358 else
John McCall882987f2013-02-28 19:01:20 +00004359 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
4360 args, "threadlocalassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004361 return;
4362}
4363
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004364/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004365/// objc_assign_ivar (id src, id *dst, ptrdiff_t ivaroffset)
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004366///
4367void CGObjCMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004368 llvm::Value *src, Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004369 llvm::Value *ivarOffset) {
4370 assert(ivarOffset && "EmitObjCIvarAssign - ivarOffset is NULL");
Chris Lattner2192fe52011-07-18 04:24:23 +00004371 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004372 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004373 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004374 assert(Size <= 8 && "does not support size > 8");
4375 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004376 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004377 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4378 }
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004379 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4380 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004381 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00004382 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004383 return;
4384}
4385
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004386/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
4387/// objc_assign_strongCast (id src, id *dst)
4388///
4389void CGObjCMac::EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004390 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004391 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004392 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004393 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004394 assert(Size <= 8 && "does not support size > 8");
4395 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004396 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004397 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4398 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004399 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4400 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004401 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004402 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004403 args, "strongassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004404 return;
4405}
4406
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004407void CGObjCMac::EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004408 Address DestPtr,
4409 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00004410 llvm::Value *size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004411 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
4412 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004413 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), size };
John McCall882987f2013-02-28 19:01:20 +00004414 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004415}
4416
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004417/// EmitObjCValueForIvar - Code Gen for ivar reference.
4418///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004419LValue CGObjCMac::EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF,
4420 QualType ObjectTy,
4421 llvm::Value *BaseValue,
4422 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004423 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00004424 const ObjCInterfaceDecl *ID =
4425 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00004426 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
4427 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004428}
4429
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004430llvm::Value *CGObjCMac::EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00004431 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004432 const ObjCIvarDecl *Ivar) {
Eli Friedman8cbca202012-11-06 22:15:52 +00004433 uint64_t Offset = ComputeIvarBaseOffset(CGM, Interface, Ivar);
4434 return llvm::ConstantInt::get(
4435 CGM.getTypes().ConvertType(CGM.getContext().LongTy),
4436 Offset);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004437}
4438
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004439/* *** Private Interface *** */
4440
4441/// EmitImageInfo - Emit the image info marker used to encode some module
4442/// level information.
4443///
4444/// See: <rdr://4810609&4810587&4810587>
4445/// struct IMAGE_INFO {
4446/// unsigned version;
4447/// unsigned flags;
4448/// };
4449enum ImageInfoFlags {
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004450 eImageInfo_FixAndContinue = (1 << 0), // This flag is no longer set by clang.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004451 eImageInfo_GarbageCollected = (1 << 1),
4452 eImageInfo_GCOnly = (1 << 2),
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004453 eImageInfo_OptimizedByDyld = (1 << 3), // This flag is set by the dyld shared cache.
Daniel Dunbar75e909f2009-04-20 07:11:47 +00004454
Daniel Dunbar5e639272010-04-25 20:39:01 +00004455 // A flag indicating that the module has no instances of a @synthesize of a
4456 // superclass variable. <rdar://problem/6803242>
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004457 eImageInfo_CorrectedSynthesize = (1 << 4), // This flag is no longer set by clang.
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004458 eImageInfo_ImageIsSimulated = (1 << 5)
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004459};
4460
Daniel Dunbar5e639272010-04-25 20:39:01 +00004461void CGObjCCommonMac::EmitImageInfo() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004462 unsigned version = 0; // Version is unused?
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004463 const char *Section = (ObjCABI == 1) ?
4464 "__OBJC, __image_info,regular" :
4465 "__DATA, __objc_imageinfo, regular, no_dead_strip";
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004466
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004467 // Generate module-level named metadata to convey this information to the
4468 // linker and code-gen.
4469 llvm::Module &Mod = CGM.getModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004470
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004471 // Add the ObjC ABI version to the module flags.
4472 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Version", ObjCABI);
4473 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Version",
4474 version);
4475 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Section",
4476 llvm::MDString::get(VMContext,Section));
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004477
David Blaikiebbafb8a2012-03-11 07:00:24 +00004478 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004479 // Non-GC overrides those files which specify GC.
4480 Mod.addModuleFlag(llvm::Module::Override,
4481 "Objective-C Garbage Collection", (uint32_t)0);
4482 } else {
4483 // Add the ObjC garbage collection value.
4484 Mod.addModuleFlag(llvm::Module::Error,
4485 "Objective-C Garbage Collection",
4486 eImageInfo_GarbageCollected);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004487
David Blaikiebbafb8a2012-03-11 07:00:24 +00004488 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004489 // Add the ObjC GC Only value.
4490 Mod.addModuleFlag(llvm::Module::Error, "Objective-C GC Only",
4491 eImageInfo_GCOnly);
4492
4493 // Require that GC be specified and set to eImageInfo_GarbageCollected.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004494 llvm::Metadata *Ops[2] = {
4495 llvm::MDString::get(VMContext, "Objective-C Garbage Collection"),
4496 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
4497 llvm::Type::getInt32Ty(VMContext), eImageInfo_GarbageCollected))};
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004498 Mod.addModuleFlag(llvm::Module::Require, "Objective-C GC Only",
4499 llvm::MDNode::get(VMContext, Ops));
4500 }
4501 }
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004502
4503 // Indicate whether we're compiling this to run on a simulator.
4504 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Tim Northover756447a2015-10-30 16:30:36 +00004505 if ((Triple.isiOS() || Triple.isWatchOS()) &&
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004506 (Triple.getArch() == llvm::Triple::x86 ||
4507 Triple.getArch() == llvm::Triple::x86_64))
4508 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Is Simulated",
4509 eImageInfo_ImageIsSimulated);
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004510}
4511
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004512// struct objc_module {
4513// unsigned long version;
4514// unsigned long size;
4515// const char *name;
4516// Symtab symtab;
4517// };
4518
4519// FIXME: Get from somewhere
4520static const int ModuleVersion = 7;
4521
4522void CGObjCMac::EmitModuleInfo() {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004523 uint64_t Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ModuleTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004524
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004525 llvm::Constant *Values[] = {
4526 llvm::ConstantInt::get(ObjCTypes.LongTy, ModuleVersion),
4527 llvm::ConstantInt::get(ObjCTypes.LongTy, Size),
4528 // This used to be the filename, now it is unused. <rdr://4327263>
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004529 GetClassName(StringRef("")),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004530 EmitModuleSymbols()
4531 };
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004532 CreateMetadataVar("OBJC_MODULES",
Owen Anderson0e0189d2009-07-27 22:29:56 +00004533 llvm::ConstantStruct::get(ObjCTypes.ModuleTy, Values),
John McCall7f416cc2015-09-08 08:05:57 +00004534 "__OBJC,__module_info,regular,no_dead_strip",
4535 CGM.getPointerAlign(), true);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004536}
4537
4538llvm::Constant *CGObjCMac::EmitModuleSymbols() {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004539 unsigned NumClasses = DefinedClasses.size();
4540 unsigned NumCategories = DefinedCategories.size();
4541
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004542 // Return null if no symbols were defined.
4543 if (!NumClasses && !NumCategories)
Owen Anderson0b75f232009-07-31 20:28:54 +00004544 return llvm::Constant::getNullValue(ObjCTypes.SymtabPtrTy);
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004545
Chris Lattnere64d7ba2011-06-20 04:01:35 +00004546 llvm::Constant *Values[5];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00004547 Values[0] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
Owen Anderson0b75f232009-07-31 20:28:54 +00004548 Values[1] = llvm::Constant::getNullValue(ObjCTypes.SelectorPtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00004549 Values[2] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumClasses);
4550 Values[3] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumCategories);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004551
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004552 // The runtime expects exactly the list of defined classes followed
4553 // by the list of defined categories, in a single array.
Chris Lattner3def9ae2012-02-06 22:16:34 +00004554 SmallVector<llvm::Constant*, 8> Symbols(NumClasses + NumCategories);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004555 for (unsigned i=0; i<NumClasses; i++) {
4556 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
4557 assert(ID);
4558 if (ObjCImplementationDecl *IMP = ID->getImplementation())
4559 // We are implementing a weak imported interface. Give it external linkage
4560 if (ID->isWeakImported() && !IMP->isWeakImported())
4561 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
4562
Owen Andersonade90fd2009-07-29 18:54:39 +00004563 Symbols[i] = llvm::ConstantExpr::getBitCast(DefinedClasses[i],
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004564 ObjCTypes.Int8PtrTy);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004565 }
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004566 for (unsigned i=0; i<NumCategories; i++)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004567 Symbols[NumClasses + i] =
Owen Andersonade90fd2009-07-29 18:54:39 +00004568 llvm::ConstantExpr::getBitCast(DefinedCategories[i],
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004569 ObjCTypes.Int8PtrTy);
4570
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004571 Values[4] =
Owen Anderson9793f0e2009-07-29 22:16:19 +00004572 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00004573 Symbols.size()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004574 Symbols);
4575
Chris Lattnere64d7ba2011-06-20 04:01:35 +00004576 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004577
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004578 llvm::GlobalVariable *GV = CreateMetadataVar(
John McCall7f416cc2015-09-08 08:05:57 +00004579 "OBJC_SYMBOLS", Init, "__OBJC,__symbols,regular,no_dead_strip",
4580 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00004581 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.SymtabPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004582}
4583
John McCall882987f2013-02-28 19:01:20 +00004584llvm::Value *CGObjCMac::EmitClassRefFromId(CodeGenFunction &CGF,
4585 IdentifierInfo *II) {
John McCall31168b02011-06-15 23:02:42 +00004586 LazySymbols.insert(II);
4587
4588 llvm::GlobalVariable *&Entry = ClassReferences[II];
4589
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004590 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004591 llvm::Constant *Casted =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004592 llvm::ConstantExpr::getBitCast(GetClassName(II->getName()),
John McCall31168b02011-06-15 23:02:42 +00004593 ObjCTypes.ClassPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004594 Entry = CreateMetadataVar(
4595 "OBJC_CLASS_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004596 "__OBJC,__cls_refs,literal_pointers,no_dead_strip",
4597 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004598 }
John McCall31168b02011-06-15 23:02:42 +00004599
John McCall7f416cc2015-09-08 08:05:57 +00004600 return CGF.Builder.CreateAlignedLoad(Entry, CGF.getPointerAlign());
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004601}
4602
John McCall882987f2013-02-28 19:01:20 +00004603llvm::Value *CGObjCMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00004604 const ObjCInterfaceDecl *ID) {
John McCall882987f2013-02-28 19:01:20 +00004605 return EmitClassRefFromId(CGF, ID->getIdentifier());
John McCall31168b02011-06-15 23:02:42 +00004606}
4607
John McCall882987f2013-02-28 19:01:20 +00004608llvm::Value *CGObjCMac::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00004609 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCall882987f2013-02-28 19:01:20 +00004610 return EmitClassRefFromId(CGF, II);
John McCall31168b02011-06-15 23:02:42 +00004611}
4612
John McCall7f416cc2015-09-08 08:05:57 +00004613llvm::Value *CGObjCMac::EmitSelector(CodeGenFunction &CGF, Selector Sel) {
4614 return CGF.Builder.CreateLoad(EmitSelectorAddr(CGF, Sel));
4615}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004616
John McCall7f416cc2015-09-08 08:05:57 +00004617Address CGObjCMac::EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel) {
4618 CharUnits Align = CGF.getPointerAlign();
4619
4620 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004621 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004622 llvm::Constant *Casted =
Owen Andersonade90fd2009-07-29 18:54:39 +00004623 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004624 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004625 Entry = CreateMetadataVar(
4626 "OBJC_SELECTOR_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004627 "__OBJC,__message_refs,literal_pointers,no_dead_strip", Align, true);
Michael Gottesman5c205962013-02-05 23:08:45 +00004628 Entry->setExternallyInitialized(true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004629 }
4630
John McCall7f416cc2015-09-08 08:05:57 +00004631 return Address(Entry, Align);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004632}
4633
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004634llvm::Constant *CGObjCCommonMac::GetClassName(StringRef RuntimeName) {
4635 llvm::GlobalVariable *&Entry = ClassNames[RuntimeName];
4636 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004637 Entry = CreateMetadataVar(
4638 "OBJC_CLASS_NAME_",
4639 llvm::ConstantDataArray::getString(VMContext, RuntimeName),
4640 ((ObjCABI == 2) ? "__TEXT,__objc_classname,cstring_literals"
4641 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004642 CharUnits::One(), true);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004643 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004644}
4645
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004646llvm::Function *CGObjCCommonMac::GetMethodDefinition(const ObjCMethodDecl *MD) {
4647 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*>::iterator
4648 I = MethodDefinitions.find(MD);
4649 if (I != MethodDefinitions.end())
4650 return I->second;
4651
Craig Topper8a13c412014-05-21 05:09:00 +00004652 return nullptr;
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004653}
4654
Fariborz Jahanian01dff422009-03-05 19:17:31 +00004655/// GetIvarLayoutName - Returns a unique constant for the given
4656/// ivar layout bitmap.
4657llvm::Constant *CGObjCCommonMac::GetIvarLayoutName(IdentifierInfo *Ident,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004658 const ObjCCommonTypesHelper &ObjCTypes) {
Owen Anderson0b75f232009-07-31 20:28:54 +00004659 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Fariborz Jahanian01dff422009-03-05 19:17:31 +00004660}
4661
John McCall3fd13f062015-10-21 18:06:47 +00004662void IvarLayoutBuilder::visitRecord(const RecordType *RT,
4663 CharUnits offset) {
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004664 const RecordDecl *RD = RT->getDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004665
John McCall3fd13f062015-10-21 18:06:47 +00004666 // If this is a union, remember that we had one, because it might mess
4667 // up the ordering of layout entries.
4668 if (RD->isUnion())
4669 IsDisordered = true;
4670
4671 const ASTRecordLayout *recLayout = nullptr;
4672 visitAggregate(RD->field_begin(), RD->field_end(), offset,
4673 [&](const FieldDecl *field) -> CharUnits {
4674 if (!recLayout)
4675 recLayout = &CGM.getContext().getASTRecordLayout(RD);
4676 auto offsetInBits = recLayout->getFieldOffset(field->getFieldIndex());
4677 return CGM.getContext().toCharUnitsFromBits(offsetInBits);
4678 });
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004679}
4680
John McCall3fd13f062015-10-21 18:06:47 +00004681template <class Iterator, class GetOffsetFn>
4682void IvarLayoutBuilder::visitAggregate(Iterator begin, Iterator end,
4683 CharUnits aggregateOffset,
4684 const GetOffsetFn &getOffset) {
4685 for (; begin != end; ++begin) {
4686 auto field = *begin;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004687
John McCall3fd13f062015-10-21 18:06:47 +00004688 // Skip over bitfields.
4689 if (field->isBitField()) {
4690 continue;
4691 }
4692
4693 // Compute the offset of the field within the aggregate.
4694 CharUnits fieldOffset = aggregateOffset + getOffset(field);
4695
4696 visitField(field, fieldOffset);
4697 }
4698}
4699
4700/// Collect layout information for the given fields into IvarsInfo.
4701void IvarLayoutBuilder::visitField(const FieldDecl *field,
4702 CharUnits fieldOffset) {
4703 QualType fieldType = field->getType();
4704
4705 // Drill down into arrays.
4706 uint64_t numElts = 1;
4707 while (auto arrayType = CGM.getContext().getAsConstantArrayType(fieldType)) {
4708 numElts *= arrayType->getSize().getZExtValue();
4709 fieldType = arrayType->getElementType();
4710 }
4711
4712 assert(!fieldType->isArrayType() && "ivar of non-constant array type?");
4713
4714 // If we ended up with a zero-sized array, we've done what we can do within
4715 // the limits of this layout encoding.
4716 if (numElts == 0) return;
4717
4718 // Recurse if the base element type is a record type.
4719 if (auto recType = fieldType->getAs<RecordType>()) {
4720 size_t oldEnd = IvarsInfo.size();
4721
4722 visitRecord(recType, fieldOffset);
4723
4724 // If we have an array, replicate the first entry's layout information.
4725 auto numEltEntries = IvarsInfo.size() - oldEnd;
4726 if (numElts != 1 && numEltEntries != 0) {
4727 CharUnits eltSize = CGM.getContext().getTypeSizeInChars(recType);
4728 for (uint64_t eltIndex = 1; eltIndex != numElts; ++eltIndex) {
4729 // Copy the last numEltEntries onto the end of the array, adjusting
4730 // each for the element size.
4731 for (size_t i = 0; i != numEltEntries; ++i) {
4732 auto firstEntry = IvarsInfo[oldEnd + i];
4733 IvarsInfo.push_back(IvarInfo(firstEntry.Offset + eltIndex * eltSize,
4734 firstEntry.SizeInWords));
4735 }
4736 }
4737 }
4738
Fariborz Jahanian524bb202009-03-10 16:22:08 +00004739 return;
Fariborz Jahanian3b0f8862009-03-11 00:07:04 +00004740 }
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004741
John McCall3fd13f062015-10-21 18:06:47 +00004742 // Classify the element type.
4743 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), fieldType);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004744
John McCall3fd13f062015-10-21 18:06:47 +00004745 // If it matches what we're looking for, add an entry.
4746 if ((ForStrongLayout && GCAttr == Qualifiers::Strong)
4747 || (!ForStrongLayout && GCAttr == Qualifiers::Weak)) {
4748 assert(CGM.getContext().getTypeSizeInChars(fieldType)
4749 == CGM.getPointerSize());
4750 IvarsInfo.push_back(IvarInfo(fieldOffset, numElts));
4751 }
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00004752}
4753
John McCall3fd13f062015-10-21 18:06:47 +00004754/// buildBitmap - This routine does the horsework of taking the offsets of
4755/// strong/weak references and creating a bitmap. The bitmap is also
4756/// returned in the given buffer, suitable for being passed to \c dump().
4757llvm::Constant *IvarLayoutBuilder::buildBitmap(CGObjCCommonMac &CGObjC,
4758 llvm::SmallVectorImpl<unsigned char> &buffer) {
4759 // The bitmap is a series of skip/scan instructions, aligned to word
4760 // boundaries. The skip is performed first.
4761 const unsigned char MaxNibble = 0xF;
4762 const unsigned char SkipMask = 0xF0, SkipShift = 4;
4763 const unsigned char ScanMask = 0x0F, ScanShift = 0;
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004764
John McCall3fd13f062015-10-21 18:06:47 +00004765 assert(!IvarsInfo.empty() && "generating bitmap for no data");
4766
4767 // Sort the ivar info on byte position in case we encounterred a
4768 // union nested in the ivar list.
4769 if (IsDisordered) {
4770 // This isn't a stable sort, but our algorithm should handle it fine.
4771 llvm::array_pod_sort(IvarsInfo.begin(), IvarsInfo.end());
4772 } else {
Craig Toppera3467052016-01-03 19:43:20 +00004773 assert(std::is_sorted(IvarsInfo.begin(), IvarsInfo.end()));
John McCall3fd13f062015-10-21 18:06:47 +00004774 }
4775 assert(IvarsInfo.back().Offset < InstanceEnd);
4776
4777 assert(buffer.empty());
4778
4779 // Skip the next N words.
4780 auto skip = [&](unsigned numWords) {
4781 assert(numWords > 0);
4782
4783 // Try to merge into the previous byte. Since scans happen second, we
4784 // can't do this if it includes a scan.
4785 if (!buffer.empty() && !(buffer.back() & ScanMask)) {
4786 unsigned lastSkip = buffer.back() >> SkipShift;
4787 if (lastSkip < MaxNibble) {
4788 unsigned claimed = std::min(MaxNibble - lastSkip, numWords);
4789 numWords -= claimed;
4790 lastSkip += claimed;
4791 buffer.back() = (lastSkip << SkipShift);
4792 }
4793 }
4794
4795 while (numWords >= MaxNibble) {
4796 buffer.push_back(MaxNibble << SkipShift);
4797 numWords -= MaxNibble;
4798 }
4799 if (numWords) {
4800 buffer.push_back(numWords << SkipShift);
4801 }
4802 };
4803
4804 // Scan the next N words.
4805 auto scan = [&](unsigned numWords) {
4806 assert(numWords > 0);
4807
4808 // Try to merge into the previous byte. Since scans happen second, we can
4809 // do this even if it includes a skip.
4810 if (!buffer.empty()) {
4811 unsigned lastScan = (buffer.back() & ScanMask) >> ScanShift;
4812 if (lastScan < MaxNibble) {
4813 unsigned claimed = std::min(MaxNibble - lastScan, numWords);
4814 numWords -= claimed;
4815 lastScan += claimed;
4816 buffer.back() = (buffer.back() & SkipMask) | (lastScan << ScanShift);
4817 }
4818 }
4819
4820 while (numWords >= MaxNibble) {
4821 buffer.push_back(MaxNibble << ScanShift);
4822 numWords -= MaxNibble;
4823 }
4824 if (numWords) {
4825 buffer.push_back(numWords << ScanShift);
4826 }
4827 };
4828
4829 // One past the end of the last scan.
4830 unsigned endOfLastScanInWords = 0;
4831 const CharUnits WordSize = CGM.getPointerSize();
4832
4833 // Consider all the scan requests.
4834 for (auto &request : IvarsInfo) {
4835 CharUnits beginOfScan = request.Offset - InstanceBegin;
4836
4837 // Ignore scan requests that don't start at an even multiple of the
4838 // word size. We can't encode them.
4839 if ((beginOfScan % WordSize) != 0) continue;
4840
4841 // Ignore scan requests that start before the instance start.
4842 // This assumes that scans never span that boundary. The boundary
4843 // isn't the true start of the ivars, because in the fragile-ARC case
4844 // it's rounded up to word alignment, but the test above should leave
4845 // us ignoring that possibility.
4846 if (beginOfScan.isNegative()) {
4847 assert(request.Offset + request.SizeInWords * WordSize <= InstanceBegin);
4848 continue;
4849 }
4850
4851 unsigned beginOfScanInWords = beginOfScan / WordSize;
4852 unsigned endOfScanInWords = beginOfScanInWords + request.SizeInWords;
4853
4854 // If the scan starts some number of words after the last one ended,
4855 // skip forward.
4856 if (beginOfScanInWords > endOfLastScanInWords) {
4857 skip(beginOfScanInWords - endOfLastScanInWords);
4858
4859 // Otherwise, start scanning where the last left off.
4860 } else {
4861 beginOfScanInWords = endOfLastScanInWords;
4862
4863 // If that leaves us with nothing to scan, ignore this request.
4864 if (beginOfScanInWords >= endOfScanInWords) continue;
4865 }
4866
4867 // Scan to the end of the request.
4868 assert(beginOfScanInWords < endOfScanInWords);
4869 scan(endOfScanInWords - beginOfScanInWords);
4870 endOfLastScanInWords = endOfScanInWords;
4871 }
4872
John McCallf5ea0722015-10-29 23:36:14 +00004873 if (buffer.empty())
4874 return llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
4875
John McCall3fd13f062015-10-21 18:06:47 +00004876 // For GC layouts, emit a skip to the end of the allocation so that we
4877 // have precise information about the entire thing. This isn't useful
4878 // or necessary for the ARC-style layout strings.
4879 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
4880 unsigned lastOffsetInWords =
4881 (InstanceEnd - InstanceBegin + WordSize - CharUnits::One()) / WordSize;
4882 if (lastOffsetInWords > endOfLastScanInWords) {
4883 skip(lastOffsetInWords - endOfLastScanInWords);
4884 }
4885 }
4886
4887 // Null terminate the string.
4888 buffer.push_back(0);
4889
4890 bool isNonFragileABI = CGObjC.isNonFragileABI();
4891
4892 llvm::GlobalVariable *Entry = CGObjC.CreateMetadataVar(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004893 "OBJC_CLASS_NAME_",
John McCall3fd13f062015-10-21 18:06:47 +00004894 llvm::ConstantDataArray::get(CGM.getLLVMContext(), buffer),
4895 (isNonFragileABI ? "__TEXT,__objc_classname,cstring_literals"
4896 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004897 CharUnits::One(), true);
John McCall3fd13f062015-10-21 18:06:47 +00004898 return getConstantGEP(CGM.getLLVMContext(), Entry, 0, 0);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004899}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004900
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004901/// BuildIvarLayout - Builds ivar layout bitmap for the class
4902/// implementation for the __strong or __weak case.
4903/// The layout map displays which words in ivar list must be skipped
4904/// and which must be scanned by GC (see below). String is built of bytes.
4905/// Each byte is divided up in two nibbles (4-bit each). Left nibble is count
4906/// of words to skip and right nibble is count of words to scan. So, each
4907/// nibble represents up to 15 workds to skip or scan. Skipping the rest is
4908/// represented by a 0x00 byte which also ends the string.
4909/// 1. when ForStrongLayout is true, following ivars are scanned:
4910/// - id, Class
4911/// - object *
4912/// - __strong anything
4913///
4914/// 2. When ForStrongLayout is false, following ivars are scanned:
4915/// - __weak anything
4916///
John McCall3fd13f062015-10-21 18:06:47 +00004917llvm::Constant *
4918CGObjCCommonMac::BuildIvarLayout(const ObjCImplementationDecl *OMD,
4919 CharUnits beginOffset, CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +00004920 bool ForStrongLayout, bool HasMRCWeakIvars) {
4921 // If this is MRC, and we're either building a strong layout or there
4922 // are no weak ivars, bail out early.
Chris Lattnerece04092012-02-07 00:39:47 +00004923 llvm::Type *PtrTy = CGM.Int8PtrTy;
David Blaikiebbafb8a2012-03-11 07:00:24 +00004924 if (CGM.getLangOpts().getGC() == LangOptions::NonGC &&
John McCall460ce582015-10-22 18:38:17 +00004925 !CGM.getLangOpts().ObjCAutoRefCount &&
4926 (ForStrongLayout || !HasMRCWeakIvars))
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004927 return llvm::Constant::getNullValue(PtrTy);
4928
Jordy Rosea91768e2011-07-22 02:08:32 +00004929 const ObjCInterfaceDecl *OI = OMD->getClassInterface();
John McCall3fd13f062015-10-21 18:06:47 +00004930 SmallVector<const ObjCIvarDecl*, 32> ivars;
4931
4932 // GC layout strings include the complete object layout, possibly
4933 // inaccurately in the non-fragile ABI; the runtime knows how to fix this
4934 // up.
4935 //
4936 // ARC layout strings only include the class's ivars. In non-fragile
John McCallf5ea0722015-10-29 23:36:14 +00004937 // runtimes, that means starting at InstanceStart, rounded up to word
4938 // alignment. In fragile runtimes, there's no InstanceStart, so it means
John McCalld80218f2015-11-19 02:27:55 +00004939 // starting at the offset of the first ivar, rounded up to word alignment.
John McCall460ce582015-10-22 18:38:17 +00004940 //
4941 // MRC weak layout strings follow the ARC style.
John McCall3fd13f062015-10-21 18:06:47 +00004942 CharUnits baseOffset;
John McCall460ce582015-10-22 18:38:17 +00004943 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Jordy Rosea91768e2011-07-22 02:08:32 +00004944 for (const ObjCIvarDecl *IVD = OI->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00004945 IVD; IVD = IVD->getNextIvar())
John McCall3fd13f062015-10-21 18:06:47 +00004946 ivars.push_back(IVD);
4947
4948 if (isNonFragileABI()) {
4949 baseOffset = beginOffset; // InstanceStart
John McCalld80218f2015-11-19 02:27:55 +00004950 } else if (!ivars.empty()) {
4951 baseOffset =
4952 CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivars[0]));
John McCall3fd13f062015-10-21 18:06:47 +00004953 } else {
4954 baseOffset = CharUnits::Zero();
4955 }
John McCallf5ea0722015-10-29 23:36:14 +00004956
Rui Ueyama83aa9792016-01-14 21:00:27 +00004957 baseOffset = baseOffset.alignTo(CGM.getPointerAlign());
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00004958 }
4959 else {
John McCall3fd13f062015-10-21 18:06:47 +00004960 CGM.getContext().DeepCollectObjCIvars(OI, true, ivars);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004961
John McCall3fd13f062015-10-21 18:06:47 +00004962 baseOffset = CharUnits::Zero();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00004963 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004964
John McCall3fd13f062015-10-21 18:06:47 +00004965 if (ivars.empty())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004966 return llvm::Constant::getNullValue(PtrTy);
4967
John McCall3fd13f062015-10-21 18:06:47 +00004968 IvarLayoutBuilder builder(CGM, baseOffset, endOffset, ForStrongLayout);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004969
John McCall3fd13f062015-10-21 18:06:47 +00004970 builder.visitAggregate(ivars.begin(), ivars.end(), CharUnits::Zero(),
4971 [&](const ObjCIvarDecl *ivar) -> CharUnits {
4972 return CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivar));
4973 });
4974
4975 if (!builder.hasBitmapData())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004976 return llvm::Constant::getNullValue(PtrTy);
John McCall3fd13f062015-10-21 18:06:47 +00004977
4978 llvm::SmallVector<unsigned char, 4> buffer;
4979 llvm::Constant *C = builder.buildBitmap(*this, buffer);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004980
John McCallf5ea0722015-10-29 23:36:14 +00004981 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004982 printf("\n%s ivar layout for class '%s': ",
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00004983 ForStrongLayout ? "strong" : "weak",
Ben Langmuire013bdc2014-07-11 00:43:47 +00004984 OMD->getClassInterface()->getName().str().c_str());
John McCall3fd13f062015-10-21 18:06:47 +00004985 builder.dump(buffer);
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00004986 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004987 return C;
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00004988}
4989
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00004990llvm::Constant *CGObjCCommonMac::GetMethodVarName(Selector Sel) {
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004991 llvm::GlobalVariable *&Entry = MethodVarNames[Sel];
4992
Chris Lattner3def9ae2012-02-06 22:16:34 +00004993 // FIXME: Avoid std::string in "Sel.getAsString()"
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004994 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004995 Entry = CreateMetadataVar(
4996 "OBJC_METH_VAR_NAME_",
4997 llvm::ConstantDataArray::getString(VMContext, Sel.getAsString()),
4998 ((ObjCABI == 2) ? "__TEXT,__objc_methname,cstring_literals"
4999 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00005000 CharUnits::One(), true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005001
Owen Anderson170229f2009-07-14 23:10:40 +00005002 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005003}
5004
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005005// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005006llvm::Constant *CGObjCCommonMac::GetMethodVarName(IdentifierInfo *ID) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005007 return GetMethodVarName(CGM.getContext().Selectors.getNullarySelector(ID));
5008}
5009
Daniel Dunbarf5c18462009-04-20 06:54:31 +00005010llvm::Constant *CGObjCCommonMac::GetMethodVarType(const FieldDecl *Field) {
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005011 std::string TypeStr;
5012 CGM.getContext().getObjCEncodingForType(Field->getType(), TypeStr, Field);
5013
5014 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbarb036db82008-08-13 03:21:16 +00005015
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005016 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005017 Entry = CreateMetadataVar(
5018 "OBJC_METH_VAR_TYPE_",
5019 llvm::ConstantDataArray::getString(VMContext, TypeStr),
5020 ((ObjCABI == 2) ? "__TEXT,__objc_methtype,cstring_literals"
5021 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00005022 CharUnits::One(), true);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005023
Owen Anderson170229f2009-07-14 23:10:40 +00005024 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005025}
5026
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005027llvm::Constant *CGObjCCommonMac::GetMethodVarType(const ObjCMethodDecl *D,
5028 bool Extended) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005029 std::string TypeStr;
Bill Wendlinge22bef72012-02-09 22:45:21 +00005030 if (CGM.getContext().getObjCEncodingForMethodDecl(D, TypeStr, Extended))
Craig Topper8a13c412014-05-21 05:09:00 +00005031 return nullptr;
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005032
5033 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
5034
Daniel Dunbar3241fae2009-04-14 23:14:47 +00005035 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005036 Entry = CreateMetadataVar(
5037 "OBJC_METH_VAR_TYPE_",
5038 llvm::ConstantDataArray::getString(VMContext, TypeStr),
5039 ((ObjCABI == 2) ? "__TEXT,__objc_methtype,cstring_literals"
5040 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00005041 CharUnits::One(), true);
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005042
Owen Anderson170229f2009-07-14 23:10:40 +00005043 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005044}
5045
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005046// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005047llvm::Constant *CGObjCCommonMac::GetPropertyName(IdentifierInfo *Ident) {
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005048 llvm::GlobalVariable *&Entry = PropertyNames[Ident];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005049
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005050 if (!Entry)
Alp Toker541d5072014-06-07 23:30:53 +00005051 Entry = CreateMetadataVar(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005052 "OBJC_PROP_NAME_ATTR_",
Alp Toker541d5072014-06-07 23:30:53 +00005053 llvm::ConstantDataArray::getString(VMContext, Ident->getName()),
John McCall7f416cc2015-09-08 08:05:57 +00005054 "__TEXT,__cstring,cstring_literals", CharUnits::One(), true);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005055
Owen Anderson170229f2009-07-14 23:10:40 +00005056 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005057}
5058
5059// FIXME: Merge into a single cstring creation function.
Daniel Dunbar4932b362008-08-28 04:38:10 +00005060// FIXME: This Decl should be more precise.
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005061llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005062CGObjCCommonMac::GetPropertyTypeString(const ObjCPropertyDecl *PD,
5063 const Decl *Container) {
Daniel Dunbar4932b362008-08-28 04:38:10 +00005064 std::string TypeStr;
5065 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container, TypeStr);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005066 return GetPropertyName(&CGM.getContext().Idents.get(TypeStr));
5067}
5068
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005069void CGObjCCommonMac::GetNameForMethod(const ObjCMethodDecl *D,
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005070 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005071 SmallVectorImpl<char> &Name) {
Daniel Dunbard2386812009-10-19 01:21:19 +00005072 llvm::raw_svector_ostream OS(Name);
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00005073 assert (CD && "Missing container decl in GetNameForMethod");
Daniel Dunbard2386812009-10-19 01:21:19 +00005074 OS << '\01' << (D->isInstanceMethod() ? '-' : '+')
5075 << '[' << CD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005076 if (const ObjCCategoryImplDecl *CID =
Daniel Dunbard2386812009-10-19 01:21:19 +00005077 dyn_cast<ObjCCategoryImplDecl>(D->getDeclContext()))
Benjamin Kramer2f569922012-02-07 11:57:45 +00005078 OS << '(' << *CID << ')';
Daniel Dunbard2386812009-10-19 01:21:19 +00005079 OS << ' ' << D->getSelector().getAsString() << ']';
Daniel Dunbara94ecd22008-08-16 03:19:19 +00005080}
5081
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005082void CGObjCMac::FinishModule() {
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005083 EmitModuleInfo();
5084
Daniel Dunbarc475d422008-10-29 22:36:39 +00005085 // Emit the dummy bodies for any protocols which were referenced but
5086 // never defined.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005087 for (llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*>::iterator
Chris Lattnerf56501c2009-07-17 23:57:13 +00005088 I = Protocols.begin(), e = Protocols.end(); I != e; ++I) {
5089 if (I->second->hasInitializer())
Daniel Dunbarc475d422008-10-29 22:36:39 +00005090 continue;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005091
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005092 llvm::Constant *Values[5];
Owen Anderson0b75f232009-07-31 20:28:54 +00005093 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005094 Values[1] = GetClassName(I->first->getName());
Owen Anderson0b75f232009-07-31 20:28:54 +00005095 Values[2] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005096 Values[3] = Values[4] =
Owen Anderson0b75f232009-07-31 20:28:54 +00005097 llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00005098 I->second->setInitializer(llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbarc475d422008-10-29 22:36:39 +00005099 Values));
Rafael Espindola060062a2014-03-06 22:15:10 +00005100 CGM.addCompilerUsedGlobal(I->second);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005101 }
5102
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005103 // Add assembler directives to add lazy undefined symbol references
5104 // for classes which are referenced but not defined. This is
5105 // important for correct linker interaction.
Daniel Dunbard027a922009-09-07 00:20:42 +00005106 //
5107 // FIXME: It would be nice if we had an LLVM construct for this.
5108 if (!LazySymbols.empty() || !DefinedSymbols.empty()) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00005109 SmallString<256> Asm;
Daniel Dunbard027a922009-09-07 00:20:42 +00005110 Asm += CGM.getModule().getModuleInlineAsm();
5111 if (!Asm.empty() && Asm.back() != '\n')
5112 Asm += '\n';
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005113
Daniel Dunbard027a922009-09-07 00:20:42 +00005114 llvm::raw_svector_ostream OS(Asm);
Daniel Dunbard027a922009-09-07 00:20:42 +00005115 for (llvm::SetVector<IdentifierInfo*>::iterator I = DefinedSymbols.begin(),
5116 e = DefinedSymbols.end(); I != e; ++I)
Daniel Dunbar07d07852009-10-18 21:17:35 +00005117 OS << "\t.objc_class_name_" << (*I)->getName() << "=0\n"
5118 << "\t.globl .objc_class_name_" << (*I)->getName() << "\n";
Chris Lattnera299f2c2010-04-17 18:26:20 +00005119 for (llvm::SetVector<IdentifierInfo*>::iterator I = LazySymbols.begin(),
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005120 e = LazySymbols.end(); I != e; ++I) {
Chris Lattnera299f2c2010-04-17 18:26:20 +00005121 OS << "\t.lazy_reference .objc_class_name_" << (*I)->getName() << "\n";
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005122 }
5123
Bill Wendling53136852012-02-07 09:06:01 +00005124 for (size_t i = 0, e = DefinedCategoryNames.size(); i < e; ++i) {
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005125 OS << "\t.objc_category_name_" << DefinedCategoryNames[i] << "=0\n"
5126 << "\t.globl .objc_category_name_" << DefinedCategoryNames[i] << "\n";
5127 }
Chris Lattnera299f2c2010-04-17 18:26:20 +00005128
Daniel Dunbard027a922009-09-07 00:20:42 +00005129 CGM.getModule().setModuleInlineAsm(OS.str());
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005130 }
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005131}
5132
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005133CGObjCNonFragileABIMac::CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm)
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005134 : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00005135 ObjCTypes(cgm) {
Craig Topper8a13c412014-05-21 05:09:00 +00005136 ObjCEmptyCacheVar = ObjCEmptyVtableVar = nullptr;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005137 ObjCABI = 2;
5138}
5139
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005140/* *** */
5141
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005142ObjCCommonTypesHelper::ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm)
Craig Topper8a13c412014-05-21 05:09:00 +00005143 : VMContext(cgm.getLLVMContext()), CGM(cgm), ExternalProtocolPtrTy(nullptr)
Douglas Gregora95f9aa2012-01-17 23:38:32 +00005144{
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005145 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5146 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005147
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005148 ShortTy = Types.ConvertType(Ctx.ShortTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005149 IntTy = Types.ConvertType(Ctx.IntTy);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005150 LongTy = Types.ConvertType(Ctx.LongTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00005151 LongLongTy = Types.ConvertType(Ctx.LongLongTy);
Chris Lattnerece04092012-02-07 00:39:47 +00005152 Int8PtrTy = CGM.Int8PtrTy;
5153 Int8PtrPtrTy = CGM.Int8PtrPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005154
Tim Northover238b5082014-03-29 13:42:40 +00005155 // arm64 targets use "int" ivar offset variables. All others,
5156 // including OS X x86_64 and Windows x86_64, use "long" ivar offsets.
Tim Northover40956e62014-07-23 12:32:58 +00005157 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::aarch64)
Tim Northover238b5082014-03-29 13:42:40 +00005158 IvarOffsetVarTy = IntTy;
5159 else
5160 IvarOffsetVarTy = LongTy;
5161
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005162 ObjectPtrTy = Types.ConvertType(Ctx.getObjCIdType());
Owen Anderson9793f0e2009-07-29 22:16:19 +00005163 PtrObjectPtrTy = llvm::PointerType::getUnqual(ObjectPtrTy);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005164 SelectorPtrTy = Types.ConvertType(Ctx.getObjCSelType());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005165
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005166 // I'm not sure I like this. The implicit coordination is a bit
5167 // gross. We should solve this in a reasonable fashion because this
5168 // is a pretty common task (match some runtime data structure with
5169 // an LLVM data structure).
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005170
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005171 // FIXME: This is leaked.
5172 // FIXME: Merge with rewriter code?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005173
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005174 // struct _objc_super {
5175 // id self;
5176 // Class cls;
5177 // }
Abramo Bagnara6150c882010-05-11 21:36:43 +00005178 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005179 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005180 SourceLocation(), SourceLocation(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005181 &Ctx.Idents.get("_objc_super"));
Craig Topper8a13c412014-05-21 05:09:00 +00005182 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5183 nullptr, Ctx.getObjCIdType(), nullptr, nullptr,
5184 false, ICIS_NoInit));
5185 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5186 nullptr, Ctx.getObjCClassType(), nullptr,
5187 nullptr, false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005188 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005189
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005190 SuperCTy = Ctx.getTagDeclType(RD);
5191 SuperPtrCTy = Ctx.getPointerType(SuperCTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005192
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005193 SuperTy = cast<llvm::StructType>(Types.ConvertType(SuperCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005194 SuperPtrTy = llvm::PointerType::getUnqual(SuperTy);
5195
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005196 // struct _prop_t {
5197 // char *name;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005198 // char *attributes;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005199 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005200 PropertyTy = llvm::StructType::create("struct._prop_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005201 Int8PtrTy, Int8PtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005202
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005203 // struct _prop_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005204 // uint32_t entsize; // sizeof(struct _prop_t)
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005205 // uint32_t count_of_properties;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005206 // struct _prop_t prop_list[count_of_properties];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005207 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005208 PropertyListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005209 llvm::StructType::create("struct._prop_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005210 llvm::ArrayType::get(PropertyTy, 0), nullptr);
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005211 // struct _prop_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005212 PropertyListPtrTy = llvm::PointerType::getUnqual(PropertyListTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005213
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005214 // struct _objc_method {
5215 // SEL _cmd;
5216 // char *method_type;
5217 // char *_imp;
5218 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005219 MethodTy = llvm::StructType::create("struct._objc_method",
5220 SelectorPtrTy, Int8PtrTy, Int8PtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005221 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005222
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005223 // struct _objc_cache *
Chris Lattner5ec04a52011-08-12 17:43:31 +00005224 CacheTy = llvm::StructType::create(VMContext, "struct._objc_cache");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005225 CachePtrTy = llvm::PointerType::getUnqual(CacheTy);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00005226
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005227}
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005228
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005229ObjCTypesHelper::ObjCTypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005230 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005231 // struct _objc_method_description {
5232 // SEL name;
5233 // char *types;
5234 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005235 MethodDescriptionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005236 llvm::StructType::create("struct._objc_method_description",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005237 SelectorPtrTy, Int8PtrTy, nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005238
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005239 // struct _objc_method_description_list {
5240 // int count;
5241 // struct _objc_method_description[1];
5242 // }
Reid Kleckneree7cf842014-12-01 22:02:27 +00005243 MethodDescriptionListTy = llvm::StructType::create(
5244 "struct._objc_method_description_list", IntTy,
5245 llvm::ArrayType::get(MethodDescriptionTy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005246
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005247 // struct _objc_method_description_list *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005248 MethodDescriptionListPtrTy =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005249 llvm::PointerType::getUnqual(MethodDescriptionListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005250
Daniel Dunbarb036db82008-08-13 03:21:16 +00005251 // Protocol description structures
5252
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005253 // struct _objc_protocol_extension {
5254 // uint32_t size; // sizeof(struct _objc_protocol_extension)
5255 // struct _objc_method_description_list *optional_instance_methods;
5256 // struct _objc_method_description_list *optional_class_methods;
5257 // struct _objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005258 // const char ** extendedMethodTypes;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005259 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005260 ProtocolExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005261 llvm::StructType::create("struct._objc_protocol_extension",
5262 IntTy, MethodDescriptionListPtrTy,
5263 MethodDescriptionListPtrTy, PropertyListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005264 Int8PtrPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005265
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005266 // struct _objc_protocol_extension *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005267 ProtocolExtensionPtrTy = llvm::PointerType::getUnqual(ProtocolExtensionTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005268
Daniel Dunbarc475d422008-10-29 22:36:39 +00005269 // Handle recursive construction of Protocol and ProtocolList types
Daniel Dunbarb036db82008-08-13 03:21:16 +00005270
Chris Lattnera5f58b02011-07-09 17:41:47 +00005271 ProtocolTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005272 llvm::StructType::create(VMContext, "struct._objc_protocol");
Daniel Dunbarb036db82008-08-13 03:21:16 +00005273
Chris Lattnera5f58b02011-07-09 17:41:47 +00005274 ProtocolListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005275 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005276 ProtocolListTy->setBody(llvm::PointerType::getUnqual(ProtocolListTy),
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005277 LongTy,
Chris Lattnera5f58b02011-07-09 17:41:47 +00005278 llvm::ArrayType::get(ProtocolTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005279 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005280
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005281 // struct _objc_protocol {
5282 // struct _objc_protocol_extension *isa;
5283 // char *protocol_name;
5284 // struct _objc_protocol **_objc_protocol_list;
5285 // struct _objc_method_description_list *instance_methods;
5286 // struct _objc_method_description_list *class_methods;
5287 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005288 ProtocolTy->setBody(ProtocolExtensionPtrTy, Int8PtrTy,
5289 llvm::PointerType::getUnqual(ProtocolListTy),
5290 MethodDescriptionListPtrTy,
5291 MethodDescriptionListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005292 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005293
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005294 // struct _objc_protocol_list *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005295 ProtocolListPtrTy = llvm::PointerType::getUnqual(ProtocolListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005296
Owen Anderson9793f0e2009-07-29 22:16:19 +00005297 ProtocolPtrTy = llvm::PointerType::getUnqual(ProtocolTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005298
5299 // Class description structures
5300
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005301 // struct _objc_ivar {
5302 // char *ivar_name;
5303 // char *ivar_type;
5304 // int ivar_offset;
5305 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005306 IvarTy = llvm::StructType::create("struct._objc_ivar",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005307 Int8PtrTy, Int8PtrTy, IntTy, nullptr);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005308
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005309 // struct _objc_ivar_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005310 IvarListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005311 llvm::StructType::create(VMContext, "struct._objc_ivar_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005312 IvarListPtrTy = llvm::PointerType::getUnqual(IvarListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005313
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005314 // struct _objc_method_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005315 MethodListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005316 llvm::StructType::create(VMContext, "struct._objc_method_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005317 MethodListPtrTy = llvm::PointerType::getUnqual(MethodListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005318
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005319 // struct _objc_class_extension *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005320 ClassExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005321 llvm::StructType::create("struct._objc_class_extension",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005322 IntTy, Int8PtrTy, PropertyListPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005323 ClassExtensionPtrTy = llvm::PointerType::getUnqual(ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005324
Chris Lattner5ec04a52011-08-12 17:43:31 +00005325 ClassTy = llvm::StructType::create(VMContext, "struct._objc_class");
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005326
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005327 // struct _objc_class {
5328 // Class isa;
5329 // Class super_class;
5330 // char *name;
5331 // long version;
5332 // long info;
5333 // long instance_size;
5334 // struct _objc_ivar_list *ivars;
5335 // struct _objc_method_list *methods;
5336 // struct _objc_cache *cache;
5337 // struct _objc_protocol_list *protocols;
5338 // char *ivar_layout;
5339 // struct _objc_class_ext *ext;
5340 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005341 ClassTy->setBody(llvm::PointerType::getUnqual(ClassTy),
5342 llvm::PointerType::getUnqual(ClassTy),
5343 Int8PtrTy,
5344 LongTy,
5345 LongTy,
5346 LongTy,
5347 IvarListPtrTy,
5348 MethodListPtrTy,
5349 CachePtrTy,
5350 ProtocolListPtrTy,
5351 Int8PtrTy,
5352 ClassExtensionPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005353 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005354
Owen Anderson9793f0e2009-07-29 22:16:19 +00005355 ClassPtrTy = llvm::PointerType::getUnqual(ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005356
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005357 // struct _objc_category {
5358 // char *category_name;
5359 // char *class_name;
5360 // struct _objc_method_list *instance_method;
5361 // struct _objc_method_list *class_method;
5362 // uint32_t size; // sizeof(struct _objc_category)
5363 // struct _objc_property_list *instance_properties;// category's @property
5364 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005365 CategoryTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005366 llvm::StructType::create("struct._objc_category",
5367 Int8PtrTy, Int8PtrTy, MethodListPtrTy,
5368 MethodListPtrTy, ProtocolListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005369 IntTy, PropertyListPtrTy, nullptr);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00005370
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005371 // Global metadata structures
5372
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005373 // struct _objc_symtab {
5374 // long sel_ref_cnt;
5375 // SEL *refs;
5376 // short cls_def_cnt;
5377 // short cat_def_cnt;
5378 // char *defs[cls_def_cnt + cat_def_cnt];
5379 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005380 SymtabTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005381 llvm::StructType::create("struct._objc_symtab",
5382 LongTy, SelectorPtrTy, ShortTy, ShortTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005383 llvm::ArrayType::get(Int8PtrTy, 0), nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005384 SymtabPtrTy = llvm::PointerType::getUnqual(SymtabTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005385
Fariborz Jahanianeee54df2009-01-22 00:37:21 +00005386 // struct _objc_module {
5387 // long version;
5388 // long size; // sizeof(struct _objc_module)
5389 // char *name;
5390 // struct _objc_symtab* symtab;
5391 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005392 ModuleTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005393 llvm::StructType::create("struct._objc_module",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005394 LongTy, LongTy, Int8PtrTy, SymtabPtrTy, nullptr);
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00005395
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005396
Mike Stump18bb9282009-05-16 07:57:57 +00005397 // FIXME: This is the size of the setjmp buffer and should be target
5398 // specific. 18 is what's used on 32-bit X86.
Anders Carlsson9ff22482008-09-09 10:10:21 +00005399 uint64_t SetJmpBufferSize = 18;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005400
Anders Carlsson9ff22482008-09-09 10:10:21 +00005401 // Exceptions
Chris Lattnerece04092012-02-07 00:39:47 +00005402 llvm::Type *StackPtrTy = llvm::ArrayType::get(CGM.Int8PtrTy, 4);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005403
5404 ExceptionDataTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005405 llvm::StructType::create("struct._objc_exception_data",
Chris Lattnerece04092012-02-07 00:39:47 +00005406 llvm::ArrayType::get(CGM.Int32Ty,SetJmpBufferSize),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005407 StackPtrTy, nullptr);
Anders Carlsson9ff22482008-09-09 10:10:21 +00005408
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005409}
5410
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005411ObjCNonFragileABITypesHelper::ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005412 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005413 // struct _method_list_t {
5414 // uint32_t entsize; // sizeof(struct _objc_method)
5415 // uint32_t method_count;
5416 // struct _objc_method method_list[method_count];
5417 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005418 MethodListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005419 llvm::StructType::create("struct.__method_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005420 llvm::ArrayType::get(MethodTy, 0), nullptr);
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005421 // struct method_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005422 MethodListnfABIPtrTy = llvm::PointerType::getUnqual(MethodListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005423
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005424 // struct _protocol_t {
5425 // id isa; // NULL
5426 // const char * const protocol_name;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005427 // const struct _protocol_list_t * protocol_list; // super protocols
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005428 // const struct method_list_t * const instance_methods;
5429 // const struct method_list_t * const class_methods;
5430 // const struct method_list_t *optionalInstanceMethods;
5431 // const struct method_list_t *optionalClassMethods;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005432 // const struct _prop_list_t * properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005433 // const uint32_t size; // sizeof(struct _protocol_t)
5434 // const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005435 // const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00005436 // const char *demangledName;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005437 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005438
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005439 // Holder for struct _protocol_list_t *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005440 ProtocolListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005441 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005442
Chris Lattnera5f58b02011-07-09 17:41:47 +00005443 ProtocolnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005444 llvm::StructType::create("struct._protocol_t", ObjectPtrTy, Int8PtrTy,
5445 llvm::PointerType::getUnqual(ProtocolListnfABITy),
5446 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
5447 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005448 PropertyListPtrTy, IntTy, IntTy, Int8PtrPtrTy,
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00005449 Int8PtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005450 nullptr);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005451
5452 // struct _protocol_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005453 ProtocolnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005454
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005455 // struct _protocol_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005456 // long protocol_count; // Note, this is 32/64 bit
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005457 // struct _protocol_t *[protocol_count];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005458 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005459 ProtocolListnfABITy->setBody(LongTy,
5460 llvm::ArrayType::get(ProtocolnfABIPtrTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005461 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005462
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005463 // struct _objc_protocol_list*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005464 ProtocolListnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005465
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005466 // struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00005467 // unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005468 // char *name;
5469 // char *type;
5470 // uint32_t alignment;
5471 // uint32_t size;
5472 // }
Tim Northover238b5082014-03-29 13:42:40 +00005473 IvarnfABITy = llvm::StructType::create(
5474 "struct._ivar_t", llvm::PointerType::getUnqual(IvarOffsetVarTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005475 Int8PtrTy, Int8PtrTy, IntTy, IntTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005476
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005477 // struct _ivar_list_t {
5478 // uint32 entsize; // sizeof(struct _ivar_t)
5479 // uint32 count;
5480 // struct _iver_t list[count];
5481 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005482 IvarListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005483 llvm::StructType::create("struct._ivar_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005484 llvm::ArrayType::get(IvarnfABITy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005485
Owen Anderson9793f0e2009-07-29 22:16:19 +00005486 IvarListnfABIPtrTy = llvm::PointerType::getUnqual(IvarListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005487
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005488 // struct _class_ro_t {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005489 // uint32_t const flags;
5490 // uint32_t const instanceStart;
5491 // uint32_t const instanceSize;
5492 // uint32_t const reserved; // only when building for 64bit targets
5493 // const uint8_t * const ivarLayout;
5494 // const char *const name;
5495 // const struct _method_list_t * const baseMethods;
5496 // const struct _objc_protocol_list *const baseProtocols;
5497 // const struct _ivar_list_t *const ivars;
5498 // const uint8_t * const weakIvarLayout;
5499 // const struct _prop_list_t * const properties;
5500 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005501
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005502 // FIXME. Add 'reserved' field in 64bit abi mode!
Chris Lattner5ec04a52011-08-12 17:43:31 +00005503 ClassRonfABITy = llvm::StructType::create("struct._class_ro_t",
5504 IntTy, IntTy, IntTy, Int8PtrTy,
5505 Int8PtrTy, MethodListnfABIPtrTy,
5506 ProtocolListnfABIPtrTy,
5507 IvarListnfABIPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005508 Int8PtrTy, PropertyListPtrTy,
5509 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005510
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005511 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +00005512 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall9dc0db22011-05-15 01:53:33 +00005513 ImpnfABITy = llvm::FunctionType::get(ObjectPtrTy, params, false)
5514 ->getPointerTo();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005515
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005516 // struct _class_t {
5517 // struct _class_t *isa;
5518 // struct _class_t * const superclass;
5519 // void *cache;
5520 // IMP *vtable;
5521 // struct class_ro_t *ro;
5522 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005523
Chris Lattner5ec04a52011-08-12 17:43:31 +00005524 ClassnfABITy = llvm::StructType::create(VMContext, "struct._class_t");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005525 ClassnfABITy->setBody(llvm::PointerType::getUnqual(ClassnfABITy),
5526 llvm::PointerType::getUnqual(ClassnfABITy),
5527 CachePtrTy,
5528 llvm::PointerType::getUnqual(ImpnfABITy),
5529 llvm::PointerType::getUnqual(ClassRonfABITy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005530 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005531
Fariborz Jahanian71394042009-01-23 23:53:38 +00005532 // LLVM for struct _class_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005533 ClassnfABIPtrTy = llvm::PointerType::getUnqual(ClassnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005534
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005535 // struct _category_t {
5536 // const char * const name;
5537 // struct _class_t *const cls;
5538 // const struct _method_list_t * const instance_methods;
5539 // const struct _method_list_t * const class_methods;
5540 // const struct _protocol_list_t * const protocols;
5541 // const struct _prop_list_t * const properties;
Fariborz Jahanian5a63e4c2009-01-23 17:41:22 +00005542 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005543 CategorynfABITy = llvm::StructType::create("struct._category_t",
5544 Int8PtrTy, ClassnfABIPtrTy,
5545 MethodListnfABIPtrTy,
5546 MethodListnfABIPtrTy,
5547 ProtocolListnfABIPtrTy,
5548 PropertyListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005549 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005550
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005551 // New types for nonfragile abi messaging.
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005552 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5553 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005554
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005555 // MessageRefTy - LLVM for:
5556 // struct _message_ref_t {
5557 // IMP messenger;
5558 // SEL name;
5559 // };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005560
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005561 // First the clang type for struct _message_ref_t
Abramo Bagnara6150c882010-05-11 21:36:43 +00005562 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005563 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005564 SourceLocation(), SourceLocation(),
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005565 &Ctx.Idents.get("_message_ref_t"));
Craig Topper8a13c412014-05-21 05:09:00 +00005566 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5567 nullptr, Ctx.VoidPtrTy, nullptr, nullptr, false,
Richard Smith2b013182012-06-10 03:12:00 +00005568 ICIS_NoInit));
Craig Topper8a13c412014-05-21 05:09:00 +00005569 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5570 nullptr, Ctx.getObjCSelType(), nullptr, nullptr,
5571 false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005572 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005573
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005574 MessageRefCTy = Ctx.getTagDeclType(RD);
5575 MessageRefCPtrTy = Ctx.getPointerType(MessageRefCTy);
5576 MessageRefTy = cast<llvm::StructType>(Types.ConvertType(MessageRefCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005577
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005578 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005579 MessageRefPtrTy = llvm::PointerType::getUnqual(MessageRefTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005580
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005581 // SuperMessageRefTy - LLVM for:
5582 // struct _super_message_ref_t {
5583 // SUPER_IMP messenger;
5584 // SEL name;
5585 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005586 SuperMessageRefTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005587 llvm::StructType::create("struct._super_message_ref_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005588 ImpnfABITy, SelectorPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005589
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005590 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005591 SuperMessageRefPtrTy = llvm::PointerType::getUnqual(SuperMessageRefTy);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00005592
Daniel Dunbarb1559a42009-03-01 04:46:24 +00005593
5594 // struct objc_typeinfo {
5595 // const void** vtable; // objc_ehtype_vtable + 2
5596 // const char* name; // c++ typeinfo string
5597 // Class cls;
5598 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005599 EHTypeTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005600 llvm::StructType::create("struct._objc_typeinfo",
5601 llvm::PointerType::getUnqual(Int8PtrTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005602 Int8PtrTy, ClassnfABIPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005603 EHTypePtrTy = llvm::PointerType::getUnqual(EHTypeTy);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005604}
5605
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005606llvm::Function *CGObjCNonFragileABIMac::ModuleInitFunction() {
Fariborz Jahanian71394042009-01-23 23:53:38 +00005607 FinishNonFragileABIModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005608
Craig Topper8a13c412014-05-21 05:09:00 +00005609 return nullptr;
Fariborz Jahanian71394042009-01-23 23:53:38 +00005610}
5611
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00005612void CGObjCNonFragileABIMac::
5613AddModuleClassList(ArrayRef<llvm::GlobalValue*> Container,
5614 const char *SymbolName,
5615 const char *SectionName) {
Daniel Dunbar19573e72009-05-15 21:48:48 +00005616 unsigned NumClasses = Container.size();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005617
Daniel Dunbar19573e72009-05-15 21:48:48 +00005618 if (!NumClasses)
5619 return;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005620
Chris Lattner3def9ae2012-02-06 22:16:34 +00005621 SmallVector<llvm::Constant*, 8> Symbols(NumClasses);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005622 for (unsigned i=0; i<NumClasses; i++)
Owen Andersonade90fd2009-07-29 18:54:39 +00005623 Symbols[i] = llvm::ConstantExpr::getBitCast(Container[i],
Daniel Dunbar19573e72009-05-15 21:48:48 +00005624 ObjCTypes.Int8PtrTy);
Chris Lattner3def9ae2012-02-06 22:16:34 +00005625 llvm::Constant *Init =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005626 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00005627 Symbols.size()),
Daniel Dunbar19573e72009-05-15 21:48:48 +00005628 Symbols);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005629
Daniel Dunbar19573e72009-05-15 21:48:48 +00005630 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00005631 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005632 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar19573e72009-05-15 21:48:48 +00005633 Init,
Owen Andersonc10c8d32009-07-08 19:05:04 +00005634 SymbolName);
Micah Villmowdd31ca12012-10-08 16:25:52 +00005635 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Daniel Dunbar19573e72009-05-15 21:48:48 +00005636 GV->setSection(SectionName);
Rafael Espindola060062a2014-03-06 22:15:10 +00005637 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005638}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005639
Fariborz Jahanian71394042009-01-23 23:53:38 +00005640void CGObjCNonFragileABIMac::FinishNonFragileABIModule() {
5641 // nonfragile abi has no module definition.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005642
Daniel Dunbar19573e72009-05-15 21:48:48 +00005643 // Build list of all implemented class addresses in array
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005644 // L_OBJC_LABEL_CLASS_$.
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005645
5646 for (unsigned i=0, NumClasses=ImplementedClasses.size(); i<NumClasses; i++) {
5647 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
5648 assert(ID);
5649 if (ObjCImplementationDecl *IMP = ID->getImplementation())
5650 // We are implementing a weak imported interface. Give it external linkage
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005651 if (ID->isWeakImported() && !IMP->isWeakImported()) {
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005652 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005653 DefinedMetaClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
5654 }
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005655 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005656
5657 AddModuleClassList(DefinedClasses, "OBJC_LABEL_CLASS_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005658 "__DATA, __objc_classlist, regular, no_dead_strip");
Rafael Espindola554256c2014-02-26 22:25:45 +00005659
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005660 AddModuleClassList(DefinedNonLazyClasses, "OBJC_LABEL_NONLAZY_CLASS_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005661 "__DATA, __objc_nlclslist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005662
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005663 // Build list of all implemented category addresses in array
5664 // L_OBJC_LABEL_CATEGORY_$.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005665 AddModuleClassList(DefinedCategories, "OBJC_LABEL_CATEGORY_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005666 "__DATA, __objc_catlist, regular, no_dead_strip");
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005667 AddModuleClassList(DefinedNonLazyCategories, "OBJC_LABEL_NONLAZY_CATEGORY_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005668 "__DATA, __objc_nlcatlist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005669
Daniel Dunbar5e639272010-04-25 20:39:01 +00005670 EmitImageInfo();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005671}
5672
John McCall9e8bb002011-05-14 03:10:52 +00005673/// isVTableDispatchedSelector - Returns true if SEL is not in the list of
5674/// VTableDispatchMethods; false otherwise. What this means is that
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005675/// except for the 19 selectors in the list, we generate 32bit-style
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005676/// message dispatch call for all the rest.
John McCall9e8bb002011-05-14 03:10:52 +00005677bool CGObjCNonFragileABIMac::isVTableDispatchedSelector(Selector Sel) {
5678 // At various points we've experimented with using vtable-based
5679 // dispatch for all methods.
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005680 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005681 case CodeGenOptions::Legacy:
Fariborz Jahaniandfb39832010-04-19 17:53:30 +00005682 return false;
John McCall9e8bb002011-05-14 03:10:52 +00005683 case CodeGenOptions::NonLegacy:
5684 return true;
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005685 case CodeGenOptions::Mixed:
5686 break;
5687 }
5688
5689 // If so, see whether this selector is in the white-list of things which must
5690 // use the new dispatch convention. We lazily build a dense set for this.
John McCall9e8bb002011-05-14 03:10:52 +00005691 if (VTableDispatchMethods.empty()) {
5692 VTableDispatchMethods.insert(GetNullarySelector("alloc"));
5693 VTableDispatchMethods.insert(GetNullarySelector("class"));
5694 VTableDispatchMethods.insert(GetNullarySelector("self"));
5695 VTableDispatchMethods.insert(GetNullarySelector("isFlipped"));
5696 VTableDispatchMethods.insert(GetNullarySelector("length"));
5697 VTableDispatchMethods.insert(GetNullarySelector("count"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005698
John McCall9e8bb002011-05-14 03:10:52 +00005699 // These are vtable-based if GC is disabled.
5700 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00005701 if (CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
John McCall9e8bb002011-05-14 03:10:52 +00005702 VTableDispatchMethods.insert(GetNullarySelector("retain"));
5703 VTableDispatchMethods.insert(GetNullarySelector("release"));
5704 VTableDispatchMethods.insert(GetNullarySelector("autorelease"));
5705 }
5706
5707 VTableDispatchMethods.insert(GetUnarySelector("allocWithZone"));
5708 VTableDispatchMethods.insert(GetUnarySelector("isKindOfClass"));
5709 VTableDispatchMethods.insert(GetUnarySelector("respondsToSelector"));
5710 VTableDispatchMethods.insert(GetUnarySelector("objectForKey"));
5711 VTableDispatchMethods.insert(GetUnarySelector("objectAtIndex"));
5712 VTableDispatchMethods.insert(GetUnarySelector("isEqualToString"));
5713 VTableDispatchMethods.insert(GetUnarySelector("isEqual"));
5714
5715 // These are vtable-based if GC is enabled.
5716 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00005717 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
John McCall9e8bb002011-05-14 03:10:52 +00005718 VTableDispatchMethods.insert(GetNullarySelector("hash"));
5719 VTableDispatchMethods.insert(GetUnarySelector("addObject"));
5720
5721 // "countByEnumeratingWithState:objects:count"
5722 IdentifierInfo *KeyIdents[] = {
5723 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
5724 &CGM.getContext().Idents.get("objects"),
5725 &CGM.getContext().Idents.get("count")
5726 };
5727 VTableDispatchMethods.insert(
5728 CGM.getContext().Selectors.getSelector(3, KeyIdents));
5729 }
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005730 }
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005731
John McCall9e8bb002011-05-14 03:10:52 +00005732 return VTableDispatchMethods.count(Sel);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005733}
5734
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005735/// BuildClassRoTInitializer - generate meta-data for:
5736/// struct _class_ro_t {
5737/// uint32_t const flags;
5738/// uint32_t const instanceStart;
5739/// uint32_t const instanceSize;
5740/// uint32_t const reserved; // only when building for 64bit targets
5741/// const uint8_t * const ivarLayout;
5742/// const char *const name;
5743/// const struct _method_list_t * const baseMethods;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005744/// const struct _protocol_list_t *const baseProtocols;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005745/// const struct _ivar_list_t *const ivars;
5746/// const uint8_t * const weakIvarLayout;
5747/// const struct _prop_list_t * const properties;
5748/// }
5749///
5750llvm::GlobalVariable * CGObjCNonFragileABIMac::BuildClassRoTInitializer(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005751 unsigned flags,
5752 unsigned InstanceStart,
5753 unsigned InstanceSize,
5754 const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005755 std::string ClassName = ID->getObjCRuntimeNameAsString();
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005756 llvm::Constant *Values[10]; // 11 for 64bit targets!
John McCall31168b02011-06-15 23:02:42 +00005757
John McCall3fd13f062015-10-21 18:06:47 +00005758 CharUnits beginInstance = CharUnits::fromQuantity(InstanceStart);
5759 CharUnits endInstance = CharUnits::fromQuantity(InstanceSize);
5760
John McCall460ce582015-10-22 18:38:17 +00005761 bool hasMRCWeak = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00005762 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallef19dbb2012-10-17 04:53:23 +00005763 flags |= NonFragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00005764 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
5765 flags |= NonFragileABI_Class_HasMRCWeakIvars;
John McCall31168b02011-06-15 23:02:42 +00005766
Owen Andersonb7a2fe62009-07-24 23:12:58 +00005767 Values[ 0] = llvm::ConstantInt::get(ObjCTypes.IntTy, flags);
5768 Values[ 1] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceStart);
5769 Values[ 2] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceSize);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005770 // FIXME. For 64bit targets add 0 here.
John McCallef19dbb2012-10-17 04:53:23 +00005771 Values[ 3] = (flags & NonFragileABI_Class_Meta)
Craig Topper8a13c412014-05-21 05:09:00 +00005772 ? GetIvarLayoutName(nullptr, ObjCTypes)
John McCall460ce582015-10-22 18:38:17 +00005773 : BuildStrongIvarLayout(ID, beginInstance, endInstance);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005774 Values[ 4] = GetClassName(ID->getObjCRuntimeNameAsString());
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005775 // const struct _method_list_t * const baseMethods;
5776 std::vector<llvm::Constant*> Methods;
5777 std::string MethodListName("\01l_OBJC_$_");
John McCallef19dbb2012-10-17 04:53:23 +00005778 if (flags & NonFragileABI_Class_Meta) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005779 MethodListName += "CLASS_METHODS_";
5780 MethodListName += ID->getObjCRuntimeNameAsString();
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00005781 for (const auto *I : ID->class_methods())
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005782 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00005783 Methods.push_back(GetMethodConstant(I));
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005784 } else {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005785 MethodListName += "INSTANCE_METHODS_";
5786 MethodListName += ID->getObjCRuntimeNameAsString();
Aaron Ballmanf26acce2014-03-13 19:50:17 +00005787 for (const auto *I : ID->instance_methods())
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005788 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00005789 Methods.push_back(GetMethodConstant(I));
5790
Aaron Ballmand85eff42014-03-14 15:02:45 +00005791 for (const auto *PID : ID->property_impls()) {
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00005792 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize){
5793 ObjCPropertyDecl *PD = PID->getPropertyDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005794
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00005795 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
5796 if (llvm::Constant *C = GetMethodConstant(MD))
5797 Methods.push_back(C);
5798 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
5799 if (llvm::Constant *C = GetMethodConstant(MD))
5800 Methods.push_back(C);
5801 }
5802 }
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005803 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005804 Values[ 5] = EmitMethodList(MethodListName,
5805 "__DATA, __objc_const", Methods);
5806
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005807 const ObjCInterfaceDecl *OID = ID->getClassInterface();
5808 assert(OID && "CGObjCNonFragileABIMac::BuildClassRoTInitializer");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005809 Values[ 6] = EmitProtocolList("\01l_OBJC_CLASS_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005810 + OID->getObjCRuntimeNameAsString(),
Ted Kremenek0ef508d2010-09-01 01:21:15 +00005811 OID->all_referenced_protocol_begin(),
5812 OID->all_referenced_protocol_end());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005813
John McCallef19dbb2012-10-17 04:53:23 +00005814 if (flags & NonFragileABI_Class_Meta) {
Owen Anderson0b75f232009-07-31 20:28:54 +00005815 Values[ 7] = llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +00005816 Values[ 8] = GetIvarLayoutName(nullptr, ObjCTypes);
Owen Anderson0b75f232009-07-31 20:28:54 +00005817 Values[ 9] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
John McCallef19dbb2012-10-17 04:53:23 +00005818 } else {
5819 Values[ 7] = EmitIvarList(ID);
John McCall460ce582015-10-22 18:38:17 +00005820 Values[ 8] = BuildWeakIvarLayout(ID, beginInstance, endInstance,
5821 hasMRCWeak);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005822 Values[ 9] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00005823 ID, ID->getClassInterface(), ObjCTypes);
John McCallef19dbb2012-10-17 04:53:23 +00005824 }
Owen Anderson0e0189d2009-07-27 22:29:56 +00005825 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassRonfABITy,
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005826 Values);
5827 llvm::GlobalVariable *CLASS_RO_GV =
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005828 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassRonfABITy, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005829 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005830 Init,
John McCallef19dbb2012-10-17 04:53:23 +00005831 (flags & NonFragileABI_Class_Meta) ?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005832 std::string("\01l_OBJC_METACLASS_RO_$_")+ClassName :
5833 std::string("\01l_OBJC_CLASS_RO_$_")+ClassName);
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00005834 CLASS_RO_GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00005835 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassRonfABITy));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00005836 CLASS_RO_GV->setSection("__DATA, __objc_const");
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005837 return CLASS_RO_GV;
Fariborz Jahanian2612e142009-01-26 22:58:07 +00005838
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005839}
5840
5841/// BuildClassMetaData - This routine defines that to-level meta-data
5842/// for the given ClassName for:
5843/// struct _class_t {
5844/// struct _class_t *isa;
5845/// struct _class_t * const superclass;
5846/// void *cache;
5847/// IMP *vtable;
5848/// struct class_ro_t *ro;
5849/// }
5850///
Rafael Espindola554256c2014-02-26 22:25:45 +00005851llvm::GlobalVariable *CGObjCNonFragileABIMac::BuildClassMetaData(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005852 const std::string &ClassName, llvm::Constant *IsAGV, llvm::Constant *SuperClassGV,
Rafael Espindola554256c2014-02-26 22:25:45 +00005853 llvm::Constant *ClassRoGV, bool HiddenVisibility, bool Weak) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005854 llvm::Constant *Values[] = {
5855 IsAGV,
5856 SuperClassGV,
5857 ObjCEmptyCacheVar, // &ObjCEmptyCacheVar
5858 ObjCEmptyVtableVar, // &ObjCEmptyVtableVar
5859 ClassRoGV // &CLASS_RO_GV
5860 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005861 if (!Values[1])
5862 Values[1] = llvm::Constant::getNullValue(ObjCTypes.ClassnfABIPtrTy);
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005863 if (!Values[3])
5864 Values[3] = llvm::Constant::getNullValue(
5865 llvm::PointerType::getUnqual(ObjCTypes.ImpnfABITy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005866 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassnfABITy,
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005867 Values);
Rafael Espindola554256c2014-02-26 22:25:45 +00005868 llvm::GlobalVariable *GV = GetClassGlobal(ClassName, Weak);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00005869 GV->setInitializer(Init);
Fariborz Jahanian04087232009-01-31 01:07:39 +00005870 GV->setSection("__DATA, __objc_data");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00005871 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00005872 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassnfABITy));
Fariborz Jahanian82208252009-01-31 00:59:10 +00005873 if (HiddenVisibility)
5874 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005875 return GV;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005876}
5877
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005878bool
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00005879CGObjCNonFragileABIMac::ImplementationIsNonLazy(const ObjCImplDecl *OD) const {
Craig Topper8a13c412014-05-21 05:09:00 +00005880 return OD->getClassMethod(GetNullarySelector("load")) != nullptr;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005881}
5882
Daniel Dunbar961202372009-05-03 12:57:56 +00005883void CGObjCNonFragileABIMac::GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00005884 uint32_t &InstanceStart,
5885 uint32_t &InstanceSize) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005886 const ASTRecordLayout &RL =
Daniel Dunbar9252ee12009-05-04 21:26:30 +00005887 CGM.getContext().getASTObjCImplementationLayout(OID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005888
Daniel Dunbar9b042e02009-05-04 23:23:09 +00005889 // InstanceSize is really instance end.
Ken Dyckd5090c12011-02-11 02:20:09 +00005890 InstanceSize = RL.getDataSize().getQuantity();
Daniel Dunbar9b042e02009-05-04 23:23:09 +00005891
5892 // If there are no fields, the start is the same as the end.
5893 if (!RL.getFieldCount())
5894 InstanceStart = InstanceSize;
5895 else
Ken Dyckc5ca8762011-04-14 00:43:09 +00005896 InstanceStart = RL.getFieldOffset(0) / CGM.getContext().getCharWidth();
Daniel Dunbar554fd792009-04-19 23:41:48 +00005897}
5898
Fariborz Jahanian71394042009-01-23 23:53:38 +00005899void CGObjCNonFragileABIMac::GenerateClass(const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005900 std::string ClassName = ID->getObjCRuntimeNameAsString();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005901 if (!ObjCEmptyCacheVar) {
5902 ObjCEmptyCacheVar = new llvm::GlobalVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005903 CGM.getModule(),
5904 ObjCTypes.CacheTy,
5905 false,
5906 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00005907 nullptr,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005908 "_objc_empty_cache");
Craig Topper8a13c412014-05-21 05:09:00 +00005909
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005910 // Make this entry NULL for any iOS device target, any iOS simulator target,
5911 // OS X with deployment target 10.9 or later.
5912 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Tim Northover756447a2015-10-30 16:30:36 +00005913 if (Triple.isiOS() || Triple.isWatchOS() ||
5914 (Triple.isMacOSX() && !Triple.isMacOSXVersionLT(10, 9)))
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005915 // This entry will be null.
Craig Topper8a13c412014-05-21 05:09:00 +00005916 ObjCEmptyVtableVar = nullptr;
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005917 else
5918 ObjCEmptyVtableVar = new llvm::GlobalVariable(
5919 CGM.getModule(),
5920 ObjCTypes.ImpnfABITy,
5921 false,
5922 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00005923 nullptr,
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005924 "_objc_empty_vtable");
Fariborz Jahanian71394042009-01-23 23:53:38 +00005925 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005926 assert(ID->getClassInterface() &&
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005927 "CGObjCNonFragileABIMac::GenerateClass - class is 0");
Daniel Dunbare3f5cfc2009-04-20 20:18:54 +00005928 // FIXME: Is this correct (that meta class size is never computed)?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005929 uint32_t InstanceStart =
Micah Villmowdd31ca12012-10-08 16:25:52 +00005930 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassnfABITy);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005931 uint32_t InstanceSize = InstanceStart;
John McCallef19dbb2012-10-17 04:53:23 +00005932 uint32_t flags = NonFragileABI_Class_Meta;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005933 llvm::SmallString<64> ObjCMetaClassName(getMetaclassSymbolPrefix());
5934 llvm::SmallString<64> ObjCClassName(getClassSymbolPrefix());
5935 llvm::SmallString<64> TClassName;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005936
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005937 llvm::GlobalVariable *SuperClassGV, *IsAGV;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005938
John McCall0d54a172012-10-17 04:53:31 +00005939 // Build the flags for the metaclass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005940 bool classIsHidden =
John McCall457a04e2010-10-22 21:05:15 +00005941 ID->getClassInterface()->getVisibility() == HiddenVisibility;
Fariborz Jahanian82208252009-01-31 00:59:10 +00005942 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00005943 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00005944
5945 // FIXME: why is this flag set on the metaclass?
5946 // ObjC metaclasses have no fields and don't really get constructed.
5947 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00005948 flags |= NonFragileABI_Class_HasCXXStructors;
John McCall0d54a172012-10-17 04:53:31 +00005949 if (!ID->hasNonZeroConstructors())
5950 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
5951 }
5952
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005953 if (!ID->getClassInterface()->getSuperClass()) {
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005954 // class is root
John McCallef19dbb2012-10-17 04:53:23 +00005955 flags |= NonFragileABI_Class_Root;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005956 TClassName = ObjCClassName;
5957 TClassName += ClassName;
5958 SuperClassGV = GetClassGlobal(TClassName.str(),
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005959 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005960 TClassName = ObjCMetaClassName;
5961 TClassName += ClassName;
5962 IsAGV = GetClassGlobal(TClassName.str(),
Rafael Espindola554256c2014-02-26 22:25:45 +00005963 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005964 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005965 // Has a root. Current class is not a root.
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00005966 const ObjCInterfaceDecl *Root = ID->getClassInterface();
5967 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
5968 Root = Super;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005969 TClassName = ObjCMetaClassName ;
5970 TClassName += Root->getObjCRuntimeNameAsString();
5971 IsAGV = GetClassGlobal(TClassName.str(),
Rafael Espindola554256c2014-02-26 22:25:45 +00005972 Root->isWeakImported());
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005973
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00005974 // work on super class metadata symbol.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005975 TClassName = ObjCMetaClassName;
5976 TClassName += ID->getClassInterface()->getSuperClass()->getObjCRuntimeNameAsString();
Rafael Espindola554256c2014-02-26 22:25:45 +00005977 SuperClassGV = GetClassGlobal(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005978 TClassName.str(),
5979 ID->getClassInterface()->getSuperClass()->isWeakImported());
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005980 }
5981 llvm::GlobalVariable *CLASS_RO_GV = BuildClassRoTInitializer(flags,
5982 InstanceStart,
5983 InstanceSize,ID);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005984 TClassName = ObjCMetaClassName;
5985 TClassName += ClassName;
Rafael Espindola554256c2014-02-26 22:25:45 +00005986 llvm::GlobalVariable *MetaTClass = BuildClassMetaData(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005987 TClassName.str(), IsAGV, SuperClassGV, CLASS_RO_GV, classIsHidden,
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005988 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian67260552009-11-17 21:37:35 +00005989 DefinedMetaClasses.push_back(MetaTClass);
Daniel Dunbar15894b72009-04-07 05:48:37 +00005990
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005991 // Metadata for the class
John McCallef19dbb2012-10-17 04:53:23 +00005992 flags = 0;
Fariborz Jahanian82208252009-01-31 00:59:10 +00005993 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00005994 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00005995
5996 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00005997 flags |= NonFragileABI_Class_HasCXXStructors;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00005998
John McCall0d54a172012-10-17 04:53:31 +00005999 // Set a flag to enable a runtime optimization when a class has
6000 // fields that require destruction but which don't require
6001 // anything except zero-initialization during construction. This
6002 // is most notably true of __strong and __weak types, but you can
6003 // also imagine there being C++ types with non-trivial default
6004 // constructors that merely set all fields to null.
6005 if (!ID->hasNonZeroConstructors())
6006 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
6007 }
6008
Douglas Gregor78bd61f2009-06-18 16:11:24 +00006009 if (hasObjCExceptionAttribute(CGM.getContext(), ID->getClassInterface()))
John McCallef19dbb2012-10-17 04:53:23 +00006010 flags |= NonFragileABI_Class_Exception;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006011
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006012 if (!ID->getClassInterface()->getSuperClass()) {
John McCallef19dbb2012-10-17 04:53:23 +00006013 flags |= NonFragileABI_Class_Root;
Craig Topper8a13c412014-05-21 05:09:00 +00006014 SuperClassGV = nullptr;
Chris Lattnerb433b272009-04-19 06:02:28 +00006015 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006016 // Has a root. Current class is not a root.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006017 TClassName = ObjCClassName;
6018 TClassName += ID->getClassInterface()->getSuperClass()->getObjCRuntimeNameAsString();
Rafael Espindola554256c2014-02-26 22:25:45 +00006019 SuperClassGV = GetClassGlobal(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006020 TClassName.str(),
6021 ID->getClassInterface()->getSuperClass()->isWeakImported());
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006022 }
Daniel Dunbar961202372009-05-03 12:57:56 +00006023 GetClassSizeInfo(ID, InstanceStart, InstanceSize);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006024 CLASS_RO_GV = BuildClassRoTInitializer(flags,
Fariborz Jahaniana887e632009-01-24 23:43:01 +00006025 InstanceStart,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006026 InstanceSize,
Fariborz Jahaniana887e632009-01-24 23:43:01 +00006027 ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006028
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006029 TClassName = ObjCClassName;
6030 TClassName += ClassName;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006031 llvm::GlobalVariable *ClassMD =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006032 BuildClassMetaData(TClassName.str(), MetaTClass, SuperClassGV, CLASS_RO_GV,
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006033 classIsHidden,
6034 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian279abd32009-01-30 20:55:31 +00006035 DefinedClasses.push_back(ClassMD);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006036 ImplementedClasses.push_back(ID->getClassInterface());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006037
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006038 // Determine if this class is also "non-lazy".
6039 if (ImplementationIsNonLazy(ID))
6040 DefinedNonLazyClasses.push_back(ClassMD);
6041
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006042 // Force the definition of the EHType if necessary.
John McCallef19dbb2012-10-17 04:53:23 +00006043 if (flags & NonFragileABI_Class_Exception)
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006044 GetInterfaceEHType(ID->getClassInterface(), true);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006045 // Make sure method definition entries are all clear for next implementation.
6046 MethodDefinitions.clear();
Fariborz Jahanian71394042009-01-23 23:53:38 +00006047}
6048
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006049/// GenerateProtocolRef - This routine is called to generate code for
6050/// a protocol reference expression; as in:
6051/// @code
6052/// @protocol(Proto1);
6053/// @endcode
6054/// It generates a weak reference to l_OBJC_PROTOCOL_REFERENCE_$_Proto1
6055/// which will hold address of the protocol meta-data.
6056///
John McCall882987f2013-02-28 19:01:20 +00006057llvm::Value *CGObjCNonFragileABIMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006058 const ObjCProtocolDecl *PD) {
6059
Fariborz Jahanian464423d2009-04-10 18:47:34 +00006060 // This routine is called for @protocol only. So, we must build definition
6061 // of protocol's meta-data (not a reference to it!)
6062 //
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006063 llvm::Constant *Init =
6064 llvm::ConstantExpr::getBitCast(GetOrEmitProtocol(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00006065 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006066
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006067 std::string ProtocolName("\01l_OBJC_PROTOCOL_REFERENCE_$_");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006068 ProtocolName += PD->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006069
John McCall7f416cc2015-09-08 08:05:57 +00006070 CharUnits Align = CGF.getPointerAlign();
6071
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006072 llvm::GlobalVariable *PTGV = CGM.getModule().getGlobalVariable(ProtocolName);
6073 if (PTGV)
John McCall7f416cc2015-09-08 08:05:57 +00006074 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006075 PTGV = new llvm::GlobalVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006076 CGM.getModule(),
6077 Init->getType(), false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006078 llvm::GlobalValue::WeakAnyLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006079 Init,
6080 ProtocolName);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006081 PTGV->setSection("__DATA, __objc_protorefs, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006082 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall7f416cc2015-09-08 08:05:57 +00006083 PTGV->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00006084 CGM.addCompilerUsedGlobal(PTGV);
John McCall7f416cc2015-09-08 08:05:57 +00006085 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006086}
6087
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006088/// GenerateCategory - Build metadata for a category implementation.
6089/// struct _category_t {
6090/// const char * const name;
6091/// struct _class_t *const cls;
6092/// const struct _method_list_t * const instance_methods;
6093/// const struct _method_list_t * const class_methods;
6094/// const struct _protocol_list_t * const protocols;
6095/// const struct _prop_list_t * const properties;
6096/// }
6097///
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006098void CGObjCNonFragileABIMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006099 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006100 const char *Prefix = "\01l_OBJC_$_CATEGORY_";
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006101
6102 llvm::SmallString<64> ExtCatName(Prefix);
6103 ExtCatName += Interface->getObjCRuntimeNameAsString();
6104 ExtCatName += "_$_";
6105 ExtCatName += OCD->getNameAsString();
6106
6107 llvm::SmallString<64> ExtClassName(getClassSymbolPrefix());
6108 ExtClassName += Interface->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006109
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006110 llvm::Constant *Values[6];
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006111 Values[0] = GetClassName(OCD->getIdentifier()->getName());
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006112 // meta-class entry symbol
Rafael Espindola554256c2014-02-26 22:25:45 +00006113 llvm::GlobalVariable *ClassGV =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006114 GetClassGlobal(ExtClassName.str(), Interface->isWeakImported());
Rafael Espindola554256c2014-02-26 22:25:45 +00006115
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006116 Values[1] = ClassGV;
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006117 std::vector<llvm::Constant*> Methods;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006118 llvm::SmallString<64> MethodListName(Prefix);
6119
6120 MethodListName += "INSTANCE_METHODS_";
6121 MethodListName += Interface->getObjCRuntimeNameAsString();
6122 MethodListName += "_$_";
6123 MethodListName += OCD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006124
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006125 for (const auto *I : OCD->instance_methods())
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006126 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006127 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006128
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006129 Values[2] = EmitMethodList(MethodListName.str(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006130 "__DATA, __objc_const",
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006131 Methods);
6132
6133 MethodListName = Prefix;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006134 MethodListName += "CLASS_METHODS_";
6135 MethodListName += Interface->getObjCRuntimeNameAsString();
6136 MethodListName += "_$_";
6137 MethodListName += OCD->getNameAsString();
6138
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006139 Methods.clear();
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006140 for (const auto *I : OCD->class_methods())
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006141 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006142 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006143
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006144 Values[3] = EmitMethodList(MethodListName.str(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006145 "__DATA, __objc_const",
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006146 Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006147 const ObjCCategoryDecl *Category =
Fariborz Jahanian066347e2009-01-28 22:18:42 +00006148 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006149 if (Category) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006150 SmallString<256> ExtName;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006151 llvm::raw_svector_ostream(ExtName) << Interface->getObjCRuntimeNameAsString() << "_$_"
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006152 << OCD->getName();
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006153 Values[4] = EmitProtocolList("\01l_OBJC_CATEGORY_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006154 + Interface->getObjCRuntimeNameAsString() + "_$_"
6155 + Category->getName(),
6156 Category->protocol_begin(),
6157 Category->protocol_end());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006158 Values[5] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
6159 OCD, Category, ObjCTypes);
Mike Stump658fe022009-07-30 22:28:39 +00006160 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00006161 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
6162 Values[5] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006163 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006164
6165 llvm::Constant *Init =
6166 llvm::ConstantStruct::get(ObjCTypes.CategorynfABITy,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006167 Values);
6168 llvm::GlobalVariable *GCATV
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006169 = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.CategorynfABITy,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006170 false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006171 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006172 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006173 ExtCatName.str());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006174 GCATV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006175 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.CategorynfABITy));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006176 GCATV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006177 CGM.addCompilerUsedGlobal(GCATV);
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006178 DefinedCategories.push_back(GCATV);
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006179
6180 // Determine if this category is also "non-lazy".
6181 if (ImplementationIsNonLazy(OCD))
6182 DefinedNonLazyCategories.push_back(GCATV);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006183 // method definition entries must be clear for next implementation.
6184 MethodDefinitions.clear();
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006185}
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006186
6187/// GetMethodConstant - Return a struct objc_method constant for the
6188/// given method if it has been defined. The result is null if the
6189/// method has not been defined. The return value has type MethodPtrTy.
6190llvm::Constant *CGObjCNonFragileABIMac::GetMethodConstant(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006191 const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00006192 llvm::Function *Fn = GetMethodDefinition(MD);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006193 if (!Fn)
Craig Topper8a13c412014-05-21 05:09:00 +00006194 return nullptr;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006195
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006196 llvm::Constant *Method[] = {
Owen Andersonade90fd2009-07-29 18:54:39 +00006197 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006198 ObjCTypes.SelectorPtrTy),
6199 GetMethodVarType(MD),
6200 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
6201 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00006202 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006203}
6204
6205/// EmitMethodList - Build meta-data for method declarations
6206/// struct _method_list_t {
6207/// uint32_t entsize; // sizeof(struct _objc_method)
6208/// uint32_t method_count;
6209/// struct _objc_method method_list[method_count];
6210/// }
6211///
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00006212llvm::Constant *
6213CGObjCNonFragileABIMac::EmitMethodList(Twine Name,
6214 const char *Section,
6215 ArrayRef<llvm::Constant*> Methods) {
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006216 // Return null for empty list.
6217 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006218 return llvm::Constant::getNullValue(ObjCTypes.MethodListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006219
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006220 llvm::Constant *Values[3];
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006221 // sizeof(struct _objc_method)
Micah Villmowdd31ca12012-10-08 16:25:52 +00006222 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.MethodTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006223 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006224 // method_count
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006225 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00006226 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006227 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00006228 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006229 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006230
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006231 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006232 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006233 llvm::GlobalValue::PrivateLinkage, Init, Name);
Micah Villmowdd31ca12012-10-08 16:25:52 +00006234 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006235 GV->setSection(Section);
Rafael Espindola060062a2014-03-06 22:15:10 +00006236 CGM.addCompilerUsedGlobal(GV);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006237 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListnfABIPtrTy);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006238}
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006239
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006240/// ObjCIvarOffsetVariable - Returns the ivar offset variable for
6241/// the given ivar.
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006242llvm::GlobalVariable *
6243CGObjCNonFragileABIMac::ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
6244 const ObjCIvarDecl *Ivar) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006245
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006246 const ObjCInterfaceDecl *Container = Ivar->getContainingInterface();
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006247 llvm::SmallString<64> Name("OBJC_IVAR_$_");
6248 Name += Container->getObjCRuntimeNameAsString();
6249 Name += ".";
6250 Name += Ivar->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006251 llvm::GlobalVariable *IvarOffsetGV =
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006252 CGM.getModule().getGlobalVariable(Name);
6253 if (!IvarOffsetGV)
Tim Northover238b5082014-03-29 13:42:40 +00006254 IvarOffsetGV = new llvm::GlobalVariable(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006255 CGM.getModule(), ObjCTypes.IvarOffsetVarTy, false,
6256 llvm::GlobalValue::ExternalLinkage, nullptr, Name.str());
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006257 return IvarOffsetGV;
6258}
6259
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006260llvm::Constant *
6261CGObjCNonFragileABIMac::EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
6262 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00006263 unsigned long int Offset) {
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006264 llvm::GlobalVariable *IvarOffsetGV = ObjCIvarOffsetVariable(ID, Ivar);
Tim Northover238b5082014-03-29 13:42:40 +00006265 IvarOffsetGV->setInitializer(
6266 llvm::ConstantInt::get(ObjCTypes.IvarOffsetVarTy, Offset));
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006267 IvarOffsetGV->setAlignment(
Tim Northover238b5082014-03-29 13:42:40 +00006268 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.IvarOffsetVarTy));
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006269
Mike Stump18bb9282009-05-16 07:57:57 +00006270 // FIXME: This matches gcc, but shouldn't the visibility be set on the use as
6271 // well (i.e., in ObjCIvarOffsetVariable).
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006272 if (Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6273 Ivar->getAccessControl() == ObjCIvarDecl::Package ||
John McCall457a04e2010-10-22 21:05:15 +00006274 ID->getVisibility() == HiddenVisibility)
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00006275 IvarOffsetGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Daniel Dunbarf5f359f2009-04-14 06:00:08 +00006276 else
Fariborz Jahanianbc3c77b2009-04-06 18:30:00 +00006277 IvarOffsetGV->setVisibility(llvm::GlobalValue::DefaultVisibility);
Bill Wendlingf7d45982011-05-04 21:37:25 +00006278 IvarOffsetGV->setSection("__DATA, __objc_ivar");
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006279 return IvarOffsetGV;
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006280}
6281
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006282/// EmitIvarList - Emit the ivar list for the given
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006283/// implementation. The return value has type
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006284/// IvarListnfABIPtrTy.
6285/// struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00006286/// unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006287/// char *name;
6288/// char *type;
6289/// uint32_t alignment;
6290/// uint32_t size;
6291/// }
6292/// struct _ivar_list_t {
6293/// uint32 entsize; // sizeof(struct _ivar_t)
6294/// uint32 count;
6295/// struct _iver_t list[count];
6296/// }
6297///
Daniel Dunbarf5c18462009-04-20 06:54:31 +00006298
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006299llvm::Constant *CGObjCNonFragileABIMac::EmitIvarList(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006300 const ObjCImplementationDecl *ID) {
6301
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006302 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006303
Jordy Rosea91768e2011-07-22 02:08:32 +00006304 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006305 assert(OID && "CGObjCNonFragileABIMac::EmitIvarList - null interface");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006306
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006307 // FIXME. Consolidate this with similar code in GenerateClass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006308
Jordy Rosea91768e2011-07-22 02:08:32 +00006309 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00006310 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00006311 // Ignore unnamed bit-fields.
6312 if (!IVD->getDeclName())
6313 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006314 llvm::Constant *Ivar[5];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006315 Ivar[0] = EmitIvarOffsetVar(ID->getClassInterface(), IVD,
Daniel Dunbar961202372009-05-03 12:57:56 +00006316 ComputeIvarBaseOffset(CGM, ID, IVD));
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006317 Ivar[1] = GetMethodVarName(IVD->getIdentifier());
6318 Ivar[2] = GetMethodVarType(IVD);
Chris Lattner2192fe52011-07-18 04:24:23 +00006319 llvm::Type *FieldTy =
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006320 CGM.getTypes().ConvertTypeForMem(IVD->getType());
Micah Villmowdd31ca12012-10-08 16:25:52 +00006321 unsigned Size = CGM.getDataLayout().getTypeAllocSize(FieldTy);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006322 unsigned Align = CGM.getContext().getPreferredTypeAlign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006323 IVD->getType().getTypePtr()) >> 3;
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006324 Align = llvm::Log2_32(Align);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006325 Ivar[3] = llvm::ConstantInt::get(ObjCTypes.IntTy, Align);
Daniel Dunbarae032262009-04-20 00:33:43 +00006326 // NOTE. Size of a bitfield does not match gcc's, because of the
6327 // way bitfields are treated special in each. But I am told that
6328 // 'size' for bitfield ivars is ignored by the runtime so it does
6329 // not matter. If it matters, there is enough info to get the
6330 // bitfield right!
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006331 Ivar[4] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson0e0189d2009-07-27 22:29:56 +00006332 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarnfABITy, Ivar));
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006333 }
6334 // Return null for empty list.
6335 if (Ivars.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006336 return llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006337
6338 llvm::Constant *Values[3];
Micah Villmowdd31ca12012-10-08 16:25:52 +00006339 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.IvarnfABITy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006340 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
6341 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00006342 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarnfABITy,
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006343 Ivars.size());
Owen Anderson47034e12009-07-28 18:33:04 +00006344 Values[2] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006345 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006346 const char *Prefix = "\01l_OBJC_$_INSTANCE_VARIABLES_";
6347 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006348 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006349 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006350 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006351 Prefix + OID->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006352 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006353 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006354 GV->setSection("__DATA, __objc_const");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006355
Rafael Espindola060062a2014-03-06 22:15:10 +00006356 CGM.addCompilerUsedGlobal(GV);
Owen Andersonade90fd2009-07-29 18:54:39 +00006357 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006358}
6359
6360llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocolRef(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006361 const ObjCProtocolDecl *PD) {
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006362 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006363
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006364 if (!Entry) {
6365 // We use the initializer as a marker of whether this is a forward
6366 // reference or not. At module finalization we add the empty
6367 // contents for protocols which were referenced but never defined.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006368 Entry =
Rafael Espindola5d117f32014-03-06 01:10:46 +00006369 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Rafael Espindola24615092014-09-12 20:14:20 +00006370 false, llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00006371 nullptr,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006372 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006373 Entry->setSection("__DATA,__datacoal_nt,coalesced");
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006374 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006375
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006376 return Entry;
6377}
6378
6379/// GetOrEmitProtocol - Generate the protocol meta-data:
6380/// @code
6381/// struct _protocol_t {
6382/// id isa; // NULL
6383/// const char * const protocol_name;
6384/// const struct _protocol_list_t * protocol_list; // super protocols
6385/// const struct method_list_t * const instance_methods;
6386/// const struct method_list_t * const class_methods;
6387/// const struct method_list_t *optionalInstanceMethods;
6388/// const struct method_list_t *optionalClassMethods;
6389/// const struct _prop_list_t * properties;
6390/// const uint32_t size; // sizeof(struct _protocol_t)
6391/// const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006392/// const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006393/// const char *demangledName;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006394/// }
6395/// @endcode
6396///
6397
6398llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocol(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006399 const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00006400 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006401
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006402 // Early exit if a defining object has already been generated.
6403 if (Entry && Entry->hasInitializer())
6404 return Entry;
6405
Douglas Gregora715bff2012-01-01 19:51:50 +00006406 // Use the protocol definition, if there is one.
6407 if (const ObjCProtocolDecl *Def = PD->getDefinition())
6408 PD = Def;
6409
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006410 // Construct method lists.
6411 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
6412 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006413 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006414 for (const auto *MD : PD->instance_methods()) {
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006415 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006416 if (!C)
6417 return GetOrEmitProtocolRef(PD);
6418
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006419 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6420 OptInstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006421 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006422 } else {
6423 InstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006424 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006425 }
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006426 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006427
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006428 for (const auto *MD : PD->class_methods()) {
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006429 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006430 if (!C)
6431 return GetOrEmitProtocolRef(PD);
6432
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006433 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6434 OptClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006435 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006436 } else {
6437 ClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006438 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006439 }
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006440 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006441
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006442 MethodTypesExt.insert(MethodTypesExt.end(),
6443 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
6444
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006445 llvm::Constant *Values[12];
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006446 // isa is NULL
Owen Anderson0b75f232009-07-31 20:28:54 +00006447 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ObjectPtrTy);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006448 Values[1] = GetClassName(PD->getObjCRuntimeNameAsString());
6449 Values[2] = EmitProtocolList("\01l_OBJC_$_PROTOCOL_REFS_" + PD->getObjCRuntimeNameAsString(),
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006450 PD->protocol_begin(),
6451 PD->protocol_end());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006452
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006453 Values[3] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006454 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006455 "__DATA, __objc_const",
6456 InstanceMethods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006457 Values[4] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006458 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006459 "__DATA, __objc_const",
6460 ClassMethods);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006461 Values[5] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_OPT_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006462 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006463 "__DATA, __objc_const",
6464 OptInstanceMethods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006465 Values[6] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_OPT_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006466 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006467 "__DATA, __objc_const",
6468 OptClassMethods);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006469 Values[7] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
Craig Topper8a13c412014-05-21 05:09:00 +00006470 nullptr, PD, ObjCTypes);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006471 uint32_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006472 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolnfABITy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006473 Values[8] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson0b75f232009-07-31 20:28:54 +00006474 Values[9] = llvm::Constant::getNullValue(ObjCTypes.IntTy);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006475 Values[10] = EmitProtocolMethodTypes("\01l_OBJC_$_PROTOCOL_METHOD_TYPES_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006476 + PD->getObjCRuntimeNameAsString(),
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006477 MethodTypesExt, ObjCTypes);
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006478 // const char *demangledName;
6479 Values[11] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
6480
Owen Anderson0e0189d2009-07-27 22:29:56 +00006481 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolnfABITy,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006482 Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006483
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006484 if (Entry) {
Rafael Espindola24615092014-09-12 20:14:20 +00006485 // Already created, fix the linkage and update the initializer.
6486 Entry->setLinkage(llvm::GlobalValue::WeakAnyLinkage);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006487 Entry->setInitializer(Init);
6488 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006489 Entry =
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006490 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006491 false, llvm::GlobalValue::WeakAnyLinkage, Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006492 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006493 Entry->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006494 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABITy));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006495 Entry->setSection("__DATA,__datacoal_nt,coalesced");
John McCallf9582a72012-03-30 21:29:05 +00006496
6497 Protocols[PD->getIdentifier()] = Entry;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006498 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006499 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006500 CGM.addCompilerUsedGlobal(Entry);
Chris Lattnerf56501c2009-07-17 23:57:13 +00006501
Fariborz Jahanian61cd4b52009-01-29 20:10:59 +00006502 // Use this protocol meta-data to build protocol list table in section
6503 // __DATA, __objc_protolist
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006504 llvm::GlobalVariable *PTGV =
6505 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABIPtrTy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006506 false, llvm::GlobalValue::WeakAnyLinkage, Entry,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006507 "\01l_OBJC_LABEL_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006508 PTGV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006509 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABIPtrTy));
Daniel Dunbarb25452a2009-04-15 02:56:18 +00006510 PTGV->setSection("__DATA, __objc_protolist, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006511 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006512 CGM.addCompilerUsedGlobal(PTGV);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006513 return Entry;
6514}
6515
6516/// EmitProtocolList - Generate protocol list meta-data:
6517/// @code
6518/// struct _protocol_list_t {
6519/// long protocol_count; // Note, this is 32/64 bit
6520/// struct _protocol_t[protocol_count];
6521/// }
6522/// @endcode
6523///
6524llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00006525CGObjCNonFragileABIMac::EmitProtocolList(Twine Name,
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006526 ObjCProtocolDecl::protocol_iterator begin,
6527 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006528 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006529
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006530 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006531 if (begin == end)
Owen Anderson0b75f232009-07-31 20:28:54 +00006532 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006533
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006534 // FIXME: We shouldn't need to do this lookup here, should we?
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006535 SmallString<256> TmpName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006536 Name.toVector(TmpName);
6537 llvm::GlobalVariable *GV =
6538 CGM.getModule().getGlobalVariable(TmpName.str(), true);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006539 if (GV)
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006540 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006541
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006542 for (; begin != end; ++begin)
6543 ProtocolRefs.push_back(GetProtocolRef(*begin)); // Implemented???
6544
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006545 // This list is null terminated.
Owen Anderson0b75f232009-07-31 20:28:54 +00006546 ProtocolRefs.push_back(llvm::Constant::getNullValue(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006547 ObjCTypes.ProtocolnfABIPtrTy));
6548
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006549 llvm::Constant *Values[2];
Owen Anderson170229f2009-07-14 23:10:40 +00006550 Values[0] =
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006551 llvm::ConstantInt::get(ObjCTypes.LongTy, ProtocolRefs.size() - 1);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006552 Values[1] =
Bill Wendlinga515b582012-02-09 22:16:49 +00006553 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolnfABIPtrTy,
6554 ProtocolRefs.size()),
6555 ProtocolRefs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006556
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006557 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Owen Andersonc10c8d32009-07-08 19:05:04 +00006558 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006559 llvm::GlobalValue::PrivateLinkage,
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006560 Init, Name);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006561 GV->setSection("__DATA, __objc_const");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006562 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006563 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Rafael Espindola060062a2014-03-06 22:15:10 +00006564 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006565 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006566 ObjCTypes.ProtocolListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006567}
6568
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006569/// GetMethodDescriptionConstant - This routine build following meta-data:
6570/// struct _objc_method {
6571/// SEL _cmd;
6572/// char *method_type;
6573/// char *_imp;
6574/// }
6575
6576llvm::Constant *
6577CGObjCNonFragileABIMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006578 llvm::Constant *Desc[3];
Owen Anderson170229f2009-07-14 23:10:40 +00006579 Desc[0] =
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006580 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
6581 ObjCTypes.SelectorPtrTy);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006582 Desc[1] = GetMethodVarType(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006583 if (!Desc[1])
Craig Topper8a13c412014-05-21 05:09:00 +00006584 return nullptr;
6585
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006586 // Protocol methods have no implementation. So, this entry is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00006587 Desc[2] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00006588 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Desc);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006589}
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006590
6591/// EmitObjCValueForIvar - Code Gen for nonfragile ivar reference.
6592/// This code gen. amounts to generating code for:
6593/// @code
6594/// (type *)((char *)base + _OBJC_IVAR_$_.ivar;
6595/// @encode
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006596///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00006597LValue CGObjCNonFragileABIMac::EmitObjCValueForIvar(
John McCall96fa4842010-05-17 21:00:27 +00006598 CodeGen::CodeGenFunction &CGF,
6599 QualType ObjectTy,
6600 llvm::Value *BaseValue,
6601 const ObjCIvarDecl *Ivar,
6602 unsigned CVRQualifiers) {
6603 ObjCInterfaceDecl *ID = ObjectTy->getAs<ObjCObjectType>()->getInterface();
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006604 llvm::Value *Offset = EmitIvarOffset(CGF, ID, Ivar);
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00006605 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006606 Offset);
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006607}
6608
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006609llvm::Value *CGObjCNonFragileABIMac::EmitIvarOffset(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006610 CodeGen::CodeGenFunction &CGF,
6611 const ObjCInterfaceDecl *Interface,
6612 const ObjCIvarDecl *Ivar) {
Tim Northover238b5082014-03-29 13:42:40 +00006613 llvm::Value *IvarOffsetValue = ObjCIvarOffsetVariable(Interface, Ivar);
John McCall7f416cc2015-09-08 08:05:57 +00006614 IvarOffsetValue = CGF.Builder.CreateAlignedLoad(IvarOffsetValue,
6615 CGF.getSizeAlign(), "ivar");
Tim Northover238b5082014-03-29 13:42:40 +00006616 if (IsIvarOffsetKnownIdempotent(CGF, Ivar))
6617 cast<llvm::LoadInst>(IvarOffsetValue)
6618 ->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
Craig Topper5fc8fc22014-08-27 06:28:36 +00006619 llvm::MDNode::get(VMContext, None));
Tim Northover238b5082014-03-29 13:42:40 +00006620
6621 // This could be 32bit int or 64bit integer depending on the architecture.
6622 // Cast it to 64bit integer value, if it is a 32bit integer ivar offset value
6623 // as this is what caller always expectes.
6624 if (ObjCTypes.IvarOffsetVarTy == ObjCTypes.IntTy)
6625 IvarOffsetValue = CGF.Builder.CreateIntCast(
6626 IvarOffsetValue, ObjCTypes.LongTy, true, "ivar.conv");
6627 return IvarOffsetValue;
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006628}
6629
John McCall234eac82011-05-13 23:16:18 +00006630static void appendSelectorForMessageRefTable(std::string &buffer,
6631 Selector selector) {
6632 if (selector.isUnarySelector()) {
6633 buffer += selector.getNameForSlot(0);
6634 return;
6635 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006636
John McCall234eac82011-05-13 23:16:18 +00006637 for (unsigned i = 0, e = selector.getNumArgs(); i != e; ++i) {
6638 buffer += selector.getNameForSlot(i);
6639 buffer += '_';
6640 }
6641}
6642
John McCall9e8bb002011-05-14 03:10:52 +00006643/// Emit a "v-table" message send. We emit a weak hidden-visibility
6644/// struct, initially containing the selector pointer and a pointer to
6645/// a "fixup" variant of the appropriate objc_msgSend. To call, we
6646/// load and call the function pointer, passing the address of the
6647/// struct as the second parameter. The runtime determines whether
6648/// the selector is currently emitted using vtable dispatch; if so, it
6649/// substitutes a stub function which simply tail-calls through the
6650/// appropriate vtable slot, and if not, it substitues a stub function
6651/// which tail-calls objc_msgSend. Both stubs adjust the selector
6652/// argument to correctly point to the selector.
6653RValue
6654CGObjCNonFragileABIMac::EmitVTableMessageSend(CodeGenFunction &CGF,
6655 ReturnValueSlot returnSlot,
6656 QualType resultType,
6657 Selector selector,
6658 llvm::Value *arg0,
6659 QualType arg0Type,
6660 bool isSuper,
6661 const CallArgList &formalArgs,
6662 const ObjCMethodDecl *method) {
John McCall234eac82011-05-13 23:16:18 +00006663 // Compute the actual arguments.
6664 CallArgList args;
6665
John McCall9e8bb002011-05-14 03:10:52 +00006666 // First argument: the receiver / super-call structure.
John McCall234eac82011-05-13 23:16:18 +00006667 if (!isSuper)
John McCall9e8bb002011-05-14 03:10:52 +00006668 arg0 = CGF.Builder.CreateBitCast(arg0, ObjCTypes.ObjectPtrTy);
6669 args.add(RValue::get(arg0), arg0Type);
John McCall234eac82011-05-13 23:16:18 +00006670
John McCall9e8bb002011-05-14 03:10:52 +00006671 // Second argument: a pointer to the message ref structure. Leave
6672 // the actual argument value blank for now.
Craig Topper8a13c412014-05-21 05:09:00 +00006673 args.add(RValue::get(nullptr), ObjCTypes.MessageRefCPtrTy);
John McCall234eac82011-05-13 23:16:18 +00006674
6675 args.insert(args.end(), formalArgs.begin(), formalArgs.end());
6676
John McCalla729c622012-02-17 03:33:10 +00006677 MessageSendInfo MSI = getMessageSendInfo(method, resultType, args);
John McCall234eac82011-05-13 23:16:18 +00006678
John McCall5880fb82011-05-14 21:12:11 +00006679 NullReturnState nullReturn;
6680
John McCall9e8bb002011-05-14 03:10:52 +00006681 // Find the function to call and the mangled name for the message
6682 // ref structure. Using a different mangled name wouldn't actually
6683 // be a problem; it would just be a waste.
6684 //
6685 // The runtime currently never uses vtable dispatch for anything
6686 // except normal, non-super message-sends.
6687 // FIXME: don't use this for that.
Craig Topper8a13c412014-05-21 05:09:00 +00006688 llvm::Constant *fn = nullptr;
John McCall234eac82011-05-13 23:16:18 +00006689 std::string messageRefName("\01l_");
Tim Northovere77cc392014-03-29 13:28:05 +00006690 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall234eac82011-05-13 23:16:18 +00006691 if (isSuper) {
6692 fn = ObjCTypes.getMessageSendSuper2StretFixupFn();
6693 messageRefName += "objc_msgSendSuper2_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006694 } else {
John McCall5880fb82011-05-14 21:12:11 +00006695 nullReturn.init(CGF, arg0);
John McCall234eac82011-05-13 23:16:18 +00006696 fn = ObjCTypes.getMessageSendStretFixupFn();
6697 messageRefName += "objc_msgSend_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006698 }
John McCall234eac82011-05-13 23:16:18 +00006699 } else if (!isSuper && CGM.ReturnTypeUsesFPRet(resultType)) {
6700 fn = ObjCTypes.getMessageSendFpretFixupFn();
6701 messageRefName += "objc_msgSend_fpret_fixup";
Mike Stump658fe022009-07-30 22:28:39 +00006702 } else {
John McCall234eac82011-05-13 23:16:18 +00006703 if (isSuper) {
6704 fn = ObjCTypes.getMessageSendSuper2FixupFn();
6705 messageRefName += "objc_msgSendSuper2_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006706 } else {
John McCall234eac82011-05-13 23:16:18 +00006707 fn = ObjCTypes.getMessageSendFixupFn();
6708 messageRefName += "objc_msgSend_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006709 }
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00006710 }
John McCall234eac82011-05-13 23:16:18 +00006711 assert(fn && "CGObjCNonFragileABIMac::EmitMessageSend");
6712 messageRefName += '_';
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006713
John McCall234eac82011-05-13 23:16:18 +00006714 // Append the selector name, except use underscores anywhere we
6715 // would have used colons.
6716 appendSelectorForMessageRefTable(messageRefName, selector);
6717
6718 llvm::GlobalVariable *messageRef
6719 = CGM.getModule().getGlobalVariable(messageRefName);
6720 if (!messageRef) {
John McCall9e8bb002011-05-14 03:10:52 +00006721 // Build the message ref structure.
John McCall234eac82011-05-13 23:16:18 +00006722 llvm::Constant *values[] = { fn, GetMethodVarName(selector) };
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006723 llvm::Constant *init = llvm::ConstantStruct::getAnon(values);
John McCall234eac82011-05-13 23:16:18 +00006724 messageRef = new llvm::GlobalVariable(CGM.getModule(),
6725 init->getType(),
6726 /*constant*/ false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006727 llvm::GlobalValue::WeakAnyLinkage,
John McCall234eac82011-05-13 23:16:18 +00006728 init,
6729 messageRefName);
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006730 messageRef->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall234eac82011-05-13 23:16:18 +00006731 messageRef->setAlignment(16);
6732 messageRef->setSection("__DATA, __objc_msgrefs, coalesced");
6733 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006734
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00006735 bool requiresnullCheck = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00006736 if (CGM.getLangOpts().ObjCAutoRefCount && method)
Aaron Ballman43b68be2014-03-07 17:50:17 +00006737 for (const auto *ParamDecl : method->params()) {
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00006738 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
6739 if (!nullReturn.NullBB)
6740 nullReturn.init(CGF, arg0);
6741 requiresnullCheck = true;
6742 break;
6743 }
6744 }
6745
John McCall7f416cc2015-09-08 08:05:57 +00006746 Address mref =
6747 Address(CGF.Builder.CreateBitCast(messageRef, ObjCTypes.MessageRefPtrTy),
6748 CGF.getPointerAlign());
John McCall234eac82011-05-13 23:16:18 +00006749
John McCall9e8bb002011-05-14 03:10:52 +00006750 // Update the message ref argument.
John McCall7f416cc2015-09-08 08:05:57 +00006751 args[1].RV = RValue::get(mref.getPointer());
John McCall234eac82011-05-13 23:16:18 +00006752
6753 // Load the function to call from the message ref table.
John McCall7f416cc2015-09-08 08:05:57 +00006754 Address calleeAddr =
6755 CGF.Builder.CreateStructGEP(mref, 0, CharUnits::Zero());
6756 llvm::Value *callee = CGF.Builder.CreateLoad(calleeAddr, "msgSend_fn");
John McCall234eac82011-05-13 23:16:18 +00006757
John McCalla729c622012-02-17 03:33:10 +00006758 callee = CGF.Builder.CreateBitCast(callee, MSI.MessengerType);
John McCall234eac82011-05-13 23:16:18 +00006759
John McCalla729c622012-02-17 03:33:10 +00006760 RValue result = CGF.EmitCall(MSI.CallInfo, callee, returnSlot, args);
Craig Topper8a13c412014-05-21 05:09:00 +00006761 return nullReturn.complete(CGF, result, resultType, formalArgs,
6762 requiresnullCheck ? method : nullptr);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00006763}
6764
6765/// Generate code for a message send expression in the nonfragile abi.
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006766CodeGen::RValue
6767CGObjCNonFragileABIMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00006768 ReturnValueSlot Return,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006769 QualType ResultType,
6770 Selector Sel,
6771 llvm::Value *Receiver,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006772 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00006773 const ObjCInterfaceDecl *Class,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006774 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00006775 return isVTableDispatchedSelector(Sel)
6776 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006777 Receiver, CGF.getContext().getObjCIdType(),
John McCall9e8bb002011-05-14 03:10:52 +00006778 false, CallArgs, Method)
6779 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00006780 EmitSelector(CGF, Sel),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006781 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00006782 false, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00006783}
6784
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006785llvm::GlobalVariable *
Rafael Espindola554256c2014-02-26 22:25:45 +00006786CGObjCNonFragileABIMac::GetClassGlobal(const std::string &Name, bool Weak) {
6787 llvm::GlobalValue::LinkageTypes L =
6788 Weak ? llvm::GlobalValue::ExternalWeakLinkage
6789 : llvm::GlobalValue::ExternalLinkage;
6790
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006791 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
6792
Rafael Espindola554256c2014-02-26 22:25:45 +00006793 if (!GV)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006794 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABITy,
Craig Topper8a13c412014-05-21 05:09:00 +00006795 false, L, nullptr, Name);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006796
Rafael Espindola554256c2014-02-26 22:25:45 +00006797 assert(GV->getLinkage() == L);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006798 return GV;
6799}
6800
John McCall882987f2013-02-28 19:01:20 +00006801llvm::Value *CGObjCNonFragileABIMac::EmitClassRefFromId(CodeGenFunction &CGF,
Rafael Espindola554256c2014-02-26 22:25:45 +00006802 IdentifierInfo *II,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006803 bool Weak,
6804 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00006805 CharUnits Align = CGF.getPointerAlign();
John McCall31168b02011-06-15 23:02:42 +00006806 llvm::GlobalVariable *&Entry = ClassReferences[II];
6807
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006808 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006809 std::string ClassName(
6810 getClassSymbolPrefix() +
6811 (ID ? ID->getObjCRuntimeNameAsString() : II->getName()).str());
Rafael Espindola554256c2014-02-26 22:25:45 +00006812 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName, Weak);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006813 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6814 false, llvm::GlobalValue::PrivateLinkage,
6815 ClassGV, "OBJC_CLASSLIST_REFERENCES_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006816 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006817 Entry->setSection("__DATA, __objc_classrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006818 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006819 }
John McCall7f416cc2015-09-08 08:05:57 +00006820 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006821}
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006822
John McCall882987f2013-02-28 19:01:20 +00006823llvm::Value *CGObjCNonFragileABIMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00006824 const ObjCInterfaceDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006825 return EmitClassRefFromId(CGF, ID->getIdentifier(), ID->isWeakImported(), ID);
John McCall31168b02011-06-15 23:02:42 +00006826}
6827
6828llvm::Value *CGObjCNonFragileABIMac::EmitNSAutoreleasePoolClassRef(
John McCall882987f2013-02-28 19:01:20 +00006829 CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00006830 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
Hans Wennborgdcfba332015-10-06 23:40:43 +00006831 return EmitClassRefFromId(CGF, II, false, nullptr);
John McCall31168b02011-06-15 23:02:42 +00006832}
6833
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006834llvm::Value *
John McCall882987f2013-02-28 19:01:20 +00006835CGObjCNonFragileABIMac::EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006836 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00006837 CharUnits Align = CGF.getPointerAlign();
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006838 llvm::GlobalVariable *&Entry = SuperClassReferences[ID->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006839
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006840 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006841 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6842 ClassName += ID->getObjCRuntimeNameAsString();
6843 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(),
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006844 ID->isWeakImported());
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006845 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6846 false, llvm::GlobalValue::PrivateLinkage,
6847 ClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006848 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006849 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006850 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006851 }
John McCall7f416cc2015-09-08 08:05:57 +00006852 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006853}
6854
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006855/// EmitMetaClassRef - Return a Value * of the address of _class_t
6856/// meta-data
6857///
John McCall882987f2013-02-28 19:01:20 +00006858llvm::Value *CGObjCNonFragileABIMac::EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00006859 const ObjCInterfaceDecl *ID,
6860 bool Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00006861 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006862 llvm::GlobalVariable * &Entry = MetaClassReferences[ID->getIdentifier()];
Rafael Espindola21039aa2014-02-27 16:26:32 +00006863 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006864 llvm::SmallString<64> MetaClassName(getMetaclassSymbolPrefix());
6865 MetaClassName += ID->getObjCRuntimeNameAsString();
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00006866 llvm::GlobalVariable *MetaClassGV =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006867 GetClassGlobal(MetaClassName.str(), Weak);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006868
Rafael Espindola21039aa2014-02-27 16:26:32 +00006869 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006870 false, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006871 MetaClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006872 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006873
Rafael Espindola21039aa2014-02-27 16:26:32 +00006874 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006875 CGM.addCompilerUsedGlobal(Entry);
Rafael Espindola21039aa2014-02-27 16:26:32 +00006876 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006877
John McCall7f416cc2015-09-08 08:05:57 +00006878 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006879}
6880
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006881/// GetClass - Return a reference to the class for the given interface
6882/// decl.
John McCall882987f2013-02-28 19:01:20 +00006883llvm::Value *CGObjCNonFragileABIMac::GetClass(CodeGenFunction &CGF,
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006884 const ObjCInterfaceDecl *ID) {
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00006885 if (ID->isWeakImported()) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006886 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6887 ClassName += ID->getObjCRuntimeNameAsString();
6888 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(), true);
Nick Lewycky9a441642014-02-27 00:36:00 +00006889 (void)ClassGV;
Rafael Espindolab3262952014-05-09 00:43:37 +00006890 assert(ClassGV->hasExternalWeakLinkage());
Fariborz Jahanian95ace552009-11-17 22:42:00 +00006891 }
6892
John McCall882987f2013-02-28 19:01:20 +00006893 return EmitClassRef(CGF, ID);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006894}
6895
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006896/// Generates a message send where the super is the receiver. This is
6897/// a message send to self with special delivery semantics indicating
6898/// which class's method should be called.
6899CodeGen::RValue
6900CGObjCNonFragileABIMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00006901 ReturnValueSlot Return,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006902 QualType ResultType,
6903 Selector Sel,
6904 const ObjCInterfaceDecl *Class,
6905 bool isCategoryImpl,
6906 llvm::Value *Receiver,
6907 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006908 const CodeGen::CallArgList &CallArgs,
6909 const ObjCMethodDecl *Method) {
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006910 // ...
6911 // Create and init a super structure; this is a (receiver, class)
6912 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00006913 Address ObjCSuper =
6914 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
6915 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006916
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006917 llvm::Value *ReceiverAsObject =
6918 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00006919 CGF.Builder.CreateStore(
6920 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00006921 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006922
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006923 // If this is a class message the metaclass is passed as the target.
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00006924 llvm::Value *Target;
Fariborz Jahanian27678b02012-10-10 23:11:18 +00006925 if (IsClassMessage)
Fariborz Jahanian85b99da2014-08-28 17:05:17 +00006926 Target = EmitMetaClassRef(CGF, Class, Class->isWeakImported());
Fariborz Jahanian27678b02012-10-10 23:11:18 +00006927 else
John McCall882987f2013-02-28 19:01:20 +00006928 Target = EmitSuperClassRef(CGF, Class);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006929
Mike Stump18bb9282009-05-16 07:57:57 +00006930 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
6931 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00006932 llvm::Type *ClassTy =
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006933 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
6934 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00006935 CGF.Builder.CreateStore(
John McCall7f416cc2015-09-08 08:05:57 +00006936 Target, CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006937
John McCall9e8bb002011-05-14 03:10:52 +00006938 return (isVTableDispatchedSelector(Sel))
6939 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
John McCall7f416cc2015-09-08 08:05:57 +00006940 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall9e8bb002011-05-14 03:10:52 +00006941 true, CallArgs, Method)
6942 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00006943 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00006944 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00006945 true, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006946}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006947
John McCall882987f2013-02-28 19:01:20 +00006948llvm::Value *CGObjCNonFragileABIMac::EmitSelector(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00006949 Selector Sel) {
6950 Address Addr = EmitSelectorAddr(CGF, Sel);
6951
6952 llvm::LoadInst* LI = CGF.Builder.CreateLoad(Addr);
6953 LI->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
6954 llvm::MDNode::get(VMContext, None));
6955 return LI;
6956}
6957
6958Address CGObjCNonFragileABIMac::EmitSelectorAddr(CodeGenFunction &CGF,
6959 Selector Sel) {
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006960 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006961
John McCall7f416cc2015-09-08 08:05:57 +00006962 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006963 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006964 llvm::Constant *Casted =
6965 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
6966 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006967 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.SelectorPtrTy,
6968 false, llvm::GlobalValue::PrivateLinkage,
6969 Casted, "OBJC_SELECTOR_REFERENCES_");
Michael Gottesman5c205962013-02-05 23:08:45 +00006970 Entry->setExternallyInitialized(true);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00006971 Entry->setSection("__DATA, __objc_selrefs, literal_pointers, no_dead_strip");
John McCall7f416cc2015-09-08 08:05:57 +00006972 Entry->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00006973 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006974 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006975
John McCall7f416cc2015-09-08 08:05:57 +00006976 return Address(Entry, Align);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006977}
John McCall7f416cc2015-09-08 08:05:57 +00006978
Fariborz Jahanian06292952009-02-16 22:52:32 +00006979/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00006980/// objc_assign_ivar (id src, id *dst, ptrdiff_t)
Fariborz Jahanian06292952009-02-16 22:52:32 +00006981///
6982void CGObjCNonFragileABIMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00006983 llvm::Value *src,
John McCall7f416cc2015-09-08 08:05:57 +00006984 Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00006985 llvm::Value *ivarOffset) {
Chris Lattner2192fe52011-07-18 04:24:23 +00006986 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006987 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00006988 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006989 assert(Size <= 8 && "does not support size > 8");
6990 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
6991 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00006992 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
6993 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00006994 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
6995 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00006996 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00006997 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahanian06292952009-02-16 22:52:32 +00006998}
6999
7000/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
7001/// objc_assign_strongCast (id src, id *dst)
7002///
7003void CGObjCNonFragileABIMac::EmitObjCStrongCastAssign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007004 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007005 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007006 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007007 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007008 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007009 assert(Size <= 8 && "does not support size > 8");
7010 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007011 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007012 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7013 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007014 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7015 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007016 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007017 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
7018 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007019}
7020
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007021void CGObjCNonFragileABIMac::EmitGCMemmoveCollectable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007022 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007023 Address DestPtr,
7024 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00007025 llvm::Value *Size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007026 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
7027 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007028 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), Size };
John McCall882987f2013-02-28 19:01:20 +00007029 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007030}
7031
Fariborz Jahanian06292952009-02-16 22:52:32 +00007032/// EmitObjCWeakRead - Code gen for loading value of a __weak
7033/// object: objc_read_weak (id *src)
7034///
7035llvm::Value * CGObjCNonFragileABIMac::EmitObjCWeakRead(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007036 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007037 Address AddrWeakObj) {
7038 llvm::Type *DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007039 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj, ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007040 llvm::Value *read_weak =
7041 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00007042 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00007043 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007044 return read_weak;
7045}
7046
7047/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
7048/// objc_assign_weak (id src, id *dst)
7049///
7050void CGObjCNonFragileABIMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007051 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007052 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007053 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007054 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007055 assert(Size <= 8 && "does not support size > 8");
7056 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7057 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007058 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7059 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007060 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7061 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007062 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007063 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
7064 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007065}
7066
7067/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
7068/// objc_assign_global (id src, id *dst)
7069///
7070void CGObjCNonFragileABIMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007071 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00007072 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007073 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007074 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007075 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007076 assert(Size <= 8 && "does not support size > 8");
7077 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7078 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007079 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7080 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007081 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7082 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007083 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00007084 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00007085 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
7086 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00007087 else
John McCall882987f2013-02-28 19:01:20 +00007088 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
7089 args, "threadlocalassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007090}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007091
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007092void
John McCallbd309292010-07-06 01:34:17 +00007093CGObjCNonFragileABIMac::EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
7094 const ObjCAtSynchronizedStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007095 EmitAtSynchronizedStmt(CGF, S,
7096 cast<llvm::Function>(ObjCTypes.getSyncEnterFn()),
7097 cast<llvm::Function>(ObjCTypes.getSyncExitFn()));
John McCallbd309292010-07-06 01:34:17 +00007098}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007099
John McCall2ca705e2010-07-24 00:37:23 +00007100llvm::Constant *
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00007101CGObjCNonFragileABIMac::GetEHType(QualType T) {
John McCall2ca705e2010-07-24 00:37:23 +00007102 // There's a particular fixed type info for 'id'.
7103 if (T->isObjCIdType() ||
7104 T->isObjCQualifiedIdType()) {
7105 llvm::Constant *IDEHType =
7106 CGM.getModule().getGlobalVariable("OBJC_EHTYPE_id");
7107 if (!IDEHType)
7108 IDEHType =
7109 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy,
7110 false,
7111 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00007112 nullptr, "OBJC_EHTYPE_id");
John McCall2ca705e2010-07-24 00:37:23 +00007113 return IDEHType;
7114 }
7115
7116 // All other types should be Objective-C interface pointer types.
7117 const ObjCObjectPointerType *PT =
7118 T->getAs<ObjCObjectPointerType>();
7119 assert(PT && "Invalid @catch type.");
7120 const ObjCInterfaceType *IT = PT->getInterfaceType();
7121 assert(IT && "Invalid @catch type.");
7122 return GetInterfaceEHType(IT->getDecl(), false);
7123}
7124
John McCallbd309292010-07-06 01:34:17 +00007125void CGObjCNonFragileABIMac::EmitTryStmt(CodeGen::CodeGenFunction &CGF,
7126 const ObjCAtTryStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007127 EmitTryCatchStmt(CGF, S,
7128 cast<llvm::Function>(ObjCTypes.getObjCBeginCatchFn()),
7129 cast<llvm::Function>(ObjCTypes.getObjCEndCatchFn()),
7130 cast<llvm::Function>(ObjCTypes.getExceptionRethrowFn()));
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +00007131}
7132
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007133/// EmitThrowStmt - Generate code for a throw statement.
7134void CGObjCNonFragileABIMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007135 const ObjCAtThrowStmt &S,
7136 bool ClearInsertionPoint) {
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007137 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00007138 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Benjamin Kramer76399eb2011-09-27 21:06:10 +00007139 Exception = CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007140 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionThrowFn(), Exception)
John McCall17afe452010-10-16 08:21:07 +00007141 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007142 } else {
John McCall882987f2013-02-28 19:01:20 +00007143 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionRethrowFn())
John McCall17afe452010-10-16 08:21:07 +00007144 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007145 }
7146
John McCall17afe452010-10-16 08:21:07 +00007147 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007148 if (ClearInsertionPoint)
7149 CGF.Builder.ClearInsertionPoint();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007150}
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007151
John McCall2ca705e2010-07-24 00:37:23 +00007152llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007153CGObjCNonFragileABIMac::GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007154 bool ForDefinition) {
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007155 llvm::GlobalVariable * &Entry = EHTypeReferences[ID->getIdentifier()];
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007156
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007157 // If we don't need a definition, return the entry if found or check
7158 // if we use an external reference.
7159 if (!ForDefinition) {
7160 if (Entry)
7161 return Entry;
Daniel Dunbard7beeea2009-04-07 06:43:45 +00007162
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007163 // If this type (or a super class) has the __objc_exception__
7164 // attribute, emit an external reference.
Douglas Gregor78bd61f2009-06-18 16:11:24 +00007165 if (hasObjCExceptionAttribute(CGM.getContext(), ID))
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007166 return Entry =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007167 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
7168 llvm::GlobalValue::ExternalLinkage,
7169 nullptr,
7170 ("OBJC_EHTYPE_$_" +
7171 ID->getObjCRuntimeNameAsString()));
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007172 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007173
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007174 // Otherwise we need to either make a new entry or fill in the
7175 // initializer.
7176 assert((!Entry || !Entry->hasInitializer()) && "Duplicate EHType definition");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007177 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
7178 ClassName += ID->getObjCRuntimeNameAsString();
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007179 std::string VTableName = "objc_ehtype_vtable";
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007180 llvm::GlobalVariable *VTableGV =
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007181 CGM.getModule().getGlobalVariable(VTableName);
7182 if (!VTableGV)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007183 VTableGV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.Int8PtrTy,
7184 false,
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007185 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00007186 nullptr, VTableName);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007187
Chris Lattnerece04092012-02-07 00:39:47 +00007188 llvm::Value *VTableIdx = llvm::ConstantInt::get(CGM.Int32Ty, 2);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007189
Benjamin Kramer22d24c22011-10-15 12:20:02 +00007190 llvm::Constant *Values[] = {
David Blaikiee3b172a2015-04-02 18:55:21 +00007191 llvm::ConstantExpr::getGetElementPtr(VTableGV->getValueType(), VTableGV,
7192 VTableIdx),
7193 GetClassName(ID->getObjCRuntimeNameAsString()),
7194 GetClassGlobal(ClassName.str())};
Owen Anderson170229f2009-07-14 23:10:40 +00007195 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00007196 llvm::ConstantStruct::get(ObjCTypes.EHTypeTy, Values);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007197
Rafael Espindola554256c2014-02-26 22:25:45 +00007198 llvm::GlobalValue::LinkageTypes L = ForDefinition
7199 ? llvm::GlobalValue::ExternalLinkage
7200 : llvm::GlobalValue::WeakAnyLinkage;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007201 if (Entry) {
7202 Entry->setInitializer(Init);
7203 } else {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007204 llvm::SmallString<64> EHTYPEName("OBJC_EHTYPE_$_");
7205 EHTYPEName += ID->getObjCRuntimeNameAsString();
Owen Andersonc10c8d32009-07-08 19:05:04 +00007206 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
Rafael Espindola554256c2014-02-26 22:25:45 +00007207 L,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007208 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007209 EHTYPEName.str());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007210 }
Rafael Espindola554256c2014-02-26 22:25:45 +00007211 assert(Entry->getLinkage() == L);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007212
John McCalla4960982013-02-19 01:57:29 +00007213 if (ID->getVisibility() == HiddenVisibility)
Daniel Dunbar15894b72009-04-07 05:48:37 +00007214 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Micah Villmowdd31ca12012-10-08 16:25:52 +00007215 Entry->setAlignment(CGM.getDataLayout().getABITypeAlignment(
Daniel Dunbar710cb202010-04-25 20:39:32 +00007216 ObjCTypes.EHTypeTy));
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007217
Rafael Espindola554256c2014-02-26 22:25:45 +00007218 if (ForDefinition)
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007219 Entry->setSection("__DATA,__objc_const");
Rafael Espindola554256c2014-02-26 22:25:45 +00007220 else
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007221 Entry->setSection("__DATA,__datacoal_nt,coalesced");
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007222
7223 return Entry;
7224}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007225
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00007226/* *** */
7227
Daniel Dunbarb036db82008-08-13 03:21:16 +00007228CodeGen::CGObjCRuntime *
7229CodeGen::CreateMacObjCRuntime(CodeGen::CodeGenModule &CGM) {
John McCall5fb5df92012-06-20 06:18:46 +00007230 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
7231 case ObjCRuntime::FragileMacOSX:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007232 return new CGObjCMac(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00007233
7234 case ObjCRuntime::MacOSX:
7235 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +00007236 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +00007237 return new CGObjCNonFragileABIMac(CGM);
7238
David Chisnallb601c962012-07-03 20:49:52 +00007239 case ObjCRuntime::GNUstep:
7240 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +00007241 case ObjCRuntime::ObjFW:
John McCall5fb5df92012-06-20 06:18:46 +00007242 llvm_unreachable("these runtimes are not Mac runtimes");
7243 }
7244 llvm_unreachable("bad runtime");
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007245}