blob: c8b8be7f4552316e9f22268f469677d3e6343146 [file] [log] [blame]
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001//===------- CGObjCGNU.cpp - Emit LLVM Code from ASTs for a Module --------===//
Chris Lattnerb7256cd2008-03-01 08:50:34 +00002//
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 GNU runtime. The
Anton Korobeynikov1200aca2008-06-01 14:13:53 +000011// class in this file generates structures used by the GNU Objective-C runtime
12// library. These structures are defined in objc/objc.h and objc/objc-api.h in
13// the GNU runtime distribution.
Chris Lattnerb7256cd2008-03-01 08:50:34 +000014//
15//===----------------------------------------------------------------------===//
16
17#include "CGObjCRuntime.h"
John McCalled1ae862011-01-28 11:13:47 +000018#include "CGCleanup.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000019#include "CodeGenFunction.h"
20#include "CodeGenModule.h"
John McCall5ad74072017-03-02 20:04:19 +000021#include "clang/CodeGen/ConstantInitBuilder.h"
Chris Lattner87ab27d2008-06-26 04:19:03 +000022#include "clang/AST/ASTContext.h"
Daniel Dunbar221fa942008-08-11 04:54:23 +000023#include "clang/AST/Decl.h"
Daniel Dunbar89da6ad2008-08-13 00:59:25 +000024#include "clang/AST/DeclObjC.h"
Anders Carlsson15b73de2009-07-18 19:43:29 +000025#include "clang/AST/RecordLayout.h"
Chris Lattnerf0b64d72009-04-26 01:32:48 +000026#include "clang/AST/StmtObjC.h"
David Chisnalld7972f52011-03-23 16:36:54 +000027#include "clang/Basic/FileManager.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000028#include "clang/Basic/SourceManager.h"
Chris Lattnerb7256cd2008-03-01 08:50:34 +000029#include "llvm/ADT/SmallVector.h"
Anton Korobeynikov1200aca2008-06-01 14:13:53 +000030#include "llvm/ADT/StringMap.h"
Chandler Carruthc80ceea2014-03-04 11:02:08 +000031#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000032#include "llvm/IR/DataLayout.h"
33#include "llvm/IR/Intrinsics.h"
34#include "llvm/IR/LLVMContext.h"
35#include "llvm/IR/Module.h"
Daniel Dunbar92992502008-08-15 22:20:32 +000036#include "llvm/Support/Compiler.h"
Chris Lattner8d3f4a42009-01-27 05:06:01 +000037
Chris Lattner87ab27d2008-06-26 04:19:03 +000038using namespace clang;
Daniel Dunbar41cf9de2008-09-09 01:06:48 +000039using namespace CodeGen;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +000040
Chris Lattnerb7256cd2008-03-01 08:50:34 +000041namespace {
David Chisnall34d00052011-03-26 11:48:37 +000042/// Class that lazily initialises the runtime function. Avoids inserting the
43/// types and the function declaration into a module if they're not used, and
44/// avoids constructing the type more than once if it's used more than once.
David Chisnalld7972f52011-03-23 16:36:54 +000045class LazyRuntimeFunction {
46 CodeGenModule *CGM;
David Blaikiebf178d32015-05-19 21:31:34 +000047 llvm::FunctionType *FTy;
David Chisnalld7972f52011-03-23 16:36:54 +000048 const char *FunctionName;
David Chisnall3fe89562011-05-23 22:33:28 +000049 llvm::Constant *Function;
David Blaikie7d9e7922015-05-18 22:51:39 +000050
51public:
52 /// Constructor leaves this class uninitialized, because it is intended to
53 /// be used as a field in another class and not all of the types that are
54 /// used as arguments will necessarily be available at construction time.
55 LazyRuntimeFunction()
Craig Topper8a13c412014-05-21 05:09:00 +000056 : CGM(nullptr), FunctionName(nullptr), Function(nullptr) {}
David Chisnalld7972f52011-03-23 16:36:54 +000057
David Blaikie7d9e7922015-05-18 22:51:39 +000058 /// Initialises the lazy function with the name, return type, and the types
59 /// of the arguments.
Serge Guelton1d993272017-05-09 19:31:30 +000060 template <typename... Tys>
61 void init(CodeGenModule *Mod, const char *name, llvm::Type *RetTy,
62 Tys *... Types) {
David Blaikie7d9e7922015-05-18 22:51:39 +000063 CGM = Mod;
64 FunctionName = name;
65 Function = nullptr;
Serge Guelton29405c92017-05-09 21:19:44 +000066 if(sizeof...(Tys)) {
67 SmallVector<llvm::Type *, 8> ArgTys({Types...});
68 FTy = llvm::FunctionType::get(RetTy, ArgTys, false);
69 }
70 else {
71 FTy = llvm::FunctionType::get(RetTy, None, false);
72 }
David Blaikie7d9e7922015-05-18 22:51:39 +000073 }
David Blaikiebf178d32015-05-19 21:31:34 +000074
75 llvm::FunctionType *getType() { return FTy; }
76
David Blaikie7d9e7922015-05-18 22:51:39 +000077 /// Overloaded cast operator, allows the class to be implicitly cast to an
78 /// LLVM constant.
79 operator llvm::Constant *() {
80 if (!Function) {
81 if (!FunctionName)
82 return nullptr;
David Blaikie7d9e7922015-05-18 22:51:39 +000083 Function =
84 cast<llvm::Constant>(CGM->CreateRuntimeFunction(FTy, FunctionName));
David Blaikie7d9e7922015-05-18 22:51:39 +000085 }
86 return Function;
87 }
88 operator llvm::Function *() {
89 return cast<llvm::Function>((llvm::Constant *)*this);
90 }
David Chisnalld7972f52011-03-23 16:36:54 +000091};
92
93
David Chisnall34d00052011-03-26 11:48:37 +000094/// GNU Objective-C runtime code generation. This class implements the parts of
John McCall775086e2012-07-12 02:07:58 +000095/// Objective-C support that are specific to the GNU family of runtimes (GCC,
96/// GNUstep and ObjFW).
David Chisnalld7972f52011-03-23 16:36:54 +000097class CGObjCGNU : public CGObjCRuntime {
David Chisnall76803412011-03-23 22:52:06 +000098protected:
David Chisnall34d00052011-03-26 11:48:37 +000099 /// The LLVM module into which output is inserted
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000100 llvm::Module &TheModule;
David Chisnall34d00052011-03-26 11:48:37 +0000101 /// strut objc_super. Used for sending messages to super. This structure
102 /// contains the receiver (object) and the expected class.
Chris Lattner2192fe52011-07-18 04:24:23 +0000103 llvm::StructType *ObjCSuperTy;
David Chisnall34d00052011-03-26 11:48:37 +0000104 /// struct objc_super*. The type of the argument to the superclass message
105 /// lookup functions.
Chris Lattner2192fe52011-07-18 04:24:23 +0000106 llvm::PointerType *PtrToObjCSuperTy;
David Chisnall34d00052011-03-26 11:48:37 +0000107 /// LLVM type for selectors. Opaque pointer (i8*) unless a header declaring
108 /// SEL is included in a header somewhere, in which case it will be whatever
109 /// type is declared in that header, most likely {i8*, i8*}.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000110 llvm::PointerType *SelectorTy;
David Chisnall34d00052011-03-26 11:48:37 +0000111 /// LLVM i8 type. Cached here to avoid repeatedly getting it in all of the
112 /// places where it's used
Chris Lattner2192fe52011-07-18 04:24:23 +0000113 llvm::IntegerType *Int8Ty;
David Chisnall34d00052011-03-26 11:48:37 +0000114 /// Pointer to i8 - LLVM type of char*, for all of the places where the
115 /// runtime needs to deal with C strings.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000116 llvm::PointerType *PtrToInt8Ty;
David Chisnall34d00052011-03-26 11:48:37 +0000117 /// Instance Method Pointer type. This is a pointer to a function that takes,
118 /// at a minimum, an object and a selector, and is the generic type for
119 /// Objective-C methods. Due to differences between variadic / non-variadic
120 /// calling conventions, it must always be cast to the correct type before
121 /// actually being used.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000122 llvm::PointerType *IMPTy;
David Chisnall34d00052011-03-26 11:48:37 +0000123 /// Type of an untyped Objective-C object. Clang treats id as a built-in type
124 /// when compiling Objective-C code, so this may be an opaque pointer (i8*),
125 /// but if the runtime header declaring it is included then it may be a
126 /// pointer to a structure.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000127 llvm::PointerType *IdTy;
David Chisnall34d00052011-03-26 11:48:37 +0000128 /// Pointer to a pointer to an Objective-C object. Used in the new ABI
129 /// message lookup function and some GC-related functions.
Chris Lattner2192fe52011-07-18 04:24:23 +0000130 llvm::PointerType *PtrToIdTy;
David Chisnall34d00052011-03-26 11:48:37 +0000131 /// The clang type of id. Used when using the clang CGCall infrastructure to
132 /// call Objective-C methods.
John McCall2da83a32010-02-26 00:48:12 +0000133 CanQualType ASTIdTy;
David Chisnall34d00052011-03-26 11:48:37 +0000134 /// LLVM type for C int type.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000135 llvm::IntegerType *IntTy;
David Chisnall34d00052011-03-26 11:48:37 +0000136 /// LLVM type for an opaque pointer. This is identical to PtrToInt8Ty, but is
137 /// used in the code to document the difference between i8* meaning a pointer
138 /// to a C string and i8* meaning a pointer to some opaque type.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000139 llvm::PointerType *PtrTy;
David Chisnall34d00052011-03-26 11:48:37 +0000140 /// LLVM type for C long type. The runtime uses this in a lot of places where
141 /// it should be using intptr_t, but we can't fix this without breaking
142 /// compatibility with GCC...
Jay Foad7c57be32011-07-11 09:56:20 +0000143 llvm::IntegerType *LongTy;
David Chisnall34d00052011-03-26 11:48:37 +0000144 /// LLVM type for C size_t. Used in various runtime data structures.
Chris Lattner2192fe52011-07-18 04:24:23 +0000145 llvm::IntegerType *SizeTy;
David Chisnalle0dc7cb2011-10-08 08:54:36 +0000146 /// LLVM type for C intptr_t.
147 llvm::IntegerType *IntPtrTy;
David Chisnall34d00052011-03-26 11:48:37 +0000148 /// LLVM type for C ptrdiff_t. Mainly used in property accessor functions.
Chris Lattner2192fe52011-07-18 04:24:23 +0000149 llvm::IntegerType *PtrDiffTy;
David Chisnall34d00052011-03-26 11:48:37 +0000150 /// LLVM type for C int*. Used for GCC-ABI-compatible non-fragile instance
151 /// variables.
Chris Lattner2192fe52011-07-18 04:24:23 +0000152 llvm::PointerType *PtrToIntTy;
David Chisnall34d00052011-03-26 11:48:37 +0000153 /// LLVM type for Objective-C BOOL type.
Chris Lattner2192fe52011-07-18 04:24:23 +0000154 llvm::Type *BoolTy;
David Chisnallcdd207e2011-10-04 15:35:30 +0000155 /// 32-bit integer type, to save us needing to look it up every time it's used.
156 llvm::IntegerType *Int32Ty;
157 /// 64-bit integer type, to save us needing to look it up every time it's used.
158 llvm::IntegerType *Int64Ty;
David Chisnall34d00052011-03-26 11:48:37 +0000159 /// Metadata kind used to tie method lookups to message sends. The GNUstep
160 /// runtime provides some LLVM passes that can use this to do things like
161 /// automatic IMP caching and speculative inlining.
David Chisnall76803412011-03-23 22:52:06 +0000162 unsigned msgSendMDKind;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000163
David Chisnall34d00052011-03-26 11:48:37 +0000164 /// Helper function that generates a constant string and returns a pointer to
165 /// the start of the string. The result of this function can be used anywhere
166 /// where the C code specifies const char*.
John McCallecee86f2016-11-30 20:19:46 +0000167 llvm::Constant *MakeConstantString(StringRef Str, const char *Name = "") {
168 ConstantAddress Array = CGM.GetAddrOfConstantCString(Str, Name);
John McCall7f416cc2015-09-08 08:05:57 +0000169 return llvm::ConstantExpr::getGetElementPtr(Array.getElementType(),
170 Array.getPointer(), Zeros);
David Chisnalld3858d62011-03-25 11:57:33 +0000171 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000172
David Chisnall34d00052011-03-26 11:48:37 +0000173 /// Emits a linkonce_odr string, whose name is the prefix followed by the
174 /// string value. This allows the linker to combine the strings between
175 /// different modules. Used for EH typeinfo names, selector strings, and a
176 /// few other things.
Benjamin Kramer81cb4b72016-11-24 16:01:20 +0000177 llvm::Constant *ExportUniqueString(const std::string &Str, StringRef Prefix) {
178 std::string Name = Prefix.str() + Str;
179 auto *ConstStr = TheModule.getGlobalVariable(Name);
David Chisnalld3858d62011-03-25 11:57:33 +0000180 if (!ConstStr) {
Chris Lattner9c818332012-02-05 02:30:40 +0000181 llvm::Constant *value = llvm::ConstantDataArray::getString(VMContext,Str);
David Chisnalld3858d62011-03-25 11:57:33 +0000182 ConstStr = new llvm::GlobalVariable(TheModule, value->getType(), true,
Benjamin Kramer81cb4b72016-11-24 16:01:20 +0000183 llvm::GlobalValue::LinkOnceODRLinkage,
184 value, Name);
David Chisnalld3858d62011-03-25 11:57:33 +0000185 }
David Blaikiee3b172a2015-04-02 18:55:21 +0000186 return llvm::ConstantExpr::getGetElementPtr(ConstStr->getValueType(),
187 ConstStr, Zeros);
David Chisnalld3858d62011-03-25 11:57:33 +0000188 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000189
David Chisnall34d00052011-03-26 11:48:37 +0000190 /// Generates a global structure, initialized by the elements in the vector.
191 /// The element types must match the types of the structure elements in the
192 /// first argument.
John McCall6c9f1fdb2016-11-19 08:17:24 +0000193 llvm::GlobalVariable *MakeGlobal(llvm::Constant *C,
John McCall7f416cc2015-09-08 08:05:57 +0000194 CharUnits Align,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000195 StringRef Name="",
David Chisnalld3858d62011-03-25 11:57:33 +0000196 llvm::GlobalValue::LinkageTypes linkage
197 =llvm::GlobalValue::InternalLinkage) {
John McCall6c9f1fdb2016-11-19 08:17:24 +0000198 auto GV = new llvm::GlobalVariable(TheModule, C->getType(), false,
John McCall7f416cc2015-09-08 08:05:57 +0000199 linkage, C, Name);
200 GV->setAlignment(Align.getQuantity());
201 return GV;
David Chisnalld3858d62011-03-25 11:57:33 +0000202 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000203
David Chisnalla5f59412012-10-16 15:11:55 +0000204 /// Returns a property name and encoding string.
205 llvm::Constant *MakePropertyEncodingString(const ObjCPropertyDecl *PD,
206 const Decl *Container) {
David Chisnallbeb80132013-02-28 13:59:29 +0000207 const ObjCRuntime &R = CGM.getLangOpts().ObjCRuntime;
David Chisnalla5f59412012-10-16 15:11:55 +0000208 if ((R.getKind() == ObjCRuntime::GNUstep) &&
209 (R.getVersion() >= VersionTuple(1, 6))) {
210 std::string NameAndAttributes;
John McCall843dfcc2016-11-29 21:57:00 +0000211 std::string TypeStr =
212 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container);
David Chisnalla5f59412012-10-16 15:11:55 +0000213 NameAndAttributes += '\0';
214 NameAndAttributes += TypeStr.length() + 3;
215 NameAndAttributes += TypeStr;
216 NameAndAttributes += '\0';
217 NameAndAttributes += PD->getNameAsString();
John McCall7f416cc2015-09-08 08:05:57 +0000218 return MakeConstantString(NameAndAttributes);
David Chisnalla5f59412012-10-16 15:11:55 +0000219 }
220 return MakeConstantString(PD->getNameAsString());
221 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000222
David Chisnallbeb80132013-02-28 13:59:29 +0000223 /// Push the property attributes into two structure fields.
John McCall23c9dc62016-11-28 22:18:27 +0000224 void PushPropertyAttributes(ConstantStructBuilder &Fields,
David Chisnallbeb80132013-02-28 13:59:29 +0000225 ObjCPropertyDecl *property, bool isSynthesized=true, bool
226 isDynamic=true) {
227 int attrs = property->getPropertyAttributes();
228 // For read-only properties, clear the copy and retain flags
229 if (attrs & ObjCPropertyDecl::OBJC_PR_readonly) {
230 attrs &= ~ObjCPropertyDecl::OBJC_PR_copy;
231 attrs &= ~ObjCPropertyDecl::OBJC_PR_retain;
232 attrs &= ~ObjCPropertyDecl::OBJC_PR_weak;
233 attrs &= ~ObjCPropertyDecl::OBJC_PR_strong;
234 }
235 // The first flags field has the same attribute values as clang uses internally
John McCall6c9f1fdb2016-11-19 08:17:24 +0000236 Fields.addInt(Int8Ty, attrs & 0xff);
David Chisnallbeb80132013-02-28 13:59:29 +0000237 attrs >>= 8;
238 attrs <<= 2;
239 // For protocol properties, synthesized and dynamic have no meaning, so we
240 // reuse these flags to indicate that this is a protocol property (both set
241 // has no meaning, as a property can't be both synthesized and dynamic)
242 attrs |= isSynthesized ? (1<<0) : 0;
243 attrs |= isDynamic ? (1<<1) : 0;
244 // The second field is the next four fields left shifted by two, with the
245 // low bit set to indicate whether the field is synthesized or dynamic.
John McCall6c9f1fdb2016-11-19 08:17:24 +0000246 Fields.addInt(Int8Ty, attrs & 0xff);
David Chisnallbeb80132013-02-28 13:59:29 +0000247 // Two padding fields
John McCall6c9f1fdb2016-11-19 08:17:24 +0000248 Fields.addInt(Int8Ty, 0);
249 Fields.addInt(Int8Ty, 0);
David Chisnallbeb80132013-02-28 13:59:29 +0000250 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000251
David Chisnall34d00052011-03-26 11:48:37 +0000252 /// Ensures that the value has the required type, by inserting a bitcast if
253 /// required. This function lets us avoid inserting bitcasts that are
254 /// redundant.
John McCall882987f2013-02-28 19:01:20 +0000255 llvm::Value* EnforceType(CGBuilderTy &B, llvm::Value *V, llvm::Type *Ty) {
David Chisnall76803412011-03-23 22:52:06 +0000256 if (V->getType() == Ty) return V;
257 return B.CreateBitCast(V, Ty);
258 }
John McCall7f416cc2015-09-08 08:05:57 +0000259 Address EnforceType(CGBuilderTy &B, Address V, llvm::Type *Ty) {
260 if (V.getType() == Ty) return V;
261 return B.CreateBitCast(V, Ty);
262 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000263
David Chisnall76803412011-03-23 22:52:06 +0000264 // Some zeros used for GEPs in lots of places.
265 llvm::Constant *Zeros[2];
David Chisnall34d00052011-03-26 11:48:37 +0000266 /// Null pointer value. Mainly used as a terminator in various arrays.
David Chisnall76803412011-03-23 22:52:06 +0000267 llvm::Constant *NULLPtr;
David Chisnall34d00052011-03-26 11:48:37 +0000268 /// LLVM context.
David Chisnall76803412011-03-23 22:52:06 +0000269 llvm::LLVMContext &VMContext;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000270
David Chisnall76803412011-03-23 22:52:06 +0000271private:
David Chisnall34d00052011-03-26 11:48:37 +0000272 /// Placeholder for the class. Lots of things refer to the class before we've
273 /// actually emitted it. We use this alias as a placeholder, and then replace
274 /// it with a pointer to the class structure before finally emitting the
275 /// module.
Daniel Dunbar566421c2009-05-04 15:31:17 +0000276 llvm::GlobalAlias *ClassPtrAlias;
David Chisnall34d00052011-03-26 11:48:37 +0000277 /// Placeholder for the metaclass. Lots of things refer to the class before
278 /// we've / actually emitted it. We use this alias as a placeholder, and then
279 /// replace / it with a pointer to the metaclass structure before finally
280 /// emitting the / module.
Daniel Dunbar566421c2009-05-04 15:31:17 +0000281 llvm::GlobalAlias *MetaClassPtrAlias;
David Chisnall34d00052011-03-26 11:48:37 +0000282 /// All of the classes that have been generated for this compilation units.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000283 std::vector<llvm::Constant*> Classes;
David Chisnall34d00052011-03-26 11:48:37 +0000284 /// All of the categories that have been generated for this compilation units.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000285 std::vector<llvm::Constant*> Categories;
David Chisnall34d00052011-03-26 11:48:37 +0000286 /// All of the Objective-C constant strings that have been generated for this
287 /// compilation units.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000288 std::vector<llvm::Constant*> ConstantStrings;
David Chisnall34d00052011-03-26 11:48:37 +0000289 /// Map from string values to Objective-C constant strings in the output.
290 /// Used to prevent emitting Objective-C strings more than once. This should
291 /// not be required at all - CodeGenModule should manage this list.
David Chisnall358e7512010-01-27 12:49:23 +0000292 llvm::StringMap<llvm::Constant*> ObjCStrings;
David Chisnall34d00052011-03-26 11:48:37 +0000293 /// All of the protocols that have been declared.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000294 llvm::StringMap<llvm::Constant*> ExistingProtocols;
David Chisnall34d00052011-03-26 11:48:37 +0000295 /// For each variant of a selector, we store the type encoding and a
296 /// placeholder value. For an untyped selector, the type will be the empty
297 /// string. Selector references are all done via the module's selector table,
298 /// so we create an alias as a placeholder and then replace it with the real
299 /// value later.
David Chisnalld7972f52011-03-23 16:36:54 +0000300 typedef std::pair<std::string, llvm::GlobalAlias*> TypedSelector;
David Chisnall34d00052011-03-26 11:48:37 +0000301 /// Type of the selector map. This is roughly equivalent to the structure
302 /// used in the GNUstep runtime, which maintains a list of all of the valid
303 /// types for a selector in a table.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000304 typedef llvm::DenseMap<Selector, SmallVector<TypedSelector, 2> >
David Chisnalld7972f52011-03-23 16:36:54 +0000305 SelectorMap;
David Chisnall34d00052011-03-26 11:48:37 +0000306 /// A map from selectors to selector types. This allows us to emit all
307 /// selectors of the same name and type together.
David Chisnalld7972f52011-03-23 16:36:54 +0000308 SelectorMap SelectorTable;
309
David Chisnall34d00052011-03-26 11:48:37 +0000310 /// Selectors related to memory management. When compiling in GC mode, we
311 /// omit these.
David Chisnall5bb4efd2010-02-03 15:59:02 +0000312 Selector RetainSel, ReleaseSel, AutoreleaseSel;
David Chisnall34d00052011-03-26 11:48:37 +0000313 /// Runtime functions used for memory management in GC mode. Note that clang
314 /// supports code generation for calling these functions, but neither GNU
315 /// runtime actually supports this API properly yet.
David Chisnalld7972f52011-03-23 16:36:54 +0000316 LazyRuntimeFunction IvarAssignFn, StrongCastAssignFn, MemMoveFn, WeakReadFn,
317 WeakAssignFn, GlobalAssignFn;
David Chisnalld7972f52011-03-23 16:36:54 +0000318
David Chisnall92d436b2012-01-31 18:59:20 +0000319 typedef std::pair<std::string, std::string> ClassAliasPair;
320 /// All classes that have aliases set for them.
321 std::vector<ClassAliasPair> ClassAliases;
322
David Chisnalld3858d62011-03-25 11:57:33 +0000323protected:
David Chisnall34d00052011-03-26 11:48:37 +0000324 /// Function used for throwing Objective-C exceptions.
David Chisnalld7972f52011-03-23 16:36:54 +0000325 LazyRuntimeFunction ExceptionThrowFn;
James Dennettb9199ee2012-06-13 22:07:09 +0000326 /// Function used for rethrowing exceptions, used at the end of \@finally or
327 /// \@synchronize blocks.
David Chisnalld3858d62011-03-25 11:57:33 +0000328 LazyRuntimeFunction ExceptionReThrowFn;
David Chisnall34d00052011-03-26 11:48:37 +0000329 /// Function called when entering a catch function. This is required for
330 /// differentiating Objective-C exceptions and foreign exceptions.
David Chisnalld3858d62011-03-25 11:57:33 +0000331 LazyRuntimeFunction EnterCatchFn;
David Chisnall34d00052011-03-26 11:48:37 +0000332 /// Function called when exiting from a catch block. Used to do exception
333 /// cleanup.
David Chisnalld3858d62011-03-25 11:57:33 +0000334 LazyRuntimeFunction ExitCatchFn;
James Dennettb9199ee2012-06-13 22:07:09 +0000335 /// Function called when entering an \@synchronize block. Acquires the lock.
David Chisnalld7972f52011-03-23 16:36:54 +0000336 LazyRuntimeFunction SyncEnterFn;
James Dennettb9199ee2012-06-13 22:07:09 +0000337 /// Function called when exiting an \@synchronize block. Releases the lock.
David Chisnalld7972f52011-03-23 16:36:54 +0000338 LazyRuntimeFunction SyncExitFn;
339
David Chisnalld3858d62011-03-25 11:57:33 +0000340private:
David Chisnall34d00052011-03-26 11:48:37 +0000341 /// Function called if fast enumeration detects that the collection is
342 /// modified during the update.
David Chisnalld7972f52011-03-23 16:36:54 +0000343 LazyRuntimeFunction EnumerationMutationFn;
David Chisnall34d00052011-03-26 11:48:37 +0000344 /// Function for implementing synthesized property getters that return an
345 /// object.
David Chisnalld7972f52011-03-23 16:36:54 +0000346 LazyRuntimeFunction GetPropertyFn;
David Chisnall34d00052011-03-26 11:48:37 +0000347 /// Function for implementing synthesized property setters that return an
348 /// object.
David Chisnalld7972f52011-03-23 16:36:54 +0000349 LazyRuntimeFunction SetPropertyFn;
David Chisnall34d00052011-03-26 11:48:37 +0000350 /// Function used for non-object declared property getters.
David Chisnalld7972f52011-03-23 16:36:54 +0000351 LazyRuntimeFunction GetStructPropertyFn;
David Chisnall34d00052011-03-26 11:48:37 +0000352 /// Function used for non-object declared property setters.
David Chisnalld7972f52011-03-23 16:36:54 +0000353 LazyRuntimeFunction SetStructPropertyFn;
354
David Chisnall34d00052011-03-26 11:48:37 +0000355 /// The version of the runtime that this class targets. Must match the
356 /// version in the runtime.
David Chisnall5c511772011-05-22 22:37:08 +0000357 int RuntimeVersion;
David Chisnall34d00052011-03-26 11:48:37 +0000358 /// The version of the protocol class. Used to differentiate between ObjC1
359 /// and ObjC2 protocols. Objective-C 1 protocols can not contain optional
360 /// components and can not contain declared properties. We always emit
361 /// Objective-C 2 property structures, but we have to pretend that they're
362 /// Objective-C 1 property structures when targeting the GCC runtime or it
363 /// will abort.
David Chisnalld7972f52011-03-23 16:36:54 +0000364 const int ProtocolVersion;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000365
David Chisnall34d00052011-03-26 11:48:37 +0000366 /// Generates an instance variable list structure. This is a structure
367 /// containing a size and an array of structures containing instance variable
368 /// metadata. This is used purely for introspection in the fragile ABI. In
369 /// the non-fragile ABI, it's used for instance variable fixup.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000370 llvm::Constant *GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
371 ArrayRef<llvm::Constant *> IvarTypes,
372 ArrayRef<llvm::Constant *> IvarOffsets);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000373
David Chisnall34d00052011-03-26 11:48:37 +0000374 /// Generates a method list structure. This is a structure containing a size
375 /// and an array of structures containing method metadata.
376 ///
377 /// This structure is used by both classes and categories, and contains a next
378 /// pointer allowing them to be chained together in a linked list.
Craig Topperbf3e3272014-08-30 16:55:52 +0000379 llvm::Constant *GenerateMethodList(StringRef ClassName,
380 StringRef CategoryName,
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000381 ArrayRef<Selector> MethodSels,
382 ArrayRef<llvm::Constant *> MethodTypes,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000383 bool isClassMethodList);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000384
James Dennettb9199ee2012-06-13 22:07:09 +0000385 /// Emits an empty protocol. This is used for \@protocol() where no protocol
David Chisnall34d00052011-03-26 11:48:37 +0000386 /// is found. The runtime will (hopefully) fix up the pointer to refer to the
387 /// real protocol.
Fariborz Jahanian89d23972009-03-31 18:27:22 +0000388 llvm::Constant *GenerateEmptyProtocol(const std::string &ProtocolName);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000389
David Chisnall34d00052011-03-26 11:48:37 +0000390 /// Generates a list of property metadata structures. This follows the same
391 /// pattern as method and instance variable metadata lists.
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000392 llvm::Constant *GeneratePropertyList(const ObjCImplementationDecl *OID,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000393 SmallVectorImpl<Selector> &InstanceMethodSels,
394 SmallVectorImpl<llvm::Constant*> &InstanceMethodTypes);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000395
David Chisnall34d00052011-03-26 11:48:37 +0000396 /// Generates a list of referenced protocols. Classes, categories, and
397 /// protocols all use this structure.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000398 llvm::Constant *GenerateProtocolList(ArrayRef<std::string> Protocols);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000399
David Chisnall34d00052011-03-26 11:48:37 +0000400 /// To ensure that all protocols are seen by the runtime, we add a category on
401 /// a class defined in the runtime, declaring no methods, but adopting the
402 /// protocols. This is a horribly ugly hack, but it allows us to collect all
403 /// of the protocols without changing the ABI.
Dmitri Gribenkob2aa9232012-11-15 14:28:07 +0000404 void GenerateProtocolHolderCategory();
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000405
David Chisnall34d00052011-03-26 11:48:37 +0000406 /// Generates a class structure.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000407 llvm::Constant *GenerateClassStructure(
408 llvm::Constant *MetaClass,
409 llvm::Constant *SuperClass,
410 unsigned info,
Chris Lattnerda35bc82008-06-26 04:47:04 +0000411 const char *Name,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000412 llvm::Constant *Version,
413 llvm::Constant *InstanceSize,
414 llvm::Constant *IVars,
415 llvm::Constant *Methods,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000416 llvm::Constant *Protocols,
417 llvm::Constant *IvarOffsets,
David Chisnalld472c852010-04-28 14:29:56 +0000418 llvm::Constant *Properties,
David Chisnallcdd207e2011-10-04 15:35:30 +0000419 llvm::Constant *StrongIvarBitmap,
420 llvm::Constant *WeakIvarBitmap,
David Chisnalld472c852010-04-28 14:29:56 +0000421 bool isMeta=false);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000422
David Chisnall34d00052011-03-26 11:48:37 +0000423 /// Generates a method list. This is used by protocols to define the required
424 /// and optional methods.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000425 llvm::Constant *GenerateProtocolMethodList(
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000426 ArrayRef<llvm::Constant *> MethodNames,
427 ArrayRef<llvm::Constant *> MethodTypes);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000428
David Chisnall34d00052011-03-26 11:48:37 +0000429 /// Returns a selector with the specified type encoding. An empty string is
430 /// used to return an untyped selector (with the types field set to NULL).
John McCall882987f2013-02-28 19:01:20 +0000431 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel,
John McCall7f416cc2015-09-08 08:05:57 +0000432 const std::string &TypeEncoding);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000433
David Chisnall34d00052011-03-26 11:48:37 +0000434 /// Returns the variable used to store the offset of an instance variable.
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +0000435 llvm::GlobalVariable *ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
436 const ObjCIvarDecl *Ivar);
David Chisnall34d00052011-03-26 11:48:37 +0000437 /// Emits a reference to a class. This allows the linker to object if there
438 /// is no class of the matching name.
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000439
John McCall775086e2012-07-12 02:07:58 +0000440protected:
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000441 void EmitClassRef(const std::string &className);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000442
David Chisnall920e83b2011-06-29 13:16:41 +0000443 /// Emits a pointer to the named class
John McCall882987f2013-02-28 19:01:20 +0000444 virtual llvm::Value *GetClassNamed(CodeGenFunction &CGF,
John McCall775086e2012-07-12 02:07:58 +0000445 const std::string &Name, bool isWeak);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000446
David Chisnall34d00052011-03-26 11:48:37 +0000447 /// Looks up the method for sending a message to the specified object. This
448 /// mechanism differs between the GCC and GNU runtimes, so this method must be
449 /// overridden in subclasses.
David Chisnall76803412011-03-23 22:52:06 +0000450 virtual llvm::Value *LookupIMP(CodeGenFunction &CGF,
451 llvm::Value *&Receiver,
452 llvm::Value *cmd,
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000453 llvm::MDNode *node,
454 MessageSendInfo &MSI) = 0;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000455
David Chisnallcdd207e2011-10-04 15:35:30 +0000456 /// Looks up the method for sending a message to a superclass. This
457 /// mechanism differs between the GCC and GNU runtimes, so this method must
458 /// be overridden in subclasses.
David Chisnall76803412011-03-23 22:52:06 +0000459 virtual llvm::Value *LookupIMPSuper(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000460 Address ObjCSuper,
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000461 llvm::Value *cmd,
462 MessageSendInfo &MSI) = 0;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000463
David Chisnallcdd207e2011-10-04 15:35:30 +0000464 /// Libobjc2 uses a bitfield representation where small(ish) bitfields are
465 /// stored in a 64-bit value with the low bit set to 1 and the remaining 63
466 /// bits set to their values, LSB first, while larger ones are stored in a
467 /// structure of this / form:
468 ///
469 /// struct { int32_t length; int32_t values[length]; };
470 ///
471 /// The values in the array are stored in host-endian format, with the least
472 /// significant bit being assumed to come first in the bitfield. Therefore,
473 /// a bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] },
474 /// while a bitfield / with the 63rd bit set will be 1<<64.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000475 llvm::Constant *MakeBitField(ArrayRef<bool> bits);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000476
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000477public:
David Chisnalld7972f52011-03-23 16:36:54 +0000478 CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion,
479 unsigned protocolClassVersion);
480
John McCall7f416cc2015-09-08 08:05:57 +0000481 ConstantAddress GenerateConstantString(const StringLiteral *) override;
David Chisnalld7972f52011-03-23 16:36:54 +0000482
Craig Topper4f12f102014-03-12 06:41:41 +0000483 RValue
484 GenerateMessageSend(CodeGenFunction &CGF, ReturnValueSlot Return,
485 QualType ResultType, Selector Sel,
486 llvm::Value *Receiver, const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +0000487 const ObjCInterfaceDecl *Class,
Craig Topper4f12f102014-03-12 06:41:41 +0000488 const ObjCMethodDecl *Method) override;
489 RValue
490 GenerateMessageSendSuper(CodeGenFunction &CGF, ReturnValueSlot Return,
491 QualType ResultType, Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000492 const ObjCInterfaceDecl *Class,
Craig Topper4f12f102014-03-12 06:41:41 +0000493 bool isCategoryImpl, llvm::Value *Receiver,
494 bool IsClassMessage, const CallArgList &CallArgs,
495 const ObjCMethodDecl *Method) override;
496 llvm::Value *GetClass(CodeGenFunction &CGF,
497 const ObjCInterfaceDecl *OID) override;
John McCall7f416cc2015-09-08 08:05:57 +0000498 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
499 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000500 llvm::Value *GetSelector(CodeGenFunction &CGF,
501 const ObjCMethodDecl *Method) override;
502 llvm::Constant *GetEHType(QualType T) override;
Mike Stump11289f42009-09-09 15:08:12 +0000503
Craig Topper4f12f102014-03-12 06:41:41 +0000504 llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
505 const ObjCContainerDecl *CD) override;
506 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
507 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
508 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override;
509 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
510 const ObjCProtocolDecl *PD) override;
511 void GenerateProtocol(const ObjCProtocolDecl *PD) override;
512 llvm::Function *ModuleInitFunction() override;
513 llvm::Constant *GetPropertyGetFunction() override;
514 llvm::Constant *GetPropertySetFunction() override;
515 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
516 bool copy) override;
517 llvm::Constant *GetSetStructFunction() override;
518 llvm::Constant *GetGetStructFunction() override;
519 llvm::Constant *GetCppAtomicObjectGetFunction() override;
520 llvm::Constant *GetCppAtomicObjectSetFunction() override;
521 llvm::Constant *EnumerationMutationFunction() override;
Mike Stump11289f42009-09-09 15:08:12 +0000522
Craig Topper4f12f102014-03-12 06:41:41 +0000523 void EmitTryStmt(CodeGenFunction &CGF,
524 const ObjCAtTryStmt &S) override;
525 void EmitSynchronizedStmt(CodeGenFunction &CGF,
526 const ObjCAtSynchronizedStmt &S) override;
527 void EmitThrowStmt(CodeGenFunction &CGF,
528 const ObjCAtThrowStmt &S,
529 bool ClearInsertionPoint=true) override;
530 llvm::Value * EmitObjCWeakRead(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000531 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000532 void EmitObjCWeakAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000533 llvm::Value *src, Address dst) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000534 void EmitObjCGlobalAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000535 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +0000536 bool threadlocal=false) override;
537 void EmitObjCIvarAssign(CodeGenFunction &CGF, llvm::Value *src,
John McCall7f416cc2015-09-08 08:05:57 +0000538 Address dest, llvm::Value *ivarOffset) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000539 void EmitObjCStrongCastAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000540 llvm::Value *src, Address dest) override;
541 void EmitGCMemmoveCollectable(CodeGenFunction &CGF, Address DestPtr,
542 Address SrcPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000543 llvm::Value *Size) override;
544 LValue EmitObjCValueForIvar(CodeGenFunction &CGF, QualType ObjectTy,
545 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
546 unsigned CVRQualifiers) override;
547 llvm::Value *EmitIvarOffset(CodeGenFunction &CGF,
548 const ObjCInterfaceDecl *Interface,
549 const ObjCIvarDecl *Ivar) override;
550 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
551 llvm::Constant *BuildGCBlockLayout(CodeGenModule &CGM,
552 const CGBlockInfo &blockInfo) override {
Fariborz Jahanianc05349e2010-08-04 16:57:49 +0000553 return NULLPtr;
554 }
Craig Topper4f12f102014-03-12 06:41:41 +0000555 llvm::Constant *BuildRCBlockLayout(CodeGenModule &CGM,
556 const CGBlockInfo &blockInfo) override {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +0000557 return NULLPtr;
558 }
Craig Topper4f12f102014-03-12 06:41:41 +0000559
560 llvm::Constant *BuildByrefLayout(CodeGenModule &CGM, QualType T) override {
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000561 return NULLPtr;
562 }
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000563};
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000564
David Chisnall34d00052011-03-26 11:48:37 +0000565/// Class representing the legacy GCC Objective-C ABI. This is the default when
566/// -fobjc-nonfragile-abi is not specified.
567///
568/// The GCC ABI target actually generates code that is approximately compatible
569/// with the new GNUstep runtime ABI, but refrains from using any features that
570/// would not work with the GCC runtime. For example, clang always generates
571/// the extended form of the class structure, and the extra fields are simply
572/// ignored by GCC libobjc.
David Chisnalld7972f52011-03-23 16:36:54 +0000573class CGObjCGCC : public CGObjCGNU {
David Chisnall34d00052011-03-26 11:48:37 +0000574 /// The GCC ABI message lookup function. Returns an IMP pointing to the
575 /// method implementation for this message.
David Chisnall76803412011-03-23 22:52:06 +0000576 LazyRuntimeFunction MsgLookupFn;
David Chisnall34d00052011-03-26 11:48:37 +0000577 /// The GCC ABI superclass message lookup function. Takes a pointer to a
578 /// structure describing the receiver and the class, and a selector as
579 /// arguments. Returns the IMP for the corresponding method.
David Chisnall76803412011-03-23 22:52:06 +0000580 LazyRuntimeFunction MsgLookupSuperFn;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000581
David Chisnall76803412011-03-23 22:52:06 +0000582protected:
Craig Topper4f12f102014-03-12 06:41:41 +0000583 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
584 llvm::Value *cmd, llvm::MDNode *node,
585 MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000586 CGBuilderTy &Builder = CGF.Builder;
David Chisnall0cc83e72011-10-28 17:55:06 +0000587 llvm::Value *args[] = {
David Chisnall76803412011-03-23 22:52:06 +0000588 EnforceType(Builder, Receiver, IdTy),
David Chisnall0cc83e72011-10-28 17:55:06 +0000589 EnforceType(Builder, cmd, SelectorTy) };
John McCall882987f2013-02-28 19:01:20 +0000590 llvm::CallSite imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFn, args);
David Chisnall0cc83e72011-10-28 17:55:06 +0000591 imp->setMetadata(msgSendMDKind, node);
592 return imp.getInstruction();
David Chisnall76803412011-03-23 22:52:06 +0000593 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000594
John McCall7f416cc2015-09-08 08:05:57 +0000595 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
Craig Topper4f12f102014-03-12 06:41:41 +0000596 llvm::Value *cmd, MessageSendInfo &MSI) override {
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000597 CGBuilderTy &Builder = CGF.Builder;
598 llvm::Value *lookupArgs[] = {EnforceType(Builder, ObjCSuper,
599 PtrToObjCSuperTy).getPointer(), cmd};
600 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
601 }
602
603public:
604 CGObjCGCC(CodeGenModule &Mod) : CGObjCGNU(Mod, 8, 2) {
605 // IMP objc_msg_lookup(id, SEL);
Serge Guelton1d993272017-05-09 19:31:30 +0000606 MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000607 // IMP objc_msg_lookup_super(struct objc_super*, SEL);
608 MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000609 PtrToObjCSuperTy, SelectorTy);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000610 }
David Chisnalld7972f52011-03-23 16:36:54 +0000611};
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000612
David Chisnall34d00052011-03-26 11:48:37 +0000613/// Class used when targeting the new GNUstep runtime ABI.
David Chisnalld7972f52011-03-23 16:36:54 +0000614class CGObjCGNUstep : public CGObjCGNU {
David Chisnall34d00052011-03-26 11:48:37 +0000615 /// The slot lookup function. Returns a pointer to a cacheable structure
616 /// that contains (among other things) the IMP.
David Chisnall76803412011-03-23 22:52:06 +0000617 LazyRuntimeFunction SlotLookupFn;
David Chisnall34d00052011-03-26 11:48:37 +0000618 /// The GNUstep ABI superclass message lookup function. Takes a pointer to
619 /// a structure describing the receiver and the class, and a selector as
620 /// arguments. Returns the slot for the corresponding method. Superclass
621 /// message lookup rarely changes, so this is a good caching opportunity.
David Chisnall76803412011-03-23 22:52:06 +0000622 LazyRuntimeFunction SlotLookupSuperFn;
David Chisnall0d75e062012-12-17 18:54:24 +0000623 /// Specialised function for setting atomic retain properties
624 LazyRuntimeFunction SetPropertyAtomic;
625 /// Specialised function for setting atomic copy properties
626 LazyRuntimeFunction SetPropertyAtomicCopy;
627 /// Specialised function for setting nonatomic retain properties
628 LazyRuntimeFunction SetPropertyNonAtomic;
629 /// Specialised function for setting nonatomic copy properties
630 LazyRuntimeFunction SetPropertyNonAtomicCopy;
631 /// Function to perform atomic copies of C++ objects with nontrivial copy
632 /// constructors from Objective-C ivars.
633 LazyRuntimeFunction CxxAtomicObjectGetFn;
634 /// Function to perform atomic copies of C++ objects with nontrivial copy
635 /// constructors to Objective-C ivars.
636 LazyRuntimeFunction CxxAtomicObjectSetFn;
David Chisnall34d00052011-03-26 11:48:37 +0000637 /// Type of an slot structure pointer. This is returned by the various
638 /// lookup functions.
David Chisnall76803412011-03-23 22:52:06 +0000639 llvm::Type *SlotTy;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000640
John McCallc31d8932012-11-14 09:08:34 +0000641 public:
Craig Topper4f12f102014-03-12 06:41:41 +0000642 llvm::Constant *GetEHType(QualType T) override;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000643
David Chisnall76803412011-03-23 22:52:06 +0000644 protected:
Craig Topper4f12f102014-03-12 06:41:41 +0000645 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
646 llvm::Value *cmd, llvm::MDNode *node,
647 MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000648 CGBuilderTy &Builder = CGF.Builder;
649 llvm::Function *LookupFn = SlotLookupFn;
650
651 // Store the receiver on the stack so that we can reload it later
John McCall7f416cc2015-09-08 08:05:57 +0000652 Address ReceiverPtr =
653 CGF.CreateTempAlloca(Receiver->getType(), CGF.getPointerAlign());
David Chisnall76803412011-03-23 22:52:06 +0000654 Builder.CreateStore(Receiver, ReceiverPtr);
655
656 llvm::Value *self;
657
658 if (isa<ObjCMethodDecl>(CGF.CurCodeDecl)) {
659 self = CGF.LoadObjCSelf();
660 } else {
661 self = llvm::ConstantPointerNull::get(IdTy);
662 }
663
664 // The lookup function is guaranteed not to capture the receiver pointer.
Reid Klecknera0b45f42017-05-03 18:17:31 +0000665 LookupFn->addParamAttr(0, llvm::Attribute::NoCapture);
David Chisnall76803412011-03-23 22:52:06 +0000666
David Chisnall0cc83e72011-10-28 17:55:06 +0000667 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +0000668 EnforceType(Builder, ReceiverPtr.getPointer(), PtrToIdTy),
David Chisnall76803412011-03-23 22:52:06 +0000669 EnforceType(Builder, cmd, SelectorTy),
David Chisnall0cc83e72011-10-28 17:55:06 +0000670 EnforceType(Builder, self, IdTy) };
John McCall882987f2013-02-28 19:01:20 +0000671 llvm::CallSite slot = CGF.EmitRuntimeCallOrInvoke(LookupFn, args);
David Chisnall0cc83e72011-10-28 17:55:06 +0000672 slot.setOnlyReadsMemory();
David Chisnall76803412011-03-23 22:52:06 +0000673 slot->setMetadata(msgSendMDKind, node);
674
675 // Load the imp from the slot
John McCall7f416cc2015-09-08 08:05:57 +0000676 llvm::Value *imp = Builder.CreateAlignedLoad(
677 Builder.CreateStructGEP(nullptr, slot.getInstruction(), 4),
678 CGF.getPointerAlign());
David Chisnall76803412011-03-23 22:52:06 +0000679
680 // The lookup function may have changed the receiver, so make sure we use
681 // the new one.
682 Receiver = Builder.CreateLoad(ReceiverPtr, true);
683 return imp;
684 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000685
John McCall7f416cc2015-09-08 08:05:57 +0000686 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
Craig Topper4f12f102014-03-12 06:41:41 +0000687 llvm::Value *cmd,
688 MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000689 CGBuilderTy &Builder = CGF.Builder;
John McCall7f416cc2015-09-08 08:05:57 +0000690 llvm::Value *lookupArgs[] = {ObjCSuper.getPointer(), cmd};
David Chisnall76803412011-03-23 22:52:06 +0000691
John McCall882987f2013-02-28 19:01:20 +0000692 llvm::CallInst *slot =
693 CGF.EmitNounwindRuntimeCall(SlotLookupSuperFn, lookupArgs);
David Chisnall76803412011-03-23 22:52:06 +0000694 slot->setOnlyReadsMemory();
695
John McCall7f416cc2015-09-08 08:05:57 +0000696 return Builder.CreateAlignedLoad(Builder.CreateStructGEP(nullptr, slot, 4),
697 CGF.getPointerAlign());
David Chisnall76803412011-03-23 22:52:06 +0000698 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000699
David Chisnalld7972f52011-03-23 16:36:54 +0000700 public:
David Chisnall76803412011-03-23 22:52:06 +0000701 CGObjCGNUstep(CodeGenModule &Mod) : CGObjCGNU(Mod, 9, 3) {
David Chisnallbeb80132013-02-28 13:59:29 +0000702 const ObjCRuntime &R = CGM.getLangOpts().ObjCRuntime;
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000703
Serge Guelton1d993272017-05-09 19:31:30 +0000704 llvm::StructType *SlotStructTy =
705 llvm::StructType::get(PtrTy, PtrTy, PtrTy, IntTy, IMPTy);
David Chisnall76803412011-03-23 22:52:06 +0000706 SlotTy = llvm::PointerType::getUnqual(SlotStructTy);
707 // Slot_t objc_msg_lookup_sender(id *receiver, SEL selector, id sender);
708 SlotLookupFn.init(&CGM, "objc_msg_lookup_sender", SlotTy, PtrToIdTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000709 SelectorTy, IdTy);
David Chisnall76803412011-03-23 22:52:06 +0000710 // Slot_t objc_msg_lookup_super(struct objc_super*, SEL);
711 SlotLookupSuperFn.init(&CGM, "objc_slot_lookup_super", SlotTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000712 PtrToObjCSuperTy, SelectorTy);
David Chisnalld3858d62011-03-25 11:57:33 +0000713 // If we're in ObjC++ mode, then we want to make
David Blaikiebbafb8a2012-03-11 07:00:24 +0000714 if (CGM.getLangOpts().CPlusPlus) {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000715 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
David Chisnalld3858d62011-03-25 11:57:33 +0000716 // void *__cxa_begin_catch(void *e)
Serge Guelton1d993272017-05-09 19:31:30 +0000717 EnterCatchFn.init(&CGM, "__cxa_begin_catch", PtrTy, PtrTy);
David Chisnalld3858d62011-03-25 11:57:33 +0000718 // void __cxa_end_catch(void)
Serge Guelton1d993272017-05-09 19:31:30 +0000719 ExitCatchFn.init(&CGM, "__cxa_end_catch", VoidTy);
David Chisnalld3858d62011-03-25 11:57:33 +0000720 // void _Unwind_Resume_or_Rethrow(void*)
David Chisnall0d75e062012-12-17 18:54:24 +0000721 ExceptionReThrowFn.init(&CGM, "_Unwind_Resume_or_Rethrow", VoidTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000722 PtrTy);
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000723 } else if (R.getVersion() >= VersionTuple(1, 7)) {
724 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
725 // id objc_begin_catch(void *e)
Serge Guelton1d993272017-05-09 19:31:30 +0000726 EnterCatchFn.init(&CGM, "objc_begin_catch", IdTy, PtrTy);
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000727 // void objc_end_catch(void)
Serge Guelton1d993272017-05-09 19:31:30 +0000728 ExitCatchFn.init(&CGM, "objc_end_catch", VoidTy);
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000729 // void _Unwind_Resume_or_Rethrow(void*)
Serge Guelton1d993272017-05-09 19:31:30 +0000730 ExceptionReThrowFn.init(&CGM, "objc_exception_rethrow", VoidTy, PtrTy);
David Chisnalld3858d62011-03-25 11:57:33 +0000731 }
David Chisnall0d75e062012-12-17 18:54:24 +0000732 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
733 SetPropertyAtomic.init(&CGM, "objc_setProperty_atomic", VoidTy, IdTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000734 SelectorTy, IdTy, PtrDiffTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000735 SetPropertyAtomicCopy.init(&CGM, "objc_setProperty_atomic_copy", VoidTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000736 IdTy, SelectorTy, IdTy, PtrDiffTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000737 SetPropertyNonAtomic.init(&CGM, "objc_setProperty_nonatomic", VoidTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000738 IdTy, SelectorTy, IdTy, PtrDiffTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000739 SetPropertyNonAtomicCopy.init(&CGM, "objc_setProperty_nonatomic_copy",
Serge Guelton1d993272017-05-09 19:31:30 +0000740 VoidTy, IdTy, SelectorTy, IdTy, PtrDiffTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000741 // void objc_setCppObjectAtomic(void *dest, const void *src, void
742 // *helper);
743 CxxAtomicObjectSetFn.init(&CGM, "objc_setCppObjectAtomic", VoidTy, PtrTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000744 PtrTy, PtrTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000745 // void objc_getCppObjectAtomic(void *dest, const void *src, void
746 // *helper);
747 CxxAtomicObjectGetFn.init(&CGM, "objc_getCppObjectAtomic", VoidTy, PtrTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000748 PtrTy, PtrTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000749 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000750
Craig Topper4f12f102014-03-12 06:41:41 +0000751 llvm::Constant *GetCppAtomicObjectGetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +0000752 // The optimised functions were added in version 1.7 of the GNUstep
753 // runtime.
754 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
755 VersionTuple(1, 7));
756 return CxxAtomicObjectGetFn;
757 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000758
Craig Topper4f12f102014-03-12 06:41:41 +0000759 llvm::Constant *GetCppAtomicObjectSetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +0000760 // The optimised functions were added in version 1.7 of the GNUstep
761 // runtime.
762 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
763 VersionTuple(1, 7));
764 return CxxAtomicObjectSetFn;
765 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000766
Craig Topper4f12f102014-03-12 06:41:41 +0000767 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
768 bool copy) override {
David Chisnall0d75e062012-12-17 18:54:24 +0000769 // The optimised property functions omit the GC check, and so are not
770 // safe to use in GC mode. The standard functions are fast in GC mode,
771 // so there is less advantage in using them.
772 assert ((CGM.getLangOpts().getGC() == LangOptions::NonGC));
773 // The optimised functions were added in version 1.7 of the GNUstep
774 // runtime.
775 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
776 VersionTuple(1, 7));
777
778 if (atomic) {
779 if (copy) return SetPropertyAtomicCopy;
780 return SetPropertyAtomic;
781 }
David Chisnall0d75e062012-12-17 18:54:24 +0000782
Ted Kremenek090a2732014-03-07 18:53:05 +0000783 return copy ? SetPropertyNonAtomicCopy : SetPropertyNonAtomic;
David Chisnall76803412011-03-23 22:52:06 +0000784 }
David Chisnalld7972f52011-03-23 16:36:54 +0000785};
786
Alp Toker272e9bc2013-11-25 00:40:53 +0000787/// Support for the ObjFW runtime.
John McCall3deb1ad2012-08-21 02:47:43 +0000788class CGObjCObjFW: public CGObjCGNU {
789protected:
790 /// The GCC ABI message lookup function. Returns an IMP pointing to the
791 /// method implementation for this message.
792 LazyRuntimeFunction MsgLookupFn;
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000793 /// stret lookup function. While this does not seem to make sense at the
794 /// first look, this is required to call the correct forwarding function.
795 LazyRuntimeFunction MsgLookupFnSRet;
John McCall3deb1ad2012-08-21 02:47:43 +0000796 /// The GCC ABI superclass message lookup function. Takes a pointer to a
797 /// structure describing the receiver and the class, and a selector as
798 /// arguments. Returns the IMP for the corresponding method.
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000799 LazyRuntimeFunction MsgLookupSuperFn, MsgLookupSuperFnSRet;
John McCall3deb1ad2012-08-21 02:47:43 +0000800
Craig Topper4f12f102014-03-12 06:41:41 +0000801 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
802 llvm::Value *cmd, llvm::MDNode *node,
803 MessageSendInfo &MSI) override {
John McCall3deb1ad2012-08-21 02:47:43 +0000804 CGBuilderTy &Builder = CGF.Builder;
805 llvm::Value *args[] = {
806 EnforceType(Builder, Receiver, IdTy),
807 EnforceType(Builder, cmd, SelectorTy) };
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000808
809 llvm::CallSite imp;
810 if (CGM.ReturnTypeUsesSRet(MSI.CallInfo))
811 imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFnSRet, args);
812 else
813 imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFn, args);
814
John McCall3deb1ad2012-08-21 02:47:43 +0000815 imp->setMetadata(msgSendMDKind, node);
816 return imp.getInstruction();
817 }
818
John McCall7f416cc2015-09-08 08:05:57 +0000819 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
Craig Topper4f12f102014-03-12 06:41:41 +0000820 llvm::Value *cmd, MessageSendInfo &MSI) override {
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +0000821 CGBuilderTy &Builder = CGF.Builder;
822 llvm::Value *lookupArgs[] = {
823 EnforceType(Builder, ObjCSuper.getPointer(), PtrToObjCSuperTy), cmd,
824 };
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000825
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +0000826 if (CGM.ReturnTypeUsesSRet(MSI.CallInfo))
827 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFnSRet, lookupArgs);
828 else
829 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
830 }
John McCall3deb1ad2012-08-21 02:47:43 +0000831
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +0000832 llvm::Value *GetClassNamed(CodeGenFunction &CGF, const std::string &Name,
833 bool isWeak) override {
John McCall775086e2012-07-12 02:07:58 +0000834 if (isWeak)
John McCall882987f2013-02-28 19:01:20 +0000835 return CGObjCGNU::GetClassNamed(CGF, Name, isWeak);
John McCall775086e2012-07-12 02:07:58 +0000836
837 EmitClassRef(Name);
John McCall775086e2012-07-12 02:07:58 +0000838 std::string SymbolName = "_OBJC_CLASS_" + Name;
John McCall775086e2012-07-12 02:07:58 +0000839 llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(SymbolName);
John McCall775086e2012-07-12 02:07:58 +0000840 if (!ClassSymbol)
841 ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false,
842 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +0000843 nullptr, SymbolName);
John McCall775086e2012-07-12 02:07:58 +0000844 return ClassSymbol;
845 }
846
847public:
John McCall3deb1ad2012-08-21 02:47:43 +0000848 CGObjCObjFW(CodeGenModule &Mod): CGObjCGNU(Mod, 9, 3) {
849 // IMP objc_msg_lookup(id, SEL);
Serge Guelton1d993272017-05-09 19:31:30 +0000850 MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy);
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000851 MsgLookupFnSRet.init(&CGM, "objc_msg_lookup_stret", IMPTy, IdTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000852 SelectorTy);
John McCall3deb1ad2012-08-21 02:47:43 +0000853 // IMP objc_msg_lookup_super(struct objc_super*, SEL);
854 MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000855 PtrToObjCSuperTy, SelectorTy);
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000856 MsgLookupSuperFnSRet.init(&CGM, "objc_msg_lookup_super_stret", IMPTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000857 PtrToObjCSuperTy, SelectorTy);
John McCall3deb1ad2012-08-21 02:47:43 +0000858 }
John McCall775086e2012-07-12 02:07:58 +0000859};
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000860} // end anonymous namespace
861
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000862/// Emits a reference to a dummy variable which is emitted with each class.
863/// This ensures that a linker error will be generated when trying to link
864/// together modules where a referenced class is not defined.
Mike Stumpdd93a192009-07-31 21:31:32 +0000865void CGObjCGNU::EmitClassRef(const std::string &className) {
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000866 std::string symbolRef = "__objc_class_ref_" + className;
867 // Don't emit two copies of the same symbol
Mike Stumpdd93a192009-07-31 21:31:32 +0000868 if (TheModule.getGlobalVariable(symbolRef))
869 return;
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000870 std::string symbolName = "__objc_class_name_" + className;
871 llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(symbolName);
872 if (!ClassSymbol) {
Owen Andersonc10c8d32009-07-08 19:05:04 +0000873 ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +0000874 llvm::GlobalValue::ExternalLinkage,
875 nullptr, symbolName);
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000876 }
Owen Andersonc10c8d32009-07-08 19:05:04 +0000877 new llvm::GlobalVariable(TheModule, ClassSymbol->getType(), true,
Chris Lattnerc58e5692009-08-05 05:25:18 +0000878 llvm::GlobalValue::WeakAnyLinkage, ClassSymbol, symbolRef);
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000879}
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000880
Craig Topperbf3e3272014-08-30 16:55:52 +0000881static std::string SymbolNameForMethod( StringRef ClassName,
882 StringRef CategoryName, const Selector MethodName,
David Chisnalld7972f52011-03-23 16:36:54 +0000883 bool isClassMethod) {
884 std::string MethodNameColonStripped = MethodName.getAsString();
David Chisnall035ead22010-01-14 14:08:19 +0000885 std::replace(MethodNameColonStripped.begin(), MethodNameColonStripped.end(),
886 ':', '_');
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000887 return (Twine(isClassMethod ? "_c_" : "_i_") + ClassName + "_" +
David Chisnalld7972f52011-03-23 16:36:54 +0000888 CategoryName + "_" + MethodNameColonStripped).str();
David Chisnall0a24fd32010-05-08 20:58:05 +0000889}
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000890
David Chisnalld7972f52011-03-23 16:36:54 +0000891CGObjCGNU::CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion,
Craig Topper8a13c412014-05-21 05:09:00 +0000892 unsigned protocolClassVersion)
John McCalla729c622012-02-17 03:33:10 +0000893 : CGObjCRuntime(cgm), TheModule(CGM.getModule()),
Craig Topper8a13c412014-05-21 05:09:00 +0000894 VMContext(cgm.getLLVMContext()), ClassPtrAlias(nullptr),
895 MetaClassPtrAlias(nullptr), RuntimeVersion(runtimeABIVersion),
896 ProtocolVersion(protocolClassVersion) {
David Chisnall01aa4672010-04-28 19:33:36 +0000897
898 msgSendMDKind = VMContext.getMDKindID("GNUObjCMessageSend");
899
David Chisnalld7972f52011-03-23 16:36:54 +0000900 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner8d3f4a42009-01-27 05:06:01 +0000901 IntTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +0000902 Types.ConvertType(CGM.getContext().IntTy));
Chris Lattner8d3f4a42009-01-27 05:06:01 +0000903 LongTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +0000904 Types.ConvertType(CGM.getContext().LongTy));
David Chisnall168b80f2010-12-26 22:13:16 +0000905 SizeTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +0000906 Types.ConvertType(CGM.getContext().getSizeType()));
David Chisnall168b80f2010-12-26 22:13:16 +0000907 PtrDiffTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +0000908 Types.ConvertType(CGM.getContext().getPointerDiffType()));
David Chisnall168b80f2010-12-26 22:13:16 +0000909 BoolTy = CGM.getTypes().ConvertType(CGM.getContext().BoolTy);
Mike Stump11289f42009-09-09 15:08:12 +0000910
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000911 Int8Ty = llvm::Type::getInt8Ty(VMContext);
912 // C string type. Used in lots of places.
913 PtrToInt8Ty = llvm::PointerType::getUnqual(Int8Ty);
914
Owen Andersonb7a2fe62009-07-24 23:12:58 +0000915 Zeros[0] = llvm::ConstantInt::get(LongTy, 0);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000916 Zeros[1] = Zeros[0];
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000917 NULLPtr = llvm::ConstantPointerNull::get(PtrToInt8Ty);
Chris Lattner4bd55962008-03-30 23:03:07 +0000918 // Get the selector Type.
David Chisnall481e3a82010-01-23 02:40:42 +0000919 QualType selTy = CGM.getContext().getObjCSelType();
920 if (QualType() == selTy) {
921 SelectorTy = PtrToInt8Ty;
922 } else {
923 SelectorTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(selTy));
924 }
Chris Lattner8d3f4a42009-01-27 05:06:01 +0000925
Owen Anderson9793f0e2009-07-29 22:16:19 +0000926 PtrToIntTy = llvm::PointerType::getUnqual(IntTy);
Chris Lattner4bd55962008-03-30 23:03:07 +0000927 PtrTy = PtrToInt8Ty;
Mike Stump11289f42009-09-09 15:08:12 +0000928
David Chisnallcdd207e2011-10-04 15:35:30 +0000929 Int32Ty = llvm::Type::getInt32Ty(VMContext);
930 Int64Ty = llvm::Type::getInt64Ty(VMContext);
931
Rafael Espindola3cc5c2d2014-01-09 21:32:51 +0000932 IntPtrTy =
933 CGM.getDataLayout().getPointerSizeInBits() == 32 ? Int32Ty : Int64Ty;
David Chisnalle0dc7cb2011-10-08 08:54:36 +0000934
Chris Lattner4bd55962008-03-30 23:03:07 +0000935 // Object type
David Chisnall10d2ded2011-04-29 14:10:35 +0000936 QualType UnqualIdTy = CGM.getContext().getObjCIdType();
937 ASTIdTy = CanQualType();
938 if (UnqualIdTy != QualType()) {
939 ASTIdTy = CGM.getContext().getCanonicalType(UnqualIdTy);
David Chisnall481e3a82010-01-23 02:40:42 +0000940 IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy));
David Chisnall10d2ded2011-04-29 14:10:35 +0000941 } else {
942 IdTy = PtrToInt8Ty;
David Chisnall481e3a82010-01-23 02:40:42 +0000943 }
David Chisnall5bb4efd2010-02-03 15:59:02 +0000944 PtrToIdTy = llvm::PointerType::getUnqual(IdTy);
Mike Stump11289f42009-09-09 15:08:12 +0000945
Serge Guelton1d993272017-05-09 19:31:30 +0000946 ObjCSuperTy = llvm::StructType::get(IdTy, IdTy);
David Chisnall76803412011-03-23 22:52:06 +0000947 PtrToObjCSuperTy = llvm::PointerType::getUnqual(ObjCSuperTy);
948
Chris Lattnera5f58b02011-07-09 17:41:47 +0000949 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
David Chisnalld7972f52011-03-23 16:36:54 +0000950
951 // void objc_exception_throw(id);
Serge Guelton1d993272017-05-09 19:31:30 +0000952 ExceptionThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy);
953 ExceptionReThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000954 // int objc_sync_enter(id);
Serge Guelton1d993272017-05-09 19:31:30 +0000955 SyncEnterFn.init(&CGM, "objc_sync_enter", IntTy, IdTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000956 // int objc_sync_exit(id);
Serge Guelton1d993272017-05-09 19:31:30 +0000957 SyncExitFn.init(&CGM, "objc_sync_exit", IntTy, IdTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000958
959 // void objc_enumerationMutation (id)
Serge Guelton1d993272017-05-09 19:31:30 +0000960 EnumerationMutationFn.init(&CGM, "objc_enumerationMutation", VoidTy, IdTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000961
962 // id objc_getProperty(id, SEL, ptrdiff_t, BOOL)
963 GetPropertyFn.init(&CGM, "objc_getProperty", IdTy, IdTy, SelectorTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000964 PtrDiffTy, BoolTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000965 // void objc_setProperty(id, SEL, ptrdiff_t, id, BOOL, BOOL)
966 SetPropertyFn.init(&CGM, "objc_setProperty", VoidTy, IdTy, SelectorTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000967 PtrDiffTy, IdTy, BoolTy, BoolTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000968 // void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL)
Serge Guelton1d993272017-05-09 19:31:30 +0000969 GetStructPropertyFn.init(&CGM, "objc_getPropertyStruct", VoidTy, PtrTy, PtrTy,
970 PtrDiffTy, BoolTy, BoolTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000971 // void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL)
Serge Guelton1d993272017-05-09 19:31:30 +0000972 SetStructPropertyFn.init(&CGM, "objc_setPropertyStruct", VoidTy, PtrTy, PtrTy,
973 PtrDiffTy, BoolTy, BoolTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000974
Chris Lattner4bd55962008-03-30 23:03:07 +0000975 // IMP type
Chris Lattnera5f58b02011-07-09 17:41:47 +0000976 llvm::Type *IMPArgs[] = { IdTy, SelectorTy };
David Chisnall76803412011-03-23 22:52:06 +0000977 IMPTy = llvm::PointerType::getUnqual(llvm::FunctionType::get(IdTy, IMPArgs,
978 true));
David Chisnall5bb4efd2010-02-03 15:59:02 +0000979
David Blaikiebbafb8a2012-03-11 07:00:24 +0000980 const LangOptions &Opts = CGM.getLangOpts();
Douglas Gregor79a91412011-09-13 17:21:33 +0000981 if ((Opts.getGC() != LangOptions::NonGC) || Opts.ObjCAutoRefCount)
David Chisnalla918b882011-07-07 11:22:31 +0000982 RuntimeVersion = 10;
983
David Chisnalld3858d62011-03-25 11:57:33 +0000984 // Don't bother initialising the GC stuff unless we're compiling in GC mode
Douglas Gregor79a91412011-09-13 17:21:33 +0000985 if (Opts.getGC() != LangOptions::NonGC) {
David Chisnall5c511772011-05-22 22:37:08 +0000986 // This is a bit of an hack. We should sort this out by having a proper
987 // CGObjCGNUstep subclass for GC, but we may want to really support the old
988 // ABI and GC added in ObjectiveC2.framework, so we fudge it a bit for now
David Chisnall5bb4efd2010-02-03 15:59:02 +0000989 // Get selectors needed in GC mode
990 RetainSel = GetNullarySelector("retain", CGM.getContext());
991 ReleaseSel = GetNullarySelector("release", CGM.getContext());
992 AutoreleaseSel = GetNullarySelector("autorelease", CGM.getContext());
993
994 // Get functions needed in GC mode
995
996 // id objc_assign_ivar(id, id, ptrdiff_t);
Serge Guelton1d993272017-05-09 19:31:30 +0000997 IvarAssignFn.init(&CGM, "objc_assign_ivar", IdTy, IdTy, IdTy, PtrDiffTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +0000998 // id objc_assign_strongCast (id, id*)
David Chisnalld7972f52011-03-23 16:36:54 +0000999 StrongCastAssignFn.init(&CGM, "objc_assign_strongCast", IdTy, IdTy,
Serge Guelton1d993272017-05-09 19:31:30 +00001000 PtrToIdTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001001 // id objc_assign_global(id, id*);
Serge Guelton1d993272017-05-09 19:31:30 +00001002 GlobalAssignFn.init(&CGM, "objc_assign_global", IdTy, IdTy, PtrToIdTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001003 // id objc_assign_weak(id, id*);
Serge Guelton1d993272017-05-09 19:31:30 +00001004 WeakAssignFn.init(&CGM, "objc_assign_weak", IdTy, IdTy, PtrToIdTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001005 // id objc_read_weak(id*);
Serge Guelton1d993272017-05-09 19:31:30 +00001006 WeakReadFn.init(&CGM, "objc_read_weak", IdTy, PtrToIdTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001007 // void *objc_memmove_collectable(void*, void *, size_t);
David Chisnalld7972f52011-03-23 16:36:54 +00001008 MemMoveFn.init(&CGM, "objc_memmove_collectable", PtrTy, PtrTy, PtrTy,
Serge Guelton1d993272017-05-09 19:31:30 +00001009 SizeTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001010 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001011}
Mike Stumpdd93a192009-07-31 21:31:32 +00001012
John McCall882987f2013-02-28 19:01:20 +00001013llvm::Value *CGObjCGNU::GetClassNamed(CodeGenFunction &CGF,
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00001014 const std::string &Name, bool isWeak) {
John McCall7f416cc2015-09-08 08:05:57 +00001015 llvm::Constant *ClassName = MakeConstantString(Name);
David Chisnalldf349172010-01-08 00:14:31 +00001016 // With the incompatible ABI, this will need to be replaced with a direct
1017 // reference to the class symbol. For the compatible nonfragile ABI we are
1018 // still performing this lookup at run time but emitting the symbol for the
1019 // class externally so that we can make the switch later.
David Chisnall920e83b2011-06-29 13:16:41 +00001020 //
1021 // Libobjc2 contains an LLVM pass that replaces calls to objc_lookup_class
1022 // with memoized versions or with static references if it's safe to do so.
David Chisnall08d67332011-06-30 10:14:37 +00001023 if (!isWeak)
1024 EmitClassRef(Name);
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +00001025
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001026 llvm::Constant *ClassLookupFn =
Jay Foad5709f7c2011-07-29 13:56:53 +00001027 CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, PtrToInt8Ty, true),
Fariborz Jahanian3b636c12009-03-30 18:02:14 +00001028 "objc_lookup_class");
John McCall882987f2013-02-28 19:01:20 +00001029 return CGF.EmitNounwindRuntimeCall(ClassLookupFn, ClassName);
Chris Lattner4bd55962008-03-30 23:03:07 +00001030}
1031
David Chisnall920e83b2011-06-29 13:16:41 +00001032// This has to perform the lookup every time, since posing and related
1033// techniques can modify the name -> class mapping.
John McCall882987f2013-02-28 19:01:20 +00001034llvm::Value *CGObjCGNU::GetClass(CodeGenFunction &CGF,
David Chisnall920e83b2011-06-29 13:16:41 +00001035 const ObjCInterfaceDecl *OID) {
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00001036 auto *Value =
1037 GetClassNamed(CGF, OID->getNameAsString(), OID->isWeakImported());
1038 if (CGM.getTriple().isOSBinFormatCOFF()) {
1039 if (auto *ClassSymbol = dyn_cast<llvm::GlobalVariable>(Value)) {
1040 auto DLLStorage = llvm::GlobalValue::DefaultStorageClass;
1041 if (OID->hasAttr<DLLExportAttr>())
1042 DLLStorage = llvm::GlobalValue::DLLExportStorageClass;
1043 else if (OID->hasAttr<DLLImportAttr>())
1044 DLLStorage = llvm::GlobalValue::DLLImportStorageClass;
1045 ClassSymbol->setDLLStorageClass(DLLStorage);
1046 }
1047 }
1048 return Value;
David Chisnall920e83b2011-06-29 13:16:41 +00001049}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001050
John McCall882987f2013-02-28 19:01:20 +00001051llvm::Value *CGObjCGNU::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00001052 auto *Value = GetClassNamed(CGF, "NSAutoreleasePool", false);
1053 if (CGM.getTriple().isOSBinFormatCOFF()) {
1054 if (auto *ClassSymbol = dyn_cast<llvm::GlobalVariable>(Value)) {
1055 IdentifierInfo &II = CGF.CGM.getContext().Idents.get("NSAutoreleasePool");
1056 TranslationUnitDecl *TUDecl = CGM.getContext().getTranslationUnitDecl();
1057 DeclContext *DC = TranslationUnitDecl::castToDeclContext(TUDecl);
1058
1059 const VarDecl *VD = nullptr;
1060 for (const auto &Result : DC->lookup(&II))
1061 if ((VD = dyn_cast<VarDecl>(Result)))
1062 break;
1063
1064 auto DLLStorage = llvm::GlobalValue::DefaultStorageClass;
1065 if (!VD || VD->hasAttr<DLLImportAttr>())
1066 DLLStorage = llvm::GlobalValue::DLLImportStorageClass;
1067 else if (VD->hasAttr<DLLExportAttr>())
1068 DLLStorage = llvm::GlobalValue::DLLExportStorageClass;
1069
1070 ClassSymbol->setDLLStorageClass(DLLStorage);
1071 }
1072 }
1073 return Value;
David Chisnall920e83b2011-06-29 13:16:41 +00001074}
1075
John McCall882987f2013-02-28 19:01:20 +00001076llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF, Selector Sel,
John McCall7f416cc2015-09-08 08:05:57 +00001077 const std::string &TypeEncoding) {
Craig Topperfa159c12013-07-14 16:47:36 +00001078 SmallVectorImpl<TypedSelector> &Types = SelectorTable[Sel];
Craig Topper8a13c412014-05-21 05:09:00 +00001079 llvm::GlobalAlias *SelValue = nullptr;
David Chisnalld7972f52011-03-23 16:36:54 +00001080
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001081 for (SmallVectorImpl<TypedSelector>::iterator i = Types.begin(),
David Chisnalld7972f52011-03-23 16:36:54 +00001082 e = Types.end() ; i!=e ; i++) {
1083 if (i->first == TypeEncoding) {
1084 SelValue = i->second;
1085 break;
1086 }
1087 }
Craig Topper8a13c412014-05-21 05:09:00 +00001088 if (!SelValue) {
Rafael Espindola234405b2014-05-17 21:30:14 +00001089 SelValue = llvm::GlobalAlias::create(
David Blaikieaff29d32015-09-14 18:02:04 +00001090 SelectorTy->getElementType(), 0, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola61722772014-05-17 19:58:16 +00001091 ".objc_selector_" + Sel.getAsString(), &TheModule);
Benjamin Kramer3204b152015-05-29 19:42:19 +00001092 Types.emplace_back(TypeEncoding, SelValue);
David Chisnalld7972f52011-03-23 16:36:54 +00001093 }
1094
David Chisnall76803412011-03-23 22:52:06 +00001095 return SelValue;
David Chisnalld7972f52011-03-23 16:36:54 +00001096}
1097
John McCall7f416cc2015-09-08 08:05:57 +00001098Address CGObjCGNU::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
1099 llvm::Value *SelValue = GetSelector(CGF, Sel);
1100
1101 // Store it to a temporary. Does this satisfy the semantics of
1102 // GetAddrOfSelector? Hopefully.
1103 Address tmp = CGF.CreateTempAlloca(SelValue->getType(),
1104 CGF.getPointerAlign());
1105 CGF.Builder.CreateStore(SelValue, tmp);
1106 return tmp;
1107}
1108
1109llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF, Selector Sel) {
1110 return GetSelector(CGF, Sel, std::string());
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001111}
1112
John McCall882987f2013-02-28 19:01:20 +00001113llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF,
1114 const ObjCMethodDecl *Method) {
John McCall843dfcc2016-11-29 21:57:00 +00001115 std::string SelTypes = CGM.getContext().getObjCEncodingForMethodDecl(Method);
John McCall7f416cc2015-09-08 08:05:57 +00001116 return GetSelector(CGF, Method->getSelector(), SelTypes);
Chris Lattner6d522c02008-06-26 04:37:12 +00001117}
1118
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001119llvm::Constant *CGObjCGNU::GetEHType(QualType T) {
John McCallc31d8932012-11-14 09:08:34 +00001120 if (T->isObjCIdType() || T->isObjCQualifiedIdType()) {
1121 // With the old ABI, there was only one kind of catchall, which broke
1122 // foreign exceptions. With the new ABI, we use __objc_id_typeinfo as
1123 // a pointer indicating object catchalls, and NULL to indicate real
1124 // catchalls
1125 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1126 return MakeConstantString("@id");
1127 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00001128 return nullptr;
John McCallc31d8932012-11-14 09:08:34 +00001129 }
David Chisnalld3858d62011-03-25 11:57:33 +00001130 }
John McCallc31d8932012-11-14 09:08:34 +00001131
1132 // All other types should be Objective-C interface pointer types.
1133 const ObjCObjectPointerType *OPT = T->getAs<ObjCObjectPointerType>();
1134 assert(OPT && "Invalid @catch type.");
1135 const ObjCInterfaceDecl *IDecl = OPT->getObjectType()->getInterface();
1136 assert(IDecl && "Invalid @catch type.");
1137 return MakeConstantString(IDecl->getIdentifier()->getName());
1138}
1139
1140llvm::Constant *CGObjCGNUstep::GetEHType(QualType T) {
1141 if (!CGM.getLangOpts().CPlusPlus)
1142 return CGObjCGNU::GetEHType(T);
1143
David Chisnalle1d2584d2011-03-20 21:35:39 +00001144 // For Objective-C++, we want to provide the ability to catch both C++ and
1145 // Objective-C objects in the same function.
1146
1147 // There's a particular fixed type info for 'id'.
1148 if (T->isObjCIdType() ||
1149 T->isObjCQualifiedIdType()) {
1150 llvm::Constant *IDEHType =
1151 CGM.getModule().getGlobalVariable("__objc_id_type_info");
1152 if (!IDEHType)
1153 IDEHType =
1154 new llvm::GlobalVariable(CGM.getModule(), PtrToInt8Ty,
1155 false,
1156 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00001157 nullptr, "__objc_id_type_info");
David Chisnalle1d2584d2011-03-20 21:35:39 +00001158 return llvm::ConstantExpr::getBitCast(IDEHType, PtrToInt8Ty);
1159 }
1160
1161 const ObjCObjectPointerType *PT =
1162 T->getAs<ObjCObjectPointerType>();
1163 assert(PT && "Invalid @catch type.");
1164 const ObjCInterfaceType *IT = PT->getInterfaceType();
1165 assert(IT && "Invalid @catch type.");
1166 std::string className = IT->getDecl()->getIdentifier()->getName();
1167
1168 std::string typeinfoName = "__objc_eh_typeinfo_" + className;
1169
1170 // Return the existing typeinfo if it exists
1171 llvm::Constant *typeinfo = TheModule.getGlobalVariable(typeinfoName);
David Chisnalld6639342012-03-20 16:25:52 +00001172 if (typeinfo)
1173 return llvm::ConstantExpr::getBitCast(typeinfo, PtrToInt8Ty);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001174
1175 // Otherwise create it.
1176
1177 // vtable for gnustep::libobjc::__objc_class_type_info
1178 // It's quite ugly hard-coding this. Ideally we'd generate it using the host
1179 // platform's name mangling.
1180 const char *vtableName = "_ZTVN7gnustep7libobjc22__objc_class_type_infoE";
David Blaikiee3b172a2015-04-02 18:55:21 +00001181 auto *Vtable = TheModule.getGlobalVariable(vtableName);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001182 if (!Vtable) {
1183 Vtable = new llvm::GlobalVariable(TheModule, PtrToInt8Ty, true,
Craig Topper8a13c412014-05-21 05:09:00 +00001184 llvm::GlobalValue::ExternalLinkage,
1185 nullptr, vtableName);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001186 }
1187 llvm::Constant *Two = llvm::ConstantInt::get(IntTy, 2);
David Blaikiee3b172a2015-04-02 18:55:21 +00001188 auto *BVtable = llvm::ConstantExpr::getBitCast(
1189 llvm::ConstantExpr::getGetElementPtr(Vtable->getValueType(), Vtable, Two),
1190 PtrToInt8Ty);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001191
1192 llvm::Constant *typeName =
1193 ExportUniqueString(className, "__objc_eh_typename_");
1194
John McCall23c9dc62016-11-28 22:18:27 +00001195 ConstantInitBuilder builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001196 auto fields = builder.beginStruct();
1197 fields.add(BVtable);
1198 fields.add(typeName);
1199 llvm::Constant *TI =
1200 fields.finishAndCreateGlobal("__objc_eh_typeinfo_" + className,
1201 CGM.getPointerAlign(),
1202 /*constant*/ false,
1203 llvm::GlobalValue::LinkOnceODRLinkage);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001204 return llvm::ConstantExpr::getBitCast(TI, PtrToInt8Ty);
John McCall2ca705e2010-07-24 00:37:23 +00001205}
1206
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001207/// Generate an NSConstantString object.
John McCall7f416cc2015-09-08 08:05:57 +00001208ConstantAddress CGObjCGNU::GenerateConstantString(const StringLiteral *SL) {
David Chisnall358e7512010-01-27 12:49:23 +00001209
Benjamin Kramer35b077e2010-08-17 12:54:38 +00001210 std::string Str = SL->getString().str();
John McCall7f416cc2015-09-08 08:05:57 +00001211 CharUnits Align = CGM.getPointerAlign();
David Chisnall481e3a82010-01-23 02:40:42 +00001212
David Chisnall358e7512010-01-27 12:49:23 +00001213 // Look for an existing one
1214 llvm::StringMap<llvm::Constant*>::iterator old = ObjCStrings.find(Str);
1215 if (old != ObjCStrings.end())
John McCall7f416cc2015-09-08 08:05:57 +00001216 return ConstantAddress(old->getValue(), Align);
David Chisnall358e7512010-01-27 12:49:23 +00001217
David Blaikiebbafb8a2012-03-11 07:00:24 +00001218 StringRef StringClass = CGM.getLangOpts().ObjCConstantStringClass;
David Chisnall207a6302012-01-04 12:02:13 +00001219
1220 if (StringClass.empty()) StringClass = "NXConstantString";
1221
1222 std::string Sym = "_OBJC_CLASS_";
1223 Sym += StringClass;
1224
1225 llvm::Constant *isa = TheModule.getNamedGlobal(Sym);
1226
1227 if (!isa)
1228 isa = new llvm::GlobalVariable(TheModule, IdTy, /* isConstant */false,
Craig Topper8a13c412014-05-21 05:09:00 +00001229 llvm::GlobalValue::ExternalWeakLinkage, nullptr, Sym);
David Chisnall207a6302012-01-04 12:02:13 +00001230 else if (isa->getType() != PtrToIdTy)
1231 isa = llvm::ConstantExpr::getBitCast(isa, PtrToIdTy);
1232
John McCall23c9dc62016-11-28 22:18:27 +00001233 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001234 auto Fields = Builder.beginStruct();
1235 Fields.add(isa);
1236 Fields.add(MakeConstantString(Str));
1237 Fields.addInt(IntTy, Str.size());
1238 llvm::Constant *ObjCStr =
1239 Fields.finishAndCreateGlobal(".objc_str", Align);
David Chisnall358e7512010-01-27 12:49:23 +00001240 ObjCStr = llvm::ConstantExpr::getBitCast(ObjCStr, PtrToInt8Ty);
1241 ObjCStrings[Str] = ObjCStr;
1242 ConstantStrings.push_back(ObjCStr);
John McCall7f416cc2015-09-08 08:05:57 +00001243 return ConstantAddress(ObjCStr, Align);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001244}
1245
1246///Generates a message send where the super is the receiver. This is a message
1247///send to self with special delivery semantics indicating which class's method
1248///should be called.
David Chisnalld7972f52011-03-23 16:36:54 +00001249RValue
1250CGObjCGNU::GenerateMessageSendSuper(CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001251 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001252 QualType ResultType,
1253 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001254 const ObjCInterfaceDecl *Class,
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001255 bool isCategoryImpl,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001256 llvm::Value *Receiver,
Daniel Dunbarc722b852008-08-30 03:02:31 +00001257 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001258 const CallArgList &CallArgs,
1259 const ObjCMethodDecl *Method) {
David Chisnall8a42d192011-05-28 14:09:01 +00001260 CGBuilderTy &Builder = CGF.Builder;
David Blaikiebbafb8a2012-03-11 07:00:24 +00001261 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
David Chisnall5bb4efd2010-02-03 15:59:02 +00001262 if (Sel == RetainSel || Sel == AutoreleaseSel) {
David Chisnall8a42d192011-05-28 14:09:01 +00001263 return RValue::get(EnforceType(Builder, Receiver,
1264 CGM.getTypes().ConvertType(ResultType)));
David Chisnall5bb4efd2010-02-03 15:59:02 +00001265 }
1266 if (Sel == ReleaseSel) {
Craig Topper8a13c412014-05-21 05:09:00 +00001267 return RValue::get(nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001268 }
1269 }
David Chisnallea529a42010-05-01 12:37:16 +00001270
John McCall882987f2013-02-28 19:01:20 +00001271 llvm::Value *cmd = GetSelector(CGF, Sel);
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00001272 CallArgList ActualArgs;
1273
Eli Friedman43dca6a2011-05-02 17:57:46 +00001274 ActualArgs.add(RValue::get(EnforceType(Builder, Receiver, IdTy)), ASTIdTy);
1275 ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00001276 ActualArgs.addFrom(CallArgs);
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00001277
John McCalla729c622012-02-17 03:33:10 +00001278 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00001279
Craig Topper8a13c412014-05-21 05:09:00 +00001280 llvm::Value *ReceiverClass = nullptr;
Chris Lattnera02cb802009-05-08 15:39:58 +00001281 if (isCategoryImpl) {
Craig Topper8a13c412014-05-21 05:09:00 +00001282 llvm::Constant *classLookupFunction = nullptr;
Chris Lattnera02cb802009-05-08 15:39:58 +00001283 if (IsClassMessage) {
Owen Anderson9793f0e2009-07-29 22:16:19 +00001284 classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get(
Jay Foad5709f7c2011-07-29 13:56:53 +00001285 IdTy, PtrTy, true), "objc_get_meta_class");
Chris Lattnera02cb802009-05-08 15:39:58 +00001286 } else {
Owen Anderson9793f0e2009-07-29 22:16:19 +00001287 classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get(
Jay Foad5709f7c2011-07-29 13:56:53 +00001288 IdTy, PtrTy, true), "objc_get_class");
Daniel Dunbar566421c2009-05-04 15:31:17 +00001289 }
David Chisnallea529a42010-05-01 12:37:16 +00001290 ReceiverClass = Builder.CreateCall(classLookupFunction,
Chris Lattnera02cb802009-05-08 15:39:58 +00001291 MakeConstantString(Class->getNameAsString()));
Daniel Dunbar566421c2009-05-04 15:31:17 +00001292 } else {
Chris Lattnera02cb802009-05-08 15:39:58 +00001293 // Set up global aliases for the metaclass or class pointer if they do not
1294 // already exist. These will are forward-references which will be set to
Mike Stumpdd93a192009-07-31 21:31:32 +00001295 // pointers to the class and metaclass structure created for the runtime
1296 // load function. To send a message to super, we look up the value of the
Chris Lattnera02cb802009-05-08 15:39:58 +00001297 // super_class pointer from either the class or metaclass structure.
1298 if (IsClassMessage) {
1299 if (!MetaClassPtrAlias) {
Rafael Espindola234405b2014-05-17 21:30:14 +00001300 MetaClassPtrAlias = llvm::GlobalAlias::create(
David Blaikieaff29d32015-09-14 18:02:04 +00001301 IdTy->getElementType(), 0, llvm::GlobalValue::InternalLinkage,
Rafael Espindola61722772014-05-17 19:58:16 +00001302 ".objc_metaclass_ref" + Class->getNameAsString(), &TheModule);
Chris Lattnera02cb802009-05-08 15:39:58 +00001303 }
1304 ReceiverClass = MetaClassPtrAlias;
1305 } else {
1306 if (!ClassPtrAlias) {
Rafael Espindola234405b2014-05-17 21:30:14 +00001307 ClassPtrAlias = llvm::GlobalAlias::create(
David Blaikieaff29d32015-09-14 18:02:04 +00001308 IdTy->getElementType(), 0, llvm::GlobalValue::InternalLinkage,
Rafael Espindola61722772014-05-17 19:58:16 +00001309 ".objc_class_ref" + Class->getNameAsString(), &TheModule);
Chris Lattnera02cb802009-05-08 15:39:58 +00001310 }
1311 ReceiverClass = ClassPtrAlias;
Daniel Dunbar566421c2009-05-04 15:31:17 +00001312 }
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00001313 }
Daniel Dunbar566421c2009-05-04 15:31:17 +00001314 // Cast the pointer to a simplified version of the class structure
Serge Guelton1d993272017-05-09 19:31:30 +00001315 llvm::Type *CastTy = llvm::StructType::get(IdTy, IdTy);
David Chisnallea529a42010-05-01 12:37:16 +00001316 ReceiverClass = Builder.CreateBitCast(ReceiverClass,
David Blaikie1ed728c2015-04-05 22:45:47 +00001317 llvm::PointerType::getUnqual(CastTy));
Daniel Dunbar566421c2009-05-04 15:31:17 +00001318 // Get the superclass pointer
David Blaikie1ed728c2015-04-05 22:45:47 +00001319 ReceiverClass = Builder.CreateStructGEP(CastTy, ReceiverClass, 1);
Daniel Dunbar566421c2009-05-04 15:31:17 +00001320 // Load the superclass pointer
John McCall7f416cc2015-09-08 08:05:57 +00001321 ReceiverClass =
1322 Builder.CreateAlignedLoad(ReceiverClass, CGF.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001323 // Construct the structure used to look up the IMP
Serge Guelton1d993272017-05-09 19:31:30 +00001324 llvm::StructType *ObjCSuperTy =
1325 llvm::StructType::get(Receiver->getType(), IdTy);
John McCall7f416cc2015-09-08 08:05:57 +00001326
1327 // FIXME: Is this really supposed to be a dynamic alloca?
1328 Address ObjCSuper = Address(Builder.CreateAlloca(ObjCSuperTy),
1329 CGF.getPointerAlign());
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00001330
David Blaikie2e804282015-04-05 22:47:07 +00001331 Builder.CreateStore(Receiver,
John McCall7f416cc2015-09-08 08:05:57 +00001332 Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
David Blaikie2e804282015-04-05 22:47:07 +00001333 Builder.CreateStore(ReceiverClass,
John McCall7f416cc2015-09-08 08:05:57 +00001334 Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001335
David Chisnall76803412011-03-23 22:52:06 +00001336 ObjCSuper = EnforceType(Builder, ObjCSuper, PtrToObjCSuperTy);
David Chisnall76803412011-03-23 22:52:06 +00001337
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001338 // Get the IMP
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00001339 llvm::Value *imp = LookupIMPSuper(CGF, ObjCSuper, cmd, MSI);
John McCalla729c622012-02-17 03:33:10 +00001340 imp = EnforceType(Builder, imp, MSI.MessengerType);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001341
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001342 llvm::Metadata *impMD[] = {
David Chisnall9eecafa2010-05-01 11:15:56 +00001343 llvm::MDString::get(VMContext, Sel.getAsString()),
1344 llvm::MDString::get(VMContext, Class->getSuperClass()->getNameAsString()),
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001345 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
1346 llvm::Type::getInt1Ty(VMContext), IsClassMessage))};
Jay Foadea324f12011-04-21 19:59:12 +00001347 llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD);
David Chisnall9eecafa2010-05-01 11:15:56 +00001348
John McCallb92ab1a2016-10-26 23:46:34 +00001349 CGCallee callee(CGCalleeInfo(), imp);
1350
David Chisnallff5f88c2010-05-02 13:41:58 +00001351 llvm::Instruction *call;
John McCallb92ab1a2016-10-26 23:46:34 +00001352 RValue msgRet = CGF.EmitCall(MSI.CallInfo, callee, Return, ActualArgs, &call);
David Chisnallff5f88c2010-05-02 13:41:58 +00001353 call->setMetadata(msgSendMDKind, node);
1354 return msgRet;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001355}
1356
Mike Stump11289f42009-09-09 15:08:12 +00001357/// Generate code for a message send expression.
David Chisnalld7972f52011-03-23 16:36:54 +00001358RValue
1359CGObjCGNU::GenerateMessageSend(CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001360 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001361 QualType ResultType,
1362 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001363 llvm::Value *Receiver,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001364 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00001365 const ObjCInterfaceDecl *Class,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001366 const ObjCMethodDecl *Method) {
David Chisnall8a42d192011-05-28 14:09:01 +00001367 CGBuilderTy &Builder = CGF.Builder;
1368
David Chisnall75afda62010-04-27 15:08:48 +00001369 // Strip out message sends to retain / release in GC mode
David Blaikiebbafb8a2012-03-11 07:00:24 +00001370 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
David Chisnall5bb4efd2010-02-03 15:59:02 +00001371 if (Sel == RetainSel || Sel == AutoreleaseSel) {
David Chisnall8a42d192011-05-28 14:09:01 +00001372 return RValue::get(EnforceType(Builder, Receiver,
1373 CGM.getTypes().ConvertType(ResultType)));
David Chisnall5bb4efd2010-02-03 15:59:02 +00001374 }
1375 if (Sel == ReleaseSel) {
Craig Topper8a13c412014-05-21 05:09:00 +00001376 return RValue::get(nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001377 }
1378 }
David Chisnall75afda62010-04-27 15:08:48 +00001379
David Chisnall75afda62010-04-27 15:08:48 +00001380 // If the return type is something that goes in an integer register, the
1381 // runtime will handle 0 returns. For other cases, we fill in the 0 value
1382 // ourselves.
1383 //
1384 // The language spec says the result of this kind of message send is
1385 // undefined, but lots of people seem to have forgotten to read that
1386 // paragraph and insist on sending messages to nil that have structure
1387 // returns. With GCC, this generates a random return value (whatever happens
1388 // to be on the stack / in those registers at the time) on most platforms,
David Chisnall76803412011-03-23 22:52:06 +00001389 // and generates an illegal instruction trap on SPARC. With LLVM it corrupts
1390 // the stack.
1391 bool isPointerSizedReturn = (ResultType->isAnyPointerType() ||
1392 ResultType->isIntegralOrEnumerationType() || ResultType->isVoidType());
David Chisnall75afda62010-04-27 15:08:48 +00001393
Craig Topper8a13c412014-05-21 05:09:00 +00001394 llvm::BasicBlock *startBB = nullptr;
1395 llvm::BasicBlock *messageBB = nullptr;
1396 llvm::BasicBlock *continueBB = nullptr;
David Chisnall75afda62010-04-27 15:08:48 +00001397
1398 if (!isPointerSizedReturn) {
1399 startBB = Builder.GetInsertBlock();
1400 messageBB = CGF.createBasicBlock("msgSend");
David Chisnall29cefd12010-05-20 13:45:48 +00001401 continueBB = CGF.createBasicBlock("continue");
David Chisnall75afda62010-04-27 15:08:48 +00001402
1403 llvm::Value *isNil = Builder.CreateICmpEQ(Receiver,
1404 llvm::Constant::getNullValue(Receiver->getType()));
David Chisnall29cefd12010-05-20 13:45:48 +00001405 Builder.CreateCondBr(isNil, continueBB, messageBB);
David Chisnall75afda62010-04-27 15:08:48 +00001406 CGF.EmitBlock(messageBB);
1407 }
1408
David Chisnall9f57c292009-08-17 16:35:33 +00001409 IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy));
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001410 llvm::Value *cmd;
1411 if (Method)
John McCall882987f2013-02-28 19:01:20 +00001412 cmd = GetSelector(CGF, Method);
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001413 else
John McCall882987f2013-02-28 19:01:20 +00001414 cmd = GetSelector(CGF, Sel);
David Chisnall76803412011-03-23 22:52:06 +00001415 cmd = EnforceType(Builder, cmd, SelectorTy);
1416 Receiver = EnforceType(Builder, Receiver, IdTy);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001417
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001418 llvm::Metadata *impMD[] = {
1419 llvm::MDString::get(VMContext, Sel.getAsString()),
1420 llvm::MDString::get(VMContext, Class ? Class->getNameAsString() : ""),
1421 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
1422 llvm::Type::getInt1Ty(VMContext), Class != nullptr))};
Jay Foadea324f12011-04-21 19:59:12 +00001423 llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD);
David Chisnall76803412011-03-23 22:52:06 +00001424
David Chisnall76803412011-03-23 22:52:06 +00001425 CallArgList ActualArgs;
Eli Friedman43dca6a2011-05-02 17:57:46 +00001426 ActualArgs.add(RValue::get(Receiver), ASTIdTy);
1427 ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00001428 ActualArgs.addFrom(CallArgs);
John McCalla729c622012-02-17 03:33:10 +00001429
1430 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
1431
David Chisnall8c93cf22011-10-24 14:07:03 +00001432 // Get the IMP to call
1433 llvm::Value *imp;
1434
1435 // If we have non-legacy dispatch specified, we try using the objc_msgSend()
1436 // functions. These are not supported on all platforms (or all runtimes on a
1437 // given platform), so we
1438 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
David Chisnall8c93cf22011-10-24 14:07:03 +00001439 case CodeGenOptions::Legacy:
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00001440 imp = LookupIMP(CGF, Receiver, cmd, node, MSI);
David Chisnall8c93cf22011-10-24 14:07:03 +00001441 break;
1442 case CodeGenOptions::Mixed:
David Chisnall8c93cf22011-10-24 14:07:03 +00001443 case CodeGenOptions::NonLegacy:
David Chisnall0cc83e72011-10-28 17:55:06 +00001444 if (CGM.ReturnTypeUsesFPRet(ResultType)) {
1445 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
1446 "objc_msgSend_fpret");
John McCalla729c622012-02-17 03:33:10 +00001447 } else if (CGM.ReturnTypeUsesSRet(MSI.CallInfo)) {
David Chisnall8c93cf22011-10-24 14:07:03 +00001448 // The actual types here don't matter - we're going to bitcast the
1449 // function anyway
1450 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
1451 "objc_msgSend_stret");
1452 } else {
1453 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
1454 "objc_msgSend");
1455 }
1456 }
1457
David Chisnall6aec31a2011-12-01 18:40:09 +00001458 // Reset the receiver in case the lookup modified it
1459 ActualArgs[0] = CallArg(RValue::get(Receiver), ASTIdTy, false);
David Chisnall8c93cf22011-10-24 14:07:03 +00001460
John McCalla729c622012-02-17 03:33:10 +00001461 imp = EnforceType(Builder, imp, MSI.MessengerType);
David Chisnallc0cf4222010-05-01 12:56:56 +00001462
David Chisnallff5f88c2010-05-02 13:41:58 +00001463 llvm::Instruction *call;
John McCallb92ab1a2016-10-26 23:46:34 +00001464 CGCallee callee(CGCalleeInfo(), imp);
1465 RValue msgRet = CGF.EmitCall(MSI.CallInfo, callee, Return, ActualArgs, &call);
David Chisnallff5f88c2010-05-02 13:41:58 +00001466 call->setMetadata(msgSendMDKind, node);
David Chisnall75afda62010-04-27 15:08:48 +00001467
David Chisnall29cefd12010-05-20 13:45:48 +00001468
David Chisnall75afda62010-04-27 15:08:48 +00001469 if (!isPointerSizedReturn) {
David Chisnall29cefd12010-05-20 13:45:48 +00001470 messageBB = CGF.Builder.GetInsertBlock();
1471 CGF.Builder.CreateBr(continueBB);
1472 CGF.EmitBlock(continueBB);
David Chisnall75afda62010-04-27 15:08:48 +00001473 if (msgRet.isScalar()) {
1474 llvm::Value *v = msgRet.getScalarVal();
Jay Foad20c0f022011-03-30 11:28:58 +00001475 llvm::PHINode *phi = Builder.CreatePHI(v->getType(), 2);
David Chisnall75afda62010-04-27 15:08:48 +00001476 phi->addIncoming(v, messageBB);
1477 phi->addIncoming(llvm::Constant::getNullValue(v->getType()), startBB);
1478 msgRet = RValue::get(phi);
1479 } else if (msgRet.isAggregate()) {
John McCall7f416cc2015-09-08 08:05:57 +00001480 Address v = msgRet.getAggregateAddress();
1481 llvm::PHINode *phi = Builder.CreatePHI(v.getType(), 2);
1482 llvm::Type *RetTy = v.getElementType();
1483 Address NullVal = CGF.CreateTempAlloca(RetTy, v.getAlignment(), "null");
1484 CGF.InitTempAlloca(NullVal, llvm::Constant::getNullValue(RetTy));
1485 phi->addIncoming(v.getPointer(), messageBB);
1486 phi->addIncoming(NullVal.getPointer(), startBB);
1487 msgRet = RValue::getAggregate(Address(phi, v.getAlignment()));
David Chisnall75afda62010-04-27 15:08:48 +00001488 } else /* isComplex() */ {
1489 std::pair<llvm::Value*,llvm::Value*> v = msgRet.getComplexVal();
Jay Foad20c0f022011-03-30 11:28:58 +00001490 llvm::PHINode *phi = Builder.CreatePHI(v.first->getType(), 2);
David Chisnall75afda62010-04-27 15:08:48 +00001491 phi->addIncoming(v.first, messageBB);
1492 phi->addIncoming(llvm::Constant::getNullValue(v.first->getType()),
1493 startBB);
Jay Foad20c0f022011-03-30 11:28:58 +00001494 llvm::PHINode *phi2 = Builder.CreatePHI(v.second->getType(), 2);
David Chisnall75afda62010-04-27 15:08:48 +00001495 phi2->addIncoming(v.second, messageBB);
1496 phi2->addIncoming(llvm::Constant::getNullValue(v.second->getType()),
1497 startBB);
1498 msgRet = RValue::getComplex(phi, phi2);
1499 }
1500 }
1501 return msgRet;
Chris Lattnerb7256cd2008-03-01 08:50:34 +00001502}
1503
Mike Stump11289f42009-09-09 15:08:12 +00001504/// Generates a MethodList. Used in construction of a objc_class and
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001505/// objc_category structures.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001506llvm::Constant *CGObjCGNU::
Craig Topperbf3e3272014-08-30 16:55:52 +00001507GenerateMethodList(StringRef ClassName,
1508 StringRef CategoryName,
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001509 ArrayRef<Selector> MethodSels,
1510 ArrayRef<llvm::Constant *> MethodTypes,
1511 bool isClassMethodList) {
David Chisnall9f57c292009-08-17 16:35:33 +00001512 if (MethodSels.empty())
1513 return NULLPtr;
John McCall6c9f1fdb2016-11-19 08:17:24 +00001514
John McCall23c9dc62016-11-28 22:18:27 +00001515 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001516
1517 auto MethodList = Builder.beginStruct();
1518 MethodList.addNullPointer(CGM.Int8PtrTy);
1519 MethodList.addInt(Int32Ty, MethodTypes.size());
1520
Mike Stump11289f42009-09-09 15:08:12 +00001521 // Get the method structure type.
John McCallecee86f2016-11-30 20:19:46 +00001522 llvm::StructType *ObjCMethodTy =
1523 llvm::StructType::get(CGM.getLLVMContext(), {
1524 PtrToInt8Ty, // Really a selector, but the runtime creates it us.
1525 PtrToInt8Ty, // Method types
1526 IMPTy // Method pointer
1527 });
John McCall6c9f1fdb2016-11-19 08:17:24 +00001528 auto Methods = MethodList.beginArray();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001529 for (unsigned int i = 0, e = MethodTypes.size(); i < e; ++i) {
John McCallecee86f2016-11-30 20:19:46 +00001530 llvm::Constant *FnPtr =
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001531 TheModule.getFunction(SymbolNameForMethod(ClassName, CategoryName,
David Chisnalld7972f52011-03-23 16:36:54 +00001532 MethodSels[i],
1533 isClassMethodList));
John McCallecee86f2016-11-30 20:19:46 +00001534 assert(FnPtr && "Can't generate metadata for method that doesn't exist");
1535 auto Method = Methods.beginStruct(ObjCMethodTy);
1536 Method.add(MakeConstantString(MethodSels[i].getAsString()));
1537 Method.add(MethodTypes[i]);
1538 Method.addBitCast(FnPtr, IMPTy);
1539 Method.finishAndAddTo(Methods);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001540 }
John McCallf1788632016-11-28 22:18:30 +00001541 Methods.finishAndAddTo(MethodList);
Mike Stump11289f42009-09-09 15:08:12 +00001542
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001543 // Create an instance of the structure
John McCall6c9f1fdb2016-11-19 08:17:24 +00001544 return MethodList.finishAndCreateGlobal(".objc_method_list",
1545 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001546}
1547
1548/// Generates an IvarList. Used in construction of a objc_class.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001549llvm::Constant *CGObjCGNU::
1550GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
1551 ArrayRef<llvm::Constant *> IvarTypes,
1552 ArrayRef<llvm::Constant *> IvarOffsets) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00001553 if (IvarNames.empty())
David Chisnallb3b44ce2009-11-16 19:05:54 +00001554 return NULLPtr;
John McCall6c9f1fdb2016-11-19 08:17:24 +00001555
John McCall23c9dc62016-11-28 22:18:27 +00001556 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001557
1558 // Structure containing array count followed by array.
1559 auto IvarList = Builder.beginStruct();
1560 IvarList.addInt(IntTy, (int)IvarNames.size());
1561
1562 // Get the ivar structure type.
Serge Guelton1d993272017-05-09 19:31:30 +00001563 llvm::StructType *ObjCIvarTy =
1564 llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty, IntTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001565
1566 // Array of ivar structures.
1567 auto Ivars = IvarList.beginArray(ObjCIvarTy);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001568 for (unsigned int i = 0, e = IvarNames.size() ; i < e ; i++) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00001569 auto Ivar = Ivars.beginStruct(ObjCIvarTy);
1570 Ivar.add(IvarNames[i]);
1571 Ivar.add(IvarTypes[i]);
1572 Ivar.add(IvarOffsets[i]);
John McCallf1788632016-11-28 22:18:30 +00001573 Ivar.finishAndAddTo(Ivars);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001574 }
John McCallf1788632016-11-28 22:18:30 +00001575 Ivars.finishAndAddTo(IvarList);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001576
1577 // Create an instance of the structure
John McCall6c9f1fdb2016-11-19 08:17:24 +00001578 return IvarList.finishAndCreateGlobal(".objc_ivar_list",
1579 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001580}
1581
1582/// Generate a class structure
1583llvm::Constant *CGObjCGNU::GenerateClassStructure(
1584 llvm::Constant *MetaClass,
1585 llvm::Constant *SuperClass,
1586 unsigned info,
Chris Lattnerda35bc82008-06-26 04:47:04 +00001587 const char *Name,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001588 llvm::Constant *Version,
1589 llvm::Constant *InstanceSize,
1590 llvm::Constant *IVars,
1591 llvm::Constant *Methods,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001592 llvm::Constant *Protocols,
1593 llvm::Constant *IvarOffsets,
David Chisnalld472c852010-04-28 14:29:56 +00001594 llvm::Constant *Properties,
David Chisnallcdd207e2011-10-04 15:35:30 +00001595 llvm::Constant *StrongIvarBitmap,
1596 llvm::Constant *WeakIvarBitmap,
David Chisnalld472c852010-04-28 14:29:56 +00001597 bool isMeta) {
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001598 // Set up the class structure
1599 // Note: Several of these are char*s when they should be ids. This is
1600 // because the runtime performs this translation on load.
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001601 //
1602 // Fields marked New ABI are part of the GNUstep runtime. We emit them
1603 // anyway; the classes will still work with the GNU runtime, they will just
1604 // be ignored.
Chris Lattner845511f2011-06-18 22:49:11 +00001605 llvm::StructType *ClassTy = llvm::StructType::get(
Serge Guelton1d993272017-05-09 19:31:30 +00001606 PtrToInt8Ty, // isa
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001607 PtrToInt8Ty, // super_class
1608 PtrToInt8Ty, // name
1609 LongTy, // version
1610 LongTy, // info
1611 LongTy, // instance_size
1612 IVars->getType(), // ivars
1613 Methods->getType(), // methods
Mike Stump11289f42009-09-09 15:08:12 +00001614 // These are all filled in by the runtime, so we pretend
Serge Guelton1d993272017-05-09 19:31:30 +00001615 PtrTy, // dtable
1616 PtrTy, // subclass_list
1617 PtrTy, // sibling_class
1618 PtrTy, // protocols
1619 PtrTy, // gc_object_type
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001620 // New ABI:
1621 LongTy, // abi_version
1622 IvarOffsets->getType(), // ivar_offsets
1623 Properties->getType(), // properties
David Chisnalle89ac062011-10-25 10:12:21 +00001624 IntPtrTy, // strong_pointers
Serge Guelton1d993272017-05-09 19:31:30 +00001625 IntPtrTy // weak_pointers
1626 );
John McCall6c9f1fdb2016-11-19 08:17:24 +00001627
John McCall23c9dc62016-11-28 22:18:27 +00001628 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001629 auto Elements = Builder.beginStruct(ClassTy);
1630
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001631 // Fill in the structure
John McCall6c9f1fdb2016-11-19 08:17:24 +00001632
1633 // isa
John McCallecee86f2016-11-30 20:19:46 +00001634 Elements.addBitCast(MetaClass, PtrToInt8Ty);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001635 // super_class
1636 Elements.add(SuperClass);
1637 // name
1638 Elements.add(MakeConstantString(Name, ".class_name"));
1639 // version
1640 Elements.addInt(LongTy, 0);
1641 // info
1642 Elements.addInt(LongTy, info);
1643 // instance_size
David Chisnall055f0642011-02-21 23:47:40 +00001644 if (isMeta) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00001645 llvm::DataLayout td(&TheModule);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001646 Elements.addInt(LongTy,
1647 td.getTypeSizeInBits(ClassTy) /
1648 CGM.getContext().getCharWidth());
David Chisnall055f0642011-02-21 23:47:40 +00001649 } else
John McCall6c9f1fdb2016-11-19 08:17:24 +00001650 Elements.add(InstanceSize);
1651 // ivars
1652 Elements.add(IVars);
1653 // methods
1654 Elements.add(Methods);
1655 // These are all filled in by the runtime, so we pretend
1656 // dtable
1657 Elements.add(NULLPtr);
1658 // subclass_list
1659 Elements.add(NULLPtr);
1660 // sibling_class
1661 Elements.add(NULLPtr);
1662 // protocols
John McCallecee86f2016-11-30 20:19:46 +00001663 Elements.addBitCast(Protocols, PtrTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001664 // gc_object_type
1665 Elements.add(NULLPtr);
1666 // abi_version
1667 Elements.addInt(LongTy, 1);
1668 // ivar_offsets
1669 Elements.add(IvarOffsets);
1670 // properties
1671 Elements.add(Properties);
1672 // strong_pointers
1673 Elements.add(StrongIvarBitmap);
1674 // weak_pointers
1675 Elements.add(WeakIvarBitmap);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001676 // Create an instance of the structure
David Chisnalldf349172010-01-08 00:14:31 +00001677 // This is now an externally visible symbol, so that we can speed up class
David Chisnall207a6302012-01-04 12:02:13 +00001678 // messages in the next ABI. We may already have some weak references to
1679 // this, so check and fix them properly.
1680 std::string ClassSym((isMeta ? "_OBJC_METACLASS_": "_OBJC_CLASS_") +
1681 std::string(Name));
1682 llvm::GlobalVariable *ClassRef = TheModule.getNamedGlobal(ClassSym);
John McCall7f416cc2015-09-08 08:05:57 +00001683 llvm::Constant *Class =
John McCall6c9f1fdb2016-11-19 08:17:24 +00001684 Elements.finishAndCreateGlobal(ClassSym, CGM.getPointerAlign(), false,
1685 llvm::GlobalValue::ExternalLinkage);
David Chisnall207a6302012-01-04 12:02:13 +00001686 if (ClassRef) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00001687 ClassRef->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(Class,
David Chisnall207a6302012-01-04 12:02:13 +00001688 ClassRef->getType()));
John McCall6c9f1fdb2016-11-19 08:17:24 +00001689 ClassRef->removeFromParent();
1690 Class->setName(ClassSym);
David Chisnall207a6302012-01-04 12:02:13 +00001691 }
1692 return Class;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001693}
1694
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001695llvm::Constant *CGObjCGNU::
1696GenerateProtocolMethodList(ArrayRef<llvm::Constant *> MethodNames,
1697 ArrayRef<llvm::Constant *> MethodTypes) {
Mike Stump11289f42009-09-09 15:08:12 +00001698 // Get the method structure type.
John McCall6c9f1fdb2016-11-19 08:17:24 +00001699 llvm::StructType *ObjCMethodDescTy =
1700 llvm::StructType::get(CGM.getLLVMContext(), { PtrToInt8Ty, PtrToInt8Ty });
John McCall23c9dc62016-11-28 22:18:27 +00001701 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001702 auto MethodList = Builder.beginStruct();
1703 MethodList.addInt(IntTy, MethodNames.size());
1704 auto Methods = MethodList.beginArray(ObjCMethodDescTy);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001705 for (unsigned int i = 0, e = MethodTypes.size() ; i < e ; i++) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00001706 auto Method = Methods.beginStruct(ObjCMethodDescTy);
1707 Method.add(MethodNames[i]);
1708 Method.add(MethodTypes[i]);
John McCallf1788632016-11-28 22:18:30 +00001709 Method.finishAndAddTo(Methods);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001710 }
John McCallf1788632016-11-28 22:18:30 +00001711 Methods.finishAndAddTo(MethodList);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001712 return MethodList.finishAndCreateGlobal(".objc_method_list",
1713 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001714}
Mike Stumpdd93a192009-07-31 21:31:32 +00001715
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001716// Create the protocol list structure used in classes, categories and so on
John McCall6c9f1fdb2016-11-19 08:17:24 +00001717llvm::Constant *
1718CGObjCGNU::GenerateProtocolList(ArrayRef<std::string> Protocols) {
1719
John McCall23c9dc62016-11-28 22:18:27 +00001720 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001721 auto ProtocolList = Builder.beginStruct();
1722 ProtocolList.add(NULLPtr);
1723 ProtocolList.addInt(LongTy, Protocols.size());
1724
1725 auto Elements = ProtocolList.beginArray(PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001726 for (const std::string *iter = Protocols.begin(), *endIter = Protocols.end();
1727 iter != endIter ; iter++) {
Craig Topper8a13c412014-05-21 05:09:00 +00001728 llvm::Constant *protocol = nullptr;
David Chisnallbc8bdea2009-11-20 14:50:59 +00001729 llvm::StringMap<llvm::Constant*>::iterator value =
1730 ExistingProtocols.find(*iter);
1731 if (value == ExistingProtocols.end()) {
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001732 protocol = GenerateEmptyProtocol(*iter);
David Chisnallbc8bdea2009-11-20 14:50:59 +00001733 } else {
1734 protocol = value->getValue();
1735 }
John McCallecee86f2016-11-30 20:19:46 +00001736 Elements.addBitCast(protocol, PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001737 }
John McCallf1788632016-11-28 22:18:30 +00001738 Elements.finishAndAddTo(ProtocolList);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001739 return ProtocolList.finishAndCreateGlobal(".objc_protocol_list",
1740 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001741}
1742
John McCall882987f2013-02-28 19:01:20 +00001743llvm::Value *CGObjCGNU::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001744 const ObjCProtocolDecl *PD) {
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001745 llvm::Value *protocol = ExistingProtocols[PD->getNameAsString()];
Chris Lattner2192fe52011-07-18 04:24:23 +00001746 llvm::Type *T =
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001747 CGM.getTypes().ConvertType(CGM.getContext().getObjCProtoType());
John McCall882987f2013-02-28 19:01:20 +00001748 return CGF.Builder.CreateBitCast(protocol, llvm::PointerType::getUnqual(T));
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001749}
1750
John McCall6c9f1fdb2016-11-19 08:17:24 +00001751llvm::Constant *
1752CGObjCGNU::GenerateEmptyProtocol(const std::string &ProtocolName) {
1753 llvm::Constant *ProtocolList = GenerateProtocolList({});
1754 llvm::Constant *MethodList = GenerateProtocolMethodList({}, {});
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001755 // Protocols are objects containing lists of the methods implemented and
1756 // protocols adopted.
John McCall23c9dc62016-11-28 22:18:27 +00001757 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001758 auto Elements = Builder.beginStruct();
1759
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001760 // The isa pointer must be set to a magic number so the runtime knows it's
1761 // the correct layout.
John McCall6c9f1fdb2016-11-19 08:17:24 +00001762 Elements.add(llvm::ConstantExpr::getIntToPtr(
1763 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
1764
1765 Elements.add(MakeConstantString(ProtocolName, ".objc_protocol_name"));
1766 Elements.add(ProtocolList);
1767 Elements.add(MethodList);
1768 Elements.add(MethodList);
1769 Elements.add(MethodList);
1770 Elements.add(MethodList);
1771 return Elements.finishAndCreateGlobal(".objc_protocol",
1772 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001773}
1774
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001775void CGObjCGNU::GenerateProtocol(const ObjCProtocolDecl *PD) {
1776 ASTContext &Context = CGM.getContext();
Chris Lattner86d7d912008-11-24 03:54:41 +00001777 std::string ProtocolName = PD->getNameAsString();
Douglas Gregora715bff2012-01-01 19:51:50 +00001778
1779 // Use the protocol definition, if there is one.
1780 if (const ObjCProtocolDecl *Def = PD->getDefinition())
1781 PD = Def;
1782
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001783 SmallVector<std::string, 16> Protocols;
Aaron Ballman0f6e64d2014-03-13 22:58:06 +00001784 for (const auto *PI : PD->protocols())
1785 Protocols.push_back(PI->getNameAsString());
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001786 SmallVector<llvm::Constant*, 16> InstanceMethodNames;
1787 SmallVector<llvm::Constant*, 16> InstanceMethodTypes;
1788 SmallVector<llvm::Constant*, 16> OptionalInstanceMethodNames;
1789 SmallVector<llvm::Constant*, 16> OptionalInstanceMethodTypes;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00001790 for (const auto *I : PD->instance_methods()) {
John McCall843dfcc2016-11-29 21:57:00 +00001791 std::string TypeStr = Context.getObjCEncodingForMethodDecl(I);
Aaron Ballmanf26acce2014-03-13 19:50:17 +00001792 if (I->getImplementationControl() == ObjCMethodDecl::Optional) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001793 OptionalInstanceMethodNames.push_back(
Aaron Ballmanf26acce2014-03-13 19:50:17 +00001794 MakeConstantString(I->getSelector().getAsString()));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001795 OptionalInstanceMethodTypes.push_back(MakeConstantString(TypeStr));
David Chisnall12d81352012-08-23 12:17:21 +00001796 } else {
1797 InstanceMethodNames.push_back(
Aaron Ballmanf26acce2014-03-13 19:50:17 +00001798 MakeConstantString(I->getSelector().getAsString()));
David Chisnall12d81352012-08-23 12:17:21 +00001799 InstanceMethodTypes.push_back(MakeConstantString(TypeStr));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001800 }
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001801 }
1802 // Collect information about class methods:
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001803 SmallVector<llvm::Constant*, 16> ClassMethodNames;
1804 SmallVector<llvm::Constant*, 16> ClassMethodTypes;
1805 SmallVector<llvm::Constant*, 16> OptionalClassMethodNames;
1806 SmallVector<llvm::Constant*, 16> OptionalClassMethodTypes;
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00001807 for (const auto *I : PD->class_methods()) {
John McCall843dfcc2016-11-29 21:57:00 +00001808 std::string TypeStr = Context.getObjCEncodingForMethodDecl(I);
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00001809 if (I->getImplementationControl() == ObjCMethodDecl::Optional) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001810 OptionalClassMethodNames.push_back(
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00001811 MakeConstantString(I->getSelector().getAsString()));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001812 OptionalClassMethodTypes.push_back(MakeConstantString(TypeStr));
David Chisnall12d81352012-08-23 12:17:21 +00001813 } else {
1814 ClassMethodNames.push_back(
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00001815 MakeConstantString(I->getSelector().getAsString()));
David Chisnall12d81352012-08-23 12:17:21 +00001816 ClassMethodTypes.push_back(MakeConstantString(TypeStr));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001817 }
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001818 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001819
1820 llvm::Constant *ProtocolList = GenerateProtocolList(Protocols);
1821 llvm::Constant *InstanceMethodList =
1822 GenerateProtocolMethodList(InstanceMethodNames, InstanceMethodTypes);
1823 llvm::Constant *ClassMethodList =
1824 GenerateProtocolMethodList(ClassMethodNames, ClassMethodTypes);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001825 llvm::Constant *OptionalInstanceMethodList =
1826 GenerateProtocolMethodList(OptionalInstanceMethodNames,
1827 OptionalInstanceMethodTypes);
1828 llvm::Constant *OptionalClassMethodList =
1829 GenerateProtocolMethodList(OptionalClassMethodNames,
1830 OptionalClassMethodTypes);
1831
1832 // Property metadata: name, attributes, isSynthesized, setter name, setter
1833 // types, getter name, getter types.
1834 // The isSynthesized value is always set to 0 in a protocol. It exists to
1835 // simplify the runtime library by allowing it to use the same data
1836 // structures for protocol metadata everywhere.
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001837
John McCall6c9f1fdb2016-11-19 08:17:24 +00001838 llvm::Constant *PropertyList;
1839 llvm::Constant *OptionalPropertyList;
1840 {
1841 llvm::StructType *propertyMetadataTy =
1842 llvm::StructType::get(CGM.getLLVMContext(),
1843 { PtrToInt8Ty, Int8Ty, Int8Ty, Int8Ty, Int8Ty, PtrToInt8Ty,
1844 PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty });
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001845
John McCall6c9f1fdb2016-11-19 08:17:24 +00001846 unsigned numReqProperties = 0, numOptProperties = 0;
1847 for (auto property : PD->instance_properties()) {
1848 if (property->isOptional())
1849 numOptProperties++;
1850 else
1851 numReqProperties++;
1852 }
David Chisnalla5f59412012-10-16 15:11:55 +00001853
John McCall23c9dc62016-11-28 22:18:27 +00001854 ConstantInitBuilder reqPropertyListBuilder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001855 auto reqPropertiesList = reqPropertyListBuilder.beginStruct();
1856 reqPropertiesList.addInt(IntTy, numReqProperties);
1857 reqPropertiesList.add(NULLPtr);
1858 auto reqPropertiesArray = reqPropertiesList.beginArray(propertyMetadataTy);
1859
John McCall23c9dc62016-11-28 22:18:27 +00001860 ConstantInitBuilder optPropertyListBuilder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001861 auto optPropertiesList = optPropertyListBuilder.beginStruct();
1862 optPropertiesList.addInt(IntTy, numOptProperties);
1863 optPropertiesList.add(NULLPtr);
1864 auto optPropertiesArray = optPropertiesList.beginArray(propertyMetadataTy);
1865
1866 // Add all of the property methods need adding to the method list and to the
1867 // property metadata list.
1868 for (auto *property : PD->instance_properties()) {
1869 auto &propertiesArray =
1870 (property->isOptional() ? optPropertiesArray : reqPropertiesArray);
1871 auto fields = propertiesArray.beginStruct(propertyMetadataTy);
1872
1873 fields.add(MakePropertyEncodingString(property, nullptr));
1874 PushPropertyAttributes(fields, property);
1875
1876 if (ObjCMethodDecl *getter = property->getGetterMethodDecl()) {
John McCall843dfcc2016-11-29 21:57:00 +00001877 std::string typeStr = Context.getObjCEncodingForMethodDecl(getter);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001878 llvm::Constant *typeEncoding = MakeConstantString(typeStr);
1879 InstanceMethodTypes.push_back(typeEncoding);
1880 fields.add(MakeConstantString(getter->getSelector().getAsString()));
1881 fields.add(typeEncoding);
1882 } else {
1883 fields.add(NULLPtr);
1884 fields.add(NULLPtr);
1885 }
1886 if (ObjCMethodDecl *setter = property->getSetterMethodDecl()) {
John McCall843dfcc2016-11-29 21:57:00 +00001887 std::string typeStr = Context.getObjCEncodingForMethodDecl(setter);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001888 llvm::Constant *typeEncoding = MakeConstantString(typeStr);
1889 InstanceMethodTypes.push_back(typeEncoding);
1890 fields.add(MakeConstantString(setter->getSelector().getAsString()));
1891 fields.add(typeEncoding);
1892 } else {
1893 fields.add(NULLPtr);
1894 fields.add(NULLPtr);
1895 }
1896
John McCallf1788632016-11-28 22:18:30 +00001897 fields.finishAndAddTo(propertiesArray);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001898 }
John McCall6c9f1fdb2016-11-19 08:17:24 +00001899
John McCallf1788632016-11-28 22:18:30 +00001900 reqPropertiesArray.finishAndAddTo(reqPropertiesList);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001901 PropertyList =
1902 reqPropertiesList.finishAndCreateGlobal(".objc_property_list",
1903 CGM.getPointerAlign());
1904
John McCallf1788632016-11-28 22:18:30 +00001905 optPropertiesArray.finishAndAddTo(optPropertiesList);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001906 OptionalPropertyList =
1907 optPropertiesList.finishAndCreateGlobal(".objc_property_list",
1908 CGM.getPointerAlign());
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001909 }
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001910
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001911 // Protocols are objects containing lists of the methods implemented and
1912 // protocols adopted.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001913 // The isa pointer must be set to a magic number so the runtime knows it's
1914 // the correct layout.
John McCall23c9dc62016-11-28 22:18:27 +00001915 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001916 auto Elements = Builder.beginStruct();
1917 Elements.add(
Benjamin Kramer30934732016-07-02 11:41:41 +00001918 llvm::ConstantExpr::getIntToPtr(
John McCall6c9f1fdb2016-11-19 08:17:24 +00001919 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
1920 Elements.add(
1921 MakeConstantString(ProtocolName, ".objc_protocol_name"));
1922 Elements.add(ProtocolList);
1923 Elements.add(InstanceMethodList);
1924 Elements.add(ClassMethodList);
1925 Elements.add(OptionalInstanceMethodList);
1926 Elements.add(OptionalClassMethodList);
1927 Elements.add(PropertyList);
1928 Elements.add(OptionalPropertyList);
Mike Stump11289f42009-09-09 15:08:12 +00001929 ExistingProtocols[ProtocolName] =
John McCall6c9f1fdb2016-11-19 08:17:24 +00001930 llvm::ConstantExpr::getBitCast(
1931 Elements.finishAndCreateGlobal(".objc_protocol", CGM.getPointerAlign()),
1932 IdTy);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001933}
Dmitri Gribenkob2aa9232012-11-15 14:28:07 +00001934void CGObjCGNU::GenerateProtocolHolderCategory() {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001935 // Collect information about instance methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001936 SmallVector<Selector, 1> MethodSels;
1937 SmallVector<llvm::Constant*, 1> MethodTypes;
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001938
John McCall23c9dc62016-11-28 22:18:27 +00001939 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001940 auto Elements = Builder.beginStruct();
1941
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001942 const std::string ClassName = "__ObjC_Protocol_Holder_Ugly_Hack";
1943 const std::string CategoryName = "AnotherHack";
John McCall6c9f1fdb2016-11-19 08:17:24 +00001944 Elements.add(MakeConstantString(CategoryName));
1945 Elements.add(MakeConstantString(ClassName));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001946 // Instance method list
John McCallecee86f2016-11-30 20:19:46 +00001947 Elements.addBitCast(GenerateMethodList(
1948 ClassName, CategoryName, MethodSels, MethodTypes, false), PtrTy);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001949 // Class method list
John McCallecee86f2016-11-30 20:19:46 +00001950 Elements.addBitCast(GenerateMethodList(
1951 ClassName, CategoryName, MethodSels, MethodTypes, true), PtrTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001952
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001953 // Protocol list
John McCall23c9dc62016-11-28 22:18:27 +00001954 ConstantInitBuilder ProtocolListBuilder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001955 auto ProtocolList = ProtocolListBuilder.beginStruct();
1956 ProtocolList.add(NULLPtr);
1957 ProtocolList.addInt(LongTy, ExistingProtocols.size());
1958 auto ProtocolElements = ProtocolList.beginArray(PtrTy);
1959 for (auto iter = ExistingProtocols.begin(), endIter = ExistingProtocols.end();
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001960 iter != endIter ; iter++) {
John McCallecee86f2016-11-30 20:19:46 +00001961 ProtocolElements.addBitCast(iter->getValue(), PtrTy);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001962 }
John McCallf1788632016-11-28 22:18:30 +00001963 ProtocolElements.finishAndAddTo(ProtocolList);
John McCallecee86f2016-11-30 20:19:46 +00001964 Elements.addBitCast(
John McCall6c9f1fdb2016-11-19 08:17:24 +00001965 ProtocolList.finishAndCreateGlobal(".objc_protocol_list",
1966 CGM.getPointerAlign()),
John McCallecee86f2016-11-30 20:19:46 +00001967 PtrTy);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001968 Categories.push_back(llvm::ConstantExpr::getBitCast(
John McCall6c9f1fdb2016-11-19 08:17:24 +00001969 Elements.finishAndCreateGlobal("", CGM.getPointerAlign()),
John McCall7f416cc2015-09-08 08:05:57 +00001970 PtrTy));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001971}
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001972
David Chisnallcdd207e2011-10-04 15:35:30 +00001973/// Libobjc2 uses a bitfield representation where small(ish) bitfields are
1974/// stored in a 64-bit value with the low bit set to 1 and the remaining 63
1975/// bits set to their values, LSB first, while larger ones are stored in a
1976/// structure of this / form:
1977///
1978/// struct { int32_t length; int32_t values[length]; };
1979///
1980/// The values in the array are stored in host-endian format, with the least
1981/// significant bit being assumed to come first in the bitfield. Therefore, a
1982/// bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] }, while a
1983/// bitfield / with the 63rd bit set will be 1<<64.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001984llvm::Constant *CGObjCGNU::MakeBitField(ArrayRef<bool> bits) {
David Chisnallcdd207e2011-10-04 15:35:30 +00001985 int bitCount = bits.size();
Rafael Espindola3cc5c2d2014-01-09 21:32:51 +00001986 int ptrBits = CGM.getDataLayout().getPointerSizeInBits();
David Chisnalle89ac062011-10-25 10:12:21 +00001987 if (bitCount < ptrBits) {
David Chisnallcdd207e2011-10-04 15:35:30 +00001988 uint64_t val = 1;
1989 for (int i=0 ; i<bitCount ; ++i) {
Eli Friedman23526672011-10-08 01:03:47 +00001990 if (bits[i]) val |= 1ULL<<(i+1);
David Chisnallcdd207e2011-10-04 15:35:30 +00001991 }
David Chisnalle89ac062011-10-25 10:12:21 +00001992 return llvm::ConstantInt::get(IntPtrTy, val);
David Chisnallcdd207e2011-10-04 15:35:30 +00001993 }
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001994 SmallVector<llvm::Constant *, 8> values;
David Chisnallcdd207e2011-10-04 15:35:30 +00001995 int v=0;
1996 while (v < bitCount) {
1997 int32_t word = 0;
1998 for (int i=0 ; (i<32) && (v<bitCount) ; ++i) {
1999 if (bits[v]) word |= 1<<i;
2000 v++;
2001 }
2002 values.push_back(llvm::ConstantInt::get(Int32Ty, word));
2003 }
John McCall6c9f1fdb2016-11-19 08:17:24 +00002004
John McCall23c9dc62016-11-28 22:18:27 +00002005 ConstantInitBuilder builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002006 auto fields = builder.beginStruct();
2007 fields.addInt(Int32Ty, values.size());
2008 auto array = fields.beginArray();
2009 for (auto v : values) array.add(v);
John McCallf1788632016-11-28 22:18:30 +00002010 array.finishAndAddTo(fields);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002011
2012 llvm::Constant *GS =
2013 fields.finishAndCreateGlobal("", CharUnits::fromQuantity(4));
David Chisnalle0dc7cb2011-10-08 08:54:36 +00002014 llvm::Constant *ptr = llvm::ConstantExpr::getPtrToInt(GS, IntPtrTy);
David Chisnalle0dc7cb2011-10-08 08:54:36 +00002015 return ptr;
David Chisnallcdd207e2011-10-04 15:35:30 +00002016}
2017
Daniel Dunbar92992502008-08-15 22:20:32 +00002018void CGObjCGNU::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Chris Lattner86d7d912008-11-24 03:54:41 +00002019 std::string ClassName = OCD->getClassInterface()->getNameAsString();
2020 std::string CategoryName = OCD->getNameAsString();
Daniel Dunbar92992502008-08-15 22:20:32 +00002021 // Collect information about instance methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002022 SmallVector<Selector, 16> InstanceMethodSels;
2023 SmallVector<llvm::Constant*, 16> InstanceMethodTypes;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002024 for (const auto *I : OCD->instance_methods()) {
2025 InstanceMethodSels.push_back(I->getSelector());
John McCall843dfcc2016-11-29 21:57:00 +00002026 std::string TypeStr = CGM.getContext().getObjCEncodingForMethodDecl(I);
David Chisnall5778fce2009-08-31 16:41:57 +00002027 InstanceMethodTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002028 }
2029
2030 // Collect information about class methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002031 SmallVector<Selector, 16> ClassMethodSels;
2032 SmallVector<llvm::Constant*, 16> ClassMethodTypes;
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002033 for (const auto *I : OCD->class_methods()) {
2034 ClassMethodSels.push_back(I->getSelector());
John McCall843dfcc2016-11-29 21:57:00 +00002035 std::string TypeStr = CGM.getContext().getObjCEncodingForMethodDecl(I);
David Chisnall5778fce2009-08-31 16:41:57 +00002036 ClassMethodTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002037 }
2038
2039 // Collect the names of referenced protocols
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002040 SmallVector<std::string, 16> Protocols;
David Chisnall2bfc50b2010-03-13 22:20:45 +00002041 const ObjCCategoryDecl *CatDecl = OCD->getCategoryDecl();
2042 const ObjCList<ObjCProtocolDecl> &Protos = CatDecl->getReferencedProtocols();
Daniel Dunbar92992502008-08-15 22:20:32 +00002043 for (ObjCList<ObjCProtocolDecl>::iterator I = Protos.begin(),
2044 E = Protos.end(); I != E; ++I)
Chris Lattnerf3d3fae2008-11-24 05:29:24 +00002045 Protocols.push_back((*I)->getNameAsString());
Daniel Dunbar92992502008-08-15 22:20:32 +00002046
John McCall23c9dc62016-11-28 22:18:27 +00002047 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002048 auto Elements = Builder.beginStruct();
2049 Elements.add(MakeConstantString(CategoryName));
2050 Elements.add(MakeConstantString(ClassName));
2051 // Instance method list
John McCallecee86f2016-11-30 20:19:46 +00002052 Elements.addBitCast(
Benjamin Kramer30934732016-07-02 11:41:41 +00002053 GenerateMethodList(ClassName, CategoryName, InstanceMethodSels,
2054 InstanceMethodTypes, false),
John McCallecee86f2016-11-30 20:19:46 +00002055 PtrTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002056 // Class method list
John McCallecee86f2016-11-30 20:19:46 +00002057 Elements.addBitCast(
2058 GenerateMethodList(ClassName, CategoryName, ClassMethodSels,
2059 ClassMethodTypes, true),
2060 PtrTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002061 // Protocol list
John McCallecee86f2016-11-30 20:19:46 +00002062 Elements.addBitCast(GenerateProtocolList(Protocols), PtrTy);
Owen Andersonade90fd2009-07-29 18:54:39 +00002063 Categories.push_back(llvm::ConstantExpr::getBitCast(
John McCall6c9f1fdb2016-11-19 08:17:24 +00002064 Elements.finishAndCreateGlobal("", CGM.getPointerAlign()),
John McCall7f416cc2015-09-08 08:05:57 +00002065 PtrTy));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002066}
Daniel Dunbar92992502008-08-15 22:20:32 +00002067
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002068llvm::Constant *CGObjCGNU::GeneratePropertyList(const ObjCImplementationDecl *OID,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002069 SmallVectorImpl<Selector> &InstanceMethodSels,
2070 SmallVectorImpl<llvm::Constant*> &InstanceMethodTypes) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002071 ASTContext &Context = CGM.getContext();
David Chisnallbeb80132013-02-28 13:59:29 +00002072 // Property metadata: name, attributes, attributes2, padding1, padding2,
2073 // setter name, setter types, getter name, getter types.
John McCall6c9f1fdb2016-11-19 08:17:24 +00002074 llvm::StructType *propertyMetadataTy =
2075 llvm::StructType::get(CGM.getLLVMContext(),
2076 { PtrToInt8Ty, Int8Ty, Int8Ty, Int8Ty, Int8Ty, PtrToInt8Ty,
2077 PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty });
2078
2079 unsigned numProperties = 0;
2080 for (auto *propertyImpl : OID->property_impls()) {
2081 (void) propertyImpl;
2082 numProperties++;
2083 }
2084
John McCall23c9dc62016-11-28 22:18:27 +00002085 ConstantInitBuilder builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002086 auto propertyList = builder.beginStruct();
2087 propertyList.addInt(IntTy, numProperties);
2088 propertyList.add(NULLPtr);
2089 auto properties = propertyList.beginArray(propertyMetadataTy);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002090
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002091 // Add all of the property methods need adding to the method list and to the
2092 // property metadata list.
Aaron Ballmand85eff42014-03-14 15:02:45 +00002093 for (auto *propertyImpl : OID->property_impls()) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00002094 auto fields = properties.beginStruct(propertyMetadataTy);
Aaron Ballmand85eff42014-03-14 15:02:45 +00002095 ObjCPropertyDecl *property = propertyImpl->getPropertyDecl();
David Chisnall36c63202010-02-26 01:11:38 +00002096 bool isSynthesized = (propertyImpl->getPropertyImplementation() ==
2097 ObjCPropertyImplDecl::Synthesize);
David Chisnallbeb80132013-02-28 13:59:29 +00002098 bool isDynamic = (propertyImpl->getPropertyImplementation() ==
2099 ObjCPropertyImplDecl::Dynamic);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002100
John McCall6c9f1fdb2016-11-19 08:17:24 +00002101 fields.add(MakePropertyEncodingString(property, OID));
2102 PushPropertyAttributes(fields, property, isSynthesized, isDynamic);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002103 if (ObjCMethodDecl *getter = property->getGetterMethodDecl()) {
John McCall843dfcc2016-11-29 21:57:00 +00002104 std::string TypeStr = Context.getObjCEncodingForMethodDecl(getter);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002105 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
David Chisnall36c63202010-02-26 01:11:38 +00002106 if (isSynthesized) {
2107 InstanceMethodTypes.push_back(TypeEncoding);
2108 InstanceMethodSels.push_back(getter->getSelector());
2109 }
John McCall6c9f1fdb2016-11-19 08:17:24 +00002110 fields.add(MakeConstantString(getter->getSelector().getAsString()));
2111 fields.add(TypeEncoding);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002112 } else {
John McCall6c9f1fdb2016-11-19 08:17:24 +00002113 fields.add(NULLPtr);
2114 fields.add(NULLPtr);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002115 }
2116 if (ObjCMethodDecl *setter = property->getSetterMethodDecl()) {
John McCall843dfcc2016-11-29 21:57:00 +00002117 std::string TypeStr = Context.getObjCEncodingForMethodDecl(setter);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002118 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
David Chisnall36c63202010-02-26 01:11:38 +00002119 if (isSynthesized) {
2120 InstanceMethodTypes.push_back(TypeEncoding);
2121 InstanceMethodSels.push_back(setter->getSelector());
2122 }
John McCall6c9f1fdb2016-11-19 08:17:24 +00002123 fields.add(MakeConstantString(setter->getSelector().getAsString()));
2124 fields.add(TypeEncoding);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002125 } else {
John McCall6c9f1fdb2016-11-19 08:17:24 +00002126 fields.add(NULLPtr);
2127 fields.add(NULLPtr);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002128 }
John McCallf1788632016-11-28 22:18:30 +00002129 fields.finishAndAddTo(properties);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002130 }
John McCallf1788632016-11-28 22:18:30 +00002131 properties.finishAndAddTo(propertyList);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002132
John McCall6c9f1fdb2016-11-19 08:17:24 +00002133 return propertyList.finishAndCreateGlobal(".objc_property_list",
2134 CGM.getPointerAlign());
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002135}
2136
David Chisnall92d436b2012-01-31 18:59:20 +00002137void CGObjCGNU::RegisterAlias(const ObjCCompatibleAliasDecl *OAD) {
2138 // Get the class declaration for which the alias is specified.
2139 ObjCInterfaceDecl *ClassDecl =
2140 const_cast<ObjCInterfaceDecl *>(OAD->getClassInterface());
Benjamin Kramer3204b152015-05-29 19:42:19 +00002141 ClassAliases.emplace_back(ClassDecl->getNameAsString(),
2142 OAD->getNameAsString());
David Chisnall92d436b2012-01-31 18:59:20 +00002143}
2144
Daniel Dunbar92992502008-08-15 22:20:32 +00002145void CGObjCGNU::GenerateClass(const ObjCImplementationDecl *OID) {
2146 ASTContext &Context = CGM.getContext();
2147
2148 // Get the superclass name.
Mike Stump11289f42009-09-09 15:08:12 +00002149 const ObjCInterfaceDecl * SuperClassDecl =
Daniel Dunbar92992502008-08-15 22:20:32 +00002150 OID->getClassInterface()->getSuperClass();
Chris Lattner86d7d912008-11-24 03:54:41 +00002151 std::string SuperClassName;
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002152 if (SuperClassDecl) {
Chris Lattner86d7d912008-11-24 03:54:41 +00002153 SuperClassName = SuperClassDecl->getNameAsString();
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002154 EmitClassRef(SuperClassName);
2155 }
Daniel Dunbar92992502008-08-15 22:20:32 +00002156
2157 // Get the class name
Chris Lattner87bc3872009-04-01 02:00:48 +00002158 ObjCInterfaceDecl *ClassDecl =
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002159 const_cast<ObjCInterfaceDecl *>(OID->getClassInterface());
Chris Lattner86d7d912008-11-24 03:54:41 +00002160 std::string ClassName = ClassDecl->getNameAsString();
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002161
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002162 // Emit the symbol that is used to generate linker errors if this class is
2163 // referenced in other modules but not declared.
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00002164 std::string classSymbolName = "__objc_class_name_" + ClassName;
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002165 if (auto *symbol = TheModule.getGlobalVariable(classSymbolName)) {
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002166 symbol->setInitializer(llvm::ConstantInt::get(LongTy, 0));
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00002167 } else {
Owen Andersonc10c8d32009-07-08 19:05:04 +00002168 new llvm::GlobalVariable(TheModule, LongTy, false,
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002169 llvm::GlobalValue::ExternalLinkage,
2170 llvm::ConstantInt::get(LongTy, 0),
2171 classSymbolName);
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00002172 }
Mike Stump11289f42009-09-09 15:08:12 +00002173
Daniel Dunbar12119b92009-05-03 10:46:44 +00002174 // Get the size of instances.
Ken Dyckc8ae5502011-02-09 01:59:34 +00002175 int instanceSize =
2176 Context.getASTObjCImplementationLayout(OID).getSize().getQuantity();
Daniel Dunbar92992502008-08-15 22:20:32 +00002177
2178 // Collect information about instance variables.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002179 SmallVector<llvm::Constant*, 16> IvarNames;
2180 SmallVector<llvm::Constant*, 16> IvarTypes;
2181 SmallVector<llvm::Constant*, 16> IvarOffsets;
Mike Stump11289f42009-09-09 15:08:12 +00002182
John McCall23c9dc62016-11-28 22:18:27 +00002183 ConstantInitBuilder IvarOffsetBuilder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002184 auto IvarOffsetValues = IvarOffsetBuilder.beginArray(PtrToIntTy);
David Chisnallcdd207e2011-10-04 15:35:30 +00002185 SmallVector<bool, 16> WeakIvars;
2186 SmallVector<bool, 16> StrongIvars;
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002187
Mike Stump11289f42009-09-09 15:08:12 +00002188 int superInstanceSize = !SuperClassDecl ? 0 :
Ken Dyckc8ae5502011-02-09 01:59:34 +00002189 Context.getASTObjCInterfaceLayout(SuperClassDecl).getSize().getQuantity();
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002190 // For non-fragile ivars, set the instance size to 0 - {the size of just this
2191 // class}. The runtime will then set this to the correct value on load.
Richard Smith9c6890a2012-11-01 22:30:59 +00002192 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002193 instanceSize = 0 - (instanceSize - superInstanceSize);
2194 }
David Chisnall18cf7372010-04-19 00:45:34 +00002195
Jordy Rosea91768e2011-07-22 02:08:32 +00002196 for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD;
2197 IVD = IVD->getNextIvar()) {
Daniel Dunbar92992502008-08-15 22:20:32 +00002198 // Store the name
David Chisnall18cf7372010-04-19 00:45:34 +00002199 IvarNames.push_back(MakeConstantString(IVD->getNameAsString()));
Daniel Dunbar92992502008-08-15 22:20:32 +00002200 // Get the type encoding for this ivar
2201 std::string TypeStr;
Akira Hatanakaff8534b2017-03-14 04:00:52 +00002202 Context.getObjCEncodingForType(IVD->getType(), TypeStr, IVD);
David Chisnall5778fce2009-08-31 16:41:57 +00002203 IvarTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002204 // Get the offset
Eli Friedman8cbca202012-11-06 22:15:52 +00002205 uint64_t BaseOffset = ComputeIvarBaseOffset(CGM, OID, IVD);
David Chisnallcb1b7bf2009-11-17 19:32:15 +00002206 uint64_t Offset = BaseOffset;
Richard Smith9c6890a2012-11-01 22:30:59 +00002207 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002208 Offset = BaseOffset - superInstanceSize;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002209 }
David Chisnall1bfe6d32011-07-07 12:34:51 +00002210 llvm::Constant *OffsetValue = llvm::ConstantInt::get(IntTy, Offset);
2211 // Create the direct offset value
2212 std::string OffsetName = "__objc_ivar_offset_value_" + ClassName +"." +
2213 IVD->getNameAsString();
2214 llvm::GlobalVariable *OffsetVar = TheModule.getGlobalVariable(OffsetName);
2215 if (OffsetVar) {
2216 OffsetVar->setInitializer(OffsetValue);
2217 // If this is the real definition, change its linkage type so that
2218 // different modules will use this one, rather than their private
2219 // copy.
2220 OffsetVar->setLinkage(llvm::GlobalValue::ExternalLinkage);
2221 } else
2222 OffsetVar = new llvm::GlobalVariable(TheModule, IntTy,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002223 false, llvm::GlobalValue::ExternalLinkage,
David Chisnall1bfe6d32011-07-07 12:34:51 +00002224 OffsetValue,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002225 "__objc_ivar_offset_value_" + ClassName +"." +
David Chisnall1bfe6d32011-07-07 12:34:51 +00002226 IVD->getNameAsString());
2227 IvarOffsets.push_back(OffsetValue);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002228 IvarOffsetValues.add(OffsetVar);
David Chisnallcdd207e2011-10-04 15:35:30 +00002229 Qualifiers::ObjCLifetime lt = IVD->getType().getQualifiers().getObjCLifetime();
2230 switch (lt) {
2231 case Qualifiers::OCL_Strong:
2232 StrongIvars.push_back(true);
2233 WeakIvars.push_back(false);
2234 break;
2235 case Qualifiers::OCL_Weak:
2236 StrongIvars.push_back(false);
2237 WeakIvars.push_back(true);
2238 break;
2239 default:
2240 StrongIvars.push_back(false);
2241 WeakIvars.push_back(false);
2242 }
Daniel Dunbar92992502008-08-15 22:20:32 +00002243 }
David Chisnallcdd207e2011-10-04 15:35:30 +00002244 llvm::Constant *StrongIvarBitmap = MakeBitField(StrongIvars);
2245 llvm::Constant *WeakIvarBitmap = MakeBitField(WeakIvars);
David Chisnalld7972f52011-03-23 16:36:54 +00002246 llvm::GlobalVariable *IvarOffsetArray =
John McCall6c9f1fdb2016-11-19 08:17:24 +00002247 IvarOffsetValues.finishAndCreateGlobal(".ivar.offsets",
2248 CGM.getPointerAlign());
David Chisnalld7972f52011-03-23 16:36:54 +00002249
Daniel Dunbar92992502008-08-15 22:20:32 +00002250 // Collect information about instance methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002251 SmallVector<Selector, 16> InstanceMethodSels;
2252 SmallVector<llvm::Constant*, 16> InstanceMethodTypes;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002253 for (const auto *I : OID->instance_methods()) {
2254 InstanceMethodSels.push_back(I->getSelector());
John McCall843dfcc2016-11-29 21:57:00 +00002255 std::string TypeStr = Context.getObjCEncodingForMethodDecl(I);
David Chisnall5778fce2009-08-31 16:41:57 +00002256 InstanceMethodTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002257 }
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002258
2259 llvm::Constant *Properties = GeneratePropertyList(OID, InstanceMethodSels,
2260 InstanceMethodTypes);
2261
Daniel Dunbar92992502008-08-15 22:20:32 +00002262 // Collect information about class methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002263 SmallVector<Selector, 16> ClassMethodSels;
2264 SmallVector<llvm::Constant*, 16> ClassMethodTypes;
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002265 for (const auto *I : OID->class_methods()) {
2266 ClassMethodSels.push_back(I->getSelector());
John McCall843dfcc2016-11-29 21:57:00 +00002267 std::string TypeStr = Context.getObjCEncodingForMethodDecl(I);
David Chisnall5778fce2009-08-31 16:41:57 +00002268 ClassMethodTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002269 }
2270 // Collect the names of referenced protocols
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002271 SmallVector<std::string, 16> Protocols;
Aaron Ballmana49c5062014-03-13 20:29:09 +00002272 for (const auto *I : ClassDecl->protocols())
2273 Protocols.push_back(I->getNameAsString());
Daniel Dunbar92992502008-08-15 22:20:32 +00002274
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002275 // Get the superclass pointer.
2276 llvm::Constant *SuperClass;
Chris Lattner86d7d912008-11-24 03:54:41 +00002277 if (!SuperClassName.empty()) {
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002278 SuperClass = MakeConstantString(SuperClassName, ".super_class_name");
2279 } else {
Owen Anderson7ec07a52009-07-30 23:11:26 +00002280 SuperClass = llvm::ConstantPointerNull::get(PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002281 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002282 // Empty vector used to construct empty method lists
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002283 SmallVector<llvm::Constant*, 1> empty;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002284 // Generate the method and instance variable lists
2285 llvm::Constant *MethodList = GenerateMethodList(ClassName, "",
Chris Lattnerbf231a62008-06-26 05:08:00 +00002286 InstanceMethodSels, InstanceMethodTypes, false);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002287 llvm::Constant *ClassMethodList = GenerateMethodList(ClassName, "",
Chris Lattnerbf231a62008-06-26 05:08:00 +00002288 ClassMethodSels, ClassMethodTypes, true);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002289 llvm::Constant *IvarList = GenerateIvarList(IvarNames, IvarTypes,
2290 IvarOffsets);
Mike Stump11289f42009-09-09 15:08:12 +00002291 // Irrespective of whether we are compiling for a fragile or non-fragile ABI,
David Chisnall5778fce2009-08-31 16:41:57 +00002292 // we emit a symbol containing the offset for each ivar in the class. This
2293 // allows code compiled for the non-Fragile ABI to inherit from code compiled
2294 // for the legacy ABI, without causing problems. The converse is also
2295 // possible, but causes all ivar accesses to be fragile.
David Chisnalle8431a72010-11-03 16:12:44 +00002296
David Chisnall5778fce2009-08-31 16:41:57 +00002297 // Offset pointer for getting at the correct field in the ivar list when
2298 // setting up the alias. These are: The base address for the global, the
2299 // ivar array (second field), the ivar in this list (set for each ivar), and
2300 // the offset (third field in ivar structure)
David Chisnallcdd207e2011-10-04 15:35:30 +00002301 llvm::Type *IndexTy = Int32Ty;
David Chisnall5778fce2009-08-31 16:41:57 +00002302 llvm::Constant *offsetPointerIndexes[] = {Zeros[0],
Craig Topper8a13c412014-05-21 05:09:00 +00002303 llvm::ConstantInt::get(IndexTy, 1), nullptr,
David Chisnall5778fce2009-08-31 16:41:57 +00002304 llvm::ConstantInt::get(IndexTy, 2) };
2305
Jordy Rosea91768e2011-07-22 02:08:32 +00002306 unsigned ivarIndex = 0;
2307 for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD;
2308 IVD = IVD->getNextIvar()) {
David Chisnall5778fce2009-08-31 16:41:57 +00002309 const std::string Name = "__objc_ivar_offset_" + ClassName + '.'
David Chisnalle8431a72010-11-03 16:12:44 +00002310 + IVD->getNameAsString();
Jordy Rosea91768e2011-07-22 02:08:32 +00002311 offsetPointerIndexes[2] = llvm::ConstantInt::get(IndexTy, ivarIndex);
David Chisnall5778fce2009-08-31 16:41:57 +00002312 // Get the correct ivar field
2313 llvm::Constant *offsetValue = llvm::ConstantExpr::getGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00002314 cast<llvm::GlobalVariable>(IvarList)->getValueType(), IvarList,
2315 offsetPointerIndexes);
David Chisnalle8431a72010-11-03 16:12:44 +00002316 // Get the existing variable, if one exists.
David Chisnall5778fce2009-08-31 16:41:57 +00002317 llvm::GlobalVariable *offset = TheModule.getNamedGlobal(Name);
2318 if (offset) {
Ted Kremenek669669f2012-04-04 00:55:25 +00002319 offset->setInitializer(offsetValue);
2320 // If this is the real definition, change its linkage type so that
2321 // different modules will use this one, rather than their private
2322 // copy.
2323 offset->setLinkage(llvm::GlobalValue::ExternalLinkage);
David Chisnall5778fce2009-08-31 16:41:57 +00002324 } else {
Ted Kremenek669669f2012-04-04 00:55:25 +00002325 // Add a new alias if there isn't one already.
2326 offset = new llvm::GlobalVariable(TheModule, offsetValue->getType(),
2327 false, llvm::GlobalValue::ExternalLinkage, offsetValue, Name);
2328 (void) offset; // Silence dead store warning.
David Chisnall5778fce2009-08-31 16:41:57 +00002329 }
Jordy Rosea91768e2011-07-22 02:08:32 +00002330 ++ivarIndex;
David Chisnall5778fce2009-08-31 16:41:57 +00002331 }
David Chisnalle89ac062011-10-25 10:12:21 +00002332 llvm::Constant *ZeroPtr = llvm::ConstantInt::get(IntPtrTy, 0);
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002333
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002334 //Generate metaclass for class methods
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002335 llvm::Constant *MetaClassStruct = GenerateClassStructure(
2336 NULLPtr, NULLPtr, 0x12L, ClassName.c_str(), nullptr, Zeros[0],
2337 GenerateIvarList(empty, empty, empty), ClassMethodList, NULLPtr, NULLPtr,
2338 NULLPtr, ZeroPtr, ZeroPtr, true);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00002339 if (CGM.getTriple().isOSBinFormatCOFF()) {
2340 auto Storage = llvm::GlobalValue::DefaultStorageClass;
2341 if (OID->getClassInterface()->hasAttr<DLLImportAttr>())
2342 Storage = llvm::GlobalValue::DLLImportStorageClass;
2343 else if (OID->getClassInterface()->hasAttr<DLLExportAttr>())
2344 Storage = llvm::GlobalValue::DLLExportStorageClass;
2345 cast<llvm::GlobalValue>(MetaClassStruct)->setDLLStorageClass(Storage);
2346 }
Daniel Dunbar566421c2009-05-04 15:31:17 +00002347
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002348 // Generate the class structure
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002349 llvm::Constant *ClassStruct = GenerateClassStructure(
2350 MetaClassStruct, SuperClass, 0x11L, ClassName.c_str(), nullptr,
2351 llvm::ConstantInt::get(LongTy, instanceSize), IvarList, MethodList,
2352 GenerateProtocolList(Protocols), IvarOffsetArray, Properties,
2353 StrongIvarBitmap, WeakIvarBitmap);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00002354 if (CGM.getTriple().isOSBinFormatCOFF()) {
2355 auto Storage = llvm::GlobalValue::DefaultStorageClass;
2356 if (OID->getClassInterface()->hasAttr<DLLImportAttr>())
2357 Storage = llvm::GlobalValue::DLLImportStorageClass;
2358 else if (OID->getClassInterface()->hasAttr<DLLExportAttr>())
2359 Storage = llvm::GlobalValue::DLLExportStorageClass;
2360 cast<llvm::GlobalValue>(ClassStruct)->setDLLStorageClass(Storage);
2361 }
Daniel Dunbar566421c2009-05-04 15:31:17 +00002362
2363 // Resolve the class aliases, if they exist.
2364 if (ClassPtrAlias) {
David Chisnall82f755c2010-11-09 11:21:43 +00002365 ClassPtrAlias->replaceAllUsesWith(
Owen Andersonade90fd2009-07-29 18:54:39 +00002366 llvm::ConstantExpr::getBitCast(ClassStruct, IdTy));
David Chisnall82f755c2010-11-09 11:21:43 +00002367 ClassPtrAlias->eraseFromParent();
Craig Topper8a13c412014-05-21 05:09:00 +00002368 ClassPtrAlias = nullptr;
Daniel Dunbar566421c2009-05-04 15:31:17 +00002369 }
2370 if (MetaClassPtrAlias) {
David Chisnall82f755c2010-11-09 11:21:43 +00002371 MetaClassPtrAlias->replaceAllUsesWith(
Owen Andersonade90fd2009-07-29 18:54:39 +00002372 llvm::ConstantExpr::getBitCast(MetaClassStruct, IdTy));
David Chisnall82f755c2010-11-09 11:21:43 +00002373 MetaClassPtrAlias->eraseFromParent();
Craig Topper8a13c412014-05-21 05:09:00 +00002374 MetaClassPtrAlias = nullptr;
Daniel Dunbar566421c2009-05-04 15:31:17 +00002375 }
2376
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002377 // Add class structure to list to be added to the symtab later
Owen Andersonade90fd2009-07-29 18:54:39 +00002378 ClassStruct = llvm::ConstantExpr::getBitCast(ClassStruct, PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002379 Classes.push_back(ClassStruct);
2380}
2381
Mike Stump11289f42009-09-09 15:08:12 +00002382llvm::Function *CGObjCGNU::ModuleInitFunction() {
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002383 // Only emit an ObjC load function if no Objective-C stuff has been called
2384 if (Classes.empty() && Categories.empty() && ConstantStrings.empty() &&
David Chisnalld7972f52011-03-23 16:36:54 +00002385 ExistingProtocols.empty() && SelectorTable.empty())
Craig Topper8a13c412014-05-21 05:09:00 +00002386 return nullptr;
Eli Friedman412c6682008-06-01 16:00:02 +00002387
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002388 // Add all referenced protocols to a category.
2389 GenerateProtocolHolderCategory();
2390
John McCallecee86f2016-11-30 20:19:46 +00002391 llvm::StructType *selStructTy =
2392 dyn_cast<llvm::StructType>(SelectorTy->getElementType());
2393 llvm::Type *selStructPtrTy = SelectorTy;
2394 if (!selStructTy) {
2395 selStructTy = llvm::StructType::get(CGM.getLLVMContext(),
2396 { PtrToInt8Ty, PtrToInt8Ty });
2397 selStructPtrTy = llvm::PointerType::getUnqual(selStructTy);
Chris Lattner8d3f4a42009-01-27 05:06:01 +00002398 }
2399
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002400 // Generate statics list:
John McCallecee86f2016-11-30 20:19:46 +00002401 llvm::Constant *statics = NULLPtr;
Alexander Kornienko6ee521c2015-01-23 15:36:10 +00002402 if (!ConstantStrings.empty()) {
John McCallecee86f2016-11-30 20:19:46 +00002403 llvm::GlobalVariable *fileStatics = [&] {
2404 ConstantInitBuilder builder(CGM);
2405 auto staticsStruct = builder.beginStruct();
David Chisnall5778fce2009-08-31 16:41:57 +00002406
John McCallecee86f2016-11-30 20:19:46 +00002407 StringRef stringClass = CGM.getLangOpts().ObjCConstantStringClass;
2408 if (stringClass.empty()) stringClass = "NXConstantString";
2409 staticsStruct.add(MakeConstantString(stringClass,
2410 ".objc_static_class_name"));
David Chisnalld7972f52011-03-23 16:36:54 +00002411
John McCallecee86f2016-11-30 20:19:46 +00002412 auto array = staticsStruct.beginArray();
2413 array.addAll(ConstantStrings);
2414 array.add(NULLPtr);
2415 array.finishAndAddTo(staticsStruct);
David Chisnalld7972f52011-03-23 16:36:54 +00002416
John McCallecee86f2016-11-30 20:19:46 +00002417 return staticsStruct.finishAndCreateGlobal(".objc_statics",
2418 CGM.getPointerAlign());
2419 }();
2420
2421 ConstantInitBuilder builder(CGM);
2422 auto allStaticsArray = builder.beginArray(fileStatics->getType());
2423 allStaticsArray.add(fileStatics);
2424 allStaticsArray.addNullPointer(fileStatics->getType());
2425
2426 statics = allStaticsArray.finishAndCreateGlobal(".objc_statics_ptr",
2427 CGM.getPointerAlign());
2428 statics = llvm::ConstantExpr::getBitCast(statics, PtrTy);
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00002429 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002430
John McCallecee86f2016-11-30 20:19:46 +00002431 // Array of classes, categories, and constant objects.
2432
2433 SmallVector<llvm::GlobalAlias*, 16> selectorAliases;
2434 unsigned selectorCount;
2435
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002436 // Pointer to an array of selectors used in this module.
John McCallecee86f2016-11-30 20:19:46 +00002437 llvm::GlobalVariable *selectorList = [&] {
2438 ConstantInitBuilder builder(CGM);
2439 auto selectors = builder.beginArray(selStructTy);
John McCallf00e2c02016-11-30 20:46:55 +00002440 auto &table = SelectorTable; // MSVC workaround
2441 for (auto &entry : table) {
David Chisnalld7972f52011-03-23 16:36:54 +00002442
John McCallecee86f2016-11-30 20:19:46 +00002443 std::string selNameStr = entry.first.getAsString();
2444 llvm::Constant *selName = ExportUniqueString(selNameStr, ".objc_sel_name");
David Chisnalld7972f52011-03-23 16:36:54 +00002445
John McCallecee86f2016-11-30 20:19:46 +00002446 for (TypedSelector &sel : entry.second) {
2447 llvm::Constant *selectorTypeEncoding = NULLPtr;
2448 if (!sel.first.empty())
2449 selectorTypeEncoding =
2450 MakeConstantString(sel.first, ".objc_sel_types");
David Chisnalld7972f52011-03-23 16:36:54 +00002451
John McCallecee86f2016-11-30 20:19:46 +00002452 auto selStruct = selectors.beginStruct(selStructTy);
2453 selStruct.add(selName);
2454 selStruct.add(selectorTypeEncoding);
2455 selStruct.finishAndAddTo(selectors);
David Chisnalld7972f52011-03-23 16:36:54 +00002456
John McCallecee86f2016-11-30 20:19:46 +00002457 // Store the selector alias for later replacement
2458 selectorAliases.push_back(sel.second);
2459 }
David Chisnalld7972f52011-03-23 16:36:54 +00002460 }
David Chisnalld7972f52011-03-23 16:36:54 +00002461
John McCallecee86f2016-11-30 20:19:46 +00002462 // Remember the number of entries in the selector table.
2463 selectorCount = selectors.size();
2464
2465 // NULL-terminate the selector list. This should not actually be required,
2466 // because the selector list has a length field. Unfortunately, the GCC
2467 // runtime decides to ignore the length field and expects a NULL terminator,
2468 // and GCC cooperates with this by always setting the length to 0.
2469 auto selStruct = selectors.beginStruct(selStructTy);
2470 selStruct.add(NULLPtr);
2471 selStruct.add(NULLPtr);
2472 selStruct.finishAndAddTo(selectors);
2473
2474 return selectors.finishAndCreateGlobal(".objc_selector_list",
2475 CGM.getPointerAlign());
2476 }();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002477
2478 // Now that all of the static selectors exist, create pointers to them.
John McCallecee86f2016-11-30 20:19:46 +00002479 for (unsigned i = 0; i < selectorCount; ++i) {
2480 llvm::Constant *idxs[] = {
2481 Zeros[0],
2482 llvm::ConstantInt::get(Int32Ty, i)
2483 };
David Chisnalld7972f52011-03-23 16:36:54 +00002484 // FIXME: We're generating redundant loads and stores here!
John McCallecee86f2016-11-30 20:19:46 +00002485 llvm::Constant *selPtr = llvm::ConstantExpr::getGetElementPtr(
2486 selectorList->getValueType(), selectorList, idxs);
Chris Lattner8d3f4a42009-01-27 05:06:01 +00002487 // If selectors are defined as an opaque type, cast the pointer to this
2488 // type.
John McCallecee86f2016-11-30 20:19:46 +00002489 selPtr = llvm::ConstantExpr::getBitCast(selPtr, SelectorTy);
2490 selectorAliases[i]->replaceAllUsesWith(selPtr);
2491 selectorAliases[i]->eraseFromParent();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002492 }
David Chisnalld7972f52011-03-23 16:36:54 +00002493
John McCallecee86f2016-11-30 20:19:46 +00002494 llvm::GlobalVariable *symtab = [&] {
2495 ConstantInitBuilder builder(CGM);
2496 auto symtab = builder.beginStruct();
2497
2498 // Number of static selectors
2499 symtab.addInt(LongTy, selectorCount);
2500
2501 symtab.addBitCast(selectorList, selStructPtrTy);
2502
2503 // Number of classes defined.
2504 symtab.addInt(CGM.Int16Ty, Classes.size());
2505 // Number of categories defined
2506 symtab.addInt(CGM.Int16Ty, Categories.size());
2507
2508 // Create an array of classes, then categories, then static object instances
2509 auto classList = symtab.beginArray(PtrToInt8Ty);
2510 classList.addAll(Classes);
2511 classList.addAll(Categories);
2512 // NULL-terminated list of static object instances (mainly constant strings)
2513 classList.add(statics);
2514 classList.add(NULLPtr);
2515 classList.finishAndAddTo(symtab);
2516
2517 // Construct the symbol table.
2518 return symtab.finishAndCreateGlobal("", CGM.getPointerAlign());
2519 }();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002520
2521 // The symbol table is contained in a module which has some version-checking
2522 // constants
John McCallecee86f2016-11-30 20:19:46 +00002523 llvm::Constant *module = [&] {
2524 llvm::Type *moduleEltTys[] = {
2525 LongTy, LongTy, PtrToInt8Ty, symtab->getType(), IntTy
2526 };
2527 llvm::StructType *moduleTy =
2528 llvm::StructType::get(CGM.getLLVMContext(),
2529 makeArrayRef(moduleEltTys).drop_back(unsigned(RuntimeVersion < 10)));
David Chisnalld7972f52011-03-23 16:36:54 +00002530
John McCallecee86f2016-11-30 20:19:46 +00002531 ConstantInitBuilder builder(CGM);
2532 auto module = builder.beginStruct(moduleTy);
2533 // Runtime version, used for ABI compatibility checking.
2534 module.addInt(LongTy, RuntimeVersion);
2535 // sizeof(ModuleTy)
2536 module.addInt(LongTy, CGM.getDataLayout().getTypeStoreSize(moduleTy));
2537
2538 // The path to the source file where this module was declared
2539 SourceManager &SM = CGM.getContext().getSourceManager();
2540 const FileEntry *mainFile = SM.getFileEntryForID(SM.getMainFileID());
2541 std::string path =
Mehdi Amini004b9c72016-10-10 22:52:47 +00002542 (Twine(mainFile->getDir()->getName()) + "/" + mainFile->getName()).str();
John McCallecee86f2016-11-30 20:19:46 +00002543 module.add(MakeConstantString(path, ".objc_source_file_name"));
2544 module.add(symtab);
David Chisnall5c511772011-05-22 22:37:08 +00002545
John McCallecee86f2016-11-30 20:19:46 +00002546 if (RuntimeVersion >= 10) {
2547 switch (CGM.getLangOpts().getGC()) {
David Chisnalla918b882011-07-07 11:22:31 +00002548 case LangOptions::GCOnly:
John McCallecee86f2016-11-30 20:19:46 +00002549 module.addInt(IntTy, 2);
David Chisnall5c511772011-05-22 22:37:08 +00002550 break;
David Chisnalla918b882011-07-07 11:22:31 +00002551 case LangOptions::NonGC:
David Blaikiebbafb8a2012-03-11 07:00:24 +00002552 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallecee86f2016-11-30 20:19:46 +00002553 module.addInt(IntTy, 1);
David Chisnalla918b882011-07-07 11:22:31 +00002554 else
John McCallecee86f2016-11-30 20:19:46 +00002555 module.addInt(IntTy, 0);
David Chisnalla918b882011-07-07 11:22:31 +00002556 break;
2557 case LangOptions::HybridGC:
John McCallecee86f2016-11-30 20:19:46 +00002558 module.addInt(IntTy, 1);
David Chisnalla918b882011-07-07 11:22:31 +00002559 break;
John McCallecee86f2016-11-30 20:19:46 +00002560 }
David Chisnalla918b882011-07-07 11:22:31 +00002561 }
David Chisnall5c511772011-05-22 22:37:08 +00002562
John McCallecee86f2016-11-30 20:19:46 +00002563 return module.finishAndCreateGlobal("", CGM.getPointerAlign());
2564 }();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002565
2566 // Create the load function calling the runtime entry point with the module
2567 // structure
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002568 llvm::Function * LoadFunction = llvm::Function::Create(
Owen Anderson41a75022009-08-13 21:57:51 +00002569 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext), false),
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002570 llvm::GlobalValue::InternalLinkage, ".objc_load_function",
2571 &TheModule);
Owen Anderson41a75022009-08-13 21:57:51 +00002572 llvm::BasicBlock *EntryBB =
2573 llvm::BasicBlock::Create(VMContext, "entry", LoadFunction);
John McCall7f416cc2015-09-08 08:05:57 +00002574 CGBuilderTy Builder(CGM, VMContext);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002575 Builder.SetInsertPoint(EntryBB);
Fariborz Jahanian3b636c12009-03-30 18:02:14 +00002576
Benjamin Kramerdf1fb132011-05-28 14:26:31 +00002577 llvm::FunctionType *FT =
John McCallecee86f2016-11-30 20:19:46 +00002578 llvm::FunctionType::get(Builder.getVoidTy(), module->getType(), true);
Benjamin Kramerdf1fb132011-05-28 14:26:31 +00002579 llvm::Value *Register = CGM.CreateRuntimeFunction(FT, "__objc_exec_class");
John McCallecee86f2016-11-30 20:19:46 +00002580 Builder.CreateCall(Register, module);
David Chisnall92d436b2012-01-31 18:59:20 +00002581
David Chisnallaf066bbb2012-02-01 19:16:56 +00002582 if (!ClassAliases.empty()) {
David Chisnall92d436b2012-01-31 18:59:20 +00002583 llvm::Type *ArgTypes[2] = {PtrTy, PtrToInt8Ty};
2584 llvm::FunctionType *RegisterAliasTy =
2585 llvm::FunctionType::get(Builder.getVoidTy(),
2586 ArgTypes, false);
2587 llvm::Function *RegisterAlias = llvm::Function::Create(
2588 RegisterAliasTy,
2589 llvm::GlobalValue::ExternalWeakLinkage, "class_registerAlias_np",
2590 &TheModule);
2591 llvm::BasicBlock *AliasBB =
2592 llvm::BasicBlock::Create(VMContext, "alias", LoadFunction);
2593 llvm::BasicBlock *NoAliasBB =
2594 llvm::BasicBlock::Create(VMContext, "no_alias", LoadFunction);
2595
2596 // Branch based on whether the runtime provided class_registerAlias_np()
2597 llvm::Value *HasRegisterAlias = Builder.CreateICmpNE(RegisterAlias,
2598 llvm::Constant::getNullValue(RegisterAlias->getType()));
2599 Builder.CreateCondBr(HasRegisterAlias, AliasBB, NoAliasBB);
2600
Alp Tokerf6a24ce2013-12-05 16:25:25 +00002601 // The true branch (has alias registration function):
David Chisnall92d436b2012-01-31 18:59:20 +00002602 Builder.SetInsertPoint(AliasBB);
2603 // Emit alias registration calls:
2604 for (std::vector<ClassAliasPair>::iterator iter = ClassAliases.begin();
2605 iter != ClassAliases.end(); ++iter) {
2606 llvm::Constant *TheClass =
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00002607 TheModule.getGlobalVariable("_OBJC_CLASS_" + iter->first, true);
Craig Topper8a13c412014-05-21 05:09:00 +00002608 if (TheClass) {
David Chisnall92d436b2012-01-31 18:59:20 +00002609 TheClass = llvm::ConstantExpr::getBitCast(TheClass, PtrTy);
David Blaikie43f9bb72015-05-18 22:14:03 +00002610 Builder.CreateCall(RegisterAlias,
2611 {TheClass, MakeConstantString(iter->second)});
David Chisnall92d436b2012-01-31 18:59:20 +00002612 }
2613 }
2614 // Jump to end:
2615 Builder.CreateBr(NoAliasBB);
2616
2617 // Missing alias registration function, just return from the function:
2618 Builder.SetInsertPoint(NoAliasBB);
2619 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002620 Builder.CreateRetVoid();
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002621
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002622 return LoadFunction;
2623}
Daniel Dunbar92992502008-08-15 22:20:32 +00002624
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00002625llvm::Function *CGObjCGNU::GenerateMethod(const ObjCMethodDecl *OMD,
Mike Stump11289f42009-09-09 15:08:12 +00002626 const ObjCContainerDecl *CD) {
2627 const ObjCCategoryImplDecl *OCD =
Steve Naroff11b387f2009-01-08 19:41:02 +00002628 dyn_cast<ObjCCategoryImplDecl>(OMD->getDeclContext());
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002629 StringRef CategoryName = OCD ? OCD->getName() : "";
2630 StringRef ClassName = CD->getName();
David Chisnalld7972f52011-03-23 16:36:54 +00002631 Selector MethodName = OMD->getSelector();
Douglas Gregorffca3a22009-01-09 17:18:27 +00002632 bool isClassMethod = !OMD->isInstanceMethod();
Daniel Dunbar92992502008-08-15 22:20:32 +00002633
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00002634 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00002635 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00002636 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002637 std::string FunctionName = SymbolNameForMethod(ClassName, CategoryName,
2638 MethodName, isClassMethod);
2639
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00002640 llvm::Function *Method
Mike Stump11289f42009-09-09 15:08:12 +00002641 = llvm::Function::Create(MethodTy,
2642 llvm::GlobalValue::InternalLinkage,
2643 FunctionName,
2644 &TheModule);
Chris Lattner4bd55962008-03-30 23:03:07 +00002645 return Method;
2646}
2647
David Chisnall3fe89562011-05-23 22:33:28 +00002648llvm::Constant *CGObjCGNU::GetPropertyGetFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002649 return GetPropertyFn;
Daniel Dunbara91c3e02008-09-24 03:38:44 +00002650}
2651
David Chisnall3fe89562011-05-23 22:33:28 +00002652llvm::Constant *CGObjCGNU::GetPropertySetFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002653 return SetPropertyFn;
Daniel Dunbara91c3e02008-09-24 03:38:44 +00002654}
2655
Ted Kremeneke65b0862012-03-06 20:05:56 +00002656llvm::Constant *CGObjCGNU::GetOptimizedPropertySetFunction(bool atomic,
2657 bool copy) {
Craig Topper8a13c412014-05-21 05:09:00 +00002658 return nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +00002659}
2660
David Chisnall3fe89562011-05-23 22:33:28 +00002661llvm::Constant *CGObjCGNU::GetGetStructFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002662 return GetStructPropertyFn;
David Chisnall168b80f2010-12-26 22:13:16 +00002663}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002664
David Chisnall3fe89562011-05-23 22:33:28 +00002665llvm::Constant *CGObjCGNU::GetSetStructFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002666 return SetStructPropertyFn;
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00002667}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002668
David Chisnall0d75e062012-12-17 18:54:24 +00002669llvm::Constant *CGObjCGNU::GetCppAtomicObjectGetFunction() {
Craig Topper8a13c412014-05-21 05:09:00 +00002670 return nullptr;
David Chisnall0d75e062012-12-17 18:54:24 +00002671}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002672
David Chisnall0d75e062012-12-17 18:54:24 +00002673llvm::Constant *CGObjCGNU::GetCppAtomicObjectSetFunction() {
Craig Topper8a13c412014-05-21 05:09:00 +00002674 return nullptr;
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00002675}
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00002676
Daniel Dunbarc46a0792009-07-24 07:40:24 +00002677llvm::Constant *CGObjCGNU::EnumerationMutationFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002678 return EnumerationMutationFn;
Anders Carlsson3f35a262008-08-31 04:05:03 +00002679}
2680
David Chisnalld7972f52011-03-23 16:36:54 +00002681void CGObjCGNU::EmitSynchronizedStmt(CodeGenFunction &CGF,
John McCallbd309292010-07-06 01:34:17 +00002682 const ObjCAtSynchronizedStmt &S) {
David Chisnalld3858d62011-03-25 11:57:33 +00002683 EmitAtSynchronizedStmt(CGF, S, SyncEnterFn, SyncExitFn);
John McCallbd309292010-07-06 01:34:17 +00002684}
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002685
David Chisnall3a509cd2009-12-24 02:26:34 +00002686
David Chisnalld7972f52011-03-23 16:36:54 +00002687void CGObjCGNU::EmitTryStmt(CodeGenFunction &CGF,
John McCallbd309292010-07-06 01:34:17 +00002688 const ObjCAtTryStmt &S) {
2689 // Unlike the Apple non-fragile runtimes, which also uses
2690 // unwind-based zero cost exceptions, the GNU Objective C runtime's
2691 // EH support isn't a veneer over C++ EH. Instead, exception
David Chisnall9a837be2012-11-07 16:50:40 +00002692 // objects are created by objc_exception_throw and destroyed by
John McCallbd309292010-07-06 01:34:17 +00002693 // the personality function; this avoids the need for bracketing
2694 // catch handlers with calls to __blah_begin_catch/__blah_end_catch
2695 // (or even _Unwind_DeleteException), but probably doesn't
2696 // interoperate very well with foreign exceptions.
David Chisnalld3858d62011-03-25 11:57:33 +00002697 //
David Chisnalle1d2584d2011-03-20 21:35:39 +00002698 // In Objective-C++ mode, we actually emit something equivalent to the C++
David Chisnalld3858d62011-03-25 11:57:33 +00002699 // exception handler.
2700 EmitTryCatchStmt(CGF, S, EnterCatchFn, ExitCatchFn, ExceptionReThrowFn);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002701}
2702
David Chisnalld7972f52011-03-23 16:36:54 +00002703void CGObjCGNU::EmitThrowStmt(CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00002704 const ObjCAtThrowStmt &S,
2705 bool ClearInsertionPoint) {
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002706 llvm::Value *ExceptionAsObject;
2707
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002708 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00002709 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Fariborz Jahanian078cd522009-05-17 16:49:27 +00002710 ExceptionAsObject = Exception;
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002711 } else {
Mike Stump11289f42009-09-09 15:08:12 +00002712 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002713 "Unexpected rethrow outside @catch block.");
2714 ExceptionAsObject = CGF.ObjCEHValueStack.back();
2715 }
Benjamin Kramer76399eb2011-09-27 21:06:10 +00002716 ExceptionAsObject = CGF.Builder.CreateBitCast(ExceptionAsObject, IdTy);
David Chisnall9a837be2012-11-07 16:50:40 +00002717 llvm::CallSite Throw =
John McCall882987f2013-02-28 19:01:20 +00002718 CGF.EmitRuntimeCallOrInvoke(ExceptionThrowFn, ExceptionAsObject);
David Chisnall9a837be2012-11-07 16:50:40 +00002719 Throw.setDoesNotReturn();
Eli Friedmandc009da2012-08-10 21:26:17 +00002720 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00002721 if (ClearInsertionPoint)
2722 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002723}
2724
David Chisnalld7972f52011-03-23 16:36:54 +00002725llvm::Value * CGObjCGNU::EmitObjCWeakRead(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002726 Address AddrWeakObj) {
John McCall882987f2013-02-28 19:01:20 +00002727 CGBuilderTy &B = CGF.Builder;
David Chisnallfcb37e92011-05-30 12:00:26 +00002728 AddrWeakObj = EnforceType(B, AddrWeakObj, PtrToIdTy);
John McCall7f416cc2015-09-08 08:05:57 +00002729 return B.CreateCall(WeakReadFn.getType(), WeakReadFn,
2730 AddrWeakObj.getPointer());
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00002731}
2732
David Chisnalld7972f52011-03-23 16:36:54 +00002733void CGObjCGNU::EmitObjCWeakAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002734 llvm::Value *src, Address dst) {
John McCall882987f2013-02-28 19:01:20 +00002735 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00002736 src = EnforceType(B, src, IdTy);
2737 dst = EnforceType(B, dst, PtrToIdTy);
John McCall7f416cc2015-09-08 08:05:57 +00002738 B.CreateCall(WeakAssignFn.getType(), WeakAssignFn,
2739 {src, dst.getPointer()});
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00002740}
2741
David Chisnalld7972f52011-03-23 16:36:54 +00002742void CGObjCGNU::EmitObjCGlobalAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002743 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00002744 bool threadlocal) {
John McCall882987f2013-02-28 19:01:20 +00002745 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00002746 src = EnforceType(B, src, IdTy);
2747 dst = EnforceType(B, dst, PtrToIdTy);
David Blaikie43f9bb72015-05-18 22:14:03 +00002748 // FIXME. Add threadloca assign API
2749 assert(!threadlocal && "EmitObjCGlobalAssign - Threal Local API NYI");
John McCall7f416cc2015-09-08 08:05:57 +00002750 B.CreateCall(GlobalAssignFn.getType(), GlobalAssignFn,
2751 {src, dst.getPointer()});
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00002752}
2753
David Chisnalld7972f52011-03-23 16:36:54 +00002754void CGObjCGNU::EmitObjCIvarAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002755 llvm::Value *src, Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00002756 llvm::Value *ivarOffset) {
John McCall882987f2013-02-28 19:01:20 +00002757 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00002758 src = EnforceType(B, src, IdTy);
David Chisnalle4e5c0f2011-05-25 20:33:17 +00002759 dst = EnforceType(B, dst, IdTy);
John McCall7f416cc2015-09-08 08:05:57 +00002760 B.CreateCall(IvarAssignFn.getType(), IvarAssignFn,
2761 {src, dst.getPointer(), ivarOffset});
Fariborz Jahaniane881b532008-11-20 19:23:36 +00002762}
2763
David Chisnalld7972f52011-03-23 16:36:54 +00002764void CGObjCGNU::EmitObjCStrongCastAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002765 llvm::Value *src, Address dst) {
John McCall882987f2013-02-28 19:01:20 +00002766 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00002767 src = EnforceType(B, src, IdTy);
2768 dst = EnforceType(B, dst, PtrToIdTy);
John McCall7f416cc2015-09-08 08:05:57 +00002769 B.CreateCall(StrongCastAssignFn.getType(), StrongCastAssignFn,
2770 {src, dst.getPointer()});
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00002771}
2772
David Chisnalld7972f52011-03-23 16:36:54 +00002773void CGObjCGNU::EmitGCMemmoveCollectable(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002774 Address DestPtr,
2775 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00002776 llvm::Value *Size) {
John McCall882987f2013-02-28 19:01:20 +00002777 CGBuilderTy &B = CGF.Builder;
David Chisnall7441d882011-05-28 14:23:43 +00002778 DestPtr = EnforceType(B, DestPtr, PtrTy);
2779 SrcPtr = EnforceType(B, SrcPtr, PtrTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00002780
John McCall7f416cc2015-09-08 08:05:57 +00002781 B.CreateCall(MemMoveFn.getType(), MemMoveFn,
2782 {DestPtr.getPointer(), SrcPtr.getPointer(), Size});
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002783}
2784
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002785llvm::GlobalVariable *CGObjCGNU::ObjCIvarOffsetVariable(
2786 const ObjCInterfaceDecl *ID,
2787 const ObjCIvarDecl *Ivar) {
2788 const std::string Name = "__objc_ivar_offset_" + ID->getNameAsString()
2789 + '.' + Ivar->getNameAsString();
2790 // Emit the variable and initialize it with what we think the correct value
2791 // is. This allows code compiled with non-fragile ivars to work correctly
2792 // when linked against code which isn't (most of the time).
David Chisnall5778fce2009-08-31 16:41:57 +00002793 llvm::GlobalVariable *IvarOffsetPointer = TheModule.getNamedGlobal(Name);
2794 if (!IvarOffsetPointer) {
David Chisnalle8431a72010-11-03 16:12:44 +00002795 // This will cause a run-time crash if we accidentally use it. A value of
2796 // 0 would seem more sensible, but will silently overwrite the isa pointer
2797 // causing a great deal of confusion.
2798 uint64_t Offset = -1;
2799 // We can't call ComputeIvarBaseOffset() here if we have the
2800 // implementation, because it will create an invalid ASTRecordLayout object
2801 // that we are then stuck with forever, so we only initialize the ivar
2802 // offset variable with a guess if we only have the interface. The
2803 // initializer will be reset later anyway, when we are generating the class
2804 // description.
2805 if (!CGM.getContext().getObjCImplementation(
Dan Gohman145f3f12010-04-19 16:39:44 +00002806 const_cast<ObjCInterfaceDecl *>(ID)))
Eli Friedman8cbca202012-11-06 22:15:52 +00002807 Offset = ComputeIvarBaseOffset(CGM, ID, Ivar);
David Chisnall44ec5552010-04-19 01:37:25 +00002808
David Chisnalle0dc7cb2011-10-08 08:54:36 +00002809 llvm::ConstantInt *OffsetGuess = llvm::ConstantInt::get(Int32Ty, Offset,
Richard Trieue4f31802011-09-21 02:46:06 +00002810 /*isSigned*/true);
David Chisnall5778fce2009-08-31 16:41:57 +00002811 // Don't emit the guess in non-PIC code because the linker will not be able
2812 // to replace it with the real version for a library. In non-PIC code you
2813 // must compile with the fragile ABI if you want to use ivars from a
Mike Stump11289f42009-09-09 15:08:12 +00002814 // GCC-compiled class.
Rafael Espindolac9d336e2016-06-23 15:07:32 +00002815 if (CGM.getLangOpts().PICLevel) {
David Chisnall5778fce2009-08-31 16:41:57 +00002816 llvm::GlobalVariable *IvarOffsetGV = new llvm::GlobalVariable(TheModule,
David Chisnallcdd207e2011-10-04 15:35:30 +00002817 Int32Ty, false,
David Chisnall5778fce2009-08-31 16:41:57 +00002818 llvm::GlobalValue::PrivateLinkage, OffsetGuess, Name+".guess");
2819 IvarOffsetPointer = new llvm::GlobalVariable(TheModule,
2820 IvarOffsetGV->getType(), false, llvm::GlobalValue::LinkOnceAnyLinkage,
2821 IvarOffsetGV, Name);
2822 } else {
2823 IvarOffsetPointer = new llvm::GlobalVariable(TheModule,
Benjamin Kramerabd5b902009-10-13 10:07:13 +00002824 llvm::Type::getInt32PtrTy(VMContext), false,
Craig Topper8a13c412014-05-21 05:09:00 +00002825 llvm::GlobalValue::ExternalLinkage, nullptr, Name);
David Chisnall5778fce2009-08-31 16:41:57 +00002826 }
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002827 }
David Chisnall5778fce2009-08-31 16:41:57 +00002828 return IvarOffsetPointer;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002829}
2830
David Chisnalld7972f52011-03-23 16:36:54 +00002831LValue CGObjCGNU::EmitObjCValueForIvar(CodeGenFunction &CGF,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00002832 QualType ObjectTy,
2833 llvm::Value *BaseValue,
2834 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00002835 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00002836 const ObjCInterfaceDecl *ID =
2837 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00002838 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
2839 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00002840}
Mike Stumpdd93a192009-07-31 21:31:32 +00002841
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002842static const ObjCInterfaceDecl *FindIvarInterface(ASTContext &Context,
2843 const ObjCInterfaceDecl *OID,
2844 const ObjCIvarDecl *OIVD) {
Jordy Rosea91768e2011-07-22 02:08:32 +00002845 for (const ObjCIvarDecl *next = OID->all_declared_ivar_begin(); next;
2846 next = next->getNextIvar()) {
2847 if (OIVD == next)
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002848 return OID;
2849 }
Mike Stump11289f42009-09-09 15:08:12 +00002850
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002851 // Otherwise check in the super class.
2852 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
2853 return FindIvarInterface(Context, Super, OIVD);
Mike Stump11289f42009-09-09 15:08:12 +00002854
Craig Topper8a13c412014-05-21 05:09:00 +00002855 return nullptr;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002856}
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00002857
David Chisnalld7972f52011-03-23 16:36:54 +00002858llvm::Value *CGObjCGNU::EmitIvarOffset(CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00002859 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00002860 const ObjCIvarDecl *Ivar) {
John McCall5fb5df92012-06-20 06:18:46 +00002861 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002862 Interface = FindIvarInterface(CGM.getContext(), Interface, Ivar);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00002863
2864 // The MSVC linker cannot have a single global defined as LinkOnceAnyLinkage
2865 // and ExternalLinkage, so create a reference to the ivar global and rely on
2866 // the definition being created as part of GenerateClass.
2867 if (RuntimeVersion < 10 ||
2868 CGF.CGM.getTarget().getTriple().isKnownWindowsMSVCEnvironment())
David Chisnall1bfe6d32011-07-07 12:34:51 +00002869 return CGF.Builder.CreateZExtOrBitCast(
Peter Collingbourneb367c562016-11-28 22:30:21 +00002870 CGF.Builder.CreateAlignedLoad(
2871 Int32Ty, CGF.Builder.CreateAlignedLoad(
2872 ObjCIvarOffsetVariable(Interface, Ivar),
2873 CGF.getPointerAlign(), "ivar"),
2874 CharUnits::fromQuantity(4)),
David Chisnall1bfe6d32011-07-07 12:34:51 +00002875 PtrDiffTy);
2876 std::string name = "__objc_ivar_offset_value_" +
2877 Interface->getNameAsString() +"." + Ivar->getNameAsString();
John McCall7f416cc2015-09-08 08:05:57 +00002878 CharUnits Align = CGM.getIntAlign();
David Chisnall1bfe6d32011-07-07 12:34:51 +00002879 llvm::Value *Offset = TheModule.getGlobalVariable(name);
John McCall7f416cc2015-09-08 08:05:57 +00002880 if (!Offset) {
2881 auto GV = new llvm::GlobalVariable(TheModule, IntTy,
David Chisnall28dc7f92011-08-01 17:36:53 +00002882 false, llvm::GlobalValue::LinkOnceAnyLinkage,
2883 llvm::Constant::getNullValue(IntTy), name);
John McCall7f416cc2015-09-08 08:05:57 +00002884 GV->setAlignment(Align.getQuantity());
2885 Offset = GV;
2886 }
2887 Offset = CGF.Builder.CreateAlignedLoad(Offset, Align);
David Chisnalla79b4692012-04-06 15:39:12 +00002888 if (Offset->getType() != PtrDiffTy)
2889 Offset = CGF.Builder.CreateZExtOrBitCast(Offset, PtrDiffTy);
2890 return Offset;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002891 }
Eli Friedman8cbca202012-11-06 22:15:52 +00002892 uint64_t Offset = ComputeIvarBaseOffset(CGF.CGM, Interface, Ivar);
2893 return llvm::ConstantInt::get(PtrDiffTy, Offset, /*isSigned*/true);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00002894}
2895
David Chisnalld7972f52011-03-23 16:36:54 +00002896CGObjCRuntime *
2897clang::CodeGen::CreateGNUObjCRuntime(CodeGenModule &CGM) {
John McCall5fb5df92012-06-20 06:18:46 +00002898 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
David Chisnallb601c962012-07-03 20:49:52 +00002899 case ObjCRuntime::GNUstep:
David Chisnalld7972f52011-03-23 16:36:54 +00002900 return new CGObjCGNUstep(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00002901
David Chisnallb601c962012-07-03 20:49:52 +00002902 case ObjCRuntime::GCC:
John McCall5fb5df92012-06-20 06:18:46 +00002903 return new CGObjCGCC(CGM);
2904
John McCall775086e2012-07-12 02:07:58 +00002905 case ObjCRuntime::ObjFW:
2906 return new CGObjCObjFW(CGM);
2907
John McCall5fb5df92012-06-20 06:18:46 +00002908 case ObjCRuntime::FragileMacOSX:
2909 case ObjCRuntime::MacOSX:
2910 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +00002911 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +00002912 llvm_unreachable("these runtimes are not GNU runtimes");
2913 }
2914 llvm_unreachable("bad runtime");
Chris Lattnerb7256cd2008-03-01 08:50:34 +00002915}