blob: ddac815038d8ca33a69187624d442bd9658f4307 [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.
836 llvm::SetVector<std::string> DefinedCategoryNames;
837
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 ///
Fariborz Jahanian1bf72882009-03-12 22:50:49 +0000916 llvm::Constant *BuildIvarLayout(const ObjCImplementationDecl *OI,
John McCall3fd13f062015-10-21 18:06:47 +0000917 CharUnits beginOffset,
918 CharUnits endOffset,
Fariborz Jahanian1bf72882009-03-12 22:50:49 +0000919 bool ForStrongLayout);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +0000920
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000921 Qualifiers::ObjCLifetime getBlockCaptureLifetime(QualType QT, bool ByrefLayout);
Fariborz Jahanian2dd78192012-11-02 22:51:18 +0000922
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000923 void UpdateRunSkipBlockVars(bool IsByref,
924 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000925 CharUnits FieldOffset,
926 CharUnits FieldSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000927
928 void BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000929 CharUnits BytePos, bool &HasUnion,
930 bool ByrefLayout=false);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000931
932 void BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
933 const RecordDecl *RD,
934 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000935 CharUnits BytePos, bool &HasUnion,
936 bool ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000937
Fariborz Jahanian23290b02012-11-01 18:32:55 +0000938 uint64_t InlineLayoutInstruction(SmallVectorImpl<unsigned char> &Layout);
939
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000940 llvm::Constant *getBitmapBlockLayout(bool ComputeByrefLayout);
941
Fariborz Jahanian01dff422009-03-05 19:17:31 +0000942 /// GetIvarLayoutName - Returns a unique constant for the given
943 /// ivar layout bitmap.
944 llvm::Constant *GetIvarLayoutName(IdentifierInfo *Ident,
945 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000946
Fariborz Jahanian066347e2009-01-28 22:18:42 +0000947 /// EmitPropertyList - Emit the given property list. The return
948 /// value has type PropertyListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000949 llvm::Constant *EmitPropertyList(Twine Name,
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000950 const Decl *Container,
Fariborz Jahanian066347e2009-01-28 22:18:42 +0000951 const ObjCContainerDecl *OCD,
952 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000953
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000954 /// EmitProtocolMethodTypes - Generate the array of extended method type
955 /// strings. The return value has type Int8PtrPtrTy.
956 llvm::Constant *EmitProtocolMethodTypes(Twine Name,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +0000957 ArrayRef<llvm::Constant*> MethodTypes,
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000958 const ObjCCommonTypesHelper &ObjCTypes);
959
Fariborz Jahanian751c1e72009-12-12 21:26:21 +0000960 /// PushProtocolProperties - Push protocol's property on the input stack.
Bill Wendlinga515b582012-02-09 22:16:49 +0000961 void PushProtocolProperties(
962 llvm::SmallPtrSet<const IdentifierInfo*, 16> &PropertySet,
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000963 SmallVectorImpl<llvm::Constant*> &Properties,
Bill Wendlinga515b582012-02-09 22:16:49 +0000964 const Decl *Container,
Aaron Ballmandc4bea42014-03-13 18:47:37 +0000965 const ObjCProtocolDecl *Proto,
Bill Wendlinga515b582012-02-09 22:16:49 +0000966 const ObjCCommonTypesHelper &ObjCTypes);
Fariborz Jahanian751c1e72009-12-12 21:26:21 +0000967
Fariborz Jahanian56b3b772009-01-29 19:24:30 +0000968 /// GetProtocolRef - Return a reference to the internal protocol
969 /// description, creating an empty one if it has not been
970 /// defined. The return value has type ProtocolPtrTy.
971 llvm::Constant *GetProtocolRef(const ObjCProtocolDecl *PD);
Fariborz Jahanian67726212009-03-08 20:18:37 +0000972
John McCall3fd13f062015-10-21 18:06:47 +0000973public:
Daniel Dunbar30c65362009-03-09 20:09:19 +0000974 /// CreateMetadataVar - Create a global variable with internal
975 /// linkage for use by the Objective-C runtime.
976 ///
977 /// This is a convenience wrapper which not only creates the
978 /// variable, but also sets the section and alignment and adds the
Chris Lattnerf56501c2009-07-17 23:57:13 +0000979 /// global to the "llvm.used" list.
Daniel Dunbar463cc8a2009-03-09 20:50:13 +0000980 ///
981 /// \param Name - The variable name.
982 /// \param Init - The variable initializer; this is also used to
983 /// define the type of the variable.
Alp Toker541d5072014-06-07 23:30:53 +0000984 /// \param Section - The section the variable should go into, or empty.
Daniel Dunbar463cc8a2009-03-09 20:50:13 +0000985 /// \param Align - The alignment for the variable, or 0.
986 /// \param AddToUsed - Whether the variable should be added to
Daniel Dunbar4527d302009-04-14 17:42:51 +0000987 /// "llvm.used".
Alp Toker541d5072014-06-07 23:30:53 +0000988 llvm::GlobalVariable *CreateMetadataVar(Twine Name, llvm::Constant *Init,
John McCall7f416cc2015-09-08 08:05:57 +0000989 StringRef Section, CharUnits Align,
Daniel Dunbar463cc8a2009-03-09 20:50:13 +0000990 bool AddToUsed);
Daniel Dunbar30c65362009-03-09 20:09:19 +0000991
John McCall3fd13f062015-10-21 18:06:47 +0000992protected:
John McCall9e8bb002011-05-14 03:10:52 +0000993 CodeGen::RValue EmitMessageSend(CodeGen::CodeGenFunction &CGF,
994 ReturnValueSlot Return,
995 QualType ResultType,
996 llvm::Value *Sel,
997 llvm::Value *Arg0,
998 QualType Arg0Ty,
999 bool IsSuper,
1000 const CallArgList &CallArgs,
1001 const ObjCMethodDecl *OMD,
John McCall1e3157b2015-09-10 22:27:50 +00001002 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00001003 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbarf5c18462009-04-20 06:54:31 +00001004
Daniel Dunbar5e639272010-04-25 20:39:01 +00001005 /// EmitImageInfo - Emit the image info marker used to encode some module
1006 /// level information.
1007 void EmitImageInfo();
1008
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001009public:
Owen Andersonae86c192009-07-13 04:10:07 +00001010 CGObjCCommonMac(CodeGen::CodeGenModule &cgm) :
John McCalla729c622012-02-17 03:33:10 +00001011 CGObjCRuntime(cgm), VMContext(cgm.getLLVMContext()) { }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001012
John McCall3fd13f062015-10-21 18:06:47 +00001013 bool isNonFragileABI() const {
1014 return ObjCABI == 2;
1015 }
1016
John McCall7f416cc2015-09-08 08:05:57 +00001017 ConstantAddress GenerateConstantString(const StringLiteral *SL) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001018
Craig Topper4f12f102014-03-12 06:41:41 +00001019 llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
Craig Topper8a13c412014-05-21 05:09:00 +00001020 const ObjCContainerDecl *CD=nullptr) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001021
1022 void GenerateProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001023
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001024 /// GetOrEmitProtocol - Get the protocol object for the given
1025 /// declaration, emitting it if necessary. The return value has type
1026 /// ProtocolPtrTy.
1027 virtual llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD)=0;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001028
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001029 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1030 /// object for the given declaration, emitting it if needed. These
1031 /// forward references will be filled in with empty bodies if no
1032 /// definition is seen. The return value has type ProtocolPtrTy.
1033 virtual llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD)=0;
Craig Topper4f12f102014-03-12 06:41:41 +00001034 llvm::Constant *BuildGCBlockLayout(CodeGen::CodeGenModule &CGM,
1035 const CGBlockInfo &blockInfo) override;
1036 llvm::Constant *BuildRCBlockLayout(CodeGen::CodeGenModule &CGM,
1037 const CGBlockInfo &blockInfo) override;
1038
1039 llvm::Constant *BuildByrefLayout(CodeGen::CodeGenModule &CGM,
1040 QualType T) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001041};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001042
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001043class CGObjCMac : public CGObjCCommonMac {
1044private:
1045 ObjCTypesHelper ObjCTypes;
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001046
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001047 /// EmitModuleInfo - Another marker encoding module level
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001048 /// information.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001049 void EmitModuleInfo();
1050
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001051 /// EmitModuleSymols - Emit module symbols, the list of defined
1052 /// classes and categories. The result has type SymtabPtrTy.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001053 llvm::Constant *EmitModuleSymbols();
1054
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001055 /// FinishModule - Write out global data structures at the end of
1056 /// processing a translation unit.
1057 void FinishModule();
Daniel Dunbarb036db82008-08-13 03:21:16 +00001058
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001059 /// EmitClassExtension - Generate the class extension structure used
1060 /// to store the weak ivar layout and properties. The return value
1061 /// has type ClassExtensionPtrTy.
John McCall3fd13f062015-10-21 18:06:47 +00001062 llvm::Constant *EmitClassExtension(const ObjCImplementationDecl *ID,
1063 CharUnits InstanceSize);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001064
1065 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1066 /// for the given class.
John McCall882987f2013-02-28 19:01:20 +00001067 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001068 const ObjCInterfaceDecl *ID);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001069
John McCall882987f2013-02-28 19:01:20 +00001070 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00001071 IdentifierInfo *II);
Craig Topper4f12f102014-03-12 06:41:41 +00001072
1073 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
1074
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001075 /// EmitSuperClassRef - Emits reference to class's main metadata class.
1076 llvm::Value *EmitSuperClassRef(const ObjCInterfaceDecl *ID);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001077
1078 /// EmitIvarList - Emit the ivar list for the given
1079 /// implementation. If ForClass is true the list of class ivars
1080 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1081 /// interface ivars will be emitted. The return value has type
1082 /// IvarListPtrTy.
1083 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00001084 bool ForClass);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001085
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001086 /// EmitMetaClass - Emit a forward reference to the class structure
1087 /// for the metaclass of the given interface. The return value has
1088 /// type ClassPtrTy.
1089 llvm::Constant *EmitMetaClassRef(const ObjCInterfaceDecl *ID);
1090
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001091 /// EmitMetaClass - Emit a class structure for the metaclass of the
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001092 /// given implementation. The return value has type ClassPtrTy.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001093 llvm::Constant *EmitMetaClass(const ObjCImplementationDecl *ID,
1094 llvm::Constant *Protocols,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001095 ArrayRef<llvm::Constant*> Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001096
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001097 llvm::Constant *GetMethodConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001098
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001099 llvm::Constant *GetMethodDescriptionConstant(const ObjCMethodDecl *MD);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001100
1101 /// EmitMethodList - Emit the method list for the given
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001102 /// implementation. The return value has type MethodListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001103 llvm::Constant *EmitMethodList(Twine Name,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00001104 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001105 ArrayRef<llvm::Constant*> Methods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001106
1107 /// EmitMethodDescList - Emit a method description list for a list of
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001108 /// method declarations.
Daniel Dunbarb036db82008-08-13 03:21:16 +00001109 /// - TypeName: The name for the type containing the methods.
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001110 /// - IsProtocol: True iff these methods are for a protocol.
1111 /// - ClassMethds: True iff these are class methods.
Daniel Dunbarb036db82008-08-13 03:21:16 +00001112 /// - Required: When true, only "required" methods are
1113 /// listed. Similarly, when false only "optional" methods are
1114 /// listed. For classes this should always be true.
1115 /// - begin, end: The method list to output.
1116 ///
1117 /// The return value has type MethodDescriptionListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001118 llvm::Constant *EmitMethodDescList(Twine Name,
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001119 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001120 ArrayRef<llvm::Constant*> Methods);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001121
Daniel Dunbarc475d422008-10-29 22:36:39 +00001122 /// GetOrEmitProtocol - Get the protocol object for the given
1123 /// declaration, emitting it if necessary. The return value has type
1124 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001125 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001126
1127 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1128 /// object for the given declaration, emitting it if needed. These
1129 /// forward references will be filled in with empty bodies if no
1130 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001131 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001132
Daniel Dunbarb036db82008-08-13 03:21:16 +00001133 /// EmitProtocolExtension - Generate the protocol extension
1134 /// structure used to store optional instance and class methods, and
1135 /// protocol properties. The return value has type
1136 /// ProtocolExtensionPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001137 llvm::Constant *
1138 EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001139 ArrayRef<llvm::Constant*> OptInstanceMethods,
1140 ArrayRef<llvm::Constant*> OptClassMethods,
1141 ArrayRef<llvm::Constant*> MethodTypesExt);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001142
1143 /// EmitProtocolList - Generate the list of referenced
1144 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001145 llvm::Constant *EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00001146 ObjCProtocolDecl::protocol_iterator begin,
1147 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001148
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001149 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1150 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001151 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1152 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001153
1154public:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001155 CGObjCMac(CodeGen::CodeGenModule &cgm);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001156
Craig Topper4f12f102014-03-12 06:41:41 +00001157 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001158
Craig Topper4f12f102014-03-12 06:41:41 +00001159 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1160 ReturnValueSlot Return,
1161 QualType ResultType,
1162 Selector Sel, llvm::Value *Receiver,
1163 const CallArgList &CallArgs,
1164 const ObjCInterfaceDecl *Class,
1165 const ObjCMethodDecl *Method) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001166
Craig Topper4f12f102014-03-12 06:41:41 +00001167 CodeGen::RValue
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001168 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001169 ReturnValueSlot Return, QualType ResultType,
1170 Selector Sel, const ObjCInterfaceDecl *Class,
1171 bool isCategoryImpl, llvm::Value *Receiver,
1172 bool IsClassMessage, const CallArgList &CallArgs,
1173 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001174
Craig Topper4f12f102014-03-12 06:41:41 +00001175 llvm::Value *GetClass(CodeGenFunction &CGF,
1176 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001177
John McCall7f416cc2015-09-08 08:05:57 +00001178 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
1179 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001180
1181 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1182 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001183 llvm::Value *GetSelector(CodeGenFunction &CGF,
1184 const ObjCMethodDecl *Method) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001185
Craig Topper4f12f102014-03-12 06:41:41 +00001186 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001187
Craig Topper4f12f102014-03-12 06:41:41 +00001188 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001189
Craig Topper4f12f102014-03-12 06:41:41 +00001190 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001191
Craig Topper4f12f102014-03-12 06:41:41 +00001192 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001193
Craig Topper4f12f102014-03-12 06:41:41 +00001194 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1195 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001196
Craig Topper4f12f102014-03-12 06:41:41 +00001197 llvm::Constant *GetPropertyGetFunction() override;
1198 llvm::Constant *GetPropertySetFunction() override;
1199 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1200 bool copy) override;
1201 llvm::Constant *GetGetStructFunction() override;
1202 llvm::Constant *GetSetStructFunction() override;
1203 llvm::Constant *GetCppAtomicObjectGetFunction() override;
1204 llvm::Constant *GetCppAtomicObjectSetFunction() override;
1205 llvm::Constant *EnumerationMutationFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001206
Craig Topper4f12f102014-03-12 06:41:41 +00001207 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1208 const ObjCAtTryStmt &S) override;
1209 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1210 const ObjCAtSynchronizedStmt &S) override;
John McCallbd309292010-07-06 01:34:17 +00001211 void EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF, const Stmt &S);
Craig Topper4f12f102014-03-12 06:41:41 +00001212 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1213 bool ClearInsertionPoint=true) override;
1214 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001215 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001216 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001217 llvm::Value *src, Address dst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001218 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001219 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001220 bool threadlocal = false) override;
1221 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001222 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001223 llvm::Value *ivarOffset) override;
1224 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001225 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001226 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001227 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001228 llvm::Value *size) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001229
Craig Topper4f12f102014-03-12 06:41:41 +00001230 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1231 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1232 unsigned CVRQualifiers) override;
1233 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1234 const ObjCInterfaceDecl *Interface,
1235 const ObjCIvarDecl *Ivar) override;
1236
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001237 /// GetClassGlobal - Return the global variable for the Objective-C
1238 /// class of the given name.
Rafael Espindola554256c2014-02-26 22:25:45 +00001239 llvm::GlobalVariable *GetClassGlobal(const std::string &Name,
Craig Toppera798a9d2014-03-02 09:32:10 +00001240 bool Weak = false) override {
David Blaikie83d382b2011-09-23 05:06:16 +00001241 llvm_unreachable("CGObjCMac::GetClassGlobal");
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001242 }
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001243};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001244
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001245class CGObjCNonFragileABIMac : public CGObjCCommonMac {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001246private:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001247 ObjCNonFragileABITypesHelper ObjCTypes;
Fariborz Jahanian71394042009-01-23 23:53:38 +00001248 llvm::GlobalVariable* ObjCEmptyCacheVar;
1249 llvm::GlobalVariable* ObjCEmptyVtableVar;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001250
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001251 /// SuperClassReferences - uniqued super class references.
1252 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> SuperClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001253
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001254 /// MetaClassReferences - uniqued meta class references.
1255 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> MetaClassReferences;
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001256
1257 /// EHTypeReferences - uniqued class ehtype references.
1258 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> EHTypeReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001259
John McCall9e8bb002011-05-14 03:10:52 +00001260 /// VTableDispatchMethods - List of methods for which we generate
1261 /// vtable-based message dispatch.
1262 llvm::DenseSet<Selector> VTableDispatchMethods;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001263
Fariborz Jahanian67260552009-11-17 21:37:35 +00001264 /// DefinedMetaClasses - List of defined meta-classes.
1265 std::vector<llvm::GlobalValue*> DefinedMetaClasses;
1266
John McCall9e8bb002011-05-14 03:10:52 +00001267 /// isVTableDispatchedSelector - Returns true if SEL is a
1268 /// vtable-based selector.
1269 bool isVTableDispatchedSelector(Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001270
Fariborz Jahanian71394042009-01-23 23:53:38 +00001271 /// FinishNonFragileABIModule - Write out global data structures at the end of
1272 /// processing a translation unit.
1273 void FinishNonFragileABIModule();
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001274
Daniel Dunbar19573e72009-05-15 21:48:48 +00001275 /// AddModuleClassList - Add the given list of class pointers to the
1276 /// module with the provided symbol and section names.
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001277 void AddModuleClassList(ArrayRef<llvm::GlobalValue*> Container,
Daniel Dunbar19573e72009-05-15 21:48:48 +00001278 const char *SymbolName,
1279 const char *SectionName);
1280
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001281 llvm::GlobalVariable * BuildClassRoTInitializer(unsigned flags,
1282 unsigned InstanceStart,
1283 unsigned InstanceSize,
1284 const ObjCImplementationDecl *ID);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001285 llvm::GlobalVariable * BuildClassMetaData(const std::string &ClassName,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001286 llvm::Constant *IsAGV,
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00001287 llvm::Constant *SuperClassGV,
Fariborz Jahanian82208252009-01-31 00:59:10 +00001288 llvm::Constant *ClassRoGV,
Rafael Espindola554256c2014-02-26 22:25:45 +00001289 bool HiddenVisibility,
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00001290 bool Weak);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001291
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001292 llvm::Constant *GetMethodConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001293
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00001294 llvm::Constant *GetMethodDescriptionConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001295
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001296 /// EmitMethodList - Emit the method list for the given
1297 /// implementation. The return value has type MethodListnfABITy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001298 llvm::Constant *EmitMethodList(Twine Name,
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001299 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001300 ArrayRef<llvm::Constant*> Methods);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00001301 /// EmitIvarList - Emit the ivar list for the given
1302 /// implementation. If ForClass is true the list of class ivars
1303 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1304 /// interface ivars will be emitted. The return value has type
1305 /// IvarListnfABIPtrTy.
1306 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001307
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001308 llvm::Constant *EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00001309 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00001310 unsigned long int offset);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001311
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001312 /// GetOrEmitProtocol - Get the protocol object for the given
1313 /// declaration, emitting it if necessary. The return value has type
1314 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001315 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001316
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001317 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1318 /// object for the given declaration, emitting it if needed. These
1319 /// forward references will be filled in with empty bodies if no
1320 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001321 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001322
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001323 /// EmitProtocolList - Generate the list of referenced
1324 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001325 llvm::Constant *EmitProtocolList(Twine Name,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001326 ObjCProtocolDecl::protocol_iterator begin,
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00001327 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001328
John McCall9e8bb002011-05-14 03:10:52 +00001329 CodeGen::RValue EmitVTableMessageSend(CodeGen::CodeGenFunction &CGF,
1330 ReturnValueSlot Return,
1331 QualType ResultType,
1332 Selector Sel,
1333 llvm::Value *Receiver,
1334 QualType Arg0Ty,
1335 bool IsSuper,
1336 const CallArgList &CallArgs,
1337 const ObjCMethodDecl *Method);
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001338
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00001339 /// GetClassGlobal - Return the global variable for the Objective-C
1340 /// class of the given name.
Rafael Espindola554256c2014-02-26 22:25:45 +00001341 llvm::GlobalVariable *GetClassGlobal(const std::string &Name,
Craig Toppera798a9d2014-03-02 09:32:10 +00001342 bool Weak = false) override;
Rafael Espindola554256c2014-02-26 22:25:45 +00001343
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00001344 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001345 /// for the given class reference.
John McCall882987f2013-02-28 19:01:20 +00001346 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001347 const ObjCInterfaceDecl *ID);
John McCall31168b02011-06-15 23:02:42 +00001348
John McCall882987f2013-02-28 19:01:20 +00001349 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001350 IdentifierInfo *II, bool Weak,
1351 const ObjCInterfaceDecl *ID);
Craig Topper4f12f102014-03-12 06:41:41 +00001352
1353 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001354
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001355 /// EmitSuperClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1356 /// for the given super class reference.
John McCall882987f2013-02-28 19:01:20 +00001357 llvm::Value *EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001358 const ObjCInterfaceDecl *ID);
1359
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001360 /// EmitMetaClassRef - Return a Value * of the address of _class_t
1361 /// meta-data
John McCall882987f2013-02-28 19:01:20 +00001362 llvm::Value *EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00001363 const ObjCInterfaceDecl *ID, bool Weak);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001364
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001365 /// ObjCIvarOffsetVariable - Returns the ivar offset variable for
1366 /// the given ivar.
1367 ///
Daniel Dunbara1060522009-04-19 00:31:15 +00001368 llvm::GlobalVariable * ObjCIvarOffsetVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001369 const ObjCInterfaceDecl *ID,
1370 const ObjCIvarDecl *Ivar);
1371
Fariborz Jahanian74b77222009-02-11 20:51:17 +00001372 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1373 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001374 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1375 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001376
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001377 /// GetInterfaceEHType - Get the cached ehtype for the given Objective-C
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001378 /// interface. The return value has type EHTypePtrTy.
John McCall2ca705e2010-07-24 00:37:23 +00001379 llvm::Constant *GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001380 bool ForDefinition);
Daniel Dunbar15894b72009-04-07 05:48:37 +00001381
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001382 const char *getMetaclassSymbolPrefix() const {
Daniel Dunbar15894b72009-04-07 05:48:37 +00001383 return "OBJC_METACLASS_$_";
1384 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001385
Daniel Dunbar15894b72009-04-07 05:48:37 +00001386 const char *getClassSymbolPrefix() const {
1387 return "OBJC_CLASS_$_";
1388 }
1389
Daniel Dunbar961202372009-05-03 12:57:56 +00001390 void GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00001391 uint32_t &InstanceStart,
1392 uint32_t &InstanceSize);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001393
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001394 // Shamelessly stolen from Analysis/CFRefCount.cpp
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001395 Selector GetNullarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001396 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1397 return CGM.getContext().Selectors.getSelector(0, &II);
1398 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001399
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001400 Selector GetUnarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001401 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1402 return CGM.getContext().Selectors.getSelector(1, &II);
1403 }
Daniel Dunbar554fd792009-04-19 23:41:48 +00001404
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001405 /// ImplementationIsNonLazy - Check whether the given category or
1406 /// class implementation is "non-lazy".
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00001407 bool ImplementationIsNonLazy(const ObjCImplDecl *OD) const;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001408
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001409 bool IsIvarOffsetKnownIdempotent(const CodeGen::CodeGenFunction &CGF,
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001410 const ObjCIvarDecl *IV) {
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001411 // Annotate the load as an invariant load iff inside an instance method
1412 // and ivar belongs to instance method's class and one of its super class.
1413 // This check is needed because the ivar offset is a lazily
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001414 // initialised value that may depend on objc_msgSend to perform a fixup on
1415 // the first message dispatch.
1416 //
1417 // An additional opportunity to mark the load as invariant arises when the
1418 // base of the ivar access is a parameter to an Objective C method.
1419 // However, because the parameters are not available in the current
1420 // interface, we cannot perform this check.
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001421 if (const ObjCMethodDecl *MD =
1422 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurFuncDecl))
Fariborz Jahanian7a583022014-03-04 22:57:32 +00001423 if (MD->isInstanceMethod())
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001424 if (const ObjCInterfaceDecl *ID = MD->getClassInterface())
1425 return IV->getContainingInterface()->isSuperClassOf(ID);
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001426 return false;
1427 }
1428
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001429public:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001430 CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian71394042009-01-23 23:53:38 +00001431 // FIXME. All stubs for now!
Craig Topper4f12f102014-03-12 06:41:41 +00001432 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001433
Craig Topper4f12f102014-03-12 06:41:41 +00001434 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1435 ReturnValueSlot Return,
1436 QualType ResultType, Selector Sel,
1437 llvm::Value *Receiver,
1438 const CallArgList &CallArgs,
1439 const ObjCInterfaceDecl *Class,
1440 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001441
Craig Topper4f12f102014-03-12 06:41:41 +00001442 CodeGen::RValue
Fariborz Jahanian71394042009-01-23 23:53:38 +00001443 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001444 ReturnValueSlot Return, QualType ResultType,
1445 Selector Sel, const ObjCInterfaceDecl *Class,
1446 bool isCategoryImpl, llvm::Value *Receiver,
1447 bool IsClassMessage, const CallArgList &CallArgs,
1448 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001449
Craig Topper4f12f102014-03-12 06:41:41 +00001450 llvm::Value *GetClass(CodeGenFunction &CGF,
1451 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001452
John McCall7f416cc2015-09-08 08:05:57 +00001453 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override
1454 { return EmitSelector(CGF, Sel); }
1455 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override
1456 { return EmitSelectorAddr(CGF, Sel); }
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001457
1458 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1459 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001460 llvm::Value *GetSelector(CodeGenFunction &CGF,
1461 const ObjCMethodDecl *Method) override
John McCall882987f2013-02-28 19:01:20 +00001462 { return EmitSelector(CGF, Method->getSelector()); }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001463
Craig Topper4f12f102014-03-12 06:41:41 +00001464 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001465
Craig Topper4f12f102014-03-12 06:41:41 +00001466 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
David Chisnall92d436b2012-01-31 18:59:20 +00001467
Craig Topper4f12f102014-03-12 06:41:41 +00001468 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001469
Craig Topper4f12f102014-03-12 06:41:41 +00001470 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1471 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001472
Craig Topper4f12f102014-03-12 06:41:41 +00001473 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001474
Craig Topper4f12f102014-03-12 06:41:41 +00001475 llvm::Constant *GetPropertyGetFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001476 return ObjCTypes.getGetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001477 }
Craig Topper4f12f102014-03-12 06:41:41 +00001478 llvm::Constant *GetPropertySetFunction() override {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001479 return ObjCTypes.getSetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001480 }
Craig Topper4f12f102014-03-12 06:41:41 +00001481
1482 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1483 bool copy) override {
Ted Kremeneke65b0862012-03-06 20:05:56 +00001484 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
1485 }
Craig Topper4f12f102014-03-12 06:41:41 +00001486
1487 llvm::Constant *GetSetStructFunction() override {
David Chisnall168b80f2010-12-26 22:13:16 +00001488 return ObjCTypes.getCopyStructFn();
1489 }
Craig Topper4f12f102014-03-12 06:41:41 +00001490 llvm::Constant *GetGetStructFunction() override {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00001491 return ObjCTypes.getCopyStructFn();
1492 }
Craig Topper4f12f102014-03-12 06:41:41 +00001493 llvm::Constant *GetCppAtomicObjectSetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +00001494 return ObjCTypes.getCppAtomicObjectFunction();
1495 }
Craig Topper4f12f102014-03-12 06:41:41 +00001496 llvm::Constant *GetCppAtomicObjectGetFunction() override {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00001497 return ObjCTypes.getCppAtomicObjectFunction();
1498 }
Craig Topper4f12f102014-03-12 06:41:41 +00001499
1500 llvm::Constant *EnumerationMutationFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001501 return ObjCTypes.getEnumerationMutationFn();
Daniel Dunbard73ea8162009-02-16 18:48:45 +00001502 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001503
Craig Topper4f12f102014-03-12 06:41:41 +00001504 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1505 const ObjCAtTryStmt &S) override;
1506 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1507 const ObjCAtSynchronizedStmt &S) override;
1508 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1509 bool ClearInsertionPoint=true) override;
1510 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001511 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001512 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001513 llvm::Value *src, Address edst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001514 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001515 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001516 bool threadlocal = false) override;
1517 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001518 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001519 llvm::Value *ivarOffset) override;
1520 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001521 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001522 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001523 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001524 llvm::Value *size) override;
1525 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1526 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1527 unsigned CVRQualifiers) override;
1528 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1529 const ObjCInterfaceDecl *Interface,
1530 const ObjCIvarDecl *Ivar) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001531};
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001532
1533/// A helper class for performing the null-initialization of a return
1534/// value.
1535struct NullReturnState {
1536 llvm::BasicBlock *NullBB;
Craig Topper8a13c412014-05-21 05:09:00 +00001537 NullReturnState() : NullBB(nullptr) {}
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001538
John McCall3d1e2c92013-02-12 05:53:35 +00001539 /// Perform a null-check of the given receiver.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001540 void init(CodeGenFunction &CGF, llvm::Value *receiver) {
John McCall3d1e2c92013-02-12 05:53:35 +00001541 // Make blocks for the null-receiver and call edges.
1542 NullBB = CGF.createBasicBlock("msgSend.null-receiver");
1543 llvm::BasicBlock *callBB = CGF.createBasicBlock("msgSend.call");
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001544
1545 // Check for a null receiver and, if there is one, jump to the
John McCall3d1e2c92013-02-12 05:53:35 +00001546 // null-receiver block. There's no point in trying to avoid it:
1547 // we're always going to put *something* there, because otherwise
1548 // we shouldn't have done this null-check in the first place.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001549 llvm::Value *isNull = CGF.Builder.CreateIsNull(receiver);
1550 CGF.Builder.CreateCondBr(isNull, NullBB, callBB);
1551
1552 // Otherwise, start performing the call.
1553 CGF.EmitBlock(callBB);
1554 }
1555
John McCall3d1e2c92013-02-12 05:53:35 +00001556 /// Complete the null-return operation. It is valid to call this
1557 /// regardless of whether 'init' has been called.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001558 RValue complete(CodeGenFunction &CGF, RValue result, QualType resultType,
1559 const CallArgList &CallArgs,
1560 const ObjCMethodDecl *Method) {
John McCall3d1e2c92013-02-12 05:53:35 +00001561 // If we never had to do a null-check, just use the raw result.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001562 if (!NullBB) return result;
John McCall3d1e2c92013-02-12 05:53:35 +00001563
1564 // The continuation block. This will be left null if we don't have an
1565 // IP, which can happen if the method we're calling is marked noreturn.
Craig Topper8a13c412014-05-21 05:09:00 +00001566 llvm::BasicBlock *contBB = nullptr;
1567
John McCall3d1e2c92013-02-12 05:53:35 +00001568 // Finish the call path.
1569 llvm::BasicBlock *callBB = CGF.Builder.GetInsertBlock();
1570 if (callBB) {
1571 contBB = CGF.createBasicBlock("msgSend.cont");
1572 CGF.Builder.CreateBr(contBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001573 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001574
John McCall3d1e2c92013-02-12 05:53:35 +00001575 // Okay, start emitting the null-receiver block.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001576 CGF.EmitBlock(NullBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001577
John McCall3d1e2c92013-02-12 05:53:35 +00001578 // Release any consumed arguments we've got.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001579 if (Method) {
1580 CallArgList::const_iterator I = CallArgs.begin();
1581 for (ObjCMethodDecl::param_const_iterator i = Method->param_begin(),
1582 e = Method->param_end(); i != e; ++i, ++I) {
1583 const ParmVarDecl *ParamDecl = (*i);
1584 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1585 RValue RV = I->RV;
1586 assert(RV.isScalar() &&
1587 "NullReturnState::complete - arg not on object");
John McCallcdda29c2013-03-13 03:10:54 +00001588 CGF.EmitARCRelease(RV.getScalarVal(), ARCImpreciseLifetime);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001589 }
1590 }
1591 }
John McCall3d1e2c92013-02-12 05:53:35 +00001592
1593 // The phi code below assumes that we haven't needed any control flow yet.
1594 assert(CGF.Builder.GetInsertBlock() == NullBB);
1595
1596 // If we've got a void return, just jump to the continuation block.
1597 if (result.isScalar() && resultType->isVoidType()) {
1598 // No jumps required if the message-send was noreturn.
1599 if (contBB) CGF.EmitBlock(contBB);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001600 return result;
1601 }
1602
John McCall3d1e2c92013-02-12 05:53:35 +00001603 // If we've got a scalar return, build a phi.
1604 if (result.isScalar()) {
1605 // Derive the null-initialization value.
1606 llvm::Constant *null = CGF.CGM.EmitNullConstant(resultType);
1607
1608 // If no join is necessary, just flow out.
1609 if (!contBB) return RValue::get(null);
1610
1611 // Otherwise, build a phi.
1612 CGF.EmitBlock(contBB);
1613 llvm::PHINode *phi = CGF.Builder.CreatePHI(null->getType(), 2);
1614 phi->addIncoming(result.getScalarVal(), callBB);
1615 phi->addIncoming(null, NullBB);
1616 return RValue::get(phi);
1617 }
1618
1619 // If we've got an aggregate return, null the buffer out.
1620 // FIXME: maybe we should be doing things differently for all the
1621 // cases where the ABI has us returning (1) non-agg values in
1622 // memory or (2) agg values in registers.
1623 if (result.isAggregate()) {
1624 assert(result.isAggregate() && "null init of non-aggregate result?");
John McCall7f416cc2015-09-08 08:05:57 +00001625 CGF.EmitNullInitialization(result.getAggregateAddress(), resultType);
John McCall3d1e2c92013-02-12 05:53:35 +00001626 if (contBB) CGF.EmitBlock(contBB);
1627 return result;
1628 }
1629
1630 // Complex types.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001631 CGF.EmitBlock(contBB);
John McCall3d1e2c92013-02-12 05:53:35 +00001632 CodeGenFunction::ComplexPairTy callResult = result.getComplexVal();
1633
1634 // Find the scalar type and its zero value.
1635 llvm::Type *scalarTy = callResult.first->getType();
1636 llvm::Constant *scalarZero = llvm::Constant::getNullValue(scalarTy);
1637
1638 // Build phis for both coordinates.
1639 llvm::PHINode *real = CGF.Builder.CreatePHI(scalarTy, 2);
1640 real->addIncoming(callResult.first, callBB);
1641 real->addIncoming(scalarZero, NullBB);
1642 llvm::PHINode *imag = CGF.Builder.CreatePHI(scalarTy, 2);
1643 imag->addIncoming(callResult.second, callBB);
1644 imag->addIncoming(scalarZero, NullBB);
1645 return RValue::getComplex(real, imag);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001646 }
1647};
1648
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001649} // end anonymous namespace
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001650
1651/* *** Helper Functions *** */
1652
1653/// getConstantGEP() - Help routine to construct simple GEPs.
Owen Anderson170229f2009-07-14 23:10:40 +00001654static llvm::Constant *getConstantGEP(llvm::LLVMContext &VMContext,
David Blaikiee3b172a2015-04-02 18:55:21 +00001655 llvm::GlobalVariable *C, unsigned idx0,
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001656 unsigned idx1) {
1657 llvm::Value *Idxs[] = {
Owen Anderson41a75022009-08-13 21:57:51 +00001658 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx0),
1659 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx1)
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001660 };
David Blaikiee3b172a2015-04-02 18:55:21 +00001661 return llvm::ConstantExpr::getGetElementPtr(C->getValueType(), C, Idxs);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001662}
1663
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001664/// hasObjCExceptionAttribute - Return true if this class or any super
1665/// class has the __objc_exception__ attribute.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001666static bool hasObjCExceptionAttribute(ASTContext &Context,
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001667 const ObjCInterfaceDecl *OID) {
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001668 if (OID->hasAttr<ObjCExceptionAttr>())
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001669 return true;
1670 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001671 return hasObjCExceptionAttribute(Context, Super);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001672 return false;
1673}
1674
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001675/* *** CGObjCMac Public Interface *** */
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001676
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001677CGObjCMac::CGObjCMac(CodeGen::CodeGenModule &cgm) : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00001678 ObjCTypes(cgm) {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001679 ObjCABI = 1;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001680 EmitImageInfo();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001681}
1682
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +00001683/// GetClass - Return a reference to the class for the given interface
1684/// decl.
John McCall882987f2013-02-28 19:01:20 +00001685llvm::Value *CGObjCMac::GetClass(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001686 const ObjCInterfaceDecl *ID) {
John McCall882987f2013-02-28 19:01:20 +00001687 return EmitClassRef(CGF, ID);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001688}
1689
1690/// GetSelector - Return the pointer to the unique'd string for this selector.
John McCall7f416cc2015-09-08 08:05:57 +00001691llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, Selector Sel) {
1692 return EmitSelector(CGF, Sel);
1693}
1694Address CGObjCMac::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
1695 return EmitSelectorAddr(CGF, Sel);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001696}
John McCall882987f2013-02-28 19:01:20 +00001697llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, const ObjCMethodDecl
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001698 *Method) {
John McCall882987f2013-02-28 19:01:20 +00001699 return EmitSelector(CGF, Method->getSelector());
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001700}
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001701
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001702llvm::Constant *CGObjCMac::GetEHType(QualType T) {
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001703 if (T->isObjCIdType() ||
1704 T->isObjCQualifiedIdType()) {
1705 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001706 CGM.getContext().getObjCIdRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001707 }
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001708 if (T->isObjCClassType() ||
1709 T->isObjCQualifiedClassType()) {
1710 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001711 CGM.getContext().getObjCClassRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001712 }
1713 if (T->isObjCObjectPointerType())
1714 return CGM.GetAddrOfRTTIDescriptor(T, /*ForEH=*/true);
1715
John McCall2ca705e2010-07-24 00:37:23 +00001716 llvm_unreachable("asking for catch type for ObjC type in fragile runtime");
John McCall2ca705e2010-07-24 00:37:23 +00001717}
1718
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001719/// Generate a constant CFString object.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001720/*
1721 struct __builtin_CFString {
1722 const int *isa; // point to __CFConstantStringClassReference
1723 int flags;
1724 const char *str;
1725 long length;
1726 };
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001727*/
1728
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001729/// or Generate a constant NSString object.
1730/*
1731 struct __builtin_NSString {
1732 const int *isa; // point to __NSConstantStringClassReference
1733 const char *str;
1734 unsigned int length;
1735 };
1736*/
1737
John McCall7f416cc2015-09-08 08:05:57 +00001738ConstantAddress CGObjCCommonMac::GenerateConstantString(
David Chisnall481e3a82010-01-23 02:40:42 +00001739 const StringLiteral *SL) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001740 return (CGM.getLangOpts().NoConstantCFStrings == 0 ?
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001741 CGM.GetAddrOfConstantCFString(SL) :
Fariborz Jahanian50c925f2010-10-19 17:19:29 +00001742 CGM.GetAddrOfConstantString(SL));
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001743}
1744
Ted Kremeneke65b0862012-03-06 20:05:56 +00001745enum {
1746 kCFTaggedObjectID_Integer = (1 << 1) + 1
1747};
1748
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001749/// Generates a message send where the super is the receiver. This is
1750/// a message send to self with special delivery semantics indicating
1751/// which class's method should be called.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001752CodeGen::RValue
1753CGObjCMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001754 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001755 QualType ResultType,
1756 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001757 const ObjCInterfaceDecl *Class,
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001758 bool isCategoryImpl,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001759 llvm::Value *Receiver,
Daniel Dunbarc722b852008-08-30 03:02:31 +00001760 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001761 const CodeGen::CallArgList &CallArgs,
1762 const ObjCMethodDecl *Method) {
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001763 // Create and init a super structure; this is a (receiver, class)
1764 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00001765 Address ObjCSuper =
1766 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
1767 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001768 llvm::Value *ReceiverAsObject =
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001769 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00001770 CGF.Builder.CreateStore(
1771 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00001772 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001773
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001774 // If this is a class message the metaclass is passed as the target.
1775 llvm::Value *Target;
1776 if (IsClassMessage) {
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001777 if (isCategoryImpl) {
1778 // Message sent to 'super' in a class method defined in a category
1779 // implementation requires an odd treatment.
1780 // If we are in a class method, we must retrieve the
1781 // _metaclass_ for the current class, pointed at by
1782 // the class's "isa" pointer. The following assumes that
1783 // isa" is the first ivar in a class (which it must be).
John McCall882987f2013-02-28 19:01:20 +00001784 Target = EmitClassRef(CGF, Class->getSuperClass());
David Blaikie1ed728c2015-04-05 22:45:47 +00001785 Target = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, Target, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001786 Target = CGF.Builder.CreateAlignedLoad(Target, CGF.getPointerAlign());
Mike Stump658fe022009-07-30 22:28:39 +00001787 } else {
David Blaikie1ed728c2015-04-05 22:45:47 +00001788 llvm::Constant *MetaClassPtr = EmitMetaClassRef(Class);
1789 llvm::Value *SuperPtr =
1790 CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, MetaClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00001791 llvm::Value *Super =
1792 CGF.Builder.CreateAlignedLoad(SuperPtr, CGF.getPointerAlign());
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001793 Target = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001794 }
David Blaikie1ed728c2015-04-05 22:45:47 +00001795 } else if (isCategoryImpl)
John McCall882987f2013-02-28 19:01:20 +00001796 Target = EmitClassRef(CGF, Class->getSuperClass());
Fariborz Jahanianda2efb02009-11-14 02:18:31 +00001797 else {
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001798 llvm::Value *ClassPtr = EmitSuperClassRef(Class);
David Blaikie1ed728c2015-04-05 22:45:47 +00001799 ClassPtr = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, ClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00001800 Target = CGF.Builder.CreateAlignedLoad(ClassPtr, CGF.getPointerAlign());
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001801 }
Mike Stump18bb9282009-05-16 07:57:57 +00001802 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
1803 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00001804 llvm::Type *ClassTy =
Daniel Dunbarc722b852008-08-30 03:02:31 +00001805 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
Daniel Dunbarc475d422008-10-29 22:36:39 +00001806 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
John McCall7f416cc2015-09-08 08:05:57 +00001807 CGF.Builder.CreateStore(Target,
1808 CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
John McCall9e8bb002011-05-14 03:10:52 +00001809 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00001810 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00001811 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00001812 true, CallArgs, Method, Class, ObjCTypes);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001813}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001814
1815/// Generate code for a message send expression.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001816CodeGen::RValue CGObjCMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001817 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001818 QualType ResultType,
1819 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001820 llvm::Value *Receiver,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001821 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00001822 const ObjCInterfaceDecl *Class,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001823 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00001824 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00001825 EmitSelector(CGF, Sel),
John McCall9e8bb002011-05-14 03:10:52 +00001826 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00001827 false, CallArgs, Method, Class, ObjCTypes);
1828}
1829
1830static bool isWeakLinkedClass(const ObjCInterfaceDecl *ID) {
1831 do {
1832 if (ID->isWeakImported())
1833 return true;
1834 } while ((ID = ID->getSuperClass()));
1835
1836 return false;
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00001837}
1838
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001839CodeGen::RValue
John McCall9e8bb002011-05-14 03:10:52 +00001840CGObjCCommonMac::EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1841 ReturnValueSlot Return,
1842 QualType ResultType,
1843 llvm::Value *Sel,
1844 llvm::Value *Arg0,
1845 QualType Arg0Ty,
1846 bool IsSuper,
1847 const CallArgList &CallArgs,
1848 const ObjCMethodDecl *Method,
John McCall1e3157b2015-09-10 22:27:50 +00001849 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00001850 const ObjCCommonTypesHelper &ObjCTypes) {
Daniel Dunbarc722b852008-08-30 03:02:31 +00001851 CallArgList ActualArgs;
Fariborz Jahanian969bc682009-04-24 21:07:43 +00001852 if (!IsSuper)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001853 Arg0 = CGF.Builder.CreateBitCast(Arg0, ObjCTypes.ObjectPtrTy);
Eli Friedman43dca6a2011-05-02 17:57:46 +00001854 ActualArgs.add(RValue::get(Arg0), Arg0Ty);
1855 ActualArgs.add(RValue::get(Sel), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00001856 ActualArgs.addFrom(CallArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001857
John McCalla729c622012-02-17 03:33:10 +00001858 // If we're calling a method, use the formal signature.
1859 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001860
Anders Carlsson280e61f12010-06-21 20:59:55 +00001861 if (Method)
Alp Toker314cc812014-01-25 16:55:45 +00001862 assert(CGM.getContext().getCanonicalType(Method->getReturnType()) ==
1863 CGM.getContext().getCanonicalType(ResultType) &&
Anders Carlsson280e61f12010-06-21 20:59:55 +00001864 "Result type mismatch!");
1865
John McCall1e3157b2015-09-10 22:27:50 +00001866 bool ReceiverCanBeNull = true;
1867
1868 // Super dispatch assumes that self is non-null; even the messenger
1869 // doesn't have a null check internally.
1870 if (IsSuper) {
1871 ReceiverCanBeNull = false;
1872
1873 // If this is a direct dispatch of a class method, check whether the class,
1874 // or anything in its hierarchy, was weak-linked.
1875 } else if (ClassReceiver && Method && Method->isClassMethod()) {
1876 ReceiverCanBeNull = isWeakLinkedClass(ClassReceiver);
1877
1878 // If we're emitting a method, and self is const (meaning just ARC, for now),
1879 // and the receiver is a load of self, then self is a valid object.
1880 } else if (auto CurMethod =
1881 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl)) {
1882 auto Self = CurMethod->getSelfDecl();
1883 if (Self->getType().isConstQualified()) {
1884 if (auto LI = dyn_cast<llvm::LoadInst>(Arg0->stripPointerCasts())) {
1885 llvm::Value *SelfAddr = CGF.GetAddrOfLocalVar(Self).getPointer();
1886 if (SelfAddr == LI->getPointerOperand()) {
1887 ReceiverCanBeNull = false;
1888 }
1889 }
1890 }
1891 }
1892
John McCall5880fb82011-05-14 21:12:11 +00001893 NullReturnState nullReturn;
1894
Craig Topper8a13c412014-05-21 05:09:00 +00001895 llvm::Constant *Fn = nullptr;
Tim Northovere77cc392014-03-29 13:28:05 +00001896 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall1e3157b2015-09-10 22:27:50 +00001897 if (ReceiverCanBeNull) nullReturn.init(CGF, Arg0);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00001898 Fn = (ObjCABI == 2) ? ObjCTypes.getSendStretFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001899 : ObjCTypes.getSendStretFn(IsSuper);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001900 } else if (CGM.ReturnTypeUsesFPRet(ResultType)) {
1901 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFpretFn2(IsSuper)
1902 : ObjCTypes.getSendFpretFn(IsSuper);
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001903 } else if (CGM.ReturnTypeUsesFP2Ret(ResultType)) {
1904 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFp2RetFn2(IsSuper)
1905 : ObjCTypes.getSendFp2retFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00001906 } else {
Tim Northovere77cc392014-03-29 13:28:05 +00001907 // arm64 uses objc_msgSend for stret methods and yet null receiver check
1908 // must be made for it.
Ahmed Bougachaa3df87b2015-10-02 22:41:59 +00001909 if (ReceiverCanBeNull && CGM.ReturnTypeUsesSRet(MSI.CallInfo))
Tim Northovere77cc392014-03-29 13:28:05 +00001910 nullReturn.init(CGF, Arg0);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00001911 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001912 : ObjCTypes.getSendFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00001913 }
John McCall1e3157b2015-09-10 22:27:50 +00001914
1915 // Emit a null-check if there's a consumed argument other than the receiver.
1916 bool RequiresNullCheck = false;
1917 if (ReceiverCanBeNull && CGM.getLangOpts().ObjCAutoRefCount && Method) {
Aaron Ballman43b68be2014-03-07 17:50:17 +00001918 for (const auto *ParamDecl : Method->params()) {
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001919 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1920 if (!nullReturn.NullBB)
1921 nullReturn.init(CGF, Arg0);
John McCall1e3157b2015-09-10 22:27:50 +00001922 RequiresNullCheck = true;
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001923 break;
1924 }
1925 }
John McCall1e3157b2015-09-10 22:27:50 +00001926 }
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001927
John McCall1e3157b2015-09-10 22:27:50 +00001928 llvm::Instruction *CallSite;
John McCalla729c622012-02-17 03:33:10 +00001929 Fn = llvm::ConstantExpr::getBitCast(Fn, MSI.MessengerType);
John McCall1e3157b2015-09-10 22:27:50 +00001930 RValue rvalue = CGF.EmitCall(MSI.CallInfo, Fn, Return, ActualArgs,
1931 nullptr, &CallSite);
1932
1933 // Mark the call as noreturn if the method is marked noreturn and the
1934 // receiver cannot be null.
1935 if (Method && Method->hasAttr<NoReturnAttr>() && !ReceiverCanBeNull) {
1936 llvm::CallSite(CallSite).setDoesNotReturn();
1937 }
1938
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001939 return nullReturn.complete(CGF, rvalue, ResultType, CallArgs,
John McCall1e3157b2015-09-10 22:27:50 +00001940 RequiresNullCheck ? Method : nullptr);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001941}
1942
John McCall3fd13f062015-10-21 18:06:47 +00001943static Qualifiers::GC GetGCAttrTypeForType(ASTContext &Ctx, QualType FQT,
1944 bool pointee = false) {
1945 // Note that GC qualification applies recursively to C pointer types
1946 // that aren't otherwise decorated. This is weird, but it's probably
1947 // an intentional workaround to the unreliable placement of GC qualifiers.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001948 if (FQT.isObjCGCStrong())
1949 return Qualifiers::Strong;
John McCall3fd13f062015-10-21 18:06:47 +00001950
1951 if (FQT.isObjCGCWeak())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001952 return Qualifiers::Weak;
John McCall3fd13f062015-10-21 18:06:47 +00001953
1954 if (auto ownership = FQT.getObjCLifetime()) {
1955 // Ownership does not apply recursively to C pointer types.
1956 if (pointee) return Qualifiers::GCNone;
1957 switch (ownership) {
1958 case Qualifiers::OCL_Weak: return Qualifiers::Weak;
1959 case Qualifiers::OCL_Strong: return Qualifiers::Strong;
1960 case Qualifiers::OCL_ExplicitNone: return Qualifiers::GCNone;
1961 case Qualifiers::OCL_Autoreleasing: llvm_unreachable("autoreleasing ivar?");
1962 case Qualifiers::OCL_None: llvm_unreachable("known nonzero");
1963 }
1964 llvm_unreachable("bad objc ownership");
1965 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001966
John McCall3fd13f062015-10-21 18:06:47 +00001967 // Treat unqualified retainable pointers as strong.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001968 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
1969 return Qualifiers::Strong;
1970
John McCall3fd13f062015-10-21 18:06:47 +00001971 // Walk into C pointer types, but only in GC.
1972 if (Ctx.getLangOpts().getGC() != LangOptions::NonGC) {
1973 if (const PointerType *PT = FQT->getAs<PointerType>())
1974 return GetGCAttrTypeForType(Ctx, PT->getPointeeType(), /*pointee*/ true);
1975 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001976
1977 return Qualifiers::GCNone;
1978}
1979
John McCall3fd13f062015-10-21 18:06:47 +00001980namespace {
1981 struct IvarInfo {
1982 CharUnits Offset;
1983 uint64_t SizeInWords;
1984 IvarInfo(CharUnits offset, uint64_t sizeInWords)
1985 : Offset(offset), SizeInWords(sizeInWords) {}
1986
1987 // Allow sorting based on byte pos.
1988 bool operator<(const IvarInfo &other) const {
1989 return Offset < other.Offset;
1990 }
1991 };
1992
1993 /// A helper class for building GC layout strings.
1994 class IvarLayoutBuilder {
1995 CodeGenModule &CGM;
1996
1997 /// The start of the layout. Offsets will be relative to this value,
1998 /// and entries less than this value will be silently discarded.
1999 CharUnits InstanceBegin;
2000
2001 /// The end of the layout. Offsets will never exceed this value.
2002 CharUnits InstanceEnd;
2003
2004 /// Whether we're generating the strong layout or the weak layout.
2005 bool ForStrongLayout;
2006
2007 /// Whether the offsets in IvarsInfo might be out-of-order.
2008 bool IsDisordered = false;
2009
2010 llvm::SmallVector<IvarInfo, 8> IvarsInfo;
2011 public:
2012 IvarLayoutBuilder(CodeGenModule &CGM, CharUnits instanceBegin,
2013 CharUnits instanceEnd, bool forStrongLayout)
2014 : CGM(CGM), InstanceBegin(instanceBegin), InstanceEnd(instanceEnd),
2015 ForStrongLayout(forStrongLayout) {
2016 }
2017
2018 void visitRecord(const RecordType *RT, CharUnits offset);
2019
2020 template <class Iterator, class GetOffsetFn>
2021 void visitAggregate(Iterator begin, Iterator end,
2022 CharUnits aggrOffset,
2023 const GetOffsetFn &getOffset);
2024
2025 void visitField(const FieldDecl *field, CharUnits offset);
2026
2027 /// Add the layout of a block implementation.
2028 void visitBlock(const CGBlockInfo &blockInfo);
2029
2030 /// Is there any information for an interesting bitmap?
2031 bool hasBitmapData() const { return !IvarsInfo.empty(); }
2032
2033 llvm::Constant *buildBitmap(CGObjCCommonMac &CGObjC,
2034 llvm::SmallVectorImpl<unsigned char> &buffer);
2035
2036 static void dump(ArrayRef<unsigned char> buffer) {
2037 const unsigned char *s = buffer.data();
2038 for (unsigned i = 0, e = buffer.size(); i < e; i++)
2039 if (!(s[i] & 0xf0))
2040 printf("0x0%x%s", s[i], s[i] != 0 ? ", " : "");
2041 else
2042 printf("0x%x%s", s[i], s[i] != 0 ? ", " : "");
2043 printf("\n");
2044 }
2045 };
2046}
2047
John McCall351762c2011-02-07 10:33:21 +00002048llvm::Constant *CGObjCCommonMac::BuildGCBlockLayout(CodeGenModule &CGM,
2049 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002050
Chris Lattnerece04092012-02-07 00:39:47 +00002051 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
David Blaikiebbafb8a2012-03-11 07:00:24 +00002052 if (CGM.getLangOpts().getGC() == LangOptions::NonGC &&
2053 !CGM.getLangOpts().ObjCAutoRefCount)
John McCall351762c2011-02-07 10:33:21 +00002054 return nullPtr;
2055
John McCall3fd13f062015-10-21 18:06:47 +00002056 IvarLayoutBuilder builder(CGM, CharUnits::Zero(), blockInfo.BlockSize,
2057 /*for strong layout*/ true);
2058
2059 builder.visitBlock(blockInfo);
2060
2061 if (!builder.hasBitmapData())
2062 return nullPtr;
2063
2064 llvm::SmallVector<unsigned char, 32> buffer;
2065 llvm::Constant *C = builder.buildBitmap(*this, buffer);
2066 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2067 printf("\n block variable layout for block: ");
2068 builder.dump(buffer);
2069 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002070
John McCall3fd13f062015-10-21 18:06:47 +00002071 return C;
2072}
2073
2074void IvarLayoutBuilder::visitBlock(const CGBlockInfo &blockInfo) {
Fariborz Jahaniancfddabf2010-09-09 00:21:45 +00002075 // __isa is the first field in block descriptor and must assume by runtime's
2076 // convention that it is GC'able.
John McCall3fd13f062015-10-21 18:06:47 +00002077 IvarsInfo.push_back(IvarInfo(CharUnits::Zero(), 1));
John McCall351762c2011-02-07 10:33:21 +00002078
2079 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2080
John McCall351762c2011-02-07 10:33:21 +00002081 // Ignore the optional 'this' capture: C++ objects are not assumed
2082 // to be GC'ed.
2083
John McCall3fd13f062015-10-21 18:06:47 +00002084 CharUnits lastFieldOffset;
2085
John McCall351762c2011-02-07 10:33:21 +00002086 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002087 for (const auto &CI : blockDecl->captures()) {
2088 const VarDecl *variable = CI.getVariable();
John McCall351762c2011-02-07 10:33:21 +00002089 QualType type = variable->getType();
2090
2091 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2092
2093 // Ignore constant captures.
2094 if (capture.isConstant()) continue;
2095
John McCall3fd13f062015-10-21 18:06:47 +00002096 CharUnits fieldOffset = capture.getOffset();
2097
2098 // Block fields are not necessarily ordered; if we detect that we're
2099 // adding them out-of-order, make sure we sort later.
2100 if (fieldOffset < lastFieldOffset)
2101 IsDisordered = true;
2102 lastFieldOffset = fieldOffset;
John McCall351762c2011-02-07 10:33:21 +00002103
2104 // __block variables are passed by their descriptor address.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002105 if (CI.isByRef()) {
John McCall3fd13f062015-10-21 18:06:47 +00002106 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
Fariborz Jahanian933c6722010-09-11 01:27:29 +00002107 continue;
John McCall351762c2011-02-07 10:33:21 +00002108 }
2109
2110 assert(!type->isArrayType() && "array variable should not be caught");
2111 if (const RecordType *record = type->getAs<RecordType>()) {
John McCall3fd13f062015-10-21 18:06:47 +00002112 visitRecord(record, fieldOffset);
Fariborz Jahanian903aba32010-08-05 21:00:25 +00002113 continue;
2114 }
Fariborz Jahanianf95e3582010-08-06 16:28:55 +00002115
John McCall351762c2011-02-07 10:33:21 +00002116 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), type);
John McCall351762c2011-02-07 10:33:21 +00002117
John McCall3fd13f062015-10-21 18:06:47 +00002118 if (GCAttr == Qualifiers::Strong) {
2119 assert(CGM.getContext().getTypeSize(type)
2120 == CGM.getTarget().getPointerWidth(0));
2121 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
2122 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002123 }
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00002124}
2125
John McCall3fd13f062015-10-21 18:06:47 +00002126
Fariborz Jahanian2c96d302012-11-04 18:19:40 +00002127/// getBlockCaptureLifetime - This routine returns life time of the captured
2128/// block variable for the purpose of block layout meta-data generation. FQT is
2129/// the type of the variable captured in the block.
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002130Qualifiers::ObjCLifetime CGObjCCommonMac::getBlockCaptureLifetime(QualType FQT,
2131 bool ByrefLayout) {
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002132 if (CGM.getLangOpts().ObjCAutoRefCount)
2133 return FQT.getObjCLifetime();
2134
Fariborz Jahanian2c96d302012-11-04 18:19:40 +00002135 // MRR.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002136 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002137 return ByrefLayout ? Qualifiers::OCL_ExplicitNone : Qualifiers::OCL_Strong;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002138
2139 return Qualifiers::OCL_None;
2140}
2141
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002142void CGObjCCommonMac::UpdateRunSkipBlockVars(bool IsByref,
2143 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002144 CharUnits FieldOffset,
2145 CharUnits FieldSize) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002146 // __block variables are passed by their descriptor address.
2147 if (IsByref)
2148 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_BYREF, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002149 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002150 else if (LifeTime == Qualifiers::OCL_Strong)
2151 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_STRONG, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002152 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002153 else if (LifeTime == Qualifiers::OCL_Weak)
2154 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_WEAK, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002155 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002156 else if (LifeTime == Qualifiers::OCL_ExplicitNone)
2157 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_UNRETAINED, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002158 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002159 else
2160 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_NON_OBJECT_BYTES,
2161 FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002162 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002163}
2164
2165void CGObjCCommonMac::BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
2166 const RecordDecl *RD,
2167 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002168 CharUnits BytePos, bool &HasUnion,
2169 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002170 bool IsUnion = (RD && RD->isUnion());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002171 CharUnits MaxUnionSize = CharUnits::Zero();
Craig Topper8a13c412014-05-21 05:09:00 +00002172 const FieldDecl *MaxField = nullptr;
2173 const FieldDecl *LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002174 CharUnits MaxFieldOffset = CharUnits::Zero();
2175 CharUnits LastBitfieldOrUnnamedOffset = CharUnits::Zero();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002176
2177 if (RecFields.empty())
2178 return;
John McCallc8e01702013-04-16 22:48:15 +00002179 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002180
2181 for (unsigned i = 0, e = RecFields.size(); i != e; ++i) {
2182 const FieldDecl *Field = RecFields[i];
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002183 // Note that 'i' here is actually the field index inside RD of Field,
2184 // although this dependency is hidden.
2185 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002186 CharUnits FieldOffset =
2187 CGM.getContext().toCharUnitsFromBits(RL.getFieldOffset(i));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002188
2189 // Skip over unnamed or bitfields
2190 if (!Field->getIdentifier() || Field->isBitField()) {
2191 LastFieldBitfieldOrUnnamed = Field;
2192 LastBitfieldOrUnnamedOffset = FieldOffset;
2193 continue;
2194 }
Craig Topper8a13c412014-05-21 05:09:00 +00002195
2196 LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002197 QualType FQT = Field->getType();
2198 if (FQT->isRecordType() || FQT->isUnionType()) {
2199 if (FQT->isUnionType())
2200 HasUnion = true;
2201
2202 BuildRCBlockVarRecordLayout(FQT->getAs<RecordType>(),
2203 BytePos + FieldOffset, HasUnion);
2204 continue;
2205 }
2206
2207 if (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2208 const ConstantArrayType *CArray =
2209 dyn_cast_or_null<ConstantArrayType>(Array);
2210 uint64_t ElCount = CArray->getSize().getZExtValue();
2211 assert(CArray && "only array with known element size is supported");
2212 FQT = CArray->getElementType();
2213 while (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2214 const ConstantArrayType *CArray =
2215 dyn_cast_or_null<ConstantArrayType>(Array);
2216 ElCount *= CArray->getSize().getZExtValue();
2217 FQT = CArray->getElementType();
2218 }
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002219 if (FQT->isRecordType() && ElCount) {
2220 int OldIndex = RunSkipBlockVars.size() - 1;
2221 const RecordType *RT = FQT->getAs<RecordType>();
2222 BuildRCBlockVarRecordLayout(RT, BytePos + FieldOffset,
2223 HasUnion);
2224
2225 // Replicate layout information for each array element. Note that
2226 // one element is already done.
2227 uint64_t ElIx = 1;
2228 for (int FirstIndex = RunSkipBlockVars.size() - 1 ;ElIx < ElCount; ElIx++) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002229 CharUnits Size = CGM.getContext().getTypeSizeInChars(RT);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002230 for (int i = OldIndex+1; i <= FirstIndex; ++i)
2231 RunSkipBlockVars.push_back(
2232 RUN_SKIP(RunSkipBlockVars[i].opcode,
2233 RunSkipBlockVars[i].block_var_bytepos + Size*ElIx,
2234 RunSkipBlockVars[i].block_var_size));
2235 }
2236 continue;
2237 }
2238 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002239 CharUnits FieldSize = CGM.getContext().getTypeSizeInChars(Field->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002240 if (IsUnion) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002241 CharUnits UnionIvarSize = FieldSize;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002242 if (UnionIvarSize > MaxUnionSize) {
2243 MaxUnionSize = UnionIvarSize;
2244 MaxField = Field;
2245 MaxFieldOffset = FieldOffset;
2246 }
2247 } else {
2248 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002249 getBlockCaptureLifetime(FQT, ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002250 BytePos + FieldOffset,
2251 FieldSize);
2252 }
2253 }
2254
2255 if (LastFieldBitfieldOrUnnamed) {
2256 if (LastFieldBitfieldOrUnnamed->isBitField()) {
2257 // Last field was a bitfield. Must update the info.
2258 uint64_t BitFieldSize
2259 = LastFieldBitfieldOrUnnamed->getBitWidthValue(CGM.getContext());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002260 unsigned UnsSize = (BitFieldSize / ByteSizeInBits) +
Eli Friedman8cbca202012-11-06 22:15:52 +00002261 ((BitFieldSize % ByteSizeInBits) != 0);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002262 CharUnits Size = CharUnits::fromQuantity(UnsSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002263 Size += LastBitfieldOrUnnamedOffset;
2264 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002265 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2266 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002267 BytePos + LastBitfieldOrUnnamedOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002268 Size);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002269 } else {
2270 assert(!LastFieldBitfieldOrUnnamed->getIdentifier() &&"Expected unnamed");
2271 // Last field was unnamed. Must update skip info.
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002272 CharUnits FieldSize
2273 = CGM.getContext().getTypeSizeInChars(LastFieldBitfieldOrUnnamed->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002274 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002275 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2276 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002277 BytePos + LastBitfieldOrUnnamedOffset,
2278 FieldSize);
2279 }
2280 }
2281
2282 if (MaxField)
2283 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002284 getBlockCaptureLifetime(MaxField->getType(), ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002285 BytePos + MaxFieldOffset,
2286 MaxUnionSize);
2287}
2288
2289void CGObjCCommonMac::BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002290 CharUnits BytePos,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002291 bool &HasUnion,
2292 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002293 const RecordDecl *RD = RT->getDecl();
Aaron Ballman62e47c42014-03-10 13:43:55 +00002294 SmallVector<const FieldDecl*, 16> Fields(RD->fields());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002295 llvm::Type *Ty = CGM.getTypes().ConvertType(QualType(RT, 0));
2296 const llvm::StructLayout *RecLayout =
2297 CGM.getDataLayout().getStructLayout(cast<llvm::StructType>(Ty));
2298
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002299 BuildRCRecordLayout(RecLayout, RD, Fields, BytePos, HasUnion, ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002300}
2301
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002302/// InlineLayoutInstruction - This routine produce an inline instruction for the
2303/// block variable layout if it can. If not, it returns 0. Rules are as follow:
2304/// If ((uintptr_t) layout) < (1 << 12), the layout is inline. In the 64bit world,
2305/// an inline layout of value 0x0000000000000xyz is interpreted as follows:
2306/// x captured object pointers of BLOCK_LAYOUT_STRONG. Followed by
2307/// y captured object of BLOCK_LAYOUT_BYREF. Followed by
2308/// z captured object of BLOCK_LAYOUT_WEAK. If any of the above is missing, zero
2309/// replaces it. For example, 0x00000x00 means x BLOCK_LAYOUT_STRONG and no
2310/// BLOCK_LAYOUT_BYREF and no BLOCK_LAYOUT_WEAK objects are captured.
2311uint64_t CGObjCCommonMac::InlineLayoutInstruction(
2312 SmallVectorImpl<unsigned char> &Layout) {
2313 uint64_t Result = 0;
2314 if (Layout.size() <= 3) {
2315 unsigned size = Layout.size();
2316 unsigned strong_word_count = 0, byref_word_count=0, weak_word_count=0;
2317 unsigned char inst;
2318 enum BLOCK_LAYOUT_OPCODE opcode ;
2319 switch (size) {
2320 case 3:
2321 inst = Layout[0];
2322 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2323 if (opcode == BLOCK_LAYOUT_STRONG)
2324 strong_word_count = (inst & 0xF)+1;
2325 else
2326 return 0;
2327 inst = Layout[1];
2328 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2329 if (opcode == BLOCK_LAYOUT_BYREF)
2330 byref_word_count = (inst & 0xF)+1;
2331 else
2332 return 0;
2333 inst = Layout[2];
2334 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2335 if (opcode == BLOCK_LAYOUT_WEAK)
2336 weak_word_count = (inst & 0xF)+1;
2337 else
2338 return 0;
2339 break;
2340
2341 case 2:
2342 inst = Layout[0];
2343 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2344 if (opcode == BLOCK_LAYOUT_STRONG) {
2345 strong_word_count = (inst & 0xF)+1;
2346 inst = Layout[1];
2347 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2348 if (opcode == BLOCK_LAYOUT_BYREF)
2349 byref_word_count = (inst & 0xF)+1;
2350 else if (opcode == BLOCK_LAYOUT_WEAK)
2351 weak_word_count = (inst & 0xF)+1;
2352 else
2353 return 0;
2354 }
2355 else if (opcode == BLOCK_LAYOUT_BYREF) {
2356 byref_word_count = (inst & 0xF)+1;
2357 inst = Layout[1];
2358 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2359 if (opcode == BLOCK_LAYOUT_WEAK)
2360 weak_word_count = (inst & 0xF)+1;
2361 else
2362 return 0;
2363 }
2364 else
2365 return 0;
2366 break;
2367
2368 case 1:
2369 inst = Layout[0];
2370 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2371 if (opcode == BLOCK_LAYOUT_STRONG)
2372 strong_word_count = (inst & 0xF)+1;
2373 else if (opcode == BLOCK_LAYOUT_BYREF)
2374 byref_word_count = (inst & 0xF)+1;
2375 else if (opcode == BLOCK_LAYOUT_WEAK)
2376 weak_word_count = (inst & 0xF)+1;
2377 else
2378 return 0;
2379 break;
2380
2381 default:
2382 return 0;
2383 }
2384
2385 // Cannot inline when any of the word counts is 15. Because this is one less
2386 // than the actual work count (so 15 means 16 actual word counts),
2387 // and we can only display 0 thru 15 word counts.
2388 if (strong_word_count == 16 || byref_word_count == 16 || weak_word_count == 16)
2389 return 0;
2390
2391 unsigned count =
2392 (strong_word_count != 0) + (byref_word_count != 0) + (weak_word_count != 0);
2393
2394 if (size == count) {
2395 if (strong_word_count)
2396 Result = strong_word_count;
2397 Result <<= 4;
2398 if (byref_word_count)
2399 Result += byref_word_count;
2400 Result <<= 4;
2401 if (weak_word_count)
2402 Result += weak_word_count;
2403 }
2404 }
2405 return Result;
2406}
2407
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002408llvm::Constant *CGObjCCommonMac::getBitmapBlockLayout(bool ComputeByrefLayout) {
2409 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2410 if (RunSkipBlockVars.empty())
2411 return nullPtr;
John McCallc8e01702013-04-16 22:48:15 +00002412 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2413 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002414 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2415
2416 // Sort on byte position; captures might not be allocated in order,
2417 // and unions can do funny things.
2418 llvm::array_pod_sort(RunSkipBlockVars.begin(), RunSkipBlockVars.end());
2419 SmallVector<unsigned char, 16> Layout;
2420
2421 unsigned size = RunSkipBlockVars.size();
2422 for (unsigned i = 0; i < size; i++) {
2423 enum BLOCK_LAYOUT_OPCODE opcode = RunSkipBlockVars[i].opcode;
2424 CharUnits start_byte_pos = RunSkipBlockVars[i].block_var_bytepos;
2425 CharUnits end_byte_pos = start_byte_pos;
2426 unsigned j = i+1;
2427 while (j < size) {
2428 if (opcode == RunSkipBlockVars[j].opcode) {
2429 end_byte_pos = RunSkipBlockVars[j++].block_var_bytepos;
2430 i++;
2431 }
2432 else
2433 break;
2434 }
2435 CharUnits size_in_bytes =
2436 end_byte_pos - start_byte_pos + RunSkipBlockVars[j-1].block_var_size;
2437 if (j < size) {
2438 CharUnits gap =
2439 RunSkipBlockVars[j].block_var_bytepos -
2440 RunSkipBlockVars[j-1].block_var_bytepos - RunSkipBlockVars[j-1].block_var_size;
2441 size_in_bytes += gap;
2442 }
2443 CharUnits residue_in_bytes = CharUnits::Zero();
2444 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES) {
2445 residue_in_bytes = size_in_bytes % WordSizeInBytes;
2446 size_in_bytes -= residue_in_bytes;
2447 opcode = BLOCK_LAYOUT_NON_OBJECT_WORDS;
2448 }
2449
2450 unsigned size_in_words = size_in_bytes.getQuantity() / WordSizeInBytes;
2451 while (size_in_words >= 16) {
2452 // Note that value in imm. is one less that the actual
2453 // value. So, 0xf means 16 words follow!
2454 unsigned char inst = (opcode << 4) | 0xf;
2455 Layout.push_back(inst);
2456 size_in_words -= 16;
2457 }
2458 if (size_in_words > 0) {
2459 // Note that value in imm. is one less that the actual
2460 // value. So, we subtract 1 away!
2461 unsigned char inst = (opcode << 4) | (size_in_words-1);
2462 Layout.push_back(inst);
2463 }
2464 if (residue_in_bytes > CharUnits::Zero()) {
2465 unsigned char inst =
2466 (BLOCK_LAYOUT_NON_OBJECT_BYTES << 4) | (residue_in_bytes.getQuantity()-1);
2467 Layout.push_back(inst);
2468 }
2469 }
2470
John McCall7f416cc2015-09-08 08:05:57 +00002471 while (!Layout.empty()) {
2472 unsigned char inst = Layout.back();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002473 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2474 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES || opcode == BLOCK_LAYOUT_NON_OBJECT_WORDS)
2475 Layout.pop_back();
2476 else
2477 break;
2478 }
2479
2480 uint64_t Result = InlineLayoutInstruction(Layout);
2481 if (Result != 0) {
2482 // Block variable layout instruction has been inlined.
2483 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2484 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002485 printf("\n Inline BYREF variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002486 else
John McCall7f416cc2015-09-08 08:05:57 +00002487 printf("\n Inline block variable layout: ");
2488 printf("0x0%" PRIx64 "", Result);
2489 if (auto numStrong = (Result & 0xF00) >> 8)
2490 printf(", BL_STRONG:%d", (int) numStrong);
2491 if (auto numByref = (Result & 0x0F0) >> 4)
2492 printf(", BL_BYREF:%d", (int) numByref);
2493 if (auto numWeak = (Result & 0x00F) >> 0)
2494 printf(", BL_WEAK:%d", (int) numWeak);
2495 printf(", BL_OPERATOR:0\n");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002496 }
John McCall7f416cc2015-09-08 08:05:57 +00002497 return llvm::ConstantInt::get(CGM.IntPtrTy, Result);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002498 }
2499
2500 unsigned char inst = (BLOCK_LAYOUT_OPERATOR << 4) | 0;
2501 Layout.push_back(inst);
2502 std::string BitMap;
2503 for (unsigned i = 0, e = Layout.size(); i != e; i++)
2504 BitMap += Layout[i];
2505
2506 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2507 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002508 printf("\n Byref variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002509 else
John McCall7f416cc2015-09-08 08:05:57 +00002510 printf("\n Block variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002511 for (unsigned i = 0, e = BitMap.size(); i != e; i++) {
2512 unsigned char inst = BitMap[i];
2513 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2514 unsigned delta = 1;
2515 switch (opcode) {
2516 case BLOCK_LAYOUT_OPERATOR:
2517 printf("BL_OPERATOR:");
2518 delta = 0;
2519 break;
2520 case BLOCK_LAYOUT_NON_OBJECT_BYTES:
2521 printf("BL_NON_OBJECT_BYTES:");
2522 break;
2523 case BLOCK_LAYOUT_NON_OBJECT_WORDS:
2524 printf("BL_NON_OBJECT_WORD:");
2525 break;
2526 case BLOCK_LAYOUT_STRONG:
2527 printf("BL_STRONG:");
2528 break;
2529 case BLOCK_LAYOUT_BYREF:
2530 printf("BL_BYREF:");
2531 break;
2532 case BLOCK_LAYOUT_WEAK:
2533 printf("BL_WEAK:");
2534 break;
2535 case BLOCK_LAYOUT_UNRETAINED:
2536 printf("BL_UNRETAINED:");
2537 break;
2538 }
2539 // Actual value of word count is one more that what is in the imm.
2540 // field of the instruction
2541 printf("%d", (inst & 0xf) + delta);
2542 if (i < e-1)
2543 printf(", ");
2544 else
2545 printf("\n");
2546 }
2547 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002548
2549 llvm::GlobalVariable *Entry = CreateMetadataVar(
2550 "OBJC_CLASS_NAME_",
2551 llvm::ConstantDataArray::getString(VMContext, BitMap, false),
John McCall7f416cc2015-09-08 08:05:57 +00002552 "__TEXT,__objc_classname,cstring_literals", CharUnits::One(), true);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002553 return getConstantGEP(VMContext, Entry, 0, 0);
2554}
2555
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002556llvm::Constant *CGObjCCommonMac::BuildRCBlockLayout(CodeGenModule &CGM,
2557 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002558 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2559
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002560 RunSkipBlockVars.clear();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002561 bool hasUnion = false;
2562
John McCallc8e01702013-04-16 22:48:15 +00002563 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2564 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002565 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2566
2567 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2568
2569 // Calculate the basic layout of the block structure.
2570 const llvm::StructLayout *layout =
2571 CGM.getDataLayout().getStructLayout(blockInfo.StructureType);
2572
2573 // Ignore the optional 'this' capture: C++ objects are not assumed
2574 // to be GC'ed.
Fariborz Jahanian4cf177e2012-12-04 17:20:57 +00002575 if (blockInfo.BlockHeaderForcedGapSize != CharUnits::Zero())
2576 UpdateRunSkipBlockVars(false, Qualifiers::OCL_None,
2577 blockInfo.BlockHeaderForcedGapOffset,
2578 blockInfo.BlockHeaderForcedGapSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002579 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002580 for (const auto &CI : blockDecl->captures()) {
2581 const VarDecl *variable = CI.getVariable();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002582 QualType type = variable->getType();
2583
2584 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2585
2586 // Ignore constant captures.
2587 if (capture.isConstant()) continue;
2588
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002589 CharUnits fieldOffset =
2590 CharUnits::fromQuantity(layout->getElementOffset(capture.getIndex()));
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002591
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002592 assert(!type->isArrayType() && "array variable should not be caught");
Aaron Ballman9371dd22014-03-14 18:34:04 +00002593 if (!CI.isByRef())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002594 if (const RecordType *record = type->getAs<RecordType>()) {
2595 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion);
2596 continue;
2597 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002598 CharUnits fieldSize;
Aaron Ballman9371dd22014-03-14 18:34:04 +00002599 if (CI.isByRef())
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002600 fieldSize = CharUnits::fromQuantity(WordSizeInBytes);
2601 else
2602 fieldSize = CGM.getContext().getTypeSizeInChars(type);
Aaron Ballman9371dd22014-03-14 18:34:04 +00002603 UpdateRunSkipBlockVars(CI.isByRef(), getBlockCaptureLifetime(type, false),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002604 fieldOffset, fieldSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002605 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002606 return getBitmapBlockLayout(false);
2607}
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002608
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002609
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002610llvm::Constant *CGObjCCommonMac::BuildByrefLayout(CodeGen::CodeGenModule &CGM,
2611 QualType T) {
2612 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2613 assert(!T->isArrayType() && "__block array variable should not be caught");
2614 CharUnits fieldOffset;
2615 RunSkipBlockVars.clear();
2616 bool hasUnion = false;
2617 if (const RecordType *record = T->getAs<RecordType>()) {
2618 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion, true /*ByrefLayout */);
2619 llvm::Constant *Result = getBitmapBlockLayout(true);
2620 return Result;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002621 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002622 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2623 return nullPtr;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002624}
2625
John McCall882987f2013-02-28 19:01:20 +00002626llvm::Value *CGObjCMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00002627 const ObjCProtocolDecl *PD) {
Daniel Dunbar7050c552008-09-04 04:33:15 +00002628 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002629 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbar7050c552008-09-04 04:33:15 +00002630 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2631
Owen Andersonade90fd2009-07-29 18:54:39 +00002632 return llvm::ConstantExpr::getBitCast(GetProtocolRef(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00002633 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002634}
2635
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002636void CGObjCCommonMac::GenerateProtocol(const ObjCProtocolDecl *PD) {
Mike Stump18bb9282009-05-16 07:57:57 +00002637 // FIXME: We shouldn't need this, the protocol decl should contain enough
2638 // information to tell us whether this was a declaration or a definition.
Daniel Dunbarc475d422008-10-29 22:36:39 +00002639 DefinedProtocols.insert(PD->getIdentifier());
2640
2641 // If we have generated a forward reference to this protocol, emit
2642 // it now. Otherwise do nothing, the protocol objects are lazily
2643 // emitted.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002644 if (Protocols.count(PD->getIdentifier()))
Daniel Dunbarc475d422008-10-29 22:36:39 +00002645 GetOrEmitProtocol(PD);
2646}
2647
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002648llvm::Constant *CGObjCCommonMac::GetProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002649 if (DefinedProtocols.count(PD->getIdentifier()))
2650 return GetOrEmitProtocol(PD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002651
Daniel Dunbarc475d422008-10-29 22:36:39 +00002652 return GetOrEmitProtocolRef(PD);
2653}
2654
Daniel Dunbarb036db82008-08-13 03:21:16 +00002655/*
Rafael Espindolaf9e1e5e2014-02-20 14:09:04 +00002656// Objective-C 1.0 extensions
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002657struct _objc_protocol {
2658struct _objc_protocol_extension *isa;
2659char *protocol_name;
2660struct _objc_protocol_list *protocol_list;
2661struct _objc__method_prototype_list *instance_methods;
2662struct _objc__method_prototype_list *class_methods
2663};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002664
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002665See EmitProtocolExtension().
Daniel Dunbarb036db82008-08-13 03:21:16 +00002666*/
Daniel Dunbarc475d422008-10-29 22:36:39 +00002667llvm::Constant *CGObjCMac::GetOrEmitProtocol(const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00002668 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbarc475d422008-10-29 22:36:39 +00002669
2670 // Early exit if a defining object has already been generated.
2671 if (Entry && Entry->hasInitializer())
2672 return Entry;
2673
Douglas Gregora715bff2012-01-01 19:51:50 +00002674 // Use the protocol definition, if there is one.
2675 if (const ObjCProtocolDecl *Def = PD->getDefinition())
2676 PD = Def;
2677
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002678 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002679 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002680 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2681
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002682 // Construct method lists.
2683 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
2684 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002685 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002686 for (const auto *MD : PD->instance_methods()) {
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002687 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002688 if (!C)
2689 return GetOrEmitProtocolRef(PD);
2690
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002691 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2692 OptInstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002693 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002694 } else {
2695 InstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002696 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002697 }
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002698 }
2699
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002700 for (const auto *MD : PD->class_methods()) {
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002701 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002702 if (!C)
2703 return GetOrEmitProtocolRef(PD);
2704
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002705 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2706 OptClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002707 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002708 } else {
2709 ClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002710 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002711 }
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002712 }
2713
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002714 MethodTypesExt.insert(MethodTypesExt.end(),
2715 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
2716
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002717 llvm::Constant *Values[] = {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002718 EmitProtocolExtension(PD, OptInstanceMethods, OptClassMethods,
2719 MethodTypesExt),
2720 GetClassName(PD->getObjCRuntimeNameAsString()),
2721 EmitProtocolList("OBJC_PROTOCOL_REFS_" + PD->getName(),
2722 PD->protocol_begin(), PD->protocol_end()),
2723 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_" + PD->getName(),
2724 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2725 InstanceMethods),
2726 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_" + PD->getName(),
2727 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2728 ClassMethods)};
Owen Anderson0e0189d2009-07-27 22:29:56 +00002729 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbarb036db82008-08-13 03:21:16 +00002730 Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002731
Daniel Dunbarb036db82008-08-13 03:21:16 +00002732 if (Entry) {
Rafael Espindola5d117f32014-03-06 01:10:46 +00002733 // Already created, update the initializer.
Rafael Espindolab3262952014-05-09 00:43:37 +00002734 assert(Entry->hasPrivateLinkage());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002735 Entry->setInitializer(Init);
2736 } else {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002737 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2738 false, llvm::GlobalValue::PrivateLinkage,
2739 Init, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002740 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002741 // FIXME: Is this necessary? Why only for protocol?
2742 Entry->setAlignment(4);
John McCallf9582a72012-03-30 21:29:05 +00002743
2744 Protocols[PD->getIdentifier()] = Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002745 }
Rafael Espindola060062a2014-03-06 22:15:10 +00002746 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbarc475d422008-10-29 22:36:39 +00002747
2748 return Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002749}
2750
Daniel Dunbarc475d422008-10-29 22:36:39 +00002751llvm::Constant *CGObjCMac::GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00002752 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
2753
2754 if (!Entry) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002755 // We use the initializer as a marker of whether this is a forward
2756 // reference or not. At module finalization we add the empty
2757 // contents for protocols which were referenced but never defined.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002758 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2759 false, llvm::GlobalValue::PrivateLinkage,
2760 nullptr, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002761 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002762 // FIXME: Is this necessary? Why only for protocol?
2763 Entry->setAlignment(4);
2764 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002765
Daniel Dunbarb036db82008-08-13 03:21:16 +00002766 return Entry;
2767}
2768
2769/*
2770 struct _objc_protocol_extension {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002771 uint32_t size;
2772 struct objc_method_description_list *optional_instance_methods;
2773 struct objc_method_description_list *optional_class_methods;
2774 struct objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002775 const char ** extendedMethodTypes;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002776 };
2777*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002778llvm::Constant *
2779CGObjCMac::EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002780 ArrayRef<llvm::Constant*> OptInstanceMethods,
2781 ArrayRef<llvm::Constant*> OptClassMethods,
2782 ArrayRef<llvm::Constant*> MethodTypesExt) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002783 uint64_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00002784 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolExtensionTy);
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002785 llvm::Constant *Values[] = {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002786 llvm::ConstantInt::get(ObjCTypes.IntTy, Size),
2787 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_OPT_" + PD->getName(),
2788 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2789 OptInstanceMethods),
2790 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_OPT_" + PD->getName(),
2791 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2792 OptClassMethods),
2793 EmitPropertyList("OBJC_$_PROP_PROTO_LIST_" + PD->getName(), nullptr, PD,
2794 ObjCTypes),
2795 EmitProtocolMethodTypes("OBJC_PROTOCOL_METHOD_TYPES_" + PD->getName(),
2796 MethodTypesExt, ObjCTypes)};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002797
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002798 // Return null if no extension bits are used.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002799 if (Values[1]->isNullValue() && Values[2]->isNullValue() &&
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002800 Values[3]->isNullValue() && Values[4]->isNullValue())
Owen Anderson0b75f232009-07-31 20:28:54 +00002801 return llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002802
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002803 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00002804 llvm::ConstantStruct::get(ObjCTypes.ProtocolExtensionTy, Values);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002805
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00002806 // No special section, but goes in llvm.used
Alp Toker541d5072014-06-07 23:30:53 +00002807 return CreateMetadataVar("\01l_OBJC_PROTOCOLEXT_" + PD->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00002808 StringRef(), CGM.getPointerAlign(), true);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002809}
2810
2811/*
2812 struct objc_protocol_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00002813 struct objc_protocol_list *next;
2814 long count;
2815 Protocol *list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00002816 };
2817*/
Daniel Dunbardec75f82008-08-21 21:57:41 +00002818llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002819CGObjCMac::EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00002820 ObjCProtocolDecl::protocol_iterator begin,
2821 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002822 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002823
Daniel Dunbardec75f82008-08-21 21:57:41 +00002824 for (; begin != end; ++begin)
2825 ProtocolRefs.push_back(GetProtocolRef(*begin));
Daniel Dunbarb036db82008-08-13 03:21:16 +00002826
2827 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002828 if (ProtocolRefs.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00002829 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002830
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002831 // This list is null terminated.
Owen Anderson0b75f232009-07-31 20:28:54 +00002832 ProtocolRefs.push_back(llvm::Constant::getNullValue(ObjCTypes.ProtocolPtrTy));
Daniel Dunbarb036db82008-08-13 03:21:16 +00002833
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002834 llvm::Constant *Values[3];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002835 // This field is only used by the runtime.
Owen Anderson0b75f232009-07-31 20:28:54 +00002836 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002837 Values[1] = llvm::ConstantInt::get(ObjCTypes.LongTy,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002838 ProtocolRefs.size() - 1);
2839 Values[2] =
2840 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolPtrTy,
2841 ProtocolRefs.size()),
Daniel Dunbarb036db82008-08-13 03:21:16 +00002842 ProtocolRefs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002843
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002844 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002845 llvm::GlobalVariable *GV =
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00002846 CreateMetadataVar(Name, Init, "__OBJC,__cat_cls_meth,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00002847 CGM.getPointerAlign(), false);
Owen Andersonade90fd2009-07-29 18:54:39 +00002848 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002849}
2850
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002851void CGObjCCommonMac::
2852PushProtocolProperties(llvm::SmallPtrSet<const IdentifierInfo*,16> &PropertySet,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002853 SmallVectorImpl<llvm::Constant *> &Properties,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002854 const Decl *Container,
Aaron Ballmandc4bea42014-03-13 18:47:37 +00002855 const ObjCProtocolDecl *Proto,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002856 const ObjCCommonTypesHelper &ObjCTypes) {
Aaron Ballman0f6e64d2014-03-13 22:58:06 +00002857 for (const auto *P : Proto->protocols())
2858 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes);
Aaron Ballmand174edf2014-03-13 19:11:50 +00002859 for (const auto *PD : Proto->properties()) {
David Blaikie82e95a32014-11-19 07:49:47 +00002860 if (!PropertySet.insert(PD->getIdentifier()).second)
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002861 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002862 llvm::Constant *Prop[] = {
2863 GetPropertyName(PD->getIdentifier()),
2864 GetPropertyTypeString(PD, Container)
2865 };
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002866 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy, Prop));
2867 }
2868}
2869
Daniel Dunbarb036db82008-08-13 03:21:16 +00002870/*
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002871 struct _objc_property {
Bill Wendlinga515b582012-02-09 22:16:49 +00002872 const char * const name;
2873 const char * const attributes;
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002874 };
2875
2876 struct _objc_property_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00002877 uint32_t entsize; // sizeof (struct _objc_property)
2878 uint32_t prop_count;
2879 struct _objc_property[prop_count];
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002880 };
2881*/
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002882llvm::Constant *CGObjCCommonMac::EmitPropertyList(Twine Name,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002883 const Decl *Container,
2884 const ObjCContainerDecl *OCD,
2885 const ObjCCommonTypesHelper &ObjCTypes) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002886 SmallVector<llvm::Constant *, 16> Properties;
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002887 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Aaron Ballmand174edf2014-03-13 19:11:50 +00002888 for (const auto *PD : OCD->properties()) {
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002889 PropertySet.insert(PD->getIdentifier());
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002890 llvm::Constant *Prop[] = {
2891 GetPropertyName(PD->getIdentifier()),
2892 GetPropertyTypeString(PD, Container)
2893 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00002894 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy,
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002895 Prop));
2896 }
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002897 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD)) {
Aaron Ballmana9f49e32014-03-13 20:55:22 +00002898 for (const auto *P : OID->all_referenced_protocols())
2899 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002900 }
2901 else if (const ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(OCD)) {
Aaron Ballman19a41762014-03-14 12:55:57 +00002902 for (const auto *P : CD->protocols())
2903 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002904 }
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002905
2906 // Return null for empty list.
2907 if (Properties.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00002908 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002909
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002910 unsigned PropertySize =
Micah Villmowdd31ca12012-10-08 16:25:52 +00002911 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.PropertyTy);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002912 llvm::Constant *Values[3];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002913 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, PropertySize);
2914 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Properties.size());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002915 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.PropertyTy,
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002916 Properties.size());
Owen Anderson47034e12009-07-28 18:33:04 +00002917 Values[2] = llvm::ConstantArray::get(AT, Properties);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002918 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002919
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002920 llvm::GlobalVariable *GV =
2921 CreateMetadataVar(Name, Init,
2922 (ObjCABI == 2) ? "__DATA, __objc_const" :
Daniel Dunbarb25452a2009-04-15 02:56:18 +00002923 "__OBJC,__property,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00002924 CGM.getPointerAlign(),
Daniel Dunbarb25452a2009-04-15 02:56:18 +00002925 true);
Owen Andersonade90fd2009-07-29 18:54:39 +00002926 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002927}
2928
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002929llvm::Constant *
2930CGObjCCommonMac::EmitProtocolMethodTypes(Twine Name,
2931 ArrayRef<llvm::Constant*> MethodTypes,
2932 const ObjCCommonTypesHelper &ObjCTypes) {
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002933 // Return null for empty list.
2934 if (MethodTypes.empty())
2935 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrPtrTy);
2936
2937 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
2938 MethodTypes.size());
2939 llvm::Constant *Init = llvm::ConstantArray::get(AT, MethodTypes);
2940
Alp Toker541d5072014-06-07 23:30:53 +00002941 llvm::GlobalVariable *GV = CreateMetadataVar(
2942 Name, Init, (ObjCABI == 2) ? "__DATA, __objc_const" : StringRef(),
John McCall7f416cc2015-09-08 08:05:57 +00002943 CGM.getPointerAlign(), true);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002944 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.Int8PtrPtrTy);
2945}
2946
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002947/*
Daniel Dunbarb036db82008-08-13 03:21:16 +00002948 struct objc_method_description_list {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002949 int count;
2950 struct objc_method_description list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00002951 };
2952*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002953llvm::Constant *
2954CGObjCMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002955 llvm::Constant *Desc[] = {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002956 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002957 ObjCTypes.SelectorPtrTy),
2958 GetMethodVarType(MD)
2959 };
Douglas Gregora9d84932011-05-27 01:19:52 +00002960 if (!Desc[1])
Craig Topper8a13c412014-05-21 05:09:00 +00002961 return nullptr;
2962
Owen Anderson0e0189d2009-07-27 22:29:56 +00002963 return llvm::ConstantStruct::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002964 Desc);
2965}
Daniel Dunbarb036db82008-08-13 03:21:16 +00002966
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002967llvm::Constant *
2968CGObjCMac::EmitMethodDescList(Twine Name, const char *Section,
2969 ArrayRef<llvm::Constant*> Methods) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00002970 // Return null for empty list.
2971 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00002972 return llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002973
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002974 llvm::Constant *Values[2];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002975 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002976 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbarb036db82008-08-13 03:21:16 +00002977 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00002978 Values[1] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002979 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002980
John McCall7f416cc2015-09-08 08:05:57 +00002981 llvm::GlobalVariable *GV =
2982 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002983 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbarb036db82008-08-13 03:21:16 +00002984 ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002985}
2986
Daniel Dunbar938a77f2008-08-22 20:34:54 +00002987/*
2988 struct _objc_category {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002989 char *category_name;
2990 char *class_name;
2991 struct _objc_method_list *instance_methods;
2992 struct _objc_method_list *class_methods;
2993 struct _objc_protocol_list *protocols;
2994 uint32_t size; // <rdar://4585769>
2995 struct _objc_property_list *instance_properties;
Daniel Dunbar938a77f2008-08-22 20:34:54 +00002996 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002997*/
Daniel Dunbar92992502008-08-15 22:20:32 +00002998void CGObjCMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00002999 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategoryTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003000
Mike Stump18bb9282009-05-16 07:57:57 +00003001 // FIXME: This is poor design, the OCD should have a pointer to the category
3002 // decl. Additionally, note that Category can be null for the @implementation
3003 // w/o an @interface case. Sema should just create one for us as it does for
3004 // @implementation so everyone else can live life under a clear blue sky.
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003005 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003006 const ObjCCategoryDecl *Category =
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003007 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003008
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003009 SmallString<256> ExtName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003010 llvm::raw_svector_ostream(ExtName) << Interface->getName() << '_'
3011 << OCD->getName();
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003012
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003013 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003014 for (const auto *I : OCD->instance_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003015 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003016 InstanceMethods.push_back(GetMethodConstant(I));
3017
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003018 for (const auto *I : OCD->class_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003019 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003020 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003021
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003022 llvm::Constant *Values[7];
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003023 Values[0] = GetClassName(OCD->getName());
3024 Values[1] = GetClassName(Interface->getObjCRuntimeNameAsString());
Fariborz Jahaniane55f8662009-04-29 20:40:05 +00003025 LazySymbols.insert(Interface->getIdentifier());
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003026 Values[2] = EmitMethodList("OBJC_CATEGORY_INSTANCE_METHODS_" + ExtName.str(),
3027 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
3028 InstanceMethods);
3029 Values[3] = EmitMethodList("OBJC_CATEGORY_CLASS_METHODS_" + ExtName.str(),
3030 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
3031 ClassMethods);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003032 if (Category) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003033 Values[4] =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003034 EmitProtocolList("OBJC_CATEGORY_PROTOCOLS_" + ExtName.str(),
3035 Category->protocol_begin(), Category->protocol_end());
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003036 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003037 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003038 }
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003039 Values[5] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003040
3041 // If there is no category @interface then there can be no properties.
3042 if (Category) {
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003043 Values[6] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
Fariborz Jahanian066347e2009-01-28 22:18:42 +00003044 OCD, Category, ObjCTypes);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003045 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003046 Values[6] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003047 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003048
Owen Anderson0e0189d2009-07-27 22:29:56 +00003049 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.CategoryTy,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003050 Values);
3051
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003052 llvm::GlobalVariable *GV =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003053 CreateMetadataVar("OBJC_CATEGORY_" + ExtName.str(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003054 "__OBJC,__category,regular,no_dead_strip",
3055 CGM.getPointerAlign(), true);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003056 DefinedCategories.push_back(GV);
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00003057 DefinedCategoryNames.insert(ExtName.str());
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003058 // method definition entries must be clear for next implementation.
3059 MethodDefinitions.clear();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003060}
3061
John McCallef19dbb2012-10-17 04:53:23 +00003062enum FragileClassFlags {
3063 FragileABI_Class_Factory = 0x00001,
3064 FragileABI_Class_Meta = 0x00002,
3065 FragileABI_Class_HasCXXStructors = 0x02000,
3066 FragileABI_Class_Hidden = 0x20000
3067};
3068
3069enum NonFragileClassFlags {
3070 /// Is a meta-class.
3071 NonFragileABI_Class_Meta = 0x00001,
3072
3073 /// Is a root class.
3074 NonFragileABI_Class_Root = 0x00002,
3075
3076 /// Has a C++ constructor and destructor.
3077 NonFragileABI_Class_HasCXXStructors = 0x00004,
3078
3079 /// Has hidden visibility.
3080 NonFragileABI_Class_Hidden = 0x00010,
3081
3082 /// Has the exception attribute.
3083 NonFragileABI_Class_Exception = 0x00020,
3084
3085 /// (Obsolete) ARC-specific: this class has a .release_ivars method
3086 NonFragileABI_Class_HasIvarReleaser = 0x00040,
3087
3088 /// Class implementation was compiled under ARC.
John McCall0d54a172012-10-17 04:53:31 +00003089 NonFragileABI_Class_CompiledByARC = 0x00080,
3090
3091 /// Class has non-trivial destructors, but zero-initialization is okay.
3092 NonFragileABI_Class_HasCXXDestructorOnly = 0x00100
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003093};
3094
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003095/*
3096 struct _objc_class {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003097 Class isa;
3098 Class super_class;
3099 const char *name;
3100 long version;
3101 long info;
3102 long instance_size;
3103 struct _objc_ivar_list *ivars;
3104 struct _objc_method_list *methods;
3105 struct _objc_cache *cache;
3106 struct _objc_protocol_list *protocols;
3107 // Objective-C 1.0 extensions (<rdr://4585769>)
3108 const char *ivar_layout;
3109 struct _objc_class_ext *ext;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003110 };
3111
3112 See EmitClassExtension();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003113*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003114void CGObjCMac::GenerateClass(const ObjCImplementationDecl *ID) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003115 DefinedSymbols.insert(ID->getIdentifier());
3116
Chris Lattner86d7d912008-11-24 03:54:41 +00003117 std::string ClassName = ID->getNameAsString();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003118 // FIXME: Gross
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003119 ObjCInterfaceDecl *Interface =
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003120 const_cast<ObjCInterfaceDecl*>(ID->getClassInterface());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003121 llvm::Constant *Protocols =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003122 EmitProtocolList("OBJC_CLASS_PROTOCOLS_" + ID->getName(),
3123 Interface->all_referenced_protocol_begin(),
3124 Interface->all_referenced_protocol_end());
John McCallef19dbb2012-10-17 04:53:23 +00003125 unsigned Flags = FragileABI_Class_Factory;
John McCall0d54a172012-10-17 04:53:31 +00003126 if (ID->hasNonZeroConstructors() || ID->hasDestructors())
John McCallef19dbb2012-10-17 04:53:23 +00003127 Flags |= FragileABI_Class_HasCXXStructors;
John McCall3fd13f062015-10-21 18:06:47 +00003128 CharUnits Size =
3129 CGM.getContext().getASTObjCImplementationLayout(ID).getSize();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003130
3131 // FIXME: Set CXX-structors flag.
John McCall457a04e2010-10-22 21:05:15 +00003132 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003133 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003134
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003135 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003136 for (const auto *I : ID->instance_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003137 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003138 InstanceMethods.push_back(GetMethodConstant(I));
3139
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003140 for (const auto *I : ID->class_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003141 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003142 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003143
Aaron Ballmand85eff42014-03-14 15:02:45 +00003144 for (const auto *PID : ID->property_impls()) {
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003145 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
3146 ObjCPropertyDecl *PD = PID->getPropertyDecl();
3147
3148 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
3149 if (llvm::Constant *C = GetMethodConstant(MD))
3150 InstanceMethods.push_back(C);
3151 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
3152 if (llvm::Constant *C = GetMethodConstant(MD))
3153 InstanceMethods.push_back(C);
3154 }
3155 }
3156
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003157 llvm::Constant *Values[12];
Daniel Dunbarccf61832009-05-03 08:56:52 +00003158 Values[ 0] = EmitMetaClass(ID, Protocols, ClassMethods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003159 if (ObjCInterfaceDecl *Super = Interface->getSuperClass()) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003160 // Record a reference to the super class.
3161 LazySymbols.insert(Super->getIdentifier());
3162
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003163 Values[ 1] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003164 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003165 ObjCTypes.ClassPtrTy);
3166 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003167 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003168 }
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003169 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003170 // Version is always 0.
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003171 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3172 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
John McCall3fd13f062015-10-21 18:06:47 +00003173 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size.getQuantity());
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003174 Values[ 6] = EmitIvarList(ID, false);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003175 Values[7] = EmitMethodList("OBJC_INSTANCE_METHODS_" + ID->getName(),
3176 "__OBJC,__inst_meth,regular,no_dead_strip",
3177 InstanceMethods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003178 // cache is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003179 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003180 Values[ 9] = Protocols;
John McCall3fd13f062015-10-21 18:06:47 +00003181 Values[10] = BuildIvarLayout(ID, CharUnits::Zero(), Size, true);
3182 Values[11] = EmitClassExtension(ID, Size);
Owen Anderson0e0189d2009-07-27 22:29:56 +00003183 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003184 Values);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003185 std::string Name("OBJC_CLASS_");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003186 Name += ClassName;
3187 const char *Section = "__OBJC,__class,regular,no_dead_strip";
3188 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003189 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003190 if (GV) {
3191 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3192 "Forward metaclass reference has incorrect type.");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003193 GV->setInitializer(Init);
3194 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003195 GV->setAlignment(CGM.getPointerAlign().getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00003196 CGM.addCompilerUsedGlobal(GV);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003197 } else
John McCall7f416cc2015-09-08 08:05:57 +00003198 GV = CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003199 DefinedClasses.push_back(GV);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00003200 ImplementedClasses.push_back(Interface);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003201 // method definition entries must be clear for next implementation.
3202 MethodDefinitions.clear();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003203}
3204
3205llvm::Constant *CGObjCMac::EmitMetaClass(const ObjCImplementationDecl *ID,
3206 llvm::Constant *Protocols,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003207 ArrayRef<llvm::Constant*> Methods) {
John McCallef19dbb2012-10-17 04:53:23 +00003208 unsigned Flags = FragileABI_Class_Meta;
Micah Villmowdd31ca12012-10-08 16:25:52 +00003209 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003210
John McCall457a04e2010-10-22 21:05:15 +00003211 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003212 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003213
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003214 llvm::Constant *Values[12];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003215 // The isa for the metaclass is the root of the hierarchy.
3216 const ObjCInterfaceDecl *Root = ID->getClassInterface();
3217 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
3218 Root = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003219 Values[ 0] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003220 llvm::ConstantExpr::getBitCast(GetClassName(Root->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003221 ObjCTypes.ClassPtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003222 // The super class for the metaclass is emitted as the name of the
3223 // super class. The runtime fixes this up to point to the
3224 // *metaclass* for the super class.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003225 if (ObjCInterfaceDecl *Super = ID->getClassInterface()->getSuperClass()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003226 Values[ 1] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003227 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003228 ObjCTypes.ClassPtrTy);
3229 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003230 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003231 }
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003232 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003233 // Version is always 0.
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003234 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3235 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
3236 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size);
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003237 Values[ 6] = EmitIvarList(ID, true);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003238 Values[7] =
3239 EmitMethodList("OBJC_CLASS_METHODS_" + ID->getNameAsString(),
3240 "__OBJC,__cls_meth,regular,no_dead_strip", Methods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003241 // cache is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003242 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003243 Values[ 9] = Protocols;
3244 // ivar_layout for metaclass is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003245 Values[10] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003246 // The class extension is always unused for metaclasses.
Owen Anderson0b75f232009-07-31 20:28:54 +00003247 Values[11] = llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00003248 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003249 Values);
3250
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003251 std::string Name("OBJC_METACLASS_");
Benjamin Kramer1bbcbd02012-07-31 11:45:39 +00003252 Name += ID->getName();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003253
3254 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003255 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003256 if (GV) {
3257 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3258 "Forward metaclass reference has incorrect type.");
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003259 GV->setInitializer(Init);
3260 } else {
Owen Andersonc10c8d32009-07-08 19:05:04 +00003261 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003262 llvm::GlobalValue::PrivateLinkage,
Owen Andersonc10c8d32009-07-08 19:05:04 +00003263 Init, Name);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003264 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003265 GV->setSection("__OBJC,__meta_class,regular,no_dead_strip");
Daniel Dunbarae333842009-03-09 22:18:41 +00003266 GV->setAlignment(4);
Rafael Espindola060062a2014-03-06 22:15:10 +00003267 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003268
3269 return GV;
3270}
3271
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003272llvm::Constant *CGObjCMac::EmitMetaClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003273 std::string Name = "OBJC_METACLASS_" + ID->getNameAsString();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003274
Mike Stump18bb9282009-05-16 07:57:57 +00003275 // FIXME: Should we look these up somewhere other than the module. Its a bit
3276 // silly since we only generate these while processing an implementation, so
3277 // exactly one pointer would work if know when we entered/exitted an
3278 // implementation block.
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003279
3280 // Check for an existing forward reference.
Fariborz Jahanian475831b2009-01-07 20:11:22 +00003281 // Previously, metaclass with internal linkage may have been defined.
3282 // pass 'true' as 2nd argument so it is returned.
Rafael Espindola21039aa2014-02-27 16:26:32 +00003283 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3284 if (!GV)
3285 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003286 llvm::GlobalValue::PrivateLinkage, nullptr,
3287 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003288
3289 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3290 "Forward metaclass reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003291 return GV;
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003292}
3293
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003294llvm::Value *CGObjCMac::EmitSuperClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003295 std::string Name = "OBJC_CLASS_" + ID->getNameAsString();
Rafael Espindola21039aa2014-02-27 16:26:32 +00003296 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3297
3298 if (!GV)
3299 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003300 llvm::GlobalValue::PrivateLinkage, nullptr,
3301 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003302
3303 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3304 "Forward class metadata reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003305 return GV;
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003306}
3307
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003308/*
John McCall3fd13f062015-10-21 18:06:47 +00003309 Emit a "class extension", which in this specific context means extra
3310 data that doesn't fit in the normal fragile-ABI class structure, and
3311 has nothing to do with the language concept of a class extension.
3312
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003313 struct objc_class_ext {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003314 uint32_t size;
3315 const char *weak_ivar_layout;
3316 struct _objc_property_list *properties;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003317 };
3318*/
3319llvm::Constant *
John McCall3fd13f062015-10-21 18:06:47 +00003320CGObjCMac::EmitClassExtension(const ObjCImplementationDecl *ID,
3321 CharUnits InstanceSize) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003322 uint64_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00003323 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003324
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003325 llvm::Constant *Values[3];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003326 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
John McCall3fd13f062015-10-21 18:06:47 +00003327 Values[1] = BuildIvarLayout(ID, CharUnits::Zero(), InstanceSize, false);
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003328 Values[2] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ID->getName(),
Fariborz Jahanian066347e2009-01-28 22:18:42 +00003329 ID, ID->getClassInterface(), ObjCTypes);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003330
3331 // Return null if no extension bits are used.
3332 if (Values[1]->isNullValue() && Values[2]->isNullValue())
Owen Anderson0b75f232009-07-31 20:28:54 +00003333 return llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003334
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003335 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00003336 llvm::ConstantStruct::get(ObjCTypes.ClassExtensionTy, Values);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003337 return CreateMetadataVar("OBJC_CLASSEXT_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003338 "__OBJC,__class_ext,regular,no_dead_strip",
3339 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003340}
3341
3342/*
3343 struct objc_ivar {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003344 char *ivar_name;
3345 char *ivar_type;
3346 int ivar_offset;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003347 };
3348
3349 struct objc_ivar_list {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003350 int ivar_count;
3351 struct objc_ivar list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003352 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003353*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003354llvm::Constant *CGObjCMac::EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003355 bool ForClass) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003356 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003357
3358 // When emitting the root class GCC emits ivar entries for the
3359 // actual class structure. It is not clear if we need to follow this
3360 // behavior; for now lets try and get away with not doing it. If so,
3361 // the cleanest solution would be to make up an ObjCInterfaceDecl
3362 // for the class.
3363 if (ForClass)
Owen Anderson0b75f232009-07-31 20:28:54 +00003364 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003365
Jordy Rosea91768e2011-07-22 02:08:32 +00003366 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003367
Jordy Rosea91768e2011-07-22 02:08:32 +00003368 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00003369 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00003370 // Ignore unnamed bit-fields.
3371 if (!IVD->getDeclName())
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003372 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003373 llvm::Constant *Ivar[] = {
3374 GetMethodVarName(IVD->getIdentifier()),
3375 GetMethodVarType(IVD),
3376 llvm::ConstantInt::get(ObjCTypes.IntTy,
Eli Friedman8cbca202012-11-06 22:15:52 +00003377 ComputeIvarBaseOffset(CGM, OID, IVD))
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003378 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00003379 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarTy, Ivar));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003380 }
3381
3382 // Return null for empty list.
3383 if (Ivars.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003384 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003385
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003386 llvm::Constant *Values[2];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003387 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00003388 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003389 Ivars.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003390 Values[1] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003391 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003392
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003393 llvm::GlobalVariable *GV;
3394 if (ForClass)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003395 GV =
3396 CreateMetadataVar("OBJC_CLASS_VARIABLES_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003397 "__OBJC,__class_vars,regular,no_dead_strip",
3398 CGM.getPointerAlign(), true);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003399 else
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003400 GV = CreateMetadataVar("OBJC_INSTANCE_VARIABLES_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003401 "__OBJC,__instance_vars,regular,no_dead_strip",
3402 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003403 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003404}
3405
3406/*
3407 struct objc_method {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003408 SEL method_name;
3409 char *method_types;
3410 void *method;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003411 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003412
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003413 struct objc_method_list {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003414 struct objc_method_list *obsolete;
3415 int count;
3416 struct objc_method methods_list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003417 };
3418*/
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003419
3420/// GetMethodConstant - Return a struct objc_method constant for the
3421/// given method if it has been defined. The result is null if the
3422/// method has not been defined. The return value has type MethodPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003423llvm::Constant *CGObjCMac::GetMethodConstant(const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00003424 llvm::Function *Fn = GetMethodDefinition(MD);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003425 if (!Fn)
Craig Topper8a13c412014-05-21 05:09:00 +00003426 return nullptr;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003427
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003428 llvm::Constant *Method[] = {
Owen Andersonade90fd2009-07-29 18:54:39 +00003429 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003430 ObjCTypes.SelectorPtrTy),
3431 GetMethodVarType(MD),
3432 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
3433 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00003434 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003435}
3436
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003437llvm::Constant *CGObjCMac::EmitMethodList(Twine Name,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003438 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003439 ArrayRef<llvm::Constant*> Methods) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003440 // Return null for empty list.
3441 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003442 return llvm::Constant::getNullValue(ObjCTypes.MethodListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003443
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003444 llvm::Constant *Values[3];
Owen Anderson0b75f232009-07-31 20:28:54 +00003445 Values[0] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003446 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00003447 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003448 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003449 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003450 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003451
John McCall7f416cc2015-09-08 08:05:57 +00003452 llvm::GlobalVariable *GV =
3453 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003454 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListPtrTy);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003455}
3456
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00003457llvm::Function *CGObjCCommonMac::GenerateMethod(const ObjCMethodDecl *OMD,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003458 const ObjCContainerDecl *CD) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003459 SmallString<256> Name;
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00003460 GetNameForMethod(OMD, CD, Name);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003461
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00003462 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00003463 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00003464 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003465 llvm::Function *Method =
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00003466 llvm::Function::Create(MethodTy,
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003467 llvm::GlobalValue::InternalLinkage,
Daniel Dunbard2386812009-10-19 01:21:19 +00003468 Name.str(),
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003469 &CGM.getModule());
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003470 MethodDefinitions.insert(std::make_pair(OMD, Method));
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003471
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003472 return Method;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003473}
3474
Alp Toker541d5072014-06-07 23:30:53 +00003475llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
3476 llvm::Constant *Init,
3477 StringRef Section,
John McCall7f416cc2015-09-08 08:05:57 +00003478 CharUnits Align,
Alp Toker541d5072014-06-07 23:30:53 +00003479 bool AddToUsed) {
Chris Lattner2192fe52011-07-18 04:24:23 +00003480 llvm::Type *Ty = Init->getType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003481 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00003482 new llvm::GlobalVariable(CGM.getModule(), Ty, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003483 llvm::GlobalValue::PrivateLinkage, Init, Name);
Alp Toker541d5072014-06-07 23:30:53 +00003484 if (!Section.empty())
Daniel Dunbar30c65362009-03-09 20:09:19 +00003485 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003486 GV->setAlignment(Align.getQuantity());
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00003487 if (AddToUsed)
Rafael Espindola060062a2014-03-06 22:15:10 +00003488 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar30c65362009-03-09 20:09:19 +00003489 return GV;
3490}
3491
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003492llvm::Function *CGObjCMac::ModuleInitFunction() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00003493 // Abuse this interface function as a place to finalize.
3494 FinishModule();
Craig Topper8a13c412014-05-21 05:09:00 +00003495 return nullptr;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003496}
3497
Chris Lattnerd4808922009-03-22 21:03:39 +00003498llvm::Constant *CGObjCMac::GetPropertyGetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003499 return ObjCTypes.getGetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003500}
3501
Chris Lattnerd4808922009-03-22 21:03:39 +00003502llvm::Constant *CGObjCMac::GetPropertySetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003503 return ObjCTypes.getSetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003504}
3505
Ted Kremeneke65b0862012-03-06 20:05:56 +00003506llvm::Constant *CGObjCMac::GetOptimizedPropertySetFunction(bool atomic,
3507 bool copy) {
3508 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
3509}
3510
David Chisnall168b80f2010-12-26 22:13:16 +00003511llvm::Constant *CGObjCMac::GetGetStructFunction() {
3512 return ObjCTypes.getCopyStructFn();
3513}
3514llvm::Constant *CGObjCMac::GetSetStructFunction() {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00003515 return ObjCTypes.getCopyStructFn();
3516}
3517
David Chisnall0d75e062012-12-17 18:54:24 +00003518llvm::Constant *CGObjCMac::GetCppAtomicObjectGetFunction() {
3519 return ObjCTypes.getCppAtomicObjectFunction();
3520}
3521llvm::Constant *CGObjCMac::GetCppAtomicObjectSetFunction() {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00003522 return ObjCTypes.getCppAtomicObjectFunction();
3523}
3524
Chris Lattnerd4808922009-03-22 21:03:39 +00003525llvm::Constant *CGObjCMac::EnumerationMutationFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003526 return ObjCTypes.getEnumerationMutationFn();
Anders Carlsson3f35a262008-08-31 04:05:03 +00003527}
3528
John McCallbd309292010-07-06 01:34:17 +00003529void CGObjCMac::EmitTryStmt(CodeGenFunction &CGF, const ObjCAtTryStmt &S) {
3530 return EmitTryOrSynchronizedStmt(CGF, S);
3531}
3532
3533void CGObjCMac::EmitSynchronizedStmt(CodeGenFunction &CGF,
3534 const ObjCAtSynchronizedStmt &S) {
3535 return EmitTryOrSynchronizedStmt(CGF, S);
3536}
3537
John McCall65bea082010-07-21 06:59:36 +00003538namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00003539 struct PerformFragileFinally final : EHScopeStack::Cleanup {
John McCall65bea082010-07-21 06:59:36 +00003540 const Stmt &S;
John McCall7f416cc2015-09-08 08:05:57 +00003541 Address SyncArgSlot;
3542 Address CallTryExitVar;
3543 Address ExceptionData;
John McCall65bea082010-07-21 06:59:36 +00003544 ObjCTypesHelper &ObjCTypes;
3545 PerformFragileFinally(const Stmt *S,
John McCall7f416cc2015-09-08 08:05:57 +00003546 Address SyncArgSlot,
3547 Address CallTryExitVar,
3548 Address ExceptionData,
John McCall65bea082010-07-21 06:59:36 +00003549 ObjCTypesHelper *ObjCTypes)
John McCall2dd7d442010-08-04 05:59:32 +00003550 : S(*S), SyncArgSlot(SyncArgSlot), CallTryExitVar(CallTryExitVar),
John McCall65bea082010-07-21 06:59:36 +00003551 ExceptionData(ExceptionData), ObjCTypes(*ObjCTypes) {}
3552
Craig Topper4f12f102014-03-12 06:41:41 +00003553 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall65bea082010-07-21 06:59:36 +00003554 // Check whether we need to call objc_exception_try_exit.
3555 // In optimized code, this branch will always be folded.
3556 llvm::BasicBlock *FinallyCallExit =
3557 CGF.createBasicBlock("finally.call_exit");
3558 llvm::BasicBlock *FinallyNoCallExit =
3559 CGF.createBasicBlock("finally.no_call_exit");
3560 CGF.Builder.CreateCondBr(CGF.Builder.CreateLoad(CallTryExitVar),
3561 FinallyCallExit, FinallyNoCallExit);
3562
3563 CGF.EmitBlock(FinallyCallExit);
John McCall882987f2013-02-28 19:01:20 +00003564 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryExitFn(),
John McCall7f416cc2015-09-08 08:05:57 +00003565 ExceptionData.getPointer());
John McCall65bea082010-07-21 06:59:36 +00003566
3567 CGF.EmitBlock(FinallyNoCallExit);
3568
3569 if (isa<ObjCAtTryStmt>(S)) {
3570 if (const ObjCAtFinallyStmt* FinallyStmt =
John McCallcebe0ca2010-08-11 00:16:14 +00003571 cast<ObjCAtTryStmt>(S).getFinallyStmt()) {
John McCall638d4f52013-04-03 00:56:07 +00003572 // Don't try to do the @finally if this is an EH cleanup.
3573 if (flags.isForEHCleanup()) return;
3574
John McCallcebe0ca2010-08-11 00:16:14 +00003575 // Save the current cleanup destination in case there's
3576 // control flow inside the finally statement.
3577 llvm::Value *CurCleanupDest =
3578 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot());
3579
John McCall65bea082010-07-21 06:59:36 +00003580 CGF.EmitStmt(FinallyStmt->getFinallyBody());
3581
John McCallcebe0ca2010-08-11 00:16:14 +00003582 if (CGF.HaveInsertPoint()) {
3583 CGF.Builder.CreateStore(CurCleanupDest,
3584 CGF.getNormalCleanupDestSlot());
3585 } else {
3586 // Currently, the end of the cleanup must always exist.
3587 CGF.EnsureInsertPoint();
3588 }
3589 }
John McCall65bea082010-07-21 06:59:36 +00003590 } else {
3591 // Emit objc_sync_exit(expr); as finally's sole statement for
3592 // @synchronized.
John McCall2dd7d442010-08-04 05:59:32 +00003593 llvm::Value *SyncArg = CGF.Builder.CreateLoad(SyncArgSlot);
John McCall882987f2013-02-28 19:01:20 +00003594 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncExitFn(), SyncArg);
John McCall65bea082010-07-21 06:59:36 +00003595 }
3596 }
3597 };
John McCall42227ed2010-07-31 23:20:56 +00003598
3599 class FragileHazards {
3600 CodeGenFunction &CGF;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003601 SmallVector<llvm::Value*, 20> Locals;
John McCall42227ed2010-07-31 23:20:56 +00003602 llvm::DenseSet<llvm::BasicBlock*> BlocksBeforeTry;
3603
3604 llvm::InlineAsm *ReadHazard;
3605 llvm::InlineAsm *WriteHazard;
3606
3607 llvm::FunctionType *GetAsmFnType();
3608
3609 void collectLocals();
3610 void emitReadHazard(CGBuilderTy &Builder);
3611
3612 public:
3613 FragileHazards(CodeGenFunction &CGF);
John McCall2dd7d442010-08-04 05:59:32 +00003614
John McCall42227ed2010-07-31 23:20:56 +00003615 void emitWriteHazard();
John McCall2dd7d442010-08-04 05:59:32 +00003616 void emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00003617 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00003618}
John McCall42227ed2010-07-31 23:20:56 +00003619
3620/// Create the fragile-ABI read and write hazards based on the current
3621/// state of the function, which is presumed to be immediately prior
3622/// to a @try block. These hazards are used to maintain correct
3623/// semantics in the face of optimization and the fragile ABI's
3624/// cavalier use of setjmp/longjmp.
3625FragileHazards::FragileHazards(CodeGenFunction &CGF) : CGF(CGF) {
3626 collectLocals();
3627
3628 if (Locals.empty()) return;
3629
3630 // Collect all the blocks in the function.
3631 for (llvm::Function::iterator
3632 I = CGF.CurFn->begin(), E = CGF.CurFn->end(); I != E; ++I)
3633 BlocksBeforeTry.insert(&*I);
3634
3635 llvm::FunctionType *AsmFnTy = GetAsmFnType();
3636
3637 // Create a read hazard for the allocas. This inhibits dead-store
3638 // optimizations and forces the values to memory. This hazard is
3639 // inserted before any 'throwing' calls in the protected scope to
3640 // reflect the possibility that the variables might be read from the
3641 // catch block if the call throws.
3642 {
3643 std::string Constraint;
3644 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3645 if (I) Constraint += ',';
3646 Constraint += "*m";
3647 }
3648
3649 ReadHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3650 }
3651
3652 // Create a write hazard for the allocas. This inhibits folding
3653 // loads across the hazard. This hazard is inserted at the
3654 // beginning of the catch path to reflect the possibility that the
3655 // variables might have been written within the protected scope.
3656 {
3657 std::string Constraint;
3658 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3659 if (I) Constraint += ',';
3660 Constraint += "=*m";
3661 }
3662
3663 WriteHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3664 }
3665}
3666
3667/// Emit a write hazard at the current location.
3668void FragileHazards::emitWriteHazard() {
3669 if (Locals.empty()) return;
3670
John McCall882987f2013-02-28 19:01:20 +00003671 CGF.EmitNounwindRuntimeCall(WriteHazard, Locals);
John McCall42227ed2010-07-31 23:20:56 +00003672}
3673
John McCall42227ed2010-07-31 23:20:56 +00003674void FragileHazards::emitReadHazard(CGBuilderTy &Builder) {
3675 assert(!Locals.empty());
John McCall882987f2013-02-28 19:01:20 +00003676 llvm::CallInst *call = Builder.CreateCall(ReadHazard, Locals);
3677 call->setDoesNotThrow();
3678 call->setCallingConv(CGF.getRuntimeCC());
John McCall42227ed2010-07-31 23:20:56 +00003679}
3680
3681/// Emit read hazards in all the protected blocks, i.e. all the blocks
3682/// which have been inserted since the beginning of the try.
John McCall2dd7d442010-08-04 05:59:32 +00003683void FragileHazards::emitHazardsInNewBlocks() {
John McCall42227ed2010-07-31 23:20:56 +00003684 if (Locals.empty()) return;
3685
John McCall7f416cc2015-09-08 08:05:57 +00003686 CGBuilderTy Builder(CGF, CGF.getLLVMContext());
John McCall42227ed2010-07-31 23:20:56 +00003687
3688 // Iterate through all blocks, skipping those prior to the try.
3689 for (llvm::Function::iterator
3690 FI = CGF.CurFn->begin(), FE = CGF.CurFn->end(); FI != FE; ++FI) {
3691 llvm::BasicBlock &BB = *FI;
3692 if (BlocksBeforeTry.count(&BB)) continue;
3693
3694 // Walk through all the calls in the block.
3695 for (llvm::BasicBlock::iterator
3696 BI = BB.begin(), BE = BB.end(); BI != BE; ++BI) {
3697 llvm::Instruction &I = *BI;
3698
3699 // Ignore instructions that aren't non-intrinsic calls.
3700 // These are the only calls that can possibly call longjmp.
3701 if (!isa<llvm::CallInst>(I) && !isa<llvm::InvokeInst>(I)) continue;
3702 if (isa<llvm::IntrinsicInst>(I))
3703 continue;
3704
3705 // Ignore call sites marked nounwind. This may be questionable,
3706 // since 'nounwind' doesn't necessarily mean 'does not call longjmp'.
3707 llvm::CallSite CS(&I);
3708 if (CS.doesNotThrow()) continue;
3709
John McCall2dd7d442010-08-04 05:59:32 +00003710 // Insert a read hazard before the call. This will ensure that
3711 // any writes to the locals are performed before making the
3712 // call. If the call throws, then this is sufficient to
3713 // guarantee correctness as long as it doesn't also write to any
3714 // locals.
John McCall42227ed2010-07-31 23:20:56 +00003715 Builder.SetInsertPoint(&BB, BI);
3716 emitReadHazard(Builder);
3717 }
3718 }
3719}
3720
3721static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, llvm::Value *V) {
3722 if (V) S.insert(V);
3723}
3724
John McCall7f416cc2015-09-08 08:05:57 +00003725static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, Address V) {
3726 if (V.isValid()) S.insert(V.getPointer());
3727}
3728
John McCall42227ed2010-07-31 23:20:56 +00003729void FragileHazards::collectLocals() {
3730 // Compute a set of allocas to ignore.
3731 llvm::DenseSet<llvm::Value*> AllocasToIgnore;
3732 addIfPresent(AllocasToIgnore, CGF.ReturnValue);
3733 addIfPresent(AllocasToIgnore, CGF.NormalCleanupDest);
John McCall42227ed2010-07-31 23:20:56 +00003734
3735 // Collect all the allocas currently in the function. This is
3736 // probably way too aggressive.
3737 llvm::BasicBlock &Entry = CGF.CurFn->getEntryBlock();
3738 for (llvm::BasicBlock::iterator
3739 I = Entry.begin(), E = Entry.end(); I != E; ++I)
3740 if (isa<llvm::AllocaInst>(*I) && !AllocasToIgnore.count(&*I))
3741 Locals.push_back(&*I);
3742}
3743
3744llvm::FunctionType *FragileHazards::GetAsmFnType() {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003745 SmallVector<llvm::Type *, 16> tys(Locals.size());
John McCall9dc0db22011-05-15 01:53:33 +00003746 for (unsigned i = 0, e = Locals.size(); i != e; ++i)
3747 tys[i] = Locals[i]->getType();
3748 return llvm::FunctionType::get(CGF.VoidTy, tys, false);
John McCall65bea082010-07-21 06:59:36 +00003749}
3750
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003751/*
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003752
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003753 Objective-C setjmp-longjmp (sjlj) Exception Handling
3754 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003755
John McCallbd309292010-07-06 01:34:17 +00003756 A catch buffer is a setjmp buffer plus:
3757 - a pointer to the exception that was caught
3758 - a pointer to the previous exception data buffer
3759 - two pointers of reserved storage
3760 Therefore catch buffers form a stack, with a pointer to the top
3761 of the stack kept in thread-local storage.
3762
3763 objc_exception_try_enter pushes a catch buffer onto the EH stack.
3764 objc_exception_try_exit pops the given catch buffer, which is
3765 required to be the top of the EH stack.
3766 objc_exception_throw pops the top of the EH stack, writes the
3767 thrown exception into the appropriate field, and longjmps
3768 to the setjmp buffer. It crashes the process (with a printf
3769 and an abort()) if there are no catch buffers on the stack.
3770 objc_exception_extract just reads the exception pointer out of the
3771 catch buffer.
3772
3773 There's no reason an implementation couldn't use a light-weight
3774 setjmp here --- something like __builtin_setjmp, but API-compatible
3775 with the heavyweight setjmp. This will be more important if we ever
3776 want to implement correct ObjC/C++ exception interactions for the
3777 fragile ABI.
3778
3779 Note that for this use of setjmp/longjmp to be correct, we may need
3780 to mark some local variables volatile: if a non-volatile local
3781 variable is modified between the setjmp and the longjmp, it has
3782 indeterminate value. For the purposes of LLVM IR, it may be
3783 sufficient to make loads and stores within the @try (to variables
3784 declared outside the @try) volatile. This is necessary for
3785 optimized correctness, but is not currently being done; this is
3786 being tracked as rdar://problem/8160285
3787
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003788 The basic framework for a @try-catch-finally is as follows:
3789 {
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003790 objc_exception_data d;
3791 id _rethrow = null;
Anders Carlssonda0e4562009-02-07 21:26:04 +00003792 bool _call_try_exit = true;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003793
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003794 objc_exception_try_enter(&d);
3795 if (!setjmp(d.jmp_buf)) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003796 ... try body ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003797 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003798 // exception path
3799 id _caught = objc_exception_extract(&d);
3800
3801 // enter new try scope for handlers
3802 if (!setjmp(d.jmp_buf)) {
3803 ... match exception and execute catch blocks ...
3804
3805 // fell off end, rethrow.
3806 _rethrow = _caught;
3807 ... jump-through-finally to finally_rethrow ...
3808 } else {
3809 // exception in catch block
3810 _rethrow = objc_exception_extract(&d);
3811 _call_try_exit = false;
3812 ... jump-through-finally to finally_rethrow ...
3813 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003814 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003815 ... jump-through-finally to finally_end ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003816
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003817 finally:
Anders Carlssonda0e4562009-02-07 21:26:04 +00003818 if (_call_try_exit)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003819 objc_exception_try_exit(&d);
Anders Carlssonda0e4562009-02-07 21:26:04 +00003820
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003821 ... finally block ....
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003822 ... dispatch to finally destination ...
3823
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003824 finally_rethrow:
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003825 objc_exception_throw(_rethrow);
3826
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003827 finally_end:
3828 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003829
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003830 This framework differs slightly from the one gcc uses, in that gcc
3831 uses _rethrow to determine if objc_exception_try_exit should be called
3832 and if the object should be rethrown. This breaks in the face of
3833 throwing nil and introduces unnecessary branches.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003834
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003835 We specialize this framework for a few particular circumstances:
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003836
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003837 - If there are no catch blocks, then we avoid emitting the second
3838 exception handling context.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003839
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003840 - If there is a catch-all catch block (i.e. @catch(...) or @catch(id
3841 e)) we avoid emitting the code to rethrow an uncaught exception.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003842
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003843 - FIXME: If there is no @finally block we can do a few more
3844 simplifications.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003845
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003846 Rethrows and Jumps-Through-Finally
3847 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003848
John McCallbd309292010-07-06 01:34:17 +00003849 '@throw;' is supported by pushing the currently-caught exception
3850 onto ObjCEHStack while the @catch blocks are emitted.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003851
John McCallbd309292010-07-06 01:34:17 +00003852 Branches through the @finally block are handled with an ordinary
3853 normal cleanup. We do not register an EH cleanup; fragile-ABI ObjC
3854 exceptions are not compatible with C++ exceptions, and this is
3855 hardly the only place where this will go wrong.
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003856
John McCallbd309292010-07-06 01:34:17 +00003857 @synchronized(expr) { stmt; } is emitted as if it were:
3858 id synch_value = expr;
3859 objc_sync_enter(synch_value);
3860 @try { stmt; } @finally { objc_sync_exit(synch_value); }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003861*/
3862
Fariborz Jahanianc2ad6dc2008-11-21 00:49:24 +00003863void CGObjCMac::EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
3864 const Stmt &S) {
3865 bool isTry = isa<ObjCAtTryStmt>(S);
John McCallbd309292010-07-06 01:34:17 +00003866
3867 // A destination for the fall-through edges of the catch handlers to
3868 // jump to.
3869 CodeGenFunction::JumpDest FinallyEnd =
3870 CGF.getJumpDestInCurrentScope("finally.end");
3871
3872 // A destination for the rethrow edge of the catch handlers to jump
3873 // to.
3874 CodeGenFunction::JumpDest FinallyRethrow =
3875 CGF.getJumpDestInCurrentScope("finally.rethrow");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003876
Daniel Dunbar94ceb612009-02-24 01:43:46 +00003877 // For @synchronized, call objc_sync_enter(sync.expr). The
3878 // evaluation of the expression must occur before we enter the
John McCall2dd7d442010-08-04 05:59:32 +00003879 // @synchronized. We can't avoid a temp here because we need the
3880 // value to be preserved. If the backend ever does liveness
3881 // correctly after setjmp, this will be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00003882 Address SyncArgSlot = Address::invalid();
Daniel Dunbar94ceb612009-02-24 01:43:46 +00003883 if (!isTry) {
John McCall2dd7d442010-08-04 05:59:32 +00003884 llvm::Value *SyncArg =
Daniel Dunbar94ceb612009-02-24 01:43:46 +00003885 CGF.EmitScalarExpr(cast<ObjCAtSynchronizedStmt>(S).getSynchExpr());
3886 SyncArg = CGF.Builder.CreateBitCast(SyncArg, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00003887 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncEnterFn(), SyncArg);
John McCall2dd7d442010-08-04 05:59:32 +00003888
John McCall7f416cc2015-09-08 08:05:57 +00003889 SyncArgSlot = CGF.CreateTempAlloca(SyncArg->getType(),
3890 CGF.getPointerAlign(), "sync.arg");
John McCall2dd7d442010-08-04 05:59:32 +00003891 CGF.Builder.CreateStore(SyncArg, SyncArgSlot);
Daniel Dunbar94ceb612009-02-24 01:43:46 +00003892 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003893
John McCall2dd7d442010-08-04 05:59:32 +00003894 // Allocate memory for the setjmp buffer. This needs to be kept
3895 // live throughout the try and catch blocks.
John McCall7f416cc2015-09-08 08:05:57 +00003896 Address ExceptionData = CGF.CreateTempAlloca(ObjCTypes.ExceptionDataTy,
3897 CGF.getPointerAlign(),
3898 "exceptiondata.ptr");
John McCall2dd7d442010-08-04 05:59:32 +00003899
John McCall42227ed2010-07-31 23:20:56 +00003900 // Create the fragile hazards. Note that this will not capture any
3901 // of the allocas required for exception processing, but will
3902 // capture the current basic block (which extends all the way to the
3903 // setjmp call) as "before the @try".
3904 FragileHazards Hazards(CGF);
3905
John McCallbd309292010-07-06 01:34:17 +00003906 // Create a flag indicating whether the cleanup needs to call
3907 // objc_exception_try_exit. This is true except when
3908 // - no catches match and we're branching through the cleanup
3909 // just to rethrow the exception, or
3910 // - a catch matched and we're falling out of the catch handler.
John McCall2dd7d442010-08-04 05:59:32 +00003911 // The setjmp-safety rule here is that we should always store to this
3912 // variable in a place that dominates the branch through the cleanup
3913 // without passing through any setjmps.
John McCall7f416cc2015-09-08 08:05:57 +00003914 Address CallTryExitVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(),
3915 CharUnits::One(),
3916 "_call_try_exit");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003917
John McCall9916e3f2010-10-04 23:42:51 +00003918 // A slot containing the exception to rethrow. Only needed when we
3919 // have both a @catch and a @finally.
John McCall7f416cc2015-09-08 08:05:57 +00003920 Address PropagatingExnVar = Address::invalid();
John McCall9916e3f2010-10-04 23:42:51 +00003921
John McCallbd309292010-07-06 01:34:17 +00003922 // Push a normal cleanup to leave the try scope.
John McCall638d4f52013-04-03 00:56:07 +00003923 CGF.EHStack.pushCleanup<PerformFragileFinally>(NormalAndEHCleanup, &S,
John McCall2dd7d442010-08-04 05:59:32 +00003924 SyncArgSlot,
John McCallcda666c2010-07-21 07:22:38 +00003925 CallTryExitVar,
3926 ExceptionData,
3927 &ObjCTypes);
John McCallbd309292010-07-06 01:34:17 +00003928
3929 // Enter a try block:
3930 // - Call objc_exception_try_enter to push ExceptionData on top of
3931 // the EH stack.
Nico Weber6307cf02015-02-26 20:43:00 +00003932 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00003933 ExceptionData.getPointer());
John McCallbd309292010-07-06 01:34:17 +00003934
3935 // - Call setjmp on the exception data buffer.
3936 llvm::Constant *Zero = llvm::ConstantInt::get(CGF.Builder.getInt32Ty(), 0);
3937 llvm::Value *GEPIndexes[] = { Zero, Zero, Zero };
David Blaikie6b2a8302015-04-03 17:47:16 +00003938 llvm::Value *SetJmpBuffer = CGF.Builder.CreateGEP(
John McCall7f416cc2015-09-08 08:05:57 +00003939 ObjCTypes.ExceptionDataTy, ExceptionData.getPointer(), GEPIndexes,
3940 "setjmp_buffer");
Nico Weber6307cf02015-02-26 20:43:00 +00003941 llvm::CallInst *SetJmpResult = CGF.EmitNounwindRuntimeCall(
3942 ObjCTypes.getSetJmpFn(), SetJmpBuffer, "setjmp_result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00003943 SetJmpResult->setCanReturnTwice();
John McCallbd309292010-07-06 01:34:17 +00003944
3945 // If setjmp returned 0, enter the protected block; otherwise,
3946 // branch to the handler.
Daniel Dunbar75283ff2008-11-11 02:29:29 +00003947 llvm::BasicBlock *TryBlock = CGF.createBasicBlock("try");
3948 llvm::BasicBlock *TryHandler = CGF.createBasicBlock("try.handler");
John McCallbd309292010-07-06 01:34:17 +00003949 llvm::Value *DidCatch =
John McCallcebe0ca2010-08-11 00:16:14 +00003950 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
3951 CGF.Builder.CreateCondBr(DidCatch, TryHandler, TryBlock);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00003952
John McCallbd309292010-07-06 01:34:17 +00003953 // Emit the protected block.
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00003954 CGF.EmitBlock(TryBlock);
John McCall2dd7d442010-08-04 05:59:32 +00003955 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003956 CGF.EmitStmt(isTry ? cast<ObjCAtTryStmt>(S).getTryBody()
John McCallbd309292010-07-06 01:34:17 +00003957 : cast<ObjCAtSynchronizedStmt>(S).getSynchBody());
John McCall2dd7d442010-08-04 05:59:32 +00003958
3959 CGBuilderTy::InsertPoint TryFallthroughIP = CGF.Builder.saveAndClearIP();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003960
John McCallbd309292010-07-06 01:34:17 +00003961 // Emit the exception handler block.
Daniel Dunbar7f086782008-09-27 23:30:04 +00003962 CGF.EmitBlock(TryHandler);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00003963
John McCall42227ed2010-07-31 23:20:56 +00003964 // Don't optimize loads of the in-scope locals across this point.
3965 Hazards.emitWriteHazard();
3966
John McCallbd309292010-07-06 01:34:17 +00003967 // For a @synchronized (or a @try with no catches), just branch
3968 // through the cleanup to the rethrow block.
3969 if (!isTry || !cast<ObjCAtTryStmt>(S).getNumCatchStmts()) {
3970 // Tell the cleanup not to re-pop the exit.
John McCall2dd7d442010-08-04 05:59:32 +00003971 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00003972 CGF.EmitBranchThroughCleanup(FinallyRethrow);
John McCallbd309292010-07-06 01:34:17 +00003973
3974 // Otherwise, we have to match against the caught exceptions.
3975 } else {
John McCall2dd7d442010-08-04 05:59:32 +00003976 // Retrieve the exception object. We may emit multiple blocks but
3977 // nothing can cross this so the value is already in SSA form.
3978 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00003979 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00003980 ExceptionData.getPointer(), "caught");
John McCall2dd7d442010-08-04 05:59:32 +00003981
John McCallbd309292010-07-06 01:34:17 +00003982 // Push the exception to rethrow onto the EH value stack for the
3983 // benefit of any @throws in the handlers.
3984 CGF.ObjCEHValueStack.push_back(Caught);
3985
Douglas Gregor96c79492010-04-23 22:50:49 +00003986 const ObjCAtTryStmt* AtTryStmt = cast<ObjCAtTryStmt>(&S);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003987
Craig Topper8a13c412014-05-21 05:09:00 +00003988 bool HasFinally = (AtTryStmt->getFinallyStmt() != nullptr);
John McCallbd309292010-07-06 01:34:17 +00003989
Craig Topper8a13c412014-05-21 05:09:00 +00003990 llvm::BasicBlock *CatchBlock = nullptr;
3991 llvm::BasicBlock *CatchHandler = nullptr;
John McCall2dd7d442010-08-04 05:59:32 +00003992 if (HasFinally) {
John McCall9916e3f2010-10-04 23:42:51 +00003993 // Save the currently-propagating exception before
3994 // objc_exception_try_enter clears the exception slot.
3995 PropagatingExnVar = CGF.CreateTempAlloca(Caught->getType(),
John McCall7f416cc2015-09-08 08:05:57 +00003996 CGF.getPointerAlign(),
John McCall9916e3f2010-10-04 23:42:51 +00003997 "propagating_exception");
3998 CGF.Builder.CreateStore(Caught, PropagatingExnVar);
3999
John McCall2dd7d442010-08-04 05:59:32 +00004000 // Enter a new exception try block (in case a @catch block
4001 // throws an exception).
John McCall882987f2013-02-28 19:01:20 +00004002 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004003 ExceptionData.getPointer());
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004004
John McCall2dd7d442010-08-04 05:59:32 +00004005 llvm::CallInst *SetJmpResult =
John McCall882987f2013-02-28 19:01:20 +00004006 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSetJmpFn(),
4007 SetJmpBuffer, "setjmp.result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004008 SetJmpResult->setCanReturnTwice();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004009
John McCall2dd7d442010-08-04 05:59:32 +00004010 llvm::Value *Threw =
4011 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4012
4013 CatchBlock = CGF.createBasicBlock("catch");
4014 CatchHandler = CGF.createBasicBlock("catch_for_catch");
4015 CGF.Builder.CreateCondBr(Threw, CatchHandler, CatchBlock);
4016
4017 CGF.EmitBlock(CatchBlock);
4018 }
4019
4020 CGF.Builder.CreateStore(CGF.Builder.getInt1(HasFinally), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004021
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004022 // Handle catch list. As a special case we check if everything is
4023 // matched and avoid generating code for falling off the end if
4024 // so.
4025 bool AllMatched = false;
Douglas Gregor96c79492010-04-23 22:50:49 +00004026 for (unsigned I = 0, N = AtTryStmt->getNumCatchStmts(); I != N; ++I) {
4027 const ObjCAtCatchStmt *CatchStmt = AtTryStmt->getCatchStmt(I);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004028
Douglas Gregor46a572b2010-04-26 16:46:50 +00004029 const VarDecl *CatchParam = CatchStmt->getCatchParamDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00004030 const ObjCObjectPointerType *OPT = nullptr;
Daniel Dunbar523208f2008-09-27 07:36:24 +00004031
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004032 // catch(...) always matches.
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004033 if (!CatchParam) {
4034 AllMatched = true;
4035 } else {
John McCall9dd450b2009-09-21 23:43:11 +00004036 OPT = CatchParam->getType()->getAs<ObjCObjectPointerType>();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004037
John McCallbd309292010-07-06 01:34:17 +00004038 // catch(id e) always matches under this ABI, since only
4039 // ObjC exceptions end up here in the first place.
Daniel Dunbar86919f42008-09-27 22:21:14 +00004040 // FIXME: For the time being we also match id<X>; this should
4041 // be rejected by Sema instead.
Eli Friedman55179ca2009-07-11 00:57:02 +00004042 if (OPT && (OPT->isObjCIdType() || OPT->isObjCQualifiedIdType()))
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004043 AllMatched = true;
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004044 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004045
John McCallbd309292010-07-06 01:34:17 +00004046 // If this is a catch-all, we don't need to test anything.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004047 if (AllMatched) {
John McCallbd309292010-07-06 01:34:17 +00004048 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
4049
Anders Carlsson9396a892008-09-11 09:15:33 +00004050 if (CatchParam) {
John McCall1c9c3fd2010-10-15 04:57:14 +00004051 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004052 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
John McCallbd309292010-07-06 01:34:17 +00004053
4054 // These types work out because ConvertType(id) == i8*.
Steve Naroff371b8fb2009-03-03 19:52:17 +00004055 CGF.Builder.CreateStore(Caught, CGF.GetAddrOfLocalVar(CatchParam));
Anders Carlsson9396a892008-09-11 09:15:33 +00004056 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004057
Anders Carlsson9396a892008-09-11 09:15:33 +00004058 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004059
4060 // The scope of the catch variable ends right here.
4061 CatchVarCleanups.ForceCleanup();
4062
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004063 CGF.EmitBranchThroughCleanup(FinallyEnd);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004064 break;
4065 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004066
Steve Naroff7cae42b2009-07-10 23:34:53 +00004067 assert(OPT && "Unexpected non-object pointer type in @catch");
John McCall96fa4842010-05-17 21:00:27 +00004068 const ObjCObjectType *ObjTy = OPT->getObjectType();
John McCallbd309292010-07-06 01:34:17 +00004069
4070 // FIXME: @catch (Class c) ?
John McCall96fa4842010-05-17 21:00:27 +00004071 ObjCInterfaceDecl *IDecl = ObjTy->getInterface();
4072 assert(IDecl && "Catch parameter must have Objective-C type!");
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004073
4074 // Check if the @catch block matches the exception object.
John McCall882987f2013-02-28 19:01:20 +00004075 llvm::Value *Class = EmitClassRef(CGF, IDecl);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004076
John McCall882987f2013-02-28 19:01:20 +00004077 llvm::Value *matchArgs[] = { Class, Caught };
John McCallbd309292010-07-06 01:34:17 +00004078 llvm::CallInst *Match =
John McCall882987f2013-02-28 19:01:20 +00004079 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionMatchFn(),
4080 matchArgs, "match");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004081
John McCallbd309292010-07-06 01:34:17 +00004082 llvm::BasicBlock *MatchedBlock = CGF.createBasicBlock("match");
4083 llvm::BasicBlock *NextCatchBlock = CGF.createBasicBlock("catch.next");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004084
4085 CGF.Builder.CreateCondBr(CGF.Builder.CreateIsNotNull(Match, "matched"),
Daniel Dunbar7f086782008-09-27 23:30:04 +00004086 MatchedBlock, NextCatchBlock);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004087
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004088 // Emit the @catch block.
4089 CGF.EmitBlock(MatchedBlock);
John McCallbd309292010-07-06 01:34:17 +00004090
4091 // Collect any cleanups for the catch variable. The scope lasts until
4092 // the end of the catch body.
John McCall2dd7d442010-08-04 05:59:32 +00004093 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
John McCallbd309292010-07-06 01:34:17 +00004094
John McCall1c9c3fd2010-10-15 04:57:14 +00004095 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004096 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004097
John McCallbd309292010-07-06 01:34:17 +00004098 // Initialize the catch variable.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004099 llvm::Value *Tmp =
4100 CGF.Builder.CreateBitCast(Caught,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004101 CGF.ConvertType(CatchParam->getType()));
Steve Naroff371b8fb2009-03-03 19:52:17 +00004102 CGF.Builder.CreateStore(Tmp, CGF.GetAddrOfLocalVar(CatchParam));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004103
Anders Carlsson9396a892008-09-11 09:15:33 +00004104 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004105
4106 // We're done with the catch variable.
4107 CatchVarCleanups.ForceCleanup();
4108
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004109 CGF.EmitBranchThroughCleanup(FinallyEnd);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004110
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004111 CGF.EmitBlock(NextCatchBlock);
4112 }
4113
John McCallbd309292010-07-06 01:34:17 +00004114 CGF.ObjCEHValueStack.pop_back();
4115
John McCall2dd7d442010-08-04 05:59:32 +00004116 // If nothing wanted anything to do with the caught exception,
4117 // kill the extract call.
4118 if (Caught->use_empty())
4119 Caught->eraseFromParent();
4120
4121 if (!AllMatched)
4122 CGF.EmitBranchThroughCleanup(FinallyRethrow);
4123
4124 if (HasFinally) {
4125 // Emit the exception handler for the @catch blocks.
4126 CGF.EmitBlock(CatchHandler);
4127
4128 // In theory we might now need a write hazard, but actually it's
4129 // unnecessary because there's no local-accessing code between
4130 // the try's write hazard and here.
4131 //Hazards.emitWriteHazard();
4132
John McCall9916e3f2010-10-04 23:42:51 +00004133 // Extract the new exception and save it to the
4134 // propagating-exception slot.
John McCall7f416cc2015-09-08 08:05:57 +00004135 assert(PropagatingExnVar.isValid());
John McCall9916e3f2010-10-04 23:42:51 +00004136 llvm::CallInst *NewCaught =
John McCall882987f2013-02-28 19:01:20 +00004137 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004138 ExceptionData.getPointer(), "caught");
John McCall9916e3f2010-10-04 23:42:51 +00004139 CGF.Builder.CreateStore(NewCaught, PropagatingExnVar);
4140
John McCall2dd7d442010-08-04 05:59:32 +00004141 // Don't pop the catch handler; the throw already did.
4142 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004143 CGF.EmitBranchThroughCleanup(FinallyRethrow);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004144 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004145 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004146
John McCall42227ed2010-07-31 23:20:56 +00004147 // Insert read hazards as required in the new blocks.
John McCall2dd7d442010-08-04 05:59:32 +00004148 Hazards.emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00004149
John McCallbd309292010-07-06 01:34:17 +00004150 // Pop the cleanup.
John McCall2dd7d442010-08-04 05:59:32 +00004151 CGF.Builder.restoreIP(TryFallthroughIP);
4152 if (CGF.HaveInsertPoint())
4153 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
John McCallbd309292010-07-06 01:34:17 +00004154 CGF.PopCleanupBlock();
John McCall2dd7d442010-08-04 05:59:32 +00004155 CGF.EmitBlock(FinallyEnd.getBlock(), true);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004156
John McCallbd309292010-07-06 01:34:17 +00004157 // Emit the rethrow block.
John McCall42227ed2010-07-31 23:20:56 +00004158 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
John McCallad5d61e2010-07-23 21:56:41 +00004159 CGF.EmitBlock(FinallyRethrow.getBlock(), true);
John McCallbd309292010-07-06 01:34:17 +00004160 if (CGF.HaveInsertPoint()) {
John McCall9916e3f2010-10-04 23:42:51 +00004161 // If we have a propagating-exception variable, check it.
4162 llvm::Value *PropagatingExn;
John McCall7f416cc2015-09-08 08:05:57 +00004163 if (PropagatingExnVar.isValid()) {
John McCall9916e3f2010-10-04 23:42:51 +00004164 PropagatingExn = CGF.Builder.CreateLoad(PropagatingExnVar);
John McCall2dd7d442010-08-04 05:59:32 +00004165
John McCall9916e3f2010-10-04 23:42:51 +00004166 // Otherwise, just look in the buffer for the exception to throw.
4167 } else {
4168 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004169 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004170 ExceptionData.getPointer());
John McCall9916e3f2010-10-04 23:42:51 +00004171 PropagatingExn = Caught;
4172 }
4173
John McCall882987f2013-02-28 19:01:20 +00004174 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionThrowFn(),
4175 PropagatingExn);
John McCallbd309292010-07-06 01:34:17 +00004176 CGF.Builder.CreateUnreachable();
Fariborz Jahaniane2caaaa2008-11-21 19:21:53 +00004177 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004178
John McCall42227ed2010-07-31 23:20:56 +00004179 CGF.Builder.restoreIP(SavedIP);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004180}
4181
4182void CGObjCMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004183 const ObjCAtThrowStmt &S,
4184 bool ClearInsertionPoint) {
Anders Carlssone005aa12008-09-09 16:16:55 +00004185 llvm::Value *ExceptionAsObject;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004186
Anders Carlssone005aa12008-09-09 16:16:55 +00004187 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00004188 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004189 ExceptionAsObject =
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004190 CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
Anders Carlssone005aa12008-09-09 16:16:55 +00004191 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004192 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004193 "Unexpected rethrow outside @catch block.");
Anders Carlssonbf8a1be2009-02-07 21:37:21 +00004194 ExceptionAsObject = CGF.ObjCEHValueStack.back();
Anders Carlssone005aa12008-09-09 16:16:55 +00004195 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004196
John McCall882987f2013-02-28 19:01:20 +00004197 CGF.EmitRuntimeCall(ObjCTypes.getExceptionThrowFn(), ExceptionAsObject)
John McCallbd309292010-07-06 01:34:17 +00004198 ->setDoesNotReturn();
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004199 CGF.Builder.CreateUnreachable();
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004200
4201 // Clear the insertion point to indicate we are in unreachable code.
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004202 if (ClearInsertionPoint)
4203 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004204}
4205
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004206/// EmitObjCWeakRead - Code gen for loading value of a __weak
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004207/// object: objc_read_weak (id *src)
4208///
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004209llvm::Value * CGObjCMac::EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004210 Address AddrWeakObj) {
4211 llvm::Type* DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004212 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj,
4213 ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004214 llvm::Value *read_weak =
4215 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004216 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00004217 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004218 return read_weak;
4219}
4220
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004221/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
4222/// objc_assign_weak (id src, id *dst)
4223///
4224void CGObjCMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004225 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004226 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004227 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004228 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004229 assert(Size <= 8 && "does not support size > 8");
4230 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004231 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004232 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4233 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004234 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4235 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004236 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004237 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
4238 args, "weakassign");
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004239 return;
4240}
4241
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004242/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
4243/// objc_assign_global (id src, id *dst)
4244///
4245void CGObjCMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004246 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00004247 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004248 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004249 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004250 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004251 assert(Size <= 8 && "does not support size > 8");
4252 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004253 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004254 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4255 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004256 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4257 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004258 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00004259 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00004260 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
4261 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00004262 else
John McCall882987f2013-02-28 19:01:20 +00004263 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
4264 args, "threadlocalassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004265 return;
4266}
4267
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004268/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004269/// objc_assign_ivar (id src, id *dst, ptrdiff_t ivaroffset)
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004270///
4271void CGObjCMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004272 llvm::Value *src, Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004273 llvm::Value *ivarOffset) {
4274 assert(ivarOffset && "EmitObjCIvarAssign - ivarOffset is NULL");
Chris Lattner2192fe52011-07-18 04:24:23 +00004275 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004276 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004277 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004278 assert(Size <= 8 && "does not support size > 8");
4279 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004280 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004281 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4282 }
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004283 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4284 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004285 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00004286 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004287 return;
4288}
4289
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004290/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
4291/// objc_assign_strongCast (id src, id *dst)
4292///
4293void CGObjCMac::EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004294 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004295 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004296 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004297 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004298 assert(Size <= 8 && "does not support size > 8");
4299 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004300 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004301 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4302 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004303 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4304 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004305 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004306 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004307 args, "strongassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004308 return;
4309}
4310
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004311void CGObjCMac::EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004312 Address DestPtr,
4313 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00004314 llvm::Value *size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004315 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
4316 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004317 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), size };
John McCall882987f2013-02-28 19:01:20 +00004318 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004319}
4320
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004321/// EmitObjCValueForIvar - Code Gen for ivar reference.
4322///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004323LValue CGObjCMac::EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF,
4324 QualType ObjectTy,
4325 llvm::Value *BaseValue,
4326 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004327 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00004328 const ObjCInterfaceDecl *ID =
4329 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00004330 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
4331 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004332}
4333
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004334llvm::Value *CGObjCMac::EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00004335 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004336 const ObjCIvarDecl *Ivar) {
Eli Friedman8cbca202012-11-06 22:15:52 +00004337 uint64_t Offset = ComputeIvarBaseOffset(CGM, Interface, Ivar);
4338 return llvm::ConstantInt::get(
4339 CGM.getTypes().ConvertType(CGM.getContext().LongTy),
4340 Offset);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004341}
4342
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004343/* *** Private Interface *** */
4344
4345/// EmitImageInfo - Emit the image info marker used to encode some module
4346/// level information.
4347///
4348/// See: <rdr://4810609&4810587&4810587>
4349/// struct IMAGE_INFO {
4350/// unsigned version;
4351/// unsigned flags;
4352/// };
4353enum ImageInfoFlags {
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004354 eImageInfo_FixAndContinue = (1 << 0), // This flag is no longer set by clang.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004355 eImageInfo_GarbageCollected = (1 << 1),
4356 eImageInfo_GCOnly = (1 << 2),
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004357 eImageInfo_OptimizedByDyld = (1 << 3), // This flag is set by the dyld shared cache.
Daniel Dunbar75e909f2009-04-20 07:11:47 +00004358
Daniel Dunbar5e639272010-04-25 20:39:01 +00004359 // A flag indicating that the module has no instances of a @synthesize of a
4360 // superclass variable. <rdar://problem/6803242>
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004361 eImageInfo_CorrectedSynthesize = (1 << 4), // This flag is no longer set by clang.
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004362 eImageInfo_ImageIsSimulated = (1 << 5)
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004363};
4364
Daniel Dunbar5e639272010-04-25 20:39:01 +00004365void CGObjCCommonMac::EmitImageInfo() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004366 unsigned version = 0; // Version is unused?
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004367 const char *Section = (ObjCABI == 1) ?
4368 "__OBJC, __image_info,regular" :
4369 "__DATA, __objc_imageinfo, regular, no_dead_strip";
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004370
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004371 // Generate module-level named metadata to convey this information to the
4372 // linker and code-gen.
4373 llvm::Module &Mod = CGM.getModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004374
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004375 // Add the ObjC ABI version to the module flags.
4376 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Version", ObjCABI);
4377 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Version",
4378 version);
4379 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Section",
4380 llvm::MDString::get(VMContext,Section));
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004381
David Blaikiebbafb8a2012-03-11 07:00:24 +00004382 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004383 // Non-GC overrides those files which specify GC.
4384 Mod.addModuleFlag(llvm::Module::Override,
4385 "Objective-C Garbage Collection", (uint32_t)0);
4386 } else {
4387 // Add the ObjC garbage collection value.
4388 Mod.addModuleFlag(llvm::Module::Error,
4389 "Objective-C Garbage Collection",
4390 eImageInfo_GarbageCollected);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004391
David Blaikiebbafb8a2012-03-11 07:00:24 +00004392 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004393 // Add the ObjC GC Only value.
4394 Mod.addModuleFlag(llvm::Module::Error, "Objective-C GC Only",
4395 eImageInfo_GCOnly);
4396
4397 // Require that GC be specified and set to eImageInfo_GarbageCollected.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004398 llvm::Metadata *Ops[2] = {
4399 llvm::MDString::get(VMContext, "Objective-C Garbage Collection"),
4400 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
4401 llvm::Type::getInt32Ty(VMContext), eImageInfo_GarbageCollected))};
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004402 Mod.addModuleFlag(llvm::Module::Require, "Objective-C GC Only",
4403 llvm::MDNode::get(VMContext, Ops));
4404 }
4405 }
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004406
4407 // Indicate whether we're compiling this to run on a simulator.
4408 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Cameron Esfahani556d91e2013-09-14 01:09:11 +00004409 if (Triple.isiOS() &&
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004410 (Triple.getArch() == llvm::Triple::x86 ||
4411 Triple.getArch() == llvm::Triple::x86_64))
4412 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Is Simulated",
4413 eImageInfo_ImageIsSimulated);
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004414}
4415
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004416// struct objc_module {
4417// unsigned long version;
4418// unsigned long size;
4419// const char *name;
4420// Symtab symtab;
4421// };
4422
4423// FIXME: Get from somewhere
4424static const int ModuleVersion = 7;
4425
4426void CGObjCMac::EmitModuleInfo() {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004427 uint64_t Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ModuleTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004428
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004429 llvm::Constant *Values[] = {
4430 llvm::ConstantInt::get(ObjCTypes.LongTy, ModuleVersion),
4431 llvm::ConstantInt::get(ObjCTypes.LongTy, Size),
4432 // This used to be the filename, now it is unused. <rdr://4327263>
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004433 GetClassName(StringRef("")),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004434 EmitModuleSymbols()
4435 };
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004436 CreateMetadataVar("OBJC_MODULES",
Owen Anderson0e0189d2009-07-27 22:29:56 +00004437 llvm::ConstantStruct::get(ObjCTypes.ModuleTy, Values),
John McCall7f416cc2015-09-08 08:05:57 +00004438 "__OBJC,__module_info,regular,no_dead_strip",
4439 CGM.getPointerAlign(), true);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004440}
4441
4442llvm::Constant *CGObjCMac::EmitModuleSymbols() {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004443 unsigned NumClasses = DefinedClasses.size();
4444 unsigned NumCategories = DefinedCategories.size();
4445
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004446 // Return null if no symbols were defined.
4447 if (!NumClasses && !NumCategories)
Owen Anderson0b75f232009-07-31 20:28:54 +00004448 return llvm::Constant::getNullValue(ObjCTypes.SymtabPtrTy);
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004449
Chris Lattnere64d7ba2011-06-20 04:01:35 +00004450 llvm::Constant *Values[5];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00004451 Values[0] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
Owen Anderson0b75f232009-07-31 20:28:54 +00004452 Values[1] = llvm::Constant::getNullValue(ObjCTypes.SelectorPtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00004453 Values[2] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumClasses);
4454 Values[3] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumCategories);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004455
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004456 // The runtime expects exactly the list of defined classes followed
4457 // by the list of defined categories, in a single array.
Chris Lattner3def9ae2012-02-06 22:16:34 +00004458 SmallVector<llvm::Constant*, 8> Symbols(NumClasses + NumCategories);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004459 for (unsigned i=0; i<NumClasses; i++) {
4460 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
4461 assert(ID);
4462 if (ObjCImplementationDecl *IMP = ID->getImplementation())
4463 // We are implementing a weak imported interface. Give it external linkage
4464 if (ID->isWeakImported() && !IMP->isWeakImported())
4465 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
4466
Owen Andersonade90fd2009-07-29 18:54:39 +00004467 Symbols[i] = llvm::ConstantExpr::getBitCast(DefinedClasses[i],
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004468 ObjCTypes.Int8PtrTy);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004469 }
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004470 for (unsigned i=0; i<NumCategories; i++)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004471 Symbols[NumClasses + i] =
Owen Andersonade90fd2009-07-29 18:54:39 +00004472 llvm::ConstantExpr::getBitCast(DefinedCategories[i],
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004473 ObjCTypes.Int8PtrTy);
4474
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004475 Values[4] =
Owen Anderson9793f0e2009-07-29 22:16:19 +00004476 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00004477 Symbols.size()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004478 Symbols);
4479
Chris Lattnere64d7ba2011-06-20 04:01:35 +00004480 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004481
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004482 llvm::GlobalVariable *GV = CreateMetadataVar(
John McCall7f416cc2015-09-08 08:05:57 +00004483 "OBJC_SYMBOLS", Init, "__OBJC,__symbols,regular,no_dead_strip",
4484 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00004485 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.SymtabPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004486}
4487
John McCall882987f2013-02-28 19:01:20 +00004488llvm::Value *CGObjCMac::EmitClassRefFromId(CodeGenFunction &CGF,
4489 IdentifierInfo *II) {
John McCall31168b02011-06-15 23:02:42 +00004490 LazySymbols.insert(II);
4491
4492 llvm::GlobalVariable *&Entry = ClassReferences[II];
4493
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004494 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004495 llvm::Constant *Casted =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004496 llvm::ConstantExpr::getBitCast(GetClassName(II->getName()),
John McCall31168b02011-06-15 23:02:42 +00004497 ObjCTypes.ClassPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004498 Entry = CreateMetadataVar(
4499 "OBJC_CLASS_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004500 "__OBJC,__cls_refs,literal_pointers,no_dead_strip",
4501 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004502 }
John McCall31168b02011-06-15 23:02:42 +00004503
John McCall7f416cc2015-09-08 08:05:57 +00004504 return CGF.Builder.CreateAlignedLoad(Entry, CGF.getPointerAlign());
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004505}
4506
John McCall882987f2013-02-28 19:01:20 +00004507llvm::Value *CGObjCMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00004508 const ObjCInterfaceDecl *ID) {
John McCall882987f2013-02-28 19:01:20 +00004509 return EmitClassRefFromId(CGF, ID->getIdentifier());
John McCall31168b02011-06-15 23:02:42 +00004510}
4511
John McCall882987f2013-02-28 19:01:20 +00004512llvm::Value *CGObjCMac::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00004513 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCall882987f2013-02-28 19:01:20 +00004514 return EmitClassRefFromId(CGF, II);
John McCall31168b02011-06-15 23:02:42 +00004515}
4516
John McCall7f416cc2015-09-08 08:05:57 +00004517llvm::Value *CGObjCMac::EmitSelector(CodeGenFunction &CGF, Selector Sel) {
4518 return CGF.Builder.CreateLoad(EmitSelectorAddr(CGF, Sel));
4519}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004520
John McCall7f416cc2015-09-08 08:05:57 +00004521Address CGObjCMac::EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel) {
4522 CharUnits Align = CGF.getPointerAlign();
4523
4524 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004525 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004526 llvm::Constant *Casted =
Owen Andersonade90fd2009-07-29 18:54:39 +00004527 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004528 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004529 Entry = CreateMetadataVar(
4530 "OBJC_SELECTOR_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004531 "__OBJC,__message_refs,literal_pointers,no_dead_strip", Align, true);
Michael Gottesman5c205962013-02-05 23:08:45 +00004532 Entry->setExternallyInitialized(true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004533 }
4534
John McCall7f416cc2015-09-08 08:05:57 +00004535 return Address(Entry, Align);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004536}
4537
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004538llvm::Constant *CGObjCCommonMac::GetClassName(StringRef RuntimeName) {
4539 llvm::GlobalVariable *&Entry = ClassNames[RuntimeName];
4540 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004541 Entry = CreateMetadataVar(
4542 "OBJC_CLASS_NAME_",
4543 llvm::ConstantDataArray::getString(VMContext, RuntimeName),
4544 ((ObjCABI == 2) ? "__TEXT,__objc_classname,cstring_literals"
4545 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004546 CharUnits::One(), true);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004547 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004548}
4549
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004550llvm::Function *CGObjCCommonMac::GetMethodDefinition(const ObjCMethodDecl *MD) {
4551 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*>::iterator
4552 I = MethodDefinitions.find(MD);
4553 if (I != MethodDefinitions.end())
4554 return I->second;
4555
Craig Topper8a13c412014-05-21 05:09:00 +00004556 return nullptr;
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004557}
4558
Fariborz Jahanian01dff422009-03-05 19:17:31 +00004559/// GetIvarLayoutName - Returns a unique constant for the given
4560/// ivar layout bitmap.
4561llvm::Constant *CGObjCCommonMac::GetIvarLayoutName(IdentifierInfo *Ident,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004562 const ObjCCommonTypesHelper &ObjCTypes) {
Owen Anderson0b75f232009-07-31 20:28:54 +00004563 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Fariborz Jahanian01dff422009-03-05 19:17:31 +00004564}
4565
John McCall3fd13f062015-10-21 18:06:47 +00004566void IvarLayoutBuilder::visitRecord(const RecordType *RT,
4567 CharUnits offset) {
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004568 const RecordDecl *RD = RT->getDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004569
John McCall3fd13f062015-10-21 18:06:47 +00004570 // If this is a union, remember that we had one, because it might mess
4571 // up the ordering of layout entries.
4572 if (RD->isUnion())
4573 IsDisordered = true;
4574
4575 const ASTRecordLayout *recLayout = nullptr;
4576 visitAggregate(RD->field_begin(), RD->field_end(), offset,
4577 [&](const FieldDecl *field) -> CharUnits {
4578 if (!recLayout)
4579 recLayout = &CGM.getContext().getASTRecordLayout(RD);
4580 auto offsetInBits = recLayout->getFieldOffset(field->getFieldIndex());
4581 return CGM.getContext().toCharUnitsFromBits(offsetInBits);
4582 });
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004583}
4584
John McCall3fd13f062015-10-21 18:06:47 +00004585template <class Iterator, class GetOffsetFn>
4586void IvarLayoutBuilder::visitAggregate(Iterator begin, Iterator end,
4587 CharUnits aggregateOffset,
4588 const GetOffsetFn &getOffset) {
4589 for (; begin != end; ++begin) {
4590 auto field = *begin;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004591
John McCall3fd13f062015-10-21 18:06:47 +00004592 // Skip over bitfields.
4593 if (field->isBitField()) {
4594 continue;
4595 }
4596
4597 // Compute the offset of the field within the aggregate.
4598 CharUnits fieldOffset = aggregateOffset + getOffset(field);
4599
4600 visitField(field, fieldOffset);
4601 }
4602}
4603
4604/// Collect layout information for the given fields into IvarsInfo.
4605void IvarLayoutBuilder::visitField(const FieldDecl *field,
4606 CharUnits fieldOffset) {
4607 QualType fieldType = field->getType();
4608
4609 // Drill down into arrays.
4610 uint64_t numElts = 1;
4611 while (auto arrayType = CGM.getContext().getAsConstantArrayType(fieldType)) {
4612 numElts *= arrayType->getSize().getZExtValue();
4613 fieldType = arrayType->getElementType();
4614 }
4615
4616 assert(!fieldType->isArrayType() && "ivar of non-constant array type?");
4617
4618 // If we ended up with a zero-sized array, we've done what we can do within
4619 // the limits of this layout encoding.
4620 if (numElts == 0) return;
4621
4622 // Recurse if the base element type is a record type.
4623 if (auto recType = fieldType->getAs<RecordType>()) {
4624 size_t oldEnd = IvarsInfo.size();
4625
4626 visitRecord(recType, fieldOffset);
4627
4628 // If we have an array, replicate the first entry's layout information.
4629 auto numEltEntries = IvarsInfo.size() - oldEnd;
4630 if (numElts != 1 && numEltEntries != 0) {
4631 CharUnits eltSize = CGM.getContext().getTypeSizeInChars(recType);
4632 for (uint64_t eltIndex = 1; eltIndex != numElts; ++eltIndex) {
4633 // Copy the last numEltEntries onto the end of the array, adjusting
4634 // each for the element size.
4635 for (size_t i = 0; i != numEltEntries; ++i) {
4636 auto firstEntry = IvarsInfo[oldEnd + i];
4637 IvarsInfo.push_back(IvarInfo(firstEntry.Offset + eltIndex * eltSize,
4638 firstEntry.SizeInWords));
4639 }
4640 }
4641 }
4642
Fariborz Jahanian524bb202009-03-10 16:22:08 +00004643 return;
Fariborz Jahanian3b0f8862009-03-11 00:07:04 +00004644 }
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004645
John McCall3fd13f062015-10-21 18:06:47 +00004646 // Classify the element type.
4647 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), fieldType);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004648
John McCall3fd13f062015-10-21 18:06:47 +00004649 // If it matches what we're looking for, add an entry.
4650 if ((ForStrongLayout && GCAttr == Qualifiers::Strong)
4651 || (!ForStrongLayout && GCAttr == Qualifiers::Weak)) {
4652 assert(CGM.getContext().getTypeSizeInChars(fieldType)
4653 == CGM.getPointerSize());
4654 IvarsInfo.push_back(IvarInfo(fieldOffset, numElts));
4655 }
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00004656}
4657
John McCall3fd13f062015-10-21 18:06:47 +00004658/// buildBitmap - This routine does the horsework of taking the offsets of
4659/// strong/weak references and creating a bitmap. The bitmap is also
4660/// returned in the given buffer, suitable for being passed to \c dump().
4661llvm::Constant *IvarLayoutBuilder::buildBitmap(CGObjCCommonMac &CGObjC,
4662 llvm::SmallVectorImpl<unsigned char> &buffer) {
4663 // The bitmap is a series of skip/scan instructions, aligned to word
4664 // boundaries. The skip is performed first.
4665 const unsigned char MaxNibble = 0xF;
4666 const unsigned char SkipMask = 0xF0, SkipShift = 4;
4667 const unsigned char ScanMask = 0x0F, ScanShift = 0;
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004668
John McCall3fd13f062015-10-21 18:06:47 +00004669 assert(!IvarsInfo.empty() && "generating bitmap for no data");
4670
4671 // Sort the ivar info on byte position in case we encounterred a
4672 // union nested in the ivar list.
4673 if (IsDisordered) {
4674 // This isn't a stable sort, but our algorithm should handle it fine.
4675 llvm::array_pod_sort(IvarsInfo.begin(), IvarsInfo.end());
4676 } else {
4677#ifndef NDEBUG
4678 for (unsigned i = 1; i != IvarsInfo.size(); ++i) {
4679 assert(IvarsInfo[i - 1].Offset <= IvarsInfo[i].Offset);
4680 }
4681#endif
4682 }
4683 assert(IvarsInfo.back().Offset < InstanceEnd);
4684
4685 assert(buffer.empty());
4686
4687 // Skip the next N words.
4688 auto skip = [&](unsigned numWords) {
4689 assert(numWords > 0);
4690
4691 // Try to merge into the previous byte. Since scans happen second, we
4692 // can't do this if it includes a scan.
4693 if (!buffer.empty() && !(buffer.back() & ScanMask)) {
4694 unsigned lastSkip = buffer.back() >> SkipShift;
4695 if (lastSkip < MaxNibble) {
4696 unsigned claimed = std::min(MaxNibble - lastSkip, numWords);
4697 numWords -= claimed;
4698 lastSkip += claimed;
4699 buffer.back() = (lastSkip << SkipShift);
4700 }
4701 }
4702
4703 while (numWords >= MaxNibble) {
4704 buffer.push_back(MaxNibble << SkipShift);
4705 numWords -= MaxNibble;
4706 }
4707 if (numWords) {
4708 buffer.push_back(numWords << SkipShift);
4709 }
4710 };
4711
4712 // Scan the next N words.
4713 auto scan = [&](unsigned numWords) {
4714 assert(numWords > 0);
4715
4716 // Try to merge into the previous byte. Since scans happen second, we can
4717 // do this even if it includes a skip.
4718 if (!buffer.empty()) {
4719 unsigned lastScan = (buffer.back() & ScanMask) >> ScanShift;
4720 if (lastScan < MaxNibble) {
4721 unsigned claimed = std::min(MaxNibble - lastScan, numWords);
4722 numWords -= claimed;
4723 lastScan += claimed;
4724 buffer.back() = (buffer.back() & SkipMask) | (lastScan << ScanShift);
4725 }
4726 }
4727
4728 while (numWords >= MaxNibble) {
4729 buffer.push_back(MaxNibble << ScanShift);
4730 numWords -= MaxNibble;
4731 }
4732 if (numWords) {
4733 buffer.push_back(numWords << ScanShift);
4734 }
4735 };
4736
4737 // One past the end of the last scan.
4738 unsigned endOfLastScanInWords = 0;
4739 const CharUnits WordSize = CGM.getPointerSize();
4740
4741 // Consider all the scan requests.
4742 for (auto &request : IvarsInfo) {
4743 CharUnits beginOfScan = request.Offset - InstanceBegin;
4744
4745 // Ignore scan requests that don't start at an even multiple of the
4746 // word size. We can't encode them.
4747 if ((beginOfScan % WordSize) != 0) continue;
4748
4749 // Ignore scan requests that start before the instance start.
4750 // This assumes that scans never span that boundary. The boundary
4751 // isn't the true start of the ivars, because in the fragile-ARC case
4752 // it's rounded up to word alignment, but the test above should leave
4753 // us ignoring that possibility.
4754 if (beginOfScan.isNegative()) {
4755 assert(request.Offset + request.SizeInWords * WordSize <= InstanceBegin);
4756 continue;
4757 }
4758
4759 unsigned beginOfScanInWords = beginOfScan / WordSize;
4760 unsigned endOfScanInWords = beginOfScanInWords + request.SizeInWords;
4761
4762 // If the scan starts some number of words after the last one ended,
4763 // skip forward.
4764 if (beginOfScanInWords > endOfLastScanInWords) {
4765 skip(beginOfScanInWords - endOfLastScanInWords);
4766
4767 // Otherwise, start scanning where the last left off.
4768 } else {
4769 beginOfScanInWords = endOfLastScanInWords;
4770
4771 // If that leaves us with nothing to scan, ignore this request.
4772 if (beginOfScanInWords >= endOfScanInWords) continue;
4773 }
4774
4775 // Scan to the end of the request.
4776 assert(beginOfScanInWords < endOfScanInWords);
4777 scan(endOfScanInWords - beginOfScanInWords);
4778 endOfLastScanInWords = endOfScanInWords;
4779 }
4780
4781 // For GC layouts, emit a skip to the end of the allocation so that we
4782 // have precise information about the entire thing. This isn't useful
4783 // or necessary for the ARC-style layout strings.
4784 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
4785 unsigned lastOffsetInWords =
4786 (InstanceEnd - InstanceBegin + WordSize - CharUnits::One()) / WordSize;
4787 if (lastOffsetInWords > endOfLastScanInWords) {
4788 skip(lastOffsetInWords - endOfLastScanInWords);
4789 }
4790 }
4791
4792 // Null terminate the string.
4793 buffer.push_back(0);
4794
4795 bool isNonFragileABI = CGObjC.isNonFragileABI();
4796
4797 llvm::GlobalVariable *Entry = CGObjC.CreateMetadataVar(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004798 "OBJC_CLASS_NAME_",
John McCall3fd13f062015-10-21 18:06:47 +00004799 llvm::ConstantDataArray::get(CGM.getLLVMContext(), buffer),
4800 (isNonFragileABI ? "__TEXT,__objc_classname,cstring_literals"
4801 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004802 CharUnits::One(), true);
John McCall3fd13f062015-10-21 18:06:47 +00004803 return getConstantGEP(CGM.getLLVMContext(), Entry, 0, 0);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004804}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004805
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004806/// BuildIvarLayout - Builds ivar layout bitmap for the class
4807/// implementation for the __strong or __weak case.
4808/// The layout map displays which words in ivar list must be skipped
4809/// and which must be scanned by GC (see below). String is built of bytes.
4810/// Each byte is divided up in two nibbles (4-bit each). Left nibble is count
4811/// of words to skip and right nibble is count of words to scan. So, each
4812/// nibble represents up to 15 workds to skip or scan. Skipping the rest is
4813/// represented by a 0x00 byte which also ends the string.
4814/// 1. when ForStrongLayout is true, following ivars are scanned:
4815/// - id, Class
4816/// - object *
4817/// - __strong anything
4818///
4819/// 2. When ForStrongLayout is false, following ivars are scanned:
4820/// - __weak anything
4821///
John McCall3fd13f062015-10-21 18:06:47 +00004822llvm::Constant *
4823CGObjCCommonMac::BuildIvarLayout(const ObjCImplementationDecl *OMD,
4824 CharUnits beginOffset, CharUnits endOffset,
4825 bool ForStrongLayout) {
Chris Lattnerece04092012-02-07 00:39:47 +00004826 llvm::Type *PtrTy = CGM.Int8PtrTy;
David Blaikiebbafb8a2012-03-11 07:00:24 +00004827 if (CGM.getLangOpts().getGC() == LangOptions::NonGC &&
4828 !CGM.getLangOpts().ObjCAutoRefCount)
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004829 return llvm::Constant::getNullValue(PtrTy);
4830
Jordy Rosea91768e2011-07-22 02:08:32 +00004831 const ObjCInterfaceDecl *OI = OMD->getClassInterface();
John McCall3fd13f062015-10-21 18:06:47 +00004832 SmallVector<const ObjCIvarDecl*, 32> ivars;
4833
4834 // GC layout strings include the complete object layout, possibly
4835 // inaccurately in the non-fragile ABI; the runtime knows how to fix this
4836 // up.
4837 //
4838 // ARC layout strings only include the class's ivars. In non-fragile
4839 // runtimes, that means starting at InstanceStart. In fragile runtimes,
4840 // there's no InstanceStart, so it means starting at the end of the
4841 // superclass, rounded up to word alignment.
4842 CharUnits baseOffset;
David Blaikiebbafb8a2012-03-11 07:00:24 +00004843 if (CGM.getLangOpts().ObjCAutoRefCount) {
Jordy Rosea91768e2011-07-22 02:08:32 +00004844 for (const ObjCIvarDecl *IVD = OI->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00004845 IVD; IVD = IVD->getNextIvar())
John McCall3fd13f062015-10-21 18:06:47 +00004846 ivars.push_back(IVD);
4847
4848 if (isNonFragileABI()) {
4849 baseOffset = beginOffset; // InstanceStart
4850 } else if (auto superClass = OMD->getSuperClass()) {
4851 auto startOffset =
4852 CGM.getContext().getASTObjCInterfaceLayout(superClass).getSize();
4853 baseOffset = startOffset.RoundUpToAlignment(CGM.getPointerAlign());
4854 } else {
4855 baseOffset = CharUnits::Zero();
4856 }
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00004857 }
4858 else {
John McCall3fd13f062015-10-21 18:06:47 +00004859 CGM.getContext().DeepCollectObjCIvars(OI, true, ivars);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004860
John McCall3fd13f062015-10-21 18:06:47 +00004861 baseOffset = CharUnits::Zero();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00004862 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004863
John McCall3fd13f062015-10-21 18:06:47 +00004864 if (ivars.empty())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004865 return llvm::Constant::getNullValue(PtrTy);
4866
John McCall3fd13f062015-10-21 18:06:47 +00004867 IvarLayoutBuilder builder(CGM, baseOffset, endOffset, ForStrongLayout);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004868
John McCall3fd13f062015-10-21 18:06:47 +00004869 builder.visitAggregate(ivars.begin(), ivars.end(), CharUnits::Zero(),
4870 [&](const ObjCIvarDecl *ivar) -> CharUnits {
4871 return CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivar));
4872 });
4873
4874 if (!builder.hasBitmapData())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004875 return llvm::Constant::getNullValue(PtrTy);
John McCall3fd13f062015-10-21 18:06:47 +00004876
4877 llvm::SmallVector<unsigned char, 4> buffer;
4878 llvm::Constant *C = builder.buildBitmap(*this, buffer);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004879
David Blaikiebbafb8a2012-03-11 07:00:24 +00004880 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004881 printf("\n%s ivar layout for class '%s': ",
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00004882 ForStrongLayout ? "strong" : "weak",
Ben Langmuire013bdc2014-07-11 00:43:47 +00004883 OMD->getClassInterface()->getName().str().c_str());
John McCall3fd13f062015-10-21 18:06:47 +00004884 builder.dump(buffer);
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00004885 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004886 return C;
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00004887}
4888
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00004889llvm::Constant *CGObjCCommonMac::GetMethodVarName(Selector Sel) {
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004890 llvm::GlobalVariable *&Entry = MethodVarNames[Sel];
4891
Chris Lattner3def9ae2012-02-06 22:16:34 +00004892 // FIXME: Avoid std::string in "Sel.getAsString()"
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004893 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004894 Entry = CreateMetadataVar(
4895 "OBJC_METH_VAR_NAME_",
4896 llvm::ConstantDataArray::getString(VMContext, Sel.getAsString()),
4897 ((ObjCABI == 2) ? "__TEXT,__objc_methname,cstring_literals"
4898 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004899 CharUnits::One(), true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004900
Owen Anderson170229f2009-07-14 23:10:40 +00004901 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarb036db82008-08-13 03:21:16 +00004902}
4903
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004904// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00004905llvm::Constant *CGObjCCommonMac::GetMethodVarName(IdentifierInfo *ID) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004906 return GetMethodVarName(CGM.getContext().Selectors.getNullarySelector(ID));
4907}
4908
Daniel Dunbarf5c18462009-04-20 06:54:31 +00004909llvm::Constant *CGObjCCommonMac::GetMethodVarType(const FieldDecl *Field) {
Devang Patel4b6e4bb2009-03-04 18:21:39 +00004910 std::string TypeStr;
4911 CGM.getContext().getObjCEncodingForType(Field->getType(), TypeStr, Field);
4912
4913 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbarb036db82008-08-13 03:21:16 +00004914
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004915 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004916 Entry = CreateMetadataVar(
4917 "OBJC_METH_VAR_TYPE_",
4918 llvm::ConstantDataArray::getString(VMContext, TypeStr),
4919 ((ObjCABI == 2) ? "__TEXT,__objc_methtype,cstring_literals"
4920 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004921 CharUnits::One(), true);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004922
Owen Anderson170229f2009-07-14 23:10:40 +00004923 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004924}
4925
Bob Wilson5f4e3a72011-11-30 01:57:58 +00004926llvm::Constant *CGObjCCommonMac::GetMethodVarType(const ObjCMethodDecl *D,
4927 bool Extended) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004928 std::string TypeStr;
Bill Wendlinge22bef72012-02-09 22:45:21 +00004929 if (CGM.getContext().getObjCEncodingForMethodDecl(D, TypeStr, Extended))
Craig Topper8a13c412014-05-21 05:09:00 +00004930 return nullptr;
Devang Patel4b6e4bb2009-03-04 18:21:39 +00004931
4932 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
4933
Daniel Dunbar3241fae2009-04-14 23:14:47 +00004934 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004935 Entry = CreateMetadataVar(
4936 "OBJC_METH_VAR_TYPE_",
4937 llvm::ConstantDataArray::getString(VMContext, TypeStr),
4938 ((ObjCABI == 2) ? "__TEXT,__objc_methtype,cstring_literals"
4939 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004940 CharUnits::One(), true);
Devang Patel4b6e4bb2009-03-04 18:21:39 +00004941
Owen Anderson170229f2009-07-14 23:10:40 +00004942 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004943}
4944
Daniel Dunbar80a840b2008-08-23 00:19:03 +00004945// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00004946llvm::Constant *CGObjCCommonMac::GetPropertyName(IdentifierInfo *Ident) {
Daniel Dunbar80a840b2008-08-23 00:19:03 +00004947 llvm::GlobalVariable *&Entry = PropertyNames[Ident];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004948
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004949 if (!Entry)
Alp Toker541d5072014-06-07 23:30:53 +00004950 Entry = CreateMetadataVar(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004951 "OBJC_PROP_NAME_ATTR_",
Alp Toker541d5072014-06-07 23:30:53 +00004952 llvm::ConstantDataArray::getString(VMContext, Ident->getName()),
John McCall7f416cc2015-09-08 08:05:57 +00004953 "__TEXT,__cstring,cstring_literals", CharUnits::One(), true);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00004954
Owen Anderson170229f2009-07-14 23:10:40 +00004955 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00004956}
4957
4958// FIXME: Merge into a single cstring creation function.
Daniel Dunbar4932b362008-08-28 04:38:10 +00004959// FIXME: This Decl should be more precise.
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004960llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004961CGObjCCommonMac::GetPropertyTypeString(const ObjCPropertyDecl *PD,
4962 const Decl *Container) {
Daniel Dunbar4932b362008-08-28 04:38:10 +00004963 std::string TypeStr;
4964 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container, TypeStr);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00004965 return GetPropertyName(&CGM.getContext().Idents.get(TypeStr));
4966}
4967
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004968void CGObjCCommonMac::GetNameForMethod(const ObjCMethodDecl *D,
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00004969 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004970 SmallVectorImpl<char> &Name) {
Daniel Dunbard2386812009-10-19 01:21:19 +00004971 llvm::raw_svector_ostream OS(Name);
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00004972 assert (CD && "Missing container decl in GetNameForMethod");
Daniel Dunbard2386812009-10-19 01:21:19 +00004973 OS << '\01' << (D->isInstanceMethod() ? '-' : '+')
4974 << '[' << CD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004975 if (const ObjCCategoryImplDecl *CID =
Daniel Dunbard2386812009-10-19 01:21:19 +00004976 dyn_cast<ObjCCategoryImplDecl>(D->getDeclContext()))
Benjamin Kramer2f569922012-02-07 11:57:45 +00004977 OS << '(' << *CID << ')';
Daniel Dunbard2386812009-10-19 01:21:19 +00004978 OS << ' ' << D->getSelector().getAsString() << ']';
Daniel Dunbara94ecd22008-08-16 03:19:19 +00004979}
4980
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004981void CGObjCMac::FinishModule() {
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004982 EmitModuleInfo();
4983
Daniel Dunbarc475d422008-10-29 22:36:39 +00004984 // Emit the dummy bodies for any protocols which were referenced but
4985 // never defined.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004986 for (llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*>::iterator
Chris Lattnerf56501c2009-07-17 23:57:13 +00004987 I = Protocols.begin(), e = Protocols.end(); I != e; ++I) {
4988 if (I->second->hasInitializer())
Daniel Dunbarc475d422008-10-29 22:36:39 +00004989 continue;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004990
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004991 llvm::Constant *Values[5];
Owen Anderson0b75f232009-07-31 20:28:54 +00004992 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004993 Values[1] = GetClassName(I->first->getName());
Owen Anderson0b75f232009-07-31 20:28:54 +00004994 Values[2] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarc475d422008-10-29 22:36:39 +00004995 Values[3] = Values[4] =
Owen Anderson0b75f232009-07-31 20:28:54 +00004996 llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00004997 I->second->setInitializer(llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbarc475d422008-10-29 22:36:39 +00004998 Values));
Rafael Espindola060062a2014-03-06 22:15:10 +00004999 CGM.addCompilerUsedGlobal(I->second);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005000 }
5001
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005002 // Add assembler directives to add lazy undefined symbol references
5003 // for classes which are referenced but not defined. This is
5004 // important for correct linker interaction.
Daniel Dunbard027a922009-09-07 00:20:42 +00005005 //
5006 // FIXME: It would be nice if we had an LLVM construct for this.
5007 if (!LazySymbols.empty() || !DefinedSymbols.empty()) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00005008 SmallString<256> Asm;
Daniel Dunbard027a922009-09-07 00:20:42 +00005009 Asm += CGM.getModule().getModuleInlineAsm();
5010 if (!Asm.empty() && Asm.back() != '\n')
5011 Asm += '\n';
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005012
Daniel Dunbard027a922009-09-07 00:20:42 +00005013 llvm::raw_svector_ostream OS(Asm);
Daniel Dunbard027a922009-09-07 00:20:42 +00005014 for (llvm::SetVector<IdentifierInfo*>::iterator I = DefinedSymbols.begin(),
5015 e = DefinedSymbols.end(); I != e; ++I)
Daniel Dunbar07d07852009-10-18 21:17:35 +00005016 OS << "\t.objc_class_name_" << (*I)->getName() << "=0\n"
5017 << "\t.globl .objc_class_name_" << (*I)->getName() << "\n";
Chris Lattnera299f2c2010-04-17 18:26:20 +00005018 for (llvm::SetVector<IdentifierInfo*>::iterator I = LazySymbols.begin(),
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005019 e = LazySymbols.end(); I != e; ++I) {
Chris Lattnera299f2c2010-04-17 18:26:20 +00005020 OS << "\t.lazy_reference .objc_class_name_" << (*I)->getName() << "\n";
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005021 }
5022
Bill Wendling53136852012-02-07 09:06:01 +00005023 for (size_t i = 0, e = DefinedCategoryNames.size(); i < e; ++i) {
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005024 OS << "\t.objc_category_name_" << DefinedCategoryNames[i] << "=0\n"
5025 << "\t.globl .objc_category_name_" << DefinedCategoryNames[i] << "\n";
5026 }
Chris Lattnera299f2c2010-04-17 18:26:20 +00005027
Daniel Dunbard027a922009-09-07 00:20:42 +00005028 CGM.getModule().setModuleInlineAsm(OS.str());
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005029 }
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005030}
5031
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005032CGObjCNonFragileABIMac::CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm)
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005033 : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00005034 ObjCTypes(cgm) {
Craig Topper8a13c412014-05-21 05:09:00 +00005035 ObjCEmptyCacheVar = ObjCEmptyVtableVar = nullptr;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005036 ObjCABI = 2;
5037}
5038
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005039/* *** */
5040
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005041ObjCCommonTypesHelper::ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm)
Craig Topper8a13c412014-05-21 05:09:00 +00005042 : VMContext(cgm.getLLVMContext()), CGM(cgm), ExternalProtocolPtrTy(nullptr)
Douglas Gregora95f9aa2012-01-17 23:38:32 +00005043{
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005044 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5045 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005046
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005047 ShortTy = Types.ConvertType(Ctx.ShortTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005048 IntTy = Types.ConvertType(Ctx.IntTy);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005049 LongTy = Types.ConvertType(Ctx.LongTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00005050 LongLongTy = Types.ConvertType(Ctx.LongLongTy);
Chris Lattnerece04092012-02-07 00:39:47 +00005051 Int8PtrTy = CGM.Int8PtrTy;
5052 Int8PtrPtrTy = CGM.Int8PtrPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005053
Tim Northover238b5082014-03-29 13:42:40 +00005054 // arm64 targets use "int" ivar offset variables. All others,
5055 // including OS X x86_64 and Windows x86_64, use "long" ivar offsets.
Tim Northover40956e62014-07-23 12:32:58 +00005056 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::aarch64)
Tim Northover238b5082014-03-29 13:42:40 +00005057 IvarOffsetVarTy = IntTy;
5058 else
5059 IvarOffsetVarTy = LongTy;
5060
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005061 ObjectPtrTy = Types.ConvertType(Ctx.getObjCIdType());
Owen Anderson9793f0e2009-07-29 22:16:19 +00005062 PtrObjectPtrTy = llvm::PointerType::getUnqual(ObjectPtrTy);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005063 SelectorPtrTy = Types.ConvertType(Ctx.getObjCSelType());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005064
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005065 // I'm not sure I like this. The implicit coordination is a bit
5066 // gross. We should solve this in a reasonable fashion because this
5067 // is a pretty common task (match some runtime data structure with
5068 // an LLVM data structure).
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005069
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005070 // FIXME: This is leaked.
5071 // FIXME: Merge with rewriter code?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005072
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005073 // struct _objc_super {
5074 // id self;
5075 // Class cls;
5076 // }
Abramo Bagnara6150c882010-05-11 21:36:43 +00005077 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005078 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005079 SourceLocation(), SourceLocation(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005080 &Ctx.Idents.get("_objc_super"));
Craig Topper8a13c412014-05-21 05:09:00 +00005081 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5082 nullptr, Ctx.getObjCIdType(), nullptr, nullptr,
5083 false, ICIS_NoInit));
5084 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5085 nullptr, Ctx.getObjCClassType(), nullptr,
5086 nullptr, false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005087 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005088
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005089 SuperCTy = Ctx.getTagDeclType(RD);
5090 SuperPtrCTy = Ctx.getPointerType(SuperCTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005091
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005092 SuperTy = cast<llvm::StructType>(Types.ConvertType(SuperCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005093 SuperPtrTy = llvm::PointerType::getUnqual(SuperTy);
5094
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005095 // struct _prop_t {
5096 // char *name;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005097 // char *attributes;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005098 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005099 PropertyTy = llvm::StructType::create("struct._prop_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005100 Int8PtrTy, Int8PtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005101
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005102 // struct _prop_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005103 // uint32_t entsize; // sizeof(struct _prop_t)
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005104 // uint32_t count_of_properties;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005105 // struct _prop_t prop_list[count_of_properties];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005106 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005107 PropertyListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005108 llvm::StructType::create("struct._prop_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005109 llvm::ArrayType::get(PropertyTy, 0), nullptr);
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005110 // struct _prop_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005111 PropertyListPtrTy = llvm::PointerType::getUnqual(PropertyListTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005112
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005113 // struct _objc_method {
5114 // SEL _cmd;
5115 // char *method_type;
5116 // char *_imp;
5117 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005118 MethodTy = llvm::StructType::create("struct._objc_method",
5119 SelectorPtrTy, Int8PtrTy, Int8PtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005120 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005121
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005122 // struct _objc_cache *
Chris Lattner5ec04a52011-08-12 17:43:31 +00005123 CacheTy = llvm::StructType::create(VMContext, "struct._objc_cache");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005124 CachePtrTy = llvm::PointerType::getUnqual(CacheTy);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00005125
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005126}
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005127
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005128ObjCTypesHelper::ObjCTypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005129 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005130 // struct _objc_method_description {
5131 // SEL name;
5132 // char *types;
5133 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005134 MethodDescriptionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005135 llvm::StructType::create("struct._objc_method_description",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005136 SelectorPtrTy, Int8PtrTy, nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005137
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005138 // struct _objc_method_description_list {
5139 // int count;
5140 // struct _objc_method_description[1];
5141 // }
Reid Kleckneree7cf842014-12-01 22:02:27 +00005142 MethodDescriptionListTy = llvm::StructType::create(
5143 "struct._objc_method_description_list", IntTy,
5144 llvm::ArrayType::get(MethodDescriptionTy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005145
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005146 // struct _objc_method_description_list *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005147 MethodDescriptionListPtrTy =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005148 llvm::PointerType::getUnqual(MethodDescriptionListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005149
Daniel Dunbarb036db82008-08-13 03:21:16 +00005150 // Protocol description structures
5151
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005152 // struct _objc_protocol_extension {
5153 // uint32_t size; // sizeof(struct _objc_protocol_extension)
5154 // struct _objc_method_description_list *optional_instance_methods;
5155 // struct _objc_method_description_list *optional_class_methods;
5156 // struct _objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005157 // const char ** extendedMethodTypes;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005158 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005159 ProtocolExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005160 llvm::StructType::create("struct._objc_protocol_extension",
5161 IntTy, MethodDescriptionListPtrTy,
5162 MethodDescriptionListPtrTy, PropertyListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005163 Int8PtrPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005164
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005165 // struct _objc_protocol_extension *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005166 ProtocolExtensionPtrTy = llvm::PointerType::getUnqual(ProtocolExtensionTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005167
Daniel Dunbarc475d422008-10-29 22:36:39 +00005168 // Handle recursive construction of Protocol and ProtocolList types
Daniel Dunbarb036db82008-08-13 03:21:16 +00005169
Chris Lattnera5f58b02011-07-09 17:41:47 +00005170 ProtocolTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005171 llvm::StructType::create(VMContext, "struct._objc_protocol");
Daniel Dunbarb036db82008-08-13 03:21:16 +00005172
Chris Lattnera5f58b02011-07-09 17:41:47 +00005173 ProtocolListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005174 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005175 ProtocolListTy->setBody(llvm::PointerType::getUnqual(ProtocolListTy),
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005176 LongTy,
Chris Lattnera5f58b02011-07-09 17:41:47 +00005177 llvm::ArrayType::get(ProtocolTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005178 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005179
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005180 // struct _objc_protocol {
5181 // struct _objc_protocol_extension *isa;
5182 // char *protocol_name;
5183 // struct _objc_protocol **_objc_protocol_list;
5184 // struct _objc_method_description_list *instance_methods;
5185 // struct _objc_method_description_list *class_methods;
5186 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005187 ProtocolTy->setBody(ProtocolExtensionPtrTy, Int8PtrTy,
5188 llvm::PointerType::getUnqual(ProtocolListTy),
5189 MethodDescriptionListPtrTy,
5190 MethodDescriptionListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005191 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005192
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005193 // struct _objc_protocol_list *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005194 ProtocolListPtrTy = llvm::PointerType::getUnqual(ProtocolListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005195
Owen Anderson9793f0e2009-07-29 22:16:19 +00005196 ProtocolPtrTy = llvm::PointerType::getUnqual(ProtocolTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005197
5198 // Class description structures
5199
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005200 // struct _objc_ivar {
5201 // char *ivar_name;
5202 // char *ivar_type;
5203 // int ivar_offset;
5204 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005205 IvarTy = llvm::StructType::create("struct._objc_ivar",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005206 Int8PtrTy, Int8PtrTy, IntTy, nullptr);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005207
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005208 // struct _objc_ivar_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005209 IvarListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005210 llvm::StructType::create(VMContext, "struct._objc_ivar_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005211 IvarListPtrTy = llvm::PointerType::getUnqual(IvarListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005212
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005213 // struct _objc_method_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005214 MethodListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005215 llvm::StructType::create(VMContext, "struct._objc_method_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005216 MethodListPtrTy = llvm::PointerType::getUnqual(MethodListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005217
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005218 // struct _objc_class_extension *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005219 ClassExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005220 llvm::StructType::create("struct._objc_class_extension",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005221 IntTy, Int8PtrTy, PropertyListPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005222 ClassExtensionPtrTy = llvm::PointerType::getUnqual(ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005223
Chris Lattner5ec04a52011-08-12 17:43:31 +00005224 ClassTy = llvm::StructType::create(VMContext, "struct._objc_class");
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005225
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005226 // struct _objc_class {
5227 // Class isa;
5228 // Class super_class;
5229 // char *name;
5230 // long version;
5231 // long info;
5232 // long instance_size;
5233 // struct _objc_ivar_list *ivars;
5234 // struct _objc_method_list *methods;
5235 // struct _objc_cache *cache;
5236 // struct _objc_protocol_list *protocols;
5237 // char *ivar_layout;
5238 // struct _objc_class_ext *ext;
5239 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005240 ClassTy->setBody(llvm::PointerType::getUnqual(ClassTy),
5241 llvm::PointerType::getUnqual(ClassTy),
5242 Int8PtrTy,
5243 LongTy,
5244 LongTy,
5245 LongTy,
5246 IvarListPtrTy,
5247 MethodListPtrTy,
5248 CachePtrTy,
5249 ProtocolListPtrTy,
5250 Int8PtrTy,
5251 ClassExtensionPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005252 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005253
Owen Anderson9793f0e2009-07-29 22:16:19 +00005254 ClassPtrTy = llvm::PointerType::getUnqual(ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005255
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005256 // struct _objc_category {
5257 // char *category_name;
5258 // char *class_name;
5259 // struct _objc_method_list *instance_method;
5260 // struct _objc_method_list *class_method;
5261 // uint32_t size; // sizeof(struct _objc_category)
5262 // struct _objc_property_list *instance_properties;// category's @property
5263 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005264 CategoryTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005265 llvm::StructType::create("struct._objc_category",
5266 Int8PtrTy, Int8PtrTy, MethodListPtrTy,
5267 MethodListPtrTy, ProtocolListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005268 IntTy, PropertyListPtrTy, nullptr);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00005269
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005270 // Global metadata structures
5271
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005272 // struct _objc_symtab {
5273 // long sel_ref_cnt;
5274 // SEL *refs;
5275 // short cls_def_cnt;
5276 // short cat_def_cnt;
5277 // char *defs[cls_def_cnt + cat_def_cnt];
5278 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005279 SymtabTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005280 llvm::StructType::create("struct._objc_symtab",
5281 LongTy, SelectorPtrTy, ShortTy, ShortTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005282 llvm::ArrayType::get(Int8PtrTy, 0), nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005283 SymtabPtrTy = llvm::PointerType::getUnqual(SymtabTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005284
Fariborz Jahanianeee54df2009-01-22 00:37:21 +00005285 // struct _objc_module {
5286 // long version;
5287 // long size; // sizeof(struct _objc_module)
5288 // char *name;
5289 // struct _objc_symtab* symtab;
5290 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005291 ModuleTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005292 llvm::StructType::create("struct._objc_module",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005293 LongTy, LongTy, Int8PtrTy, SymtabPtrTy, nullptr);
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00005294
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005295
Mike Stump18bb9282009-05-16 07:57:57 +00005296 // FIXME: This is the size of the setjmp buffer and should be target
5297 // specific. 18 is what's used on 32-bit X86.
Anders Carlsson9ff22482008-09-09 10:10:21 +00005298 uint64_t SetJmpBufferSize = 18;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005299
Anders Carlsson9ff22482008-09-09 10:10:21 +00005300 // Exceptions
Chris Lattnerece04092012-02-07 00:39:47 +00005301 llvm::Type *StackPtrTy = llvm::ArrayType::get(CGM.Int8PtrTy, 4);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005302
5303 ExceptionDataTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005304 llvm::StructType::create("struct._objc_exception_data",
Chris Lattnerece04092012-02-07 00:39:47 +00005305 llvm::ArrayType::get(CGM.Int32Ty,SetJmpBufferSize),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005306 StackPtrTy, nullptr);
Anders Carlsson9ff22482008-09-09 10:10:21 +00005307
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005308}
5309
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005310ObjCNonFragileABITypesHelper::ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005311 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005312 // struct _method_list_t {
5313 // uint32_t entsize; // sizeof(struct _objc_method)
5314 // uint32_t method_count;
5315 // struct _objc_method method_list[method_count];
5316 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005317 MethodListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005318 llvm::StructType::create("struct.__method_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005319 llvm::ArrayType::get(MethodTy, 0), nullptr);
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005320 // struct method_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005321 MethodListnfABIPtrTy = llvm::PointerType::getUnqual(MethodListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005322
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005323 // struct _protocol_t {
5324 // id isa; // NULL
5325 // const char * const protocol_name;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005326 // const struct _protocol_list_t * protocol_list; // super protocols
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005327 // const struct method_list_t * const instance_methods;
5328 // const struct method_list_t * const class_methods;
5329 // const struct method_list_t *optionalInstanceMethods;
5330 // const struct method_list_t *optionalClassMethods;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005331 // const struct _prop_list_t * properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005332 // const uint32_t size; // sizeof(struct _protocol_t)
5333 // const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005334 // const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00005335 // const char *demangledName;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005336 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005337
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005338 // Holder for struct _protocol_list_t *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005339 ProtocolListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005340 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005341
Chris Lattnera5f58b02011-07-09 17:41:47 +00005342 ProtocolnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005343 llvm::StructType::create("struct._protocol_t", ObjectPtrTy, Int8PtrTy,
5344 llvm::PointerType::getUnqual(ProtocolListnfABITy),
5345 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
5346 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005347 PropertyListPtrTy, IntTy, IntTy, Int8PtrPtrTy,
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00005348 Int8PtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005349 nullptr);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005350
5351 // struct _protocol_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005352 ProtocolnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005353
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005354 // struct _protocol_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005355 // long protocol_count; // Note, this is 32/64 bit
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005356 // struct _protocol_t *[protocol_count];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005357 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005358 ProtocolListnfABITy->setBody(LongTy,
5359 llvm::ArrayType::get(ProtocolnfABIPtrTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005360 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005361
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005362 // struct _objc_protocol_list*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005363 ProtocolListnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005364
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005365 // struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00005366 // unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005367 // char *name;
5368 // char *type;
5369 // uint32_t alignment;
5370 // uint32_t size;
5371 // }
Tim Northover238b5082014-03-29 13:42:40 +00005372 IvarnfABITy = llvm::StructType::create(
5373 "struct._ivar_t", llvm::PointerType::getUnqual(IvarOffsetVarTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005374 Int8PtrTy, Int8PtrTy, IntTy, IntTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005375
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005376 // struct _ivar_list_t {
5377 // uint32 entsize; // sizeof(struct _ivar_t)
5378 // uint32 count;
5379 // struct _iver_t list[count];
5380 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005381 IvarListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005382 llvm::StructType::create("struct._ivar_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005383 llvm::ArrayType::get(IvarnfABITy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005384
Owen Anderson9793f0e2009-07-29 22:16:19 +00005385 IvarListnfABIPtrTy = llvm::PointerType::getUnqual(IvarListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005386
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005387 // struct _class_ro_t {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005388 // uint32_t const flags;
5389 // uint32_t const instanceStart;
5390 // uint32_t const instanceSize;
5391 // uint32_t const reserved; // only when building for 64bit targets
5392 // const uint8_t * const ivarLayout;
5393 // const char *const name;
5394 // const struct _method_list_t * const baseMethods;
5395 // const struct _objc_protocol_list *const baseProtocols;
5396 // const struct _ivar_list_t *const ivars;
5397 // const uint8_t * const weakIvarLayout;
5398 // const struct _prop_list_t * const properties;
5399 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005400
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005401 // FIXME. Add 'reserved' field in 64bit abi mode!
Chris Lattner5ec04a52011-08-12 17:43:31 +00005402 ClassRonfABITy = llvm::StructType::create("struct._class_ro_t",
5403 IntTy, IntTy, IntTy, Int8PtrTy,
5404 Int8PtrTy, MethodListnfABIPtrTy,
5405 ProtocolListnfABIPtrTy,
5406 IvarListnfABIPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005407 Int8PtrTy, PropertyListPtrTy,
5408 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005409
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005410 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +00005411 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall9dc0db22011-05-15 01:53:33 +00005412 ImpnfABITy = llvm::FunctionType::get(ObjectPtrTy, params, false)
5413 ->getPointerTo();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005414
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005415 // struct _class_t {
5416 // struct _class_t *isa;
5417 // struct _class_t * const superclass;
5418 // void *cache;
5419 // IMP *vtable;
5420 // struct class_ro_t *ro;
5421 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005422
Chris Lattner5ec04a52011-08-12 17:43:31 +00005423 ClassnfABITy = llvm::StructType::create(VMContext, "struct._class_t");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005424 ClassnfABITy->setBody(llvm::PointerType::getUnqual(ClassnfABITy),
5425 llvm::PointerType::getUnqual(ClassnfABITy),
5426 CachePtrTy,
5427 llvm::PointerType::getUnqual(ImpnfABITy),
5428 llvm::PointerType::getUnqual(ClassRonfABITy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005429 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005430
Fariborz Jahanian71394042009-01-23 23:53:38 +00005431 // LLVM for struct _class_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005432 ClassnfABIPtrTy = llvm::PointerType::getUnqual(ClassnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005433
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005434 // struct _category_t {
5435 // const char * const name;
5436 // struct _class_t *const cls;
5437 // const struct _method_list_t * const instance_methods;
5438 // const struct _method_list_t * const class_methods;
5439 // const struct _protocol_list_t * const protocols;
5440 // const struct _prop_list_t * const properties;
Fariborz Jahanian5a63e4c2009-01-23 17:41:22 +00005441 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005442 CategorynfABITy = llvm::StructType::create("struct._category_t",
5443 Int8PtrTy, ClassnfABIPtrTy,
5444 MethodListnfABIPtrTy,
5445 MethodListnfABIPtrTy,
5446 ProtocolListnfABIPtrTy,
5447 PropertyListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005448 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005449
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005450 // New types for nonfragile abi messaging.
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005451 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5452 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005453
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005454 // MessageRefTy - LLVM for:
5455 // struct _message_ref_t {
5456 // IMP messenger;
5457 // SEL name;
5458 // };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005459
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005460 // First the clang type for struct _message_ref_t
Abramo Bagnara6150c882010-05-11 21:36:43 +00005461 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005462 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005463 SourceLocation(), SourceLocation(),
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005464 &Ctx.Idents.get("_message_ref_t"));
Craig Topper8a13c412014-05-21 05:09:00 +00005465 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5466 nullptr, Ctx.VoidPtrTy, nullptr, nullptr, false,
Richard Smith2b013182012-06-10 03:12:00 +00005467 ICIS_NoInit));
Craig Topper8a13c412014-05-21 05:09:00 +00005468 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5469 nullptr, Ctx.getObjCSelType(), nullptr, nullptr,
5470 false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005471 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005472
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005473 MessageRefCTy = Ctx.getTagDeclType(RD);
5474 MessageRefCPtrTy = Ctx.getPointerType(MessageRefCTy);
5475 MessageRefTy = cast<llvm::StructType>(Types.ConvertType(MessageRefCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005476
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005477 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005478 MessageRefPtrTy = llvm::PointerType::getUnqual(MessageRefTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005479
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005480 // SuperMessageRefTy - LLVM for:
5481 // struct _super_message_ref_t {
5482 // SUPER_IMP messenger;
5483 // SEL name;
5484 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005485 SuperMessageRefTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005486 llvm::StructType::create("struct._super_message_ref_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005487 ImpnfABITy, SelectorPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005488
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005489 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005490 SuperMessageRefPtrTy = llvm::PointerType::getUnqual(SuperMessageRefTy);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00005491
Daniel Dunbarb1559a42009-03-01 04:46:24 +00005492
5493 // struct objc_typeinfo {
5494 // const void** vtable; // objc_ehtype_vtable + 2
5495 // const char* name; // c++ typeinfo string
5496 // Class cls;
5497 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005498 EHTypeTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005499 llvm::StructType::create("struct._objc_typeinfo",
5500 llvm::PointerType::getUnqual(Int8PtrTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005501 Int8PtrTy, ClassnfABIPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005502 EHTypePtrTy = llvm::PointerType::getUnqual(EHTypeTy);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005503}
5504
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005505llvm::Function *CGObjCNonFragileABIMac::ModuleInitFunction() {
Fariborz Jahanian71394042009-01-23 23:53:38 +00005506 FinishNonFragileABIModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005507
Craig Topper8a13c412014-05-21 05:09:00 +00005508 return nullptr;
Fariborz Jahanian71394042009-01-23 23:53:38 +00005509}
5510
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00005511void CGObjCNonFragileABIMac::
5512AddModuleClassList(ArrayRef<llvm::GlobalValue*> Container,
5513 const char *SymbolName,
5514 const char *SectionName) {
Daniel Dunbar19573e72009-05-15 21:48:48 +00005515 unsigned NumClasses = Container.size();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005516
Daniel Dunbar19573e72009-05-15 21:48:48 +00005517 if (!NumClasses)
5518 return;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005519
Chris Lattner3def9ae2012-02-06 22:16:34 +00005520 SmallVector<llvm::Constant*, 8> Symbols(NumClasses);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005521 for (unsigned i=0; i<NumClasses; i++)
Owen Andersonade90fd2009-07-29 18:54:39 +00005522 Symbols[i] = llvm::ConstantExpr::getBitCast(Container[i],
Daniel Dunbar19573e72009-05-15 21:48:48 +00005523 ObjCTypes.Int8PtrTy);
Chris Lattner3def9ae2012-02-06 22:16:34 +00005524 llvm::Constant *Init =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005525 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00005526 Symbols.size()),
Daniel Dunbar19573e72009-05-15 21:48:48 +00005527 Symbols);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005528
Daniel Dunbar19573e72009-05-15 21:48:48 +00005529 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00005530 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005531 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar19573e72009-05-15 21:48:48 +00005532 Init,
Owen Andersonc10c8d32009-07-08 19:05:04 +00005533 SymbolName);
Micah Villmowdd31ca12012-10-08 16:25:52 +00005534 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Daniel Dunbar19573e72009-05-15 21:48:48 +00005535 GV->setSection(SectionName);
Rafael Espindola060062a2014-03-06 22:15:10 +00005536 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005537}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005538
Fariborz Jahanian71394042009-01-23 23:53:38 +00005539void CGObjCNonFragileABIMac::FinishNonFragileABIModule() {
5540 // nonfragile abi has no module definition.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005541
Daniel Dunbar19573e72009-05-15 21:48:48 +00005542 // Build list of all implemented class addresses in array
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005543 // L_OBJC_LABEL_CLASS_$.
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005544
5545 for (unsigned i=0, NumClasses=ImplementedClasses.size(); i<NumClasses; i++) {
5546 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
5547 assert(ID);
5548 if (ObjCImplementationDecl *IMP = ID->getImplementation())
5549 // We are implementing a weak imported interface. Give it external linkage
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005550 if (ID->isWeakImported() && !IMP->isWeakImported()) {
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005551 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005552 DefinedMetaClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
5553 }
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005554 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005555
5556 AddModuleClassList(DefinedClasses, "OBJC_LABEL_CLASS_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005557 "__DATA, __objc_classlist, regular, no_dead_strip");
Rafael Espindola554256c2014-02-26 22:25:45 +00005558
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005559 AddModuleClassList(DefinedNonLazyClasses, "OBJC_LABEL_NONLAZY_CLASS_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005560 "__DATA, __objc_nlclslist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005561
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005562 // Build list of all implemented category addresses in array
5563 // L_OBJC_LABEL_CATEGORY_$.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005564 AddModuleClassList(DefinedCategories, "OBJC_LABEL_CATEGORY_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005565 "__DATA, __objc_catlist, regular, no_dead_strip");
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005566 AddModuleClassList(DefinedNonLazyCategories, "OBJC_LABEL_NONLAZY_CATEGORY_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005567 "__DATA, __objc_nlcatlist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005568
Daniel Dunbar5e639272010-04-25 20:39:01 +00005569 EmitImageInfo();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005570}
5571
John McCall9e8bb002011-05-14 03:10:52 +00005572/// isVTableDispatchedSelector - Returns true if SEL is not in the list of
5573/// VTableDispatchMethods; false otherwise. What this means is that
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005574/// except for the 19 selectors in the list, we generate 32bit-style
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005575/// message dispatch call for all the rest.
John McCall9e8bb002011-05-14 03:10:52 +00005576bool CGObjCNonFragileABIMac::isVTableDispatchedSelector(Selector Sel) {
5577 // At various points we've experimented with using vtable-based
5578 // dispatch for all methods.
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005579 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005580 case CodeGenOptions::Legacy:
Fariborz Jahaniandfb39832010-04-19 17:53:30 +00005581 return false;
John McCall9e8bb002011-05-14 03:10:52 +00005582 case CodeGenOptions::NonLegacy:
5583 return true;
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005584 case CodeGenOptions::Mixed:
5585 break;
5586 }
5587
5588 // If so, see whether this selector is in the white-list of things which must
5589 // use the new dispatch convention. We lazily build a dense set for this.
John McCall9e8bb002011-05-14 03:10:52 +00005590 if (VTableDispatchMethods.empty()) {
5591 VTableDispatchMethods.insert(GetNullarySelector("alloc"));
5592 VTableDispatchMethods.insert(GetNullarySelector("class"));
5593 VTableDispatchMethods.insert(GetNullarySelector("self"));
5594 VTableDispatchMethods.insert(GetNullarySelector("isFlipped"));
5595 VTableDispatchMethods.insert(GetNullarySelector("length"));
5596 VTableDispatchMethods.insert(GetNullarySelector("count"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005597
John McCall9e8bb002011-05-14 03:10:52 +00005598 // These are vtable-based if GC is disabled.
5599 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00005600 if (CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
John McCall9e8bb002011-05-14 03:10:52 +00005601 VTableDispatchMethods.insert(GetNullarySelector("retain"));
5602 VTableDispatchMethods.insert(GetNullarySelector("release"));
5603 VTableDispatchMethods.insert(GetNullarySelector("autorelease"));
5604 }
5605
5606 VTableDispatchMethods.insert(GetUnarySelector("allocWithZone"));
5607 VTableDispatchMethods.insert(GetUnarySelector("isKindOfClass"));
5608 VTableDispatchMethods.insert(GetUnarySelector("respondsToSelector"));
5609 VTableDispatchMethods.insert(GetUnarySelector("objectForKey"));
5610 VTableDispatchMethods.insert(GetUnarySelector("objectAtIndex"));
5611 VTableDispatchMethods.insert(GetUnarySelector("isEqualToString"));
5612 VTableDispatchMethods.insert(GetUnarySelector("isEqual"));
5613
5614 // These are vtable-based if GC is enabled.
5615 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00005616 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
John McCall9e8bb002011-05-14 03:10:52 +00005617 VTableDispatchMethods.insert(GetNullarySelector("hash"));
5618 VTableDispatchMethods.insert(GetUnarySelector("addObject"));
5619
5620 // "countByEnumeratingWithState:objects:count"
5621 IdentifierInfo *KeyIdents[] = {
5622 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
5623 &CGM.getContext().Idents.get("objects"),
5624 &CGM.getContext().Idents.get("count")
5625 };
5626 VTableDispatchMethods.insert(
5627 CGM.getContext().Selectors.getSelector(3, KeyIdents));
5628 }
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005629 }
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005630
John McCall9e8bb002011-05-14 03:10:52 +00005631 return VTableDispatchMethods.count(Sel);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005632}
5633
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005634/// BuildClassRoTInitializer - generate meta-data for:
5635/// struct _class_ro_t {
5636/// uint32_t const flags;
5637/// uint32_t const instanceStart;
5638/// uint32_t const instanceSize;
5639/// uint32_t const reserved; // only when building for 64bit targets
5640/// const uint8_t * const ivarLayout;
5641/// const char *const name;
5642/// const struct _method_list_t * const baseMethods;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005643/// const struct _protocol_list_t *const baseProtocols;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005644/// const struct _ivar_list_t *const ivars;
5645/// const uint8_t * const weakIvarLayout;
5646/// const struct _prop_list_t * const properties;
5647/// }
5648///
5649llvm::GlobalVariable * CGObjCNonFragileABIMac::BuildClassRoTInitializer(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005650 unsigned flags,
5651 unsigned InstanceStart,
5652 unsigned InstanceSize,
5653 const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005654 std::string ClassName = ID->getObjCRuntimeNameAsString();
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005655 llvm::Constant *Values[10]; // 11 for 64bit targets!
John McCall31168b02011-06-15 23:02:42 +00005656
John McCall3fd13f062015-10-21 18:06:47 +00005657 CharUnits beginInstance = CharUnits::fromQuantity(InstanceStart);
5658 CharUnits endInstance = CharUnits::fromQuantity(InstanceSize);
5659
David Blaikiebbafb8a2012-03-11 07:00:24 +00005660 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallef19dbb2012-10-17 04:53:23 +00005661 flags |= NonFragileABI_Class_CompiledByARC;
John McCall31168b02011-06-15 23:02:42 +00005662
Owen Andersonb7a2fe62009-07-24 23:12:58 +00005663 Values[ 0] = llvm::ConstantInt::get(ObjCTypes.IntTy, flags);
5664 Values[ 1] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceStart);
5665 Values[ 2] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceSize);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005666 // FIXME. For 64bit targets add 0 here.
John McCallef19dbb2012-10-17 04:53:23 +00005667 Values[ 3] = (flags & NonFragileABI_Class_Meta)
Craig Topper8a13c412014-05-21 05:09:00 +00005668 ? GetIvarLayoutName(nullptr, ObjCTypes)
John McCall3fd13f062015-10-21 18:06:47 +00005669 : BuildIvarLayout(ID, beginInstance, endInstance, true);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005670 Values[ 4] = GetClassName(ID->getObjCRuntimeNameAsString());
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005671 // const struct _method_list_t * const baseMethods;
5672 std::vector<llvm::Constant*> Methods;
5673 std::string MethodListName("\01l_OBJC_$_");
John McCallef19dbb2012-10-17 04:53:23 +00005674 if (flags & NonFragileABI_Class_Meta) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005675 MethodListName += "CLASS_METHODS_";
5676 MethodListName += ID->getObjCRuntimeNameAsString();
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00005677 for (const auto *I : ID->class_methods())
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005678 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00005679 Methods.push_back(GetMethodConstant(I));
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005680 } else {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005681 MethodListName += "INSTANCE_METHODS_";
5682 MethodListName += ID->getObjCRuntimeNameAsString();
Aaron Ballmanf26acce2014-03-13 19:50:17 +00005683 for (const auto *I : ID->instance_methods())
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005684 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00005685 Methods.push_back(GetMethodConstant(I));
5686
Aaron Ballmand85eff42014-03-14 15:02:45 +00005687 for (const auto *PID : ID->property_impls()) {
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00005688 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize){
5689 ObjCPropertyDecl *PD = PID->getPropertyDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005690
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00005691 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
5692 if (llvm::Constant *C = GetMethodConstant(MD))
5693 Methods.push_back(C);
5694 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
5695 if (llvm::Constant *C = GetMethodConstant(MD))
5696 Methods.push_back(C);
5697 }
5698 }
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005699 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005700 Values[ 5] = EmitMethodList(MethodListName,
5701 "__DATA, __objc_const", Methods);
5702
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005703 const ObjCInterfaceDecl *OID = ID->getClassInterface();
5704 assert(OID && "CGObjCNonFragileABIMac::BuildClassRoTInitializer");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005705 Values[ 6] = EmitProtocolList("\01l_OBJC_CLASS_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005706 + OID->getObjCRuntimeNameAsString(),
Ted Kremenek0ef508d2010-09-01 01:21:15 +00005707 OID->all_referenced_protocol_begin(),
5708 OID->all_referenced_protocol_end());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005709
John McCallef19dbb2012-10-17 04:53:23 +00005710 if (flags & NonFragileABI_Class_Meta) {
Owen Anderson0b75f232009-07-31 20:28:54 +00005711 Values[ 7] = llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +00005712 Values[ 8] = GetIvarLayoutName(nullptr, ObjCTypes);
Owen Anderson0b75f232009-07-31 20:28:54 +00005713 Values[ 9] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
John McCallef19dbb2012-10-17 04:53:23 +00005714 } else {
5715 Values[ 7] = EmitIvarList(ID);
John McCall3fd13f062015-10-21 18:06:47 +00005716 Values[ 8] = BuildIvarLayout(ID, beginInstance, endInstance, false);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005717 Values[ 9] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00005718 ID, ID->getClassInterface(), ObjCTypes);
John McCallef19dbb2012-10-17 04:53:23 +00005719 }
Owen Anderson0e0189d2009-07-27 22:29:56 +00005720 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassRonfABITy,
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005721 Values);
5722 llvm::GlobalVariable *CLASS_RO_GV =
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005723 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassRonfABITy, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005724 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005725 Init,
John McCallef19dbb2012-10-17 04:53:23 +00005726 (flags & NonFragileABI_Class_Meta) ?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005727 std::string("\01l_OBJC_METACLASS_RO_$_")+ClassName :
5728 std::string("\01l_OBJC_CLASS_RO_$_")+ClassName);
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00005729 CLASS_RO_GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00005730 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassRonfABITy));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00005731 CLASS_RO_GV->setSection("__DATA, __objc_const");
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005732 return CLASS_RO_GV;
Fariborz Jahanian2612e142009-01-26 22:58:07 +00005733
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005734}
5735
5736/// BuildClassMetaData - This routine defines that to-level meta-data
5737/// for the given ClassName for:
5738/// struct _class_t {
5739/// struct _class_t *isa;
5740/// struct _class_t * const superclass;
5741/// void *cache;
5742/// IMP *vtable;
5743/// struct class_ro_t *ro;
5744/// }
5745///
Rafael Espindola554256c2014-02-26 22:25:45 +00005746llvm::GlobalVariable *CGObjCNonFragileABIMac::BuildClassMetaData(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005747 const std::string &ClassName, llvm::Constant *IsAGV, llvm::Constant *SuperClassGV,
Rafael Espindola554256c2014-02-26 22:25:45 +00005748 llvm::Constant *ClassRoGV, bool HiddenVisibility, bool Weak) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005749 llvm::Constant *Values[] = {
5750 IsAGV,
5751 SuperClassGV,
5752 ObjCEmptyCacheVar, // &ObjCEmptyCacheVar
5753 ObjCEmptyVtableVar, // &ObjCEmptyVtableVar
5754 ClassRoGV // &CLASS_RO_GV
5755 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005756 if (!Values[1])
5757 Values[1] = llvm::Constant::getNullValue(ObjCTypes.ClassnfABIPtrTy);
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005758 if (!Values[3])
5759 Values[3] = llvm::Constant::getNullValue(
5760 llvm::PointerType::getUnqual(ObjCTypes.ImpnfABITy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005761 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassnfABITy,
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005762 Values);
Rafael Espindola554256c2014-02-26 22:25:45 +00005763 llvm::GlobalVariable *GV = GetClassGlobal(ClassName, Weak);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00005764 GV->setInitializer(Init);
Fariborz Jahanian04087232009-01-31 01:07:39 +00005765 GV->setSection("__DATA, __objc_data");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00005766 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00005767 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassnfABITy));
Fariborz Jahanian82208252009-01-31 00:59:10 +00005768 if (HiddenVisibility)
5769 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005770 return GV;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005771}
5772
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005773bool
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00005774CGObjCNonFragileABIMac::ImplementationIsNonLazy(const ObjCImplDecl *OD) const {
Craig Topper8a13c412014-05-21 05:09:00 +00005775 return OD->getClassMethod(GetNullarySelector("load")) != nullptr;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005776}
5777
Daniel Dunbar961202372009-05-03 12:57:56 +00005778void CGObjCNonFragileABIMac::GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00005779 uint32_t &InstanceStart,
5780 uint32_t &InstanceSize) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005781 const ASTRecordLayout &RL =
Daniel Dunbar9252ee12009-05-04 21:26:30 +00005782 CGM.getContext().getASTObjCImplementationLayout(OID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005783
Daniel Dunbar9b042e02009-05-04 23:23:09 +00005784 // InstanceSize is really instance end.
Ken Dyckd5090c12011-02-11 02:20:09 +00005785 InstanceSize = RL.getDataSize().getQuantity();
Daniel Dunbar9b042e02009-05-04 23:23:09 +00005786
5787 // If there are no fields, the start is the same as the end.
5788 if (!RL.getFieldCount())
5789 InstanceStart = InstanceSize;
5790 else
Ken Dyckc5ca8762011-04-14 00:43:09 +00005791 InstanceStart = RL.getFieldOffset(0) / CGM.getContext().getCharWidth();
Daniel Dunbar554fd792009-04-19 23:41:48 +00005792}
5793
Fariborz Jahanian71394042009-01-23 23:53:38 +00005794void CGObjCNonFragileABIMac::GenerateClass(const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005795 std::string ClassName = ID->getObjCRuntimeNameAsString();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005796 if (!ObjCEmptyCacheVar) {
5797 ObjCEmptyCacheVar = new llvm::GlobalVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005798 CGM.getModule(),
5799 ObjCTypes.CacheTy,
5800 false,
5801 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00005802 nullptr,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005803 "_objc_empty_cache");
Craig Topper8a13c412014-05-21 05:09:00 +00005804
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005805 // Make this entry NULL for any iOS device target, any iOS simulator target,
5806 // OS X with deployment target 10.9 or later.
5807 const llvm::Triple &Triple = CGM.getTarget().getTriple();
5808 if (Triple.isiOS() || (Triple.isMacOSX() && !Triple.isMacOSXVersionLT(10, 9)))
5809 // This entry will be null.
Craig Topper8a13c412014-05-21 05:09:00 +00005810 ObjCEmptyVtableVar = nullptr;
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005811 else
5812 ObjCEmptyVtableVar = new llvm::GlobalVariable(
5813 CGM.getModule(),
5814 ObjCTypes.ImpnfABITy,
5815 false,
5816 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00005817 nullptr,
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005818 "_objc_empty_vtable");
Fariborz Jahanian71394042009-01-23 23:53:38 +00005819 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005820 assert(ID->getClassInterface() &&
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005821 "CGObjCNonFragileABIMac::GenerateClass - class is 0");
Daniel Dunbare3f5cfc2009-04-20 20:18:54 +00005822 // FIXME: Is this correct (that meta class size is never computed)?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005823 uint32_t InstanceStart =
Micah Villmowdd31ca12012-10-08 16:25:52 +00005824 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassnfABITy);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005825 uint32_t InstanceSize = InstanceStart;
John McCallef19dbb2012-10-17 04:53:23 +00005826 uint32_t flags = NonFragileABI_Class_Meta;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005827 llvm::SmallString<64> ObjCMetaClassName(getMetaclassSymbolPrefix());
5828 llvm::SmallString<64> ObjCClassName(getClassSymbolPrefix());
5829 llvm::SmallString<64> TClassName;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005830
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005831 llvm::GlobalVariable *SuperClassGV, *IsAGV;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005832
John McCall0d54a172012-10-17 04:53:31 +00005833 // Build the flags for the metaclass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005834 bool classIsHidden =
John McCall457a04e2010-10-22 21:05:15 +00005835 ID->getClassInterface()->getVisibility() == HiddenVisibility;
Fariborz Jahanian82208252009-01-31 00:59:10 +00005836 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00005837 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00005838
5839 // FIXME: why is this flag set on the metaclass?
5840 // ObjC metaclasses have no fields and don't really get constructed.
5841 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00005842 flags |= NonFragileABI_Class_HasCXXStructors;
John McCall0d54a172012-10-17 04:53:31 +00005843 if (!ID->hasNonZeroConstructors())
5844 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
5845 }
5846
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005847 if (!ID->getClassInterface()->getSuperClass()) {
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005848 // class is root
John McCallef19dbb2012-10-17 04:53:23 +00005849 flags |= NonFragileABI_Class_Root;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005850 TClassName = ObjCClassName;
5851 TClassName += ClassName;
5852 SuperClassGV = GetClassGlobal(TClassName.str(),
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005853 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005854 TClassName = ObjCMetaClassName;
5855 TClassName += ClassName;
5856 IsAGV = GetClassGlobal(TClassName.str(),
Rafael Espindola554256c2014-02-26 22:25:45 +00005857 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005858 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005859 // Has a root. Current class is not a root.
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00005860 const ObjCInterfaceDecl *Root = ID->getClassInterface();
5861 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
5862 Root = Super;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005863 TClassName = ObjCMetaClassName ;
5864 TClassName += Root->getObjCRuntimeNameAsString();
5865 IsAGV = GetClassGlobal(TClassName.str(),
Rafael Espindola554256c2014-02-26 22:25:45 +00005866 Root->isWeakImported());
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005867
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00005868 // work on super class metadata symbol.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005869 TClassName = ObjCMetaClassName;
5870 TClassName += ID->getClassInterface()->getSuperClass()->getObjCRuntimeNameAsString();
Rafael Espindola554256c2014-02-26 22:25:45 +00005871 SuperClassGV = GetClassGlobal(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005872 TClassName.str(),
5873 ID->getClassInterface()->getSuperClass()->isWeakImported());
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005874 }
5875 llvm::GlobalVariable *CLASS_RO_GV = BuildClassRoTInitializer(flags,
5876 InstanceStart,
5877 InstanceSize,ID);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005878 TClassName = ObjCMetaClassName;
5879 TClassName += ClassName;
Rafael Espindola554256c2014-02-26 22:25:45 +00005880 llvm::GlobalVariable *MetaTClass = BuildClassMetaData(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005881 TClassName.str(), IsAGV, SuperClassGV, CLASS_RO_GV, classIsHidden,
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005882 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian67260552009-11-17 21:37:35 +00005883 DefinedMetaClasses.push_back(MetaTClass);
Daniel Dunbar15894b72009-04-07 05:48:37 +00005884
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005885 // Metadata for the class
John McCallef19dbb2012-10-17 04:53:23 +00005886 flags = 0;
Fariborz Jahanian82208252009-01-31 00:59:10 +00005887 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00005888 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00005889
5890 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00005891 flags |= NonFragileABI_Class_HasCXXStructors;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00005892
John McCall0d54a172012-10-17 04:53:31 +00005893 // Set a flag to enable a runtime optimization when a class has
5894 // fields that require destruction but which don't require
5895 // anything except zero-initialization during construction. This
5896 // is most notably true of __strong and __weak types, but you can
5897 // also imagine there being C++ types with non-trivial default
5898 // constructors that merely set all fields to null.
5899 if (!ID->hasNonZeroConstructors())
5900 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
5901 }
5902
Douglas Gregor78bd61f2009-06-18 16:11:24 +00005903 if (hasObjCExceptionAttribute(CGM.getContext(), ID->getClassInterface()))
John McCallef19dbb2012-10-17 04:53:23 +00005904 flags |= NonFragileABI_Class_Exception;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00005905
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005906 if (!ID->getClassInterface()->getSuperClass()) {
John McCallef19dbb2012-10-17 04:53:23 +00005907 flags |= NonFragileABI_Class_Root;
Craig Topper8a13c412014-05-21 05:09:00 +00005908 SuperClassGV = nullptr;
Chris Lattnerb433b272009-04-19 06:02:28 +00005909 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005910 // Has a root. Current class is not a root.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005911 TClassName = ObjCClassName;
5912 TClassName += ID->getClassInterface()->getSuperClass()->getObjCRuntimeNameAsString();
Rafael Espindola554256c2014-02-26 22:25:45 +00005913 SuperClassGV = GetClassGlobal(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005914 TClassName.str(),
5915 ID->getClassInterface()->getSuperClass()->isWeakImported());
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005916 }
Daniel Dunbar961202372009-05-03 12:57:56 +00005917 GetClassSizeInfo(ID, InstanceStart, InstanceSize);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005918 CLASS_RO_GV = BuildClassRoTInitializer(flags,
Fariborz Jahaniana887e632009-01-24 23:43:01 +00005919 InstanceStart,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005920 InstanceSize,
Fariborz Jahaniana887e632009-01-24 23:43:01 +00005921 ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005922
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005923 TClassName = ObjCClassName;
5924 TClassName += ClassName;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005925 llvm::GlobalVariable *ClassMD =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005926 BuildClassMetaData(TClassName.str(), MetaTClass, SuperClassGV, CLASS_RO_GV,
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005927 classIsHidden,
5928 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005929 DefinedClasses.push_back(ClassMD);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005930 ImplementedClasses.push_back(ID->getClassInterface());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00005931
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005932 // Determine if this class is also "non-lazy".
5933 if (ImplementationIsNonLazy(ID))
5934 DefinedNonLazyClasses.push_back(ClassMD);
5935
Daniel Dunbar8f28d012009-04-08 04:21:03 +00005936 // Force the definition of the EHType if necessary.
John McCallef19dbb2012-10-17 04:53:23 +00005937 if (flags & NonFragileABI_Class_Exception)
Daniel Dunbar8f28d012009-04-08 04:21:03 +00005938 GetInterfaceEHType(ID->getClassInterface(), true);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00005939 // Make sure method definition entries are all clear for next implementation.
5940 MethodDefinitions.clear();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005941}
5942
Fariborz Jahanian097feda2009-01-30 18:58:59 +00005943/// GenerateProtocolRef - This routine is called to generate code for
5944/// a protocol reference expression; as in:
5945/// @code
5946/// @protocol(Proto1);
5947/// @endcode
5948/// It generates a weak reference to l_OBJC_PROTOCOL_REFERENCE_$_Proto1
5949/// which will hold address of the protocol meta-data.
5950///
John McCall882987f2013-02-28 19:01:20 +00005951llvm::Value *CGObjCNonFragileABIMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005952 const ObjCProtocolDecl *PD) {
5953
Fariborz Jahanian464423d2009-04-10 18:47:34 +00005954 // This routine is called for @protocol only. So, we must build definition
5955 // of protocol's meta-data (not a reference to it!)
5956 //
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005957 llvm::Constant *Init =
5958 llvm::ConstantExpr::getBitCast(GetOrEmitProtocol(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00005959 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005960
Fariborz Jahanian097feda2009-01-30 18:58:59 +00005961 std::string ProtocolName("\01l_OBJC_PROTOCOL_REFERENCE_$_");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005962 ProtocolName += PD->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005963
John McCall7f416cc2015-09-08 08:05:57 +00005964 CharUnits Align = CGF.getPointerAlign();
5965
Fariborz Jahanian097feda2009-01-30 18:58:59 +00005966 llvm::GlobalVariable *PTGV = CGM.getModule().getGlobalVariable(ProtocolName);
5967 if (PTGV)
John McCall7f416cc2015-09-08 08:05:57 +00005968 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00005969 PTGV = new llvm::GlobalVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005970 CGM.getModule(),
5971 Init->getType(), false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00005972 llvm::GlobalValue::WeakAnyLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005973 Init,
5974 ProtocolName);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00005975 PTGV->setSection("__DATA, __objc_protorefs, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00005976 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall7f416cc2015-09-08 08:05:57 +00005977 PTGV->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00005978 CGM.addCompilerUsedGlobal(PTGV);
John McCall7f416cc2015-09-08 08:05:57 +00005979 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00005980}
5981
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00005982/// GenerateCategory - Build metadata for a category implementation.
5983/// struct _category_t {
5984/// const char * const name;
5985/// struct _class_t *const cls;
5986/// const struct _method_list_t * const instance_methods;
5987/// const struct _method_list_t * const class_methods;
5988/// const struct _protocol_list_t * const protocols;
5989/// const struct _prop_list_t * const properties;
5990/// }
5991///
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005992void CGObjCNonFragileABIMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00005993 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Fariborz Jahanian2612e142009-01-26 22:58:07 +00005994 const char *Prefix = "\01l_OBJC_$_CATEGORY_";
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005995
5996 llvm::SmallString<64> ExtCatName(Prefix);
5997 ExtCatName += Interface->getObjCRuntimeNameAsString();
5998 ExtCatName += "_$_";
5999 ExtCatName += OCD->getNameAsString();
6000
6001 llvm::SmallString<64> ExtClassName(getClassSymbolPrefix());
6002 ExtClassName += Interface->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006003
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006004 llvm::Constant *Values[6];
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006005 Values[0] = GetClassName(OCD->getIdentifier()->getName());
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006006 // meta-class entry symbol
Rafael Espindola554256c2014-02-26 22:25:45 +00006007 llvm::GlobalVariable *ClassGV =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006008 GetClassGlobal(ExtClassName.str(), Interface->isWeakImported());
Rafael Espindola554256c2014-02-26 22:25:45 +00006009
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006010 Values[1] = ClassGV;
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006011 std::vector<llvm::Constant*> Methods;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006012 llvm::SmallString<64> MethodListName(Prefix);
6013
6014 MethodListName += "INSTANCE_METHODS_";
6015 MethodListName += Interface->getObjCRuntimeNameAsString();
6016 MethodListName += "_$_";
6017 MethodListName += OCD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006018
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006019 for (const auto *I : OCD->instance_methods())
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006020 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006021 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006022
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006023 Values[2] = EmitMethodList(MethodListName.str(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006024 "__DATA, __objc_const",
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006025 Methods);
6026
6027 MethodListName = Prefix;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006028 MethodListName += "CLASS_METHODS_";
6029 MethodListName += Interface->getObjCRuntimeNameAsString();
6030 MethodListName += "_$_";
6031 MethodListName += OCD->getNameAsString();
6032
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006033 Methods.clear();
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006034 for (const auto *I : OCD->class_methods())
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006035 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006036 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006037
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006038 Values[3] = EmitMethodList(MethodListName.str(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006039 "__DATA, __objc_const",
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006040 Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006041 const ObjCCategoryDecl *Category =
Fariborz Jahanian066347e2009-01-28 22:18:42 +00006042 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006043 if (Category) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006044 SmallString<256> ExtName;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006045 llvm::raw_svector_ostream(ExtName) << Interface->getObjCRuntimeNameAsString() << "_$_"
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006046 << OCD->getName();
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006047 Values[4] = EmitProtocolList("\01l_OBJC_CATEGORY_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006048 + Interface->getObjCRuntimeNameAsString() + "_$_"
6049 + Category->getName(),
6050 Category->protocol_begin(),
6051 Category->protocol_end());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006052 Values[5] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
6053 OCD, Category, ObjCTypes);
Mike Stump658fe022009-07-30 22:28:39 +00006054 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00006055 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
6056 Values[5] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006057 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006058
6059 llvm::Constant *Init =
6060 llvm::ConstantStruct::get(ObjCTypes.CategorynfABITy,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006061 Values);
6062 llvm::GlobalVariable *GCATV
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006063 = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.CategorynfABITy,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006064 false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006065 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006066 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006067 ExtCatName.str());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006068 GCATV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006069 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.CategorynfABITy));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006070 GCATV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006071 CGM.addCompilerUsedGlobal(GCATV);
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006072 DefinedCategories.push_back(GCATV);
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006073
6074 // Determine if this category is also "non-lazy".
6075 if (ImplementationIsNonLazy(OCD))
6076 DefinedNonLazyCategories.push_back(GCATV);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006077 // method definition entries must be clear for next implementation.
6078 MethodDefinitions.clear();
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006079}
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006080
6081/// GetMethodConstant - Return a struct objc_method constant for the
6082/// given method if it has been defined. The result is null if the
6083/// method has not been defined. The return value has type MethodPtrTy.
6084llvm::Constant *CGObjCNonFragileABIMac::GetMethodConstant(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006085 const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00006086 llvm::Function *Fn = GetMethodDefinition(MD);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006087 if (!Fn)
Craig Topper8a13c412014-05-21 05:09:00 +00006088 return nullptr;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006089
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006090 llvm::Constant *Method[] = {
Owen Andersonade90fd2009-07-29 18:54:39 +00006091 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006092 ObjCTypes.SelectorPtrTy),
6093 GetMethodVarType(MD),
6094 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
6095 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00006096 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006097}
6098
6099/// EmitMethodList - Build meta-data for method declarations
6100/// struct _method_list_t {
6101/// uint32_t entsize; // sizeof(struct _objc_method)
6102/// uint32_t method_count;
6103/// struct _objc_method method_list[method_count];
6104/// }
6105///
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00006106llvm::Constant *
6107CGObjCNonFragileABIMac::EmitMethodList(Twine Name,
6108 const char *Section,
6109 ArrayRef<llvm::Constant*> Methods) {
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006110 // Return null for empty list.
6111 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006112 return llvm::Constant::getNullValue(ObjCTypes.MethodListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006113
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006114 llvm::Constant *Values[3];
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006115 // sizeof(struct _objc_method)
Micah Villmowdd31ca12012-10-08 16:25:52 +00006116 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.MethodTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006117 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006118 // method_count
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006119 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00006120 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006121 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00006122 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006123 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006124
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006125 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006126 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006127 llvm::GlobalValue::PrivateLinkage, Init, Name);
Micah Villmowdd31ca12012-10-08 16:25:52 +00006128 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006129 GV->setSection(Section);
Rafael Espindola060062a2014-03-06 22:15:10 +00006130 CGM.addCompilerUsedGlobal(GV);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006131 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListnfABIPtrTy);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006132}
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006133
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006134/// ObjCIvarOffsetVariable - Returns the ivar offset variable for
6135/// the given ivar.
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006136llvm::GlobalVariable *
6137CGObjCNonFragileABIMac::ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
6138 const ObjCIvarDecl *Ivar) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006139
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006140 const ObjCInterfaceDecl *Container = Ivar->getContainingInterface();
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006141 llvm::SmallString<64> Name("OBJC_IVAR_$_");
6142 Name += Container->getObjCRuntimeNameAsString();
6143 Name += ".";
6144 Name += Ivar->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006145 llvm::GlobalVariable *IvarOffsetGV =
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006146 CGM.getModule().getGlobalVariable(Name);
6147 if (!IvarOffsetGV)
Tim Northover238b5082014-03-29 13:42:40 +00006148 IvarOffsetGV = new llvm::GlobalVariable(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006149 CGM.getModule(), ObjCTypes.IvarOffsetVarTy, false,
6150 llvm::GlobalValue::ExternalLinkage, nullptr, Name.str());
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006151 return IvarOffsetGV;
6152}
6153
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006154llvm::Constant *
6155CGObjCNonFragileABIMac::EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
6156 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00006157 unsigned long int Offset) {
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006158 llvm::GlobalVariable *IvarOffsetGV = ObjCIvarOffsetVariable(ID, Ivar);
Tim Northover238b5082014-03-29 13:42:40 +00006159 IvarOffsetGV->setInitializer(
6160 llvm::ConstantInt::get(ObjCTypes.IvarOffsetVarTy, Offset));
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006161 IvarOffsetGV->setAlignment(
Tim Northover238b5082014-03-29 13:42:40 +00006162 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.IvarOffsetVarTy));
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006163
Mike Stump18bb9282009-05-16 07:57:57 +00006164 // FIXME: This matches gcc, but shouldn't the visibility be set on the use as
6165 // well (i.e., in ObjCIvarOffsetVariable).
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006166 if (Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6167 Ivar->getAccessControl() == ObjCIvarDecl::Package ||
John McCall457a04e2010-10-22 21:05:15 +00006168 ID->getVisibility() == HiddenVisibility)
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00006169 IvarOffsetGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Daniel Dunbarf5f359f2009-04-14 06:00:08 +00006170 else
Fariborz Jahanianbc3c77b2009-04-06 18:30:00 +00006171 IvarOffsetGV->setVisibility(llvm::GlobalValue::DefaultVisibility);
Bill Wendlingf7d45982011-05-04 21:37:25 +00006172 IvarOffsetGV->setSection("__DATA, __objc_ivar");
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006173 return IvarOffsetGV;
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006174}
6175
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006176/// EmitIvarList - Emit the ivar list for the given
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006177/// implementation. The return value has type
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006178/// IvarListnfABIPtrTy.
6179/// struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00006180/// unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006181/// char *name;
6182/// char *type;
6183/// uint32_t alignment;
6184/// uint32_t size;
6185/// }
6186/// struct _ivar_list_t {
6187/// uint32 entsize; // sizeof(struct _ivar_t)
6188/// uint32 count;
6189/// struct _iver_t list[count];
6190/// }
6191///
Daniel Dunbarf5c18462009-04-20 06:54:31 +00006192
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006193llvm::Constant *CGObjCNonFragileABIMac::EmitIvarList(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006194 const ObjCImplementationDecl *ID) {
6195
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006196 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006197
Jordy Rosea91768e2011-07-22 02:08:32 +00006198 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006199 assert(OID && "CGObjCNonFragileABIMac::EmitIvarList - null interface");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006200
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006201 // FIXME. Consolidate this with similar code in GenerateClass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006202
Jordy Rosea91768e2011-07-22 02:08:32 +00006203 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00006204 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00006205 // Ignore unnamed bit-fields.
6206 if (!IVD->getDeclName())
6207 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006208 llvm::Constant *Ivar[5];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006209 Ivar[0] = EmitIvarOffsetVar(ID->getClassInterface(), IVD,
Daniel Dunbar961202372009-05-03 12:57:56 +00006210 ComputeIvarBaseOffset(CGM, ID, IVD));
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006211 Ivar[1] = GetMethodVarName(IVD->getIdentifier());
6212 Ivar[2] = GetMethodVarType(IVD);
Chris Lattner2192fe52011-07-18 04:24:23 +00006213 llvm::Type *FieldTy =
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006214 CGM.getTypes().ConvertTypeForMem(IVD->getType());
Micah Villmowdd31ca12012-10-08 16:25:52 +00006215 unsigned Size = CGM.getDataLayout().getTypeAllocSize(FieldTy);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006216 unsigned Align = CGM.getContext().getPreferredTypeAlign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006217 IVD->getType().getTypePtr()) >> 3;
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006218 Align = llvm::Log2_32(Align);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006219 Ivar[3] = llvm::ConstantInt::get(ObjCTypes.IntTy, Align);
Daniel Dunbarae032262009-04-20 00:33:43 +00006220 // NOTE. Size of a bitfield does not match gcc's, because of the
6221 // way bitfields are treated special in each. But I am told that
6222 // 'size' for bitfield ivars is ignored by the runtime so it does
6223 // not matter. If it matters, there is enough info to get the
6224 // bitfield right!
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006225 Ivar[4] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson0e0189d2009-07-27 22:29:56 +00006226 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarnfABITy, Ivar));
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006227 }
6228 // Return null for empty list.
6229 if (Ivars.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006230 return llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006231
6232 llvm::Constant *Values[3];
Micah Villmowdd31ca12012-10-08 16:25:52 +00006233 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.IvarnfABITy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006234 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
6235 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00006236 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarnfABITy,
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006237 Ivars.size());
Owen Anderson47034e12009-07-28 18:33:04 +00006238 Values[2] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006239 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006240 const char *Prefix = "\01l_OBJC_$_INSTANCE_VARIABLES_";
6241 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006242 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006243 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006244 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006245 Prefix + OID->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006246 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006247 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006248 GV->setSection("__DATA, __objc_const");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006249
Rafael Espindola060062a2014-03-06 22:15:10 +00006250 CGM.addCompilerUsedGlobal(GV);
Owen Andersonade90fd2009-07-29 18:54:39 +00006251 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006252}
6253
6254llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocolRef(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006255 const ObjCProtocolDecl *PD) {
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006256 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006257
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006258 if (!Entry) {
6259 // We use the initializer as a marker of whether this is a forward
6260 // reference or not. At module finalization we add the empty
6261 // contents for protocols which were referenced but never defined.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006262 Entry =
Rafael Espindola5d117f32014-03-06 01:10:46 +00006263 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Rafael Espindola24615092014-09-12 20:14:20 +00006264 false, llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00006265 nullptr,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006266 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006267 Entry->setSection("__DATA,__datacoal_nt,coalesced");
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006268 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006269
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006270 return Entry;
6271}
6272
6273/// GetOrEmitProtocol - Generate the protocol meta-data:
6274/// @code
6275/// struct _protocol_t {
6276/// id isa; // NULL
6277/// const char * const protocol_name;
6278/// const struct _protocol_list_t * protocol_list; // super protocols
6279/// const struct method_list_t * const instance_methods;
6280/// const struct method_list_t * const class_methods;
6281/// const struct method_list_t *optionalInstanceMethods;
6282/// const struct method_list_t *optionalClassMethods;
6283/// const struct _prop_list_t * properties;
6284/// const uint32_t size; // sizeof(struct _protocol_t)
6285/// const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006286/// const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006287/// const char *demangledName;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006288/// }
6289/// @endcode
6290///
6291
6292llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocol(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006293 const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00006294 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006295
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006296 // Early exit if a defining object has already been generated.
6297 if (Entry && Entry->hasInitializer())
6298 return Entry;
6299
Douglas Gregora715bff2012-01-01 19:51:50 +00006300 // Use the protocol definition, if there is one.
6301 if (const ObjCProtocolDecl *Def = PD->getDefinition())
6302 PD = Def;
6303
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006304 // Construct method lists.
6305 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
6306 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006307 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006308 for (const auto *MD : PD->instance_methods()) {
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006309 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006310 if (!C)
6311 return GetOrEmitProtocolRef(PD);
6312
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006313 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6314 OptInstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006315 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006316 } else {
6317 InstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006318 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006319 }
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006320 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006321
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006322 for (const auto *MD : PD->class_methods()) {
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006323 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006324 if (!C)
6325 return GetOrEmitProtocolRef(PD);
6326
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006327 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6328 OptClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006329 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006330 } else {
6331 ClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006332 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006333 }
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006334 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006335
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006336 MethodTypesExt.insert(MethodTypesExt.end(),
6337 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
6338
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006339 llvm::Constant *Values[12];
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006340 // isa is NULL
Owen Anderson0b75f232009-07-31 20:28:54 +00006341 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ObjectPtrTy);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006342 Values[1] = GetClassName(PD->getObjCRuntimeNameAsString());
6343 Values[2] = EmitProtocolList("\01l_OBJC_$_PROTOCOL_REFS_" + PD->getObjCRuntimeNameAsString(),
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006344 PD->protocol_begin(),
6345 PD->protocol_end());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006346
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006347 Values[3] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006348 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006349 "__DATA, __objc_const",
6350 InstanceMethods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006351 Values[4] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006352 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006353 "__DATA, __objc_const",
6354 ClassMethods);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006355 Values[5] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_OPT_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006356 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006357 "__DATA, __objc_const",
6358 OptInstanceMethods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006359 Values[6] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_OPT_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006360 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006361 "__DATA, __objc_const",
6362 OptClassMethods);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006363 Values[7] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
Craig Topper8a13c412014-05-21 05:09:00 +00006364 nullptr, PD, ObjCTypes);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006365 uint32_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006366 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolnfABITy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006367 Values[8] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson0b75f232009-07-31 20:28:54 +00006368 Values[9] = llvm::Constant::getNullValue(ObjCTypes.IntTy);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006369 Values[10] = EmitProtocolMethodTypes("\01l_OBJC_$_PROTOCOL_METHOD_TYPES_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006370 + PD->getObjCRuntimeNameAsString(),
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006371 MethodTypesExt, ObjCTypes);
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006372 // const char *demangledName;
6373 Values[11] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
6374
Owen Anderson0e0189d2009-07-27 22:29:56 +00006375 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolnfABITy,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006376 Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006377
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006378 if (Entry) {
Rafael Espindola24615092014-09-12 20:14:20 +00006379 // Already created, fix the linkage and update the initializer.
6380 Entry->setLinkage(llvm::GlobalValue::WeakAnyLinkage);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006381 Entry->setInitializer(Init);
6382 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006383 Entry =
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006384 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006385 false, llvm::GlobalValue::WeakAnyLinkage, Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006386 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006387 Entry->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006388 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABITy));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006389 Entry->setSection("__DATA,__datacoal_nt,coalesced");
John McCallf9582a72012-03-30 21:29:05 +00006390
6391 Protocols[PD->getIdentifier()] = Entry;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006392 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006393 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006394 CGM.addCompilerUsedGlobal(Entry);
Chris Lattnerf56501c2009-07-17 23:57:13 +00006395
Fariborz Jahanian61cd4b52009-01-29 20:10:59 +00006396 // Use this protocol meta-data to build protocol list table in section
6397 // __DATA, __objc_protolist
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006398 llvm::GlobalVariable *PTGV =
6399 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABIPtrTy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006400 false, llvm::GlobalValue::WeakAnyLinkage, Entry,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006401 "\01l_OBJC_LABEL_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006402 PTGV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006403 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABIPtrTy));
Daniel Dunbarb25452a2009-04-15 02:56:18 +00006404 PTGV->setSection("__DATA, __objc_protolist, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006405 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006406 CGM.addCompilerUsedGlobal(PTGV);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006407 return Entry;
6408}
6409
6410/// EmitProtocolList - Generate protocol list meta-data:
6411/// @code
6412/// struct _protocol_list_t {
6413/// long protocol_count; // Note, this is 32/64 bit
6414/// struct _protocol_t[protocol_count];
6415/// }
6416/// @endcode
6417///
6418llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00006419CGObjCNonFragileABIMac::EmitProtocolList(Twine Name,
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006420 ObjCProtocolDecl::protocol_iterator begin,
6421 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006422 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006423
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006424 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006425 if (begin == end)
Owen Anderson0b75f232009-07-31 20:28:54 +00006426 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006427
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006428 // FIXME: We shouldn't need to do this lookup here, should we?
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006429 SmallString<256> TmpName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006430 Name.toVector(TmpName);
6431 llvm::GlobalVariable *GV =
6432 CGM.getModule().getGlobalVariable(TmpName.str(), true);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006433 if (GV)
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006434 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006435
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006436 for (; begin != end; ++begin)
6437 ProtocolRefs.push_back(GetProtocolRef(*begin)); // Implemented???
6438
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006439 // This list is null terminated.
Owen Anderson0b75f232009-07-31 20:28:54 +00006440 ProtocolRefs.push_back(llvm::Constant::getNullValue(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006441 ObjCTypes.ProtocolnfABIPtrTy));
6442
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006443 llvm::Constant *Values[2];
Owen Anderson170229f2009-07-14 23:10:40 +00006444 Values[0] =
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006445 llvm::ConstantInt::get(ObjCTypes.LongTy, ProtocolRefs.size() - 1);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006446 Values[1] =
Bill Wendlinga515b582012-02-09 22:16:49 +00006447 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolnfABIPtrTy,
6448 ProtocolRefs.size()),
6449 ProtocolRefs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006450
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006451 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Owen Andersonc10c8d32009-07-08 19:05:04 +00006452 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006453 llvm::GlobalValue::PrivateLinkage,
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006454 Init, Name);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006455 GV->setSection("__DATA, __objc_const");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006456 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006457 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Rafael Espindola060062a2014-03-06 22:15:10 +00006458 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006459 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006460 ObjCTypes.ProtocolListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006461}
6462
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006463/// GetMethodDescriptionConstant - This routine build following meta-data:
6464/// struct _objc_method {
6465/// SEL _cmd;
6466/// char *method_type;
6467/// char *_imp;
6468/// }
6469
6470llvm::Constant *
6471CGObjCNonFragileABIMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006472 llvm::Constant *Desc[3];
Owen Anderson170229f2009-07-14 23:10:40 +00006473 Desc[0] =
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006474 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
6475 ObjCTypes.SelectorPtrTy);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006476 Desc[1] = GetMethodVarType(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006477 if (!Desc[1])
Craig Topper8a13c412014-05-21 05:09:00 +00006478 return nullptr;
6479
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006480 // Protocol methods have no implementation. So, this entry is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00006481 Desc[2] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00006482 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Desc);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006483}
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006484
6485/// EmitObjCValueForIvar - Code Gen for nonfragile ivar reference.
6486/// This code gen. amounts to generating code for:
6487/// @code
6488/// (type *)((char *)base + _OBJC_IVAR_$_.ivar;
6489/// @encode
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006490///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00006491LValue CGObjCNonFragileABIMac::EmitObjCValueForIvar(
John McCall96fa4842010-05-17 21:00:27 +00006492 CodeGen::CodeGenFunction &CGF,
6493 QualType ObjectTy,
6494 llvm::Value *BaseValue,
6495 const ObjCIvarDecl *Ivar,
6496 unsigned CVRQualifiers) {
6497 ObjCInterfaceDecl *ID = ObjectTy->getAs<ObjCObjectType>()->getInterface();
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006498 llvm::Value *Offset = EmitIvarOffset(CGF, ID, Ivar);
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00006499 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006500 Offset);
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006501}
6502
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006503llvm::Value *CGObjCNonFragileABIMac::EmitIvarOffset(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006504 CodeGen::CodeGenFunction &CGF,
6505 const ObjCInterfaceDecl *Interface,
6506 const ObjCIvarDecl *Ivar) {
Tim Northover238b5082014-03-29 13:42:40 +00006507 llvm::Value *IvarOffsetValue = ObjCIvarOffsetVariable(Interface, Ivar);
John McCall7f416cc2015-09-08 08:05:57 +00006508 IvarOffsetValue = CGF.Builder.CreateAlignedLoad(IvarOffsetValue,
6509 CGF.getSizeAlign(), "ivar");
Tim Northover238b5082014-03-29 13:42:40 +00006510 if (IsIvarOffsetKnownIdempotent(CGF, Ivar))
6511 cast<llvm::LoadInst>(IvarOffsetValue)
6512 ->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
Craig Topper5fc8fc22014-08-27 06:28:36 +00006513 llvm::MDNode::get(VMContext, None));
Tim Northover238b5082014-03-29 13:42:40 +00006514
6515 // This could be 32bit int or 64bit integer depending on the architecture.
6516 // Cast it to 64bit integer value, if it is a 32bit integer ivar offset value
6517 // as this is what caller always expectes.
6518 if (ObjCTypes.IvarOffsetVarTy == ObjCTypes.IntTy)
6519 IvarOffsetValue = CGF.Builder.CreateIntCast(
6520 IvarOffsetValue, ObjCTypes.LongTy, true, "ivar.conv");
6521 return IvarOffsetValue;
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006522}
6523
John McCall234eac82011-05-13 23:16:18 +00006524static void appendSelectorForMessageRefTable(std::string &buffer,
6525 Selector selector) {
6526 if (selector.isUnarySelector()) {
6527 buffer += selector.getNameForSlot(0);
6528 return;
6529 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006530
John McCall234eac82011-05-13 23:16:18 +00006531 for (unsigned i = 0, e = selector.getNumArgs(); i != e; ++i) {
6532 buffer += selector.getNameForSlot(i);
6533 buffer += '_';
6534 }
6535}
6536
John McCall9e8bb002011-05-14 03:10:52 +00006537/// Emit a "v-table" message send. We emit a weak hidden-visibility
6538/// struct, initially containing the selector pointer and a pointer to
6539/// a "fixup" variant of the appropriate objc_msgSend. To call, we
6540/// load and call the function pointer, passing the address of the
6541/// struct as the second parameter. The runtime determines whether
6542/// the selector is currently emitted using vtable dispatch; if so, it
6543/// substitutes a stub function which simply tail-calls through the
6544/// appropriate vtable slot, and if not, it substitues a stub function
6545/// which tail-calls objc_msgSend. Both stubs adjust the selector
6546/// argument to correctly point to the selector.
6547RValue
6548CGObjCNonFragileABIMac::EmitVTableMessageSend(CodeGenFunction &CGF,
6549 ReturnValueSlot returnSlot,
6550 QualType resultType,
6551 Selector selector,
6552 llvm::Value *arg0,
6553 QualType arg0Type,
6554 bool isSuper,
6555 const CallArgList &formalArgs,
6556 const ObjCMethodDecl *method) {
John McCall234eac82011-05-13 23:16:18 +00006557 // Compute the actual arguments.
6558 CallArgList args;
6559
John McCall9e8bb002011-05-14 03:10:52 +00006560 // First argument: the receiver / super-call structure.
John McCall234eac82011-05-13 23:16:18 +00006561 if (!isSuper)
John McCall9e8bb002011-05-14 03:10:52 +00006562 arg0 = CGF.Builder.CreateBitCast(arg0, ObjCTypes.ObjectPtrTy);
6563 args.add(RValue::get(arg0), arg0Type);
John McCall234eac82011-05-13 23:16:18 +00006564
John McCall9e8bb002011-05-14 03:10:52 +00006565 // Second argument: a pointer to the message ref structure. Leave
6566 // the actual argument value blank for now.
Craig Topper8a13c412014-05-21 05:09:00 +00006567 args.add(RValue::get(nullptr), ObjCTypes.MessageRefCPtrTy);
John McCall234eac82011-05-13 23:16:18 +00006568
6569 args.insert(args.end(), formalArgs.begin(), formalArgs.end());
6570
John McCalla729c622012-02-17 03:33:10 +00006571 MessageSendInfo MSI = getMessageSendInfo(method, resultType, args);
John McCall234eac82011-05-13 23:16:18 +00006572
John McCall5880fb82011-05-14 21:12:11 +00006573 NullReturnState nullReturn;
6574
John McCall9e8bb002011-05-14 03:10:52 +00006575 // Find the function to call and the mangled name for the message
6576 // ref structure. Using a different mangled name wouldn't actually
6577 // be a problem; it would just be a waste.
6578 //
6579 // The runtime currently never uses vtable dispatch for anything
6580 // except normal, non-super message-sends.
6581 // FIXME: don't use this for that.
Craig Topper8a13c412014-05-21 05:09:00 +00006582 llvm::Constant *fn = nullptr;
John McCall234eac82011-05-13 23:16:18 +00006583 std::string messageRefName("\01l_");
Tim Northovere77cc392014-03-29 13:28:05 +00006584 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall234eac82011-05-13 23:16:18 +00006585 if (isSuper) {
6586 fn = ObjCTypes.getMessageSendSuper2StretFixupFn();
6587 messageRefName += "objc_msgSendSuper2_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006588 } else {
John McCall5880fb82011-05-14 21:12:11 +00006589 nullReturn.init(CGF, arg0);
John McCall234eac82011-05-13 23:16:18 +00006590 fn = ObjCTypes.getMessageSendStretFixupFn();
6591 messageRefName += "objc_msgSend_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006592 }
John McCall234eac82011-05-13 23:16:18 +00006593 } else if (!isSuper && CGM.ReturnTypeUsesFPRet(resultType)) {
6594 fn = ObjCTypes.getMessageSendFpretFixupFn();
6595 messageRefName += "objc_msgSend_fpret_fixup";
Mike Stump658fe022009-07-30 22:28:39 +00006596 } else {
John McCall234eac82011-05-13 23:16:18 +00006597 if (isSuper) {
6598 fn = ObjCTypes.getMessageSendSuper2FixupFn();
6599 messageRefName += "objc_msgSendSuper2_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006600 } else {
John McCall234eac82011-05-13 23:16:18 +00006601 fn = ObjCTypes.getMessageSendFixupFn();
6602 messageRefName += "objc_msgSend_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006603 }
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00006604 }
John McCall234eac82011-05-13 23:16:18 +00006605 assert(fn && "CGObjCNonFragileABIMac::EmitMessageSend");
6606 messageRefName += '_';
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006607
John McCall234eac82011-05-13 23:16:18 +00006608 // Append the selector name, except use underscores anywhere we
6609 // would have used colons.
6610 appendSelectorForMessageRefTable(messageRefName, selector);
6611
6612 llvm::GlobalVariable *messageRef
6613 = CGM.getModule().getGlobalVariable(messageRefName);
6614 if (!messageRef) {
John McCall9e8bb002011-05-14 03:10:52 +00006615 // Build the message ref structure.
John McCall234eac82011-05-13 23:16:18 +00006616 llvm::Constant *values[] = { fn, GetMethodVarName(selector) };
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006617 llvm::Constant *init = llvm::ConstantStruct::getAnon(values);
John McCall234eac82011-05-13 23:16:18 +00006618 messageRef = new llvm::GlobalVariable(CGM.getModule(),
6619 init->getType(),
6620 /*constant*/ false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006621 llvm::GlobalValue::WeakAnyLinkage,
John McCall234eac82011-05-13 23:16:18 +00006622 init,
6623 messageRefName);
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006624 messageRef->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall234eac82011-05-13 23:16:18 +00006625 messageRef->setAlignment(16);
6626 messageRef->setSection("__DATA, __objc_msgrefs, coalesced");
6627 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006628
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00006629 bool requiresnullCheck = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00006630 if (CGM.getLangOpts().ObjCAutoRefCount && method)
Aaron Ballman43b68be2014-03-07 17:50:17 +00006631 for (const auto *ParamDecl : method->params()) {
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00006632 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
6633 if (!nullReturn.NullBB)
6634 nullReturn.init(CGF, arg0);
6635 requiresnullCheck = true;
6636 break;
6637 }
6638 }
6639
John McCall7f416cc2015-09-08 08:05:57 +00006640 Address mref =
6641 Address(CGF.Builder.CreateBitCast(messageRef, ObjCTypes.MessageRefPtrTy),
6642 CGF.getPointerAlign());
John McCall234eac82011-05-13 23:16:18 +00006643
John McCall9e8bb002011-05-14 03:10:52 +00006644 // Update the message ref argument.
John McCall7f416cc2015-09-08 08:05:57 +00006645 args[1].RV = RValue::get(mref.getPointer());
John McCall234eac82011-05-13 23:16:18 +00006646
6647 // Load the function to call from the message ref table.
John McCall7f416cc2015-09-08 08:05:57 +00006648 Address calleeAddr =
6649 CGF.Builder.CreateStructGEP(mref, 0, CharUnits::Zero());
6650 llvm::Value *callee = CGF.Builder.CreateLoad(calleeAddr, "msgSend_fn");
John McCall234eac82011-05-13 23:16:18 +00006651
John McCalla729c622012-02-17 03:33:10 +00006652 callee = CGF.Builder.CreateBitCast(callee, MSI.MessengerType);
John McCall234eac82011-05-13 23:16:18 +00006653
John McCalla729c622012-02-17 03:33:10 +00006654 RValue result = CGF.EmitCall(MSI.CallInfo, callee, returnSlot, args);
Craig Topper8a13c412014-05-21 05:09:00 +00006655 return nullReturn.complete(CGF, result, resultType, formalArgs,
6656 requiresnullCheck ? method : nullptr);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00006657}
6658
6659/// Generate code for a message send expression in the nonfragile abi.
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006660CodeGen::RValue
6661CGObjCNonFragileABIMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00006662 ReturnValueSlot Return,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006663 QualType ResultType,
6664 Selector Sel,
6665 llvm::Value *Receiver,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006666 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00006667 const ObjCInterfaceDecl *Class,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006668 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00006669 return isVTableDispatchedSelector(Sel)
6670 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006671 Receiver, CGF.getContext().getObjCIdType(),
John McCall9e8bb002011-05-14 03:10:52 +00006672 false, CallArgs, Method)
6673 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00006674 EmitSelector(CGF, Sel),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006675 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00006676 false, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00006677}
6678
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006679llvm::GlobalVariable *
Rafael Espindola554256c2014-02-26 22:25:45 +00006680CGObjCNonFragileABIMac::GetClassGlobal(const std::string &Name, bool Weak) {
6681 llvm::GlobalValue::LinkageTypes L =
6682 Weak ? llvm::GlobalValue::ExternalWeakLinkage
6683 : llvm::GlobalValue::ExternalLinkage;
6684
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006685 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
6686
Rafael Espindola554256c2014-02-26 22:25:45 +00006687 if (!GV)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006688 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABITy,
Craig Topper8a13c412014-05-21 05:09:00 +00006689 false, L, nullptr, Name);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006690
Rafael Espindola554256c2014-02-26 22:25:45 +00006691 assert(GV->getLinkage() == L);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006692 return GV;
6693}
6694
John McCall882987f2013-02-28 19:01:20 +00006695llvm::Value *CGObjCNonFragileABIMac::EmitClassRefFromId(CodeGenFunction &CGF,
Rafael Espindola554256c2014-02-26 22:25:45 +00006696 IdentifierInfo *II,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006697 bool Weak,
6698 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00006699 CharUnits Align = CGF.getPointerAlign();
John McCall31168b02011-06-15 23:02:42 +00006700 llvm::GlobalVariable *&Entry = ClassReferences[II];
6701
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006702 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006703 std::string ClassName(
6704 getClassSymbolPrefix() +
6705 (ID ? ID->getObjCRuntimeNameAsString() : II->getName()).str());
Rafael Espindola554256c2014-02-26 22:25:45 +00006706 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName, Weak);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006707 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6708 false, llvm::GlobalValue::PrivateLinkage,
6709 ClassGV, "OBJC_CLASSLIST_REFERENCES_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006710 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006711 Entry->setSection("__DATA, __objc_classrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006712 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006713 }
John McCall7f416cc2015-09-08 08:05:57 +00006714 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006715}
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006716
John McCall882987f2013-02-28 19:01:20 +00006717llvm::Value *CGObjCNonFragileABIMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00006718 const ObjCInterfaceDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006719 return EmitClassRefFromId(CGF, ID->getIdentifier(), ID->isWeakImported(), ID);
John McCall31168b02011-06-15 23:02:42 +00006720}
6721
6722llvm::Value *CGObjCNonFragileABIMac::EmitNSAutoreleasePoolClassRef(
John McCall882987f2013-02-28 19:01:20 +00006723 CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00006724 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
Hans Wennborgdcfba332015-10-06 23:40:43 +00006725 return EmitClassRefFromId(CGF, II, false, nullptr);
John McCall31168b02011-06-15 23:02:42 +00006726}
6727
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006728llvm::Value *
John McCall882987f2013-02-28 19:01:20 +00006729CGObjCNonFragileABIMac::EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006730 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00006731 CharUnits Align = CGF.getPointerAlign();
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006732 llvm::GlobalVariable *&Entry = SuperClassReferences[ID->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006733
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006734 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006735 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6736 ClassName += ID->getObjCRuntimeNameAsString();
6737 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(),
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006738 ID->isWeakImported());
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006739 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6740 false, llvm::GlobalValue::PrivateLinkage,
6741 ClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006742 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006743 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006744 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006745 }
John McCall7f416cc2015-09-08 08:05:57 +00006746 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006747}
6748
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006749/// EmitMetaClassRef - Return a Value * of the address of _class_t
6750/// meta-data
6751///
John McCall882987f2013-02-28 19:01:20 +00006752llvm::Value *CGObjCNonFragileABIMac::EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00006753 const ObjCInterfaceDecl *ID,
6754 bool Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00006755 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006756 llvm::GlobalVariable * &Entry = MetaClassReferences[ID->getIdentifier()];
Rafael Espindola21039aa2014-02-27 16:26:32 +00006757 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006758 llvm::SmallString<64> MetaClassName(getMetaclassSymbolPrefix());
6759 MetaClassName += ID->getObjCRuntimeNameAsString();
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00006760 llvm::GlobalVariable *MetaClassGV =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006761 GetClassGlobal(MetaClassName.str(), Weak);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006762
Rafael Espindola21039aa2014-02-27 16:26:32 +00006763 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006764 false, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006765 MetaClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006766 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006767
Rafael Espindola21039aa2014-02-27 16:26:32 +00006768 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006769 CGM.addCompilerUsedGlobal(Entry);
Rafael Espindola21039aa2014-02-27 16:26:32 +00006770 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006771
John McCall7f416cc2015-09-08 08:05:57 +00006772 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006773}
6774
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006775/// GetClass - Return a reference to the class for the given interface
6776/// decl.
John McCall882987f2013-02-28 19:01:20 +00006777llvm::Value *CGObjCNonFragileABIMac::GetClass(CodeGenFunction &CGF,
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006778 const ObjCInterfaceDecl *ID) {
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00006779 if (ID->isWeakImported()) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006780 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6781 ClassName += ID->getObjCRuntimeNameAsString();
6782 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(), true);
Nick Lewycky9a441642014-02-27 00:36:00 +00006783 (void)ClassGV;
Rafael Espindolab3262952014-05-09 00:43:37 +00006784 assert(ClassGV->hasExternalWeakLinkage());
Fariborz Jahanian95ace552009-11-17 22:42:00 +00006785 }
6786
John McCall882987f2013-02-28 19:01:20 +00006787 return EmitClassRef(CGF, ID);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006788}
6789
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006790/// Generates a message send where the super is the receiver. This is
6791/// a message send to self with special delivery semantics indicating
6792/// which class's method should be called.
6793CodeGen::RValue
6794CGObjCNonFragileABIMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00006795 ReturnValueSlot Return,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006796 QualType ResultType,
6797 Selector Sel,
6798 const ObjCInterfaceDecl *Class,
6799 bool isCategoryImpl,
6800 llvm::Value *Receiver,
6801 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006802 const CodeGen::CallArgList &CallArgs,
6803 const ObjCMethodDecl *Method) {
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006804 // ...
6805 // Create and init a super structure; this is a (receiver, class)
6806 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00006807 Address ObjCSuper =
6808 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
6809 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006810
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006811 llvm::Value *ReceiverAsObject =
6812 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00006813 CGF.Builder.CreateStore(
6814 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00006815 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006816
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006817 // If this is a class message the metaclass is passed as the target.
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00006818 llvm::Value *Target;
Fariborz Jahanian27678b02012-10-10 23:11:18 +00006819 if (IsClassMessage)
Fariborz Jahanian85b99da2014-08-28 17:05:17 +00006820 Target = EmitMetaClassRef(CGF, Class, Class->isWeakImported());
Fariborz Jahanian27678b02012-10-10 23:11:18 +00006821 else
John McCall882987f2013-02-28 19:01:20 +00006822 Target = EmitSuperClassRef(CGF, Class);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006823
Mike Stump18bb9282009-05-16 07:57:57 +00006824 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
6825 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00006826 llvm::Type *ClassTy =
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006827 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
6828 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00006829 CGF.Builder.CreateStore(
John McCall7f416cc2015-09-08 08:05:57 +00006830 Target, CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006831
John McCall9e8bb002011-05-14 03:10:52 +00006832 return (isVTableDispatchedSelector(Sel))
6833 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
John McCall7f416cc2015-09-08 08:05:57 +00006834 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall9e8bb002011-05-14 03:10:52 +00006835 true, CallArgs, Method)
6836 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00006837 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00006838 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00006839 true, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006840}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006841
John McCall882987f2013-02-28 19:01:20 +00006842llvm::Value *CGObjCNonFragileABIMac::EmitSelector(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00006843 Selector Sel) {
6844 Address Addr = EmitSelectorAddr(CGF, Sel);
6845
6846 llvm::LoadInst* LI = CGF.Builder.CreateLoad(Addr);
6847 LI->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
6848 llvm::MDNode::get(VMContext, None));
6849 return LI;
6850}
6851
6852Address CGObjCNonFragileABIMac::EmitSelectorAddr(CodeGenFunction &CGF,
6853 Selector Sel) {
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006854 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006855
John McCall7f416cc2015-09-08 08:05:57 +00006856 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006857 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006858 llvm::Constant *Casted =
6859 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
6860 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006861 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.SelectorPtrTy,
6862 false, llvm::GlobalValue::PrivateLinkage,
6863 Casted, "OBJC_SELECTOR_REFERENCES_");
Michael Gottesman5c205962013-02-05 23:08:45 +00006864 Entry->setExternallyInitialized(true);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00006865 Entry->setSection("__DATA, __objc_selrefs, literal_pointers, no_dead_strip");
John McCall7f416cc2015-09-08 08:05:57 +00006866 Entry->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00006867 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006868 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006869
John McCall7f416cc2015-09-08 08:05:57 +00006870 return Address(Entry, Align);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006871}
John McCall7f416cc2015-09-08 08:05:57 +00006872
Fariborz Jahanian06292952009-02-16 22:52:32 +00006873/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00006874/// objc_assign_ivar (id src, id *dst, ptrdiff_t)
Fariborz Jahanian06292952009-02-16 22:52:32 +00006875///
6876void CGObjCNonFragileABIMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00006877 llvm::Value *src,
John McCall7f416cc2015-09-08 08:05:57 +00006878 Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00006879 llvm::Value *ivarOffset) {
Chris Lattner2192fe52011-07-18 04:24:23 +00006880 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006881 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00006882 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006883 assert(Size <= 8 && "does not support size > 8");
6884 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
6885 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00006886 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
6887 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00006888 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
6889 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00006890 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00006891 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahanian06292952009-02-16 22:52:32 +00006892}
6893
6894/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
6895/// objc_assign_strongCast (id src, id *dst)
6896///
6897void CGObjCNonFragileABIMac::EmitObjCStrongCastAssign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006898 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00006899 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00006900 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006901 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00006902 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006903 assert(Size <= 8 && "does not support size > 8");
6904 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006905 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00006906 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
6907 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00006908 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
6909 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00006910 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00006911 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
6912 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00006913}
6914
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00006915void CGObjCNonFragileABIMac::EmitGCMemmoveCollectable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006916 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00006917 Address DestPtr,
6918 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00006919 llvm::Value *Size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00006920 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
6921 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00006922 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), Size };
John McCall882987f2013-02-28 19:01:20 +00006923 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00006924}
6925
Fariborz Jahanian06292952009-02-16 22:52:32 +00006926/// EmitObjCWeakRead - Code gen for loading value of a __weak
6927/// object: objc_read_weak (id *src)
6928///
6929llvm::Value * CGObjCNonFragileABIMac::EmitObjCWeakRead(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006930 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00006931 Address AddrWeakObj) {
6932 llvm::Type *DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006933 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj, ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00006934 llvm::Value *read_weak =
6935 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00006936 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00006937 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanian06292952009-02-16 22:52:32 +00006938 return read_weak;
6939}
6940
6941/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
6942/// objc_assign_weak (id src, id *dst)
6943///
6944void CGObjCNonFragileABIMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00006945 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00006946 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006947 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00006948 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006949 assert(Size <= 8 && "does not support size > 8");
6950 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
6951 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00006952 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
6953 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00006954 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
6955 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00006956 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00006957 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
6958 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00006959}
6960
6961/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
6962/// objc_assign_global (id src, id *dst)
6963///
6964void CGObjCNonFragileABIMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00006965 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00006966 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00006967 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006968 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00006969 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00006970 assert(Size <= 8 && "does not support size > 8");
6971 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
6972 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00006973 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
6974 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00006975 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
6976 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00006977 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00006978 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00006979 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
6980 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00006981 else
John McCall882987f2013-02-28 19:01:20 +00006982 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
6983 args, "threadlocalassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00006984}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00006985
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006986void
John McCallbd309292010-07-06 01:34:17 +00006987CGObjCNonFragileABIMac::EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
6988 const ObjCAtSynchronizedStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00006989 EmitAtSynchronizedStmt(CGF, S,
6990 cast<llvm::Function>(ObjCTypes.getSyncEnterFn()),
6991 cast<llvm::Function>(ObjCTypes.getSyncExitFn()));
John McCallbd309292010-07-06 01:34:17 +00006992}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006993
John McCall2ca705e2010-07-24 00:37:23 +00006994llvm::Constant *
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00006995CGObjCNonFragileABIMac::GetEHType(QualType T) {
John McCall2ca705e2010-07-24 00:37:23 +00006996 // There's a particular fixed type info for 'id'.
6997 if (T->isObjCIdType() ||
6998 T->isObjCQualifiedIdType()) {
6999 llvm::Constant *IDEHType =
7000 CGM.getModule().getGlobalVariable("OBJC_EHTYPE_id");
7001 if (!IDEHType)
7002 IDEHType =
7003 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy,
7004 false,
7005 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00007006 nullptr, "OBJC_EHTYPE_id");
John McCall2ca705e2010-07-24 00:37:23 +00007007 return IDEHType;
7008 }
7009
7010 // All other types should be Objective-C interface pointer types.
7011 const ObjCObjectPointerType *PT =
7012 T->getAs<ObjCObjectPointerType>();
7013 assert(PT && "Invalid @catch type.");
7014 const ObjCInterfaceType *IT = PT->getInterfaceType();
7015 assert(IT && "Invalid @catch type.");
7016 return GetInterfaceEHType(IT->getDecl(), false);
7017}
7018
John McCallbd309292010-07-06 01:34:17 +00007019void CGObjCNonFragileABIMac::EmitTryStmt(CodeGen::CodeGenFunction &CGF,
7020 const ObjCAtTryStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007021 EmitTryCatchStmt(CGF, S,
7022 cast<llvm::Function>(ObjCTypes.getObjCBeginCatchFn()),
7023 cast<llvm::Function>(ObjCTypes.getObjCEndCatchFn()),
7024 cast<llvm::Function>(ObjCTypes.getExceptionRethrowFn()));
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +00007025}
7026
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007027/// EmitThrowStmt - Generate code for a throw statement.
7028void CGObjCNonFragileABIMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007029 const ObjCAtThrowStmt &S,
7030 bool ClearInsertionPoint) {
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007031 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00007032 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Benjamin Kramer76399eb2011-09-27 21:06:10 +00007033 Exception = CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007034 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionThrowFn(), Exception)
John McCall17afe452010-10-16 08:21:07 +00007035 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007036 } else {
John McCall882987f2013-02-28 19:01:20 +00007037 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionRethrowFn())
John McCall17afe452010-10-16 08:21:07 +00007038 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007039 }
7040
John McCall17afe452010-10-16 08:21:07 +00007041 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007042 if (ClearInsertionPoint)
7043 CGF.Builder.ClearInsertionPoint();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007044}
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007045
John McCall2ca705e2010-07-24 00:37:23 +00007046llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007047CGObjCNonFragileABIMac::GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007048 bool ForDefinition) {
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007049 llvm::GlobalVariable * &Entry = EHTypeReferences[ID->getIdentifier()];
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007050
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007051 // If we don't need a definition, return the entry if found or check
7052 // if we use an external reference.
7053 if (!ForDefinition) {
7054 if (Entry)
7055 return Entry;
Daniel Dunbard7beeea2009-04-07 06:43:45 +00007056
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007057 // If this type (or a super class) has the __objc_exception__
7058 // attribute, emit an external reference.
Douglas Gregor78bd61f2009-06-18 16:11:24 +00007059 if (hasObjCExceptionAttribute(CGM.getContext(), ID))
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007060 return Entry =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007061 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
7062 llvm::GlobalValue::ExternalLinkage,
7063 nullptr,
7064 ("OBJC_EHTYPE_$_" +
7065 ID->getObjCRuntimeNameAsString()));
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007066 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007067
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007068 // Otherwise we need to either make a new entry or fill in the
7069 // initializer.
7070 assert((!Entry || !Entry->hasInitializer()) && "Duplicate EHType definition");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007071 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
7072 ClassName += ID->getObjCRuntimeNameAsString();
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007073 std::string VTableName = "objc_ehtype_vtable";
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007074 llvm::GlobalVariable *VTableGV =
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007075 CGM.getModule().getGlobalVariable(VTableName);
7076 if (!VTableGV)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007077 VTableGV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.Int8PtrTy,
7078 false,
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007079 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00007080 nullptr, VTableName);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007081
Chris Lattnerece04092012-02-07 00:39:47 +00007082 llvm::Value *VTableIdx = llvm::ConstantInt::get(CGM.Int32Ty, 2);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007083
Benjamin Kramer22d24c22011-10-15 12:20:02 +00007084 llvm::Constant *Values[] = {
David Blaikiee3b172a2015-04-02 18:55:21 +00007085 llvm::ConstantExpr::getGetElementPtr(VTableGV->getValueType(), VTableGV,
7086 VTableIdx),
7087 GetClassName(ID->getObjCRuntimeNameAsString()),
7088 GetClassGlobal(ClassName.str())};
Owen Anderson170229f2009-07-14 23:10:40 +00007089 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00007090 llvm::ConstantStruct::get(ObjCTypes.EHTypeTy, Values);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007091
Rafael Espindola554256c2014-02-26 22:25:45 +00007092 llvm::GlobalValue::LinkageTypes L = ForDefinition
7093 ? llvm::GlobalValue::ExternalLinkage
7094 : llvm::GlobalValue::WeakAnyLinkage;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007095 if (Entry) {
7096 Entry->setInitializer(Init);
7097 } else {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007098 llvm::SmallString<64> EHTYPEName("OBJC_EHTYPE_$_");
7099 EHTYPEName += ID->getObjCRuntimeNameAsString();
Owen Andersonc10c8d32009-07-08 19:05:04 +00007100 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
Rafael Espindola554256c2014-02-26 22:25:45 +00007101 L,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007102 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007103 EHTYPEName.str());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007104 }
Rafael Espindola554256c2014-02-26 22:25:45 +00007105 assert(Entry->getLinkage() == L);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007106
John McCalla4960982013-02-19 01:57:29 +00007107 if (ID->getVisibility() == HiddenVisibility)
Daniel Dunbar15894b72009-04-07 05:48:37 +00007108 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Micah Villmowdd31ca12012-10-08 16:25:52 +00007109 Entry->setAlignment(CGM.getDataLayout().getABITypeAlignment(
Daniel Dunbar710cb202010-04-25 20:39:32 +00007110 ObjCTypes.EHTypeTy));
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007111
Rafael Espindola554256c2014-02-26 22:25:45 +00007112 if (ForDefinition)
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007113 Entry->setSection("__DATA,__objc_const");
Rafael Espindola554256c2014-02-26 22:25:45 +00007114 else
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007115 Entry->setSection("__DATA,__datacoal_nt,coalesced");
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007116
7117 return Entry;
7118}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007119
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00007120/* *** */
7121
Daniel Dunbarb036db82008-08-13 03:21:16 +00007122CodeGen::CGObjCRuntime *
7123CodeGen::CreateMacObjCRuntime(CodeGen::CodeGenModule &CGM) {
John McCall5fb5df92012-06-20 06:18:46 +00007124 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
7125 case ObjCRuntime::FragileMacOSX:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007126 return new CGObjCMac(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00007127
7128 case ObjCRuntime::MacOSX:
7129 case ObjCRuntime::iOS:
7130 return new CGObjCNonFragileABIMac(CGM);
7131
David Chisnallb601c962012-07-03 20:49:52 +00007132 case ObjCRuntime::GNUstep:
7133 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +00007134 case ObjCRuntime::ObjFW:
John McCall5fb5df92012-06-20 06:18:46 +00007135 llvm_unreachable("these runtimes are not Mac runtimes");
7136 }
7137 llvm_unreachable("bad runtime");
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007138}