blob: 6f4cde569f8a70b94507fc6bb8603f91ad75dc28 [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;
George Burgess IV00f70bd2018-03-01 05:43:23 +000083 Function = CGM->CreateRuntimeFunction(FTy, FunctionName);
David Blaikie7d9e7922015-05-18 22:51:39 +000084 }
85 return Function;
86 }
87 operator llvm::Function *() {
88 return cast<llvm::Function>((llvm::Constant *)*this);
89 }
David Chisnalld7972f52011-03-23 16:36:54 +000090};
91
92
David Chisnall34d00052011-03-26 11:48:37 +000093/// GNU Objective-C runtime code generation. This class implements the parts of
John McCall775086e2012-07-12 02:07:58 +000094/// Objective-C support that are specific to the GNU family of runtimes (GCC,
95/// GNUstep and ObjFW).
David Chisnalld7972f52011-03-23 16:36:54 +000096class CGObjCGNU : public CGObjCRuntime {
David Chisnall76803412011-03-23 22:52:06 +000097protected:
David Chisnall34d00052011-03-26 11:48:37 +000098 /// The LLVM module into which output is inserted
Chris Lattnerb7256cd2008-03-01 08:50:34 +000099 llvm::Module &TheModule;
David Chisnall34d00052011-03-26 11:48:37 +0000100 /// strut objc_super. Used for sending messages to super. This structure
101 /// contains the receiver (object) and the expected class.
Chris Lattner2192fe52011-07-18 04:24:23 +0000102 llvm::StructType *ObjCSuperTy;
David Chisnall34d00052011-03-26 11:48:37 +0000103 /// struct objc_super*. The type of the argument to the superclass message
104 /// lookup functions.
Chris Lattner2192fe52011-07-18 04:24:23 +0000105 llvm::PointerType *PtrToObjCSuperTy;
David Chisnall34d00052011-03-26 11:48:37 +0000106 /// LLVM type for selectors. Opaque pointer (i8*) unless a header declaring
107 /// SEL is included in a header somewhere, in which case it will be whatever
108 /// type is declared in that header, most likely {i8*, i8*}.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000109 llvm::PointerType *SelectorTy;
David Chisnall34d00052011-03-26 11:48:37 +0000110 /// LLVM i8 type. Cached here to avoid repeatedly getting it in all of the
111 /// places where it's used
Chris Lattner2192fe52011-07-18 04:24:23 +0000112 llvm::IntegerType *Int8Ty;
David Chisnall34d00052011-03-26 11:48:37 +0000113 /// Pointer to i8 - LLVM type of char*, for all of the places where the
114 /// runtime needs to deal with C strings.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000115 llvm::PointerType *PtrToInt8Ty;
David Chisnall34d00052011-03-26 11:48:37 +0000116 /// Instance Method Pointer type. This is a pointer to a function that takes,
117 /// at a minimum, an object and a selector, and is the generic type for
118 /// Objective-C methods. Due to differences between variadic / non-variadic
119 /// calling conventions, it must always be cast to the correct type before
120 /// actually being used.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000121 llvm::PointerType *IMPTy;
David Chisnall34d00052011-03-26 11:48:37 +0000122 /// Type of an untyped Objective-C object. Clang treats id as a built-in type
123 /// when compiling Objective-C code, so this may be an opaque pointer (i8*),
124 /// but if the runtime header declaring it is included then it may be a
125 /// pointer to a structure.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000126 llvm::PointerType *IdTy;
David Chisnall34d00052011-03-26 11:48:37 +0000127 /// Pointer to a pointer to an Objective-C object. Used in the new ABI
128 /// message lookup function and some GC-related functions.
Chris Lattner2192fe52011-07-18 04:24:23 +0000129 llvm::PointerType *PtrToIdTy;
David Chisnall34d00052011-03-26 11:48:37 +0000130 /// The clang type of id. Used when using the clang CGCall infrastructure to
131 /// call Objective-C methods.
John McCall2da83a32010-02-26 00:48:12 +0000132 CanQualType ASTIdTy;
David Chisnall34d00052011-03-26 11:48:37 +0000133 /// LLVM type for C int type.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000134 llvm::IntegerType *IntTy;
David Chisnall34d00052011-03-26 11:48:37 +0000135 /// LLVM type for an opaque pointer. This is identical to PtrToInt8Ty, but is
136 /// used in the code to document the difference between i8* meaning a pointer
137 /// to a C string and i8* meaning a pointer to some opaque type.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000138 llvm::PointerType *PtrTy;
David Chisnall34d00052011-03-26 11:48:37 +0000139 /// LLVM type for C long type. The runtime uses this in a lot of places where
140 /// it should be using intptr_t, but we can't fix this without breaking
141 /// compatibility with GCC...
Jay Foad7c57be32011-07-11 09:56:20 +0000142 llvm::IntegerType *LongTy;
David Chisnall34d00052011-03-26 11:48:37 +0000143 /// LLVM type for C size_t. Used in various runtime data structures.
Chris Lattner2192fe52011-07-18 04:24:23 +0000144 llvm::IntegerType *SizeTy;
David Chisnalle0dc7cb2011-10-08 08:54:36 +0000145 /// LLVM type for C intptr_t.
146 llvm::IntegerType *IntPtrTy;
David Chisnall34d00052011-03-26 11:48:37 +0000147 /// LLVM type for C ptrdiff_t. Mainly used in property accessor functions.
Chris Lattner2192fe52011-07-18 04:24:23 +0000148 llvm::IntegerType *PtrDiffTy;
David Chisnall34d00052011-03-26 11:48:37 +0000149 /// LLVM type for C int*. Used for GCC-ABI-compatible non-fragile instance
150 /// variables.
Chris Lattner2192fe52011-07-18 04:24:23 +0000151 llvm::PointerType *PtrToIntTy;
David Chisnall34d00052011-03-26 11:48:37 +0000152 /// LLVM type for Objective-C BOOL type.
Chris Lattner2192fe52011-07-18 04:24:23 +0000153 llvm::Type *BoolTy;
David Chisnallcdd207e2011-10-04 15:35:30 +0000154 /// 32-bit integer type, to save us needing to look it up every time it's used.
155 llvm::IntegerType *Int32Ty;
156 /// 64-bit integer type, to save us needing to look it up every time it's used.
157 llvm::IntegerType *Int64Ty;
David Chisnall34d00052011-03-26 11:48:37 +0000158 /// Metadata kind used to tie method lookups to message sends. The GNUstep
159 /// runtime provides some LLVM passes that can use this to do things like
160 /// automatic IMP caching and speculative inlining.
David Chisnall76803412011-03-23 22:52:06 +0000161 unsigned msgSendMDKind;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000162
David Chisnall34d00052011-03-26 11:48:37 +0000163 /// Helper function that generates a constant string and returns a pointer to
164 /// the start of the string. The result of this function can be used anywhere
165 /// where the C code specifies const char*.
John McCallecee86f2016-11-30 20:19:46 +0000166 llvm::Constant *MakeConstantString(StringRef Str, const char *Name = "") {
167 ConstantAddress Array = CGM.GetAddrOfConstantCString(Str, Name);
John McCall7f416cc2015-09-08 08:05:57 +0000168 return llvm::ConstantExpr::getGetElementPtr(Array.getElementType(),
169 Array.getPointer(), Zeros);
David Chisnalld3858d62011-03-25 11:57:33 +0000170 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000171
David Chisnall34d00052011-03-26 11:48:37 +0000172 /// Emits a linkonce_odr string, whose name is the prefix followed by the
173 /// string value. This allows the linker to combine the strings between
174 /// different modules. Used for EH typeinfo names, selector strings, and a
175 /// few other things.
Benjamin Kramer81cb4b72016-11-24 16:01:20 +0000176 llvm::Constant *ExportUniqueString(const std::string &Str, StringRef Prefix) {
177 std::string Name = Prefix.str() + Str;
178 auto *ConstStr = TheModule.getGlobalVariable(Name);
David Chisnalld3858d62011-03-25 11:57:33 +0000179 if (!ConstStr) {
Chris Lattner9c818332012-02-05 02:30:40 +0000180 llvm::Constant *value = llvm::ConstantDataArray::getString(VMContext,Str);
David Chisnalld3858d62011-03-25 11:57:33 +0000181 ConstStr = new llvm::GlobalVariable(TheModule, value->getType(), true,
Benjamin Kramer81cb4b72016-11-24 16:01:20 +0000182 llvm::GlobalValue::LinkOnceODRLinkage,
183 value, Name);
David Chisnalld3858d62011-03-25 11:57:33 +0000184 }
David Blaikiee3b172a2015-04-02 18:55:21 +0000185 return llvm::ConstantExpr::getGetElementPtr(ConstStr->getValueType(),
186 ConstStr, Zeros);
David Chisnalld3858d62011-03-25 11:57:33 +0000187 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000188
David Chisnall34d00052011-03-26 11:48:37 +0000189 /// Generates a global structure, initialized by the elements in the vector.
190 /// The element types must match the types of the structure elements in the
191 /// first argument.
John McCall6c9f1fdb2016-11-19 08:17:24 +0000192 llvm::GlobalVariable *MakeGlobal(llvm::Constant *C,
John McCall7f416cc2015-09-08 08:05:57 +0000193 CharUnits Align,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000194 StringRef Name="",
David Chisnalld3858d62011-03-25 11:57:33 +0000195 llvm::GlobalValue::LinkageTypes linkage
196 =llvm::GlobalValue::InternalLinkage) {
John McCall6c9f1fdb2016-11-19 08:17:24 +0000197 auto GV = new llvm::GlobalVariable(TheModule, C->getType(), false,
John McCall7f416cc2015-09-08 08:05:57 +0000198 linkage, C, Name);
199 GV->setAlignment(Align.getQuantity());
200 return GV;
David Chisnalld3858d62011-03-25 11:57:33 +0000201 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000202
David Chisnalla5f59412012-10-16 15:11:55 +0000203 /// Returns a property name and encoding string.
204 llvm::Constant *MakePropertyEncodingString(const ObjCPropertyDecl *PD,
205 const Decl *Container) {
David Chisnallbeb80132013-02-28 13:59:29 +0000206 const ObjCRuntime &R = CGM.getLangOpts().ObjCRuntime;
David Chisnalla5f59412012-10-16 15:11:55 +0000207 if ((R.getKind() == ObjCRuntime::GNUstep) &&
208 (R.getVersion() >= VersionTuple(1, 6))) {
209 std::string NameAndAttributes;
John McCall843dfcc2016-11-29 21:57:00 +0000210 std::string TypeStr =
211 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container);
David Chisnalla5f59412012-10-16 15:11:55 +0000212 NameAndAttributes += '\0';
213 NameAndAttributes += TypeStr.length() + 3;
214 NameAndAttributes += TypeStr;
215 NameAndAttributes += '\0';
216 NameAndAttributes += PD->getNameAsString();
John McCall7f416cc2015-09-08 08:05:57 +0000217 return MakeConstantString(NameAndAttributes);
David Chisnalla5f59412012-10-16 15:11:55 +0000218 }
219 return MakeConstantString(PD->getNameAsString());
220 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000221
David Chisnallbeb80132013-02-28 13:59:29 +0000222 /// Push the property attributes into two structure fields.
John McCall23c9dc62016-11-28 22:18:27 +0000223 void PushPropertyAttributes(ConstantStructBuilder &Fields,
David Chisnallbeb80132013-02-28 13:59:29 +0000224 ObjCPropertyDecl *property, bool isSynthesized=true, bool
225 isDynamic=true) {
226 int attrs = property->getPropertyAttributes();
227 // For read-only properties, clear the copy and retain flags
228 if (attrs & ObjCPropertyDecl::OBJC_PR_readonly) {
229 attrs &= ~ObjCPropertyDecl::OBJC_PR_copy;
230 attrs &= ~ObjCPropertyDecl::OBJC_PR_retain;
231 attrs &= ~ObjCPropertyDecl::OBJC_PR_weak;
232 attrs &= ~ObjCPropertyDecl::OBJC_PR_strong;
233 }
234 // The first flags field has the same attribute values as clang uses internally
John McCall6c9f1fdb2016-11-19 08:17:24 +0000235 Fields.addInt(Int8Ty, attrs & 0xff);
David Chisnallbeb80132013-02-28 13:59:29 +0000236 attrs >>= 8;
237 attrs <<= 2;
238 // For protocol properties, synthesized and dynamic have no meaning, so we
239 // reuse these flags to indicate that this is a protocol property (both set
240 // has no meaning, as a property can't be both synthesized and dynamic)
241 attrs |= isSynthesized ? (1<<0) : 0;
242 attrs |= isDynamic ? (1<<1) : 0;
243 // The second field is the next four fields left shifted by two, with the
244 // low bit set to indicate whether the field is synthesized or dynamic.
John McCall6c9f1fdb2016-11-19 08:17:24 +0000245 Fields.addInt(Int8Ty, attrs & 0xff);
David Chisnallbeb80132013-02-28 13:59:29 +0000246 // Two padding fields
John McCall6c9f1fdb2016-11-19 08:17:24 +0000247 Fields.addInt(Int8Ty, 0);
248 Fields.addInt(Int8Ty, 0);
David Chisnallbeb80132013-02-28 13:59:29 +0000249 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000250
David Chisnall34d00052011-03-26 11:48:37 +0000251 /// Ensures that the value has the required type, by inserting a bitcast if
252 /// required. This function lets us avoid inserting bitcasts that are
253 /// redundant.
John McCall882987f2013-02-28 19:01:20 +0000254 llvm::Value* EnforceType(CGBuilderTy &B, llvm::Value *V, llvm::Type *Ty) {
David Chisnall76803412011-03-23 22:52:06 +0000255 if (V->getType() == Ty) return V;
256 return B.CreateBitCast(V, Ty);
257 }
John McCall7f416cc2015-09-08 08:05:57 +0000258 Address EnforceType(CGBuilderTy &B, Address V, llvm::Type *Ty) {
259 if (V.getType() == Ty) return V;
260 return B.CreateBitCast(V, Ty);
261 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000262
David Chisnall76803412011-03-23 22:52:06 +0000263 // Some zeros used for GEPs in lots of places.
264 llvm::Constant *Zeros[2];
David Chisnall34d00052011-03-26 11:48:37 +0000265 /// Null pointer value. Mainly used as a terminator in various arrays.
David Chisnall76803412011-03-23 22:52:06 +0000266 llvm::Constant *NULLPtr;
David Chisnall34d00052011-03-26 11:48:37 +0000267 /// LLVM context.
David Chisnall76803412011-03-23 22:52:06 +0000268 llvm::LLVMContext &VMContext;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000269
David Chisnall76803412011-03-23 22:52:06 +0000270private:
David Chisnall34d00052011-03-26 11:48:37 +0000271 /// Placeholder for the class. Lots of things refer to the class before we've
272 /// actually emitted it. We use this alias as a placeholder, and then replace
273 /// it with a pointer to the class structure before finally emitting the
274 /// module.
Daniel Dunbar566421c2009-05-04 15:31:17 +0000275 llvm::GlobalAlias *ClassPtrAlias;
David Chisnall34d00052011-03-26 11:48:37 +0000276 /// Placeholder for the metaclass. Lots of things refer to the class before
277 /// we've / actually emitted it. We use this alias as a placeholder, and then
278 /// replace / it with a pointer to the metaclass structure before finally
279 /// emitting the / module.
Daniel Dunbar566421c2009-05-04 15:31:17 +0000280 llvm::GlobalAlias *MetaClassPtrAlias;
David Chisnall34d00052011-03-26 11:48:37 +0000281 /// All of the classes that have been generated for this compilation units.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000282 std::vector<llvm::Constant*> Classes;
David Chisnall34d00052011-03-26 11:48:37 +0000283 /// All of the categories that have been generated for this compilation units.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000284 std::vector<llvm::Constant*> Categories;
David Chisnall34d00052011-03-26 11:48:37 +0000285 /// All of the Objective-C constant strings that have been generated for this
286 /// compilation units.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000287 std::vector<llvm::Constant*> ConstantStrings;
David Chisnall34d00052011-03-26 11:48:37 +0000288 /// Map from string values to Objective-C constant strings in the output.
289 /// Used to prevent emitting Objective-C strings more than once. This should
290 /// not be required at all - CodeGenModule should manage this list.
David Chisnall358e7512010-01-27 12:49:23 +0000291 llvm::StringMap<llvm::Constant*> ObjCStrings;
David Chisnall34d00052011-03-26 11:48:37 +0000292 /// All of the protocols that have been declared.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000293 llvm::StringMap<llvm::Constant*> ExistingProtocols;
David Chisnall34d00052011-03-26 11:48:37 +0000294 /// For each variant of a selector, we store the type encoding and a
295 /// placeholder value. For an untyped selector, the type will be the empty
296 /// string. Selector references are all done via the module's selector table,
297 /// so we create an alias as a placeholder and then replace it with the real
298 /// value later.
David Chisnalld7972f52011-03-23 16:36:54 +0000299 typedef std::pair<std::string, llvm::GlobalAlias*> TypedSelector;
David Chisnall34d00052011-03-26 11:48:37 +0000300 /// Type of the selector map. This is roughly equivalent to the structure
301 /// used in the GNUstep runtime, which maintains a list of all of the valid
302 /// types for a selector in a table.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000303 typedef llvm::DenseMap<Selector, SmallVector<TypedSelector, 2> >
David Chisnalld7972f52011-03-23 16:36:54 +0000304 SelectorMap;
David Chisnall34d00052011-03-26 11:48:37 +0000305 /// A map from selectors to selector types. This allows us to emit all
306 /// selectors of the same name and type together.
David Chisnalld7972f52011-03-23 16:36:54 +0000307 SelectorMap SelectorTable;
308
David Chisnall34d00052011-03-26 11:48:37 +0000309 /// Selectors related to memory management. When compiling in GC mode, we
310 /// omit these.
David Chisnall5bb4efd2010-02-03 15:59:02 +0000311 Selector RetainSel, ReleaseSel, AutoreleaseSel;
David Chisnall34d00052011-03-26 11:48:37 +0000312 /// Runtime functions used for memory management in GC mode. Note that clang
313 /// supports code generation for calling these functions, but neither GNU
314 /// runtime actually supports this API properly yet.
David Chisnalld7972f52011-03-23 16:36:54 +0000315 LazyRuntimeFunction IvarAssignFn, StrongCastAssignFn, MemMoveFn, WeakReadFn,
316 WeakAssignFn, GlobalAssignFn;
David Chisnalld7972f52011-03-23 16:36:54 +0000317
David Chisnall92d436b2012-01-31 18:59:20 +0000318 typedef std::pair<std::string, std::string> ClassAliasPair;
319 /// All classes that have aliases set for them.
320 std::vector<ClassAliasPair> ClassAliases;
321
David Chisnalld3858d62011-03-25 11:57:33 +0000322protected:
David Chisnall34d00052011-03-26 11:48:37 +0000323 /// Function used for throwing Objective-C exceptions.
David Chisnalld7972f52011-03-23 16:36:54 +0000324 LazyRuntimeFunction ExceptionThrowFn;
James Dennettb9199ee2012-06-13 22:07:09 +0000325 /// Function used for rethrowing exceptions, used at the end of \@finally or
326 /// \@synchronize blocks.
David Chisnalld3858d62011-03-25 11:57:33 +0000327 LazyRuntimeFunction ExceptionReThrowFn;
David Chisnall34d00052011-03-26 11:48:37 +0000328 /// Function called when entering a catch function. This is required for
329 /// differentiating Objective-C exceptions and foreign exceptions.
David Chisnalld3858d62011-03-25 11:57:33 +0000330 LazyRuntimeFunction EnterCatchFn;
David Chisnall34d00052011-03-26 11:48:37 +0000331 /// Function called when exiting from a catch block. Used to do exception
332 /// cleanup.
David Chisnalld3858d62011-03-25 11:57:33 +0000333 LazyRuntimeFunction ExitCatchFn;
James Dennettb9199ee2012-06-13 22:07:09 +0000334 /// Function called when entering an \@synchronize block. Acquires the lock.
David Chisnalld7972f52011-03-23 16:36:54 +0000335 LazyRuntimeFunction SyncEnterFn;
James Dennettb9199ee2012-06-13 22:07:09 +0000336 /// Function called when exiting an \@synchronize block. Releases the lock.
David Chisnalld7972f52011-03-23 16:36:54 +0000337 LazyRuntimeFunction SyncExitFn;
338
David Chisnalld3858d62011-03-25 11:57:33 +0000339private:
David Chisnall34d00052011-03-26 11:48:37 +0000340 /// Function called if fast enumeration detects that the collection is
341 /// modified during the update.
David Chisnalld7972f52011-03-23 16:36:54 +0000342 LazyRuntimeFunction EnumerationMutationFn;
David Chisnall34d00052011-03-26 11:48:37 +0000343 /// Function for implementing synthesized property getters that return an
344 /// object.
David Chisnalld7972f52011-03-23 16:36:54 +0000345 LazyRuntimeFunction GetPropertyFn;
David Chisnall34d00052011-03-26 11:48:37 +0000346 /// Function for implementing synthesized property setters that return an
347 /// object.
David Chisnalld7972f52011-03-23 16:36:54 +0000348 LazyRuntimeFunction SetPropertyFn;
David Chisnall34d00052011-03-26 11:48:37 +0000349 /// Function used for non-object declared property getters.
David Chisnalld7972f52011-03-23 16:36:54 +0000350 LazyRuntimeFunction GetStructPropertyFn;
David Chisnall34d00052011-03-26 11:48:37 +0000351 /// Function used for non-object declared property setters.
David Chisnalld7972f52011-03-23 16:36:54 +0000352 LazyRuntimeFunction SetStructPropertyFn;
353
David Chisnall34d00052011-03-26 11:48:37 +0000354 /// The version of the runtime that this class targets. Must match the
355 /// version in the runtime.
David Chisnall5c511772011-05-22 22:37:08 +0000356 int RuntimeVersion;
David Chisnall34d00052011-03-26 11:48:37 +0000357 /// The version of the protocol class. Used to differentiate between ObjC1
358 /// and ObjC2 protocols. Objective-C 1 protocols can not contain optional
359 /// components and can not contain declared properties. We always emit
360 /// Objective-C 2 property structures, but we have to pretend that they're
361 /// Objective-C 1 property structures when targeting the GCC runtime or it
362 /// will abort.
David Chisnalld7972f52011-03-23 16:36:54 +0000363 const int ProtocolVersion;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000364
David Chisnall34d00052011-03-26 11:48:37 +0000365 /// Generates an instance variable list structure. This is a structure
366 /// containing a size and an array of structures containing instance variable
367 /// metadata. This is used purely for introspection in the fragile ABI. In
368 /// the non-fragile ABI, it's used for instance variable fixup.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000369 llvm::Constant *GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
370 ArrayRef<llvm::Constant *> IvarTypes,
371 ArrayRef<llvm::Constant *> IvarOffsets);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000372
David Chisnall34d00052011-03-26 11:48:37 +0000373 /// Generates a method list structure. This is a structure containing a size
374 /// and an array of structures containing method metadata.
375 ///
376 /// This structure is used by both classes and categories, and contains a next
377 /// pointer allowing them to be chained together in a linked list.
Craig Topperbf3e3272014-08-30 16:55:52 +0000378 llvm::Constant *GenerateMethodList(StringRef ClassName,
379 StringRef CategoryName,
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000380 ArrayRef<Selector> MethodSels,
381 ArrayRef<llvm::Constant *> MethodTypes,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000382 bool isClassMethodList);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000383
James Dennettb9199ee2012-06-13 22:07:09 +0000384 /// Emits an empty protocol. This is used for \@protocol() where no protocol
David Chisnall34d00052011-03-26 11:48:37 +0000385 /// is found. The runtime will (hopefully) fix up the pointer to refer to the
386 /// real protocol.
Fariborz Jahanian89d23972009-03-31 18:27:22 +0000387 llvm::Constant *GenerateEmptyProtocol(const std::string &ProtocolName);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000388
David Chisnall34d00052011-03-26 11:48:37 +0000389 /// Generates a list of property metadata structures. This follows the same
390 /// pattern as method and instance variable metadata lists.
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000391 llvm::Constant *GeneratePropertyList(const ObjCImplementationDecl *OID,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000392 SmallVectorImpl<Selector> &InstanceMethodSels,
393 SmallVectorImpl<llvm::Constant*> &InstanceMethodTypes);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000394
David Chisnall34d00052011-03-26 11:48:37 +0000395 /// Generates a list of referenced protocols. Classes, categories, and
396 /// protocols all use this structure.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000397 llvm::Constant *GenerateProtocolList(ArrayRef<std::string> Protocols);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000398
David Chisnall34d00052011-03-26 11:48:37 +0000399 /// To ensure that all protocols are seen by the runtime, we add a category on
400 /// a class defined in the runtime, declaring no methods, but adopting the
401 /// protocols. This is a horribly ugly hack, but it allows us to collect all
402 /// of the protocols without changing the ABI.
Dmitri Gribenkob2aa9232012-11-15 14:28:07 +0000403 void GenerateProtocolHolderCategory();
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000404
David Chisnall34d00052011-03-26 11:48:37 +0000405 /// Generates a class structure.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000406 llvm::Constant *GenerateClassStructure(
407 llvm::Constant *MetaClass,
408 llvm::Constant *SuperClass,
409 unsigned info,
Chris Lattnerda35bc82008-06-26 04:47:04 +0000410 const char *Name,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000411 llvm::Constant *Version,
412 llvm::Constant *InstanceSize,
413 llvm::Constant *IVars,
414 llvm::Constant *Methods,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000415 llvm::Constant *Protocols,
416 llvm::Constant *IvarOffsets,
David Chisnalld472c852010-04-28 14:29:56 +0000417 llvm::Constant *Properties,
David Chisnallcdd207e2011-10-04 15:35:30 +0000418 llvm::Constant *StrongIvarBitmap,
419 llvm::Constant *WeakIvarBitmap,
David Chisnalld472c852010-04-28 14:29:56 +0000420 bool isMeta=false);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000421
David Chisnall34d00052011-03-26 11:48:37 +0000422 /// Generates a method list. This is used by protocols to define the required
423 /// and optional methods.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000424 llvm::Constant *GenerateProtocolMethodList(
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000425 ArrayRef<llvm::Constant *> MethodNames,
426 ArrayRef<llvm::Constant *> MethodTypes);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000427
David Chisnall34d00052011-03-26 11:48:37 +0000428 /// Returns a selector with the specified type encoding. An empty string is
429 /// used to return an untyped selector (with the types field set to NULL).
John McCall882987f2013-02-28 19:01:20 +0000430 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel,
John McCall7f416cc2015-09-08 08:05:57 +0000431 const std::string &TypeEncoding);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000432
David Chisnall34d00052011-03-26 11:48:37 +0000433 /// Returns the variable used to store the offset of an instance variable.
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +0000434 llvm::GlobalVariable *ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
435 const ObjCIvarDecl *Ivar);
David Chisnall34d00052011-03-26 11:48:37 +0000436 /// Emits a reference to a class. This allows the linker to object if there
437 /// is no class of the matching name.
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000438
John McCall775086e2012-07-12 02:07:58 +0000439protected:
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000440 void EmitClassRef(const std::string &className);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000441
David Chisnall920e83b2011-06-29 13:16:41 +0000442 /// Emits a pointer to the named class
John McCall882987f2013-02-28 19:01:20 +0000443 virtual llvm::Value *GetClassNamed(CodeGenFunction &CGF,
John McCall775086e2012-07-12 02:07:58 +0000444 const std::string &Name, bool isWeak);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000445
David Chisnall34d00052011-03-26 11:48:37 +0000446 /// Looks up the method for sending a message to the specified object. This
447 /// mechanism differs between the GCC and GNU runtimes, so this method must be
448 /// overridden in subclasses.
David Chisnall76803412011-03-23 22:52:06 +0000449 virtual llvm::Value *LookupIMP(CodeGenFunction &CGF,
450 llvm::Value *&Receiver,
451 llvm::Value *cmd,
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000452 llvm::MDNode *node,
453 MessageSendInfo &MSI) = 0;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000454
David Chisnallcdd207e2011-10-04 15:35:30 +0000455 /// Looks up the method for sending a message to a superclass. This
456 /// mechanism differs between the GCC and GNU runtimes, so this method must
457 /// be overridden in subclasses.
David Chisnall76803412011-03-23 22:52:06 +0000458 virtual llvm::Value *LookupIMPSuper(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000459 Address ObjCSuper,
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000460 llvm::Value *cmd,
461 MessageSendInfo &MSI) = 0;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000462
David Chisnallcdd207e2011-10-04 15:35:30 +0000463 /// Libobjc2 uses a bitfield representation where small(ish) bitfields are
464 /// stored in a 64-bit value with the low bit set to 1 and the remaining 63
465 /// bits set to their values, LSB first, while larger ones are stored in a
466 /// structure of this / form:
467 ///
468 /// struct { int32_t length; int32_t values[length]; };
469 ///
470 /// The values in the array are stored in host-endian format, with the least
471 /// significant bit being assumed to come first in the bitfield. Therefore,
472 /// a bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] },
473 /// while a bitfield / with the 63rd bit set will be 1<<64.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000474 llvm::Constant *MakeBitField(ArrayRef<bool> bits);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000475
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000476public:
David Chisnalld7972f52011-03-23 16:36:54 +0000477 CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion,
478 unsigned protocolClassVersion);
479
John McCall7f416cc2015-09-08 08:05:57 +0000480 ConstantAddress GenerateConstantString(const StringLiteral *) override;
David Chisnalld7972f52011-03-23 16:36:54 +0000481
Craig Topper4f12f102014-03-12 06:41:41 +0000482 RValue
483 GenerateMessageSend(CodeGenFunction &CGF, ReturnValueSlot Return,
484 QualType ResultType, Selector Sel,
485 llvm::Value *Receiver, const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +0000486 const ObjCInterfaceDecl *Class,
Craig Topper4f12f102014-03-12 06:41:41 +0000487 const ObjCMethodDecl *Method) override;
488 RValue
489 GenerateMessageSendSuper(CodeGenFunction &CGF, ReturnValueSlot Return,
490 QualType ResultType, Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000491 const ObjCInterfaceDecl *Class,
Craig Topper4f12f102014-03-12 06:41:41 +0000492 bool isCategoryImpl, llvm::Value *Receiver,
493 bool IsClassMessage, const CallArgList &CallArgs,
494 const ObjCMethodDecl *Method) override;
495 llvm::Value *GetClass(CodeGenFunction &CGF,
496 const ObjCInterfaceDecl *OID) override;
John McCall7f416cc2015-09-08 08:05:57 +0000497 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
498 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000499 llvm::Value *GetSelector(CodeGenFunction &CGF,
500 const ObjCMethodDecl *Method) override;
501 llvm::Constant *GetEHType(QualType T) override;
Mike Stump11289f42009-09-09 15:08:12 +0000502
Craig Topper4f12f102014-03-12 06:41:41 +0000503 llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
504 const ObjCContainerDecl *CD) override;
505 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
506 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
507 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override;
508 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
509 const ObjCProtocolDecl *PD) override;
510 void GenerateProtocol(const ObjCProtocolDecl *PD) override;
511 llvm::Function *ModuleInitFunction() override;
512 llvm::Constant *GetPropertyGetFunction() override;
513 llvm::Constant *GetPropertySetFunction() override;
514 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
515 bool copy) override;
516 llvm::Constant *GetSetStructFunction() override;
517 llvm::Constant *GetGetStructFunction() override;
518 llvm::Constant *GetCppAtomicObjectGetFunction() override;
519 llvm::Constant *GetCppAtomicObjectSetFunction() override;
520 llvm::Constant *EnumerationMutationFunction() override;
Mike Stump11289f42009-09-09 15:08:12 +0000521
Craig Topper4f12f102014-03-12 06:41:41 +0000522 void EmitTryStmt(CodeGenFunction &CGF,
523 const ObjCAtTryStmt &S) override;
524 void EmitSynchronizedStmt(CodeGenFunction &CGF,
525 const ObjCAtSynchronizedStmt &S) override;
526 void EmitThrowStmt(CodeGenFunction &CGF,
527 const ObjCAtThrowStmt &S,
528 bool ClearInsertionPoint=true) override;
529 llvm::Value * EmitObjCWeakRead(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000530 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000531 void EmitObjCWeakAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000532 llvm::Value *src, Address dst) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000533 void EmitObjCGlobalAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000534 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +0000535 bool threadlocal=false) override;
536 void EmitObjCIvarAssign(CodeGenFunction &CGF, llvm::Value *src,
John McCall7f416cc2015-09-08 08:05:57 +0000537 Address dest, llvm::Value *ivarOffset) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000538 void EmitObjCStrongCastAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000539 llvm::Value *src, Address dest) override;
540 void EmitGCMemmoveCollectable(CodeGenFunction &CGF, Address DestPtr,
541 Address SrcPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000542 llvm::Value *Size) override;
543 LValue EmitObjCValueForIvar(CodeGenFunction &CGF, QualType ObjectTy,
544 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
545 unsigned CVRQualifiers) override;
546 llvm::Value *EmitIvarOffset(CodeGenFunction &CGF,
547 const ObjCInterfaceDecl *Interface,
548 const ObjCIvarDecl *Ivar) override;
549 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
550 llvm::Constant *BuildGCBlockLayout(CodeGenModule &CGM,
551 const CGBlockInfo &blockInfo) override {
Fariborz Jahanianc05349e2010-08-04 16:57:49 +0000552 return NULLPtr;
553 }
Craig Topper4f12f102014-03-12 06:41:41 +0000554 llvm::Constant *BuildRCBlockLayout(CodeGenModule &CGM,
555 const CGBlockInfo &blockInfo) override {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +0000556 return NULLPtr;
557 }
Craig Topper4f12f102014-03-12 06:41:41 +0000558
559 llvm::Constant *BuildByrefLayout(CodeGenModule &CGM, QualType T) override {
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000560 return NULLPtr;
561 }
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000562};
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000563
David Chisnall34d00052011-03-26 11:48:37 +0000564/// Class representing the legacy GCC Objective-C ABI. This is the default when
565/// -fobjc-nonfragile-abi is not specified.
566///
567/// The GCC ABI target actually generates code that is approximately compatible
568/// with the new GNUstep runtime ABI, but refrains from using any features that
569/// would not work with the GCC runtime. For example, clang always generates
570/// the extended form of the class structure, and the extra fields are simply
571/// ignored by GCC libobjc.
David Chisnalld7972f52011-03-23 16:36:54 +0000572class CGObjCGCC : public CGObjCGNU {
David Chisnall34d00052011-03-26 11:48:37 +0000573 /// The GCC ABI message lookup function. Returns an IMP pointing to the
574 /// method implementation for this message.
David Chisnall76803412011-03-23 22:52:06 +0000575 LazyRuntimeFunction MsgLookupFn;
David Chisnall34d00052011-03-26 11:48:37 +0000576 /// The GCC ABI superclass message lookup function. Takes a pointer to a
577 /// structure describing the receiver and the class, and a selector as
578 /// arguments. Returns the IMP for the corresponding method.
David Chisnall76803412011-03-23 22:52:06 +0000579 LazyRuntimeFunction MsgLookupSuperFn;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000580
David Chisnall76803412011-03-23 22:52:06 +0000581protected:
Craig Topper4f12f102014-03-12 06:41:41 +0000582 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
583 llvm::Value *cmd, llvm::MDNode *node,
584 MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000585 CGBuilderTy &Builder = CGF.Builder;
David Chisnall0cc83e72011-10-28 17:55:06 +0000586 llvm::Value *args[] = {
David Chisnall76803412011-03-23 22:52:06 +0000587 EnforceType(Builder, Receiver, IdTy),
David Chisnall0cc83e72011-10-28 17:55:06 +0000588 EnforceType(Builder, cmd, SelectorTy) };
John McCall882987f2013-02-28 19:01:20 +0000589 llvm::CallSite imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFn, args);
David Chisnall0cc83e72011-10-28 17:55:06 +0000590 imp->setMetadata(msgSendMDKind, node);
591 return imp.getInstruction();
David Chisnall76803412011-03-23 22:52:06 +0000592 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000593
John McCall7f416cc2015-09-08 08:05:57 +0000594 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
Craig Topper4f12f102014-03-12 06:41:41 +0000595 llvm::Value *cmd, MessageSendInfo &MSI) override {
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000596 CGBuilderTy &Builder = CGF.Builder;
597 llvm::Value *lookupArgs[] = {EnforceType(Builder, ObjCSuper,
598 PtrToObjCSuperTy).getPointer(), cmd};
599 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
600 }
601
602public:
603 CGObjCGCC(CodeGenModule &Mod) : CGObjCGNU(Mod, 8, 2) {
604 // IMP objc_msg_lookup(id, SEL);
Serge Guelton1d993272017-05-09 19:31:30 +0000605 MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000606 // IMP objc_msg_lookup_super(struct objc_super*, SEL);
607 MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000608 PtrToObjCSuperTy, SelectorTy);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000609 }
David Chisnalld7972f52011-03-23 16:36:54 +0000610};
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000611
David Chisnall34d00052011-03-26 11:48:37 +0000612/// Class used when targeting the new GNUstep runtime ABI.
David Chisnalld7972f52011-03-23 16:36:54 +0000613class CGObjCGNUstep : public CGObjCGNU {
David Chisnall34d00052011-03-26 11:48:37 +0000614 /// The slot lookup function. Returns a pointer to a cacheable structure
615 /// that contains (among other things) the IMP.
David Chisnall76803412011-03-23 22:52:06 +0000616 LazyRuntimeFunction SlotLookupFn;
David Chisnall34d00052011-03-26 11:48:37 +0000617 /// The GNUstep ABI superclass message lookup function. Takes a pointer to
618 /// a structure describing the receiver and the class, and a selector as
619 /// arguments. Returns the slot for the corresponding method. Superclass
620 /// message lookup rarely changes, so this is a good caching opportunity.
David Chisnall76803412011-03-23 22:52:06 +0000621 LazyRuntimeFunction SlotLookupSuperFn;
David Chisnall0d75e062012-12-17 18:54:24 +0000622 /// Specialised function for setting atomic retain properties
623 LazyRuntimeFunction SetPropertyAtomic;
624 /// Specialised function for setting atomic copy properties
625 LazyRuntimeFunction SetPropertyAtomicCopy;
626 /// Specialised function for setting nonatomic retain properties
627 LazyRuntimeFunction SetPropertyNonAtomic;
628 /// Specialised function for setting nonatomic copy properties
629 LazyRuntimeFunction SetPropertyNonAtomicCopy;
630 /// Function to perform atomic copies of C++ objects with nontrivial copy
631 /// constructors from Objective-C ivars.
632 LazyRuntimeFunction CxxAtomicObjectGetFn;
633 /// Function to perform atomic copies of C++ objects with nontrivial copy
634 /// constructors to Objective-C ivars.
635 LazyRuntimeFunction CxxAtomicObjectSetFn;
David Chisnall34d00052011-03-26 11:48:37 +0000636 /// Type of an slot structure pointer. This is returned by the various
637 /// lookup functions.
David Chisnall76803412011-03-23 22:52:06 +0000638 llvm::Type *SlotTy;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000639
John McCallc31d8932012-11-14 09:08:34 +0000640 public:
Craig Topper4f12f102014-03-12 06:41:41 +0000641 llvm::Constant *GetEHType(QualType T) override;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000642
David Chisnall76803412011-03-23 22:52:06 +0000643 protected:
Craig Topper4f12f102014-03-12 06:41:41 +0000644 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
645 llvm::Value *cmd, llvm::MDNode *node,
646 MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000647 CGBuilderTy &Builder = CGF.Builder;
648 llvm::Function *LookupFn = SlotLookupFn;
649
650 // Store the receiver on the stack so that we can reload it later
John McCall7f416cc2015-09-08 08:05:57 +0000651 Address ReceiverPtr =
652 CGF.CreateTempAlloca(Receiver->getType(), CGF.getPointerAlign());
David Chisnall76803412011-03-23 22:52:06 +0000653 Builder.CreateStore(Receiver, ReceiverPtr);
654
655 llvm::Value *self;
656
657 if (isa<ObjCMethodDecl>(CGF.CurCodeDecl)) {
658 self = CGF.LoadObjCSelf();
659 } else {
660 self = llvm::ConstantPointerNull::get(IdTy);
661 }
662
663 // The lookup function is guaranteed not to capture the receiver pointer.
Reid Klecknera0b45f42017-05-03 18:17:31 +0000664 LookupFn->addParamAttr(0, llvm::Attribute::NoCapture);
David Chisnall76803412011-03-23 22:52:06 +0000665
David Chisnall0cc83e72011-10-28 17:55:06 +0000666 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +0000667 EnforceType(Builder, ReceiverPtr.getPointer(), PtrToIdTy),
David Chisnall76803412011-03-23 22:52:06 +0000668 EnforceType(Builder, cmd, SelectorTy),
David Chisnall0cc83e72011-10-28 17:55:06 +0000669 EnforceType(Builder, self, IdTy) };
John McCall882987f2013-02-28 19:01:20 +0000670 llvm::CallSite slot = CGF.EmitRuntimeCallOrInvoke(LookupFn, args);
David Chisnall0cc83e72011-10-28 17:55:06 +0000671 slot.setOnlyReadsMemory();
David Chisnall76803412011-03-23 22:52:06 +0000672 slot->setMetadata(msgSendMDKind, node);
673
674 // Load the imp from the slot
John McCall7f416cc2015-09-08 08:05:57 +0000675 llvm::Value *imp = Builder.CreateAlignedLoad(
676 Builder.CreateStructGEP(nullptr, slot.getInstruction(), 4),
677 CGF.getPointerAlign());
David Chisnall76803412011-03-23 22:52:06 +0000678
679 // The lookup function may have changed the receiver, so make sure we use
680 // the new one.
681 Receiver = Builder.CreateLoad(ReceiverPtr, true);
682 return imp;
683 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000684
John McCall7f416cc2015-09-08 08:05:57 +0000685 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
Craig Topper4f12f102014-03-12 06:41:41 +0000686 llvm::Value *cmd,
687 MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000688 CGBuilderTy &Builder = CGF.Builder;
John McCall7f416cc2015-09-08 08:05:57 +0000689 llvm::Value *lookupArgs[] = {ObjCSuper.getPointer(), cmd};
David Chisnall76803412011-03-23 22:52:06 +0000690
John McCall882987f2013-02-28 19:01:20 +0000691 llvm::CallInst *slot =
692 CGF.EmitNounwindRuntimeCall(SlotLookupSuperFn, lookupArgs);
David Chisnall76803412011-03-23 22:52:06 +0000693 slot->setOnlyReadsMemory();
694
John McCall7f416cc2015-09-08 08:05:57 +0000695 return Builder.CreateAlignedLoad(Builder.CreateStructGEP(nullptr, slot, 4),
696 CGF.getPointerAlign());
David Chisnall76803412011-03-23 22:52:06 +0000697 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000698
David Chisnalld7972f52011-03-23 16:36:54 +0000699 public:
David Chisnall76803412011-03-23 22:52:06 +0000700 CGObjCGNUstep(CodeGenModule &Mod) : CGObjCGNU(Mod, 9, 3) {
David Chisnallbeb80132013-02-28 13:59:29 +0000701 const ObjCRuntime &R = CGM.getLangOpts().ObjCRuntime;
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000702
Serge Guelton1d993272017-05-09 19:31:30 +0000703 llvm::StructType *SlotStructTy =
704 llvm::StructType::get(PtrTy, PtrTy, PtrTy, IntTy, IMPTy);
David Chisnall76803412011-03-23 22:52:06 +0000705 SlotTy = llvm::PointerType::getUnqual(SlotStructTy);
706 // Slot_t objc_msg_lookup_sender(id *receiver, SEL selector, id sender);
707 SlotLookupFn.init(&CGM, "objc_msg_lookup_sender", SlotTy, PtrToIdTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000708 SelectorTy, IdTy);
David Chisnall76803412011-03-23 22:52:06 +0000709 // Slot_t objc_msg_lookup_super(struct objc_super*, SEL);
710 SlotLookupSuperFn.init(&CGM, "objc_slot_lookup_super", SlotTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000711 PtrToObjCSuperTy, SelectorTy);
David Chisnalld3858d62011-03-25 11:57:33 +0000712 // If we're in ObjC++ mode, then we want to make
David Blaikiebbafb8a2012-03-11 07:00:24 +0000713 if (CGM.getLangOpts().CPlusPlus) {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000714 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
David Chisnalld3858d62011-03-25 11:57:33 +0000715 // void *__cxa_begin_catch(void *e)
Serge Guelton1d993272017-05-09 19:31:30 +0000716 EnterCatchFn.init(&CGM, "__cxa_begin_catch", PtrTy, PtrTy);
David Chisnalld3858d62011-03-25 11:57:33 +0000717 // void __cxa_end_catch(void)
Serge Guelton1d993272017-05-09 19:31:30 +0000718 ExitCatchFn.init(&CGM, "__cxa_end_catch", VoidTy);
David Chisnalld3858d62011-03-25 11:57:33 +0000719 // void _Unwind_Resume_or_Rethrow(void*)
David Chisnall0d75e062012-12-17 18:54:24 +0000720 ExceptionReThrowFn.init(&CGM, "_Unwind_Resume_or_Rethrow", VoidTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000721 PtrTy);
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000722 } else if (R.getVersion() >= VersionTuple(1, 7)) {
723 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
724 // id objc_begin_catch(void *e)
Serge Guelton1d993272017-05-09 19:31:30 +0000725 EnterCatchFn.init(&CGM, "objc_begin_catch", IdTy, PtrTy);
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000726 // void objc_end_catch(void)
Serge Guelton1d993272017-05-09 19:31:30 +0000727 ExitCatchFn.init(&CGM, "objc_end_catch", VoidTy);
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000728 // void _Unwind_Resume_or_Rethrow(void*)
Serge Guelton1d993272017-05-09 19:31:30 +0000729 ExceptionReThrowFn.init(&CGM, "objc_exception_rethrow", VoidTy, PtrTy);
David Chisnalld3858d62011-03-25 11:57:33 +0000730 }
David Chisnall0d75e062012-12-17 18:54:24 +0000731 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
732 SetPropertyAtomic.init(&CGM, "objc_setProperty_atomic", VoidTy, IdTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000733 SelectorTy, IdTy, PtrDiffTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000734 SetPropertyAtomicCopy.init(&CGM, "objc_setProperty_atomic_copy", VoidTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000735 IdTy, SelectorTy, IdTy, PtrDiffTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000736 SetPropertyNonAtomic.init(&CGM, "objc_setProperty_nonatomic", VoidTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000737 IdTy, SelectorTy, IdTy, PtrDiffTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000738 SetPropertyNonAtomicCopy.init(&CGM, "objc_setProperty_nonatomic_copy",
Serge Guelton1d993272017-05-09 19:31:30 +0000739 VoidTy, IdTy, SelectorTy, IdTy, PtrDiffTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000740 // void objc_setCppObjectAtomic(void *dest, const void *src, void
741 // *helper);
742 CxxAtomicObjectSetFn.init(&CGM, "objc_setCppObjectAtomic", VoidTy, PtrTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000743 PtrTy, PtrTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000744 // void objc_getCppObjectAtomic(void *dest, const void *src, void
745 // *helper);
746 CxxAtomicObjectGetFn.init(&CGM, "objc_getCppObjectAtomic", VoidTy, PtrTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000747 PtrTy, PtrTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000748 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000749
Craig Topper4f12f102014-03-12 06:41:41 +0000750 llvm::Constant *GetCppAtomicObjectGetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +0000751 // The optimised functions were added in version 1.7 of the GNUstep
752 // runtime.
753 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
754 VersionTuple(1, 7));
755 return CxxAtomicObjectGetFn;
756 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000757
Craig Topper4f12f102014-03-12 06:41:41 +0000758 llvm::Constant *GetCppAtomicObjectSetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +0000759 // The optimised functions were added in version 1.7 of the GNUstep
760 // runtime.
761 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
762 VersionTuple(1, 7));
763 return CxxAtomicObjectSetFn;
764 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000765
Craig Topper4f12f102014-03-12 06:41:41 +0000766 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
767 bool copy) override {
David Chisnall0d75e062012-12-17 18:54:24 +0000768 // The optimised property functions omit the GC check, and so are not
769 // safe to use in GC mode. The standard functions are fast in GC mode,
770 // so there is less advantage in using them.
771 assert ((CGM.getLangOpts().getGC() == LangOptions::NonGC));
772 // The optimised functions were added in version 1.7 of the GNUstep
773 // runtime.
774 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
775 VersionTuple(1, 7));
776
777 if (atomic) {
778 if (copy) return SetPropertyAtomicCopy;
779 return SetPropertyAtomic;
780 }
David Chisnall0d75e062012-12-17 18:54:24 +0000781
Ted Kremenek090a2732014-03-07 18:53:05 +0000782 return copy ? SetPropertyNonAtomicCopy : SetPropertyNonAtomic;
David Chisnall76803412011-03-23 22:52:06 +0000783 }
David Chisnalld7972f52011-03-23 16:36:54 +0000784};
785
Alp Toker272e9bc2013-11-25 00:40:53 +0000786/// Support for the ObjFW runtime.
John McCall3deb1ad2012-08-21 02:47:43 +0000787class CGObjCObjFW: public CGObjCGNU {
788protected:
789 /// The GCC ABI message lookup function. Returns an IMP pointing to the
790 /// method implementation for this message.
791 LazyRuntimeFunction MsgLookupFn;
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000792 /// stret lookup function. While this does not seem to make sense at the
793 /// first look, this is required to call the correct forwarding function.
794 LazyRuntimeFunction MsgLookupFnSRet;
John McCall3deb1ad2012-08-21 02:47:43 +0000795 /// The GCC ABI superclass message lookup function. Takes a pointer to a
796 /// structure describing the receiver and the class, and a selector as
797 /// arguments. Returns the IMP for the corresponding method.
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000798 LazyRuntimeFunction MsgLookupSuperFn, MsgLookupSuperFnSRet;
John McCall3deb1ad2012-08-21 02:47:43 +0000799
Craig Topper4f12f102014-03-12 06:41:41 +0000800 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
801 llvm::Value *cmd, llvm::MDNode *node,
802 MessageSendInfo &MSI) override {
John McCall3deb1ad2012-08-21 02:47:43 +0000803 CGBuilderTy &Builder = CGF.Builder;
804 llvm::Value *args[] = {
805 EnforceType(Builder, Receiver, IdTy),
806 EnforceType(Builder, cmd, SelectorTy) };
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000807
808 llvm::CallSite imp;
809 if (CGM.ReturnTypeUsesSRet(MSI.CallInfo))
810 imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFnSRet, args);
811 else
812 imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFn, args);
813
John McCall3deb1ad2012-08-21 02:47:43 +0000814 imp->setMetadata(msgSendMDKind, node);
815 return imp.getInstruction();
816 }
817
John McCall7f416cc2015-09-08 08:05:57 +0000818 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
Craig Topper4f12f102014-03-12 06:41:41 +0000819 llvm::Value *cmd, MessageSendInfo &MSI) override {
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +0000820 CGBuilderTy &Builder = CGF.Builder;
821 llvm::Value *lookupArgs[] = {
822 EnforceType(Builder, ObjCSuper.getPointer(), PtrToObjCSuperTy), cmd,
823 };
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000824
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +0000825 if (CGM.ReturnTypeUsesSRet(MSI.CallInfo))
826 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFnSRet, lookupArgs);
827 else
828 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
829 }
John McCall3deb1ad2012-08-21 02:47:43 +0000830
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +0000831 llvm::Value *GetClassNamed(CodeGenFunction &CGF, const std::string &Name,
832 bool isWeak) override {
John McCall775086e2012-07-12 02:07:58 +0000833 if (isWeak)
John McCall882987f2013-02-28 19:01:20 +0000834 return CGObjCGNU::GetClassNamed(CGF, Name, isWeak);
John McCall775086e2012-07-12 02:07:58 +0000835
836 EmitClassRef(Name);
John McCall775086e2012-07-12 02:07:58 +0000837 std::string SymbolName = "_OBJC_CLASS_" + Name;
John McCall775086e2012-07-12 02:07:58 +0000838 llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(SymbolName);
John McCall775086e2012-07-12 02:07:58 +0000839 if (!ClassSymbol)
840 ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false,
841 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +0000842 nullptr, SymbolName);
John McCall775086e2012-07-12 02:07:58 +0000843 return ClassSymbol;
844 }
845
846public:
John McCall3deb1ad2012-08-21 02:47:43 +0000847 CGObjCObjFW(CodeGenModule &Mod): CGObjCGNU(Mod, 9, 3) {
848 // IMP objc_msg_lookup(id, SEL);
Serge Guelton1d993272017-05-09 19:31:30 +0000849 MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy);
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000850 MsgLookupFnSRet.init(&CGM, "objc_msg_lookup_stret", IMPTy, IdTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000851 SelectorTy);
John McCall3deb1ad2012-08-21 02:47:43 +0000852 // IMP objc_msg_lookup_super(struct objc_super*, SEL);
853 MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000854 PtrToObjCSuperTy, SelectorTy);
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000855 MsgLookupSuperFnSRet.init(&CGM, "objc_msg_lookup_super_stret", IMPTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000856 PtrToObjCSuperTy, SelectorTy);
John McCall3deb1ad2012-08-21 02:47:43 +0000857 }
John McCall775086e2012-07-12 02:07:58 +0000858};
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000859} // end anonymous namespace
860
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000861/// Emits a reference to a dummy variable which is emitted with each class.
862/// This ensures that a linker error will be generated when trying to link
863/// together modules where a referenced class is not defined.
Mike Stumpdd93a192009-07-31 21:31:32 +0000864void CGObjCGNU::EmitClassRef(const std::string &className) {
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000865 std::string symbolRef = "__objc_class_ref_" + className;
866 // Don't emit two copies of the same symbol
Mike Stumpdd93a192009-07-31 21:31:32 +0000867 if (TheModule.getGlobalVariable(symbolRef))
868 return;
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000869 std::string symbolName = "__objc_class_name_" + className;
870 llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(symbolName);
871 if (!ClassSymbol) {
Owen Andersonc10c8d32009-07-08 19:05:04 +0000872 ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +0000873 llvm::GlobalValue::ExternalLinkage,
874 nullptr, symbolName);
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000875 }
Owen Andersonc10c8d32009-07-08 19:05:04 +0000876 new llvm::GlobalVariable(TheModule, ClassSymbol->getType(), true,
Chris Lattnerc58e5692009-08-05 05:25:18 +0000877 llvm::GlobalValue::WeakAnyLinkage, ClassSymbol, symbolRef);
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000878}
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000879
Craig Topperbf3e3272014-08-30 16:55:52 +0000880static std::string SymbolNameForMethod( StringRef ClassName,
881 StringRef CategoryName, const Selector MethodName,
David Chisnalld7972f52011-03-23 16:36:54 +0000882 bool isClassMethod) {
883 std::string MethodNameColonStripped = MethodName.getAsString();
David Chisnall035ead22010-01-14 14:08:19 +0000884 std::replace(MethodNameColonStripped.begin(), MethodNameColonStripped.end(),
885 ':', '_');
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000886 return (Twine(isClassMethod ? "_c_" : "_i_") + ClassName + "_" +
David Chisnalld7972f52011-03-23 16:36:54 +0000887 CategoryName + "_" + MethodNameColonStripped).str();
David Chisnall0a24fd32010-05-08 20:58:05 +0000888}
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000889
David Chisnalld7972f52011-03-23 16:36:54 +0000890CGObjCGNU::CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion,
Craig Topper8a13c412014-05-21 05:09:00 +0000891 unsigned protocolClassVersion)
John McCalla729c622012-02-17 03:33:10 +0000892 : CGObjCRuntime(cgm), TheModule(CGM.getModule()),
Craig Topper8a13c412014-05-21 05:09:00 +0000893 VMContext(cgm.getLLVMContext()), ClassPtrAlias(nullptr),
894 MetaClassPtrAlias(nullptr), RuntimeVersion(runtimeABIVersion),
895 ProtocolVersion(protocolClassVersion) {
David Chisnall01aa4672010-04-28 19:33:36 +0000896
897 msgSendMDKind = VMContext.getMDKindID("GNUObjCMessageSend");
898
David Chisnalld7972f52011-03-23 16:36:54 +0000899 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner8d3f4a42009-01-27 05:06:01 +0000900 IntTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +0000901 Types.ConvertType(CGM.getContext().IntTy));
Chris Lattner8d3f4a42009-01-27 05:06:01 +0000902 LongTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +0000903 Types.ConvertType(CGM.getContext().LongTy));
David Chisnall168b80f2010-12-26 22:13:16 +0000904 SizeTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +0000905 Types.ConvertType(CGM.getContext().getSizeType()));
David Chisnall168b80f2010-12-26 22:13:16 +0000906 PtrDiffTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +0000907 Types.ConvertType(CGM.getContext().getPointerDiffType()));
David Chisnall168b80f2010-12-26 22:13:16 +0000908 BoolTy = CGM.getTypes().ConvertType(CGM.getContext().BoolTy);
Mike Stump11289f42009-09-09 15:08:12 +0000909
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000910 Int8Ty = llvm::Type::getInt8Ty(VMContext);
911 // C string type. Used in lots of places.
912 PtrToInt8Ty = llvm::PointerType::getUnqual(Int8Ty);
913
Owen Andersonb7a2fe62009-07-24 23:12:58 +0000914 Zeros[0] = llvm::ConstantInt::get(LongTy, 0);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000915 Zeros[1] = Zeros[0];
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000916 NULLPtr = llvm::ConstantPointerNull::get(PtrToInt8Ty);
Chris Lattner4bd55962008-03-30 23:03:07 +0000917 // Get the selector Type.
David Chisnall481e3a82010-01-23 02:40:42 +0000918 QualType selTy = CGM.getContext().getObjCSelType();
919 if (QualType() == selTy) {
920 SelectorTy = PtrToInt8Ty;
921 } else {
922 SelectorTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(selTy));
923 }
Chris Lattner8d3f4a42009-01-27 05:06:01 +0000924
Owen Anderson9793f0e2009-07-29 22:16:19 +0000925 PtrToIntTy = llvm::PointerType::getUnqual(IntTy);
Chris Lattner4bd55962008-03-30 23:03:07 +0000926 PtrTy = PtrToInt8Ty;
Mike Stump11289f42009-09-09 15:08:12 +0000927
David Chisnallcdd207e2011-10-04 15:35:30 +0000928 Int32Ty = llvm::Type::getInt32Ty(VMContext);
929 Int64Ty = llvm::Type::getInt64Ty(VMContext);
930
Rafael Espindola3cc5c2d2014-01-09 21:32:51 +0000931 IntPtrTy =
932 CGM.getDataLayout().getPointerSizeInBits() == 32 ? Int32Ty : Int64Ty;
David Chisnalle0dc7cb2011-10-08 08:54:36 +0000933
Chris Lattner4bd55962008-03-30 23:03:07 +0000934 // Object type
David Chisnall10d2ded2011-04-29 14:10:35 +0000935 QualType UnqualIdTy = CGM.getContext().getObjCIdType();
936 ASTIdTy = CanQualType();
937 if (UnqualIdTy != QualType()) {
938 ASTIdTy = CGM.getContext().getCanonicalType(UnqualIdTy);
David Chisnall481e3a82010-01-23 02:40:42 +0000939 IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy));
David Chisnall10d2ded2011-04-29 14:10:35 +0000940 } else {
941 IdTy = PtrToInt8Ty;
David Chisnall481e3a82010-01-23 02:40:42 +0000942 }
David Chisnall5bb4efd2010-02-03 15:59:02 +0000943 PtrToIdTy = llvm::PointerType::getUnqual(IdTy);
Mike Stump11289f42009-09-09 15:08:12 +0000944
Serge Guelton1d993272017-05-09 19:31:30 +0000945 ObjCSuperTy = llvm::StructType::get(IdTy, IdTy);
David Chisnall76803412011-03-23 22:52:06 +0000946 PtrToObjCSuperTy = llvm::PointerType::getUnqual(ObjCSuperTy);
947
Chris Lattnera5f58b02011-07-09 17:41:47 +0000948 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
David Chisnalld7972f52011-03-23 16:36:54 +0000949
950 // void objc_exception_throw(id);
Serge Guelton1d993272017-05-09 19:31:30 +0000951 ExceptionThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy);
952 ExceptionReThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000953 // int objc_sync_enter(id);
Serge Guelton1d993272017-05-09 19:31:30 +0000954 SyncEnterFn.init(&CGM, "objc_sync_enter", IntTy, IdTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000955 // int objc_sync_exit(id);
Serge Guelton1d993272017-05-09 19:31:30 +0000956 SyncExitFn.init(&CGM, "objc_sync_exit", IntTy, IdTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000957
958 // void objc_enumerationMutation (id)
Serge Guelton1d993272017-05-09 19:31:30 +0000959 EnumerationMutationFn.init(&CGM, "objc_enumerationMutation", VoidTy, IdTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000960
961 // id objc_getProperty(id, SEL, ptrdiff_t, BOOL)
962 GetPropertyFn.init(&CGM, "objc_getProperty", IdTy, IdTy, SelectorTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000963 PtrDiffTy, BoolTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000964 // void objc_setProperty(id, SEL, ptrdiff_t, id, BOOL, BOOL)
965 SetPropertyFn.init(&CGM, "objc_setProperty", VoidTy, IdTy, SelectorTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000966 PtrDiffTy, IdTy, BoolTy, BoolTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000967 // void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL)
Serge Guelton1d993272017-05-09 19:31:30 +0000968 GetStructPropertyFn.init(&CGM, "objc_getPropertyStruct", VoidTy, PtrTy, PtrTy,
969 PtrDiffTy, BoolTy, BoolTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000970 // void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL)
Serge Guelton1d993272017-05-09 19:31:30 +0000971 SetStructPropertyFn.init(&CGM, "objc_setPropertyStruct", VoidTy, PtrTy, PtrTy,
972 PtrDiffTy, BoolTy, BoolTy);
David Chisnalld7972f52011-03-23 16:36:54 +0000973
Chris Lattner4bd55962008-03-30 23:03:07 +0000974 // IMP type
Chris Lattnera5f58b02011-07-09 17:41:47 +0000975 llvm::Type *IMPArgs[] = { IdTy, SelectorTy };
David Chisnall76803412011-03-23 22:52:06 +0000976 IMPTy = llvm::PointerType::getUnqual(llvm::FunctionType::get(IdTy, IMPArgs,
977 true));
David Chisnall5bb4efd2010-02-03 15:59:02 +0000978
David Blaikiebbafb8a2012-03-11 07:00:24 +0000979 const LangOptions &Opts = CGM.getLangOpts();
Douglas Gregor79a91412011-09-13 17:21:33 +0000980 if ((Opts.getGC() != LangOptions::NonGC) || Opts.ObjCAutoRefCount)
David Chisnalla918b882011-07-07 11:22:31 +0000981 RuntimeVersion = 10;
982
David Chisnalld3858d62011-03-25 11:57:33 +0000983 // Don't bother initialising the GC stuff unless we're compiling in GC mode
Douglas Gregor79a91412011-09-13 17:21:33 +0000984 if (Opts.getGC() != LangOptions::NonGC) {
David Chisnall5c511772011-05-22 22:37:08 +0000985 // This is a bit of an hack. We should sort this out by having a proper
986 // CGObjCGNUstep subclass for GC, but we may want to really support the old
987 // ABI and GC added in ObjectiveC2.framework, so we fudge it a bit for now
David Chisnall5bb4efd2010-02-03 15:59:02 +0000988 // Get selectors needed in GC mode
989 RetainSel = GetNullarySelector("retain", CGM.getContext());
990 ReleaseSel = GetNullarySelector("release", CGM.getContext());
991 AutoreleaseSel = GetNullarySelector("autorelease", CGM.getContext());
992
993 // Get functions needed in GC mode
994
995 // id objc_assign_ivar(id, id, ptrdiff_t);
Serge Guelton1d993272017-05-09 19:31:30 +0000996 IvarAssignFn.init(&CGM, "objc_assign_ivar", IdTy, IdTy, IdTy, PtrDiffTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +0000997 // id objc_assign_strongCast (id, id*)
David Chisnalld7972f52011-03-23 16:36:54 +0000998 StrongCastAssignFn.init(&CGM, "objc_assign_strongCast", IdTy, IdTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000999 PtrToIdTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001000 // id objc_assign_global(id, id*);
Serge Guelton1d993272017-05-09 19:31:30 +00001001 GlobalAssignFn.init(&CGM, "objc_assign_global", IdTy, IdTy, PtrToIdTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001002 // id objc_assign_weak(id, id*);
Serge Guelton1d993272017-05-09 19:31:30 +00001003 WeakAssignFn.init(&CGM, "objc_assign_weak", IdTy, IdTy, PtrToIdTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001004 // id objc_read_weak(id*);
Serge Guelton1d993272017-05-09 19:31:30 +00001005 WeakReadFn.init(&CGM, "objc_read_weak", IdTy, PtrToIdTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001006 // void *objc_memmove_collectable(void*, void *, size_t);
David Chisnalld7972f52011-03-23 16:36:54 +00001007 MemMoveFn.init(&CGM, "objc_memmove_collectable", PtrTy, PtrTy, PtrTy,
Serge Guelton1d993272017-05-09 19:31:30 +00001008 SizeTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001009 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001010}
Mike Stumpdd93a192009-07-31 21:31:32 +00001011
John McCall882987f2013-02-28 19:01:20 +00001012llvm::Value *CGObjCGNU::GetClassNamed(CodeGenFunction &CGF,
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00001013 const std::string &Name, bool isWeak) {
John McCall7f416cc2015-09-08 08:05:57 +00001014 llvm::Constant *ClassName = MakeConstantString(Name);
David Chisnalldf349172010-01-08 00:14:31 +00001015 // With the incompatible ABI, this will need to be replaced with a direct
1016 // reference to the class symbol. For the compatible nonfragile ABI we are
1017 // still performing this lookup at run time but emitting the symbol for the
1018 // class externally so that we can make the switch later.
David Chisnall920e83b2011-06-29 13:16:41 +00001019 //
1020 // Libobjc2 contains an LLVM pass that replaces calls to objc_lookup_class
1021 // with memoized versions or with static references if it's safe to do so.
David Chisnall08d67332011-06-30 10:14:37 +00001022 if (!isWeak)
1023 EmitClassRef(Name);
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +00001024
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001025 llvm::Constant *ClassLookupFn =
Jay Foad5709f7c2011-07-29 13:56:53 +00001026 CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, PtrToInt8Ty, true),
Fariborz Jahanian3b636c12009-03-30 18:02:14 +00001027 "objc_lookup_class");
John McCall882987f2013-02-28 19:01:20 +00001028 return CGF.EmitNounwindRuntimeCall(ClassLookupFn, ClassName);
Chris Lattner4bd55962008-03-30 23:03:07 +00001029}
1030
David Chisnall920e83b2011-06-29 13:16:41 +00001031// This has to perform the lookup every time, since posing and related
1032// techniques can modify the name -> class mapping.
John McCall882987f2013-02-28 19:01:20 +00001033llvm::Value *CGObjCGNU::GetClass(CodeGenFunction &CGF,
David Chisnall920e83b2011-06-29 13:16:41 +00001034 const ObjCInterfaceDecl *OID) {
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00001035 auto *Value =
1036 GetClassNamed(CGF, OID->getNameAsString(), OID->isWeakImported());
Rafael Espindolab7350042018-03-01 00:35:47 +00001037 if (auto *ClassSymbol = dyn_cast<llvm::GlobalVariable>(Value))
1038 CGM.setGVProperties(ClassSymbol, OID);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00001039 return Value;
David Chisnall920e83b2011-06-29 13:16:41 +00001040}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001041
John McCall882987f2013-02-28 19:01:20 +00001042llvm::Value *CGObjCGNU::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00001043 auto *Value = GetClassNamed(CGF, "NSAutoreleasePool", false);
1044 if (CGM.getTriple().isOSBinFormatCOFF()) {
1045 if (auto *ClassSymbol = dyn_cast<llvm::GlobalVariable>(Value)) {
1046 IdentifierInfo &II = CGF.CGM.getContext().Idents.get("NSAutoreleasePool");
1047 TranslationUnitDecl *TUDecl = CGM.getContext().getTranslationUnitDecl();
1048 DeclContext *DC = TranslationUnitDecl::castToDeclContext(TUDecl);
1049
1050 const VarDecl *VD = nullptr;
1051 for (const auto &Result : DC->lookup(&II))
1052 if ((VD = dyn_cast<VarDecl>(Result)))
1053 break;
1054
Rafael Espindolab7350042018-03-01 00:35:47 +00001055 CGM.setGVProperties(ClassSymbol, VD);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00001056 }
1057 }
1058 return Value;
David Chisnall920e83b2011-06-29 13:16:41 +00001059}
1060
John McCall882987f2013-02-28 19:01:20 +00001061llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF, Selector Sel,
John McCall7f416cc2015-09-08 08:05:57 +00001062 const std::string &TypeEncoding) {
Craig Topperfa159c12013-07-14 16:47:36 +00001063 SmallVectorImpl<TypedSelector> &Types = SelectorTable[Sel];
Craig Topper8a13c412014-05-21 05:09:00 +00001064 llvm::GlobalAlias *SelValue = nullptr;
David Chisnalld7972f52011-03-23 16:36:54 +00001065
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001066 for (SmallVectorImpl<TypedSelector>::iterator i = Types.begin(),
David Chisnalld7972f52011-03-23 16:36:54 +00001067 e = Types.end() ; i!=e ; i++) {
1068 if (i->first == TypeEncoding) {
1069 SelValue = i->second;
1070 break;
1071 }
1072 }
Craig Topper8a13c412014-05-21 05:09:00 +00001073 if (!SelValue) {
Rafael Espindola234405b2014-05-17 21:30:14 +00001074 SelValue = llvm::GlobalAlias::create(
David Blaikieaff29d32015-09-14 18:02:04 +00001075 SelectorTy->getElementType(), 0, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola61722772014-05-17 19:58:16 +00001076 ".objc_selector_" + Sel.getAsString(), &TheModule);
Benjamin Kramer3204b152015-05-29 19:42:19 +00001077 Types.emplace_back(TypeEncoding, SelValue);
David Chisnalld7972f52011-03-23 16:36:54 +00001078 }
1079
David Chisnall76803412011-03-23 22:52:06 +00001080 return SelValue;
David Chisnalld7972f52011-03-23 16:36:54 +00001081}
1082
John McCall7f416cc2015-09-08 08:05:57 +00001083Address CGObjCGNU::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
1084 llvm::Value *SelValue = GetSelector(CGF, Sel);
1085
1086 // Store it to a temporary. Does this satisfy the semantics of
1087 // GetAddrOfSelector? Hopefully.
1088 Address tmp = CGF.CreateTempAlloca(SelValue->getType(),
1089 CGF.getPointerAlign());
1090 CGF.Builder.CreateStore(SelValue, tmp);
1091 return tmp;
1092}
1093
1094llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF, Selector Sel) {
1095 return GetSelector(CGF, Sel, std::string());
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001096}
1097
John McCall882987f2013-02-28 19:01:20 +00001098llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF,
1099 const ObjCMethodDecl *Method) {
John McCall843dfcc2016-11-29 21:57:00 +00001100 std::string SelTypes = CGM.getContext().getObjCEncodingForMethodDecl(Method);
John McCall7f416cc2015-09-08 08:05:57 +00001101 return GetSelector(CGF, Method->getSelector(), SelTypes);
Chris Lattner6d522c02008-06-26 04:37:12 +00001102}
1103
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001104llvm::Constant *CGObjCGNU::GetEHType(QualType T) {
John McCallc31d8932012-11-14 09:08:34 +00001105 if (T->isObjCIdType() || T->isObjCQualifiedIdType()) {
1106 // With the old ABI, there was only one kind of catchall, which broke
1107 // foreign exceptions. With the new ABI, we use __objc_id_typeinfo as
1108 // a pointer indicating object catchalls, and NULL to indicate real
1109 // catchalls
1110 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1111 return MakeConstantString("@id");
1112 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00001113 return nullptr;
John McCallc31d8932012-11-14 09:08:34 +00001114 }
David Chisnalld3858d62011-03-25 11:57:33 +00001115 }
John McCallc31d8932012-11-14 09:08:34 +00001116
1117 // All other types should be Objective-C interface pointer types.
1118 const ObjCObjectPointerType *OPT = T->getAs<ObjCObjectPointerType>();
1119 assert(OPT && "Invalid @catch type.");
1120 const ObjCInterfaceDecl *IDecl = OPT->getObjectType()->getInterface();
1121 assert(IDecl && "Invalid @catch type.");
1122 return MakeConstantString(IDecl->getIdentifier()->getName());
1123}
1124
1125llvm::Constant *CGObjCGNUstep::GetEHType(QualType T) {
1126 if (!CGM.getLangOpts().CPlusPlus)
1127 return CGObjCGNU::GetEHType(T);
1128
David Chisnalle1d2584d2011-03-20 21:35:39 +00001129 // For Objective-C++, we want to provide the ability to catch both C++ and
1130 // Objective-C objects in the same function.
1131
1132 // There's a particular fixed type info for 'id'.
1133 if (T->isObjCIdType() ||
1134 T->isObjCQualifiedIdType()) {
1135 llvm::Constant *IDEHType =
1136 CGM.getModule().getGlobalVariable("__objc_id_type_info");
1137 if (!IDEHType)
1138 IDEHType =
1139 new llvm::GlobalVariable(CGM.getModule(), PtrToInt8Ty,
1140 false,
1141 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00001142 nullptr, "__objc_id_type_info");
David Chisnalle1d2584d2011-03-20 21:35:39 +00001143 return llvm::ConstantExpr::getBitCast(IDEHType, PtrToInt8Ty);
1144 }
1145
1146 const ObjCObjectPointerType *PT =
1147 T->getAs<ObjCObjectPointerType>();
1148 assert(PT && "Invalid @catch type.");
1149 const ObjCInterfaceType *IT = PT->getInterfaceType();
1150 assert(IT && "Invalid @catch type.");
1151 std::string className = IT->getDecl()->getIdentifier()->getName();
1152
1153 std::string typeinfoName = "__objc_eh_typeinfo_" + className;
1154
1155 // Return the existing typeinfo if it exists
1156 llvm::Constant *typeinfo = TheModule.getGlobalVariable(typeinfoName);
David Chisnalld6639342012-03-20 16:25:52 +00001157 if (typeinfo)
1158 return llvm::ConstantExpr::getBitCast(typeinfo, PtrToInt8Ty);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001159
1160 // Otherwise create it.
1161
1162 // vtable for gnustep::libobjc::__objc_class_type_info
1163 // It's quite ugly hard-coding this. Ideally we'd generate it using the host
1164 // platform's name mangling.
1165 const char *vtableName = "_ZTVN7gnustep7libobjc22__objc_class_type_infoE";
David Blaikiee3b172a2015-04-02 18:55:21 +00001166 auto *Vtable = TheModule.getGlobalVariable(vtableName);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001167 if (!Vtable) {
1168 Vtable = new llvm::GlobalVariable(TheModule, PtrToInt8Ty, true,
Craig Topper8a13c412014-05-21 05:09:00 +00001169 llvm::GlobalValue::ExternalLinkage,
1170 nullptr, vtableName);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001171 }
1172 llvm::Constant *Two = llvm::ConstantInt::get(IntTy, 2);
David Blaikiee3b172a2015-04-02 18:55:21 +00001173 auto *BVtable = llvm::ConstantExpr::getBitCast(
1174 llvm::ConstantExpr::getGetElementPtr(Vtable->getValueType(), Vtable, Two),
1175 PtrToInt8Ty);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001176
1177 llvm::Constant *typeName =
1178 ExportUniqueString(className, "__objc_eh_typename_");
1179
John McCall23c9dc62016-11-28 22:18:27 +00001180 ConstantInitBuilder builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001181 auto fields = builder.beginStruct();
1182 fields.add(BVtable);
1183 fields.add(typeName);
1184 llvm::Constant *TI =
1185 fields.finishAndCreateGlobal("__objc_eh_typeinfo_" + className,
1186 CGM.getPointerAlign(),
1187 /*constant*/ false,
1188 llvm::GlobalValue::LinkOnceODRLinkage);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001189 return llvm::ConstantExpr::getBitCast(TI, PtrToInt8Ty);
John McCall2ca705e2010-07-24 00:37:23 +00001190}
1191
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001192/// Generate an NSConstantString object.
John McCall7f416cc2015-09-08 08:05:57 +00001193ConstantAddress CGObjCGNU::GenerateConstantString(const StringLiteral *SL) {
David Chisnall358e7512010-01-27 12:49:23 +00001194
Benjamin Kramer35b077e2010-08-17 12:54:38 +00001195 std::string Str = SL->getString().str();
John McCall7f416cc2015-09-08 08:05:57 +00001196 CharUnits Align = CGM.getPointerAlign();
David Chisnall481e3a82010-01-23 02:40:42 +00001197
David Chisnall358e7512010-01-27 12:49:23 +00001198 // Look for an existing one
1199 llvm::StringMap<llvm::Constant*>::iterator old = ObjCStrings.find(Str);
1200 if (old != ObjCStrings.end())
John McCall7f416cc2015-09-08 08:05:57 +00001201 return ConstantAddress(old->getValue(), Align);
David Chisnall358e7512010-01-27 12:49:23 +00001202
David Blaikiebbafb8a2012-03-11 07:00:24 +00001203 StringRef StringClass = CGM.getLangOpts().ObjCConstantStringClass;
David Chisnall207a6302012-01-04 12:02:13 +00001204
1205 if (StringClass.empty()) StringClass = "NXConstantString";
1206
1207 std::string Sym = "_OBJC_CLASS_";
1208 Sym += StringClass;
1209
1210 llvm::Constant *isa = TheModule.getNamedGlobal(Sym);
1211
1212 if (!isa)
1213 isa = new llvm::GlobalVariable(TheModule, IdTy, /* isConstant */false,
Craig Topper8a13c412014-05-21 05:09:00 +00001214 llvm::GlobalValue::ExternalWeakLinkage, nullptr, Sym);
David Chisnall207a6302012-01-04 12:02:13 +00001215 else if (isa->getType() != PtrToIdTy)
1216 isa = llvm::ConstantExpr::getBitCast(isa, PtrToIdTy);
1217
John McCall23c9dc62016-11-28 22:18:27 +00001218 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001219 auto Fields = Builder.beginStruct();
1220 Fields.add(isa);
1221 Fields.add(MakeConstantString(Str));
1222 Fields.addInt(IntTy, Str.size());
1223 llvm::Constant *ObjCStr =
1224 Fields.finishAndCreateGlobal(".objc_str", Align);
David Chisnall358e7512010-01-27 12:49:23 +00001225 ObjCStr = llvm::ConstantExpr::getBitCast(ObjCStr, PtrToInt8Ty);
1226 ObjCStrings[Str] = ObjCStr;
1227 ConstantStrings.push_back(ObjCStr);
John McCall7f416cc2015-09-08 08:05:57 +00001228 return ConstantAddress(ObjCStr, Align);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001229}
1230
1231///Generates a message send where the super is the receiver. This is a message
1232///send to self with special delivery semantics indicating which class's method
1233///should be called.
David Chisnalld7972f52011-03-23 16:36:54 +00001234RValue
1235CGObjCGNU::GenerateMessageSendSuper(CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001236 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001237 QualType ResultType,
1238 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001239 const ObjCInterfaceDecl *Class,
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001240 bool isCategoryImpl,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001241 llvm::Value *Receiver,
Daniel Dunbarc722b852008-08-30 03:02:31 +00001242 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001243 const CallArgList &CallArgs,
1244 const ObjCMethodDecl *Method) {
David Chisnall8a42d192011-05-28 14:09:01 +00001245 CGBuilderTy &Builder = CGF.Builder;
David Blaikiebbafb8a2012-03-11 07:00:24 +00001246 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
David Chisnall5bb4efd2010-02-03 15:59:02 +00001247 if (Sel == RetainSel || Sel == AutoreleaseSel) {
David Chisnall8a42d192011-05-28 14:09:01 +00001248 return RValue::get(EnforceType(Builder, Receiver,
1249 CGM.getTypes().ConvertType(ResultType)));
David Chisnall5bb4efd2010-02-03 15:59:02 +00001250 }
1251 if (Sel == ReleaseSel) {
Craig Topper8a13c412014-05-21 05:09:00 +00001252 return RValue::get(nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001253 }
1254 }
David Chisnallea529a42010-05-01 12:37:16 +00001255
John McCall882987f2013-02-28 19:01:20 +00001256 llvm::Value *cmd = GetSelector(CGF, Sel);
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00001257 CallArgList ActualArgs;
1258
Eli Friedman43dca6a2011-05-02 17:57:46 +00001259 ActualArgs.add(RValue::get(EnforceType(Builder, Receiver, IdTy)), ASTIdTy);
1260 ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00001261 ActualArgs.addFrom(CallArgs);
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00001262
John McCalla729c622012-02-17 03:33:10 +00001263 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00001264
Craig Topper8a13c412014-05-21 05:09:00 +00001265 llvm::Value *ReceiverClass = nullptr;
Chris Lattnera02cb802009-05-08 15:39:58 +00001266 if (isCategoryImpl) {
Craig Topper8a13c412014-05-21 05:09:00 +00001267 llvm::Constant *classLookupFunction = nullptr;
Chris Lattnera02cb802009-05-08 15:39:58 +00001268 if (IsClassMessage) {
Owen Anderson9793f0e2009-07-29 22:16:19 +00001269 classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get(
Jay Foad5709f7c2011-07-29 13:56:53 +00001270 IdTy, PtrTy, true), "objc_get_meta_class");
Chris Lattnera02cb802009-05-08 15:39:58 +00001271 } else {
Owen Anderson9793f0e2009-07-29 22:16:19 +00001272 classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get(
Jay Foad5709f7c2011-07-29 13:56:53 +00001273 IdTy, PtrTy, true), "objc_get_class");
Daniel Dunbar566421c2009-05-04 15:31:17 +00001274 }
David Chisnallea529a42010-05-01 12:37:16 +00001275 ReceiverClass = Builder.CreateCall(classLookupFunction,
Chris Lattnera02cb802009-05-08 15:39:58 +00001276 MakeConstantString(Class->getNameAsString()));
Daniel Dunbar566421c2009-05-04 15:31:17 +00001277 } else {
Chris Lattnera02cb802009-05-08 15:39:58 +00001278 // Set up global aliases for the metaclass or class pointer if they do not
1279 // already exist. These will are forward-references which will be set to
Mike Stumpdd93a192009-07-31 21:31:32 +00001280 // pointers to the class and metaclass structure created for the runtime
1281 // load function. To send a message to super, we look up the value of the
Chris Lattnera02cb802009-05-08 15:39:58 +00001282 // super_class pointer from either the class or metaclass structure.
1283 if (IsClassMessage) {
1284 if (!MetaClassPtrAlias) {
Rafael Espindola234405b2014-05-17 21:30:14 +00001285 MetaClassPtrAlias = llvm::GlobalAlias::create(
David Blaikieaff29d32015-09-14 18:02:04 +00001286 IdTy->getElementType(), 0, llvm::GlobalValue::InternalLinkage,
Rafael Espindola61722772014-05-17 19:58:16 +00001287 ".objc_metaclass_ref" + Class->getNameAsString(), &TheModule);
Chris Lattnera02cb802009-05-08 15:39:58 +00001288 }
1289 ReceiverClass = MetaClassPtrAlias;
1290 } else {
1291 if (!ClassPtrAlias) {
Rafael Espindola234405b2014-05-17 21:30:14 +00001292 ClassPtrAlias = llvm::GlobalAlias::create(
David Blaikieaff29d32015-09-14 18:02:04 +00001293 IdTy->getElementType(), 0, llvm::GlobalValue::InternalLinkage,
Rafael Espindola61722772014-05-17 19:58:16 +00001294 ".objc_class_ref" + Class->getNameAsString(), &TheModule);
Chris Lattnera02cb802009-05-08 15:39:58 +00001295 }
1296 ReceiverClass = ClassPtrAlias;
Daniel Dunbar566421c2009-05-04 15:31:17 +00001297 }
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00001298 }
Daniel Dunbar566421c2009-05-04 15:31:17 +00001299 // Cast the pointer to a simplified version of the class structure
Serge Guelton1d993272017-05-09 19:31:30 +00001300 llvm::Type *CastTy = llvm::StructType::get(IdTy, IdTy);
David Chisnallea529a42010-05-01 12:37:16 +00001301 ReceiverClass = Builder.CreateBitCast(ReceiverClass,
David Blaikie1ed728c2015-04-05 22:45:47 +00001302 llvm::PointerType::getUnqual(CastTy));
Daniel Dunbar566421c2009-05-04 15:31:17 +00001303 // Get the superclass pointer
David Blaikie1ed728c2015-04-05 22:45:47 +00001304 ReceiverClass = Builder.CreateStructGEP(CastTy, ReceiverClass, 1);
Daniel Dunbar566421c2009-05-04 15:31:17 +00001305 // Load the superclass pointer
John McCall7f416cc2015-09-08 08:05:57 +00001306 ReceiverClass =
1307 Builder.CreateAlignedLoad(ReceiverClass, CGF.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001308 // Construct the structure used to look up the IMP
Serge Guelton1d993272017-05-09 19:31:30 +00001309 llvm::StructType *ObjCSuperTy =
1310 llvm::StructType::get(Receiver->getType(), IdTy);
John McCall7f416cc2015-09-08 08:05:57 +00001311
1312 // FIXME: Is this really supposed to be a dynamic alloca?
1313 Address ObjCSuper = Address(Builder.CreateAlloca(ObjCSuperTy),
1314 CGF.getPointerAlign());
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00001315
David Blaikie2e804282015-04-05 22:47:07 +00001316 Builder.CreateStore(Receiver,
John McCall7f416cc2015-09-08 08:05:57 +00001317 Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
David Blaikie2e804282015-04-05 22:47:07 +00001318 Builder.CreateStore(ReceiverClass,
John McCall7f416cc2015-09-08 08:05:57 +00001319 Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001320
David Chisnall76803412011-03-23 22:52:06 +00001321 ObjCSuper = EnforceType(Builder, ObjCSuper, PtrToObjCSuperTy);
David Chisnall76803412011-03-23 22:52:06 +00001322
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001323 // Get the IMP
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00001324 llvm::Value *imp = LookupIMPSuper(CGF, ObjCSuper, cmd, MSI);
John McCalla729c622012-02-17 03:33:10 +00001325 imp = EnforceType(Builder, imp, MSI.MessengerType);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001326
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001327 llvm::Metadata *impMD[] = {
David Chisnall9eecafa2010-05-01 11:15:56 +00001328 llvm::MDString::get(VMContext, Sel.getAsString()),
1329 llvm::MDString::get(VMContext, Class->getSuperClass()->getNameAsString()),
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001330 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
1331 llvm::Type::getInt1Ty(VMContext), IsClassMessage))};
Jay Foadea324f12011-04-21 19:59:12 +00001332 llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD);
David Chisnall9eecafa2010-05-01 11:15:56 +00001333
John McCallb92ab1a2016-10-26 23:46:34 +00001334 CGCallee callee(CGCalleeInfo(), imp);
1335
David Chisnallff5f88c2010-05-02 13:41:58 +00001336 llvm::Instruction *call;
John McCallb92ab1a2016-10-26 23:46:34 +00001337 RValue msgRet = CGF.EmitCall(MSI.CallInfo, callee, Return, ActualArgs, &call);
David Chisnallff5f88c2010-05-02 13:41:58 +00001338 call->setMetadata(msgSendMDKind, node);
1339 return msgRet;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001340}
1341
Mike Stump11289f42009-09-09 15:08:12 +00001342/// Generate code for a message send expression.
David Chisnalld7972f52011-03-23 16:36:54 +00001343RValue
1344CGObjCGNU::GenerateMessageSend(CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001345 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001346 QualType ResultType,
1347 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001348 llvm::Value *Receiver,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001349 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00001350 const ObjCInterfaceDecl *Class,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001351 const ObjCMethodDecl *Method) {
David Chisnall8a42d192011-05-28 14:09:01 +00001352 CGBuilderTy &Builder = CGF.Builder;
1353
David Chisnall75afda62010-04-27 15:08:48 +00001354 // Strip out message sends to retain / release in GC mode
David Blaikiebbafb8a2012-03-11 07:00:24 +00001355 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
David Chisnall5bb4efd2010-02-03 15:59:02 +00001356 if (Sel == RetainSel || Sel == AutoreleaseSel) {
David Chisnall8a42d192011-05-28 14:09:01 +00001357 return RValue::get(EnforceType(Builder, Receiver,
1358 CGM.getTypes().ConvertType(ResultType)));
David Chisnall5bb4efd2010-02-03 15:59:02 +00001359 }
1360 if (Sel == ReleaseSel) {
Craig Topper8a13c412014-05-21 05:09:00 +00001361 return RValue::get(nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001362 }
1363 }
David Chisnall75afda62010-04-27 15:08:48 +00001364
David Chisnall75afda62010-04-27 15:08:48 +00001365 // If the return type is something that goes in an integer register, the
1366 // runtime will handle 0 returns. For other cases, we fill in the 0 value
1367 // ourselves.
1368 //
1369 // The language spec says the result of this kind of message send is
1370 // undefined, but lots of people seem to have forgotten to read that
1371 // paragraph and insist on sending messages to nil that have structure
1372 // returns. With GCC, this generates a random return value (whatever happens
1373 // to be on the stack / in those registers at the time) on most platforms,
David Chisnall76803412011-03-23 22:52:06 +00001374 // and generates an illegal instruction trap on SPARC. With LLVM it corrupts
1375 // the stack.
1376 bool isPointerSizedReturn = (ResultType->isAnyPointerType() ||
1377 ResultType->isIntegralOrEnumerationType() || ResultType->isVoidType());
David Chisnall75afda62010-04-27 15:08:48 +00001378
Craig Topper8a13c412014-05-21 05:09:00 +00001379 llvm::BasicBlock *startBB = nullptr;
1380 llvm::BasicBlock *messageBB = nullptr;
1381 llvm::BasicBlock *continueBB = nullptr;
David Chisnall75afda62010-04-27 15:08:48 +00001382
1383 if (!isPointerSizedReturn) {
1384 startBB = Builder.GetInsertBlock();
1385 messageBB = CGF.createBasicBlock("msgSend");
David Chisnall29cefd12010-05-20 13:45:48 +00001386 continueBB = CGF.createBasicBlock("continue");
David Chisnall75afda62010-04-27 15:08:48 +00001387
1388 llvm::Value *isNil = Builder.CreateICmpEQ(Receiver,
1389 llvm::Constant::getNullValue(Receiver->getType()));
David Chisnall29cefd12010-05-20 13:45:48 +00001390 Builder.CreateCondBr(isNil, continueBB, messageBB);
David Chisnall75afda62010-04-27 15:08:48 +00001391 CGF.EmitBlock(messageBB);
1392 }
1393
David Chisnall9f57c292009-08-17 16:35:33 +00001394 IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy));
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001395 llvm::Value *cmd;
1396 if (Method)
John McCall882987f2013-02-28 19:01:20 +00001397 cmd = GetSelector(CGF, Method);
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001398 else
John McCall882987f2013-02-28 19:01:20 +00001399 cmd = GetSelector(CGF, Sel);
David Chisnall76803412011-03-23 22:52:06 +00001400 cmd = EnforceType(Builder, cmd, SelectorTy);
1401 Receiver = EnforceType(Builder, Receiver, IdTy);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001402
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001403 llvm::Metadata *impMD[] = {
1404 llvm::MDString::get(VMContext, Sel.getAsString()),
1405 llvm::MDString::get(VMContext, Class ? Class->getNameAsString() : ""),
1406 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
1407 llvm::Type::getInt1Ty(VMContext), Class != nullptr))};
Jay Foadea324f12011-04-21 19:59:12 +00001408 llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD);
David Chisnall76803412011-03-23 22:52:06 +00001409
David Chisnall76803412011-03-23 22:52:06 +00001410 CallArgList ActualArgs;
Eli Friedman43dca6a2011-05-02 17:57:46 +00001411 ActualArgs.add(RValue::get(Receiver), ASTIdTy);
1412 ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00001413 ActualArgs.addFrom(CallArgs);
John McCalla729c622012-02-17 03:33:10 +00001414
1415 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
1416
David Chisnall8c93cf22011-10-24 14:07:03 +00001417 // Get the IMP to call
1418 llvm::Value *imp;
1419
1420 // If we have non-legacy dispatch specified, we try using the objc_msgSend()
1421 // functions. These are not supported on all platforms (or all runtimes on a
1422 // given platform), so we
1423 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
David Chisnall8c93cf22011-10-24 14:07:03 +00001424 case CodeGenOptions::Legacy:
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00001425 imp = LookupIMP(CGF, Receiver, cmd, node, MSI);
David Chisnall8c93cf22011-10-24 14:07:03 +00001426 break;
1427 case CodeGenOptions::Mixed:
David Chisnall8c93cf22011-10-24 14:07:03 +00001428 case CodeGenOptions::NonLegacy:
David Chisnall0cc83e72011-10-28 17:55:06 +00001429 if (CGM.ReturnTypeUsesFPRet(ResultType)) {
1430 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
1431 "objc_msgSend_fpret");
John McCalla729c622012-02-17 03:33:10 +00001432 } else if (CGM.ReturnTypeUsesSRet(MSI.CallInfo)) {
David Chisnall8c93cf22011-10-24 14:07:03 +00001433 // The actual types here don't matter - we're going to bitcast the
1434 // function anyway
1435 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
1436 "objc_msgSend_stret");
1437 } else {
1438 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
1439 "objc_msgSend");
1440 }
1441 }
1442
David Chisnall6aec31a2011-12-01 18:40:09 +00001443 // Reset the receiver in case the lookup modified it
Yaxun Liu5b330e82018-03-15 15:25:19 +00001444 ActualArgs[0] = CallArg(RValue::get(Receiver), ASTIdTy);
David Chisnall8c93cf22011-10-24 14:07:03 +00001445
John McCalla729c622012-02-17 03:33:10 +00001446 imp = EnforceType(Builder, imp, MSI.MessengerType);
David Chisnallc0cf4222010-05-01 12:56:56 +00001447
David Chisnallff5f88c2010-05-02 13:41:58 +00001448 llvm::Instruction *call;
John McCallb92ab1a2016-10-26 23:46:34 +00001449 CGCallee callee(CGCalleeInfo(), imp);
1450 RValue msgRet = CGF.EmitCall(MSI.CallInfo, callee, Return, ActualArgs, &call);
David Chisnallff5f88c2010-05-02 13:41:58 +00001451 call->setMetadata(msgSendMDKind, node);
David Chisnall75afda62010-04-27 15:08:48 +00001452
David Chisnall29cefd12010-05-20 13:45:48 +00001453
David Chisnall75afda62010-04-27 15:08:48 +00001454 if (!isPointerSizedReturn) {
David Chisnall29cefd12010-05-20 13:45:48 +00001455 messageBB = CGF.Builder.GetInsertBlock();
1456 CGF.Builder.CreateBr(continueBB);
1457 CGF.EmitBlock(continueBB);
David Chisnall75afda62010-04-27 15:08:48 +00001458 if (msgRet.isScalar()) {
1459 llvm::Value *v = msgRet.getScalarVal();
Jay Foad20c0f022011-03-30 11:28:58 +00001460 llvm::PHINode *phi = Builder.CreatePHI(v->getType(), 2);
David Chisnall75afda62010-04-27 15:08:48 +00001461 phi->addIncoming(v, messageBB);
1462 phi->addIncoming(llvm::Constant::getNullValue(v->getType()), startBB);
1463 msgRet = RValue::get(phi);
1464 } else if (msgRet.isAggregate()) {
John McCall7f416cc2015-09-08 08:05:57 +00001465 Address v = msgRet.getAggregateAddress();
1466 llvm::PHINode *phi = Builder.CreatePHI(v.getType(), 2);
1467 llvm::Type *RetTy = v.getElementType();
1468 Address NullVal = CGF.CreateTempAlloca(RetTy, v.getAlignment(), "null");
1469 CGF.InitTempAlloca(NullVal, llvm::Constant::getNullValue(RetTy));
1470 phi->addIncoming(v.getPointer(), messageBB);
1471 phi->addIncoming(NullVal.getPointer(), startBB);
1472 msgRet = RValue::getAggregate(Address(phi, v.getAlignment()));
David Chisnall75afda62010-04-27 15:08:48 +00001473 } else /* isComplex() */ {
1474 std::pair<llvm::Value*,llvm::Value*> v = msgRet.getComplexVal();
Jay Foad20c0f022011-03-30 11:28:58 +00001475 llvm::PHINode *phi = Builder.CreatePHI(v.first->getType(), 2);
David Chisnall75afda62010-04-27 15:08:48 +00001476 phi->addIncoming(v.first, messageBB);
1477 phi->addIncoming(llvm::Constant::getNullValue(v.first->getType()),
1478 startBB);
Jay Foad20c0f022011-03-30 11:28:58 +00001479 llvm::PHINode *phi2 = Builder.CreatePHI(v.second->getType(), 2);
David Chisnall75afda62010-04-27 15:08:48 +00001480 phi2->addIncoming(v.second, messageBB);
1481 phi2->addIncoming(llvm::Constant::getNullValue(v.second->getType()),
1482 startBB);
1483 msgRet = RValue::getComplex(phi, phi2);
1484 }
1485 }
1486 return msgRet;
Chris Lattnerb7256cd2008-03-01 08:50:34 +00001487}
1488
Mike Stump11289f42009-09-09 15:08:12 +00001489/// Generates a MethodList. Used in construction of a objc_class and
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001490/// objc_category structures.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001491llvm::Constant *CGObjCGNU::
Craig Topperbf3e3272014-08-30 16:55:52 +00001492GenerateMethodList(StringRef ClassName,
1493 StringRef CategoryName,
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001494 ArrayRef<Selector> MethodSels,
1495 ArrayRef<llvm::Constant *> MethodTypes,
1496 bool isClassMethodList) {
David Chisnall9f57c292009-08-17 16:35:33 +00001497 if (MethodSels.empty())
1498 return NULLPtr;
John McCall6c9f1fdb2016-11-19 08:17:24 +00001499
John McCall23c9dc62016-11-28 22:18:27 +00001500 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001501
1502 auto MethodList = Builder.beginStruct();
1503 MethodList.addNullPointer(CGM.Int8PtrTy);
1504 MethodList.addInt(Int32Ty, MethodTypes.size());
1505
Mike Stump11289f42009-09-09 15:08:12 +00001506 // Get the method structure type.
John McCallecee86f2016-11-30 20:19:46 +00001507 llvm::StructType *ObjCMethodTy =
1508 llvm::StructType::get(CGM.getLLVMContext(), {
1509 PtrToInt8Ty, // Really a selector, but the runtime creates it us.
1510 PtrToInt8Ty, // Method types
1511 IMPTy // Method pointer
1512 });
John McCall6c9f1fdb2016-11-19 08:17:24 +00001513 auto Methods = MethodList.beginArray();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001514 for (unsigned int i = 0, e = MethodTypes.size(); i < e; ++i) {
John McCallecee86f2016-11-30 20:19:46 +00001515 llvm::Constant *FnPtr =
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001516 TheModule.getFunction(SymbolNameForMethod(ClassName, CategoryName,
David Chisnalld7972f52011-03-23 16:36:54 +00001517 MethodSels[i],
1518 isClassMethodList));
John McCallecee86f2016-11-30 20:19:46 +00001519 assert(FnPtr && "Can't generate metadata for method that doesn't exist");
1520 auto Method = Methods.beginStruct(ObjCMethodTy);
1521 Method.add(MakeConstantString(MethodSels[i].getAsString()));
1522 Method.add(MethodTypes[i]);
1523 Method.addBitCast(FnPtr, IMPTy);
1524 Method.finishAndAddTo(Methods);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001525 }
John McCallf1788632016-11-28 22:18:30 +00001526 Methods.finishAndAddTo(MethodList);
Mike Stump11289f42009-09-09 15:08:12 +00001527
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001528 // Create an instance of the structure
John McCall6c9f1fdb2016-11-19 08:17:24 +00001529 return MethodList.finishAndCreateGlobal(".objc_method_list",
1530 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001531}
1532
1533/// Generates an IvarList. Used in construction of a objc_class.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001534llvm::Constant *CGObjCGNU::
1535GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
1536 ArrayRef<llvm::Constant *> IvarTypes,
1537 ArrayRef<llvm::Constant *> IvarOffsets) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00001538 if (IvarNames.empty())
David Chisnallb3b44ce2009-11-16 19:05:54 +00001539 return NULLPtr;
John McCall6c9f1fdb2016-11-19 08:17:24 +00001540
John McCall23c9dc62016-11-28 22:18:27 +00001541 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001542
1543 // Structure containing array count followed by array.
1544 auto IvarList = Builder.beginStruct();
1545 IvarList.addInt(IntTy, (int)IvarNames.size());
1546
1547 // Get the ivar structure type.
Serge Guelton1d993272017-05-09 19:31:30 +00001548 llvm::StructType *ObjCIvarTy =
1549 llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty, IntTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001550
1551 // Array of ivar structures.
1552 auto Ivars = IvarList.beginArray(ObjCIvarTy);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001553 for (unsigned int i = 0, e = IvarNames.size() ; i < e ; i++) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00001554 auto Ivar = Ivars.beginStruct(ObjCIvarTy);
1555 Ivar.add(IvarNames[i]);
1556 Ivar.add(IvarTypes[i]);
1557 Ivar.add(IvarOffsets[i]);
John McCallf1788632016-11-28 22:18:30 +00001558 Ivar.finishAndAddTo(Ivars);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001559 }
John McCallf1788632016-11-28 22:18:30 +00001560 Ivars.finishAndAddTo(IvarList);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001561
1562 // Create an instance of the structure
John McCall6c9f1fdb2016-11-19 08:17:24 +00001563 return IvarList.finishAndCreateGlobal(".objc_ivar_list",
1564 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001565}
1566
1567/// Generate a class structure
1568llvm::Constant *CGObjCGNU::GenerateClassStructure(
1569 llvm::Constant *MetaClass,
1570 llvm::Constant *SuperClass,
1571 unsigned info,
Chris Lattnerda35bc82008-06-26 04:47:04 +00001572 const char *Name,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001573 llvm::Constant *Version,
1574 llvm::Constant *InstanceSize,
1575 llvm::Constant *IVars,
1576 llvm::Constant *Methods,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001577 llvm::Constant *Protocols,
1578 llvm::Constant *IvarOffsets,
David Chisnalld472c852010-04-28 14:29:56 +00001579 llvm::Constant *Properties,
David Chisnallcdd207e2011-10-04 15:35:30 +00001580 llvm::Constant *StrongIvarBitmap,
1581 llvm::Constant *WeakIvarBitmap,
David Chisnalld472c852010-04-28 14:29:56 +00001582 bool isMeta) {
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001583 // Set up the class structure
1584 // Note: Several of these are char*s when they should be ids. This is
1585 // because the runtime performs this translation on load.
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001586 //
1587 // Fields marked New ABI are part of the GNUstep runtime. We emit them
1588 // anyway; the classes will still work with the GNU runtime, they will just
1589 // be ignored.
Chris Lattner845511f2011-06-18 22:49:11 +00001590 llvm::StructType *ClassTy = llvm::StructType::get(
Serge Guelton1d993272017-05-09 19:31:30 +00001591 PtrToInt8Ty, // isa
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001592 PtrToInt8Ty, // super_class
1593 PtrToInt8Ty, // name
1594 LongTy, // version
1595 LongTy, // info
1596 LongTy, // instance_size
1597 IVars->getType(), // ivars
1598 Methods->getType(), // methods
Mike Stump11289f42009-09-09 15:08:12 +00001599 // These are all filled in by the runtime, so we pretend
Serge Guelton1d993272017-05-09 19:31:30 +00001600 PtrTy, // dtable
1601 PtrTy, // subclass_list
1602 PtrTy, // sibling_class
1603 PtrTy, // protocols
1604 PtrTy, // gc_object_type
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001605 // New ABI:
1606 LongTy, // abi_version
1607 IvarOffsets->getType(), // ivar_offsets
1608 Properties->getType(), // properties
David Chisnalle89ac062011-10-25 10:12:21 +00001609 IntPtrTy, // strong_pointers
Serge Guelton1d993272017-05-09 19:31:30 +00001610 IntPtrTy // weak_pointers
1611 );
John McCall6c9f1fdb2016-11-19 08:17:24 +00001612
John McCall23c9dc62016-11-28 22:18:27 +00001613 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001614 auto Elements = Builder.beginStruct(ClassTy);
1615
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001616 // Fill in the structure
John McCall6c9f1fdb2016-11-19 08:17:24 +00001617
1618 // isa
John McCallecee86f2016-11-30 20:19:46 +00001619 Elements.addBitCast(MetaClass, PtrToInt8Ty);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001620 // super_class
1621 Elements.add(SuperClass);
1622 // name
1623 Elements.add(MakeConstantString(Name, ".class_name"));
1624 // version
1625 Elements.addInt(LongTy, 0);
1626 // info
1627 Elements.addInt(LongTy, info);
1628 // instance_size
David Chisnall055f0642011-02-21 23:47:40 +00001629 if (isMeta) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00001630 llvm::DataLayout td(&TheModule);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001631 Elements.addInt(LongTy,
1632 td.getTypeSizeInBits(ClassTy) /
1633 CGM.getContext().getCharWidth());
David Chisnall055f0642011-02-21 23:47:40 +00001634 } else
John McCall6c9f1fdb2016-11-19 08:17:24 +00001635 Elements.add(InstanceSize);
1636 // ivars
1637 Elements.add(IVars);
1638 // methods
1639 Elements.add(Methods);
1640 // These are all filled in by the runtime, so we pretend
1641 // dtable
1642 Elements.add(NULLPtr);
1643 // subclass_list
1644 Elements.add(NULLPtr);
1645 // sibling_class
1646 Elements.add(NULLPtr);
1647 // protocols
John McCallecee86f2016-11-30 20:19:46 +00001648 Elements.addBitCast(Protocols, PtrTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001649 // gc_object_type
1650 Elements.add(NULLPtr);
1651 // abi_version
1652 Elements.addInt(LongTy, 1);
1653 // ivar_offsets
1654 Elements.add(IvarOffsets);
1655 // properties
1656 Elements.add(Properties);
1657 // strong_pointers
1658 Elements.add(StrongIvarBitmap);
1659 // weak_pointers
1660 Elements.add(WeakIvarBitmap);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001661 // Create an instance of the structure
David Chisnalldf349172010-01-08 00:14:31 +00001662 // This is now an externally visible symbol, so that we can speed up class
David Chisnall207a6302012-01-04 12:02:13 +00001663 // messages in the next ABI. We may already have some weak references to
1664 // this, so check and fix them properly.
1665 std::string ClassSym((isMeta ? "_OBJC_METACLASS_": "_OBJC_CLASS_") +
1666 std::string(Name));
1667 llvm::GlobalVariable *ClassRef = TheModule.getNamedGlobal(ClassSym);
John McCall7f416cc2015-09-08 08:05:57 +00001668 llvm::Constant *Class =
John McCall6c9f1fdb2016-11-19 08:17:24 +00001669 Elements.finishAndCreateGlobal(ClassSym, CGM.getPointerAlign(), false,
1670 llvm::GlobalValue::ExternalLinkage);
David Chisnall207a6302012-01-04 12:02:13 +00001671 if (ClassRef) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00001672 ClassRef->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(Class,
David Chisnall207a6302012-01-04 12:02:13 +00001673 ClassRef->getType()));
John McCall6c9f1fdb2016-11-19 08:17:24 +00001674 ClassRef->removeFromParent();
1675 Class->setName(ClassSym);
David Chisnall207a6302012-01-04 12:02:13 +00001676 }
1677 return Class;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001678}
1679
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001680llvm::Constant *CGObjCGNU::
1681GenerateProtocolMethodList(ArrayRef<llvm::Constant *> MethodNames,
1682 ArrayRef<llvm::Constant *> MethodTypes) {
Mike Stump11289f42009-09-09 15:08:12 +00001683 // Get the method structure type.
John McCall6c9f1fdb2016-11-19 08:17:24 +00001684 llvm::StructType *ObjCMethodDescTy =
1685 llvm::StructType::get(CGM.getLLVMContext(), { PtrToInt8Ty, PtrToInt8Ty });
John McCall23c9dc62016-11-28 22:18:27 +00001686 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001687 auto MethodList = Builder.beginStruct();
1688 MethodList.addInt(IntTy, MethodNames.size());
1689 auto Methods = MethodList.beginArray(ObjCMethodDescTy);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001690 for (unsigned int i = 0, e = MethodTypes.size() ; i < e ; i++) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00001691 auto Method = Methods.beginStruct(ObjCMethodDescTy);
1692 Method.add(MethodNames[i]);
1693 Method.add(MethodTypes[i]);
John McCallf1788632016-11-28 22:18:30 +00001694 Method.finishAndAddTo(Methods);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001695 }
John McCallf1788632016-11-28 22:18:30 +00001696 Methods.finishAndAddTo(MethodList);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001697 return MethodList.finishAndCreateGlobal(".objc_method_list",
1698 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001699}
Mike Stumpdd93a192009-07-31 21:31:32 +00001700
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001701// Create the protocol list structure used in classes, categories and so on
John McCall6c9f1fdb2016-11-19 08:17:24 +00001702llvm::Constant *
1703CGObjCGNU::GenerateProtocolList(ArrayRef<std::string> Protocols) {
1704
John McCall23c9dc62016-11-28 22:18:27 +00001705 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001706 auto ProtocolList = Builder.beginStruct();
1707 ProtocolList.add(NULLPtr);
1708 ProtocolList.addInt(LongTy, Protocols.size());
1709
1710 auto Elements = ProtocolList.beginArray(PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001711 for (const std::string *iter = Protocols.begin(), *endIter = Protocols.end();
1712 iter != endIter ; iter++) {
Craig Topper8a13c412014-05-21 05:09:00 +00001713 llvm::Constant *protocol = nullptr;
David Chisnallbc8bdea2009-11-20 14:50:59 +00001714 llvm::StringMap<llvm::Constant*>::iterator value =
1715 ExistingProtocols.find(*iter);
1716 if (value == ExistingProtocols.end()) {
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001717 protocol = GenerateEmptyProtocol(*iter);
David Chisnallbc8bdea2009-11-20 14:50:59 +00001718 } else {
1719 protocol = value->getValue();
1720 }
John McCallecee86f2016-11-30 20:19:46 +00001721 Elements.addBitCast(protocol, PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001722 }
John McCallf1788632016-11-28 22:18:30 +00001723 Elements.finishAndAddTo(ProtocolList);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001724 return ProtocolList.finishAndCreateGlobal(".objc_protocol_list",
1725 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001726}
1727
John McCall882987f2013-02-28 19:01:20 +00001728llvm::Value *CGObjCGNU::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001729 const ObjCProtocolDecl *PD) {
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001730 llvm::Value *protocol = ExistingProtocols[PD->getNameAsString()];
Chris Lattner2192fe52011-07-18 04:24:23 +00001731 llvm::Type *T =
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001732 CGM.getTypes().ConvertType(CGM.getContext().getObjCProtoType());
John McCall882987f2013-02-28 19:01:20 +00001733 return CGF.Builder.CreateBitCast(protocol, llvm::PointerType::getUnqual(T));
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001734}
1735
John McCall6c9f1fdb2016-11-19 08:17:24 +00001736llvm::Constant *
1737CGObjCGNU::GenerateEmptyProtocol(const std::string &ProtocolName) {
1738 llvm::Constant *ProtocolList = GenerateProtocolList({});
1739 llvm::Constant *MethodList = GenerateProtocolMethodList({}, {});
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001740 // Protocols are objects containing lists of the methods implemented and
1741 // protocols adopted.
John McCall23c9dc62016-11-28 22:18:27 +00001742 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001743 auto Elements = Builder.beginStruct();
1744
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001745 // The isa pointer must be set to a magic number so the runtime knows it's
1746 // the correct layout.
John McCall6c9f1fdb2016-11-19 08:17:24 +00001747 Elements.add(llvm::ConstantExpr::getIntToPtr(
1748 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
1749
1750 Elements.add(MakeConstantString(ProtocolName, ".objc_protocol_name"));
David Chisnall10e590e2018-04-12 06:46:15 +00001751 Elements.add(ProtocolList); /* .protocol_list */
1752 Elements.add(MethodList); /* .instance_methods */
1753 Elements.add(MethodList); /* .class_methods */
1754 Elements.add(MethodList); /* .optional_instance_methods */
1755 Elements.add(MethodList); /* .optional_class_methods */
1756 Elements.add(NULLPtr); /* .properties */
1757 Elements.add(NULLPtr); /* .optional_properties */
John McCall6c9f1fdb2016-11-19 08:17:24 +00001758 return Elements.finishAndCreateGlobal(".objc_protocol",
1759 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001760}
1761
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001762void CGObjCGNU::GenerateProtocol(const ObjCProtocolDecl *PD) {
1763 ASTContext &Context = CGM.getContext();
Chris Lattner86d7d912008-11-24 03:54:41 +00001764 std::string ProtocolName = PD->getNameAsString();
Douglas Gregora715bff2012-01-01 19:51:50 +00001765
1766 // Use the protocol definition, if there is one.
1767 if (const ObjCProtocolDecl *Def = PD->getDefinition())
1768 PD = Def;
1769
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001770 SmallVector<std::string, 16> Protocols;
Aaron Ballman0f6e64d2014-03-13 22:58:06 +00001771 for (const auto *PI : PD->protocols())
1772 Protocols.push_back(PI->getNameAsString());
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001773 SmallVector<llvm::Constant*, 16> InstanceMethodNames;
1774 SmallVector<llvm::Constant*, 16> InstanceMethodTypes;
1775 SmallVector<llvm::Constant*, 16> OptionalInstanceMethodNames;
1776 SmallVector<llvm::Constant*, 16> OptionalInstanceMethodTypes;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00001777 for (const auto *I : PD->instance_methods()) {
John McCall843dfcc2016-11-29 21:57:00 +00001778 std::string TypeStr = Context.getObjCEncodingForMethodDecl(I);
Aaron Ballmanf26acce2014-03-13 19:50:17 +00001779 if (I->getImplementationControl() == ObjCMethodDecl::Optional) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001780 OptionalInstanceMethodNames.push_back(
Aaron Ballmanf26acce2014-03-13 19:50:17 +00001781 MakeConstantString(I->getSelector().getAsString()));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001782 OptionalInstanceMethodTypes.push_back(MakeConstantString(TypeStr));
David Chisnall12d81352012-08-23 12:17:21 +00001783 } else {
1784 InstanceMethodNames.push_back(
Aaron Ballmanf26acce2014-03-13 19:50:17 +00001785 MakeConstantString(I->getSelector().getAsString()));
David Chisnall12d81352012-08-23 12:17:21 +00001786 InstanceMethodTypes.push_back(MakeConstantString(TypeStr));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001787 }
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001788 }
1789 // Collect information about class methods:
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001790 SmallVector<llvm::Constant*, 16> ClassMethodNames;
1791 SmallVector<llvm::Constant*, 16> ClassMethodTypes;
1792 SmallVector<llvm::Constant*, 16> OptionalClassMethodNames;
1793 SmallVector<llvm::Constant*, 16> OptionalClassMethodTypes;
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00001794 for (const auto *I : PD->class_methods()) {
John McCall843dfcc2016-11-29 21:57:00 +00001795 std::string TypeStr = Context.getObjCEncodingForMethodDecl(I);
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00001796 if (I->getImplementationControl() == ObjCMethodDecl::Optional) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001797 OptionalClassMethodNames.push_back(
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00001798 MakeConstantString(I->getSelector().getAsString()));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001799 OptionalClassMethodTypes.push_back(MakeConstantString(TypeStr));
David Chisnall12d81352012-08-23 12:17:21 +00001800 } else {
1801 ClassMethodNames.push_back(
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00001802 MakeConstantString(I->getSelector().getAsString()));
David Chisnall12d81352012-08-23 12:17:21 +00001803 ClassMethodTypes.push_back(MakeConstantString(TypeStr));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001804 }
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001805 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001806
1807 llvm::Constant *ProtocolList = GenerateProtocolList(Protocols);
1808 llvm::Constant *InstanceMethodList =
1809 GenerateProtocolMethodList(InstanceMethodNames, InstanceMethodTypes);
1810 llvm::Constant *ClassMethodList =
1811 GenerateProtocolMethodList(ClassMethodNames, ClassMethodTypes);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001812 llvm::Constant *OptionalInstanceMethodList =
1813 GenerateProtocolMethodList(OptionalInstanceMethodNames,
1814 OptionalInstanceMethodTypes);
1815 llvm::Constant *OptionalClassMethodList =
1816 GenerateProtocolMethodList(OptionalClassMethodNames,
1817 OptionalClassMethodTypes);
1818
1819 // Property metadata: name, attributes, isSynthesized, setter name, setter
1820 // types, getter name, getter types.
1821 // The isSynthesized value is always set to 0 in a protocol. It exists to
1822 // simplify the runtime library by allowing it to use the same data
1823 // structures for protocol metadata everywhere.
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001824
John McCall6c9f1fdb2016-11-19 08:17:24 +00001825 llvm::Constant *PropertyList;
1826 llvm::Constant *OptionalPropertyList;
1827 {
1828 llvm::StructType *propertyMetadataTy =
1829 llvm::StructType::get(CGM.getLLVMContext(),
1830 { PtrToInt8Ty, Int8Ty, Int8Ty, Int8Ty, Int8Ty, PtrToInt8Ty,
1831 PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty });
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001832
John McCall6c9f1fdb2016-11-19 08:17:24 +00001833 unsigned numReqProperties = 0, numOptProperties = 0;
1834 for (auto property : PD->instance_properties()) {
1835 if (property->isOptional())
1836 numOptProperties++;
1837 else
1838 numReqProperties++;
1839 }
David Chisnalla5f59412012-10-16 15:11:55 +00001840
John McCall23c9dc62016-11-28 22:18:27 +00001841 ConstantInitBuilder reqPropertyListBuilder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001842 auto reqPropertiesList = reqPropertyListBuilder.beginStruct();
1843 reqPropertiesList.addInt(IntTy, numReqProperties);
1844 reqPropertiesList.add(NULLPtr);
1845 auto reqPropertiesArray = reqPropertiesList.beginArray(propertyMetadataTy);
1846
John McCall23c9dc62016-11-28 22:18:27 +00001847 ConstantInitBuilder optPropertyListBuilder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001848 auto optPropertiesList = optPropertyListBuilder.beginStruct();
1849 optPropertiesList.addInt(IntTy, numOptProperties);
1850 optPropertiesList.add(NULLPtr);
1851 auto optPropertiesArray = optPropertiesList.beginArray(propertyMetadataTy);
1852
1853 // Add all of the property methods need adding to the method list and to the
1854 // property metadata list.
1855 for (auto *property : PD->instance_properties()) {
1856 auto &propertiesArray =
1857 (property->isOptional() ? optPropertiesArray : reqPropertiesArray);
1858 auto fields = propertiesArray.beginStruct(propertyMetadataTy);
1859
1860 fields.add(MakePropertyEncodingString(property, nullptr));
1861 PushPropertyAttributes(fields, property);
1862
1863 if (ObjCMethodDecl *getter = property->getGetterMethodDecl()) {
John McCall843dfcc2016-11-29 21:57:00 +00001864 std::string typeStr = Context.getObjCEncodingForMethodDecl(getter);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001865 llvm::Constant *typeEncoding = MakeConstantString(typeStr);
1866 InstanceMethodTypes.push_back(typeEncoding);
1867 fields.add(MakeConstantString(getter->getSelector().getAsString()));
1868 fields.add(typeEncoding);
1869 } else {
1870 fields.add(NULLPtr);
1871 fields.add(NULLPtr);
1872 }
1873 if (ObjCMethodDecl *setter = property->getSetterMethodDecl()) {
John McCall843dfcc2016-11-29 21:57:00 +00001874 std::string typeStr = Context.getObjCEncodingForMethodDecl(setter);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001875 llvm::Constant *typeEncoding = MakeConstantString(typeStr);
1876 InstanceMethodTypes.push_back(typeEncoding);
1877 fields.add(MakeConstantString(setter->getSelector().getAsString()));
1878 fields.add(typeEncoding);
1879 } else {
1880 fields.add(NULLPtr);
1881 fields.add(NULLPtr);
1882 }
1883
John McCallf1788632016-11-28 22:18:30 +00001884 fields.finishAndAddTo(propertiesArray);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001885 }
John McCall6c9f1fdb2016-11-19 08:17:24 +00001886
John McCallf1788632016-11-28 22:18:30 +00001887 reqPropertiesArray.finishAndAddTo(reqPropertiesList);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001888 PropertyList =
1889 reqPropertiesList.finishAndCreateGlobal(".objc_property_list",
1890 CGM.getPointerAlign());
1891
John McCallf1788632016-11-28 22:18:30 +00001892 optPropertiesArray.finishAndAddTo(optPropertiesList);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001893 OptionalPropertyList =
1894 optPropertiesList.finishAndCreateGlobal(".objc_property_list",
1895 CGM.getPointerAlign());
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001896 }
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001897
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001898 // Protocols are objects containing lists of the methods implemented and
1899 // protocols adopted.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001900 // The isa pointer must be set to a magic number so the runtime knows it's
1901 // the correct layout.
John McCall23c9dc62016-11-28 22:18:27 +00001902 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001903 auto Elements = Builder.beginStruct();
1904 Elements.add(
Benjamin Kramer30934732016-07-02 11:41:41 +00001905 llvm::ConstantExpr::getIntToPtr(
John McCall6c9f1fdb2016-11-19 08:17:24 +00001906 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
1907 Elements.add(
1908 MakeConstantString(ProtocolName, ".objc_protocol_name"));
1909 Elements.add(ProtocolList);
1910 Elements.add(InstanceMethodList);
1911 Elements.add(ClassMethodList);
1912 Elements.add(OptionalInstanceMethodList);
1913 Elements.add(OptionalClassMethodList);
1914 Elements.add(PropertyList);
1915 Elements.add(OptionalPropertyList);
Mike Stump11289f42009-09-09 15:08:12 +00001916 ExistingProtocols[ProtocolName] =
John McCall6c9f1fdb2016-11-19 08:17:24 +00001917 llvm::ConstantExpr::getBitCast(
1918 Elements.finishAndCreateGlobal(".objc_protocol", CGM.getPointerAlign()),
1919 IdTy);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001920}
Dmitri Gribenkob2aa9232012-11-15 14:28:07 +00001921void CGObjCGNU::GenerateProtocolHolderCategory() {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001922 // Collect information about instance methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001923 SmallVector<Selector, 1> MethodSels;
1924 SmallVector<llvm::Constant*, 1> MethodTypes;
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001925
John McCall23c9dc62016-11-28 22:18:27 +00001926 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001927 auto Elements = Builder.beginStruct();
1928
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001929 const std::string ClassName = "__ObjC_Protocol_Holder_Ugly_Hack";
1930 const std::string CategoryName = "AnotherHack";
John McCall6c9f1fdb2016-11-19 08:17:24 +00001931 Elements.add(MakeConstantString(CategoryName));
1932 Elements.add(MakeConstantString(ClassName));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001933 // Instance method list
John McCallecee86f2016-11-30 20:19:46 +00001934 Elements.addBitCast(GenerateMethodList(
1935 ClassName, CategoryName, MethodSels, MethodTypes, false), PtrTy);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001936 // Class method list
John McCallecee86f2016-11-30 20:19:46 +00001937 Elements.addBitCast(GenerateMethodList(
1938 ClassName, CategoryName, MethodSels, MethodTypes, true), PtrTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001939
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001940 // Protocol list
John McCall23c9dc62016-11-28 22:18:27 +00001941 ConstantInitBuilder ProtocolListBuilder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001942 auto ProtocolList = ProtocolListBuilder.beginStruct();
1943 ProtocolList.add(NULLPtr);
1944 ProtocolList.addInt(LongTy, ExistingProtocols.size());
1945 auto ProtocolElements = ProtocolList.beginArray(PtrTy);
1946 for (auto iter = ExistingProtocols.begin(), endIter = ExistingProtocols.end();
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001947 iter != endIter ; iter++) {
John McCallecee86f2016-11-30 20:19:46 +00001948 ProtocolElements.addBitCast(iter->getValue(), PtrTy);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001949 }
John McCallf1788632016-11-28 22:18:30 +00001950 ProtocolElements.finishAndAddTo(ProtocolList);
John McCallecee86f2016-11-30 20:19:46 +00001951 Elements.addBitCast(
John McCall6c9f1fdb2016-11-19 08:17:24 +00001952 ProtocolList.finishAndCreateGlobal(".objc_protocol_list",
1953 CGM.getPointerAlign()),
John McCallecee86f2016-11-30 20:19:46 +00001954 PtrTy);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001955 Categories.push_back(llvm::ConstantExpr::getBitCast(
John McCall6c9f1fdb2016-11-19 08:17:24 +00001956 Elements.finishAndCreateGlobal("", CGM.getPointerAlign()),
John McCall7f416cc2015-09-08 08:05:57 +00001957 PtrTy));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001958}
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001959
David Chisnallcdd207e2011-10-04 15:35:30 +00001960/// Libobjc2 uses a bitfield representation where small(ish) bitfields are
1961/// stored in a 64-bit value with the low bit set to 1 and the remaining 63
1962/// bits set to their values, LSB first, while larger ones are stored in a
1963/// structure of this / form:
1964///
1965/// struct { int32_t length; int32_t values[length]; };
1966///
1967/// The values in the array are stored in host-endian format, with the least
1968/// significant bit being assumed to come first in the bitfield. Therefore, a
1969/// bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] }, while a
1970/// bitfield / with the 63rd bit set will be 1<<64.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001971llvm::Constant *CGObjCGNU::MakeBitField(ArrayRef<bool> bits) {
David Chisnallcdd207e2011-10-04 15:35:30 +00001972 int bitCount = bits.size();
Rafael Espindola3cc5c2d2014-01-09 21:32:51 +00001973 int ptrBits = CGM.getDataLayout().getPointerSizeInBits();
David Chisnalle89ac062011-10-25 10:12:21 +00001974 if (bitCount < ptrBits) {
David Chisnallcdd207e2011-10-04 15:35:30 +00001975 uint64_t val = 1;
1976 for (int i=0 ; i<bitCount ; ++i) {
Eli Friedman23526672011-10-08 01:03:47 +00001977 if (bits[i]) val |= 1ULL<<(i+1);
David Chisnallcdd207e2011-10-04 15:35:30 +00001978 }
David Chisnalle89ac062011-10-25 10:12:21 +00001979 return llvm::ConstantInt::get(IntPtrTy, val);
David Chisnallcdd207e2011-10-04 15:35:30 +00001980 }
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001981 SmallVector<llvm::Constant *, 8> values;
David Chisnallcdd207e2011-10-04 15:35:30 +00001982 int v=0;
1983 while (v < bitCount) {
1984 int32_t word = 0;
1985 for (int i=0 ; (i<32) && (v<bitCount) ; ++i) {
1986 if (bits[v]) word |= 1<<i;
1987 v++;
1988 }
1989 values.push_back(llvm::ConstantInt::get(Int32Ty, word));
1990 }
John McCall6c9f1fdb2016-11-19 08:17:24 +00001991
John McCall23c9dc62016-11-28 22:18:27 +00001992 ConstantInitBuilder builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001993 auto fields = builder.beginStruct();
1994 fields.addInt(Int32Ty, values.size());
1995 auto array = fields.beginArray();
1996 for (auto v : values) array.add(v);
John McCallf1788632016-11-28 22:18:30 +00001997 array.finishAndAddTo(fields);
John McCall6c9f1fdb2016-11-19 08:17:24 +00001998
1999 llvm::Constant *GS =
2000 fields.finishAndCreateGlobal("", CharUnits::fromQuantity(4));
David Chisnalle0dc7cb2011-10-08 08:54:36 +00002001 llvm::Constant *ptr = llvm::ConstantExpr::getPtrToInt(GS, IntPtrTy);
David Chisnalle0dc7cb2011-10-08 08:54:36 +00002002 return ptr;
David Chisnallcdd207e2011-10-04 15:35:30 +00002003}
2004
Daniel Dunbar92992502008-08-15 22:20:32 +00002005void CGObjCGNU::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Chris Lattner86d7d912008-11-24 03:54:41 +00002006 std::string ClassName = OCD->getClassInterface()->getNameAsString();
2007 std::string CategoryName = OCD->getNameAsString();
Daniel Dunbar92992502008-08-15 22:20:32 +00002008 // Collect information about instance methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002009 SmallVector<Selector, 16> InstanceMethodSels;
2010 SmallVector<llvm::Constant*, 16> InstanceMethodTypes;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002011 for (const auto *I : OCD->instance_methods()) {
2012 InstanceMethodSels.push_back(I->getSelector());
John McCall843dfcc2016-11-29 21:57:00 +00002013 std::string TypeStr = CGM.getContext().getObjCEncodingForMethodDecl(I);
David Chisnall5778fce2009-08-31 16:41:57 +00002014 InstanceMethodTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002015 }
2016
2017 // Collect information about class methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002018 SmallVector<Selector, 16> ClassMethodSels;
2019 SmallVector<llvm::Constant*, 16> ClassMethodTypes;
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002020 for (const auto *I : OCD->class_methods()) {
2021 ClassMethodSels.push_back(I->getSelector());
John McCall843dfcc2016-11-29 21:57:00 +00002022 std::string TypeStr = CGM.getContext().getObjCEncodingForMethodDecl(I);
David Chisnall5778fce2009-08-31 16:41:57 +00002023 ClassMethodTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002024 }
2025
2026 // Collect the names of referenced protocols
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002027 SmallVector<std::string, 16> Protocols;
David Chisnall2bfc50b2010-03-13 22:20:45 +00002028 const ObjCCategoryDecl *CatDecl = OCD->getCategoryDecl();
2029 const ObjCList<ObjCProtocolDecl> &Protos = CatDecl->getReferencedProtocols();
Daniel Dunbar92992502008-08-15 22:20:32 +00002030 for (ObjCList<ObjCProtocolDecl>::iterator I = Protos.begin(),
2031 E = Protos.end(); I != E; ++I)
Chris Lattnerf3d3fae2008-11-24 05:29:24 +00002032 Protocols.push_back((*I)->getNameAsString());
Daniel Dunbar92992502008-08-15 22:20:32 +00002033
John McCall23c9dc62016-11-28 22:18:27 +00002034 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002035 auto Elements = Builder.beginStruct();
2036 Elements.add(MakeConstantString(CategoryName));
2037 Elements.add(MakeConstantString(ClassName));
2038 // Instance method list
John McCallecee86f2016-11-30 20:19:46 +00002039 Elements.addBitCast(
Benjamin Kramer30934732016-07-02 11:41:41 +00002040 GenerateMethodList(ClassName, CategoryName, InstanceMethodSels,
2041 InstanceMethodTypes, false),
John McCallecee86f2016-11-30 20:19:46 +00002042 PtrTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002043 // Class method list
John McCallecee86f2016-11-30 20:19:46 +00002044 Elements.addBitCast(
2045 GenerateMethodList(ClassName, CategoryName, ClassMethodSels,
2046 ClassMethodTypes, true),
2047 PtrTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002048 // Protocol list
John McCallecee86f2016-11-30 20:19:46 +00002049 Elements.addBitCast(GenerateProtocolList(Protocols), PtrTy);
Owen Andersonade90fd2009-07-29 18:54:39 +00002050 Categories.push_back(llvm::ConstantExpr::getBitCast(
John McCall6c9f1fdb2016-11-19 08:17:24 +00002051 Elements.finishAndCreateGlobal("", CGM.getPointerAlign()),
John McCall7f416cc2015-09-08 08:05:57 +00002052 PtrTy));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002053}
Daniel Dunbar92992502008-08-15 22:20:32 +00002054
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002055llvm::Constant *CGObjCGNU::GeneratePropertyList(const ObjCImplementationDecl *OID,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002056 SmallVectorImpl<Selector> &InstanceMethodSels,
2057 SmallVectorImpl<llvm::Constant*> &InstanceMethodTypes) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002058 ASTContext &Context = CGM.getContext();
David Chisnallbeb80132013-02-28 13:59:29 +00002059 // Property metadata: name, attributes, attributes2, padding1, padding2,
2060 // setter name, setter types, getter name, getter types.
John McCall6c9f1fdb2016-11-19 08:17:24 +00002061 llvm::StructType *propertyMetadataTy =
2062 llvm::StructType::get(CGM.getLLVMContext(),
2063 { PtrToInt8Ty, Int8Ty, Int8Ty, Int8Ty, Int8Ty, PtrToInt8Ty,
2064 PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty });
2065
2066 unsigned numProperties = 0;
2067 for (auto *propertyImpl : OID->property_impls()) {
2068 (void) propertyImpl;
2069 numProperties++;
2070 }
2071
John McCall23c9dc62016-11-28 22:18:27 +00002072 ConstantInitBuilder builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002073 auto propertyList = builder.beginStruct();
2074 propertyList.addInt(IntTy, numProperties);
2075 propertyList.add(NULLPtr);
2076 auto properties = propertyList.beginArray(propertyMetadataTy);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002077
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002078 // Add all of the property methods need adding to the method list and to the
2079 // property metadata list.
Aaron Ballmand85eff42014-03-14 15:02:45 +00002080 for (auto *propertyImpl : OID->property_impls()) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00002081 auto fields = properties.beginStruct(propertyMetadataTy);
Aaron Ballmand85eff42014-03-14 15:02:45 +00002082 ObjCPropertyDecl *property = propertyImpl->getPropertyDecl();
David Chisnall36c63202010-02-26 01:11:38 +00002083 bool isSynthesized = (propertyImpl->getPropertyImplementation() ==
2084 ObjCPropertyImplDecl::Synthesize);
David Chisnallbeb80132013-02-28 13:59:29 +00002085 bool isDynamic = (propertyImpl->getPropertyImplementation() ==
2086 ObjCPropertyImplDecl::Dynamic);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002087
John McCall6c9f1fdb2016-11-19 08:17:24 +00002088 fields.add(MakePropertyEncodingString(property, OID));
2089 PushPropertyAttributes(fields, property, isSynthesized, isDynamic);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002090 if (ObjCMethodDecl *getter = property->getGetterMethodDecl()) {
John McCall843dfcc2016-11-29 21:57:00 +00002091 std::string TypeStr = Context.getObjCEncodingForMethodDecl(getter);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002092 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
David Chisnall36c63202010-02-26 01:11:38 +00002093 if (isSynthesized) {
2094 InstanceMethodTypes.push_back(TypeEncoding);
2095 InstanceMethodSels.push_back(getter->getSelector());
2096 }
John McCall6c9f1fdb2016-11-19 08:17:24 +00002097 fields.add(MakeConstantString(getter->getSelector().getAsString()));
2098 fields.add(TypeEncoding);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002099 } else {
John McCall6c9f1fdb2016-11-19 08:17:24 +00002100 fields.add(NULLPtr);
2101 fields.add(NULLPtr);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002102 }
2103 if (ObjCMethodDecl *setter = property->getSetterMethodDecl()) {
John McCall843dfcc2016-11-29 21:57:00 +00002104 std::string TypeStr = Context.getObjCEncodingForMethodDecl(setter);
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(setter->getSelector());
2109 }
John McCall6c9f1fdb2016-11-19 08:17:24 +00002110 fields.add(MakeConstantString(setter->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 }
John McCallf1788632016-11-28 22:18:30 +00002116 fields.finishAndAddTo(properties);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002117 }
John McCallf1788632016-11-28 22:18:30 +00002118 properties.finishAndAddTo(propertyList);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002119
John McCall6c9f1fdb2016-11-19 08:17:24 +00002120 return propertyList.finishAndCreateGlobal(".objc_property_list",
2121 CGM.getPointerAlign());
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002122}
2123
David Chisnall92d436b2012-01-31 18:59:20 +00002124void CGObjCGNU::RegisterAlias(const ObjCCompatibleAliasDecl *OAD) {
2125 // Get the class declaration for which the alias is specified.
2126 ObjCInterfaceDecl *ClassDecl =
2127 const_cast<ObjCInterfaceDecl *>(OAD->getClassInterface());
Benjamin Kramer3204b152015-05-29 19:42:19 +00002128 ClassAliases.emplace_back(ClassDecl->getNameAsString(),
2129 OAD->getNameAsString());
David Chisnall92d436b2012-01-31 18:59:20 +00002130}
2131
Daniel Dunbar92992502008-08-15 22:20:32 +00002132void CGObjCGNU::GenerateClass(const ObjCImplementationDecl *OID) {
2133 ASTContext &Context = CGM.getContext();
2134
2135 // Get the superclass name.
Mike Stump11289f42009-09-09 15:08:12 +00002136 const ObjCInterfaceDecl * SuperClassDecl =
Daniel Dunbar92992502008-08-15 22:20:32 +00002137 OID->getClassInterface()->getSuperClass();
Chris Lattner86d7d912008-11-24 03:54:41 +00002138 std::string SuperClassName;
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002139 if (SuperClassDecl) {
Chris Lattner86d7d912008-11-24 03:54:41 +00002140 SuperClassName = SuperClassDecl->getNameAsString();
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002141 EmitClassRef(SuperClassName);
2142 }
Daniel Dunbar92992502008-08-15 22:20:32 +00002143
2144 // Get the class name
Chris Lattner87bc3872009-04-01 02:00:48 +00002145 ObjCInterfaceDecl *ClassDecl =
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002146 const_cast<ObjCInterfaceDecl *>(OID->getClassInterface());
Chris Lattner86d7d912008-11-24 03:54:41 +00002147 std::string ClassName = ClassDecl->getNameAsString();
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002148
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002149 // Emit the symbol that is used to generate linker errors if this class is
2150 // referenced in other modules but not declared.
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00002151 std::string classSymbolName = "__objc_class_name_" + ClassName;
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002152 if (auto *symbol = TheModule.getGlobalVariable(classSymbolName)) {
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002153 symbol->setInitializer(llvm::ConstantInt::get(LongTy, 0));
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00002154 } else {
Owen Andersonc10c8d32009-07-08 19:05:04 +00002155 new llvm::GlobalVariable(TheModule, LongTy, false,
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002156 llvm::GlobalValue::ExternalLinkage,
2157 llvm::ConstantInt::get(LongTy, 0),
2158 classSymbolName);
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00002159 }
Mike Stump11289f42009-09-09 15:08:12 +00002160
Daniel Dunbar12119b92009-05-03 10:46:44 +00002161 // Get the size of instances.
Ken Dyckc8ae5502011-02-09 01:59:34 +00002162 int instanceSize =
2163 Context.getASTObjCImplementationLayout(OID).getSize().getQuantity();
Daniel Dunbar92992502008-08-15 22:20:32 +00002164
2165 // Collect information about instance variables.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002166 SmallVector<llvm::Constant*, 16> IvarNames;
2167 SmallVector<llvm::Constant*, 16> IvarTypes;
2168 SmallVector<llvm::Constant*, 16> IvarOffsets;
Mike Stump11289f42009-09-09 15:08:12 +00002169
John McCall23c9dc62016-11-28 22:18:27 +00002170 ConstantInitBuilder IvarOffsetBuilder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002171 auto IvarOffsetValues = IvarOffsetBuilder.beginArray(PtrToIntTy);
David Chisnallcdd207e2011-10-04 15:35:30 +00002172 SmallVector<bool, 16> WeakIvars;
2173 SmallVector<bool, 16> StrongIvars;
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002174
Mike Stump11289f42009-09-09 15:08:12 +00002175 int superInstanceSize = !SuperClassDecl ? 0 :
Ken Dyckc8ae5502011-02-09 01:59:34 +00002176 Context.getASTObjCInterfaceLayout(SuperClassDecl).getSize().getQuantity();
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002177 // For non-fragile ivars, set the instance size to 0 - {the size of just this
2178 // class}. The runtime will then set this to the correct value on load.
Richard Smith9c6890a2012-11-01 22:30:59 +00002179 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002180 instanceSize = 0 - (instanceSize - superInstanceSize);
2181 }
David Chisnall18cf7372010-04-19 00:45:34 +00002182
Jordy Rosea91768e2011-07-22 02:08:32 +00002183 for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD;
2184 IVD = IVD->getNextIvar()) {
Daniel Dunbar92992502008-08-15 22:20:32 +00002185 // Store the name
David Chisnall18cf7372010-04-19 00:45:34 +00002186 IvarNames.push_back(MakeConstantString(IVD->getNameAsString()));
Daniel Dunbar92992502008-08-15 22:20:32 +00002187 // Get the type encoding for this ivar
2188 std::string TypeStr;
Akira Hatanakaff8534b2017-03-14 04:00:52 +00002189 Context.getObjCEncodingForType(IVD->getType(), TypeStr, IVD);
David Chisnall5778fce2009-08-31 16:41:57 +00002190 IvarTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002191 // Get the offset
Eli Friedman8cbca202012-11-06 22:15:52 +00002192 uint64_t BaseOffset = ComputeIvarBaseOffset(CGM, OID, IVD);
David Chisnallcb1b7bf2009-11-17 19:32:15 +00002193 uint64_t Offset = BaseOffset;
Richard Smith9c6890a2012-11-01 22:30:59 +00002194 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002195 Offset = BaseOffset - superInstanceSize;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002196 }
David Chisnall1bfe6d32011-07-07 12:34:51 +00002197 llvm::Constant *OffsetValue = llvm::ConstantInt::get(IntTy, Offset);
2198 // Create the direct offset value
2199 std::string OffsetName = "__objc_ivar_offset_value_" + ClassName +"." +
2200 IVD->getNameAsString();
2201 llvm::GlobalVariable *OffsetVar = TheModule.getGlobalVariable(OffsetName);
2202 if (OffsetVar) {
2203 OffsetVar->setInitializer(OffsetValue);
2204 // If this is the real definition, change its linkage type so that
2205 // different modules will use this one, rather than their private
2206 // copy.
2207 OffsetVar->setLinkage(llvm::GlobalValue::ExternalLinkage);
2208 } else
2209 OffsetVar = new llvm::GlobalVariable(TheModule, IntTy,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002210 false, llvm::GlobalValue::ExternalLinkage,
David Chisnall1bfe6d32011-07-07 12:34:51 +00002211 OffsetValue,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002212 "__objc_ivar_offset_value_" + ClassName +"." +
David Chisnall1bfe6d32011-07-07 12:34:51 +00002213 IVD->getNameAsString());
2214 IvarOffsets.push_back(OffsetValue);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002215 IvarOffsetValues.add(OffsetVar);
David Chisnallcdd207e2011-10-04 15:35:30 +00002216 Qualifiers::ObjCLifetime lt = IVD->getType().getQualifiers().getObjCLifetime();
2217 switch (lt) {
2218 case Qualifiers::OCL_Strong:
2219 StrongIvars.push_back(true);
2220 WeakIvars.push_back(false);
2221 break;
2222 case Qualifiers::OCL_Weak:
2223 StrongIvars.push_back(false);
2224 WeakIvars.push_back(true);
2225 break;
2226 default:
2227 StrongIvars.push_back(false);
2228 WeakIvars.push_back(false);
2229 }
Daniel Dunbar92992502008-08-15 22:20:32 +00002230 }
David Chisnallcdd207e2011-10-04 15:35:30 +00002231 llvm::Constant *StrongIvarBitmap = MakeBitField(StrongIvars);
2232 llvm::Constant *WeakIvarBitmap = MakeBitField(WeakIvars);
David Chisnalld7972f52011-03-23 16:36:54 +00002233 llvm::GlobalVariable *IvarOffsetArray =
John McCall6c9f1fdb2016-11-19 08:17:24 +00002234 IvarOffsetValues.finishAndCreateGlobal(".ivar.offsets",
2235 CGM.getPointerAlign());
David Chisnalld7972f52011-03-23 16:36:54 +00002236
Daniel Dunbar92992502008-08-15 22:20:32 +00002237 // Collect information about instance methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002238 SmallVector<Selector, 16> InstanceMethodSels;
2239 SmallVector<llvm::Constant*, 16> InstanceMethodTypes;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002240 for (const auto *I : OID->instance_methods()) {
2241 InstanceMethodSels.push_back(I->getSelector());
John McCall843dfcc2016-11-29 21:57:00 +00002242 std::string TypeStr = Context.getObjCEncodingForMethodDecl(I);
David Chisnall5778fce2009-08-31 16:41:57 +00002243 InstanceMethodTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002244 }
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002245
2246 llvm::Constant *Properties = GeneratePropertyList(OID, InstanceMethodSels,
2247 InstanceMethodTypes);
2248
Daniel Dunbar92992502008-08-15 22:20:32 +00002249 // Collect information about class methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002250 SmallVector<Selector, 16> ClassMethodSels;
2251 SmallVector<llvm::Constant*, 16> ClassMethodTypes;
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002252 for (const auto *I : OID->class_methods()) {
2253 ClassMethodSels.push_back(I->getSelector());
John McCall843dfcc2016-11-29 21:57:00 +00002254 std::string TypeStr = Context.getObjCEncodingForMethodDecl(I);
David Chisnall5778fce2009-08-31 16:41:57 +00002255 ClassMethodTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002256 }
2257 // Collect the names of referenced protocols
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002258 SmallVector<std::string, 16> Protocols;
Aaron Ballmana49c5062014-03-13 20:29:09 +00002259 for (const auto *I : ClassDecl->protocols())
2260 Protocols.push_back(I->getNameAsString());
Daniel Dunbar92992502008-08-15 22:20:32 +00002261
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002262 // Get the superclass pointer.
2263 llvm::Constant *SuperClass;
Chris Lattner86d7d912008-11-24 03:54:41 +00002264 if (!SuperClassName.empty()) {
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002265 SuperClass = MakeConstantString(SuperClassName, ".super_class_name");
2266 } else {
Owen Anderson7ec07a52009-07-30 23:11:26 +00002267 SuperClass = llvm::ConstantPointerNull::get(PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002268 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002269 // Empty vector used to construct empty method lists
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002270 SmallVector<llvm::Constant*, 1> empty;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002271 // Generate the method and instance variable lists
2272 llvm::Constant *MethodList = GenerateMethodList(ClassName, "",
Chris Lattnerbf231a62008-06-26 05:08:00 +00002273 InstanceMethodSels, InstanceMethodTypes, false);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002274 llvm::Constant *ClassMethodList = GenerateMethodList(ClassName, "",
Chris Lattnerbf231a62008-06-26 05:08:00 +00002275 ClassMethodSels, ClassMethodTypes, true);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002276 llvm::Constant *IvarList = GenerateIvarList(IvarNames, IvarTypes,
2277 IvarOffsets);
Mike Stump11289f42009-09-09 15:08:12 +00002278 // Irrespective of whether we are compiling for a fragile or non-fragile ABI,
David Chisnall5778fce2009-08-31 16:41:57 +00002279 // we emit a symbol containing the offset for each ivar in the class. This
2280 // allows code compiled for the non-Fragile ABI to inherit from code compiled
2281 // for the legacy ABI, without causing problems. The converse is also
2282 // possible, but causes all ivar accesses to be fragile.
David Chisnalle8431a72010-11-03 16:12:44 +00002283
David Chisnall5778fce2009-08-31 16:41:57 +00002284 // Offset pointer for getting at the correct field in the ivar list when
2285 // setting up the alias. These are: The base address for the global, the
2286 // ivar array (second field), the ivar in this list (set for each ivar), and
2287 // the offset (third field in ivar structure)
David Chisnallcdd207e2011-10-04 15:35:30 +00002288 llvm::Type *IndexTy = Int32Ty;
David Chisnall5778fce2009-08-31 16:41:57 +00002289 llvm::Constant *offsetPointerIndexes[] = {Zeros[0],
Craig Topper8a13c412014-05-21 05:09:00 +00002290 llvm::ConstantInt::get(IndexTy, 1), nullptr,
David Chisnall5778fce2009-08-31 16:41:57 +00002291 llvm::ConstantInt::get(IndexTy, 2) };
2292
Jordy Rosea91768e2011-07-22 02:08:32 +00002293 unsigned ivarIndex = 0;
2294 for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD;
2295 IVD = IVD->getNextIvar()) {
David Chisnall5778fce2009-08-31 16:41:57 +00002296 const std::string Name = "__objc_ivar_offset_" + ClassName + '.'
David Chisnalle8431a72010-11-03 16:12:44 +00002297 + IVD->getNameAsString();
Jordy Rosea91768e2011-07-22 02:08:32 +00002298 offsetPointerIndexes[2] = llvm::ConstantInt::get(IndexTy, ivarIndex);
David Chisnall5778fce2009-08-31 16:41:57 +00002299 // Get the correct ivar field
2300 llvm::Constant *offsetValue = llvm::ConstantExpr::getGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00002301 cast<llvm::GlobalVariable>(IvarList)->getValueType(), IvarList,
2302 offsetPointerIndexes);
David Chisnalle8431a72010-11-03 16:12:44 +00002303 // Get the existing variable, if one exists.
David Chisnall5778fce2009-08-31 16:41:57 +00002304 llvm::GlobalVariable *offset = TheModule.getNamedGlobal(Name);
2305 if (offset) {
Ted Kremenek669669f2012-04-04 00:55:25 +00002306 offset->setInitializer(offsetValue);
2307 // If this is the real definition, change its linkage type so that
2308 // different modules will use this one, rather than their private
2309 // copy.
2310 offset->setLinkage(llvm::GlobalValue::ExternalLinkage);
David Chisnall5778fce2009-08-31 16:41:57 +00002311 } else {
Ted Kremenek669669f2012-04-04 00:55:25 +00002312 // Add a new alias if there isn't one already.
2313 offset = new llvm::GlobalVariable(TheModule, offsetValue->getType(),
2314 false, llvm::GlobalValue::ExternalLinkage, offsetValue, Name);
2315 (void) offset; // Silence dead store warning.
David Chisnall5778fce2009-08-31 16:41:57 +00002316 }
Jordy Rosea91768e2011-07-22 02:08:32 +00002317 ++ivarIndex;
David Chisnall5778fce2009-08-31 16:41:57 +00002318 }
David Chisnalle89ac062011-10-25 10:12:21 +00002319 llvm::Constant *ZeroPtr = llvm::ConstantInt::get(IntPtrTy, 0);
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002320
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002321 //Generate metaclass for class methods
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002322 llvm::Constant *MetaClassStruct = GenerateClassStructure(
2323 NULLPtr, NULLPtr, 0x12L, ClassName.c_str(), nullptr, Zeros[0],
2324 GenerateIvarList(empty, empty, empty), ClassMethodList, NULLPtr, NULLPtr,
2325 NULLPtr, ZeroPtr, ZeroPtr, true);
Rafael Espindolab7350042018-03-01 00:35:47 +00002326 CGM.setGVProperties(cast<llvm::GlobalValue>(MetaClassStruct),
2327 OID->getClassInterface());
Daniel Dunbar566421c2009-05-04 15:31:17 +00002328
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002329 // Generate the class structure
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002330 llvm::Constant *ClassStruct = GenerateClassStructure(
2331 MetaClassStruct, SuperClass, 0x11L, ClassName.c_str(), nullptr,
2332 llvm::ConstantInt::get(LongTy, instanceSize), IvarList, MethodList,
2333 GenerateProtocolList(Protocols), IvarOffsetArray, Properties,
2334 StrongIvarBitmap, WeakIvarBitmap);
Rafael Espindolab7350042018-03-01 00:35:47 +00002335 CGM.setGVProperties(cast<llvm::GlobalValue>(ClassStruct),
2336 OID->getClassInterface());
Daniel Dunbar566421c2009-05-04 15:31:17 +00002337
2338 // Resolve the class aliases, if they exist.
2339 if (ClassPtrAlias) {
David Chisnall82f755c2010-11-09 11:21:43 +00002340 ClassPtrAlias->replaceAllUsesWith(
Owen Andersonade90fd2009-07-29 18:54:39 +00002341 llvm::ConstantExpr::getBitCast(ClassStruct, IdTy));
David Chisnall82f755c2010-11-09 11:21:43 +00002342 ClassPtrAlias->eraseFromParent();
Craig Topper8a13c412014-05-21 05:09:00 +00002343 ClassPtrAlias = nullptr;
Daniel Dunbar566421c2009-05-04 15:31:17 +00002344 }
2345 if (MetaClassPtrAlias) {
David Chisnall82f755c2010-11-09 11:21:43 +00002346 MetaClassPtrAlias->replaceAllUsesWith(
Owen Andersonade90fd2009-07-29 18:54:39 +00002347 llvm::ConstantExpr::getBitCast(MetaClassStruct, IdTy));
David Chisnall82f755c2010-11-09 11:21:43 +00002348 MetaClassPtrAlias->eraseFromParent();
Craig Topper8a13c412014-05-21 05:09:00 +00002349 MetaClassPtrAlias = nullptr;
Daniel Dunbar566421c2009-05-04 15:31:17 +00002350 }
2351
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002352 // Add class structure to list to be added to the symtab later
Owen Andersonade90fd2009-07-29 18:54:39 +00002353 ClassStruct = llvm::ConstantExpr::getBitCast(ClassStruct, PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002354 Classes.push_back(ClassStruct);
2355}
2356
Mike Stump11289f42009-09-09 15:08:12 +00002357llvm::Function *CGObjCGNU::ModuleInitFunction() {
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002358 // Only emit an ObjC load function if no Objective-C stuff has been called
2359 if (Classes.empty() && Categories.empty() && ConstantStrings.empty() &&
David Chisnalld7972f52011-03-23 16:36:54 +00002360 ExistingProtocols.empty() && SelectorTable.empty())
Craig Topper8a13c412014-05-21 05:09:00 +00002361 return nullptr;
Eli Friedman412c6682008-06-01 16:00:02 +00002362
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002363 // Add all referenced protocols to a category.
2364 GenerateProtocolHolderCategory();
2365
John McCallecee86f2016-11-30 20:19:46 +00002366 llvm::StructType *selStructTy =
2367 dyn_cast<llvm::StructType>(SelectorTy->getElementType());
2368 llvm::Type *selStructPtrTy = SelectorTy;
2369 if (!selStructTy) {
2370 selStructTy = llvm::StructType::get(CGM.getLLVMContext(),
2371 { PtrToInt8Ty, PtrToInt8Ty });
2372 selStructPtrTy = llvm::PointerType::getUnqual(selStructTy);
Chris Lattner8d3f4a42009-01-27 05:06:01 +00002373 }
2374
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002375 // Generate statics list:
John McCallecee86f2016-11-30 20:19:46 +00002376 llvm::Constant *statics = NULLPtr;
Alexander Kornienko6ee521c2015-01-23 15:36:10 +00002377 if (!ConstantStrings.empty()) {
John McCallecee86f2016-11-30 20:19:46 +00002378 llvm::GlobalVariable *fileStatics = [&] {
2379 ConstantInitBuilder builder(CGM);
2380 auto staticsStruct = builder.beginStruct();
David Chisnall5778fce2009-08-31 16:41:57 +00002381
John McCallecee86f2016-11-30 20:19:46 +00002382 StringRef stringClass = CGM.getLangOpts().ObjCConstantStringClass;
2383 if (stringClass.empty()) stringClass = "NXConstantString";
2384 staticsStruct.add(MakeConstantString(stringClass,
2385 ".objc_static_class_name"));
David Chisnalld7972f52011-03-23 16:36:54 +00002386
John McCallecee86f2016-11-30 20:19:46 +00002387 auto array = staticsStruct.beginArray();
2388 array.addAll(ConstantStrings);
2389 array.add(NULLPtr);
2390 array.finishAndAddTo(staticsStruct);
David Chisnalld7972f52011-03-23 16:36:54 +00002391
John McCallecee86f2016-11-30 20:19:46 +00002392 return staticsStruct.finishAndCreateGlobal(".objc_statics",
2393 CGM.getPointerAlign());
2394 }();
2395
2396 ConstantInitBuilder builder(CGM);
2397 auto allStaticsArray = builder.beginArray(fileStatics->getType());
2398 allStaticsArray.add(fileStatics);
2399 allStaticsArray.addNullPointer(fileStatics->getType());
2400
2401 statics = allStaticsArray.finishAndCreateGlobal(".objc_statics_ptr",
2402 CGM.getPointerAlign());
2403 statics = llvm::ConstantExpr::getBitCast(statics, PtrTy);
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00002404 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002405
John McCallecee86f2016-11-30 20:19:46 +00002406 // Array of classes, categories, and constant objects.
2407
2408 SmallVector<llvm::GlobalAlias*, 16> selectorAliases;
2409 unsigned selectorCount;
2410
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002411 // Pointer to an array of selectors used in this module.
John McCallecee86f2016-11-30 20:19:46 +00002412 llvm::GlobalVariable *selectorList = [&] {
2413 ConstantInitBuilder builder(CGM);
2414 auto selectors = builder.beginArray(selStructTy);
John McCallf00e2c02016-11-30 20:46:55 +00002415 auto &table = SelectorTable; // MSVC workaround
2416 for (auto &entry : table) {
David Chisnalld7972f52011-03-23 16:36:54 +00002417
John McCallecee86f2016-11-30 20:19:46 +00002418 std::string selNameStr = entry.first.getAsString();
2419 llvm::Constant *selName = ExportUniqueString(selNameStr, ".objc_sel_name");
David Chisnalld7972f52011-03-23 16:36:54 +00002420
John McCallecee86f2016-11-30 20:19:46 +00002421 for (TypedSelector &sel : entry.second) {
2422 llvm::Constant *selectorTypeEncoding = NULLPtr;
2423 if (!sel.first.empty())
2424 selectorTypeEncoding =
2425 MakeConstantString(sel.first, ".objc_sel_types");
David Chisnalld7972f52011-03-23 16:36:54 +00002426
John McCallecee86f2016-11-30 20:19:46 +00002427 auto selStruct = selectors.beginStruct(selStructTy);
2428 selStruct.add(selName);
2429 selStruct.add(selectorTypeEncoding);
2430 selStruct.finishAndAddTo(selectors);
David Chisnalld7972f52011-03-23 16:36:54 +00002431
John McCallecee86f2016-11-30 20:19:46 +00002432 // Store the selector alias for later replacement
2433 selectorAliases.push_back(sel.second);
2434 }
David Chisnalld7972f52011-03-23 16:36:54 +00002435 }
David Chisnalld7972f52011-03-23 16:36:54 +00002436
John McCallecee86f2016-11-30 20:19:46 +00002437 // Remember the number of entries in the selector table.
2438 selectorCount = selectors.size();
2439
2440 // NULL-terminate the selector list. This should not actually be required,
2441 // because the selector list has a length field. Unfortunately, the GCC
2442 // runtime decides to ignore the length field and expects a NULL terminator,
2443 // and GCC cooperates with this by always setting the length to 0.
2444 auto selStruct = selectors.beginStruct(selStructTy);
2445 selStruct.add(NULLPtr);
2446 selStruct.add(NULLPtr);
2447 selStruct.finishAndAddTo(selectors);
2448
2449 return selectors.finishAndCreateGlobal(".objc_selector_list",
2450 CGM.getPointerAlign());
2451 }();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002452
2453 // Now that all of the static selectors exist, create pointers to them.
John McCallecee86f2016-11-30 20:19:46 +00002454 for (unsigned i = 0; i < selectorCount; ++i) {
2455 llvm::Constant *idxs[] = {
2456 Zeros[0],
2457 llvm::ConstantInt::get(Int32Ty, i)
2458 };
David Chisnalld7972f52011-03-23 16:36:54 +00002459 // FIXME: We're generating redundant loads and stores here!
John McCallecee86f2016-11-30 20:19:46 +00002460 llvm::Constant *selPtr = llvm::ConstantExpr::getGetElementPtr(
2461 selectorList->getValueType(), selectorList, idxs);
Chris Lattner8d3f4a42009-01-27 05:06:01 +00002462 // If selectors are defined as an opaque type, cast the pointer to this
2463 // type.
John McCallecee86f2016-11-30 20:19:46 +00002464 selPtr = llvm::ConstantExpr::getBitCast(selPtr, SelectorTy);
2465 selectorAliases[i]->replaceAllUsesWith(selPtr);
2466 selectorAliases[i]->eraseFromParent();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002467 }
David Chisnalld7972f52011-03-23 16:36:54 +00002468
John McCallecee86f2016-11-30 20:19:46 +00002469 llvm::GlobalVariable *symtab = [&] {
2470 ConstantInitBuilder builder(CGM);
2471 auto symtab = builder.beginStruct();
2472
2473 // Number of static selectors
2474 symtab.addInt(LongTy, selectorCount);
2475
2476 symtab.addBitCast(selectorList, selStructPtrTy);
2477
2478 // Number of classes defined.
2479 symtab.addInt(CGM.Int16Ty, Classes.size());
2480 // Number of categories defined
2481 symtab.addInt(CGM.Int16Ty, Categories.size());
2482
2483 // Create an array of classes, then categories, then static object instances
2484 auto classList = symtab.beginArray(PtrToInt8Ty);
2485 classList.addAll(Classes);
2486 classList.addAll(Categories);
2487 // NULL-terminated list of static object instances (mainly constant strings)
2488 classList.add(statics);
2489 classList.add(NULLPtr);
2490 classList.finishAndAddTo(symtab);
2491
2492 // Construct the symbol table.
2493 return symtab.finishAndCreateGlobal("", CGM.getPointerAlign());
2494 }();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002495
2496 // The symbol table is contained in a module which has some version-checking
2497 // constants
John McCallecee86f2016-11-30 20:19:46 +00002498 llvm::Constant *module = [&] {
2499 llvm::Type *moduleEltTys[] = {
2500 LongTy, LongTy, PtrToInt8Ty, symtab->getType(), IntTy
2501 };
2502 llvm::StructType *moduleTy =
2503 llvm::StructType::get(CGM.getLLVMContext(),
2504 makeArrayRef(moduleEltTys).drop_back(unsigned(RuntimeVersion < 10)));
David Chisnalld7972f52011-03-23 16:36:54 +00002505
John McCallecee86f2016-11-30 20:19:46 +00002506 ConstantInitBuilder builder(CGM);
2507 auto module = builder.beginStruct(moduleTy);
2508 // Runtime version, used for ABI compatibility checking.
2509 module.addInt(LongTy, RuntimeVersion);
2510 // sizeof(ModuleTy)
2511 module.addInt(LongTy, CGM.getDataLayout().getTypeStoreSize(moduleTy));
2512
2513 // The path to the source file where this module was declared
2514 SourceManager &SM = CGM.getContext().getSourceManager();
2515 const FileEntry *mainFile = SM.getFileEntryForID(SM.getMainFileID());
2516 std::string path =
Mehdi Amini004b9c72016-10-10 22:52:47 +00002517 (Twine(mainFile->getDir()->getName()) + "/" + mainFile->getName()).str();
John McCallecee86f2016-11-30 20:19:46 +00002518 module.add(MakeConstantString(path, ".objc_source_file_name"));
2519 module.add(symtab);
David Chisnall5c511772011-05-22 22:37:08 +00002520
John McCallecee86f2016-11-30 20:19:46 +00002521 if (RuntimeVersion >= 10) {
2522 switch (CGM.getLangOpts().getGC()) {
David Chisnalla918b882011-07-07 11:22:31 +00002523 case LangOptions::GCOnly:
John McCallecee86f2016-11-30 20:19:46 +00002524 module.addInt(IntTy, 2);
David Chisnall5c511772011-05-22 22:37:08 +00002525 break;
David Chisnalla918b882011-07-07 11:22:31 +00002526 case LangOptions::NonGC:
David Blaikiebbafb8a2012-03-11 07:00:24 +00002527 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallecee86f2016-11-30 20:19:46 +00002528 module.addInt(IntTy, 1);
David Chisnalla918b882011-07-07 11:22:31 +00002529 else
John McCallecee86f2016-11-30 20:19:46 +00002530 module.addInt(IntTy, 0);
David Chisnalla918b882011-07-07 11:22:31 +00002531 break;
2532 case LangOptions::HybridGC:
John McCallecee86f2016-11-30 20:19:46 +00002533 module.addInt(IntTy, 1);
David Chisnalla918b882011-07-07 11:22:31 +00002534 break;
John McCallecee86f2016-11-30 20:19:46 +00002535 }
David Chisnalla918b882011-07-07 11:22:31 +00002536 }
David Chisnall5c511772011-05-22 22:37:08 +00002537
John McCallecee86f2016-11-30 20:19:46 +00002538 return module.finishAndCreateGlobal("", CGM.getPointerAlign());
2539 }();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002540
2541 // Create the load function calling the runtime entry point with the module
2542 // structure
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002543 llvm::Function * LoadFunction = llvm::Function::Create(
Owen Anderson41a75022009-08-13 21:57:51 +00002544 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext), false),
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002545 llvm::GlobalValue::InternalLinkage, ".objc_load_function",
2546 &TheModule);
Owen Anderson41a75022009-08-13 21:57:51 +00002547 llvm::BasicBlock *EntryBB =
2548 llvm::BasicBlock::Create(VMContext, "entry", LoadFunction);
John McCall7f416cc2015-09-08 08:05:57 +00002549 CGBuilderTy Builder(CGM, VMContext);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002550 Builder.SetInsertPoint(EntryBB);
Fariborz Jahanian3b636c12009-03-30 18:02:14 +00002551
Benjamin Kramerdf1fb132011-05-28 14:26:31 +00002552 llvm::FunctionType *FT =
John McCallecee86f2016-11-30 20:19:46 +00002553 llvm::FunctionType::get(Builder.getVoidTy(), module->getType(), true);
Benjamin Kramerdf1fb132011-05-28 14:26:31 +00002554 llvm::Value *Register = CGM.CreateRuntimeFunction(FT, "__objc_exec_class");
John McCallecee86f2016-11-30 20:19:46 +00002555 Builder.CreateCall(Register, module);
David Chisnall92d436b2012-01-31 18:59:20 +00002556
David Chisnallaf066bbb2012-02-01 19:16:56 +00002557 if (!ClassAliases.empty()) {
David Chisnall92d436b2012-01-31 18:59:20 +00002558 llvm::Type *ArgTypes[2] = {PtrTy, PtrToInt8Ty};
2559 llvm::FunctionType *RegisterAliasTy =
2560 llvm::FunctionType::get(Builder.getVoidTy(),
2561 ArgTypes, false);
2562 llvm::Function *RegisterAlias = llvm::Function::Create(
2563 RegisterAliasTy,
2564 llvm::GlobalValue::ExternalWeakLinkage, "class_registerAlias_np",
2565 &TheModule);
2566 llvm::BasicBlock *AliasBB =
2567 llvm::BasicBlock::Create(VMContext, "alias", LoadFunction);
2568 llvm::BasicBlock *NoAliasBB =
2569 llvm::BasicBlock::Create(VMContext, "no_alias", LoadFunction);
2570
2571 // Branch based on whether the runtime provided class_registerAlias_np()
2572 llvm::Value *HasRegisterAlias = Builder.CreateICmpNE(RegisterAlias,
2573 llvm::Constant::getNullValue(RegisterAlias->getType()));
2574 Builder.CreateCondBr(HasRegisterAlias, AliasBB, NoAliasBB);
2575
Alp Tokerf6a24ce2013-12-05 16:25:25 +00002576 // The true branch (has alias registration function):
David Chisnall92d436b2012-01-31 18:59:20 +00002577 Builder.SetInsertPoint(AliasBB);
2578 // Emit alias registration calls:
2579 for (std::vector<ClassAliasPair>::iterator iter = ClassAliases.begin();
2580 iter != ClassAliases.end(); ++iter) {
2581 llvm::Constant *TheClass =
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00002582 TheModule.getGlobalVariable("_OBJC_CLASS_" + iter->first, true);
Craig Topper8a13c412014-05-21 05:09:00 +00002583 if (TheClass) {
David Chisnall92d436b2012-01-31 18:59:20 +00002584 TheClass = llvm::ConstantExpr::getBitCast(TheClass, PtrTy);
David Blaikie43f9bb72015-05-18 22:14:03 +00002585 Builder.CreateCall(RegisterAlias,
2586 {TheClass, MakeConstantString(iter->second)});
David Chisnall92d436b2012-01-31 18:59:20 +00002587 }
2588 }
2589 // Jump to end:
2590 Builder.CreateBr(NoAliasBB);
2591
2592 // Missing alias registration function, just return from the function:
2593 Builder.SetInsertPoint(NoAliasBB);
2594 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002595 Builder.CreateRetVoid();
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002596
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002597 return LoadFunction;
2598}
Daniel Dunbar92992502008-08-15 22:20:32 +00002599
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00002600llvm::Function *CGObjCGNU::GenerateMethod(const ObjCMethodDecl *OMD,
Mike Stump11289f42009-09-09 15:08:12 +00002601 const ObjCContainerDecl *CD) {
2602 const ObjCCategoryImplDecl *OCD =
Steve Naroff11b387f2009-01-08 19:41:02 +00002603 dyn_cast<ObjCCategoryImplDecl>(OMD->getDeclContext());
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002604 StringRef CategoryName = OCD ? OCD->getName() : "";
2605 StringRef ClassName = CD->getName();
David Chisnalld7972f52011-03-23 16:36:54 +00002606 Selector MethodName = OMD->getSelector();
Douglas Gregorffca3a22009-01-09 17:18:27 +00002607 bool isClassMethod = !OMD->isInstanceMethod();
Daniel Dunbar92992502008-08-15 22:20:32 +00002608
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00002609 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00002610 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00002611 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002612 std::string FunctionName = SymbolNameForMethod(ClassName, CategoryName,
2613 MethodName, isClassMethod);
2614
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00002615 llvm::Function *Method
Mike Stump11289f42009-09-09 15:08:12 +00002616 = llvm::Function::Create(MethodTy,
2617 llvm::GlobalValue::InternalLinkage,
2618 FunctionName,
2619 &TheModule);
Chris Lattner4bd55962008-03-30 23:03:07 +00002620 return Method;
2621}
2622
David Chisnall3fe89562011-05-23 22:33:28 +00002623llvm::Constant *CGObjCGNU::GetPropertyGetFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002624 return GetPropertyFn;
Daniel Dunbara91c3e02008-09-24 03:38:44 +00002625}
2626
David Chisnall3fe89562011-05-23 22:33:28 +00002627llvm::Constant *CGObjCGNU::GetPropertySetFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002628 return SetPropertyFn;
Daniel Dunbara91c3e02008-09-24 03:38:44 +00002629}
2630
Ted Kremeneke65b0862012-03-06 20:05:56 +00002631llvm::Constant *CGObjCGNU::GetOptimizedPropertySetFunction(bool atomic,
2632 bool copy) {
Craig Topper8a13c412014-05-21 05:09:00 +00002633 return nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +00002634}
2635
David Chisnall3fe89562011-05-23 22:33:28 +00002636llvm::Constant *CGObjCGNU::GetGetStructFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002637 return GetStructPropertyFn;
David Chisnall168b80f2010-12-26 22:13:16 +00002638}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002639
David Chisnall3fe89562011-05-23 22:33:28 +00002640llvm::Constant *CGObjCGNU::GetSetStructFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002641 return SetStructPropertyFn;
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00002642}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002643
David Chisnall0d75e062012-12-17 18:54:24 +00002644llvm::Constant *CGObjCGNU::GetCppAtomicObjectGetFunction() {
Craig Topper8a13c412014-05-21 05:09:00 +00002645 return nullptr;
David Chisnall0d75e062012-12-17 18:54:24 +00002646}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002647
David Chisnall0d75e062012-12-17 18:54:24 +00002648llvm::Constant *CGObjCGNU::GetCppAtomicObjectSetFunction() {
Craig Topper8a13c412014-05-21 05:09:00 +00002649 return nullptr;
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00002650}
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00002651
Daniel Dunbarc46a0792009-07-24 07:40:24 +00002652llvm::Constant *CGObjCGNU::EnumerationMutationFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002653 return EnumerationMutationFn;
Anders Carlsson3f35a262008-08-31 04:05:03 +00002654}
2655
David Chisnalld7972f52011-03-23 16:36:54 +00002656void CGObjCGNU::EmitSynchronizedStmt(CodeGenFunction &CGF,
John McCallbd309292010-07-06 01:34:17 +00002657 const ObjCAtSynchronizedStmt &S) {
David Chisnalld3858d62011-03-25 11:57:33 +00002658 EmitAtSynchronizedStmt(CGF, S, SyncEnterFn, SyncExitFn);
John McCallbd309292010-07-06 01:34:17 +00002659}
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002660
David Chisnall3a509cd2009-12-24 02:26:34 +00002661
David Chisnalld7972f52011-03-23 16:36:54 +00002662void CGObjCGNU::EmitTryStmt(CodeGenFunction &CGF,
John McCallbd309292010-07-06 01:34:17 +00002663 const ObjCAtTryStmt &S) {
2664 // Unlike the Apple non-fragile runtimes, which also uses
2665 // unwind-based zero cost exceptions, the GNU Objective C runtime's
2666 // EH support isn't a veneer over C++ EH. Instead, exception
David Chisnall9a837be2012-11-07 16:50:40 +00002667 // objects are created by objc_exception_throw and destroyed by
John McCallbd309292010-07-06 01:34:17 +00002668 // the personality function; this avoids the need for bracketing
2669 // catch handlers with calls to __blah_begin_catch/__blah_end_catch
2670 // (or even _Unwind_DeleteException), but probably doesn't
2671 // interoperate very well with foreign exceptions.
David Chisnalld3858d62011-03-25 11:57:33 +00002672 //
David Chisnalle1d2584d2011-03-20 21:35:39 +00002673 // In Objective-C++ mode, we actually emit something equivalent to the C++
David Chisnalld3858d62011-03-25 11:57:33 +00002674 // exception handler.
2675 EmitTryCatchStmt(CGF, S, EnterCatchFn, ExitCatchFn, ExceptionReThrowFn);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002676}
2677
David Chisnalld7972f52011-03-23 16:36:54 +00002678void CGObjCGNU::EmitThrowStmt(CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00002679 const ObjCAtThrowStmt &S,
2680 bool ClearInsertionPoint) {
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002681 llvm::Value *ExceptionAsObject;
2682
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002683 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00002684 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Fariborz Jahanian078cd522009-05-17 16:49:27 +00002685 ExceptionAsObject = Exception;
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002686 } else {
Mike Stump11289f42009-09-09 15:08:12 +00002687 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002688 "Unexpected rethrow outside @catch block.");
2689 ExceptionAsObject = CGF.ObjCEHValueStack.back();
2690 }
Benjamin Kramer76399eb2011-09-27 21:06:10 +00002691 ExceptionAsObject = CGF.Builder.CreateBitCast(ExceptionAsObject, IdTy);
David Chisnall9a837be2012-11-07 16:50:40 +00002692 llvm::CallSite Throw =
John McCall882987f2013-02-28 19:01:20 +00002693 CGF.EmitRuntimeCallOrInvoke(ExceptionThrowFn, ExceptionAsObject);
David Chisnall9a837be2012-11-07 16:50:40 +00002694 Throw.setDoesNotReturn();
Eli Friedmandc009da2012-08-10 21:26:17 +00002695 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00002696 if (ClearInsertionPoint)
2697 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002698}
2699
David Chisnalld7972f52011-03-23 16:36:54 +00002700llvm::Value * CGObjCGNU::EmitObjCWeakRead(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002701 Address AddrWeakObj) {
John McCall882987f2013-02-28 19:01:20 +00002702 CGBuilderTy &B = CGF.Builder;
David Chisnallfcb37e92011-05-30 12:00:26 +00002703 AddrWeakObj = EnforceType(B, AddrWeakObj, PtrToIdTy);
John McCall7f416cc2015-09-08 08:05:57 +00002704 return B.CreateCall(WeakReadFn.getType(), WeakReadFn,
2705 AddrWeakObj.getPointer());
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00002706}
2707
David Chisnalld7972f52011-03-23 16:36:54 +00002708void CGObjCGNU::EmitObjCWeakAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002709 llvm::Value *src, Address dst) {
John McCall882987f2013-02-28 19:01:20 +00002710 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00002711 src = EnforceType(B, src, IdTy);
2712 dst = EnforceType(B, dst, PtrToIdTy);
John McCall7f416cc2015-09-08 08:05:57 +00002713 B.CreateCall(WeakAssignFn.getType(), WeakAssignFn,
2714 {src, dst.getPointer()});
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00002715}
2716
David Chisnalld7972f52011-03-23 16:36:54 +00002717void CGObjCGNU::EmitObjCGlobalAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002718 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00002719 bool threadlocal) {
John McCall882987f2013-02-28 19:01:20 +00002720 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00002721 src = EnforceType(B, src, IdTy);
2722 dst = EnforceType(B, dst, PtrToIdTy);
David Blaikie43f9bb72015-05-18 22:14:03 +00002723 // FIXME. Add threadloca assign API
2724 assert(!threadlocal && "EmitObjCGlobalAssign - Threal Local API NYI");
John McCall7f416cc2015-09-08 08:05:57 +00002725 B.CreateCall(GlobalAssignFn.getType(), GlobalAssignFn,
2726 {src, dst.getPointer()});
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00002727}
2728
David Chisnalld7972f52011-03-23 16:36:54 +00002729void CGObjCGNU::EmitObjCIvarAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002730 llvm::Value *src, Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00002731 llvm::Value *ivarOffset) {
John McCall882987f2013-02-28 19:01:20 +00002732 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00002733 src = EnforceType(B, src, IdTy);
David Chisnalle4e5c0f2011-05-25 20:33:17 +00002734 dst = EnforceType(B, dst, IdTy);
John McCall7f416cc2015-09-08 08:05:57 +00002735 B.CreateCall(IvarAssignFn.getType(), IvarAssignFn,
2736 {src, dst.getPointer(), ivarOffset});
Fariborz Jahaniane881b532008-11-20 19:23:36 +00002737}
2738
David Chisnalld7972f52011-03-23 16:36:54 +00002739void CGObjCGNU::EmitObjCStrongCastAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002740 llvm::Value *src, Address dst) {
John McCall882987f2013-02-28 19:01:20 +00002741 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00002742 src = EnforceType(B, src, IdTy);
2743 dst = EnforceType(B, dst, PtrToIdTy);
John McCall7f416cc2015-09-08 08:05:57 +00002744 B.CreateCall(StrongCastAssignFn.getType(), StrongCastAssignFn,
2745 {src, dst.getPointer()});
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00002746}
2747
David Chisnalld7972f52011-03-23 16:36:54 +00002748void CGObjCGNU::EmitGCMemmoveCollectable(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002749 Address DestPtr,
2750 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00002751 llvm::Value *Size) {
John McCall882987f2013-02-28 19:01:20 +00002752 CGBuilderTy &B = CGF.Builder;
David Chisnall7441d882011-05-28 14:23:43 +00002753 DestPtr = EnforceType(B, DestPtr, PtrTy);
2754 SrcPtr = EnforceType(B, SrcPtr, PtrTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00002755
John McCall7f416cc2015-09-08 08:05:57 +00002756 B.CreateCall(MemMoveFn.getType(), MemMoveFn,
2757 {DestPtr.getPointer(), SrcPtr.getPointer(), Size});
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002758}
2759
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002760llvm::GlobalVariable *CGObjCGNU::ObjCIvarOffsetVariable(
2761 const ObjCInterfaceDecl *ID,
2762 const ObjCIvarDecl *Ivar) {
2763 const std::string Name = "__objc_ivar_offset_" + ID->getNameAsString()
2764 + '.' + Ivar->getNameAsString();
2765 // Emit the variable and initialize it with what we think the correct value
2766 // is. This allows code compiled with non-fragile ivars to work correctly
2767 // when linked against code which isn't (most of the time).
David Chisnall5778fce2009-08-31 16:41:57 +00002768 llvm::GlobalVariable *IvarOffsetPointer = TheModule.getNamedGlobal(Name);
2769 if (!IvarOffsetPointer) {
David Chisnalle8431a72010-11-03 16:12:44 +00002770 // This will cause a run-time crash if we accidentally use it. A value of
2771 // 0 would seem more sensible, but will silently overwrite the isa pointer
2772 // causing a great deal of confusion.
2773 uint64_t Offset = -1;
2774 // We can't call ComputeIvarBaseOffset() here if we have the
2775 // implementation, because it will create an invalid ASTRecordLayout object
2776 // that we are then stuck with forever, so we only initialize the ivar
2777 // offset variable with a guess if we only have the interface. The
2778 // initializer will be reset later anyway, when we are generating the class
2779 // description.
2780 if (!CGM.getContext().getObjCImplementation(
Dan Gohman145f3f12010-04-19 16:39:44 +00002781 const_cast<ObjCInterfaceDecl *>(ID)))
Eli Friedman8cbca202012-11-06 22:15:52 +00002782 Offset = ComputeIvarBaseOffset(CGM, ID, Ivar);
David Chisnall44ec5552010-04-19 01:37:25 +00002783
David Chisnalle0dc7cb2011-10-08 08:54:36 +00002784 llvm::ConstantInt *OffsetGuess = llvm::ConstantInt::get(Int32Ty, Offset,
Richard Trieue4f31802011-09-21 02:46:06 +00002785 /*isSigned*/true);
David Chisnall5778fce2009-08-31 16:41:57 +00002786 // Don't emit the guess in non-PIC code because the linker will not be able
2787 // to replace it with the real version for a library. In non-PIC code you
2788 // must compile with the fragile ABI if you want to use ivars from a
Mike Stump11289f42009-09-09 15:08:12 +00002789 // GCC-compiled class.
Rafael Espindolac9d336e2016-06-23 15:07:32 +00002790 if (CGM.getLangOpts().PICLevel) {
David Chisnall5778fce2009-08-31 16:41:57 +00002791 llvm::GlobalVariable *IvarOffsetGV = new llvm::GlobalVariable(TheModule,
David Chisnallcdd207e2011-10-04 15:35:30 +00002792 Int32Ty, false,
David Chisnall5778fce2009-08-31 16:41:57 +00002793 llvm::GlobalValue::PrivateLinkage, OffsetGuess, Name+".guess");
2794 IvarOffsetPointer = new llvm::GlobalVariable(TheModule,
2795 IvarOffsetGV->getType(), false, llvm::GlobalValue::LinkOnceAnyLinkage,
2796 IvarOffsetGV, Name);
2797 } else {
2798 IvarOffsetPointer = new llvm::GlobalVariable(TheModule,
Benjamin Kramerabd5b902009-10-13 10:07:13 +00002799 llvm::Type::getInt32PtrTy(VMContext), false,
Craig Topper8a13c412014-05-21 05:09:00 +00002800 llvm::GlobalValue::ExternalLinkage, nullptr, Name);
David Chisnall5778fce2009-08-31 16:41:57 +00002801 }
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002802 }
David Chisnall5778fce2009-08-31 16:41:57 +00002803 return IvarOffsetPointer;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002804}
2805
David Chisnalld7972f52011-03-23 16:36:54 +00002806LValue CGObjCGNU::EmitObjCValueForIvar(CodeGenFunction &CGF,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00002807 QualType ObjectTy,
2808 llvm::Value *BaseValue,
2809 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00002810 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00002811 const ObjCInterfaceDecl *ID =
2812 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00002813 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
2814 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00002815}
Mike Stumpdd93a192009-07-31 21:31:32 +00002816
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002817static const ObjCInterfaceDecl *FindIvarInterface(ASTContext &Context,
2818 const ObjCInterfaceDecl *OID,
2819 const ObjCIvarDecl *OIVD) {
Jordy Rosea91768e2011-07-22 02:08:32 +00002820 for (const ObjCIvarDecl *next = OID->all_declared_ivar_begin(); next;
2821 next = next->getNextIvar()) {
2822 if (OIVD == next)
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002823 return OID;
2824 }
Mike Stump11289f42009-09-09 15:08:12 +00002825
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002826 // Otherwise check in the super class.
2827 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
2828 return FindIvarInterface(Context, Super, OIVD);
Mike Stump11289f42009-09-09 15:08:12 +00002829
Craig Topper8a13c412014-05-21 05:09:00 +00002830 return nullptr;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002831}
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00002832
David Chisnalld7972f52011-03-23 16:36:54 +00002833llvm::Value *CGObjCGNU::EmitIvarOffset(CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00002834 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00002835 const ObjCIvarDecl *Ivar) {
John McCall5fb5df92012-06-20 06:18:46 +00002836 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002837 Interface = FindIvarInterface(CGM.getContext(), Interface, Ivar);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00002838
2839 // The MSVC linker cannot have a single global defined as LinkOnceAnyLinkage
2840 // and ExternalLinkage, so create a reference to the ivar global and rely on
2841 // the definition being created as part of GenerateClass.
2842 if (RuntimeVersion < 10 ||
2843 CGF.CGM.getTarget().getTriple().isKnownWindowsMSVCEnvironment())
David Chisnall1bfe6d32011-07-07 12:34:51 +00002844 return CGF.Builder.CreateZExtOrBitCast(
Peter Collingbourneb367c562016-11-28 22:30:21 +00002845 CGF.Builder.CreateAlignedLoad(
2846 Int32Ty, CGF.Builder.CreateAlignedLoad(
2847 ObjCIvarOffsetVariable(Interface, Ivar),
2848 CGF.getPointerAlign(), "ivar"),
2849 CharUnits::fromQuantity(4)),
David Chisnall1bfe6d32011-07-07 12:34:51 +00002850 PtrDiffTy);
2851 std::string name = "__objc_ivar_offset_value_" +
2852 Interface->getNameAsString() +"." + Ivar->getNameAsString();
John McCall7f416cc2015-09-08 08:05:57 +00002853 CharUnits Align = CGM.getIntAlign();
David Chisnall1bfe6d32011-07-07 12:34:51 +00002854 llvm::Value *Offset = TheModule.getGlobalVariable(name);
John McCall7f416cc2015-09-08 08:05:57 +00002855 if (!Offset) {
2856 auto GV = new llvm::GlobalVariable(TheModule, IntTy,
David Chisnall28dc7f92011-08-01 17:36:53 +00002857 false, llvm::GlobalValue::LinkOnceAnyLinkage,
2858 llvm::Constant::getNullValue(IntTy), name);
John McCall7f416cc2015-09-08 08:05:57 +00002859 GV->setAlignment(Align.getQuantity());
2860 Offset = GV;
2861 }
2862 Offset = CGF.Builder.CreateAlignedLoad(Offset, Align);
David Chisnalla79b4692012-04-06 15:39:12 +00002863 if (Offset->getType() != PtrDiffTy)
2864 Offset = CGF.Builder.CreateZExtOrBitCast(Offset, PtrDiffTy);
2865 return Offset;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002866 }
Eli Friedman8cbca202012-11-06 22:15:52 +00002867 uint64_t Offset = ComputeIvarBaseOffset(CGF.CGM, Interface, Ivar);
2868 return llvm::ConstantInt::get(PtrDiffTy, Offset, /*isSigned*/true);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00002869}
2870
David Chisnalld7972f52011-03-23 16:36:54 +00002871CGObjCRuntime *
2872clang::CodeGen::CreateGNUObjCRuntime(CodeGenModule &CGM) {
John McCall5fb5df92012-06-20 06:18:46 +00002873 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
David Chisnallb601c962012-07-03 20:49:52 +00002874 case ObjCRuntime::GNUstep:
David Chisnalld7972f52011-03-23 16:36:54 +00002875 return new CGObjCGNUstep(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00002876
David Chisnallb601c962012-07-03 20:49:52 +00002877 case ObjCRuntime::GCC:
John McCall5fb5df92012-06-20 06:18:46 +00002878 return new CGObjCGCC(CGM);
2879
John McCall775086e2012-07-12 02:07:58 +00002880 case ObjCRuntime::ObjFW:
2881 return new CGObjCObjFW(CGM);
2882
John McCall5fb5df92012-06-20 06:18:46 +00002883 case ObjCRuntime::FragileMacOSX:
2884 case ObjCRuntime::MacOSX:
2885 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +00002886 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +00002887 llvm_unreachable("these runtimes are not GNU runtimes");
2888 }
2889 llvm_unreachable("bad runtime");
Chris Lattnerb7256cd2008-03-01 08:50:34 +00002890}