blob: a5f504e141cc171241d3ad007271249311d612aa [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,
1950 nullptr, &CallSite);
1951
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 }
John McCall7f416cc2015-09-08 08:05:57 +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);
2643 return Result;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002644 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002645 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2646 return nullPtr;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002647}
2648
John McCall882987f2013-02-28 19:01:20 +00002649llvm::Value *CGObjCMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00002650 const ObjCProtocolDecl *PD) {
Daniel Dunbar7050c552008-09-04 04:33:15 +00002651 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002652 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbar7050c552008-09-04 04:33:15 +00002653 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2654
Owen Andersonade90fd2009-07-29 18:54:39 +00002655 return llvm::ConstantExpr::getBitCast(GetProtocolRef(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00002656 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002657}
2658
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002659void CGObjCCommonMac::GenerateProtocol(const ObjCProtocolDecl *PD) {
Mike Stump18bb9282009-05-16 07:57:57 +00002660 // FIXME: We shouldn't need this, the protocol decl should contain enough
2661 // information to tell us whether this was a declaration or a definition.
Daniel Dunbarc475d422008-10-29 22:36:39 +00002662 DefinedProtocols.insert(PD->getIdentifier());
2663
2664 // If we have generated a forward reference to this protocol, emit
2665 // it now. Otherwise do nothing, the protocol objects are lazily
2666 // emitted.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002667 if (Protocols.count(PD->getIdentifier()))
Daniel Dunbarc475d422008-10-29 22:36:39 +00002668 GetOrEmitProtocol(PD);
2669}
2670
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002671llvm::Constant *CGObjCCommonMac::GetProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002672 if (DefinedProtocols.count(PD->getIdentifier()))
2673 return GetOrEmitProtocol(PD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002674
Daniel Dunbarc475d422008-10-29 22:36:39 +00002675 return GetOrEmitProtocolRef(PD);
2676}
2677
Daniel Dunbarb036db82008-08-13 03:21:16 +00002678/*
Rafael Espindolaf9e1e5e2014-02-20 14:09:04 +00002679// Objective-C 1.0 extensions
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002680struct _objc_protocol {
2681struct _objc_protocol_extension *isa;
2682char *protocol_name;
2683struct _objc_protocol_list *protocol_list;
2684struct _objc__method_prototype_list *instance_methods;
2685struct _objc__method_prototype_list *class_methods
2686};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002687
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002688See EmitProtocolExtension().
Daniel Dunbarb036db82008-08-13 03:21:16 +00002689*/
Daniel Dunbarc475d422008-10-29 22:36:39 +00002690llvm::Constant *CGObjCMac::GetOrEmitProtocol(const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00002691 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbarc475d422008-10-29 22:36:39 +00002692
2693 // Early exit if a defining object has already been generated.
2694 if (Entry && Entry->hasInitializer())
2695 return Entry;
2696
Douglas Gregora715bff2012-01-01 19:51:50 +00002697 // Use the protocol definition, if there is one.
2698 if (const ObjCProtocolDecl *Def = PD->getDefinition())
2699 PD = Def;
2700
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002701 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002702 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002703 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2704
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002705 // Construct method lists.
2706 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
2707 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002708 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002709 for (const auto *MD : PD->instance_methods()) {
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002710 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002711 if (!C)
2712 return GetOrEmitProtocolRef(PD);
2713
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002714 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2715 OptInstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002716 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002717 } else {
2718 InstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002719 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002720 }
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002721 }
2722
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002723 for (const auto *MD : PD->class_methods()) {
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002724 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002725 if (!C)
2726 return GetOrEmitProtocolRef(PD);
2727
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002728 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2729 OptClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002730 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002731 } else {
2732 ClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002733 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002734 }
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002735 }
2736
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002737 MethodTypesExt.insert(MethodTypesExt.end(),
2738 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
2739
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002740 llvm::Constant *Values[] = {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002741 EmitProtocolExtension(PD, OptInstanceMethods, OptClassMethods,
2742 MethodTypesExt),
2743 GetClassName(PD->getObjCRuntimeNameAsString()),
2744 EmitProtocolList("OBJC_PROTOCOL_REFS_" + PD->getName(),
2745 PD->protocol_begin(), PD->protocol_end()),
2746 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_" + PD->getName(),
2747 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2748 InstanceMethods),
2749 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_" + PD->getName(),
2750 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2751 ClassMethods)};
Owen Anderson0e0189d2009-07-27 22:29:56 +00002752 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbarb036db82008-08-13 03:21:16 +00002753 Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002754
Daniel Dunbarb036db82008-08-13 03:21:16 +00002755 if (Entry) {
Rafael Espindola5d117f32014-03-06 01:10:46 +00002756 // Already created, update the initializer.
Rafael Espindolab3262952014-05-09 00:43:37 +00002757 assert(Entry->hasPrivateLinkage());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002758 Entry->setInitializer(Init);
2759 } else {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002760 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2761 false, llvm::GlobalValue::PrivateLinkage,
2762 Init, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002763 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002764 // FIXME: Is this necessary? Why only for protocol?
2765 Entry->setAlignment(4);
John McCallf9582a72012-03-30 21:29:05 +00002766
2767 Protocols[PD->getIdentifier()] = Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002768 }
Rafael Espindola060062a2014-03-06 22:15:10 +00002769 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbarc475d422008-10-29 22:36:39 +00002770
2771 return Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002772}
2773
Daniel Dunbarc475d422008-10-29 22:36:39 +00002774llvm::Constant *CGObjCMac::GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00002775 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
2776
2777 if (!Entry) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002778 // We use the initializer as a marker of whether this is a forward
2779 // reference or not. At module finalization we add the empty
2780 // contents for protocols which were referenced but never defined.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002781 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2782 false, llvm::GlobalValue::PrivateLinkage,
2783 nullptr, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002784 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002785 // FIXME: Is this necessary? Why only for protocol?
2786 Entry->setAlignment(4);
2787 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002788
Daniel Dunbarb036db82008-08-13 03:21:16 +00002789 return Entry;
2790}
2791
2792/*
2793 struct _objc_protocol_extension {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002794 uint32_t size;
2795 struct objc_method_description_list *optional_instance_methods;
2796 struct objc_method_description_list *optional_class_methods;
2797 struct objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002798 const char ** extendedMethodTypes;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002799 };
2800*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002801llvm::Constant *
2802CGObjCMac::EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002803 ArrayRef<llvm::Constant*> OptInstanceMethods,
2804 ArrayRef<llvm::Constant*> OptClassMethods,
2805 ArrayRef<llvm::Constant*> MethodTypesExt) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002806 uint64_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00002807 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolExtensionTy);
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002808 llvm::Constant *Values[] = {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002809 llvm::ConstantInt::get(ObjCTypes.IntTy, Size),
2810 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_OPT_" + PD->getName(),
2811 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2812 OptInstanceMethods),
2813 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_OPT_" + PD->getName(),
2814 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2815 OptClassMethods),
2816 EmitPropertyList("OBJC_$_PROP_PROTO_LIST_" + PD->getName(), nullptr, PD,
2817 ObjCTypes),
2818 EmitProtocolMethodTypes("OBJC_PROTOCOL_METHOD_TYPES_" + PD->getName(),
2819 MethodTypesExt, ObjCTypes)};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002820
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002821 // Return null if no extension bits are used.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002822 if (Values[1]->isNullValue() && Values[2]->isNullValue() &&
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002823 Values[3]->isNullValue() && Values[4]->isNullValue())
Owen Anderson0b75f232009-07-31 20:28:54 +00002824 return llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002825
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002826 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00002827 llvm::ConstantStruct::get(ObjCTypes.ProtocolExtensionTy, Values);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002828
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00002829 // No special section, but goes in llvm.used
Alp Toker541d5072014-06-07 23:30:53 +00002830 return CreateMetadataVar("\01l_OBJC_PROTOCOLEXT_" + PD->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00002831 StringRef(), CGM.getPointerAlign(), true);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002832}
2833
2834/*
2835 struct objc_protocol_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00002836 struct objc_protocol_list *next;
2837 long count;
2838 Protocol *list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00002839 };
2840*/
Daniel Dunbardec75f82008-08-21 21:57:41 +00002841llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002842CGObjCMac::EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00002843 ObjCProtocolDecl::protocol_iterator begin,
2844 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002845 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002846
Daniel Dunbardec75f82008-08-21 21:57:41 +00002847 for (; begin != end; ++begin)
2848 ProtocolRefs.push_back(GetProtocolRef(*begin));
Daniel Dunbarb036db82008-08-13 03:21:16 +00002849
2850 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002851 if (ProtocolRefs.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00002852 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002853
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002854 // This list is null terminated.
Owen Anderson0b75f232009-07-31 20:28:54 +00002855 ProtocolRefs.push_back(llvm::Constant::getNullValue(ObjCTypes.ProtocolPtrTy));
Daniel Dunbarb036db82008-08-13 03:21:16 +00002856
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002857 llvm::Constant *Values[3];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002858 // This field is only used by the runtime.
Owen Anderson0b75f232009-07-31 20:28:54 +00002859 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002860 Values[1] = llvm::ConstantInt::get(ObjCTypes.LongTy,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002861 ProtocolRefs.size() - 1);
2862 Values[2] =
2863 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolPtrTy,
2864 ProtocolRefs.size()),
Daniel Dunbarb036db82008-08-13 03:21:16 +00002865 ProtocolRefs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002866
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002867 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002868 llvm::GlobalVariable *GV =
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00002869 CreateMetadataVar(Name, Init, "__OBJC,__cat_cls_meth,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00002870 CGM.getPointerAlign(), false);
Owen Andersonade90fd2009-07-29 18:54:39 +00002871 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002872}
2873
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002874void CGObjCCommonMac::
2875PushProtocolProperties(llvm::SmallPtrSet<const IdentifierInfo*,16> &PropertySet,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002876 SmallVectorImpl<llvm::Constant *> &Properties,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002877 const Decl *Container,
Aaron Ballmandc4bea42014-03-13 18:47:37 +00002878 const ObjCProtocolDecl *Proto,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002879 const ObjCCommonTypesHelper &ObjCTypes) {
Aaron Ballman0f6e64d2014-03-13 22:58:06 +00002880 for (const auto *P : Proto->protocols())
2881 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes);
Aaron Ballmand174edf2014-03-13 19:11:50 +00002882 for (const auto *PD : Proto->properties()) {
David Blaikie82e95a32014-11-19 07:49:47 +00002883 if (!PropertySet.insert(PD->getIdentifier()).second)
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002884 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002885 llvm::Constant *Prop[] = {
2886 GetPropertyName(PD->getIdentifier()),
2887 GetPropertyTypeString(PD, Container)
2888 };
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002889 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy, Prop));
2890 }
2891}
2892
Daniel Dunbarb036db82008-08-13 03:21:16 +00002893/*
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002894 struct _objc_property {
Bill Wendlinga515b582012-02-09 22:16:49 +00002895 const char * const name;
2896 const char * const attributes;
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002897 };
2898
2899 struct _objc_property_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00002900 uint32_t entsize; // sizeof (struct _objc_property)
2901 uint32_t prop_count;
2902 struct _objc_property[prop_count];
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002903 };
2904*/
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002905llvm::Constant *CGObjCCommonMac::EmitPropertyList(Twine Name,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002906 const Decl *Container,
2907 const ObjCContainerDecl *OCD,
2908 const ObjCCommonTypesHelper &ObjCTypes) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002909 SmallVector<llvm::Constant *, 16> Properties;
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002910 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Aaron Ballmand174edf2014-03-13 19:11:50 +00002911 for (const auto *PD : OCD->properties()) {
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002912 PropertySet.insert(PD->getIdentifier());
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002913 llvm::Constant *Prop[] = {
2914 GetPropertyName(PD->getIdentifier()),
2915 GetPropertyTypeString(PD, Container)
2916 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00002917 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy,
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002918 Prop));
2919 }
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002920 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD)) {
Aaron Ballmana9f49e32014-03-13 20:55:22 +00002921 for (const auto *P : OID->all_referenced_protocols())
2922 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002923 }
2924 else if (const ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(OCD)) {
Aaron Ballman19a41762014-03-14 12:55:57 +00002925 for (const auto *P : CD->protocols())
2926 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002927 }
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002928
2929 // Return null for empty list.
2930 if (Properties.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00002931 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002932
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002933 unsigned PropertySize =
Micah Villmowdd31ca12012-10-08 16:25:52 +00002934 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.PropertyTy);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002935 llvm::Constant *Values[3];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002936 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, PropertySize);
2937 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Properties.size());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002938 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.PropertyTy,
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002939 Properties.size());
Owen Anderson47034e12009-07-28 18:33:04 +00002940 Values[2] = llvm::ConstantArray::get(AT, Properties);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002941 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002942
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002943 llvm::GlobalVariable *GV =
2944 CreateMetadataVar(Name, Init,
2945 (ObjCABI == 2) ? "__DATA, __objc_const" :
Daniel Dunbarb25452a2009-04-15 02:56:18 +00002946 "__OBJC,__property,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00002947 CGM.getPointerAlign(),
Daniel Dunbarb25452a2009-04-15 02:56:18 +00002948 true);
Owen Andersonade90fd2009-07-29 18:54:39 +00002949 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002950}
2951
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002952llvm::Constant *
2953CGObjCCommonMac::EmitProtocolMethodTypes(Twine Name,
2954 ArrayRef<llvm::Constant*> MethodTypes,
2955 const ObjCCommonTypesHelper &ObjCTypes) {
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002956 // Return null for empty list.
2957 if (MethodTypes.empty())
2958 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrPtrTy);
2959
2960 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
2961 MethodTypes.size());
2962 llvm::Constant *Init = llvm::ConstantArray::get(AT, MethodTypes);
2963
Alp Toker541d5072014-06-07 23:30:53 +00002964 llvm::GlobalVariable *GV = CreateMetadataVar(
2965 Name, Init, (ObjCABI == 2) ? "__DATA, __objc_const" : StringRef(),
John McCall7f416cc2015-09-08 08:05:57 +00002966 CGM.getPointerAlign(), true);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002967 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.Int8PtrPtrTy);
2968}
2969
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002970/*
Daniel Dunbarb036db82008-08-13 03:21:16 +00002971 struct objc_method_description_list {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002972 int count;
2973 struct objc_method_description list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00002974 };
2975*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002976llvm::Constant *
2977CGObjCMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002978 llvm::Constant *Desc[] = {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002979 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002980 ObjCTypes.SelectorPtrTy),
2981 GetMethodVarType(MD)
2982 };
Douglas Gregora9d84932011-05-27 01:19:52 +00002983 if (!Desc[1])
Craig Topper8a13c412014-05-21 05:09:00 +00002984 return nullptr;
2985
Owen Anderson0e0189d2009-07-27 22:29:56 +00002986 return llvm::ConstantStruct::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002987 Desc);
2988}
Daniel Dunbarb036db82008-08-13 03:21:16 +00002989
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002990llvm::Constant *
2991CGObjCMac::EmitMethodDescList(Twine Name, const char *Section,
2992 ArrayRef<llvm::Constant*> Methods) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00002993 // Return null for empty list.
2994 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00002995 return llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002996
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002997 llvm::Constant *Values[2];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002998 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002999 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbarb036db82008-08-13 03:21:16 +00003000 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003001 Values[1] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003002 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003003
John McCall7f416cc2015-09-08 08:05:57 +00003004 llvm::GlobalVariable *GV =
3005 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003006 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbarb036db82008-08-13 03:21:16 +00003007 ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003008}
3009
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003010/*
3011 struct _objc_category {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003012 char *category_name;
3013 char *class_name;
3014 struct _objc_method_list *instance_methods;
3015 struct _objc_method_list *class_methods;
3016 struct _objc_protocol_list *protocols;
3017 uint32_t size; // <rdar://4585769>
3018 struct _objc_property_list *instance_properties;
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003019 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003020*/
Daniel Dunbar92992502008-08-15 22:20:32 +00003021void CGObjCMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00003022 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategoryTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003023
Mike Stump18bb9282009-05-16 07:57:57 +00003024 // FIXME: This is poor design, the OCD should have a pointer to the category
3025 // decl. Additionally, note that Category can be null for the @implementation
3026 // w/o an @interface case. Sema should just create one for us as it does for
3027 // @implementation so everyone else can live life under a clear blue sky.
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003028 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003029 const ObjCCategoryDecl *Category =
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003030 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003031
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003032 SmallString<256> ExtName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003033 llvm::raw_svector_ostream(ExtName) << Interface->getName() << '_'
3034 << OCD->getName();
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003035
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003036 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003037 for (const auto *I : OCD->instance_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003038 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003039 InstanceMethods.push_back(GetMethodConstant(I));
3040
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003041 for (const auto *I : OCD->class_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003042 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003043 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003044
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003045 llvm::Constant *Values[7];
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003046 Values[0] = GetClassName(OCD->getName());
3047 Values[1] = GetClassName(Interface->getObjCRuntimeNameAsString());
Fariborz Jahaniane55f8662009-04-29 20:40:05 +00003048 LazySymbols.insert(Interface->getIdentifier());
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003049 Values[2] = EmitMethodList("OBJC_CATEGORY_INSTANCE_METHODS_" + ExtName.str(),
3050 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
3051 InstanceMethods);
3052 Values[3] = EmitMethodList("OBJC_CATEGORY_CLASS_METHODS_" + ExtName.str(),
3053 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
3054 ClassMethods);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003055 if (Category) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003056 Values[4] =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003057 EmitProtocolList("OBJC_CATEGORY_PROTOCOLS_" + ExtName.str(),
3058 Category->protocol_begin(), Category->protocol_end());
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003059 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003060 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003061 }
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003062 Values[5] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003063
3064 // If there is no category @interface then there can be no properties.
3065 if (Category) {
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003066 Values[6] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
Fariborz Jahanian066347e2009-01-28 22:18:42 +00003067 OCD, Category, ObjCTypes);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003068 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003069 Values[6] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003070 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003071
Owen Anderson0e0189d2009-07-27 22:29:56 +00003072 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.CategoryTy,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003073 Values);
3074
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003075 llvm::GlobalVariable *GV =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003076 CreateMetadataVar("OBJC_CATEGORY_" + ExtName.str(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003077 "__OBJC,__category,regular,no_dead_strip",
3078 CGM.getPointerAlign(), true);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003079 DefinedCategories.push_back(GV);
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00003080 DefinedCategoryNames.insert(ExtName.str());
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003081 // method definition entries must be clear for next implementation.
3082 MethodDefinitions.clear();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003083}
3084
John McCallef19dbb2012-10-17 04:53:23 +00003085enum FragileClassFlags {
John McCall460ce582015-10-22 18:38:17 +00003086 /// Apparently: is not a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003087 FragileABI_Class_Factory = 0x00001,
John McCall460ce582015-10-22 18:38:17 +00003088
3089 /// Is a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003090 FragileABI_Class_Meta = 0x00002,
John McCall460ce582015-10-22 18:38:17 +00003091
3092 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003093 FragileABI_Class_HasCXXStructors = 0x02000,
John McCall460ce582015-10-22 18:38:17 +00003094
3095 /// Has hidden visibility.
John McCall09ec1ec2015-10-21 22:06:03 +00003096 FragileABI_Class_Hidden = 0x20000,
John McCall460ce582015-10-22 18:38:17 +00003097
3098 /// Class implementation was compiled under ARC.
3099 FragileABI_Class_CompiledByARC = 0x04000000,
3100
3101 /// Class implementation was compiled under MRC and has MRC weak ivars.
3102 /// Exclusive with CompiledByARC.
3103 FragileABI_Class_HasMRCWeakIvars = 0x08000000,
John McCallef19dbb2012-10-17 04:53:23 +00003104};
3105
3106enum NonFragileClassFlags {
3107 /// Is a meta-class.
3108 NonFragileABI_Class_Meta = 0x00001,
3109
3110 /// Is a root class.
3111 NonFragileABI_Class_Root = 0x00002,
3112
John McCall460ce582015-10-22 18:38:17 +00003113 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003114 NonFragileABI_Class_HasCXXStructors = 0x00004,
3115
3116 /// Has hidden visibility.
3117 NonFragileABI_Class_Hidden = 0x00010,
3118
3119 /// Has the exception attribute.
3120 NonFragileABI_Class_Exception = 0x00020,
3121
3122 /// (Obsolete) ARC-specific: this class has a .release_ivars method
3123 NonFragileABI_Class_HasIvarReleaser = 0x00040,
3124
3125 /// Class implementation was compiled under ARC.
John McCall0d54a172012-10-17 04:53:31 +00003126 NonFragileABI_Class_CompiledByARC = 0x00080,
3127
3128 /// Class has non-trivial destructors, but zero-initialization is okay.
John McCall460ce582015-10-22 18:38:17 +00003129 NonFragileABI_Class_HasCXXDestructorOnly = 0x00100,
3130
3131 /// Class implementation was compiled under MRC and has MRC weak ivars.
3132 /// Exclusive with CompiledByARC.
3133 NonFragileABI_Class_HasMRCWeakIvars = 0x00200,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003134};
3135
John McCall460ce582015-10-22 18:38:17 +00003136static bool hasWeakMember(QualType type) {
3137 if (type.getObjCLifetime() == Qualifiers::OCL_Weak) {
3138 return true;
3139 }
3140
3141 if (auto recType = type->getAs<RecordType>()) {
3142 for (auto field : recType->getDecl()->fields()) {
3143 if (hasWeakMember(field->getType()))
3144 return true;
3145 }
3146 }
3147
3148 return false;
3149}
3150
3151/// For compatibility, we only want to set the "HasMRCWeakIvars" flag
3152/// (and actually fill in a layout string) if we really do have any
3153/// __weak ivars.
3154static bool hasMRCWeakIvars(CodeGenModule &CGM,
3155 const ObjCImplementationDecl *ID) {
3156 if (!CGM.getLangOpts().ObjCWeak) return false;
3157 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
3158
3159 for (const ObjCIvarDecl *ivar =
3160 ID->getClassInterface()->all_declared_ivar_begin();
3161 ivar; ivar = ivar->getNextIvar()) {
3162 if (hasWeakMember(ivar->getType()))
3163 return true;
3164 }
3165
3166 return false;
3167}
3168
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003169/*
3170 struct _objc_class {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003171 Class isa;
3172 Class super_class;
3173 const char *name;
3174 long version;
3175 long info;
3176 long instance_size;
3177 struct _objc_ivar_list *ivars;
3178 struct _objc_method_list *methods;
3179 struct _objc_cache *cache;
3180 struct _objc_protocol_list *protocols;
3181 // Objective-C 1.0 extensions (<rdr://4585769>)
3182 const char *ivar_layout;
3183 struct _objc_class_ext *ext;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003184 };
3185
3186 See EmitClassExtension();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003187*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003188void CGObjCMac::GenerateClass(const ObjCImplementationDecl *ID) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003189 DefinedSymbols.insert(ID->getIdentifier());
3190
Chris Lattner86d7d912008-11-24 03:54:41 +00003191 std::string ClassName = ID->getNameAsString();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003192 // FIXME: Gross
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003193 ObjCInterfaceDecl *Interface =
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003194 const_cast<ObjCInterfaceDecl*>(ID->getClassInterface());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003195 llvm::Constant *Protocols =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003196 EmitProtocolList("OBJC_CLASS_PROTOCOLS_" + ID->getName(),
3197 Interface->all_referenced_protocol_begin(),
3198 Interface->all_referenced_protocol_end());
John McCallef19dbb2012-10-17 04:53:23 +00003199 unsigned Flags = FragileABI_Class_Factory;
John McCall0d54a172012-10-17 04:53:31 +00003200 if (ID->hasNonZeroConstructors() || ID->hasDestructors())
John McCallef19dbb2012-10-17 04:53:23 +00003201 Flags |= FragileABI_Class_HasCXXStructors;
John McCall09ec1ec2015-10-21 22:06:03 +00003202
John McCall460ce582015-10-22 18:38:17 +00003203 bool hasMRCWeak = false;
3204
John McCall09ec1ec2015-10-21 22:06:03 +00003205 if (CGM.getLangOpts().ObjCAutoRefCount)
3206 Flags |= FragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00003207 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
3208 Flags |= FragileABI_Class_HasMRCWeakIvars;
John McCall09ec1ec2015-10-21 22:06:03 +00003209
John McCall3fd13f062015-10-21 18:06:47 +00003210 CharUnits Size =
3211 CGM.getContext().getASTObjCImplementationLayout(ID).getSize();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003212
3213 // FIXME: Set CXX-structors flag.
John McCall457a04e2010-10-22 21:05:15 +00003214 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003215 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003216
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003217 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003218 for (const auto *I : ID->instance_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003219 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003220 InstanceMethods.push_back(GetMethodConstant(I));
3221
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003222 for (const auto *I : ID->class_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003223 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003224 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003225
Aaron Ballmand85eff42014-03-14 15:02:45 +00003226 for (const auto *PID : ID->property_impls()) {
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003227 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
3228 ObjCPropertyDecl *PD = PID->getPropertyDecl();
3229
3230 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
3231 if (llvm::Constant *C = GetMethodConstant(MD))
3232 InstanceMethods.push_back(C);
3233 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
3234 if (llvm::Constant *C = GetMethodConstant(MD))
3235 InstanceMethods.push_back(C);
3236 }
3237 }
3238
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003239 llvm::Constant *Values[12];
Daniel Dunbarccf61832009-05-03 08:56:52 +00003240 Values[ 0] = EmitMetaClass(ID, Protocols, ClassMethods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003241 if (ObjCInterfaceDecl *Super = Interface->getSuperClass()) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003242 // Record a reference to the super class.
3243 LazySymbols.insert(Super->getIdentifier());
3244
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003245 Values[ 1] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003246 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003247 ObjCTypes.ClassPtrTy);
3248 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003249 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003250 }
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003251 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003252 // Version is always 0.
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003253 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3254 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
John McCall3fd13f062015-10-21 18:06:47 +00003255 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size.getQuantity());
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003256 Values[ 6] = EmitIvarList(ID, false);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003257 Values[7] = EmitMethodList("OBJC_INSTANCE_METHODS_" + ID->getName(),
3258 "__OBJC,__inst_meth,regular,no_dead_strip",
3259 InstanceMethods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003260 // cache is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003261 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003262 Values[ 9] = Protocols;
John McCall460ce582015-10-22 18:38:17 +00003263 Values[10] = BuildStrongIvarLayout(ID, CharUnits::Zero(), Size);
3264 Values[11] = EmitClassExtension(ID, Size, hasMRCWeak);
Owen Anderson0e0189d2009-07-27 22:29:56 +00003265 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003266 Values);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003267 std::string Name("OBJC_CLASS_");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003268 Name += ClassName;
3269 const char *Section = "__OBJC,__class,regular,no_dead_strip";
3270 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003271 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003272 if (GV) {
3273 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3274 "Forward metaclass reference has incorrect type.");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003275 GV->setInitializer(Init);
3276 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003277 GV->setAlignment(CGM.getPointerAlign().getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00003278 CGM.addCompilerUsedGlobal(GV);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003279 } else
John McCall7f416cc2015-09-08 08:05:57 +00003280 GV = CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003281 DefinedClasses.push_back(GV);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00003282 ImplementedClasses.push_back(Interface);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003283 // method definition entries must be clear for next implementation.
3284 MethodDefinitions.clear();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003285}
3286
3287llvm::Constant *CGObjCMac::EmitMetaClass(const ObjCImplementationDecl *ID,
3288 llvm::Constant *Protocols,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003289 ArrayRef<llvm::Constant*> Methods) {
John McCallef19dbb2012-10-17 04:53:23 +00003290 unsigned Flags = FragileABI_Class_Meta;
Micah Villmowdd31ca12012-10-08 16:25:52 +00003291 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003292
John McCall457a04e2010-10-22 21:05:15 +00003293 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003294 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003295
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003296 llvm::Constant *Values[12];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003297 // The isa for the metaclass is the root of the hierarchy.
3298 const ObjCInterfaceDecl *Root = ID->getClassInterface();
3299 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
3300 Root = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003301 Values[ 0] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003302 llvm::ConstantExpr::getBitCast(GetClassName(Root->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003303 ObjCTypes.ClassPtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003304 // The super class for the metaclass is emitted as the name of the
3305 // super class. The runtime fixes this up to point to the
3306 // *metaclass* for the super class.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003307 if (ObjCInterfaceDecl *Super = ID->getClassInterface()->getSuperClass()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003308 Values[ 1] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003309 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003310 ObjCTypes.ClassPtrTy);
3311 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003312 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003313 }
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003314 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003315 // Version is always 0.
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003316 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3317 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
3318 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size);
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003319 Values[ 6] = EmitIvarList(ID, true);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003320 Values[7] =
3321 EmitMethodList("OBJC_CLASS_METHODS_" + ID->getNameAsString(),
3322 "__OBJC,__cls_meth,regular,no_dead_strip", Methods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003323 // cache is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003324 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003325 Values[ 9] = Protocols;
3326 // ivar_layout for metaclass is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003327 Values[10] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003328 // The class extension is always unused for metaclasses.
Owen Anderson0b75f232009-07-31 20:28:54 +00003329 Values[11] = llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00003330 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003331 Values);
3332
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003333 std::string Name("OBJC_METACLASS_");
Benjamin Kramer1bbcbd02012-07-31 11:45:39 +00003334 Name += ID->getName();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003335
3336 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003337 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003338 if (GV) {
3339 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3340 "Forward metaclass reference has incorrect type.");
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003341 GV->setInitializer(Init);
3342 } else {
Owen Andersonc10c8d32009-07-08 19:05:04 +00003343 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003344 llvm::GlobalValue::PrivateLinkage,
Owen Andersonc10c8d32009-07-08 19:05:04 +00003345 Init, Name);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003346 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003347 GV->setSection("__OBJC,__meta_class,regular,no_dead_strip");
Daniel Dunbarae333842009-03-09 22:18:41 +00003348 GV->setAlignment(4);
Rafael Espindola060062a2014-03-06 22:15:10 +00003349 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003350
3351 return GV;
3352}
3353
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003354llvm::Constant *CGObjCMac::EmitMetaClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003355 std::string Name = "OBJC_METACLASS_" + ID->getNameAsString();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003356
Mike Stump18bb9282009-05-16 07:57:57 +00003357 // FIXME: Should we look these up somewhere other than the module. Its a bit
3358 // silly since we only generate these while processing an implementation, so
3359 // exactly one pointer would work if know when we entered/exitted an
3360 // implementation block.
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003361
3362 // Check for an existing forward reference.
Fariborz Jahanian475831b2009-01-07 20:11:22 +00003363 // Previously, metaclass with internal linkage may have been defined.
3364 // pass 'true' as 2nd argument so it is returned.
Rafael Espindola21039aa2014-02-27 16:26:32 +00003365 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3366 if (!GV)
3367 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003368 llvm::GlobalValue::PrivateLinkage, nullptr,
3369 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003370
3371 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3372 "Forward metaclass reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003373 return GV;
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003374}
3375
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003376llvm::Value *CGObjCMac::EmitSuperClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003377 std::string Name = "OBJC_CLASS_" + ID->getNameAsString();
Rafael Espindola21039aa2014-02-27 16:26:32 +00003378 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3379
3380 if (!GV)
3381 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003382 llvm::GlobalValue::PrivateLinkage, nullptr,
3383 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003384
3385 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3386 "Forward class metadata reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003387 return GV;
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003388}
3389
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003390/*
John McCall3fd13f062015-10-21 18:06:47 +00003391 Emit a "class extension", which in this specific context means extra
3392 data that doesn't fit in the normal fragile-ABI class structure, and
3393 has nothing to do with the language concept of a class extension.
3394
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003395 struct objc_class_ext {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003396 uint32_t size;
3397 const char *weak_ivar_layout;
3398 struct _objc_property_list *properties;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003399 };
3400*/
3401llvm::Constant *
John McCall3fd13f062015-10-21 18:06:47 +00003402CGObjCMac::EmitClassExtension(const ObjCImplementationDecl *ID,
John McCall460ce582015-10-22 18:38:17 +00003403 CharUnits InstanceSize, bool hasMRCWeakIvars) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003404 uint64_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00003405 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003406
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003407 llvm::Constant *Values[3];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003408 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
John McCall460ce582015-10-22 18:38:17 +00003409 Values[1] = BuildWeakIvarLayout(ID, CharUnits::Zero(), InstanceSize,
3410 hasMRCWeakIvars);
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003411 Values[2] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ID->getName(),
Fariborz Jahanian066347e2009-01-28 22:18:42 +00003412 ID, ID->getClassInterface(), ObjCTypes);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003413
3414 // Return null if no extension bits are used.
3415 if (Values[1]->isNullValue() && Values[2]->isNullValue())
Owen Anderson0b75f232009-07-31 20:28:54 +00003416 return llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003417
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003418 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00003419 llvm::ConstantStruct::get(ObjCTypes.ClassExtensionTy, Values);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003420 return CreateMetadataVar("OBJC_CLASSEXT_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003421 "__OBJC,__class_ext,regular,no_dead_strip",
3422 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003423}
3424
3425/*
3426 struct objc_ivar {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003427 char *ivar_name;
3428 char *ivar_type;
3429 int ivar_offset;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003430 };
3431
3432 struct objc_ivar_list {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003433 int ivar_count;
3434 struct objc_ivar list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003435 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003436*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003437llvm::Constant *CGObjCMac::EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003438 bool ForClass) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003439 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003440
3441 // When emitting the root class GCC emits ivar entries for the
3442 // actual class structure. It is not clear if we need to follow this
3443 // behavior; for now lets try and get away with not doing it. If so,
3444 // the cleanest solution would be to make up an ObjCInterfaceDecl
3445 // for the class.
3446 if (ForClass)
Owen Anderson0b75f232009-07-31 20:28:54 +00003447 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003448
Jordy Rosea91768e2011-07-22 02:08:32 +00003449 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003450
Jordy Rosea91768e2011-07-22 02:08:32 +00003451 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00003452 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00003453 // Ignore unnamed bit-fields.
3454 if (!IVD->getDeclName())
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003455 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003456 llvm::Constant *Ivar[] = {
3457 GetMethodVarName(IVD->getIdentifier()),
3458 GetMethodVarType(IVD),
3459 llvm::ConstantInt::get(ObjCTypes.IntTy,
Eli Friedman8cbca202012-11-06 22:15:52 +00003460 ComputeIvarBaseOffset(CGM, OID, IVD))
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003461 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00003462 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarTy, Ivar));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003463 }
3464
3465 // Return null for empty list.
3466 if (Ivars.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003467 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003468
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003469 llvm::Constant *Values[2];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003470 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00003471 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003472 Ivars.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003473 Values[1] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003474 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003475
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003476 llvm::GlobalVariable *GV;
3477 if (ForClass)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003478 GV =
3479 CreateMetadataVar("OBJC_CLASS_VARIABLES_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003480 "__OBJC,__class_vars,regular,no_dead_strip",
3481 CGM.getPointerAlign(), true);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003482 else
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003483 GV = CreateMetadataVar("OBJC_INSTANCE_VARIABLES_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003484 "__OBJC,__instance_vars,regular,no_dead_strip",
3485 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003486 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003487}
3488
3489/*
3490 struct objc_method {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003491 SEL method_name;
3492 char *method_types;
3493 void *method;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003494 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003495
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003496 struct objc_method_list {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003497 struct objc_method_list *obsolete;
3498 int count;
3499 struct objc_method methods_list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003500 };
3501*/
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003502
3503/// GetMethodConstant - Return a struct objc_method constant for the
3504/// given method if it has been defined. The result is null if the
3505/// method has not been defined. The return value has type MethodPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003506llvm::Constant *CGObjCMac::GetMethodConstant(const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00003507 llvm::Function *Fn = GetMethodDefinition(MD);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003508 if (!Fn)
Craig Topper8a13c412014-05-21 05:09:00 +00003509 return nullptr;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003510
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003511 llvm::Constant *Method[] = {
Owen Andersonade90fd2009-07-29 18:54:39 +00003512 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003513 ObjCTypes.SelectorPtrTy),
3514 GetMethodVarType(MD),
3515 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
3516 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00003517 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003518}
3519
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003520llvm::Constant *CGObjCMac::EmitMethodList(Twine Name,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003521 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003522 ArrayRef<llvm::Constant*> Methods) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003523 // Return null for empty list.
3524 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003525 return llvm::Constant::getNullValue(ObjCTypes.MethodListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003526
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003527 llvm::Constant *Values[3];
Owen Anderson0b75f232009-07-31 20:28:54 +00003528 Values[0] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003529 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00003530 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003531 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003532 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003533 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003534
John McCall7f416cc2015-09-08 08:05:57 +00003535 llvm::GlobalVariable *GV =
3536 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003537 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListPtrTy);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003538}
3539
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00003540llvm::Function *CGObjCCommonMac::GenerateMethod(const ObjCMethodDecl *OMD,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003541 const ObjCContainerDecl *CD) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003542 SmallString<256> Name;
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00003543 GetNameForMethod(OMD, CD, Name);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003544
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00003545 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00003546 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00003547 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003548 llvm::Function *Method =
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00003549 llvm::Function::Create(MethodTy,
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003550 llvm::GlobalValue::InternalLinkage,
Daniel Dunbard2386812009-10-19 01:21:19 +00003551 Name.str(),
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003552 &CGM.getModule());
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003553 MethodDefinitions.insert(std::make_pair(OMD, Method));
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003554
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003555 return Method;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003556}
3557
Alp Toker541d5072014-06-07 23:30:53 +00003558llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
3559 llvm::Constant *Init,
3560 StringRef Section,
John McCall7f416cc2015-09-08 08:05:57 +00003561 CharUnits Align,
Alp Toker541d5072014-06-07 23:30:53 +00003562 bool AddToUsed) {
Chris Lattner2192fe52011-07-18 04:24:23 +00003563 llvm::Type *Ty = Init->getType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003564 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00003565 new llvm::GlobalVariable(CGM.getModule(), Ty, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003566 llvm::GlobalValue::PrivateLinkage, Init, Name);
Alp Toker541d5072014-06-07 23:30:53 +00003567 if (!Section.empty())
Daniel Dunbar30c65362009-03-09 20:09:19 +00003568 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003569 GV->setAlignment(Align.getQuantity());
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00003570 if (AddToUsed)
Rafael Espindola060062a2014-03-06 22:15:10 +00003571 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar30c65362009-03-09 20:09:19 +00003572 return GV;
3573}
3574
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003575llvm::Function *CGObjCMac::ModuleInitFunction() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00003576 // Abuse this interface function as a place to finalize.
3577 FinishModule();
Craig Topper8a13c412014-05-21 05:09:00 +00003578 return nullptr;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003579}
3580
Chris Lattnerd4808922009-03-22 21:03:39 +00003581llvm::Constant *CGObjCMac::GetPropertyGetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003582 return ObjCTypes.getGetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003583}
3584
Chris Lattnerd4808922009-03-22 21:03:39 +00003585llvm::Constant *CGObjCMac::GetPropertySetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003586 return ObjCTypes.getSetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003587}
3588
Ted Kremeneke65b0862012-03-06 20:05:56 +00003589llvm::Constant *CGObjCMac::GetOptimizedPropertySetFunction(bool atomic,
3590 bool copy) {
3591 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
3592}
3593
David Chisnall168b80f2010-12-26 22:13:16 +00003594llvm::Constant *CGObjCMac::GetGetStructFunction() {
3595 return ObjCTypes.getCopyStructFn();
3596}
3597llvm::Constant *CGObjCMac::GetSetStructFunction() {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00003598 return ObjCTypes.getCopyStructFn();
3599}
3600
David Chisnall0d75e062012-12-17 18:54:24 +00003601llvm::Constant *CGObjCMac::GetCppAtomicObjectGetFunction() {
3602 return ObjCTypes.getCppAtomicObjectFunction();
3603}
3604llvm::Constant *CGObjCMac::GetCppAtomicObjectSetFunction() {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00003605 return ObjCTypes.getCppAtomicObjectFunction();
3606}
3607
Chris Lattnerd4808922009-03-22 21:03:39 +00003608llvm::Constant *CGObjCMac::EnumerationMutationFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003609 return ObjCTypes.getEnumerationMutationFn();
Anders Carlsson3f35a262008-08-31 04:05:03 +00003610}
3611
John McCallbd309292010-07-06 01:34:17 +00003612void CGObjCMac::EmitTryStmt(CodeGenFunction &CGF, const ObjCAtTryStmt &S) {
3613 return EmitTryOrSynchronizedStmt(CGF, S);
3614}
3615
3616void CGObjCMac::EmitSynchronizedStmt(CodeGenFunction &CGF,
3617 const ObjCAtSynchronizedStmt &S) {
3618 return EmitTryOrSynchronizedStmt(CGF, S);
3619}
3620
John McCall65bea082010-07-21 06:59:36 +00003621namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00003622 struct PerformFragileFinally final : EHScopeStack::Cleanup {
John McCall65bea082010-07-21 06:59:36 +00003623 const Stmt &S;
John McCall7f416cc2015-09-08 08:05:57 +00003624 Address SyncArgSlot;
3625 Address CallTryExitVar;
3626 Address ExceptionData;
John McCall65bea082010-07-21 06:59:36 +00003627 ObjCTypesHelper &ObjCTypes;
3628 PerformFragileFinally(const Stmt *S,
John McCall7f416cc2015-09-08 08:05:57 +00003629 Address SyncArgSlot,
3630 Address CallTryExitVar,
3631 Address ExceptionData,
John McCall65bea082010-07-21 06:59:36 +00003632 ObjCTypesHelper *ObjCTypes)
John McCall2dd7d442010-08-04 05:59:32 +00003633 : S(*S), SyncArgSlot(SyncArgSlot), CallTryExitVar(CallTryExitVar),
John McCall65bea082010-07-21 06:59:36 +00003634 ExceptionData(ExceptionData), ObjCTypes(*ObjCTypes) {}
3635
Craig Topper4f12f102014-03-12 06:41:41 +00003636 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall65bea082010-07-21 06:59:36 +00003637 // Check whether we need to call objc_exception_try_exit.
3638 // In optimized code, this branch will always be folded.
3639 llvm::BasicBlock *FinallyCallExit =
3640 CGF.createBasicBlock("finally.call_exit");
3641 llvm::BasicBlock *FinallyNoCallExit =
3642 CGF.createBasicBlock("finally.no_call_exit");
3643 CGF.Builder.CreateCondBr(CGF.Builder.CreateLoad(CallTryExitVar),
3644 FinallyCallExit, FinallyNoCallExit);
3645
3646 CGF.EmitBlock(FinallyCallExit);
John McCall882987f2013-02-28 19:01:20 +00003647 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryExitFn(),
John McCall7f416cc2015-09-08 08:05:57 +00003648 ExceptionData.getPointer());
John McCall65bea082010-07-21 06:59:36 +00003649
3650 CGF.EmitBlock(FinallyNoCallExit);
3651
3652 if (isa<ObjCAtTryStmt>(S)) {
3653 if (const ObjCAtFinallyStmt* FinallyStmt =
John McCallcebe0ca2010-08-11 00:16:14 +00003654 cast<ObjCAtTryStmt>(S).getFinallyStmt()) {
John McCall638d4f52013-04-03 00:56:07 +00003655 // Don't try to do the @finally if this is an EH cleanup.
3656 if (flags.isForEHCleanup()) return;
3657
John McCallcebe0ca2010-08-11 00:16:14 +00003658 // Save the current cleanup destination in case there's
3659 // control flow inside the finally statement.
3660 llvm::Value *CurCleanupDest =
3661 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot());
3662
John McCall65bea082010-07-21 06:59:36 +00003663 CGF.EmitStmt(FinallyStmt->getFinallyBody());
3664
John McCallcebe0ca2010-08-11 00:16:14 +00003665 if (CGF.HaveInsertPoint()) {
3666 CGF.Builder.CreateStore(CurCleanupDest,
3667 CGF.getNormalCleanupDestSlot());
3668 } else {
3669 // Currently, the end of the cleanup must always exist.
3670 CGF.EnsureInsertPoint();
3671 }
3672 }
John McCall65bea082010-07-21 06:59:36 +00003673 } else {
3674 // Emit objc_sync_exit(expr); as finally's sole statement for
3675 // @synchronized.
John McCall2dd7d442010-08-04 05:59:32 +00003676 llvm::Value *SyncArg = CGF.Builder.CreateLoad(SyncArgSlot);
John McCall882987f2013-02-28 19:01:20 +00003677 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncExitFn(), SyncArg);
John McCall65bea082010-07-21 06:59:36 +00003678 }
3679 }
3680 };
John McCall42227ed2010-07-31 23:20:56 +00003681
3682 class FragileHazards {
3683 CodeGenFunction &CGF;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003684 SmallVector<llvm::Value*, 20> Locals;
John McCall42227ed2010-07-31 23:20:56 +00003685 llvm::DenseSet<llvm::BasicBlock*> BlocksBeforeTry;
3686
3687 llvm::InlineAsm *ReadHazard;
3688 llvm::InlineAsm *WriteHazard;
3689
3690 llvm::FunctionType *GetAsmFnType();
3691
3692 void collectLocals();
3693 void emitReadHazard(CGBuilderTy &Builder);
3694
3695 public:
3696 FragileHazards(CodeGenFunction &CGF);
John McCall2dd7d442010-08-04 05:59:32 +00003697
John McCall42227ed2010-07-31 23:20:56 +00003698 void emitWriteHazard();
John McCall2dd7d442010-08-04 05:59:32 +00003699 void emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00003700 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00003701}
John McCall42227ed2010-07-31 23:20:56 +00003702
3703/// Create the fragile-ABI read and write hazards based on the current
3704/// state of the function, which is presumed to be immediately prior
3705/// to a @try block. These hazards are used to maintain correct
3706/// semantics in the face of optimization and the fragile ABI's
3707/// cavalier use of setjmp/longjmp.
3708FragileHazards::FragileHazards(CodeGenFunction &CGF) : CGF(CGF) {
3709 collectLocals();
3710
3711 if (Locals.empty()) return;
3712
3713 // Collect all the blocks in the function.
3714 for (llvm::Function::iterator
3715 I = CGF.CurFn->begin(), E = CGF.CurFn->end(); I != E; ++I)
3716 BlocksBeforeTry.insert(&*I);
3717
3718 llvm::FunctionType *AsmFnTy = GetAsmFnType();
3719
3720 // Create a read hazard for the allocas. This inhibits dead-store
3721 // optimizations and forces the values to memory. This hazard is
3722 // inserted before any 'throwing' calls in the protected scope to
3723 // reflect the possibility that the variables might be read from the
3724 // catch block if the call throws.
3725 {
3726 std::string Constraint;
3727 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3728 if (I) Constraint += ',';
3729 Constraint += "*m";
3730 }
3731
3732 ReadHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3733 }
3734
3735 // Create a write hazard for the allocas. This inhibits folding
3736 // loads across the hazard. This hazard is inserted at the
3737 // beginning of the catch path to reflect the possibility that the
3738 // variables might have been written within the protected scope.
3739 {
3740 std::string Constraint;
3741 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3742 if (I) Constraint += ',';
3743 Constraint += "=*m";
3744 }
3745
3746 WriteHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3747 }
3748}
3749
3750/// Emit a write hazard at the current location.
3751void FragileHazards::emitWriteHazard() {
3752 if (Locals.empty()) return;
3753
John McCall882987f2013-02-28 19:01:20 +00003754 CGF.EmitNounwindRuntimeCall(WriteHazard, Locals);
John McCall42227ed2010-07-31 23:20:56 +00003755}
3756
John McCall42227ed2010-07-31 23:20:56 +00003757void FragileHazards::emitReadHazard(CGBuilderTy &Builder) {
3758 assert(!Locals.empty());
John McCall882987f2013-02-28 19:01:20 +00003759 llvm::CallInst *call = Builder.CreateCall(ReadHazard, Locals);
3760 call->setDoesNotThrow();
3761 call->setCallingConv(CGF.getRuntimeCC());
John McCall42227ed2010-07-31 23:20:56 +00003762}
3763
3764/// Emit read hazards in all the protected blocks, i.e. all the blocks
3765/// which have been inserted since the beginning of the try.
John McCall2dd7d442010-08-04 05:59:32 +00003766void FragileHazards::emitHazardsInNewBlocks() {
John McCall42227ed2010-07-31 23:20:56 +00003767 if (Locals.empty()) return;
3768
John McCall7f416cc2015-09-08 08:05:57 +00003769 CGBuilderTy Builder(CGF, CGF.getLLVMContext());
John McCall42227ed2010-07-31 23:20:56 +00003770
3771 // Iterate through all blocks, skipping those prior to the try.
3772 for (llvm::Function::iterator
3773 FI = CGF.CurFn->begin(), FE = CGF.CurFn->end(); FI != FE; ++FI) {
3774 llvm::BasicBlock &BB = *FI;
3775 if (BlocksBeforeTry.count(&BB)) continue;
3776
3777 // Walk through all the calls in the block.
3778 for (llvm::BasicBlock::iterator
3779 BI = BB.begin(), BE = BB.end(); BI != BE; ++BI) {
3780 llvm::Instruction &I = *BI;
3781
3782 // Ignore instructions that aren't non-intrinsic calls.
3783 // These are the only calls that can possibly call longjmp.
3784 if (!isa<llvm::CallInst>(I) && !isa<llvm::InvokeInst>(I)) continue;
3785 if (isa<llvm::IntrinsicInst>(I))
3786 continue;
3787
3788 // Ignore call sites marked nounwind. This may be questionable,
3789 // since 'nounwind' doesn't necessarily mean 'does not call longjmp'.
3790 llvm::CallSite CS(&I);
3791 if (CS.doesNotThrow()) continue;
3792
John McCall2dd7d442010-08-04 05:59:32 +00003793 // Insert a read hazard before the call. This will ensure that
3794 // any writes to the locals are performed before making the
3795 // call. If the call throws, then this is sufficient to
3796 // guarantee correctness as long as it doesn't also write to any
3797 // locals.
John McCall42227ed2010-07-31 23:20:56 +00003798 Builder.SetInsertPoint(&BB, BI);
3799 emitReadHazard(Builder);
3800 }
3801 }
3802}
3803
3804static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, llvm::Value *V) {
3805 if (V) S.insert(V);
3806}
3807
John McCall7f416cc2015-09-08 08:05:57 +00003808static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, Address V) {
3809 if (V.isValid()) S.insert(V.getPointer());
3810}
3811
John McCall42227ed2010-07-31 23:20:56 +00003812void FragileHazards::collectLocals() {
3813 // Compute a set of allocas to ignore.
3814 llvm::DenseSet<llvm::Value*> AllocasToIgnore;
3815 addIfPresent(AllocasToIgnore, CGF.ReturnValue);
3816 addIfPresent(AllocasToIgnore, CGF.NormalCleanupDest);
John McCall42227ed2010-07-31 23:20:56 +00003817
3818 // Collect all the allocas currently in the function. This is
3819 // probably way too aggressive.
3820 llvm::BasicBlock &Entry = CGF.CurFn->getEntryBlock();
3821 for (llvm::BasicBlock::iterator
3822 I = Entry.begin(), E = Entry.end(); I != E; ++I)
3823 if (isa<llvm::AllocaInst>(*I) && !AllocasToIgnore.count(&*I))
3824 Locals.push_back(&*I);
3825}
3826
3827llvm::FunctionType *FragileHazards::GetAsmFnType() {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003828 SmallVector<llvm::Type *, 16> tys(Locals.size());
John McCall9dc0db22011-05-15 01:53:33 +00003829 for (unsigned i = 0, e = Locals.size(); i != e; ++i)
3830 tys[i] = Locals[i]->getType();
3831 return llvm::FunctionType::get(CGF.VoidTy, tys, false);
John McCall65bea082010-07-21 06:59:36 +00003832}
3833
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003834/*
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003835
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003836 Objective-C setjmp-longjmp (sjlj) Exception Handling
3837 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003838
John McCallbd309292010-07-06 01:34:17 +00003839 A catch buffer is a setjmp buffer plus:
3840 - a pointer to the exception that was caught
3841 - a pointer to the previous exception data buffer
3842 - two pointers of reserved storage
3843 Therefore catch buffers form a stack, with a pointer to the top
3844 of the stack kept in thread-local storage.
3845
3846 objc_exception_try_enter pushes a catch buffer onto the EH stack.
3847 objc_exception_try_exit pops the given catch buffer, which is
3848 required to be the top of the EH stack.
3849 objc_exception_throw pops the top of the EH stack, writes the
3850 thrown exception into the appropriate field, and longjmps
3851 to the setjmp buffer. It crashes the process (with a printf
3852 and an abort()) if there are no catch buffers on the stack.
3853 objc_exception_extract just reads the exception pointer out of the
3854 catch buffer.
3855
3856 There's no reason an implementation couldn't use a light-weight
3857 setjmp here --- something like __builtin_setjmp, but API-compatible
3858 with the heavyweight setjmp. This will be more important if we ever
3859 want to implement correct ObjC/C++ exception interactions for the
3860 fragile ABI.
3861
3862 Note that for this use of setjmp/longjmp to be correct, we may need
3863 to mark some local variables volatile: if a non-volatile local
3864 variable is modified between the setjmp and the longjmp, it has
3865 indeterminate value. For the purposes of LLVM IR, it may be
3866 sufficient to make loads and stores within the @try (to variables
3867 declared outside the @try) volatile. This is necessary for
3868 optimized correctness, but is not currently being done; this is
3869 being tracked as rdar://problem/8160285
3870
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003871 The basic framework for a @try-catch-finally is as follows:
3872 {
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003873 objc_exception_data d;
3874 id _rethrow = null;
Anders Carlssonda0e4562009-02-07 21:26:04 +00003875 bool _call_try_exit = true;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003876
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003877 objc_exception_try_enter(&d);
3878 if (!setjmp(d.jmp_buf)) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003879 ... try body ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003880 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003881 // exception path
3882 id _caught = objc_exception_extract(&d);
3883
3884 // enter new try scope for handlers
3885 if (!setjmp(d.jmp_buf)) {
3886 ... match exception and execute catch blocks ...
3887
3888 // fell off end, rethrow.
3889 _rethrow = _caught;
3890 ... jump-through-finally to finally_rethrow ...
3891 } else {
3892 // exception in catch block
3893 _rethrow = objc_exception_extract(&d);
3894 _call_try_exit = false;
3895 ... jump-through-finally to finally_rethrow ...
3896 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003897 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003898 ... jump-through-finally to finally_end ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003899
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003900 finally:
Anders Carlssonda0e4562009-02-07 21:26:04 +00003901 if (_call_try_exit)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003902 objc_exception_try_exit(&d);
Anders Carlssonda0e4562009-02-07 21:26:04 +00003903
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003904 ... finally block ....
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003905 ... dispatch to finally destination ...
3906
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003907 finally_rethrow:
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003908 objc_exception_throw(_rethrow);
3909
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003910 finally_end:
3911 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003912
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003913 This framework differs slightly from the one gcc uses, in that gcc
3914 uses _rethrow to determine if objc_exception_try_exit should be called
3915 and if the object should be rethrown. This breaks in the face of
3916 throwing nil and introduces unnecessary branches.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003917
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003918 We specialize this framework for a few particular circumstances:
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003919
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003920 - If there are no catch blocks, then we avoid emitting the second
3921 exception handling context.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003922
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003923 - If there is a catch-all catch block (i.e. @catch(...) or @catch(id
3924 e)) we avoid emitting the code to rethrow an uncaught exception.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003925
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003926 - FIXME: If there is no @finally block we can do a few more
3927 simplifications.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003928
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003929 Rethrows and Jumps-Through-Finally
3930 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003931
John McCallbd309292010-07-06 01:34:17 +00003932 '@throw;' is supported by pushing the currently-caught exception
3933 onto ObjCEHStack while the @catch blocks are emitted.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003934
John McCallbd309292010-07-06 01:34:17 +00003935 Branches through the @finally block are handled with an ordinary
3936 normal cleanup. We do not register an EH cleanup; fragile-ABI ObjC
3937 exceptions are not compatible with C++ exceptions, and this is
3938 hardly the only place where this will go wrong.
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003939
John McCallbd309292010-07-06 01:34:17 +00003940 @synchronized(expr) { stmt; } is emitted as if it were:
3941 id synch_value = expr;
3942 objc_sync_enter(synch_value);
3943 @try { stmt; } @finally { objc_sync_exit(synch_value); }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003944*/
3945
Fariborz Jahanianc2ad6dc2008-11-21 00:49:24 +00003946void CGObjCMac::EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
3947 const Stmt &S) {
3948 bool isTry = isa<ObjCAtTryStmt>(S);
John McCallbd309292010-07-06 01:34:17 +00003949
3950 // A destination for the fall-through edges of the catch handlers to
3951 // jump to.
3952 CodeGenFunction::JumpDest FinallyEnd =
3953 CGF.getJumpDestInCurrentScope("finally.end");
3954
3955 // A destination for the rethrow edge of the catch handlers to jump
3956 // to.
3957 CodeGenFunction::JumpDest FinallyRethrow =
3958 CGF.getJumpDestInCurrentScope("finally.rethrow");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003959
Daniel Dunbar94ceb612009-02-24 01:43:46 +00003960 // For @synchronized, call objc_sync_enter(sync.expr). The
3961 // evaluation of the expression must occur before we enter the
John McCall2dd7d442010-08-04 05:59:32 +00003962 // @synchronized. We can't avoid a temp here because we need the
3963 // value to be preserved. If the backend ever does liveness
3964 // correctly after setjmp, this will be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00003965 Address SyncArgSlot = Address::invalid();
Daniel Dunbar94ceb612009-02-24 01:43:46 +00003966 if (!isTry) {
John McCall2dd7d442010-08-04 05:59:32 +00003967 llvm::Value *SyncArg =
Daniel Dunbar94ceb612009-02-24 01:43:46 +00003968 CGF.EmitScalarExpr(cast<ObjCAtSynchronizedStmt>(S).getSynchExpr());
3969 SyncArg = CGF.Builder.CreateBitCast(SyncArg, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00003970 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncEnterFn(), SyncArg);
John McCall2dd7d442010-08-04 05:59:32 +00003971
John McCall7f416cc2015-09-08 08:05:57 +00003972 SyncArgSlot = CGF.CreateTempAlloca(SyncArg->getType(),
3973 CGF.getPointerAlign(), "sync.arg");
John McCall2dd7d442010-08-04 05:59:32 +00003974 CGF.Builder.CreateStore(SyncArg, SyncArgSlot);
Daniel Dunbar94ceb612009-02-24 01:43:46 +00003975 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003976
John McCall2dd7d442010-08-04 05:59:32 +00003977 // Allocate memory for the setjmp buffer. This needs to be kept
3978 // live throughout the try and catch blocks.
John McCall7f416cc2015-09-08 08:05:57 +00003979 Address ExceptionData = CGF.CreateTempAlloca(ObjCTypes.ExceptionDataTy,
3980 CGF.getPointerAlign(),
3981 "exceptiondata.ptr");
John McCall2dd7d442010-08-04 05:59:32 +00003982
John McCall42227ed2010-07-31 23:20:56 +00003983 // Create the fragile hazards. Note that this will not capture any
3984 // of the allocas required for exception processing, but will
3985 // capture the current basic block (which extends all the way to the
3986 // setjmp call) as "before the @try".
3987 FragileHazards Hazards(CGF);
3988
John McCallbd309292010-07-06 01:34:17 +00003989 // Create a flag indicating whether the cleanup needs to call
3990 // objc_exception_try_exit. This is true except when
3991 // - no catches match and we're branching through the cleanup
3992 // just to rethrow the exception, or
3993 // - a catch matched and we're falling out of the catch handler.
John McCall2dd7d442010-08-04 05:59:32 +00003994 // The setjmp-safety rule here is that we should always store to this
3995 // variable in a place that dominates the branch through the cleanup
3996 // without passing through any setjmps.
John McCall7f416cc2015-09-08 08:05:57 +00003997 Address CallTryExitVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(),
3998 CharUnits::One(),
3999 "_call_try_exit");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004000
John McCall9916e3f2010-10-04 23:42:51 +00004001 // A slot containing the exception to rethrow. Only needed when we
4002 // have both a @catch and a @finally.
John McCall7f416cc2015-09-08 08:05:57 +00004003 Address PropagatingExnVar = Address::invalid();
John McCall9916e3f2010-10-04 23:42:51 +00004004
John McCallbd309292010-07-06 01:34:17 +00004005 // Push a normal cleanup to leave the try scope.
John McCall638d4f52013-04-03 00:56:07 +00004006 CGF.EHStack.pushCleanup<PerformFragileFinally>(NormalAndEHCleanup, &S,
John McCall2dd7d442010-08-04 05:59:32 +00004007 SyncArgSlot,
John McCallcda666c2010-07-21 07:22:38 +00004008 CallTryExitVar,
4009 ExceptionData,
4010 &ObjCTypes);
John McCallbd309292010-07-06 01:34:17 +00004011
4012 // Enter a try block:
4013 // - Call objc_exception_try_enter to push ExceptionData on top of
4014 // the EH stack.
Nico Weber6307cf02015-02-26 20:43:00 +00004015 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004016 ExceptionData.getPointer());
John McCallbd309292010-07-06 01:34:17 +00004017
4018 // - Call setjmp on the exception data buffer.
4019 llvm::Constant *Zero = llvm::ConstantInt::get(CGF.Builder.getInt32Ty(), 0);
4020 llvm::Value *GEPIndexes[] = { Zero, Zero, Zero };
David Blaikie6b2a8302015-04-03 17:47:16 +00004021 llvm::Value *SetJmpBuffer = CGF.Builder.CreateGEP(
John McCall7f416cc2015-09-08 08:05:57 +00004022 ObjCTypes.ExceptionDataTy, ExceptionData.getPointer(), GEPIndexes,
4023 "setjmp_buffer");
Nico Weber6307cf02015-02-26 20:43:00 +00004024 llvm::CallInst *SetJmpResult = CGF.EmitNounwindRuntimeCall(
4025 ObjCTypes.getSetJmpFn(), SetJmpBuffer, "setjmp_result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004026 SetJmpResult->setCanReturnTwice();
John McCallbd309292010-07-06 01:34:17 +00004027
4028 // If setjmp returned 0, enter the protected block; otherwise,
4029 // branch to the handler.
Daniel Dunbar75283ff2008-11-11 02:29:29 +00004030 llvm::BasicBlock *TryBlock = CGF.createBasicBlock("try");
4031 llvm::BasicBlock *TryHandler = CGF.createBasicBlock("try.handler");
John McCallbd309292010-07-06 01:34:17 +00004032 llvm::Value *DidCatch =
John McCallcebe0ca2010-08-11 00:16:14 +00004033 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4034 CGF.Builder.CreateCondBr(DidCatch, TryHandler, TryBlock);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004035
John McCallbd309292010-07-06 01:34:17 +00004036 // Emit the protected block.
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004037 CGF.EmitBlock(TryBlock);
John McCall2dd7d442010-08-04 05:59:32 +00004038 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004039 CGF.EmitStmt(isTry ? cast<ObjCAtTryStmt>(S).getTryBody()
John McCallbd309292010-07-06 01:34:17 +00004040 : cast<ObjCAtSynchronizedStmt>(S).getSynchBody());
John McCall2dd7d442010-08-04 05:59:32 +00004041
4042 CGBuilderTy::InsertPoint TryFallthroughIP = CGF.Builder.saveAndClearIP();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004043
John McCallbd309292010-07-06 01:34:17 +00004044 // Emit the exception handler block.
Daniel Dunbar7f086782008-09-27 23:30:04 +00004045 CGF.EmitBlock(TryHandler);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004046
John McCall42227ed2010-07-31 23:20:56 +00004047 // Don't optimize loads of the in-scope locals across this point.
4048 Hazards.emitWriteHazard();
4049
John McCallbd309292010-07-06 01:34:17 +00004050 // For a @synchronized (or a @try with no catches), just branch
4051 // through the cleanup to the rethrow block.
4052 if (!isTry || !cast<ObjCAtTryStmt>(S).getNumCatchStmts()) {
4053 // Tell the cleanup not to re-pop the exit.
John McCall2dd7d442010-08-04 05:59:32 +00004054 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004055 CGF.EmitBranchThroughCleanup(FinallyRethrow);
John McCallbd309292010-07-06 01:34:17 +00004056
4057 // Otherwise, we have to match against the caught exceptions.
4058 } else {
John McCall2dd7d442010-08-04 05:59:32 +00004059 // Retrieve the exception object. We may emit multiple blocks but
4060 // nothing can cross this so the value is already in SSA form.
4061 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004062 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004063 ExceptionData.getPointer(), "caught");
John McCall2dd7d442010-08-04 05:59:32 +00004064
John McCallbd309292010-07-06 01:34:17 +00004065 // Push the exception to rethrow onto the EH value stack for the
4066 // benefit of any @throws in the handlers.
4067 CGF.ObjCEHValueStack.push_back(Caught);
4068
Douglas Gregor96c79492010-04-23 22:50:49 +00004069 const ObjCAtTryStmt* AtTryStmt = cast<ObjCAtTryStmt>(&S);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004070
Craig Topper8a13c412014-05-21 05:09:00 +00004071 bool HasFinally = (AtTryStmt->getFinallyStmt() != nullptr);
John McCallbd309292010-07-06 01:34:17 +00004072
Craig Topper8a13c412014-05-21 05:09:00 +00004073 llvm::BasicBlock *CatchBlock = nullptr;
4074 llvm::BasicBlock *CatchHandler = nullptr;
John McCall2dd7d442010-08-04 05:59:32 +00004075 if (HasFinally) {
John McCall9916e3f2010-10-04 23:42:51 +00004076 // Save the currently-propagating exception before
4077 // objc_exception_try_enter clears the exception slot.
4078 PropagatingExnVar = CGF.CreateTempAlloca(Caught->getType(),
John McCall7f416cc2015-09-08 08:05:57 +00004079 CGF.getPointerAlign(),
John McCall9916e3f2010-10-04 23:42:51 +00004080 "propagating_exception");
4081 CGF.Builder.CreateStore(Caught, PropagatingExnVar);
4082
John McCall2dd7d442010-08-04 05:59:32 +00004083 // Enter a new exception try block (in case a @catch block
4084 // throws an exception).
John McCall882987f2013-02-28 19:01:20 +00004085 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004086 ExceptionData.getPointer());
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004087
John McCall2dd7d442010-08-04 05:59:32 +00004088 llvm::CallInst *SetJmpResult =
John McCall882987f2013-02-28 19:01:20 +00004089 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSetJmpFn(),
4090 SetJmpBuffer, "setjmp.result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004091 SetJmpResult->setCanReturnTwice();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004092
John McCall2dd7d442010-08-04 05:59:32 +00004093 llvm::Value *Threw =
4094 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4095
4096 CatchBlock = CGF.createBasicBlock("catch");
4097 CatchHandler = CGF.createBasicBlock("catch_for_catch");
4098 CGF.Builder.CreateCondBr(Threw, CatchHandler, CatchBlock);
4099
4100 CGF.EmitBlock(CatchBlock);
4101 }
4102
4103 CGF.Builder.CreateStore(CGF.Builder.getInt1(HasFinally), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004104
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004105 // Handle catch list. As a special case we check if everything is
4106 // matched and avoid generating code for falling off the end if
4107 // so.
4108 bool AllMatched = false;
Douglas Gregor96c79492010-04-23 22:50:49 +00004109 for (unsigned I = 0, N = AtTryStmt->getNumCatchStmts(); I != N; ++I) {
4110 const ObjCAtCatchStmt *CatchStmt = AtTryStmt->getCatchStmt(I);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004111
Douglas Gregor46a572b2010-04-26 16:46:50 +00004112 const VarDecl *CatchParam = CatchStmt->getCatchParamDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00004113 const ObjCObjectPointerType *OPT = nullptr;
Daniel Dunbar523208f2008-09-27 07:36:24 +00004114
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004115 // catch(...) always matches.
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004116 if (!CatchParam) {
4117 AllMatched = true;
4118 } else {
John McCall9dd450b2009-09-21 23:43:11 +00004119 OPT = CatchParam->getType()->getAs<ObjCObjectPointerType>();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004120
John McCallbd309292010-07-06 01:34:17 +00004121 // catch(id e) always matches under this ABI, since only
4122 // ObjC exceptions end up here in the first place.
Daniel Dunbar86919f42008-09-27 22:21:14 +00004123 // FIXME: For the time being we also match id<X>; this should
4124 // be rejected by Sema instead.
Eli Friedman55179ca2009-07-11 00:57:02 +00004125 if (OPT && (OPT->isObjCIdType() || OPT->isObjCQualifiedIdType()))
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004126 AllMatched = true;
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004127 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004128
John McCallbd309292010-07-06 01:34:17 +00004129 // If this is a catch-all, we don't need to test anything.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004130 if (AllMatched) {
John McCallbd309292010-07-06 01:34:17 +00004131 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
4132
Anders Carlsson9396a892008-09-11 09:15:33 +00004133 if (CatchParam) {
John McCall1c9c3fd2010-10-15 04:57:14 +00004134 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004135 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
John McCallbd309292010-07-06 01:34:17 +00004136
4137 // These types work out because ConvertType(id) == i8*.
John McCall17f02752015-10-30 00:56:02 +00004138 EmitInitOfCatchParam(CGF, Caught, CatchParam);
Anders Carlsson9396a892008-09-11 09:15:33 +00004139 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004140
Anders Carlsson9396a892008-09-11 09:15:33 +00004141 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004142
4143 // The scope of the catch variable ends right here.
4144 CatchVarCleanups.ForceCleanup();
4145
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004146 CGF.EmitBranchThroughCleanup(FinallyEnd);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004147 break;
4148 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004149
Steve Naroff7cae42b2009-07-10 23:34:53 +00004150 assert(OPT && "Unexpected non-object pointer type in @catch");
John McCall96fa4842010-05-17 21:00:27 +00004151 const ObjCObjectType *ObjTy = OPT->getObjectType();
John McCallbd309292010-07-06 01:34:17 +00004152
4153 // FIXME: @catch (Class c) ?
John McCall96fa4842010-05-17 21:00:27 +00004154 ObjCInterfaceDecl *IDecl = ObjTy->getInterface();
4155 assert(IDecl && "Catch parameter must have Objective-C type!");
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004156
4157 // Check if the @catch block matches the exception object.
John McCall882987f2013-02-28 19:01:20 +00004158 llvm::Value *Class = EmitClassRef(CGF, IDecl);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004159
John McCall882987f2013-02-28 19:01:20 +00004160 llvm::Value *matchArgs[] = { Class, Caught };
John McCallbd309292010-07-06 01:34:17 +00004161 llvm::CallInst *Match =
John McCall882987f2013-02-28 19:01:20 +00004162 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionMatchFn(),
4163 matchArgs, "match");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004164
John McCallbd309292010-07-06 01:34:17 +00004165 llvm::BasicBlock *MatchedBlock = CGF.createBasicBlock("match");
4166 llvm::BasicBlock *NextCatchBlock = CGF.createBasicBlock("catch.next");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004167
4168 CGF.Builder.CreateCondBr(CGF.Builder.CreateIsNotNull(Match, "matched"),
Daniel Dunbar7f086782008-09-27 23:30:04 +00004169 MatchedBlock, NextCatchBlock);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004170
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004171 // Emit the @catch block.
4172 CGF.EmitBlock(MatchedBlock);
John McCallbd309292010-07-06 01:34:17 +00004173
4174 // Collect any cleanups for the catch variable. The scope lasts until
4175 // the end of the catch body.
John McCall2dd7d442010-08-04 05:59:32 +00004176 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
John McCallbd309292010-07-06 01:34:17 +00004177
John McCall1c9c3fd2010-10-15 04:57:14 +00004178 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004179 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004180
John McCallbd309292010-07-06 01:34:17 +00004181 // Initialize the catch variable.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004182 llvm::Value *Tmp =
4183 CGF.Builder.CreateBitCast(Caught,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004184 CGF.ConvertType(CatchParam->getType()));
John McCall17f02752015-10-30 00:56:02 +00004185 EmitInitOfCatchParam(CGF, Tmp, CatchParam);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004186
Anders Carlsson9396a892008-09-11 09:15:33 +00004187 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004188
4189 // We're done with the catch variable.
4190 CatchVarCleanups.ForceCleanup();
4191
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004192 CGF.EmitBranchThroughCleanup(FinallyEnd);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004193
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004194 CGF.EmitBlock(NextCatchBlock);
4195 }
4196
John McCallbd309292010-07-06 01:34:17 +00004197 CGF.ObjCEHValueStack.pop_back();
4198
John McCall2dd7d442010-08-04 05:59:32 +00004199 // If nothing wanted anything to do with the caught exception,
4200 // kill the extract call.
4201 if (Caught->use_empty())
4202 Caught->eraseFromParent();
4203
4204 if (!AllMatched)
4205 CGF.EmitBranchThroughCleanup(FinallyRethrow);
4206
4207 if (HasFinally) {
4208 // Emit the exception handler for the @catch blocks.
4209 CGF.EmitBlock(CatchHandler);
4210
4211 // In theory we might now need a write hazard, but actually it's
4212 // unnecessary because there's no local-accessing code between
4213 // the try's write hazard and here.
4214 //Hazards.emitWriteHazard();
4215
John McCall9916e3f2010-10-04 23:42:51 +00004216 // Extract the new exception and save it to the
4217 // propagating-exception slot.
John McCall7f416cc2015-09-08 08:05:57 +00004218 assert(PropagatingExnVar.isValid());
John McCall9916e3f2010-10-04 23:42:51 +00004219 llvm::CallInst *NewCaught =
John McCall882987f2013-02-28 19:01:20 +00004220 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004221 ExceptionData.getPointer(), "caught");
John McCall9916e3f2010-10-04 23:42:51 +00004222 CGF.Builder.CreateStore(NewCaught, PropagatingExnVar);
4223
John McCall2dd7d442010-08-04 05:59:32 +00004224 // Don't pop the catch handler; the throw already did.
4225 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004226 CGF.EmitBranchThroughCleanup(FinallyRethrow);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004227 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004228 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004229
John McCall42227ed2010-07-31 23:20:56 +00004230 // Insert read hazards as required in the new blocks.
John McCall2dd7d442010-08-04 05:59:32 +00004231 Hazards.emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00004232
John McCallbd309292010-07-06 01:34:17 +00004233 // Pop the cleanup.
John McCall2dd7d442010-08-04 05:59:32 +00004234 CGF.Builder.restoreIP(TryFallthroughIP);
4235 if (CGF.HaveInsertPoint())
4236 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
John McCallbd309292010-07-06 01:34:17 +00004237 CGF.PopCleanupBlock();
John McCall2dd7d442010-08-04 05:59:32 +00004238 CGF.EmitBlock(FinallyEnd.getBlock(), true);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004239
John McCallbd309292010-07-06 01:34:17 +00004240 // Emit the rethrow block.
John McCall42227ed2010-07-31 23:20:56 +00004241 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
John McCallad5d61e2010-07-23 21:56:41 +00004242 CGF.EmitBlock(FinallyRethrow.getBlock(), true);
John McCallbd309292010-07-06 01:34:17 +00004243 if (CGF.HaveInsertPoint()) {
John McCall9916e3f2010-10-04 23:42:51 +00004244 // If we have a propagating-exception variable, check it.
4245 llvm::Value *PropagatingExn;
John McCall7f416cc2015-09-08 08:05:57 +00004246 if (PropagatingExnVar.isValid()) {
John McCall9916e3f2010-10-04 23:42:51 +00004247 PropagatingExn = CGF.Builder.CreateLoad(PropagatingExnVar);
John McCall2dd7d442010-08-04 05:59:32 +00004248
John McCall9916e3f2010-10-04 23:42:51 +00004249 // Otherwise, just look in the buffer for the exception to throw.
4250 } else {
4251 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004252 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004253 ExceptionData.getPointer());
John McCall9916e3f2010-10-04 23:42:51 +00004254 PropagatingExn = Caught;
4255 }
4256
John McCall882987f2013-02-28 19:01:20 +00004257 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionThrowFn(),
4258 PropagatingExn);
John McCallbd309292010-07-06 01:34:17 +00004259 CGF.Builder.CreateUnreachable();
Fariborz Jahaniane2caaaa2008-11-21 19:21:53 +00004260 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004261
John McCall42227ed2010-07-31 23:20:56 +00004262 CGF.Builder.restoreIP(SavedIP);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004263}
4264
4265void CGObjCMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004266 const ObjCAtThrowStmt &S,
4267 bool ClearInsertionPoint) {
Anders Carlssone005aa12008-09-09 16:16:55 +00004268 llvm::Value *ExceptionAsObject;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004269
Anders Carlssone005aa12008-09-09 16:16:55 +00004270 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00004271 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004272 ExceptionAsObject =
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004273 CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
Anders Carlssone005aa12008-09-09 16:16:55 +00004274 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004275 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004276 "Unexpected rethrow outside @catch block.");
Anders Carlssonbf8a1be2009-02-07 21:37:21 +00004277 ExceptionAsObject = CGF.ObjCEHValueStack.back();
Anders Carlssone005aa12008-09-09 16:16:55 +00004278 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004279
John McCall882987f2013-02-28 19:01:20 +00004280 CGF.EmitRuntimeCall(ObjCTypes.getExceptionThrowFn(), ExceptionAsObject)
John McCallbd309292010-07-06 01:34:17 +00004281 ->setDoesNotReturn();
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004282 CGF.Builder.CreateUnreachable();
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004283
4284 // Clear the insertion point to indicate we are in unreachable code.
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004285 if (ClearInsertionPoint)
4286 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004287}
4288
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004289/// EmitObjCWeakRead - Code gen for loading value of a __weak
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004290/// object: objc_read_weak (id *src)
4291///
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004292llvm::Value * CGObjCMac::EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004293 Address AddrWeakObj) {
4294 llvm::Type* DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004295 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj,
4296 ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004297 llvm::Value *read_weak =
4298 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004299 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00004300 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004301 return read_weak;
4302}
4303
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004304/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
4305/// objc_assign_weak (id src, id *dst)
4306///
4307void CGObjCMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004308 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004309 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004310 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004311 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004312 assert(Size <= 8 && "does not support size > 8");
4313 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004314 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004315 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4316 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004317 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4318 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004319 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004320 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
4321 args, "weakassign");
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004322 return;
4323}
4324
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004325/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
4326/// objc_assign_global (id src, id *dst)
4327///
4328void CGObjCMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004329 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00004330 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004331 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004332 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004333 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004334 assert(Size <= 8 && "does not support size > 8");
4335 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004336 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004337 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4338 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004339 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4340 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004341 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00004342 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00004343 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
4344 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00004345 else
John McCall882987f2013-02-28 19:01:20 +00004346 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
4347 args, "threadlocalassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004348 return;
4349}
4350
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004351/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004352/// objc_assign_ivar (id src, id *dst, ptrdiff_t ivaroffset)
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004353///
4354void CGObjCMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004355 llvm::Value *src, Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004356 llvm::Value *ivarOffset) {
4357 assert(ivarOffset && "EmitObjCIvarAssign - ivarOffset is NULL");
Chris Lattner2192fe52011-07-18 04:24:23 +00004358 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004359 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004360 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004361 assert(Size <= 8 && "does not support size > 8");
4362 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004363 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004364 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4365 }
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004366 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4367 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004368 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00004369 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004370 return;
4371}
4372
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004373/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
4374/// objc_assign_strongCast (id src, id *dst)
4375///
4376void CGObjCMac::EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004377 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004378 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004379 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004380 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004381 assert(Size <= 8 && "does not support size > 8");
4382 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004383 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004384 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4385 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004386 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4387 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004388 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004389 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004390 args, "strongassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004391 return;
4392}
4393
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004394void CGObjCMac::EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004395 Address DestPtr,
4396 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00004397 llvm::Value *size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004398 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
4399 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004400 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), size };
John McCall882987f2013-02-28 19:01:20 +00004401 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004402}
4403
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004404/// EmitObjCValueForIvar - Code Gen for ivar reference.
4405///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004406LValue CGObjCMac::EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF,
4407 QualType ObjectTy,
4408 llvm::Value *BaseValue,
4409 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004410 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00004411 const ObjCInterfaceDecl *ID =
4412 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00004413 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
4414 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004415}
4416
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004417llvm::Value *CGObjCMac::EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00004418 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004419 const ObjCIvarDecl *Ivar) {
Eli Friedman8cbca202012-11-06 22:15:52 +00004420 uint64_t Offset = ComputeIvarBaseOffset(CGM, Interface, Ivar);
4421 return llvm::ConstantInt::get(
4422 CGM.getTypes().ConvertType(CGM.getContext().LongTy),
4423 Offset);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004424}
4425
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004426/* *** Private Interface *** */
4427
4428/// EmitImageInfo - Emit the image info marker used to encode some module
4429/// level information.
4430///
4431/// See: <rdr://4810609&4810587&4810587>
4432/// struct IMAGE_INFO {
4433/// unsigned version;
4434/// unsigned flags;
4435/// };
4436enum ImageInfoFlags {
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004437 eImageInfo_FixAndContinue = (1 << 0), // This flag is no longer set by clang.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004438 eImageInfo_GarbageCollected = (1 << 1),
4439 eImageInfo_GCOnly = (1 << 2),
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004440 eImageInfo_OptimizedByDyld = (1 << 3), // This flag is set by the dyld shared cache.
Daniel Dunbar75e909f2009-04-20 07:11:47 +00004441
Daniel Dunbar5e639272010-04-25 20:39:01 +00004442 // A flag indicating that the module has no instances of a @synthesize of a
4443 // superclass variable. <rdar://problem/6803242>
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004444 eImageInfo_CorrectedSynthesize = (1 << 4), // This flag is no longer set by clang.
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004445 eImageInfo_ImageIsSimulated = (1 << 5)
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004446};
4447
Daniel Dunbar5e639272010-04-25 20:39:01 +00004448void CGObjCCommonMac::EmitImageInfo() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004449 unsigned version = 0; // Version is unused?
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004450 const char *Section = (ObjCABI == 1) ?
4451 "__OBJC, __image_info,regular" :
4452 "__DATA, __objc_imageinfo, regular, no_dead_strip";
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004453
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004454 // Generate module-level named metadata to convey this information to the
4455 // linker and code-gen.
4456 llvm::Module &Mod = CGM.getModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004457
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004458 // Add the ObjC ABI version to the module flags.
4459 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Version", ObjCABI);
4460 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Version",
4461 version);
4462 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Section",
4463 llvm::MDString::get(VMContext,Section));
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004464
David Blaikiebbafb8a2012-03-11 07:00:24 +00004465 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004466 // Non-GC overrides those files which specify GC.
4467 Mod.addModuleFlag(llvm::Module::Override,
4468 "Objective-C Garbage Collection", (uint32_t)0);
4469 } else {
4470 // Add the ObjC garbage collection value.
4471 Mod.addModuleFlag(llvm::Module::Error,
4472 "Objective-C Garbage Collection",
4473 eImageInfo_GarbageCollected);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004474
David Blaikiebbafb8a2012-03-11 07:00:24 +00004475 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004476 // Add the ObjC GC Only value.
4477 Mod.addModuleFlag(llvm::Module::Error, "Objective-C GC Only",
4478 eImageInfo_GCOnly);
4479
4480 // Require that GC be specified and set to eImageInfo_GarbageCollected.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004481 llvm::Metadata *Ops[2] = {
4482 llvm::MDString::get(VMContext, "Objective-C Garbage Collection"),
4483 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
4484 llvm::Type::getInt32Ty(VMContext), eImageInfo_GarbageCollected))};
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004485 Mod.addModuleFlag(llvm::Module::Require, "Objective-C GC Only",
4486 llvm::MDNode::get(VMContext, Ops));
4487 }
4488 }
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004489
4490 // Indicate whether we're compiling this to run on a simulator.
4491 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Tim Northover756447a2015-10-30 16:30:36 +00004492 if ((Triple.isiOS() || Triple.isWatchOS()) &&
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004493 (Triple.getArch() == llvm::Triple::x86 ||
4494 Triple.getArch() == llvm::Triple::x86_64))
4495 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Is Simulated",
4496 eImageInfo_ImageIsSimulated);
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004497}
4498
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004499// struct objc_module {
4500// unsigned long version;
4501// unsigned long size;
4502// const char *name;
4503// Symtab symtab;
4504// };
4505
4506// FIXME: Get from somewhere
4507static const int ModuleVersion = 7;
4508
4509void CGObjCMac::EmitModuleInfo() {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004510 uint64_t Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ModuleTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004511
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004512 llvm::Constant *Values[] = {
4513 llvm::ConstantInt::get(ObjCTypes.LongTy, ModuleVersion),
4514 llvm::ConstantInt::get(ObjCTypes.LongTy, Size),
4515 // This used to be the filename, now it is unused. <rdr://4327263>
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004516 GetClassName(StringRef("")),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004517 EmitModuleSymbols()
4518 };
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004519 CreateMetadataVar("OBJC_MODULES",
Owen Anderson0e0189d2009-07-27 22:29:56 +00004520 llvm::ConstantStruct::get(ObjCTypes.ModuleTy, Values),
John McCall7f416cc2015-09-08 08:05:57 +00004521 "__OBJC,__module_info,regular,no_dead_strip",
4522 CGM.getPointerAlign(), true);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004523}
4524
4525llvm::Constant *CGObjCMac::EmitModuleSymbols() {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004526 unsigned NumClasses = DefinedClasses.size();
4527 unsigned NumCategories = DefinedCategories.size();
4528
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004529 // Return null if no symbols were defined.
4530 if (!NumClasses && !NumCategories)
Owen Anderson0b75f232009-07-31 20:28:54 +00004531 return llvm::Constant::getNullValue(ObjCTypes.SymtabPtrTy);
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004532
Chris Lattnere64d7ba2011-06-20 04:01:35 +00004533 llvm::Constant *Values[5];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00004534 Values[0] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
Owen Anderson0b75f232009-07-31 20:28:54 +00004535 Values[1] = llvm::Constant::getNullValue(ObjCTypes.SelectorPtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00004536 Values[2] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumClasses);
4537 Values[3] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumCategories);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004538
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004539 // The runtime expects exactly the list of defined classes followed
4540 // by the list of defined categories, in a single array.
Chris Lattner3def9ae2012-02-06 22:16:34 +00004541 SmallVector<llvm::Constant*, 8> Symbols(NumClasses + NumCategories);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004542 for (unsigned i=0; i<NumClasses; i++) {
4543 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
4544 assert(ID);
4545 if (ObjCImplementationDecl *IMP = ID->getImplementation())
4546 // We are implementing a weak imported interface. Give it external linkage
4547 if (ID->isWeakImported() && !IMP->isWeakImported())
4548 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
4549
Owen Andersonade90fd2009-07-29 18:54:39 +00004550 Symbols[i] = llvm::ConstantExpr::getBitCast(DefinedClasses[i],
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004551 ObjCTypes.Int8PtrTy);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004552 }
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004553 for (unsigned i=0; i<NumCategories; i++)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004554 Symbols[NumClasses + i] =
Owen Andersonade90fd2009-07-29 18:54:39 +00004555 llvm::ConstantExpr::getBitCast(DefinedCategories[i],
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004556 ObjCTypes.Int8PtrTy);
4557
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004558 Values[4] =
Owen Anderson9793f0e2009-07-29 22:16:19 +00004559 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00004560 Symbols.size()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004561 Symbols);
4562
Chris Lattnere64d7ba2011-06-20 04:01:35 +00004563 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004564
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004565 llvm::GlobalVariable *GV = CreateMetadataVar(
John McCall7f416cc2015-09-08 08:05:57 +00004566 "OBJC_SYMBOLS", Init, "__OBJC,__symbols,regular,no_dead_strip",
4567 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00004568 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.SymtabPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004569}
4570
John McCall882987f2013-02-28 19:01:20 +00004571llvm::Value *CGObjCMac::EmitClassRefFromId(CodeGenFunction &CGF,
4572 IdentifierInfo *II) {
John McCall31168b02011-06-15 23:02:42 +00004573 LazySymbols.insert(II);
4574
4575 llvm::GlobalVariable *&Entry = ClassReferences[II];
4576
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004577 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004578 llvm::Constant *Casted =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004579 llvm::ConstantExpr::getBitCast(GetClassName(II->getName()),
John McCall31168b02011-06-15 23:02:42 +00004580 ObjCTypes.ClassPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004581 Entry = CreateMetadataVar(
4582 "OBJC_CLASS_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004583 "__OBJC,__cls_refs,literal_pointers,no_dead_strip",
4584 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004585 }
John McCall31168b02011-06-15 23:02:42 +00004586
John McCall7f416cc2015-09-08 08:05:57 +00004587 return CGF.Builder.CreateAlignedLoad(Entry, CGF.getPointerAlign());
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004588}
4589
John McCall882987f2013-02-28 19:01:20 +00004590llvm::Value *CGObjCMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00004591 const ObjCInterfaceDecl *ID) {
John McCall882987f2013-02-28 19:01:20 +00004592 return EmitClassRefFromId(CGF, ID->getIdentifier());
John McCall31168b02011-06-15 23:02:42 +00004593}
4594
John McCall882987f2013-02-28 19:01:20 +00004595llvm::Value *CGObjCMac::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00004596 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCall882987f2013-02-28 19:01:20 +00004597 return EmitClassRefFromId(CGF, II);
John McCall31168b02011-06-15 23:02:42 +00004598}
4599
John McCall7f416cc2015-09-08 08:05:57 +00004600llvm::Value *CGObjCMac::EmitSelector(CodeGenFunction &CGF, Selector Sel) {
4601 return CGF.Builder.CreateLoad(EmitSelectorAddr(CGF, Sel));
4602}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004603
John McCall7f416cc2015-09-08 08:05:57 +00004604Address CGObjCMac::EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel) {
4605 CharUnits Align = CGF.getPointerAlign();
4606
4607 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004608 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004609 llvm::Constant *Casted =
Owen Andersonade90fd2009-07-29 18:54:39 +00004610 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004611 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004612 Entry = CreateMetadataVar(
4613 "OBJC_SELECTOR_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004614 "__OBJC,__message_refs,literal_pointers,no_dead_strip", Align, true);
Michael Gottesman5c205962013-02-05 23:08:45 +00004615 Entry->setExternallyInitialized(true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004616 }
4617
John McCall7f416cc2015-09-08 08:05:57 +00004618 return Address(Entry, Align);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004619}
4620
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004621llvm::Constant *CGObjCCommonMac::GetClassName(StringRef RuntimeName) {
4622 llvm::GlobalVariable *&Entry = ClassNames[RuntimeName];
4623 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004624 Entry = CreateMetadataVar(
4625 "OBJC_CLASS_NAME_",
4626 llvm::ConstantDataArray::getString(VMContext, RuntimeName),
4627 ((ObjCABI == 2) ? "__TEXT,__objc_classname,cstring_literals"
4628 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004629 CharUnits::One(), true);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004630 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004631}
4632
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004633llvm::Function *CGObjCCommonMac::GetMethodDefinition(const ObjCMethodDecl *MD) {
4634 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*>::iterator
4635 I = MethodDefinitions.find(MD);
4636 if (I != MethodDefinitions.end())
4637 return I->second;
4638
Craig Topper8a13c412014-05-21 05:09:00 +00004639 return nullptr;
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004640}
4641
Fariborz Jahanian01dff422009-03-05 19:17:31 +00004642/// GetIvarLayoutName - Returns a unique constant for the given
4643/// ivar layout bitmap.
4644llvm::Constant *CGObjCCommonMac::GetIvarLayoutName(IdentifierInfo *Ident,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004645 const ObjCCommonTypesHelper &ObjCTypes) {
Owen Anderson0b75f232009-07-31 20:28:54 +00004646 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Fariborz Jahanian01dff422009-03-05 19:17:31 +00004647}
4648
John McCall3fd13f062015-10-21 18:06:47 +00004649void IvarLayoutBuilder::visitRecord(const RecordType *RT,
4650 CharUnits offset) {
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004651 const RecordDecl *RD = RT->getDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004652
John McCall3fd13f062015-10-21 18:06:47 +00004653 // If this is a union, remember that we had one, because it might mess
4654 // up the ordering of layout entries.
4655 if (RD->isUnion())
4656 IsDisordered = true;
4657
4658 const ASTRecordLayout *recLayout = nullptr;
4659 visitAggregate(RD->field_begin(), RD->field_end(), offset,
4660 [&](const FieldDecl *field) -> CharUnits {
4661 if (!recLayout)
4662 recLayout = &CGM.getContext().getASTRecordLayout(RD);
4663 auto offsetInBits = recLayout->getFieldOffset(field->getFieldIndex());
4664 return CGM.getContext().toCharUnitsFromBits(offsetInBits);
4665 });
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004666}
4667
John McCall3fd13f062015-10-21 18:06:47 +00004668template <class Iterator, class GetOffsetFn>
4669void IvarLayoutBuilder::visitAggregate(Iterator begin, Iterator end,
4670 CharUnits aggregateOffset,
4671 const GetOffsetFn &getOffset) {
4672 for (; begin != end; ++begin) {
4673 auto field = *begin;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004674
John McCall3fd13f062015-10-21 18:06:47 +00004675 // Skip over bitfields.
4676 if (field->isBitField()) {
4677 continue;
4678 }
4679
4680 // Compute the offset of the field within the aggregate.
4681 CharUnits fieldOffset = aggregateOffset + getOffset(field);
4682
4683 visitField(field, fieldOffset);
4684 }
4685}
4686
4687/// Collect layout information for the given fields into IvarsInfo.
4688void IvarLayoutBuilder::visitField(const FieldDecl *field,
4689 CharUnits fieldOffset) {
4690 QualType fieldType = field->getType();
4691
4692 // Drill down into arrays.
4693 uint64_t numElts = 1;
4694 while (auto arrayType = CGM.getContext().getAsConstantArrayType(fieldType)) {
4695 numElts *= arrayType->getSize().getZExtValue();
4696 fieldType = arrayType->getElementType();
4697 }
4698
4699 assert(!fieldType->isArrayType() && "ivar of non-constant array type?");
4700
4701 // If we ended up with a zero-sized array, we've done what we can do within
4702 // the limits of this layout encoding.
4703 if (numElts == 0) return;
4704
4705 // Recurse if the base element type is a record type.
4706 if (auto recType = fieldType->getAs<RecordType>()) {
4707 size_t oldEnd = IvarsInfo.size();
4708
4709 visitRecord(recType, fieldOffset);
4710
4711 // If we have an array, replicate the first entry's layout information.
4712 auto numEltEntries = IvarsInfo.size() - oldEnd;
4713 if (numElts != 1 && numEltEntries != 0) {
4714 CharUnits eltSize = CGM.getContext().getTypeSizeInChars(recType);
4715 for (uint64_t eltIndex = 1; eltIndex != numElts; ++eltIndex) {
4716 // Copy the last numEltEntries onto the end of the array, adjusting
4717 // each for the element size.
4718 for (size_t i = 0; i != numEltEntries; ++i) {
4719 auto firstEntry = IvarsInfo[oldEnd + i];
4720 IvarsInfo.push_back(IvarInfo(firstEntry.Offset + eltIndex * eltSize,
4721 firstEntry.SizeInWords));
4722 }
4723 }
4724 }
4725
Fariborz Jahanian524bb202009-03-10 16:22:08 +00004726 return;
Fariborz Jahanian3b0f8862009-03-11 00:07:04 +00004727 }
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004728
John McCall3fd13f062015-10-21 18:06:47 +00004729 // Classify the element type.
4730 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), fieldType);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004731
John McCall3fd13f062015-10-21 18:06:47 +00004732 // If it matches what we're looking for, add an entry.
4733 if ((ForStrongLayout && GCAttr == Qualifiers::Strong)
4734 || (!ForStrongLayout && GCAttr == Qualifiers::Weak)) {
4735 assert(CGM.getContext().getTypeSizeInChars(fieldType)
4736 == CGM.getPointerSize());
4737 IvarsInfo.push_back(IvarInfo(fieldOffset, numElts));
4738 }
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00004739}
4740
John McCall3fd13f062015-10-21 18:06:47 +00004741/// buildBitmap - This routine does the horsework of taking the offsets of
4742/// strong/weak references and creating a bitmap. The bitmap is also
4743/// returned in the given buffer, suitable for being passed to \c dump().
4744llvm::Constant *IvarLayoutBuilder::buildBitmap(CGObjCCommonMac &CGObjC,
4745 llvm::SmallVectorImpl<unsigned char> &buffer) {
4746 // The bitmap is a series of skip/scan instructions, aligned to word
4747 // boundaries. The skip is performed first.
4748 const unsigned char MaxNibble = 0xF;
4749 const unsigned char SkipMask = 0xF0, SkipShift = 4;
4750 const unsigned char ScanMask = 0x0F, ScanShift = 0;
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004751
John McCall3fd13f062015-10-21 18:06:47 +00004752 assert(!IvarsInfo.empty() && "generating bitmap for no data");
4753
4754 // Sort the ivar info on byte position in case we encounterred a
4755 // union nested in the ivar list.
4756 if (IsDisordered) {
4757 // This isn't a stable sort, but our algorithm should handle it fine.
4758 llvm::array_pod_sort(IvarsInfo.begin(), IvarsInfo.end());
4759 } else {
4760#ifndef NDEBUG
4761 for (unsigned i = 1; i != IvarsInfo.size(); ++i) {
4762 assert(IvarsInfo[i - 1].Offset <= IvarsInfo[i].Offset);
4763 }
4764#endif
4765 }
4766 assert(IvarsInfo.back().Offset < InstanceEnd);
4767
4768 assert(buffer.empty());
4769
4770 // Skip the next N words.
4771 auto skip = [&](unsigned numWords) {
4772 assert(numWords > 0);
4773
4774 // Try to merge into the previous byte. Since scans happen second, we
4775 // can't do this if it includes a scan.
4776 if (!buffer.empty() && !(buffer.back() & ScanMask)) {
4777 unsigned lastSkip = buffer.back() >> SkipShift;
4778 if (lastSkip < MaxNibble) {
4779 unsigned claimed = std::min(MaxNibble - lastSkip, numWords);
4780 numWords -= claimed;
4781 lastSkip += claimed;
4782 buffer.back() = (lastSkip << SkipShift);
4783 }
4784 }
4785
4786 while (numWords >= MaxNibble) {
4787 buffer.push_back(MaxNibble << SkipShift);
4788 numWords -= MaxNibble;
4789 }
4790 if (numWords) {
4791 buffer.push_back(numWords << SkipShift);
4792 }
4793 };
4794
4795 // Scan the next N words.
4796 auto scan = [&](unsigned numWords) {
4797 assert(numWords > 0);
4798
4799 // Try to merge into the previous byte. Since scans happen second, we can
4800 // do this even if it includes a skip.
4801 if (!buffer.empty()) {
4802 unsigned lastScan = (buffer.back() & ScanMask) >> ScanShift;
4803 if (lastScan < MaxNibble) {
4804 unsigned claimed = std::min(MaxNibble - lastScan, numWords);
4805 numWords -= claimed;
4806 lastScan += claimed;
4807 buffer.back() = (buffer.back() & SkipMask) | (lastScan << ScanShift);
4808 }
4809 }
4810
4811 while (numWords >= MaxNibble) {
4812 buffer.push_back(MaxNibble << ScanShift);
4813 numWords -= MaxNibble;
4814 }
4815 if (numWords) {
4816 buffer.push_back(numWords << ScanShift);
4817 }
4818 };
4819
4820 // One past the end of the last scan.
4821 unsigned endOfLastScanInWords = 0;
4822 const CharUnits WordSize = CGM.getPointerSize();
4823
4824 // Consider all the scan requests.
4825 for (auto &request : IvarsInfo) {
4826 CharUnits beginOfScan = request.Offset - InstanceBegin;
4827
4828 // Ignore scan requests that don't start at an even multiple of the
4829 // word size. We can't encode them.
4830 if ((beginOfScan % WordSize) != 0) continue;
4831
4832 // Ignore scan requests that start before the instance start.
4833 // This assumes that scans never span that boundary. The boundary
4834 // isn't the true start of the ivars, because in the fragile-ARC case
4835 // it's rounded up to word alignment, but the test above should leave
4836 // us ignoring that possibility.
4837 if (beginOfScan.isNegative()) {
4838 assert(request.Offset + request.SizeInWords * WordSize <= InstanceBegin);
4839 continue;
4840 }
4841
4842 unsigned beginOfScanInWords = beginOfScan / WordSize;
4843 unsigned endOfScanInWords = beginOfScanInWords + request.SizeInWords;
4844
4845 // If the scan starts some number of words after the last one ended,
4846 // skip forward.
4847 if (beginOfScanInWords > endOfLastScanInWords) {
4848 skip(beginOfScanInWords - endOfLastScanInWords);
4849
4850 // Otherwise, start scanning where the last left off.
4851 } else {
4852 beginOfScanInWords = endOfLastScanInWords;
4853
4854 // If that leaves us with nothing to scan, ignore this request.
4855 if (beginOfScanInWords >= endOfScanInWords) continue;
4856 }
4857
4858 // Scan to the end of the request.
4859 assert(beginOfScanInWords < endOfScanInWords);
4860 scan(endOfScanInWords - beginOfScanInWords);
4861 endOfLastScanInWords = endOfScanInWords;
4862 }
4863
John McCallf5ea0722015-10-29 23:36:14 +00004864 if (buffer.empty())
4865 return llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
4866
John McCall3fd13f062015-10-21 18:06:47 +00004867 // For GC layouts, emit a skip to the end of the allocation so that we
4868 // have precise information about the entire thing. This isn't useful
4869 // or necessary for the ARC-style layout strings.
4870 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
4871 unsigned lastOffsetInWords =
4872 (InstanceEnd - InstanceBegin + WordSize - CharUnits::One()) / WordSize;
4873 if (lastOffsetInWords > endOfLastScanInWords) {
4874 skip(lastOffsetInWords - endOfLastScanInWords);
4875 }
4876 }
4877
4878 // Null terminate the string.
4879 buffer.push_back(0);
4880
4881 bool isNonFragileABI = CGObjC.isNonFragileABI();
4882
4883 llvm::GlobalVariable *Entry = CGObjC.CreateMetadataVar(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004884 "OBJC_CLASS_NAME_",
John McCall3fd13f062015-10-21 18:06:47 +00004885 llvm::ConstantDataArray::get(CGM.getLLVMContext(), buffer),
4886 (isNonFragileABI ? "__TEXT,__objc_classname,cstring_literals"
4887 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004888 CharUnits::One(), true);
John McCall3fd13f062015-10-21 18:06:47 +00004889 return getConstantGEP(CGM.getLLVMContext(), Entry, 0, 0);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004890}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004891
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004892/// BuildIvarLayout - Builds ivar layout bitmap for the class
4893/// implementation for the __strong or __weak case.
4894/// The layout map displays which words in ivar list must be skipped
4895/// and which must be scanned by GC (see below). String is built of bytes.
4896/// Each byte is divided up in two nibbles (4-bit each). Left nibble is count
4897/// of words to skip and right nibble is count of words to scan. So, each
4898/// nibble represents up to 15 workds to skip or scan. Skipping the rest is
4899/// represented by a 0x00 byte which also ends the string.
4900/// 1. when ForStrongLayout is true, following ivars are scanned:
4901/// - id, Class
4902/// - object *
4903/// - __strong anything
4904///
4905/// 2. When ForStrongLayout is false, following ivars are scanned:
4906/// - __weak anything
4907///
John McCall3fd13f062015-10-21 18:06:47 +00004908llvm::Constant *
4909CGObjCCommonMac::BuildIvarLayout(const ObjCImplementationDecl *OMD,
4910 CharUnits beginOffset, CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +00004911 bool ForStrongLayout, bool HasMRCWeakIvars) {
4912 // If this is MRC, and we're either building a strong layout or there
4913 // are no weak ivars, bail out early.
Chris Lattnerece04092012-02-07 00:39:47 +00004914 llvm::Type *PtrTy = CGM.Int8PtrTy;
David Blaikiebbafb8a2012-03-11 07:00:24 +00004915 if (CGM.getLangOpts().getGC() == LangOptions::NonGC &&
John McCall460ce582015-10-22 18:38:17 +00004916 !CGM.getLangOpts().ObjCAutoRefCount &&
4917 (ForStrongLayout || !HasMRCWeakIvars))
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004918 return llvm::Constant::getNullValue(PtrTy);
4919
Jordy Rosea91768e2011-07-22 02:08:32 +00004920 const ObjCInterfaceDecl *OI = OMD->getClassInterface();
John McCall3fd13f062015-10-21 18:06:47 +00004921 SmallVector<const ObjCIvarDecl*, 32> ivars;
4922
4923 // GC layout strings include the complete object layout, possibly
4924 // inaccurately in the non-fragile ABI; the runtime knows how to fix this
4925 // up.
4926 //
4927 // ARC layout strings only include the class's ivars. In non-fragile
John McCallf5ea0722015-10-29 23:36:14 +00004928 // runtimes, that means starting at InstanceStart, rounded up to word
4929 // alignment. In fragile runtimes, there's no InstanceStart, so it means
4930 // starting at the end of the superclass, rounded up to word alignment.
John McCall460ce582015-10-22 18:38:17 +00004931 //
4932 // MRC weak layout strings follow the ARC style.
John McCall3fd13f062015-10-21 18:06:47 +00004933 CharUnits baseOffset;
John McCall460ce582015-10-22 18:38:17 +00004934 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Jordy Rosea91768e2011-07-22 02:08:32 +00004935 for (const ObjCIvarDecl *IVD = OI->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00004936 IVD; IVD = IVD->getNextIvar())
John McCall3fd13f062015-10-21 18:06:47 +00004937 ivars.push_back(IVD);
4938
4939 if (isNonFragileABI()) {
4940 baseOffset = beginOffset; // InstanceStart
John McCall09ec1ec2015-10-21 22:06:03 +00004941 } else if (auto superClass = OI->getSuperClass()) {
John McCall3fd13f062015-10-21 18:06:47 +00004942 auto startOffset =
4943 CGM.getContext().getASTObjCInterfaceLayout(superClass).getSize();
John McCallf5ea0722015-10-29 23:36:14 +00004944 baseOffset = startOffset;
John McCall3fd13f062015-10-21 18:06:47 +00004945 } else {
4946 baseOffset = CharUnits::Zero();
4947 }
John McCallf5ea0722015-10-29 23:36:14 +00004948
4949 baseOffset = baseOffset.RoundUpToAlignment(CGM.getPointerAlign());
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00004950 }
4951 else {
John McCall3fd13f062015-10-21 18:06:47 +00004952 CGM.getContext().DeepCollectObjCIvars(OI, true, ivars);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004953
John McCall3fd13f062015-10-21 18:06:47 +00004954 baseOffset = CharUnits::Zero();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00004955 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004956
John McCall3fd13f062015-10-21 18:06:47 +00004957 if (ivars.empty())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004958 return llvm::Constant::getNullValue(PtrTy);
4959
John McCall3fd13f062015-10-21 18:06:47 +00004960 IvarLayoutBuilder builder(CGM, baseOffset, endOffset, ForStrongLayout);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004961
John McCall3fd13f062015-10-21 18:06:47 +00004962 builder.visitAggregate(ivars.begin(), ivars.end(), CharUnits::Zero(),
4963 [&](const ObjCIvarDecl *ivar) -> CharUnits {
4964 return CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivar));
4965 });
4966
4967 if (!builder.hasBitmapData())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004968 return llvm::Constant::getNullValue(PtrTy);
John McCall3fd13f062015-10-21 18:06:47 +00004969
4970 llvm::SmallVector<unsigned char, 4> buffer;
4971 llvm::Constant *C = builder.buildBitmap(*this, buffer);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004972
John McCallf5ea0722015-10-29 23:36:14 +00004973 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004974 printf("\n%s ivar layout for class '%s': ",
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00004975 ForStrongLayout ? "strong" : "weak",
Ben Langmuire013bdc2014-07-11 00:43:47 +00004976 OMD->getClassInterface()->getName().str().c_str());
John McCall3fd13f062015-10-21 18:06:47 +00004977 builder.dump(buffer);
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00004978 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004979 return C;
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00004980}
4981
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00004982llvm::Constant *CGObjCCommonMac::GetMethodVarName(Selector Sel) {
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004983 llvm::GlobalVariable *&Entry = MethodVarNames[Sel];
4984
Chris Lattner3def9ae2012-02-06 22:16:34 +00004985 // FIXME: Avoid std::string in "Sel.getAsString()"
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004986 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004987 Entry = CreateMetadataVar(
4988 "OBJC_METH_VAR_NAME_",
4989 llvm::ConstantDataArray::getString(VMContext, Sel.getAsString()),
4990 ((ObjCABI == 2) ? "__TEXT,__objc_methname,cstring_literals"
4991 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004992 CharUnits::One(), true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004993
Owen Anderson170229f2009-07-14 23:10:40 +00004994 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarb036db82008-08-13 03:21:16 +00004995}
4996
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004997// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00004998llvm::Constant *CGObjCCommonMac::GetMethodVarName(IdentifierInfo *ID) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004999 return GetMethodVarName(CGM.getContext().Selectors.getNullarySelector(ID));
5000}
5001
Daniel Dunbarf5c18462009-04-20 06:54:31 +00005002llvm::Constant *CGObjCCommonMac::GetMethodVarType(const FieldDecl *Field) {
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005003 std::string TypeStr;
5004 CGM.getContext().getObjCEncodingForType(Field->getType(), TypeStr, Field);
5005
5006 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbarb036db82008-08-13 03:21:16 +00005007
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005008 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005009 Entry = CreateMetadataVar(
5010 "OBJC_METH_VAR_TYPE_",
5011 llvm::ConstantDataArray::getString(VMContext, TypeStr),
5012 ((ObjCABI == 2) ? "__TEXT,__objc_methtype,cstring_literals"
5013 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00005014 CharUnits::One(), true);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005015
Owen Anderson170229f2009-07-14 23:10:40 +00005016 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005017}
5018
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005019llvm::Constant *CGObjCCommonMac::GetMethodVarType(const ObjCMethodDecl *D,
5020 bool Extended) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005021 std::string TypeStr;
Bill Wendlinge22bef72012-02-09 22:45:21 +00005022 if (CGM.getContext().getObjCEncodingForMethodDecl(D, TypeStr, Extended))
Craig Topper8a13c412014-05-21 05:09:00 +00005023 return nullptr;
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005024
5025 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
5026
Daniel Dunbar3241fae2009-04-14 23:14:47 +00005027 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005028 Entry = CreateMetadataVar(
5029 "OBJC_METH_VAR_TYPE_",
5030 llvm::ConstantDataArray::getString(VMContext, TypeStr),
5031 ((ObjCABI == 2) ? "__TEXT,__objc_methtype,cstring_literals"
5032 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00005033 CharUnits::One(), true);
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005034
Owen Anderson170229f2009-07-14 23:10:40 +00005035 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005036}
5037
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005038// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005039llvm::Constant *CGObjCCommonMac::GetPropertyName(IdentifierInfo *Ident) {
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005040 llvm::GlobalVariable *&Entry = PropertyNames[Ident];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005041
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005042 if (!Entry)
Alp Toker541d5072014-06-07 23:30:53 +00005043 Entry = CreateMetadataVar(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005044 "OBJC_PROP_NAME_ATTR_",
Alp Toker541d5072014-06-07 23:30:53 +00005045 llvm::ConstantDataArray::getString(VMContext, Ident->getName()),
John McCall7f416cc2015-09-08 08:05:57 +00005046 "__TEXT,__cstring,cstring_literals", CharUnits::One(), true);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005047
Owen Anderson170229f2009-07-14 23:10:40 +00005048 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005049}
5050
5051// FIXME: Merge into a single cstring creation function.
Daniel Dunbar4932b362008-08-28 04:38:10 +00005052// FIXME: This Decl should be more precise.
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005053llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005054CGObjCCommonMac::GetPropertyTypeString(const ObjCPropertyDecl *PD,
5055 const Decl *Container) {
Daniel Dunbar4932b362008-08-28 04:38:10 +00005056 std::string TypeStr;
5057 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container, TypeStr);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005058 return GetPropertyName(&CGM.getContext().Idents.get(TypeStr));
5059}
5060
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005061void CGObjCCommonMac::GetNameForMethod(const ObjCMethodDecl *D,
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005062 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005063 SmallVectorImpl<char> &Name) {
Daniel Dunbard2386812009-10-19 01:21:19 +00005064 llvm::raw_svector_ostream OS(Name);
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00005065 assert (CD && "Missing container decl in GetNameForMethod");
Daniel Dunbard2386812009-10-19 01:21:19 +00005066 OS << '\01' << (D->isInstanceMethod() ? '-' : '+')
5067 << '[' << CD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005068 if (const ObjCCategoryImplDecl *CID =
Daniel Dunbard2386812009-10-19 01:21:19 +00005069 dyn_cast<ObjCCategoryImplDecl>(D->getDeclContext()))
Benjamin Kramer2f569922012-02-07 11:57:45 +00005070 OS << '(' << *CID << ')';
Daniel Dunbard2386812009-10-19 01:21:19 +00005071 OS << ' ' << D->getSelector().getAsString() << ']';
Daniel Dunbara94ecd22008-08-16 03:19:19 +00005072}
5073
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005074void CGObjCMac::FinishModule() {
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005075 EmitModuleInfo();
5076
Daniel Dunbarc475d422008-10-29 22:36:39 +00005077 // Emit the dummy bodies for any protocols which were referenced but
5078 // never defined.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005079 for (llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*>::iterator
Chris Lattnerf56501c2009-07-17 23:57:13 +00005080 I = Protocols.begin(), e = Protocols.end(); I != e; ++I) {
5081 if (I->second->hasInitializer())
Daniel Dunbarc475d422008-10-29 22:36:39 +00005082 continue;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005083
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005084 llvm::Constant *Values[5];
Owen Anderson0b75f232009-07-31 20:28:54 +00005085 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005086 Values[1] = GetClassName(I->first->getName());
Owen Anderson0b75f232009-07-31 20:28:54 +00005087 Values[2] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005088 Values[3] = Values[4] =
Owen Anderson0b75f232009-07-31 20:28:54 +00005089 llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00005090 I->second->setInitializer(llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbarc475d422008-10-29 22:36:39 +00005091 Values));
Rafael Espindola060062a2014-03-06 22:15:10 +00005092 CGM.addCompilerUsedGlobal(I->second);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005093 }
5094
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005095 // Add assembler directives to add lazy undefined symbol references
5096 // for classes which are referenced but not defined. This is
5097 // important for correct linker interaction.
Daniel Dunbard027a922009-09-07 00:20:42 +00005098 //
5099 // FIXME: It would be nice if we had an LLVM construct for this.
5100 if (!LazySymbols.empty() || !DefinedSymbols.empty()) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00005101 SmallString<256> Asm;
Daniel Dunbard027a922009-09-07 00:20:42 +00005102 Asm += CGM.getModule().getModuleInlineAsm();
5103 if (!Asm.empty() && Asm.back() != '\n')
5104 Asm += '\n';
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005105
Daniel Dunbard027a922009-09-07 00:20:42 +00005106 llvm::raw_svector_ostream OS(Asm);
Daniel Dunbard027a922009-09-07 00:20:42 +00005107 for (llvm::SetVector<IdentifierInfo*>::iterator I = DefinedSymbols.begin(),
5108 e = DefinedSymbols.end(); I != e; ++I)
Daniel Dunbar07d07852009-10-18 21:17:35 +00005109 OS << "\t.objc_class_name_" << (*I)->getName() << "=0\n"
5110 << "\t.globl .objc_class_name_" << (*I)->getName() << "\n";
Chris Lattnera299f2c2010-04-17 18:26:20 +00005111 for (llvm::SetVector<IdentifierInfo*>::iterator I = LazySymbols.begin(),
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005112 e = LazySymbols.end(); I != e; ++I) {
Chris Lattnera299f2c2010-04-17 18:26:20 +00005113 OS << "\t.lazy_reference .objc_class_name_" << (*I)->getName() << "\n";
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005114 }
5115
Bill Wendling53136852012-02-07 09:06:01 +00005116 for (size_t i = 0, e = DefinedCategoryNames.size(); i < e; ++i) {
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005117 OS << "\t.objc_category_name_" << DefinedCategoryNames[i] << "=0\n"
5118 << "\t.globl .objc_category_name_" << DefinedCategoryNames[i] << "\n";
5119 }
Chris Lattnera299f2c2010-04-17 18:26:20 +00005120
Daniel Dunbard027a922009-09-07 00:20:42 +00005121 CGM.getModule().setModuleInlineAsm(OS.str());
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005122 }
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005123}
5124
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005125CGObjCNonFragileABIMac::CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm)
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005126 : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00005127 ObjCTypes(cgm) {
Craig Topper8a13c412014-05-21 05:09:00 +00005128 ObjCEmptyCacheVar = ObjCEmptyVtableVar = nullptr;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005129 ObjCABI = 2;
5130}
5131
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005132/* *** */
5133
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005134ObjCCommonTypesHelper::ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm)
Craig Topper8a13c412014-05-21 05:09:00 +00005135 : VMContext(cgm.getLLVMContext()), CGM(cgm), ExternalProtocolPtrTy(nullptr)
Douglas Gregora95f9aa2012-01-17 23:38:32 +00005136{
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005137 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5138 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005139
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005140 ShortTy = Types.ConvertType(Ctx.ShortTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005141 IntTy = Types.ConvertType(Ctx.IntTy);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005142 LongTy = Types.ConvertType(Ctx.LongTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00005143 LongLongTy = Types.ConvertType(Ctx.LongLongTy);
Chris Lattnerece04092012-02-07 00:39:47 +00005144 Int8PtrTy = CGM.Int8PtrTy;
5145 Int8PtrPtrTy = CGM.Int8PtrPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005146
Tim Northover238b5082014-03-29 13:42:40 +00005147 // arm64 targets use "int" ivar offset variables. All others,
5148 // including OS X x86_64 and Windows x86_64, use "long" ivar offsets.
Tim Northover40956e62014-07-23 12:32:58 +00005149 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::aarch64)
Tim Northover238b5082014-03-29 13:42:40 +00005150 IvarOffsetVarTy = IntTy;
5151 else
5152 IvarOffsetVarTy = LongTy;
5153
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005154 ObjectPtrTy = Types.ConvertType(Ctx.getObjCIdType());
Owen Anderson9793f0e2009-07-29 22:16:19 +00005155 PtrObjectPtrTy = llvm::PointerType::getUnqual(ObjectPtrTy);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005156 SelectorPtrTy = Types.ConvertType(Ctx.getObjCSelType());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005157
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005158 // I'm not sure I like this. The implicit coordination is a bit
5159 // gross. We should solve this in a reasonable fashion because this
5160 // is a pretty common task (match some runtime data structure with
5161 // an LLVM data structure).
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005162
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005163 // FIXME: This is leaked.
5164 // FIXME: Merge with rewriter code?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005165
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005166 // struct _objc_super {
5167 // id self;
5168 // Class cls;
5169 // }
Abramo Bagnara6150c882010-05-11 21:36:43 +00005170 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005171 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005172 SourceLocation(), SourceLocation(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005173 &Ctx.Idents.get("_objc_super"));
Craig Topper8a13c412014-05-21 05:09:00 +00005174 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5175 nullptr, Ctx.getObjCIdType(), nullptr, nullptr,
5176 false, ICIS_NoInit));
5177 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5178 nullptr, Ctx.getObjCClassType(), nullptr,
5179 nullptr, false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005180 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005181
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005182 SuperCTy = Ctx.getTagDeclType(RD);
5183 SuperPtrCTy = Ctx.getPointerType(SuperCTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005184
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005185 SuperTy = cast<llvm::StructType>(Types.ConvertType(SuperCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005186 SuperPtrTy = llvm::PointerType::getUnqual(SuperTy);
5187
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005188 // struct _prop_t {
5189 // char *name;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005190 // char *attributes;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005191 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005192 PropertyTy = llvm::StructType::create("struct._prop_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005193 Int8PtrTy, Int8PtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005194
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005195 // struct _prop_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005196 // uint32_t entsize; // sizeof(struct _prop_t)
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005197 // uint32_t count_of_properties;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005198 // struct _prop_t prop_list[count_of_properties];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005199 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005200 PropertyListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005201 llvm::StructType::create("struct._prop_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005202 llvm::ArrayType::get(PropertyTy, 0), nullptr);
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005203 // struct _prop_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005204 PropertyListPtrTy = llvm::PointerType::getUnqual(PropertyListTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005205
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005206 // struct _objc_method {
5207 // SEL _cmd;
5208 // char *method_type;
5209 // char *_imp;
5210 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005211 MethodTy = llvm::StructType::create("struct._objc_method",
5212 SelectorPtrTy, Int8PtrTy, Int8PtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005213 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005214
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005215 // struct _objc_cache *
Chris Lattner5ec04a52011-08-12 17:43:31 +00005216 CacheTy = llvm::StructType::create(VMContext, "struct._objc_cache");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005217 CachePtrTy = llvm::PointerType::getUnqual(CacheTy);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00005218
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005219}
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005220
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005221ObjCTypesHelper::ObjCTypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005222 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005223 // struct _objc_method_description {
5224 // SEL name;
5225 // char *types;
5226 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005227 MethodDescriptionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005228 llvm::StructType::create("struct._objc_method_description",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005229 SelectorPtrTy, Int8PtrTy, nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005230
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005231 // struct _objc_method_description_list {
5232 // int count;
5233 // struct _objc_method_description[1];
5234 // }
Reid Kleckneree7cf842014-12-01 22:02:27 +00005235 MethodDescriptionListTy = llvm::StructType::create(
5236 "struct._objc_method_description_list", IntTy,
5237 llvm::ArrayType::get(MethodDescriptionTy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005238
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005239 // struct _objc_method_description_list *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005240 MethodDescriptionListPtrTy =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005241 llvm::PointerType::getUnqual(MethodDescriptionListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005242
Daniel Dunbarb036db82008-08-13 03:21:16 +00005243 // Protocol description structures
5244
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005245 // struct _objc_protocol_extension {
5246 // uint32_t size; // sizeof(struct _objc_protocol_extension)
5247 // struct _objc_method_description_list *optional_instance_methods;
5248 // struct _objc_method_description_list *optional_class_methods;
5249 // struct _objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005250 // const char ** extendedMethodTypes;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005251 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005252 ProtocolExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005253 llvm::StructType::create("struct._objc_protocol_extension",
5254 IntTy, MethodDescriptionListPtrTy,
5255 MethodDescriptionListPtrTy, PropertyListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005256 Int8PtrPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005257
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005258 // struct _objc_protocol_extension *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005259 ProtocolExtensionPtrTy = llvm::PointerType::getUnqual(ProtocolExtensionTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005260
Daniel Dunbarc475d422008-10-29 22:36:39 +00005261 // Handle recursive construction of Protocol and ProtocolList types
Daniel Dunbarb036db82008-08-13 03:21:16 +00005262
Chris Lattnera5f58b02011-07-09 17:41:47 +00005263 ProtocolTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005264 llvm::StructType::create(VMContext, "struct._objc_protocol");
Daniel Dunbarb036db82008-08-13 03:21:16 +00005265
Chris Lattnera5f58b02011-07-09 17:41:47 +00005266 ProtocolListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005267 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005268 ProtocolListTy->setBody(llvm::PointerType::getUnqual(ProtocolListTy),
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005269 LongTy,
Chris Lattnera5f58b02011-07-09 17:41:47 +00005270 llvm::ArrayType::get(ProtocolTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005271 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005272
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005273 // struct _objc_protocol {
5274 // struct _objc_protocol_extension *isa;
5275 // char *protocol_name;
5276 // struct _objc_protocol **_objc_protocol_list;
5277 // struct _objc_method_description_list *instance_methods;
5278 // struct _objc_method_description_list *class_methods;
5279 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005280 ProtocolTy->setBody(ProtocolExtensionPtrTy, Int8PtrTy,
5281 llvm::PointerType::getUnqual(ProtocolListTy),
5282 MethodDescriptionListPtrTy,
5283 MethodDescriptionListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005284 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005285
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005286 // struct _objc_protocol_list *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005287 ProtocolListPtrTy = llvm::PointerType::getUnqual(ProtocolListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005288
Owen Anderson9793f0e2009-07-29 22:16:19 +00005289 ProtocolPtrTy = llvm::PointerType::getUnqual(ProtocolTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005290
5291 // Class description structures
5292
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005293 // struct _objc_ivar {
5294 // char *ivar_name;
5295 // char *ivar_type;
5296 // int ivar_offset;
5297 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005298 IvarTy = llvm::StructType::create("struct._objc_ivar",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005299 Int8PtrTy, Int8PtrTy, IntTy, nullptr);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005300
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005301 // struct _objc_ivar_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005302 IvarListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005303 llvm::StructType::create(VMContext, "struct._objc_ivar_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005304 IvarListPtrTy = llvm::PointerType::getUnqual(IvarListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005305
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005306 // struct _objc_method_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005307 MethodListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005308 llvm::StructType::create(VMContext, "struct._objc_method_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005309 MethodListPtrTy = llvm::PointerType::getUnqual(MethodListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005310
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005311 // struct _objc_class_extension *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005312 ClassExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005313 llvm::StructType::create("struct._objc_class_extension",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005314 IntTy, Int8PtrTy, PropertyListPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005315 ClassExtensionPtrTy = llvm::PointerType::getUnqual(ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005316
Chris Lattner5ec04a52011-08-12 17:43:31 +00005317 ClassTy = llvm::StructType::create(VMContext, "struct._objc_class");
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005318
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005319 // struct _objc_class {
5320 // Class isa;
5321 // Class super_class;
5322 // char *name;
5323 // long version;
5324 // long info;
5325 // long instance_size;
5326 // struct _objc_ivar_list *ivars;
5327 // struct _objc_method_list *methods;
5328 // struct _objc_cache *cache;
5329 // struct _objc_protocol_list *protocols;
5330 // char *ivar_layout;
5331 // struct _objc_class_ext *ext;
5332 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005333 ClassTy->setBody(llvm::PointerType::getUnqual(ClassTy),
5334 llvm::PointerType::getUnqual(ClassTy),
5335 Int8PtrTy,
5336 LongTy,
5337 LongTy,
5338 LongTy,
5339 IvarListPtrTy,
5340 MethodListPtrTy,
5341 CachePtrTy,
5342 ProtocolListPtrTy,
5343 Int8PtrTy,
5344 ClassExtensionPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005345 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005346
Owen Anderson9793f0e2009-07-29 22:16:19 +00005347 ClassPtrTy = llvm::PointerType::getUnqual(ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005348
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005349 // struct _objc_category {
5350 // char *category_name;
5351 // char *class_name;
5352 // struct _objc_method_list *instance_method;
5353 // struct _objc_method_list *class_method;
5354 // uint32_t size; // sizeof(struct _objc_category)
5355 // struct _objc_property_list *instance_properties;// category's @property
5356 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005357 CategoryTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005358 llvm::StructType::create("struct._objc_category",
5359 Int8PtrTy, Int8PtrTy, MethodListPtrTy,
5360 MethodListPtrTy, ProtocolListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005361 IntTy, PropertyListPtrTy, nullptr);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00005362
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005363 // Global metadata structures
5364
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005365 // struct _objc_symtab {
5366 // long sel_ref_cnt;
5367 // SEL *refs;
5368 // short cls_def_cnt;
5369 // short cat_def_cnt;
5370 // char *defs[cls_def_cnt + cat_def_cnt];
5371 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005372 SymtabTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005373 llvm::StructType::create("struct._objc_symtab",
5374 LongTy, SelectorPtrTy, ShortTy, ShortTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005375 llvm::ArrayType::get(Int8PtrTy, 0), nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005376 SymtabPtrTy = llvm::PointerType::getUnqual(SymtabTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005377
Fariborz Jahanianeee54df2009-01-22 00:37:21 +00005378 // struct _objc_module {
5379 // long version;
5380 // long size; // sizeof(struct _objc_module)
5381 // char *name;
5382 // struct _objc_symtab* symtab;
5383 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005384 ModuleTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005385 llvm::StructType::create("struct._objc_module",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005386 LongTy, LongTy, Int8PtrTy, SymtabPtrTy, nullptr);
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00005387
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005388
Mike Stump18bb9282009-05-16 07:57:57 +00005389 // FIXME: This is the size of the setjmp buffer and should be target
5390 // specific. 18 is what's used on 32-bit X86.
Anders Carlsson9ff22482008-09-09 10:10:21 +00005391 uint64_t SetJmpBufferSize = 18;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005392
Anders Carlsson9ff22482008-09-09 10:10:21 +00005393 // Exceptions
Chris Lattnerece04092012-02-07 00:39:47 +00005394 llvm::Type *StackPtrTy = llvm::ArrayType::get(CGM.Int8PtrTy, 4);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005395
5396 ExceptionDataTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005397 llvm::StructType::create("struct._objc_exception_data",
Chris Lattnerece04092012-02-07 00:39:47 +00005398 llvm::ArrayType::get(CGM.Int32Ty,SetJmpBufferSize),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005399 StackPtrTy, nullptr);
Anders Carlsson9ff22482008-09-09 10:10:21 +00005400
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005401}
5402
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005403ObjCNonFragileABITypesHelper::ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005404 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005405 // struct _method_list_t {
5406 // uint32_t entsize; // sizeof(struct _objc_method)
5407 // uint32_t method_count;
5408 // struct _objc_method method_list[method_count];
5409 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005410 MethodListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005411 llvm::StructType::create("struct.__method_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005412 llvm::ArrayType::get(MethodTy, 0), nullptr);
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005413 // struct method_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005414 MethodListnfABIPtrTy = llvm::PointerType::getUnqual(MethodListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005415
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005416 // struct _protocol_t {
5417 // id isa; // NULL
5418 // const char * const protocol_name;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005419 // const struct _protocol_list_t * protocol_list; // super protocols
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005420 // const struct method_list_t * const instance_methods;
5421 // const struct method_list_t * const class_methods;
5422 // const struct method_list_t *optionalInstanceMethods;
5423 // const struct method_list_t *optionalClassMethods;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005424 // const struct _prop_list_t * properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005425 // const uint32_t size; // sizeof(struct _protocol_t)
5426 // const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005427 // const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00005428 // const char *demangledName;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005429 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005430
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005431 // Holder for struct _protocol_list_t *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005432 ProtocolListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005433 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005434
Chris Lattnera5f58b02011-07-09 17:41:47 +00005435 ProtocolnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005436 llvm::StructType::create("struct._protocol_t", ObjectPtrTy, Int8PtrTy,
5437 llvm::PointerType::getUnqual(ProtocolListnfABITy),
5438 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
5439 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005440 PropertyListPtrTy, IntTy, IntTy, Int8PtrPtrTy,
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00005441 Int8PtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005442 nullptr);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005443
5444 // struct _protocol_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005445 ProtocolnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005446
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005447 // struct _protocol_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005448 // long protocol_count; // Note, this is 32/64 bit
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005449 // struct _protocol_t *[protocol_count];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005450 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005451 ProtocolListnfABITy->setBody(LongTy,
5452 llvm::ArrayType::get(ProtocolnfABIPtrTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005453 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005454
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005455 // struct _objc_protocol_list*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005456 ProtocolListnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005457
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005458 // struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00005459 // unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005460 // char *name;
5461 // char *type;
5462 // uint32_t alignment;
5463 // uint32_t size;
5464 // }
Tim Northover238b5082014-03-29 13:42:40 +00005465 IvarnfABITy = llvm::StructType::create(
5466 "struct._ivar_t", llvm::PointerType::getUnqual(IvarOffsetVarTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005467 Int8PtrTy, Int8PtrTy, IntTy, IntTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005468
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005469 // struct _ivar_list_t {
5470 // uint32 entsize; // sizeof(struct _ivar_t)
5471 // uint32 count;
5472 // struct _iver_t list[count];
5473 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005474 IvarListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005475 llvm::StructType::create("struct._ivar_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005476 llvm::ArrayType::get(IvarnfABITy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005477
Owen Anderson9793f0e2009-07-29 22:16:19 +00005478 IvarListnfABIPtrTy = llvm::PointerType::getUnqual(IvarListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005479
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005480 // struct _class_ro_t {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005481 // uint32_t const flags;
5482 // uint32_t const instanceStart;
5483 // uint32_t const instanceSize;
5484 // uint32_t const reserved; // only when building for 64bit targets
5485 // const uint8_t * const ivarLayout;
5486 // const char *const name;
5487 // const struct _method_list_t * const baseMethods;
5488 // const struct _objc_protocol_list *const baseProtocols;
5489 // const struct _ivar_list_t *const ivars;
5490 // const uint8_t * const weakIvarLayout;
5491 // const struct _prop_list_t * const properties;
5492 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005493
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005494 // FIXME. Add 'reserved' field in 64bit abi mode!
Chris Lattner5ec04a52011-08-12 17:43:31 +00005495 ClassRonfABITy = llvm::StructType::create("struct._class_ro_t",
5496 IntTy, IntTy, IntTy, Int8PtrTy,
5497 Int8PtrTy, MethodListnfABIPtrTy,
5498 ProtocolListnfABIPtrTy,
5499 IvarListnfABIPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005500 Int8PtrTy, PropertyListPtrTy,
5501 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005502
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005503 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +00005504 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall9dc0db22011-05-15 01:53:33 +00005505 ImpnfABITy = llvm::FunctionType::get(ObjectPtrTy, params, false)
5506 ->getPointerTo();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005507
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005508 // struct _class_t {
5509 // struct _class_t *isa;
5510 // struct _class_t * const superclass;
5511 // void *cache;
5512 // IMP *vtable;
5513 // struct class_ro_t *ro;
5514 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005515
Chris Lattner5ec04a52011-08-12 17:43:31 +00005516 ClassnfABITy = llvm::StructType::create(VMContext, "struct._class_t");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005517 ClassnfABITy->setBody(llvm::PointerType::getUnqual(ClassnfABITy),
5518 llvm::PointerType::getUnqual(ClassnfABITy),
5519 CachePtrTy,
5520 llvm::PointerType::getUnqual(ImpnfABITy),
5521 llvm::PointerType::getUnqual(ClassRonfABITy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005522 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005523
Fariborz Jahanian71394042009-01-23 23:53:38 +00005524 // LLVM for struct _class_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005525 ClassnfABIPtrTy = llvm::PointerType::getUnqual(ClassnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005526
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005527 // struct _category_t {
5528 // const char * const name;
5529 // struct _class_t *const cls;
5530 // const struct _method_list_t * const instance_methods;
5531 // const struct _method_list_t * const class_methods;
5532 // const struct _protocol_list_t * const protocols;
5533 // const struct _prop_list_t * const properties;
Fariborz Jahanian5a63e4c2009-01-23 17:41:22 +00005534 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005535 CategorynfABITy = llvm::StructType::create("struct._category_t",
5536 Int8PtrTy, ClassnfABIPtrTy,
5537 MethodListnfABIPtrTy,
5538 MethodListnfABIPtrTy,
5539 ProtocolListnfABIPtrTy,
5540 PropertyListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005541 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005542
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005543 // New types for nonfragile abi messaging.
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005544 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5545 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005546
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005547 // MessageRefTy - LLVM for:
5548 // struct _message_ref_t {
5549 // IMP messenger;
5550 // SEL name;
5551 // };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005552
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005553 // First the clang type for struct _message_ref_t
Abramo Bagnara6150c882010-05-11 21:36:43 +00005554 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005555 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005556 SourceLocation(), SourceLocation(),
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005557 &Ctx.Idents.get("_message_ref_t"));
Craig Topper8a13c412014-05-21 05:09:00 +00005558 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5559 nullptr, Ctx.VoidPtrTy, nullptr, nullptr, false,
Richard Smith2b013182012-06-10 03:12:00 +00005560 ICIS_NoInit));
Craig Topper8a13c412014-05-21 05:09:00 +00005561 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5562 nullptr, Ctx.getObjCSelType(), nullptr, nullptr,
5563 false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005564 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005565
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005566 MessageRefCTy = Ctx.getTagDeclType(RD);
5567 MessageRefCPtrTy = Ctx.getPointerType(MessageRefCTy);
5568 MessageRefTy = cast<llvm::StructType>(Types.ConvertType(MessageRefCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005569
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005570 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005571 MessageRefPtrTy = llvm::PointerType::getUnqual(MessageRefTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005572
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005573 // SuperMessageRefTy - LLVM for:
5574 // struct _super_message_ref_t {
5575 // SUPER_IMP messenger;
5576 // SEL name;
5577 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005578 SuperMessageRefTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005579 llvm::StructType::create("struct._super_message_ref_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005580 ImpnfABITy, SelectorPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005581
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005582 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005583 SuperMessageRefPtrTy = llvm::PointerType::getUnqual(SuperMessageRefTy);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00005584
Daniel Dunbarb1559a42009-03-01 04:46:24 +00005585
5586 // struct objc_typeinfo {
5587 // const void** vtable; // objc_ehtype_vtable + 2
5588 // const char* name; // c++ typeinfo string
5589 // Class cls;
5590 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005591 EHTypeTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005592 llvm::StructType::create("struct._objc_typeinfo",
5593 llvm::PointerType::getUnqual(Int8PtrTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005594 Int8PtrTy, ClassnfABIPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005595 EHTypePtrTy = llvm::PointerType::getUnqual(EHTypeTy);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005596}
5597
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005598llvm::Function *CGObjCNonFragileABIMac::ModuleInitFunction() {
Fariborz Jahanian71394042009-01-23 23:53:38 +00005599 FinishNonFragileABIModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005600
Craig Topper8a13c412014-05-21 05:09:00 +00005601 return nullptr;
Fariborz Jahanian71394042009-01-23 23:53:38 +00005602}
5603
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00005604void CGObjCNonFragileABIMac::
5605AddModuleClassList(ArrayRef<llvm::GlobalValue*> Container,
5606 const char *SymbolName,
5607 const char *SectionName) {
Daniel Dunbar19573e72009-05-15 21:48:48 +00005608 unsigned NumClasses = Container.size();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005609
Daniel Dunbar19573e72009-05-15 21:48:48 +00005610 if (!NumClasses)
5611 return;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005612
Chris Lattner3def9ae2012-02-06 22:16:34 +00005613 SmallVector<llvm::Constant*, 8> Symbols(NumClasses);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005614 for (unsigned i=0; i<NumClasses; i++)
Owen Andersonade90fd2009-07-29 18:54:39 +00005615 Symbols[i] = llvm::ConstantExpr::getBitCast(Container[i],
Daniel Dunbar19573e72009-05-15 21:48:48 +00005616 ObjCTypes.Int8PtrTy);
Chris Lattner3def9ae2012-02-06 22:16:34 +00005617 llvm::Constant *Init =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005618 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00005619 Symbols.size()),
Daniel Dunbar19573e72009-05-15 21:48:48 +00005620 Symbols);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005621
Daniel Dunbar19573e72009-05-15 21:48:48 +00005622 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00005623 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005624 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar19573e72009-05-15 21:48:48 +00005625 Init,
Owen Andersonc10c8d32009-07-08 19:05:04 +00005626 SymbolName);
Micah Villmowdd31ca12012-10-08 16:25:52 +00005627 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Daniel Dunbar19573e72009-05-15 21:48:48 +00005628 GV->setSection(SectionName);
Rafael Espindola060062a2014-03-06 22:15:10 +00005629 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005630}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005631
Fariborz Jahanian71394042009-01-23 23:53:38 +00005632void CGObjCNonFragileABIMac::FinishNonFragileABIModule() {
5633 // nonfragile abi has no module definition.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005634
Daniel Dunbar19573e72009-05-15 21:48:48 +00005635 // Build list of all implemented class addresses in array
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005636 // L_OBJC_LABEL_CLASS_$.
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005637
5638 for (unsigned i=0, NumClasses=ImplementedClasses.size(); i<NumClasses; i++) {
5639 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
5640 assert(ID);
5641 if (ObjCImplementationDecl *IMP = ID->getImplementation())
5642 // We are implementing a weak imported interface. Give it external linkage
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005643 if (ID->isWeakImported() && !IMP->isWeakImported()) {
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005644 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005645 DefinedMetaClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
5646 }
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005647 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005648
5649 AddModuleClassList(DefinedClasses, "OBJC_LABEL_CLASS_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005650 "__DATA, __objc_classlist, regular, no_dead_strip");
Rafael Espindola554256c2014-02-26 22:25:45 +00005651
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005652 AddModuleClassList(DefinedNonLazyClasses, "OBJC_LABEL_NONLAZY_CLASS_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005653 "__DATA, __objc_nlclslist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005654
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005655 // Build list of all implemented category addresses in array
5656 // L_OBJC_LABEL_CATEGORY_$.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005657 AddModuleClassList(DefinedCategories, "OBJC_LABEL_CATEGORY_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005658 "__DATA, __objc_catlist, regular, no_dead_strip");
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005659 AddModuleClassList(DefinedNonLazyCategories, "OBJC_LABEL_NONLAZY_CATEGORY_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005660 "__DATA, __objc_nlcatlist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005661
Daniel Dunbar5e639272010-04-25 20:39:01 +00005662 EmitImageInfo();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005663}
5664
John McCall9e8bb002011-05-14 03:10:52 +00005665/// isVTableDispatchedSelector - Returns true if SEL is not in the list of
5666/// VTableDispatchMethods; false otherwise. What this means is that
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005667/// except for the 19 selectors in the list, we generate 32bit-style
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005668/// message dispatch call for all the rest.
John McCall9e8bb002011-05-14 03:10:52 +00005669bool CGObjCNonFragileABIMac::isVTableDispatchedSelector(Selector Sel) {
5670 // At various points we've experimented with using vtable-based
5671 // dispatch for all methods.
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005672 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005673 case CodeGenOptions::Legacy:
Fariborz Jahaniandfb39832010-04-19 17:53:30 +00005674 return false;
John McCall9e8bb002011-05-14 03:10:52 +00005675 case CodeGenOptions::NonLegacy:
5676 return true;
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005677 case CodeGenOptions::Mixed:
5678 break;
5679 }
5680
5681 // If so, see whether this selector is in the white-list of things which must
5682 // use the new dispatch convention. We lazily build a dense set for this.
John McCall9e8bb002011-05-14 03:10:52 +00005683 if (VTableDispatchMethods.empty()) {
5684 VTableDispatchMethods.insert(GetNullarySelector("alloc"));
5685 VTableDispatchMethods.insert(GetNullarySelector("class"));
5686 VTableDispatchMethods.insert(GetNullarySelector("self"));
5687 VTableDispatchMethods.insert(GetNullarySelector("isFlipped"));
5688 VTableDispatchMethods.insert(GetNullarySelector("length"));
5689 VTableDispatchMethods.insert(GetNullarySelector("count"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005690
John McCall9e8bb002011-05-14 03:10:52 +00005691 // These are vtable-based if GC is disabled.
5692 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00005693 if (CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
John McCall9e8bb002011-05-14 03:10:52 +00005694 VTableDispatchMethods.insert(GetNullarySelector("retain"));
5695 VTableDispatchMethods.insert(GetNullarySelector("release"));
5696 VTableDispatchMethods.insert(GetNullarySelector("autorelease"));
5697 }
5698
5699 VTableDispatchMethods.insert(GetUnarySelector("allocWithZone"));
5700 VTableDispatchMethods.insert(GetUnarySelector("isKindOfClass"));
5701 VTableDispatchMethods.insert(GetUnarySelector("respondsToSelector"));
5702 VTableDispatchMethods.insert(GetUnarySelector("objectForKey"));
5703 VTableDispatchMethods.insert(GetUnarySelector("objectAtIndex"));
5704 VTableDispatchMethods.insert(GetUnarySelector("isEqualToString"));
5705 VTableDispatchMethods.insert(GetUnarySelector("isEqual"));
5706
5707 // These are vtable-based if GC is enabled.
5708 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00005709 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
John McCall9e8bb002011-05-14 03:10:52 +00005710 VTableDispatchMethods.insert(GetNullarySelector("hash"));
5711 VTableDispatchMethods.insert(GetUnarySelector("addObject"));
5712
5713 // "countByEnumeratingWithState:objects:count"
5714 IdentifierInfo *KeyIdents[] = {
5715 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
5716 &CGM.getContext().Idents.get("objects"),
5717 &CGM.getContext().Idents.get("count")
5718 };
5719 VTableDispatchMethods.insert(
5720 CGM.getContext().Selectors.getSelector(3, KeyIdents));
5721 }
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005722 }
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005723
John McCall9e8bb002011-05-14 03:10:52 +00005724 return VTableDispatchMethods.count(Sel);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005725}
5726
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005727/// BuildClassRoTInitializer - generate meta-data for:
5728/// struct _class_ro_t {
5729/// uint32_t const flags;
5730/// uint32_t const instanceStart;
5731/// uint32_t const instanceSize;
5732/// uint32_t const reserved; // only when building for 64bit targets
5733/// const uint8_t * const ivarLayout;
5734/// const char *const name;
5735/// const struct _method_list_t * const baseMethods;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005736/// const struct _protocol_list_t *const baseProtocols;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005737/// const struct _ivar_list_t *const ivars;
5738/// const uint8_t * const weakIvarLayout;
5739/// const struct _prop_list_t * const properties;
5740/// }
5741///
5742llvm::GlobalVariable * CGObjCNonFragileABIMac::BuildClassRoTInitializer(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005743 unsigned flags,
5744 unsigned InstanceStart,
5745 unsigned InstanceSize,
5746 const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005747 std::string ClassName = ID->getObjCRuntimeNameAsString();
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005748 llvm::Constant *Values[10]; // 11 for 64bit targets!
John McCall31168b02011-06-15 23:02:42 +00005749
John McCall3fd13f062015-10-21 18:06:47 +00005750 CharUnits beginInstance = CharUnits::fromQuantity(InstanceStart);
5751 CharUnits endInstance = CharUnits::fromQuantity(InstanceSize);
5752
John McCall460ce582015-10-22 18:38:17 +00005753 bool hasMRCWeak = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00005754 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallef19dbb2012-10-17 04:53:23 +00005755 flags |= NonFragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00005756 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
5757 flags |= NonFragileABI_Class_HasMRCWeakIvars;
John McCall31168b02011-06-15 23:02:42 +00005758
Owen Andersonb7a2fe62009-07-24 23:12:58 +00005759 Values[ 0] = llvm::ConstantInt::get(ObjCTypes.IntTy, flags);
5760 Values[ 1] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceStart);
5761 Values[ 2] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceSize);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005762 // FIXME. For 64bit targets add 0 here.
John McCallef19dbb2012-10-17 04:53:23 +00005763 Values[ 3] = (flags & NonFragileABI_Class_Meta)
Craig Topper8a13c412014-05-21 05:09:00 +00005764 ? GetIvarLayoutName(nullptr, ObjCTypes)
John McCall460ce582015-10-22 18:38:17 +00005765 : BuildStrongIvarLayout(ID, beginInstance, endInstance);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005766 Values[ 4] = GetClassName(ID->getObjCRuntimeNameAsString());
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005767 // const struct _method_list_t * const baseMethods;
5768 std::vector<llvm::Constant*> Methods;
5769 std::string MethodListName("\01l_OBJC_$_");
John McCallef19dbb2012-10-17 04:53:23 +00005770 if (flags & NonFragileABI_Class_Meta) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005771 MethodListName += "CLASS_METHODS_";
5772 MethodListName += ID->getObjCRuntimeNameAsString();
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00005773 for (const auto *I : ID->class_methods())
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005774 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00005775 Methods.push_back(GetMethodConstant(I));
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005776 } else {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005777 MethodListName += "INSTANCE_METHODS_";
5778 MethodListName += ID->getObjCRuntimeNameAsString();
Aaron Ballmanf26acce2014-03-13 19:50:17 +00005779 for (const auto *I : ID->instance_methods())
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005780 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00005781 Methods.push_back(GetMethodConstant(I));
5782
Aaron Ballmand85eff42014-03-14 15:02:45 +00005783 for (const auto *PID : ID->property_impls()) {
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00005784 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize){
5785 ObjCPropertyDecl *PD = PID->getPropertyDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005786
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00005787 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
5788 if (llvm::Constant *C = GetMethodConstant(MD))
5789 Methods.push_back(C);
5790 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
5791 if (llvm::Constant *C = GetMethodConstant(MD))
5792 Methods.push_back(C);
5793 }
5794 }
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005795 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005796 Values[ 5] = EmitMethodList(MethodListName,
5797 "__DATA, __objc_const", Methods);
5798
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005799 const ObjCInterfaceDecl *OID = ID->getClassInterface();
5800 assert(OID && "CGObjCNonFragileABIMac::BuildClassRoTInitializer");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005801 Values[ 6] = EmitProtocolList("\01l_OBJC_CLASS_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005802 + OID->getObjCRuntimeNameAsString(),
Ted Kremenek0ef508d2010-09-01 01:21:15 +00005803 OID->all_referenced_protocol_begin(),
5804 OID->all_referenced_protocol_end());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005805
John McCallef19dbb2012-10-17 04:53:23 +00005806 if (flags & NonFragileABI_Class_Meta) {
Owen Anderson0b75f232009-07-31 20:28:54 +00005807 Values[ 7] = llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +00005808 Values[ 8] = GetIvarLayoutName(nullptr, ObjCTypes);
Owen Anderson0b75f232009-07-31 20:28:54 +00005809 Values[ 9] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
John McCallef19dbb2012-10-17 04:53:23 +00005810 } else {
5811 Values[ 7] = EmitIvarList(ID);
John McCall460ce582015-10-22 18:38:17 +00005812 Values[ 8] = BuildWeakIvarLayout(ID, beginInstance, endInstance,
5813 hasMRCWeak);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005814 Values[ 9] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00005815 ID, ID->getClassInterface(), ObjCTypes);
John McCallef19dbb2012-10-17 04:53:23 +00005816 }
Owen Anderson0e0189d2009-07-27 22:29:56 +00005817 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassRonfABITy,
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005818 Values);
5819 llvm::GlobalVariable *CLASS_RO_GV =
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005820 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassRonfABITy, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005821 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005822 Init,
John McCallef19dbb2012-10-17 04:53:23 +00005823 (flags & NonFragileABI_Class_Meta) ?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005824 std::string("\01l_OBJC_METACLASS_RO_$_")+ClassName :
5825 std::string("\01l_OBJC_CLASS_RO_$_")+ClassName);
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00005826 CLASS_RO_GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00005827 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassRonfABITy));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00005828 CLASS_RO_GV->setSection("__DATA, __objc_const");
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005829 return CLASS_RO_GV;
Fariborz Jahanian2612e142009-01-26 22:58:07 +00005830
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005831}
5832
5833/// BuildClassMetaData - This routine defines that to-level meta-data
5834/// for the given ClassName for:
5835/// struct _class_t {
5836/// struct _class_t *isa;
5837/// struct _class_t * const superclass;
5838/// void *cache;
5839/// IMP *vtable;
5840/// struct class_ro_t *ro;
5841/// }
5842///
Rafael Espindola554256c2014-02-26 22:25:45 +00005843llvm::GlobalVariable *CGObjCNonFragileABIMac::BuildClassMetaData(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005844 const std::string &ClassName, llvm::Constant *IsAGV, llvm::Constant *SuperClassGV,
Rafael Espindola554256c2014-02-26 22:25:45 +00005845 llvm::Constant *ClassRoGV, bool HiddenVisibility, bool Weak) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005846 llvm::Constant *Values[] = {
5847 IsAGV,
5848 SuperClassGV,
5849 ObjCEmptyCacheVar, // &ObjCEmptyCacheVar
5850 ObjCEmptyVtableVar, // &ObjCEmptyVtableVar
5851 ClassRoGV // &CLASS_RO_GV
5852 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005853 if (!Values[1])
5854 Values[1] = llvm::Constant::getNullValue(ObjCTypes.ClassnfABIPtrTy);
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005855 if (!Values[3])
5856 Values[3] = llvm::Constant::getNullValue(
5857 llvm::PointerType::getUnqual(ObjCTypes.ImpnfABITy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005858 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassnfABITy,
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005859 Values);
Rafael Espindola554256c2014-02-26 22:25:45 +00005860 llvm::GlobalVariable *GV = GetClassGlobal(ClassName, Weak);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00005861 GV->setInitializer(Init);
Fariborz Jahanian04087232009-01-31 01:07:39 +00005862 GV->setSection("__DATA, __objc_data");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00005863 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00005864 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassnfABITy));
Fariborz Jahanian82208252009-01-31 00:59:10 +00005865 if (HiddenVisibility)
5866 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005867 return GV;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005868}
5869
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005870bool
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00005871CGObjCNonFragileABIMac::ImplementationIsNonLazy(const ObjCImplDecl *OD) const {
Craig Topper8a13c412014-05-21 05:09:00 +00005872 return OD->getClassMethod(GetNullarySelector("load")) != nullptr;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005873}
5874
Daniel Dunbar961202372009-05-03 12:57:56 +00005875void CGObjCNonFragileABIMac::GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00005876 uint32_t &InstanceStart,
5877 uint32_t &InstanceSize) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005878 const ASTRecordLayout &RL =
Daniel Dunbar9252ee12009-05-04 21:26:30 +00005879 CGM.getContext().getASTObjCImplementationLayout(OID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005880
Daniel Dunbar9b042e02009-05-04 23:23:09 +00005881 // InstanceSize is really instance end.
Ken Dyckd5090c12011-02-11 02:20:09 +00005882 InstanceSize = RL.getDataSize().getQuantity();
Daniel Dunbar9b042e02009-05-04 23:23:09 +00005883
5884 // If there are no fields, the start is the same as the end.
5885 if (!RL.getFieldCount())
5886 InstanceStart = InstanceSize;
5887 else
Ken Dyckc5ca8762011-04-14 00:43:09 +00005888 InstanceStart = RL.getFieldOffset(0) / CGM.getContext().getCharWidth();
Daniel Dunbar554fd792009-04-19 23:41:48 +00005889}
5890
Fariborz Jahanian71394042009-01-23 23:53:38 +00005891void CGObjCNonFragileABIMac::GenerateClass(const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005892 std::string ClassName = ID->getObjCRuntimeNameAsString();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005893 if (!ObjCEmptyCacheVar) {
5894 ObjCEmptyCacheVar = new llvm::GlobalVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005895 CGM.getModule(),
5896 ObjCTypes.CacheTy,
5897 false,
5898 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00005899 nullptr,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005900 "_objc_empty_cache");
Craig Topper8a13c412014-05-21 05:09:00 +00005901
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005902 // Make this entry NULL for any iOS device target, any iOS simulator target,
5903 // OS X with deployment target 10.9 or later.
5904 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Tim Northover756447a2015-10-30 16:30:36 +00005905 if (Triple.isiOS() || Triple.isWatchOS() ||
5906 (Triple.isMacOSX() && !Triple.isMacOSXVersionLT(10, 9)))
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005907 // This entry will be null.
Craig Topper8a13c412014-05-21 05:09:00 +00005908 ObjCEmptyVtableVar = nullptr;
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005909 else
5910 ObjCEmptyVtableVar = new llvm::GlobalVariable(
5911 CGM.getModule(),
5912 ObjCTypes.ImpnfABITy,
5913 false,
5914 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00005915 nullptr,
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005916 "_objc_empty_vtable");
Fariborz Jahanian71394042009-01-23 23:53:38 +00005917 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005918 assert(ID->getClassInterface() &&
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005919 "CGObjCNonFragileABIMac::GenerateClass - class is 0");
Daniel Dunbare3f5cfc2009-04-20 20:18:54 +00005920 // FIXME: Is this correct (that meta class size is never computed)?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005921 uint32_t InstanceStart =
Micah Villmowdd31ca12012-10-08 16:25:52 +00005922 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassnfABITy);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005923 uint32_t InstanceSize = InstanceStart;
John McCallef19dbb2012-10-17 04:53:23 +00005924 uint32_t flags = NonFragileABI_Class_Meta;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005925 llvm::SmallString<64> ObjCMetaClassName(getMetaclassSymbolPrefix());
5926 llvm::SmallString<64> ObjCClassName(getClassSymbolPrefix());
5927 llvm::SmallString<64> TClassName;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005928
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005929 llvm::GlobalVariable *SuperClassGV, *IsAGV;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005930
John McCall0d54a172012-10-17 04:53:31 +00005931 // Build the flags for the metaclass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005932 bool classIsHidden =
John McCall457a04e2010-10-22 21:05:15 +00005933 ID->getClassInterface()->getVisibility() == HiddenVisibility;
Fariborz Jahanian82208252009-01-31 00:59:10 +00005934 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00005935 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00005936
5937 // FIXME: why is this flag set on the metaclass?
5938 // ObjC metaclasses have no fields and don't really get constructed.
5939 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00005940 flags |= NonFragileABI_Class_HasCXXStructors;
John McCall0d54a172012-10-17 04:53:31 +00005941 if (!ID->hasNonZeroConstructors())
5942 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
5943 }
5944
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005945 if (!ID->getClassInterface()->getSuperClass()) {
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005946 // class is root
John McCallef19dbb2012-10-17 04:53:23 +00005947 flags |= NonFragileABI_Class_Root;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005948 TClassName = ObjCClassName;
5949 TClassName += ClassName;
5950 SuperClassGV = GetClassGlobal(TClassName.str(),
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005951 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005952 TClassName = ObjCMetaClassName;
5953 TClassName += ClassName;
5954 IsAGV = GetClassGlobal(TClassName.str(),
Rafael Espindola554256c2014-02-26 22:25:45 +00005955 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005956 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005957 // Has a root. Current class is not a root.
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00005958 const ObjCInterfaceDecl *Root = ID->getClassInterface();
5959 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
5960 Root = Super;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005961 TClassName = ObjCMetaClassName ;
5962 TClassName += Root->getObjCRuntimeNameAsString();
5963 IsAGV = GetClassGlobal(TClassName.str(),
Rafael Espindola554256c2014-02-26 22:25:45 +00005964 Root->isWeakImported());
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005965
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00005966 // work on super class metadata symbol.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005967 TClassName = ObjCMetaClassName;
5968 TClassName += ID->getClassInterface()->getSuperClass()->getObjCRuntimeNameAsString();
Rafael Espindola554256c2014-02-26 22:25:45 +00005969 SuperClassGV = GetClassGlobal(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005970 TClassName.str(),
5971 ID->getClassInterface()->getSuperClass()->isWeakImported());
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005972 }
5973 llvm::GlobalVariable *CLASS_RO_GV = BuildClassRoTInitializer(flags,
5974 InstanceStart,
5975 InstanceSize,ID);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005976 TClassName = ObjCMetaClassName;
5977 TClassName += ClassName;
Rafael Espindola554256c2014-02-26 22:25:45 +00005978 llvm::GlobalVariable *MetaTClass = BuildClassMetaData(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005979 TClassName.str(), IsAGV, SuperClassGV, CLASS_RO_GV, classIsHidden,
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005980 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian67260552009-11-17 21:37:35 +00005981 DefinedMetaClasses.push_back(MetaTClass);
Daniel Dunbar15894b72009-04-07 05:48:37 +00005982
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005983 // Metadata for the class
John McCallef19dbb2012-10-17 04:53:23 +00005984 flags = 0;
Fariborz Jahanian82208252009-01-31 00:59:10 +00005985 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00005986 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00005987
5988 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00005989 flags |= NonFragileABI_Class_HasCXXStructors;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00005990
John McCall0d54a172012-10-17 04:53:31 +00005991 // Set a flag to enable a runtime optimization when a class has
5992 // fields that require destruction but which don't require
5993 // anything except zero-initialization during construction. This
5994 // is most notably true of __strong and __weak types, but you can
5995 // also imagine there being C++ types with non-trivial default
5996 // constructors that merely set all fields to null.
5997 if (!ID->hasNonZeroConstructors())
5998 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
5999 }
6000
Douglas Gregor78bd61f2009-06-18 16:11:24 +00006001 if (hasObjCExceptionAttribute(CGM.getContext(), ID->getClassInterface()))
John McCallef19dbb2012-10-17 04:53:23 +00006002 flags |= NonFragileABI_Class_Exception;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006003
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006004 if (!ID->getClassInterface()->getSuperClass()) {
John McCallef19dbb2012-10-17 04:53:23 +00006005 flags |= NonFragileABI_Class_Root;
Craig Topper8a13c412014-05-21 05:09:00 +00006006 SuperClassGV = nullptr;
Chris Lattnerb433b272009-04-19 06:02:28 +00006007 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006008 // Has a root. Current class is not a root.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006009 TClassName = ObjCClassName;
6010 TClassName += ID->getClassInterface()->getSuperClass()->getObjCRuntimeNameAsString();
Rafael Espindola554256c2014-02-26 22:25:45 +00006011 SuperClassGV = GetClassGlobal(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006012 TClassName.str(),
6013 ID->getClassInterface()->getSuperClass()->isWeakImported());
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006014 }
Daniel Dunbar961202372009-05-03 12:57:56 +00006015 GetClassSizeInfo(ID, InstanceStart, InstanceSize);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006016 CLASS_RO_GV = BuildClassRoTInitializer(flags,
Fariborz Jahaniana887e632009-01-24 23:43:01 +00006017 InstanceStart,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006018 InstanceSize,
Fariborz Jahaniana887e632009-01-24 23:43:01 +00006019 ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006020
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006021 TClassName = ObjCClassName;
6022 TClassName += ClassName;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006023 llvm::GlobalVariable *ClassMD =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006024 BuildClassMetaData(TClassName.str(), MetaTClass, SuperClassGV, CLASS_RO_GV,
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006025 classIsHidden,
6026 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian279abd32009-01-30 20:55:31 +00006027 DefinedClasses.push_back(ClassMD);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006028 ImplementedClasses.push_back(ID->getClassInterface());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006029
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006030 // Determine if this class is also "non-lazy".
6031 if (ImplementationIsNonLazy(ID))
6032 DefinedNonLazyClasses.push_back(ClassMD);
6033
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006034 // Force the definition of the EHType if necessary.
John McCallef19dbb2012-10-17 04:53:23 +00006035 if (flags & NonFragileABI_Class_Exception)
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006036 GetInterfaceEHType(ID->getClassInterface(), true);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006037 // Make sure method definition entries are all clear for next implementation.
6038 MethodDefinitions.clear();
Fariborz Jahanian71394042009-01-23 23:53:38 +00006039}
6040
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006041/// GenerateProtocolRef - This routine is called to generate code for
6042/// a protocol reference expression; as in:
6043/// @code
6044/// @protocol(Proto1);
6045/// @endcode
6046/// It generates a weak reference to l_OBJC_PROTOCOL_REFERENCE_$_Proto1
6047/// which will hold address of the protocol meta-data.
6048///
John McCall882987f2013-02-28 19:01:20 +00006049llvm::Value *CGObjCNonFragileABIMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006050 const ObjCProtocolDecl *PD) {
6051
Fariborz Jahanian464423d2009-04-10 18:47:34 +00006052 // This routine is called for @protocol only. So, we must build definition
6053 // of protocol's meta-data (not a reference to it!)
6054 //
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006055 llvm::Constant *Init =
6056 llvm::ConstantExpr::getBitCast(GetOrEmitProtocol(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00006057 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006058
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006059 std::string ProtocolName("\01l_OBJC_PROTOCOL_REFERENCE_$_");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006060 ProtocolName += PD->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006061
John McCall7f416cc2015-09-08 08:05:57 +00006062 CharUnits Align = CGF.getPointerAlign();
6063
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006064 llvm::GlobalVariable *PTGV = CGM.getModule().getGlobalVariable(ProtocolName);
6065 if (PTGV)
John McCall7f416cc2015-09-08 08:05:57 +00006066 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006067 PTGV = new llvm::GlobalVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006068 CGM.getModule(),
6069 Init->getType(), false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006070 llvm::GlobalValue::WeakAnyLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006071 Init,
6072 ProtocolName);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006073 PTGV->setSection("__DATA, __objc_protorefs, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006074 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall7f416cc2015-09-08 08:05:57 +00006075 PTGV->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00006076 CGM.addCompilerUsedGlobal(PTGV);
John McCall7f416cc2015-09-08 08:05:57 +00006077 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006078}
6079
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006080/// GenerateCategory - Build metadata for a category implementation.
6081/// struct _category_t {
6082/// const char * const name;
6083/// struct _class_t *const cls;
6084/// const struct _method_list_t * const instance_methods;
6085/// const struct _method_list_t * const class_methods;
6086/// const struct _protocol_list_t * const protocols;
6087/// const struct _prop_list_t * const properties;
6088/// }
6089///
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006090void CGObjCNonFragileABIMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006091 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006092 const char *Prefix = "\01l_OBJC_$_CATEGORY_";
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006093
6094 llvm::SmallString<64> ExtCatName(Prefix);
6095 ExtCatName += Interface->getObjCRuntimeNameAsString();
6096 ExtCatName += "_$_";
6097 ExtCatName += OCD->getNameAsString();
6098
6099 llvm::SmallString<64> ExtClassName(getClassSymbolPrefix());
6100 ExtClassName += Interface->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006101
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006102 llvm::Constant *Values[6];
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006103 Values[0] = GetClassName(OCD->getIdentifier()->getName());
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006104 // meta-class entry symbol
Rafael Espindola554256c2014-02-26 22:25:45 +00006105 llvm::GlobalVariable *ClassGV =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006106 GetClassGlobal(ExtClassName.str(), Interface->isWeakImported());
Rafael Espindola554256c2014-02-26 22:25:45 +00006107
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006108 Values[1] = ClassGV;
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006109 std::vector<llvm::Constant*> Methods;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006110 llvm::SmallString<64> MethodListName(Prefix);
6111
6112 MethodListName += "INSTANCE_METHODS_";
6113 MethodListName += Interface->getObjCRuntimeNameAsString();
6114 MethodListName += "_$_";
6115 MethodListName += OCD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006116
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006117 for (const auto *I : OCD->instance_methods())
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006118 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006119 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006120
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006121 Values[2] = EmitMethodList(MethodListName.str(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006122 "__DATA, __objc_const",
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006123 Methods);
6124
6125 MethodListName = Prefix;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006126 MethodListName += "CLASS_METHODS_";
6127 MethodListName += Interface->getObjCRuntimeNameAsString();
6128 MethodListName += "_$_";
6129 MethodListName += OCD->getNameAsString();
6130
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006131 Methods.clear();
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006132 for (const auto *I : OCD->class_methods())
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006133 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006134 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006135
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006136 Values[3] = EmitMethodList(MethodListName.str(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006137 "__DATA, __objc_const",
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006138 Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006139 const ObjCCategoryDecl *Category =
Fariborz Jahanian066347e2009-01-28 22:18:42 +00006140 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006141 if (Category) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006142 SmallString<256> ExtName;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006143 llvm::raw_svector_ostream(ExtName) << Interface->getObjCRuntimeNameAsString() << "_$_"
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006144 << OCD->getName();
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006145 Values[4] = EmitProtocolList("\01l_OBJC_CATEGORY_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006146 + Interface->getObjCRuntimeNameAsString() + "_$_"
6147 + Category->getName(),
6148 Category->protocol_begin(),
6149 Category->protocol_end());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006150 Values[5] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
6151 OCD, Category, ObjCTypes);
Mike Stump658fe022009-07-30 22:28:39 +00006152 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00006153 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
6154 Values[5] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006155 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006156
6157 llvm::Constant *Init =
6158 llvm::ConstantStruct::get(ObjCTypes.CategorynfABITy,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006159 Values);
6160 llvm::GlobalVariable *GCATV
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006161 = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.CategorynfABITy,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006162 false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006163 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006164 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006165 ExtCatName.str());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006166 GCATV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006167 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.CategorynfABITy));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006168 GCATV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006169 CGM.addCompilerUsedGlobal(GCATV);
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006170 DefinedCategories.push_back(GCATV);
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006171
6172 // Determine if this category is also "non-lazy".
6173 if (ImplementationIsNonLazy(OCD))
6174 DefinedNonLazyCategories.push_back(GCATV);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006175 // method definition entries must be clear for next implementation.
6176 MethodDefinitions.clear();
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006177}
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006178
6179/// GetMethodConstant - Return a struct objc_method constant for the
6180/// given method if it has been defined. The result is null if the
6181/// method has not been defined. The return value has type MethodPtrTy.
6182llvm::Constant *CGObjCNonFragileABIMac::GetMethodConstant(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006183 const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00006184 llvm::Function *Fn = GetMethodDefinition(MD);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006185 if (!Fn)
Craig Topper8a13c412014-05-21 05:09:00 +00006186 return nullptr;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006187
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006188 llvm::Constant *Method[] = {
Owen Andersonade90fd2009-07-29 18:54:39 +00006189 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006190 ObjCTypes.SelectorPtrTy),
6191 GetMethodVarType(MD),
6192 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
6193 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00006194 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006195}
6196
6197/// EmitMethodList - Build meta-data for method declarations
6198/// struct _method_list_t {
6199/// uint32_t entsize; // sizeof(struct _objc_method)
6200/// uint32_t method_count;
6201/// struct _objc_method method_list[method_count];
6202/// }
6203///
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00006204llvm::Constant *
6205CGObjCNonFragileABIMac::EmitMethodList(Twine Name,
6206 const char *Section,
6207 ArrayRef<llvm::Constant*> Methods) {
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006208 // Return null for empty list.
6209 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006210 return llvm::Constant::getNullValue(ObjCTypes.MethodListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006211
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006212 llvm::Constant *Values[3];
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006213 // sizeof(struct _objc_method)
Micah Villmowdd31ca12012-10-08 16:25:52 +00006214 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.MethodTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006215 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006216 // method_count
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006217 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00006218 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006219 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00006220 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006221 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006222
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006223 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006224 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006225 llvm::GlobalValue::PrivateLinkage, Init, Name);
Micah Villmowdd31ca12012-10-08 16:25:52 +00006226 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006227 GV->setSection(Section);
Rafael Espindola060062a2014-03-06 22:15:10 +00006228 CGM.addCompilerUsedGlobal(GV);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006229 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListnfABIPtrTy);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006230}
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006231
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006232/// ObjCIvarOffsetVariable - Returns the ivar offset variable for
6233/// the given ivar.
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006234llvm::GlobalVariable *
6235CGObjCNonFragileABIMac::ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
6236 const ObjCIvarDecl *Ivar) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006237
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006238 const ObjCInterfaceDecl *Container = Ivar->getContainingInterface();
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006239 llvm::SmallString<64> Name("OBJC_IVAR_$_");
6240 Name += Container->getObjCRuntimeNameAsString();
6241 Name += ".";
6242 Name += Ivar->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006243 llvm::GlobalVariable *IvarOffsetGV =
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006244 CGM.getModule().getGlobalVariable(Name);
6245 if (!IvarOffsetGV)
Tim Northover238b5082014-03-29 13:42:40 +00006246 IvarOffsetGV = new llvm::GlobalVariable(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006247 CGM.getModule(), ObjCTypes.IvarOffsetVarTy, false,
6248 llvm::GlobalValue::ExternalLinkage, nullptr, Name.str());
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006249 return IvarOffsetGV;
6250}
6251
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006252llvm::Constant *
6253CGObjCNonFragileABIMac::EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
6254 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00006255 unsigned long int Offset) {
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006256 llvm::GlobalVariable *IvarOffsetGV = ObjCIvarOffsetVariable(ID, Ivar);
Tim Northover238b5082014-03-29 13:42:40 +00006257 IvarOffsetGV->setInitializer(
6258 llvm::ConstantInt::get(ObjCTypes.IvarOffsetVarTy, Offset));
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006259 IvarOffsetGV->setAlignment(
Tim Northover238b5082014-03-29 13:42:40 +00006260 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.IvarOffsetVarTy));
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006261
Mike Stump18bb9282009-05-16 07:57:57 +00006262 // FIXME: This matches gcc, but shouldn't the visibility be set on the use as
6263 // well (i.e., in ObjCIvarOffsetVariable).
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006264 if (Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6265 Ivar->getAccessControl() == ObjCIvarDecl::Package ||
John McCall457a04e2010-10-22 21:05:15 +00006266 ID->getVisibility() == HiddenVisibility)
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00006267 IvarOffsetGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Daniel Dunbarf5f359f2009-04-14 06:00:08 +00006268 else
Fariborz Jahanianbc3c77b2009-04-06 18:30:00 +00006269 IvarOffsetGV->setVisibility(llvm::GlobalValue::DefaultVisibility);
Bill Wendlingf7d45982011-05-04 21:37:25 +00006270 IvarOffsetGV->setSection("__DATA, __objc_ivar");
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006271 return IvarOffsetGV;
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006272}
6273
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006274/// EmitIvarList - Emit the ivar list for the given
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006275/// implementation. The return value has type
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006276/// IvarListnfABIPtrTy.
6277/// struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00006278/// unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006279/// char *name;
6280/// char *type;
6281/// uint32_t alignment;
6282/// uint32_t size;
6283/// }
6284/// struct _ivar_list_t {
6285/// uint32 entsize; // sizeof(struct _ivar_t)
6286/// uint32 count;
6287/// struct _iver_t list[count];
6288/// }
6289///
Daniel Dunbarf5c18462009-04-20 06:54:31 +00006290
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006291llvm::Constant *CGObjCNonFragileABIMac::EmitIvarList(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006292 const ObjCImplementationDecl *ID) {
6293
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006294 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006295
Jordy Rosea91768e2011-07-22 02:08:32 +00006296 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006297 assert(OID && "CGObjCNonFragileABIMac::EmitIvarList - null interface");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006298
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006299 // FIXME. Consolidate this with similar code in GenerateClass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006300
Jordy Rosea91768e2011-07-22 02:08:32 +00006301 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00006302 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00006303 // Ignore unnamed bit-fields.
6304 if (!IVD->getDeclName())
6305 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006306 llvm::Constant *Ivar[5];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006307 Ivar[0] = EmitIvarOffsetVar(ID->getClassInterface(), IVD,
Daniel Dunbar961202372009-05-03 12:57:56 +00006308 ComputeIvarBaseOffset(CGM, ID, IVD));
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006309 Ivar[1] = GetMethodVarName(IVD->getIdentifier());
6310 Ivar[2] = GetMethodVarType(IVD);
Chris Lattner2192fe52011-07-18 04:24:23 +00006311 llvm::Type *FieldTy =
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006312 CGM.getTypes().ConvertTypeForMem(IVD->getType());
Micah Villmowdd31ca12012-10-08 16:25:52 +00006313 unsigned Size = CGM.getDataLayout().getTypeAllocSize(FieldTy);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006314 unsigned Align = CGM.getContext().getPreferredTypeAlign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006315 IVD->getType().getTypePtr()) >> 3;
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006316 Align = llvm::Log2_32(Align);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006317 Ivar[3] = llvm::ConstantInt::get(ObjCTypes.IntTy, Align);
Daniel Dunbarae032262009-04-20 00:33:43 +00006318 // NOTE. Size of a bitfield does not match gcc's, because of the
6319 // way bitfields are treated special in each. But I am told that
6320 // 'size' for bitfield ivars is ignored by the runtime so it does
6321 // not matter. If it matters, there is enough info to get the
6322 // bitfield right!
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006323 Ivar[4] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson0e0189d2009-07-27 22:29:56 +00006324 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarnfABITy, Ivar));
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006325 }
6326 // Return null for empty list.
6327 if (Ivars.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006328 return llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006329
6330 llvm::Constant *Values[3];
Micah Villmowdd31ca12012-10-08 16:25:52 +00006331 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.IvarnfABITy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006332 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
6333 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00006334 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarnfABITy,
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006335 Ivars.size());
Owen Anderson47034e12009-07-28 18:33:04 +00006336 Values[2] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006337 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006338 const char *Prefix = "\01l_OBJC_$_INSTANCE_VARIABLES_";
6339 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006340 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006341 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006342 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006343 Prefix + OID->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006344 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006345 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006346 GV->setSection("__DATA, __objc_const");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006347
Rafael Espindola060062a2014-03-06 22:15:10 +00006348 CGM.addCompilerUsedGlobal(GV);
Owen Andersonade90fd2009-07-29 18:54:39 +00006349 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006350}
6351
6352llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocolRef(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006353 const ObjCProtocolDecl *PD) {
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006354 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006355
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006356 if (!Entry) {
6357 // We use the initializer as a marker of whether this is a forward
6358 // reference or not. At module finalization we add the empty
6359 // contents for protocols which were referenced but never defined.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006360 Entry =
Rafael Espindola5d117f32014-03-06 01:10:46 +00006361 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Rafael Espindola24615092014-09-12 20:14:20 +00006362 false, llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00006363 nullptr,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006364 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006365 Entry->setSection("__DATA,__datacoal_nt,coalesced");
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006366 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006367
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006368 return Entry;
6369}
6370
6371/// GetOrEmitProtocol - Generate the protocol meta-data:
6372/// @code
6373/// struct _protocol_t {
6374/// id isa; // NULL
6375/// const char * const protocol_name;
6376/// const struct _protocol_list_t * protocol_list; // super protocols
6377/// const struct method_list_t * const instance_methods;
6378/// const struct method_list_t * const class_methods;
6379/// const struct method_list_t *optionalInstanceMethods;
6380/// const struct method_list_t *optionalClassMethods;
6381/// const struct _prop_list_t * properties;
6382/// const uint32_t size; // sizeof(struct _protocol_t)
6383/// const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006384/// const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006385/// const char *demangledName;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006386/// }
6387/// @endcode
6388///
6389
6390llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocol(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006391 const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00006392 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006393
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006394 // Early exit if a defining object has already been generated.
6395 if (Entry && Entry->hasInitializer())
6396 return Entry;
6397
Douglas Gregora715bff2012-01-01 19:51:50 +00006398 // Use the protocol definition, if there is one.
6399 if (const ObjCProtocolDecl *Def = PD->getDefinition())
6400 PD = Def;
6401
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006402 // Construct method lists.
6403 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
6404 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006405 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006406 for (const auto *MD : PD->instance_methods()) {
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006407 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006408 if (!C)
6409 return GetOrEmitProtocolRef(PD);
6410
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006411 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6412 OptInstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006413 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006414 } else {
6415 InstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006416 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006417 }
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006418 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006419
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006420 for (const auto *MD : PD->class_methods()) {
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006421 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006422 if (!C)
6423 return GetOrEmitProtocolRef(PD);
6424
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006425 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6426 OptClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006427 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006428 } else {
6429 ClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006430 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006431 }
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006432 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006433
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006434 MethodTypesExt.insert(MethodTypesExt.end(),
6435 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
6436
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006437 llvm::Constant *Values[12];
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006438 // isa is NULL
Owen Anderson0b75f232009-07-31 20:28:54 +00006439 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ObjectPtrTy);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006440 Values[1] = GetClassName(PD->getObjCRuntimeNameAsString());
6441 Values[2] = EmitProtocolList("\01l_OBJC_$_PROTOCOL_REFS_" + PD->getObjCRuntimeNameAsString(),
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006442 PD->protocol_begin(),
6443 PD->protocol_end());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006444
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006445 Values[3] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006446 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006447 "__DATA, __objc_const",
6448 InstanceMethods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006449 Values[4] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006450 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006451 "__DATA, __objc_const",
6452 ClassMethods);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006453 Values[5] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_OPT_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006454 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006455 "__DATA, __objc_const",
6456 OptInstanceMethods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006457 Values[6] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_OPT_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006458 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006459 "__DATA, __objc_const",
6460 OptClassMethods);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006461 Values[7] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
Craig Topper8a13c412014-05-21 05:09:00 +00006462 nullptr, PD, ObjCTypes);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006463 uint32_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006464 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolnfABITy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006465 Values[8] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson0b75f232009-07-31 20:28:54 +00006466 Values[9] = llvm::Constant::getNullValue(ObjCTypes.IntTy);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006467 Values[10] = EmitProtocolMethodTypes("\01l_OBJC_$_PROTOCOL_METHOD_TYPES_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006468 + PD->getObjCRuntimeNameAsString(),
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006469 MethodTypesExt, ObjCTypes);
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006470 // const char *demangledName;
6471 Values[11] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
6472
Owen Anderson0e0189d2009-07-27 22:29:56 +00006473 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolnfABITy,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006474 Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006475
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006476 if (Entry) {
Rafael Espindola24615092014-09-12 20:14:20 +00006477 // Already created, fix the linkage and update the initializer.
6478 Entry->setLinkage(llvm::GlobalValue::WeakAnyLinkage);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006479 Entry->setInitializer(Init);
6480 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006481 Entry =
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006482 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006483 false, llvm::GlobalValue::WeakAnyLinkage, Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006484 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006485 Entry->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006486 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABITy));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006487 Entry->setSection("__DATA,__datacoal_nt,coalesced");
John McCallf9582a72012-03-30 21:29:05 +00006488
6489 Protocols[PD->getIdentifier()] = Entry;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006490 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006491 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006492 CGM.addCompilerUsedGlobal(Entry);
Chris Lattnerf56501c2009-07-17 23:57:13 +00006493
Fariborz Jahanian61cd4b52009-01-29 20:10:59 +00006494 // Use this protocol meta-data to build protocol list table in section
6495 // __DATA, __objc_protolist
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006496 llvm::GlobalVariable *PTGV =
6497 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABIPtrTy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006498 false, llvm::GlobalValue::WeakAnyLinkage, Entry,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006499 "\01l_OBJC_LABEL_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006500 PTGV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006501 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABIPtrTy));
Daniel Dunbarb25452a2009-04-15 02:56:18 +00006502 PTGV->setSection("__DATA, __objc_protolist, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006503 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006504 CGM.addCompilerUsedGlobal(PTGV);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006505 return Entry;
6506}
6507
6508/// EmitProtocolList - Generate protocol list meta-data:
6509/// @code
6510/// struct _protocol_list_t {
6511/// long protocol_count; // Note, this is 32/64 bit
6512/// struct _protocol_t[protocol_count];
6513/// }
6514/// @endcode
6515///
6516llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00006517CGObjCNonFragileABIMac::EmitProtocolList(Twine Name,
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006518 ObjCProtocolDecl::protocol_iterator begin,
6519 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006520 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006521
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006522 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006523 if (begin == end)
Owen Anderson0b75f232009-07-31 20:28:54 +00006524 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006525
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006526 // FIXME: We shouldn't need to do this lookup here, should we?
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006527 SmallString<256> TmpName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006528 Name.toVector(TmpName);
6529 llvm::GlobalVariable *GV =
6530 CGM.getModule().getGlobalVariable(TmpName.str(), true);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006531 if (GV)
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006532 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006533
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006534 for (; begin != end; ++begin)
6535 ProtocolRefs.push_back(GetProtocolRef(*begin)); // Implemented???
6536
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006537 // This list is null terminated.
Owen Anderson0b75f232009-07-31 20:28:54 +00006538 ProtocolRefs.push_back(llvm::Constant::getNullValue(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006539 ObjCTypes.ProtocolnfABIPtrTy));
6540
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006541 llvm::Constant *Values[2];
Owen Anderson170229f2009-07-14 23:10:40 +00006542 Values[0] =
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006543 llvm::ConstantInt::get(ObjCTypes.LongTy, ProtocolRefs.size() - 1);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006544 Values[1] =
Bill Wendlinga515b582012-02-09 22:16:49 +00006545 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolnfABIPtrTy,
6546 ProtocolRefs.size()),
6547 ProtocolRefs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006548
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006549 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Owen Andersonc10c8d32009-07-08 19:05:04 +00006550 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006551 llvm::GlobalValue::PrivateLinkage,
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006552 Init, Name);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006553 GV->setSection("__DATA, __objc_const");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006554 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006555 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Rafael Espindola060062a2014-03-06 22:15:10 +00006556 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006557 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006558 ObjCTypes.ProtocolListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006559}
6560
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006561/// GetMethodDescriptionConstant - This routine build following meta-data:
6562/// struct _objc_method {
6563/// SEL _cmd;
6564/// char *method_type;
6565/// char *_imp;
6566/// }
6567
6568llvm::Constant *
6569CGObjCNonFragileABIMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006570 llvm::Constant *Desc[3];
Owen Anderson170229f2009-07-14 23:10:40 +00006571 Desc[0] =
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006572 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
6573 ObjCTypes.SelectorPtrTy);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006574 Desc[1] = GetMethodVarType(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006575 if (!Desc[1])
Craig Topper8a13c412014-05-21 05:09:00 +00006576 return nullptr;
6577
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006578 // Protocol methods have no implementation. So, this entry is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00006579 Desc[2] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00006580 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Desc);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006581}
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006582
6583/// EmitObjCValueForIvar - Code Gen for nonfragile ivar reference.
6584/// This code gen. amounts to generating code for:
6585/// @code
6586/// (type *)((char *)base + _OBJC_IVAR_$_.ivar;
6587/// @encode
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006588///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00006589LValue CGObjCNonFragileABIMac::EmitObjCValueForIvar(
John McCall96fa4842010-05-17 21:00:27 +00006590 CodeGen::CodeGenFunction &CGF,
6591 QualType ObjectTy,
6592 llvm::Value *BaseValue,
6593 const ObjCIvarDecl *Ivar,
6594 unsigned CVRQualifiers) {
6595 ObjCInterfaceDecl *ID = ObjectTy->getAs<ObjCObjectType>()->getInterface();
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006596 llvm::Value *Offset = EmitIvarOffset(CGF, ID, Ivar);
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00006597 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006598 Offset);
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006599}
6600
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006601llvm::Value *CGObjCNonFragileABIMac::EmitIvarOffset(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006602 CodeGen::CodeGenFunction &CGF,
6603 const ObjCInterfaceDecl *Interface,
6604 const ObjCIvarDecl *Ivar) {
Tim Northover238b5082014-03-29 13:42:40 +00006605 llvm::Value *IvarOffsetValue = ObjCIvarOffsetVariable(Interface, Ivar);
John McCall7f416cc2015-09-08 08:05:57 +00006606 IvarOffsetValue = CGF.Builder.CreateAlignedLoad(IvarOffsetValue,
6607 CGF.getSizeAlign(), "ivar");
Tim Northover238b5082014-03-29 13:42:40 +00006608 if (IsIvarOffsetKnownIdempotent(CGF, Ivar))
6609 cast<llvm::LoadInst>(IvarOffsetValue)
6610 ->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
Craig Topper5fc8fc22014-08-27 06:28:36 +00006611 llvm::MDNode::get(VMContext, None));
Tim Northover238b5082014-03-29 13:42:40 +00006612
6613 // This could be 32bit int or 64bit integer depending on the architecture.
6614 // Cast it to 64bit integer value, if it is a 32bit integer ivar offset value
6615 // as this is what caller always expectes.
6616 if (ObjCTypes.IvarOffsetVarTy == ObjCTypes.IntTy)
6617 IvarOffsetValue = CGF.Builder.CreateIntCast(
6618 IvarOffsetValue, ObjCTypes.LongTy, true, "ivar.conv");
6619 return IvarOffsetValue;
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006620}
6621
John McCall234eac82011-05-13 23:16:18 +00006622static void appendSelectorForMessageRefTable(std::string &buffer,
6623 Selector selector) {
6624 if (selector.isUnarySelector()) {
6625 buffer += selector.getNameForSlot(0);
6626 return;
6627 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006628
John McCall234eac82011-05-13 23:16:18 +00006629 for (unsigned i = 0, e = selector.getNumArgs(); i != e; ++i) {
6630 buffer += selector.getNameForSlot(i);
6631 buffer += '_';
6632 }
6633}
6634
John McCall9e8bb002011-05-14 03:10:52 +00006635/// Emit a "v-table" message send. We emit a weak hidden-visibility
6636/// struct, initially containing the selector pointer and a pointer to
6637/// a "fixup" variant of the appropriate objc_msgSend. To call, we
6638/// load and call the function pointer, passing the address of the
6639/// struct as the second parameter. The runtime determines whether
6640/// the selector is currently emitted using vtable dispatch; if so, it
6641/// substitutes a stub function which simply tail-calls through the
6642/// appropriate vtable slot, and if not, it substitues a stub function
6643/// which tail-calls objc_msgSend. Both stubs adjust the selector
6644/// argument to correctly point to the selector.
6645RValue
6646CGObjCNonFragileABIMac::EmitVTableMessageSend(CodeGenFunction &CGF,
6647 ReturnValueSlot returnSlot,
6648 QualType resultType,
6649 Selector selector,
6650 llvm::Value *arg0,
6651 QualType arg0Type,
6652 bool isSuper,
6653 const CallArgList &formalArgs,
6654 const ObjCMethodDecl *method) {
John McCall234eac82011-05-13 23:16:18 +00006655 // Compute the actual arguments.
6656 CallArgList args;
6657
John McCall9e8bb002011-05-14 03:10:52 +00006658 // First argument: the receiver / super-call structure.
John McCall234eac82011-05-13 23:16:18 +00006659 if (!isSuper)
John McCall9e8bb002011-05-14 03:10:52 +00006660 arg0 = CGF.Builder.CreateBitCast(arg0, ObjCTypes.ObjectPtrTy);
6661 args.add(RValue::get(arg0), arg0Type);
John McCall234eac82011-05-13 23:16:18 +00006662
John McCall9e8bb002011-05-14 03:10:52 +00006663 // Second argument: a pointer to the message ref structure. Leave
6664 // the actual argument value blank for now.
Craig Topper8a13c412014-05-21 05:09:00 +00006665 args.add(RValue::get(nullptr), ObjCTypes.MessageRefCPtrTy);
John McCall234eac82011-05-13 23:16:18 +00006666
6667 args.insert(args.end(), formalArgs.begin(), formalArgs.end());
6668
John McCalla729c622012-02-17 03:33:10 +00006669 MessageSendInfo MSI = getMessageSendInfo(method, resultType, args);
John McCall234eac82011-05-13 23:16:18 +00006670
John McCall5880fb82011-05-14 21:12:11 +00006671 NullReturnState nullReturn;
6672
John McCall9e8bb002011-05-14 03:10:52 +00006673 // Find the function to call and the mangled name for the message
6674 // ref structure. Using a different mangled name wouldn't actually
6675 // be a problem; it would just be a waste.
6676 //
6677 // The runtime currently never uses vtable dispatch for anything
6678 // except normal, non-super message-sends.
6679 // FIXME: don't use this for that.
Craig Topper8a13c412014-05-21 05:09:00 +00006680 llvm::Constant *fn = nullptr;
John McCall234eac82011-05-13 23:16:18 +00006681 std::string messageRefName("\01l_");
Tim Northovere77cc392014-03-29 13:28:05 +00006682 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall234eac82011-05-13 23:16:18 +00006683 if (isSuper) {
6684 fn = ObjCTypes.getMessageSendSuper2StretFixupFn();
6685 messageRefName += "objc_msgSendSuper2_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006686 } else {
John McCall5880fb82011-05-14 21:12:11 +00006687 nullReturn.init(CGF, arg0);
John McCall234eac82011-05-13 23:16:18 +00006688 fn = ObjCTypes.getMessageSendStretFixupFn();
6689 messageRefName += "objc_msgSend_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006690 }
John McCall234eac82011-05-13 23:16:18 +00006691 } else if (!isSuper && CGM.ReturnTypeUsesFPRet(resultType)) {
6692 fn = ObjCTypes.getMessageSendFpretFixupFn();
6693 messageRefName += "objc_msgSend_fpret_fixup";
Mike Stump658fe022009-07-30 22:28:39 +00006694 } else {
John McCall234eac82011-05-13 23:16:18 +00006695 if (isSuper) {
6696 fn = ObjCTypes.getMessageSendSuper2FixupFn();
6697 messageRefName += "objc_msgSendSuper2_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006698 } else {
John McCall234eac82011-05-13 23:16:18 +00006699 fn = ObjCTypes.getMessageSendFixupFn();
6700 messageRefName += "objc_msgSend_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006701 }
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00006702 }
John McCall234eac82011-05-13 23:16:18 +00006703 assert(fn && "CGObjCNonFragileABIMac::EmitMessageSend");
6704 messageRefName += '_';
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006705
John McCall234eac82011-05-13 23:16:18 +00006706 // Append the selector name, except use underscores anywhere we
6707 // would have used colons.
6708 appendSelectorForMessageRefTable(messageRefName, selector);
6709
6710 llvm::GlobalVariable *messageRef
6711 = CGM.getModule().getGlobalVariable(messageRefName);
6712 if (!messageRef) {
John McCall9e8bb002011-05-14 03:10:52 +00006713 // Build the message ref structure.
John McCall234eac82011-05-13 23:16:18 +00006714 llvm::Constant *values[] = { fn, GetMethodVarName(selector) };
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006715 llvm::Constant *init = llvm::ConstantStruct::getAnon(values);
John McCall234eac82011-05-13 23:16:18 +00006716 messageRef = new llvm::GlobalVariable(CGM.getModule(),
6717 init->getType(),
6718 /*constant*/ false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006719 llvm::GlobalValue::WeakAnyLinkage,
John McCall234eac82011-05-13 23:16:18 +00006720 init,
6721 messageRefName);
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006722 messageRef->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall234eac82011-05-13 23:16:18 +00006723 messageRef->setAlignment(16);
6724 messageRef->setSection("__DATA, __objc_msgrefs, coalesced");
6725 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006726
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00006727 bool requiresnullCheck = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00006728 if (CGM.getLangOpts().ObjCAutoRefCount && method)
Aaron Ballman43b68be2014-03-07 17:50:17 +00006729 for (const auto *ParamDecl : method->params()) {
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00006730 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
6731 if (!nullReturn.NullBB)
6732 nullReturn.init(CGF, arg0);
6733 requiresnullCheck = true;
6734 break;
6735 }
6736 }
6737
John McCall7f416cc2015-09-08 08:05:57 +00006738 Address mref =
6739 Address(CGF.Builder.CreateBitCast(messageRef, ObjCTypes.MessageRefPtrTy),
6740 CGF.getPointerAlign());
John McCall234eac82011-05-13 23:16:18 +00006741
John McCall9e8bb002011-05-14 03:10:52 +00006742 // Update the message ref argument.
John McCall7f416cc2015-09-08 08:05:57 +00006743 args[1].RV = RValue::get(mref.getPointer());
John McCall234eac82011-05-13 23:16:18 +00006744
6745 // Load the function to call from the message ref table.
John McCall7f416cc2015-09-08 08:05:57 +00006746 Address calleeAddr =
6747 CGF.Builder.CreateStructGEP(mref, 0, CharUnits::Zero());
6748 llvm::Value *callee = CGF.Builder.CreateLoad(calleeAddr, "msgSend_fn");
John McCall234eac82011-05-13 23:16:18 +00006749
John McCalla729c622012-02-17 03:33:10 +00006750 callee = CGF.Builder.CreateBitCast(callee, MSI.MessengerType);
John McCall234eac82011-05-13 23:16:18 +00006751
John McCalla729c622012-02-17 03:33:10 +00006752 RValue result = CGF.EmitCall(MSI.CallInfo, callee, returnSlot, args);
Craig Topper8a13c412014-05-21 05:09:00 +00006753 return nullReturn.complete(CGF, result, resultType, formalArgs,
6754 requiresnullCheck ? method : nullptr);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00006755}
6756
6757/// Generate code for a message send expression in the nonfragile abi.
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006758CodeGen::RValue
6759CGObjCNonFragileABIMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00006760 ReturnValueSlot Return,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006761 QualType ResultType,
6762 Selector Sel,
6763 llvm::Value *Receiver,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006764 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00006765 const ObjCInterfaceDecl *Class,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006766 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00006767 return isVTableDispatchedSelector(Sel)
6768 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006769 Receiver, CGF.getContext().getObjCIdType(),
John McCall9e8bb002011-05-14 03:10:52 +00006770 false, CallArgs, Method)
6771 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00006772 EmitSelector(CGF, Sel),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006773 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00006774 false, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00006775}
6776
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006777llvm::GlobalVariable *
Rafael Espindola554256c2014-02-26 22:25:45 +00006778CGObjCNonFragileABIMac::GetClassGlobal(const std::string &Name, bool Weak) {
6779 llvm::GlobalValue::LinkageTypes L =
6780 Weak ? llvm::GlobalValue::ExternalWeakLinkage
6781 : llvm::GlobalValue::ExternalLinkage;
6782
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006783 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
6784
Rafael Espindola554256c2014-02-26 22:25:45 +00006785 if (!GV)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006786 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABITy,
Craig Topper8a13c412014-05-21 05:09:00 +00006787 false, L, nullptr, Name);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006788
Rafael Espindola554256c2014-02-26 22:25:45 +00006789 assert(GV->getLinkage() == L);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006790 return GV;
6791}
6792
John McCall882987f2013-02-28 19:01:20 +00006793llvm::Value *CGObjCNonFragileABIMac::EmitClassRefFromId(CodeGenFunction &CGF,
Rafael Espindola554256c2014-02-26 22:25:45 +00006794 IdentifierInfo *II,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006795 bool Weak,
6796 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00006797 CharUnits Align = CGF.getPointerAlign();
John McCall31168b02011-06-15 23:02:42 +00006798 llvm::GlobalVariable *&Entry = ClassReferences[II];
6799
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006800 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006801 std::string ClassName(
6802 getClassSymbolPrefix() +
6803 (ID ? ID->getObjCRuntimeNameAsString() : II->getName()).str());
Rafael Espindola554256c2014-02-26 22:25:45 +00006804 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName, Weak);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006805 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6806 false, llvm::GlobalValue::PrivateLinkage,
6807 ClassGV, "OBJC_CLASSLIST_REFERENCES_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006808 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006809 Entry->setSection("__DATA, __objc_classrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006810 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006811 }
John McCall7f416cc2015-09-08 08:05:57 +00006812 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006813}
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006814
John McCall882987f2013-02-28 19:01:20 +00006815llvm::Value *CGObjCNonFragileABIMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00006816 const ObjCInterfaceDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006817 return EmitClassRefFromId(CGF, ID->getIdentifier(), ID->isWeakImported(), ID);
John McCall31168b02011-06-15 23:02:42 +00006818}
6819
6820llvm::Value *CGObjCNonFragileABIMac::EmitNSAutoreleasePoolClassRef(
John McCall882987f2013-02-28 19:01:20 +00006821 CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00006822 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
Hans Wennborgdcfba332015-10-06 23:40:43 +00006823 return EmitClassRefFromId(CGF, II, false, nullptr);
John McCall31168b02011-06-15 23:02:42 +00006824}
6825
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006826llvm::Value *
John McCall882987f2013-02-28 19:01:20 +00006827CGObjCNonFragileABIMac::EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006828 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00006829 CharUnits Align = CGF.getPointerAlign();
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006830 llvm::GlobalVariable *&Entry = SuperClassReferences[ID->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006831
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006832 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006833 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6834 ClassName += ID->getObjCRuntimeNameAsString();
6835 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(),
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006836 ID->isWeakImported());
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006837 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6838 false, llvm::GlobalValue::PrivateLinkage,
6839 ClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006840 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006841 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006842 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006843 }
John McCall7f416cc2015-09-08 08:05:57 +00006844 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006845}
6846
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006847/// EmitMetaClassRef - Return a Value * of the address of _class_t
6848/// meta-data
6849///
John McCall882987f2013-02-28 19:01:20 +00006850llvm::Value *CGObjCNonFragileABIMac::EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00006851 const ObjCInterfaceDecl *ID,
6852 bool Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00006853 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006854 llvm::GlobalVariable * &Entry = MetaClassReferences[ID->getIdentifier()];
Rafael Espindola21039aa2014-02-27 16:26:32 +00006855 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006856 llvm::SmallString<64> MetaClassName(getMetaclassSymbolPrefix());
6857 MetaClassName += ID->getObjCRuntimeNameAsString();
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00006858 llvm::GlobalVariable *MetaClassGV =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006859 GetClassGlobal(MetaClassName.str(), Weak);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006860
Rafael Espindola21039aa2014-02-27 16:26:32 +00006861 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006862 false, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006863 MetaClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006864 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006865
Rafael Espindola21039aa2014-02-27 16:26:32 +00006866 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006867 CGM.addCompilerUsedGlobal(Entry);
Rafael Espindola21039aa2014-02-27 16:26:32 +00006868 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006869
John McCall7f416cc2015-09-08 08:05:57 +00006870 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006871}
6872
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006873/// GetClass - Return a reference to the class for the given interface
6874/// decl.
John McCall882987f2013-02-28 19:01:20 +00006875llvm::Value *CGObjCNonFragileABIMac::GetClass(CodeGenFunction &CGF,
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006876 const ObjCInterfaceDecl *ID) {
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00006877 if (ID->isWeakImported()) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006878 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6879 ClassName += ID->getObjCRuntimeNameAsString();
6880 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(), true);
Nick Lewycky9a441642014-02-27 00:36:00 +00006881 (void)ClassGV;
Rafael Espindolab3262952014-05-09 00:43:37 +00006882 assert(ClassGV->hasExternalWeakLinkage());
Fariborz Jahanian95ace552009-11-17 22:42:00 +00006883 }
6884
John McCall882987f2013-02-28 19:01:20 +00006885 return EmitClassRef(CGF, ID);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006886}
6887
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006888/// Generates a message send where the super is the receiver. This is
6889/// a message send to self with special delivery semantics indicating
6890/// which class's method should be called.
6891CodeGen::RValue
6892CGObjCNonFragileABIMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00006893 ReturnValueSlot Return,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006894 QualType ResultType,
6895 Selector Sel,
6896 const ObjCInterfaceDecl *Class,
6897 bool isCategoryImpl,
6898 llvm::Value *Receiver,
6899 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006900 const CodeGen::CallArgList &CallArgs,
6901 const ObjCMethodDecl *Method) {
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006902 // ...
6903 // Create and init a super structure; this is a (receiver, class)
6904 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00006905 Address ObjCSuper =
6906 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
6907 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006908
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006909 llvm::Value *ReceiverAsObject =
6910 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00006911 CGF.Builder.CreateStore(
6912 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00006913 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006914
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006915 // If this is a class message the metaclass is passed as the target.
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00006916 llvm::Value *Target;
Fariborz Jahanian27678b02012-10-10 23:11:18 +00006917 if (IsClassMessage)
Fariborz Jahanian85b99da2014-08-28 17:05:17 +00006918 Target = EmitMetaClassRef(CGF, Class, Class->isWeakImported());
Fariborz Jahanian27678b02012-10-10 23:11:18 +00006919 else
John McCall882987f2013-02-28 19:01:20 +00006920 Target = EmitSuperClassRef(CGF, Class);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006921
Mike Stump18bb9282009-05-16 07:57:57 +00006922 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
6923 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00006924 llvm::Type *ClassTy =
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006925 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
6926 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00006927 CGF.Builder.CreateStore(
John McCall7f416cc2015-09-08 08:05:57 +00006928 Target, CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006929
John McCall9e8bb002011-05-14 03:10:52 +00006930 return (isVTableDispatchedSelector(Sel))
6931 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
John McCall7f416cc2015-09-08 08:05:57 +00006932 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall9e8bb002011-05-14 03:10:52 +00006933 true, CallArgs, Method)
6934 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00006935 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00006936 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00006937 true, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006938}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006939
John McCall882987f2013-02-28 19:01:20 +00006940llvm::Value *CGObjCNonFragileABIMac::EmitSelector(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00006941 Selector Sel) {
6942 Address Addr = EmitSelectorAddr(CGF, Sel);
6943
6944 llvm::LoadInst* LI = CGF.Builder.CreateLoad(Addr);
6945 LI->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
6946 llvm::MDNode::get(VMContext, None));
6947 return LI;
6948}
6949
6950Address CGObjCNonFragileABIMac::EmitSelectorAddr(CodeGenFunction &CGF,
6951 Selector Sel) {
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006952 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006953
John McCall7f416cc2015-09-08 08:05:57 +00006954 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006955 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006956 llvm::Constant *Casted =
6957 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
6958 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006959 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.SelectorPtrTy,
6960 false, llvm::GlobalValue::PrivateLinkage,
6961 Casted, "OBJC_SELECTOR_REFERENCES_");
Michael Gottesman5c205962013-02-05 23:08:45 +00006962 Entry->setExternallyInitialized(true);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00006963 Entry->setSection("__DATA, __objc_selrefs, literal_pointers, no_dead_strip");
John McCall7f416cc2015-09-08 08:05:57 +00006964 Entry->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00006965 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006966 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006967
John McCall7f416cc2015-09-08 08:05:57 +00006968 return Address(Entry, Align);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006969}
John McCall7f416cc2015-09-08 08:05:57 +00006970
Fariborz Jahanian06292952009-02-16 22:52:32 +00006971/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00006972/// objc_assign_ivar (id src, id *dst, ptrdiff_t)
Fariborz Jahanian06292952009-02-16 22:52:32 +00006973///
6974void CGObjCNonFragileABIMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00006975 llvm::Value *src,
John McCall7f416cc2015-09-08 08:05:57 +00006976 Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00006977 llvm::Value *ivarOffset) {
Chris Lattner2192fe52011-07-18 04:24:23 +00006978 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006979 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00006980 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006981 assert(Size <= 8 && "does not support size > 8");
6982 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
6983 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00006984 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
6985 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00006986 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
6987 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00006988 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00006989 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahanian06292952009-02-16 22:52:32 +00006990}
6991
6992/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
6993/// objc_assign_strongCast (id src, id *dst)
6994///
6995void CGObjCNonFragileABIMac::EmitObjCStrongCastAssign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006996 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00006997 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00006998 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006999 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007000 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007001 assert(Size <= 8 && "does not support size > 8");
7002 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007003 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007004 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7005 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007006 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7007 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007008 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007009 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
7010 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007011}
7012
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007013void CGObjCNonFragileABIMac::EmitGCMemmoveCollectable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007014 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007015 Address DestPtr,
7016 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00007017 llvm::Value *Size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007018 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
7019 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007020 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), Size };
John McCall882987f2013-02-28 19:01:20 +00007021 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007022}
7023
Fariborz Jahanian06292952009-02-16 22:52:32 +00007024/// EmitObjCWeakRead - Code gen for loading value of a __weak
7025/// object: objc_read_weak (id *src)
7026///
7027llvm::Value * CGObjCNonFragileABIMac::EmitObjCWeakRead(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007028 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007029 Address AddrWeakObj) {
7030 llvm::Type *DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007031 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj, ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007032 llvm::Value *read_weak =
7033 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00007034 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00007035 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007036 return read_weak;
7037}
7038
7039/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
7040/// objc_assign_weak (id src, id *dst)
7041///
7042void CGObjCNonFragileABIMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007043 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007044 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007045 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007046 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007047 assert(Size <= 8 && "does not support size > 8");
7048 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7049 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007050 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7051 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007052 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7053 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007054 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007055 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
7056 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007057}
7058
7059/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
7060/// objc_assign_global (id src, id *dst)
7061///
7062void CGObjCNonFragileABIMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007063 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00007064 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007065 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007066 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007067 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007068 assert(Size <= 8 && "does not support size > 8");
7069 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7070 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007071 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7072 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007073 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7074 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007075 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00007076 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00007077 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
7078 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00007079 else
John McCall882987f2013-02-28 19:01:20 +00007080 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
7081 args, "threadlocalassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007082}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007083
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007084void
John McCallbd309292010-07-06 01:34:17 +00007085CGObjCNonFragileABIMac::EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
7086 const ObjCAtSynchronizedStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007087 EmitAtSynchronizedStmt(CGF, S,
7088 cast<llvm::Function>(ObjCTypes.getSyncEnterFn()),
7089 cast<llvm::Function>(ObjCTypes.getSyncExitFn()));
John McCallbd309292010-07-06 01:34:17 +00007090}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007091
John McCall2ca705e2010-07-24 00:37:23 +00007092llvm::Constant *
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00007093CGObjCNonFragileABIMac::GetEHType(QualType T) {
John McCall2ca705e2010-07-24 00:37:23 +00007094 // There's a particular fixed type info for 'id'.
7095 if (T->isObjCIdType() ||
7096 T->isObjCQualifiedIdType()) {
7097 llvm::Constant *IDEHType =
7098 CGM.getModule().getGlobalVariable("OBJC_EHTYPE_id");
7099 if (!IDEHType)
7100 IDEHType =
7101 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy,
7102 false,
7103 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00007104 nullptr, "OBJC_EHTYPE_id");
John McCall2ca705e2010-07-24 00:37:23 +00007105 return IDEHType;
7106 }
7107
7108 // All other types should be Objective-C interface pointer types.
7109 const ObjCObjectPointerType *PT =
7110 T->getAs<ObjCObjectPointerType>();
7111 assert(PT && "Invalid @catch type.");
7112 const ObjCInterfaceType *IT = PT->getInterfaceType();
7113 assert(IT && "Invalid @catch type.");
7114 return GetInterfaceEHType(IT->getDecl(), false);
7115}
7116
John McCallbd309292010-07-06 01:34:17 +00007117void CGObjCNonFragileABIMac::EmitTryStmt(CodeGen::CodeGenFunction &CGF,
7118 const ObjCAtTryStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007119 EmitTryCatchStmt(CGF, S,
7120 cast<llvm::Function>(ObjCTypes.getObjCBeginCatchFn()),
7121 cast<llvm::Function>(ObjCTypes.getObjCEndCatchFn()),
7122 cast<llvm::Function>(ObjCTypes.getExceptionRethrowFn()));
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +00007123}
7124
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007125/// EmitThrowStmt - Generate code for a throw statement.
7126void CGObjCNonFragileABIMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007127 const ObjCAtThrowStmt &S,
7128 bool ClearInsertionPoint) {
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007129 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00007130 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Benjamin Kramer76399eb2011-09-27 21:06:10 +00007131 Exception = CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007132 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionThrowFn(), Exception)
John McCall17afe452010-10-16 08:21:07 +00007133 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007134 } else {
John McCall882987f2013-02-28 19:01:20 +00007135 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionRethrowFn())
John McCall17afe452010-10-16 08:21:07 +00007136 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007137 }
7138
John McCall17afe452010-10-16 08:21:07 +00007139 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007140 if (ClearInsertionPoint)
7141 CGF.Builder.ClearInsertionPoint();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007142}
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007143
John McCall2ca705e2010-07-24 00:37:23 +00007144llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007145CGObjCNonFragileABIMac::GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007146 bool ForDefinition) {
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007147 llvm::GlobalVariable * &Entry = EHTypeReferences[ID->getIdentifier()];
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007148
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007149 // If we don't need a definition, return the entry if found or check
7150 // if we use an external reference.
7151 if (!ForDefinition) {
7152 if (Entry)
7153 return Entry;
Daniel Dunbard7beeea2009-04-07 06:43:45 +00007154
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007155 // If this type (or a super class) has the __objc_exception__
7156 // attribute, emit an external reference.
Douglas Gregor78bd61f2009-06-18 16:11:24 +00007157 if (hasObjCExceptionAttribute(CGM.getContext(), ID))
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007158 return Entry =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007159 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
7160 llvm::GlobalValue::ExternalLinkage,
7161 nullptr,
7162 ("OBJC_EHTYPE_$_" +
7163 ID->getObjCRuntimeNameAsString()));
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007164 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007165
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007166 // Otherwise we need to either make a new entry or fill in the
7167 // initializer.
7168 assert((!Entry || !Entry->hasInitializer()) && "Duplicate EHType definition");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007169 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
7170 ClassName += ID->getObjCRuntimeNameAsString();
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007171 std::string VTableName = "objc_ehtype_vtable";
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007172 llvm::GlobalVariable *VTableGV =
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007173 CGM.getModule().getGlobalVariable(VTableName);
7174 if (!VTableGV)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007175 VTableGV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.Int8PtrTy,
7176 false,
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007177 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00007178 nullptr, VTableName);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007179
Chris Lattnerece04092012-02-07 00:39:47 +00007180 llvm::Value *VTableIdx = llvm::ConstantInt::get(CGM.Int32Ty, 2);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007181
Benjamin Kramer22d24c22011-10-15 12:20:02 +00007182 llvm::Constant *Values[] = {
David Blaikiee3b172a2015-04-02 18:55:21 +00007183 llvm::ConstantExpr::getGetElementPtr(VTableGV->getValueType(), VTableGV,
7184 VTableIdx),
7185 GetClassName(ID->getObjCRuntimeNameAsString()),
7186 GetClassGlobal(ClassName.str())};
Owen Anderson170229f2009-07-14 23:10:40 +00007187 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00007188 llvm::ConstantStruct::get(ObjCTypes.EHTypeTy, Values);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007189
Rafael Espindola554256c2014-02-26 22:25:45 +00007190 llvm::GlobalValue::LinkageTypes L = ForDefinition
7191 ? llvm::GlobalValue::ExternalLinkage
7192 : llvm::GlobalValue::WeakAnyLinkage;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007193 if (Entry) {
7194 Entry->setInitializer(Init);
7195 } else {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007196 llvm::SmallString<64> EHTYPEName("OBJC_EHTYPE_$_");
7197 EHTYPEName += ID->getObjCRuntimeNameAsString();
Owen Andersonc10c8d32009-07-08 19:05:04 +00007198 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
Rafael Espindola554256c2014-02-26 22:25:45 +00007199 L,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007200 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007201 EHTYPEName.str());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007202 }
Rafael Espindola554256c2014-02-26 22:25:45 +00007203 assert(Entry->getLinkage() == L);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007204
John McCalla4960982013-02-19 01:57:29 +00007205 if (ID->getVisibility() == HiddenVisibility)
Daniel Dunbar15894b72009-04-07 05:48:37 +00007206 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Micah Villmowdd31ca12012-10-08 16:25:52 +00007207 Entry->setAlignment(CGM.getDataLayout().getABITypeAlignment(
Daniel Dunbar710cb202010-04-25 20:39:32 +00007208 ObjCTypes.EHTypeTy));
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007209
Rafael Espindola554256c2014-02-26 22:25:45 +00007210 if (ForDefinition)
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007211 Entry->setSection("__DATA,__objc_const");
Rafael Espindola554256c2014-02-26 22:25:45 +00007212 else
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007213 Entry->setSection("__DATA,__datacoal_nt,coalesced");
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007214
7215 return Entry;
7216}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007217
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00007218/* *** */
7219
Daniel Dunbarb036db82008-08-13 03:21:16 +00007220CodeGen::CGObjCRuntime *
7221CodeGen::CreateMacObjCRuntime(CodeGen::CodeGenModule &CGM) {
John McCall5fb5df92012-06-20 06:18:46 +00007222 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
7223 case ObjCRuntime::FragileMacOSX:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007224 return new CGObjCMac(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00007225
7226 case ObjCRuntime::MacOSX:
7227 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +00007228 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +00007229 return new CGObjCNonFragileABIMac(CGM);
7230
David Chisnallb601c962012-07-03 20:49:52 +00007231 case ObjCRuntime::GNUstep:
7232 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +00007233 case ObjCRuntime::ObjFW:
John McCall5fb5df92012-06-20 06:18:46 +00007234 llvm_unreachable("these runtimes are not Mac runtimes");
7235 }
7236 llvm_unreachable("bad runtime");
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007237}