blob: 1580c777ea4799cc8cb0f33d955adc20d6d46546 [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"
Chris Lattner87ab27d2008-06-26 04:19:03 +000021#include "clang/AST/ASTContext.h"
Daniel Dunbar221fa942008-08-11 04:54:23 +000022#include "clang/AST/Decl.h"
Daniel Dunbar89da6ad2008-08-13 00:59:25 +000023#include "clang/AST/DeclObjC.h"
Anders Carlsson15b73de2009-07-18 19:43:29 +000024#include "clang/AST/RecordLayout.h"
Chris Lattnerf0b64d72009-04-26 01:32:48 +000025#include "clang/AST/StmtObjC.h"
David Chisnalld7972f52011-03-23 16:36:54 +000026#include "clang/Basic/FileManager.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000027#include "clang/Basic/SourceManager.h"
Chris Lattnerb7256cd2008-03-01 08:50:34 +000028#include "llvm/ADT/SmallVector.h"
Anton Korobeynikov1200aca2008-06-01 14:13:53 +000029#include "llvm/ADT/StringMap.h"
Chandler Carruthc80ceea2014-03-04 11:02:08 +000030#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000031#include "llvm/IR/DataLayout.h"
32#include "llvm/IR/Intrinsics.h"
33#include "llvm/IR/LLVMContext.h"
34#include "llvm/IR/Module.h"
Daniel Dunbar92992502008-08-15 22:20:32 +000035#include "llvm/Support/Compiler.h"
Chris Lattner0e62c1c2011-07-23 10:55:15 +000036#include <cstdarg>
Chris Lattner8d3f4a42009-01-27 05:06:01 +000037
38
Chris Lattner87ab27d2008-06-26 04:19:03 +000039using namespace clang;
Daniel Dunbar41cf9de2008-09-09 01:06:48 +000040using namespace CodeGen;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +000041
Chris Lattnerb7256cd2008-03-01 08:50:34 +000042
Chris Lattnerb7256cd2008-03-01 08:50:34 +000043namespace {
David Chisnall34d00052011-03-26 11:48:37 +000044/// Class that lazily initialises the runtime function. Avoids inserting the
45/// types and the function declaration into a module if they're not used, and
46/// avoids constructing the type more than once if it's used more than once.
David Chisnalld7972f52011-03-23 16:36:54 +000047class LazyRuntimeFunction {
48 CodeGenModule *CGM;
David Blaikiebf178d32015-05-19 21:31:34 +000049 llvm::FunctionType *FTy;
David Chisnalld7972f52011-03-23 16:36:54 +000050 const char *FunctionName;
David Chisnall3fe89562011-05-23 22:33:28 +000051 llvm::Constant *Function;
David Blaikie7d9e7922015-05-18 22:51:39 +000052
53public:
54 /// Constructor leaves this class uninitialized, because it is intended to
55 /// be used as a field in another class and not all of the types that are
56 /// used as arguments will necessarily be available at construction time.
57 LazyRuntimeFunction()
Craig Topper8a13c412014-05-21 05:09:00 +000058 : CGM(nullptr), FunctionName(nullptr), Function(nullptr) {}
David Chisnalld7972f52011-03-23 16:36:54 +000059
David Blaikie7d9e7922015-05-18 22:51:39 +000060 /// Initialises the lazy function with the name, return type, and the types
61 /// of the arguments.
62 LLVM_END_WITH_NULL
63 void init(CodeGenModule *Mod, const char *name, llvm::Type *RetTy, ...) {
64 CGM = Mod;
65 FunctionName = name;
66 Function = nullptr;
David Blaikiebf178d32015-05-19 21:31:34 +000067 std::vector<llvm::Type *> ArgTys;
David Blaikie7d9e7922015-05-18 22:51:39 +000068 va_list Args;
69 va_start(Args, RetTy);
70 while (llvm::Type *ArgTy = va_arg(Args, llvm::Type *))
71 ArgTys.push_back(ArgTy);
72 va_end(Args);
David Blaikiebf178d32015-05-19 21:31:34 +000073 FTy = llvm::FunctionType::get(RetTy, ArgTys, false);
David Blaikie7d9e7922015-05-18 22:51:39 +000074 }
David Blaikiebf178d32015-05-19 21:31:34 +000075
76 llvm::FunctionType *getType() { return FTy; }
77
David Blaikie7d9e7922015-05-18 22:51:39 +000078 /// Overloaded cast operator, allows the class to be implicitly cast to an
79 /// LLVM constant.
80 operator llvm::Constant *() {
81 if (!Function) {
82 if (!FunctionName)
83 return nullptr;
David Blaikie7d9e7922015-05-18 22:51:39 +000084 Function =
85 cast<llvm::Constant>(CGM->CreateRuntimeFunction(FTy, FunctionName));
David Blaikie7d9e7922015-05-18 22:51:39 +000086 }
87 return Function;
88 }
89 operator llvm::Function *() {
90 return cast<llvm::Function>((llvm::Constant *)*this);
91 }
David Chisnalld7972f52011-03-23 16:36:54 +000092};
93
94
David Chisnall34d00052011-03-26 11:48:37 +000095/// GNU Objective-C runtime code generation. This class implements the parts of
John McCall775086e2012-07-12 02:07:58 +000096/// Objective-C support that are specific to the GNU family of runtimes (GCC,
97/// GNUstep and ObjFW).
David Chisnalld7972f52011-03-23 16:36:54 +000098class CGObjCGNU : public CGObjCRuntime {
David Chisnall76803412011-03-23 22:52:06 +000099protected:
David Chisnall34d00052011-03-26 11:48:37 +0000100 /// The LLVM module into which output is inserted
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000101 llvm::Module &TheModule;
David Chisnall34d00052011-03-26 11:48:37 +0000102 /// strut objc_super. Used for sending messages to super. This structure
103 /// contains the receiver (object) and the expected class.
Chris Lattner2192fe52011-07-18 04:24:23 +0000104 llvm::StructType *ObjCSuperTy;
David Chisnall34d00052011-03-26 11:48:37 +0000105 /// struct objc_super*. The type of the argument to the superclass message
106 /// lookup functions.
Chris Lattner2192fe52011-07-18 04:24:23 +0000107 llvm::PointerType *PtrToObjCSuperTy;
David Chisnall34d00052011-03-26 11:48:37 +0000108 /// LLVM type for selectors. Opaque pointer (i8*) unless a header declaring
109 /// SEL is included in a header somewhere, in which case it will be whatever
110 /// type is declared in that header, most likely {i8*, i8*}.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000111 llvm::PointerType *SelectorTy;
David Chisnall34d00052011-03-26 11:48:37 +0000112 /// LLVM i8 type. Cached here to avoid repeatedly getting it in all of the
113 /// places where it's used
Chris Lattner2192fe52011-07-18 04:24:23 +0000114 llvm::IntegerType *Int8Ty;
David Chisnall34d00052011-03-26 11:48:37 +0000115 /// Pointer to i8 - LLVM type of char*, for all of the places where the
116 /// runtime needs to deal with C strings.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000117 llvm::PointerType *PtrToInt8Ty;
David Chisnall34d00052011-03-26 11:48:37 +0000118 /// Instance Method Pointer type. This is a pointer to a function that takes,
119 /// at a minimum, an object and a selector, and is the generic type for
120 /// Objective-C methods. Due to differences between variadic / non-variadic
121 /// calling conventions, it must always be cast to the correct type before
122 /// actually being used.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000123 llvm::PointerType *IMPTy;
David Chisnall34d00052011-03-26 11:48:37 +0000124 /// Type of an untyped Objective-C object. Clang treats id as a built-in type
125 /// when compiling Objective-C code, so this may be an opaque pointer (i8*),
126 /// but if the runtime header declaring it is included then it may be a
127 /// pointer to a structure.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000128 llvm::PointerType *IdTy;
David Chisnall34d00052011-03-26 11:48:37 +0000129 /// Pointer to a pointer to an Objective-C object. Used in the new ABI
130 /// message lookup function and some GC-related functions.
Chris Lattner2192fe52011-07-18 04:24:23 +0000131 llvm::PointerType *PtrToIdTy;
David Chisnall34d00052011-03-26 11:48:37 +0000132 /// The clang type of id. Used when using the clang CGCall infrastructure to
133 /// call Objective-C methods.
John McCall2da83a32010-02-26 00:48:12 +0000134 CanQualType ASTIdTy;
David Chisnall34d00052011-03-26 11:48:37 +0000135 /// LLVM type for C int type.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000136 llvm::IntegerType *IntTy;
David Chisnall34d00052011-03-26 11:48:37 +0000137 /// LLVM type for an opaque pointer. This is identical to PtrToInt8Ty, but is
138 /// used in the code to document the difference between i8* meaning a pointer
139 /// to a C string and i8* meaning a pointer to some opaque type.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000140 llvm::PointerType *PtrTy;
David Chisnall34d00052011-03-26 11:48:37 +0000141 /// LLVM type for C long type. The runtime uses this in a lot of places where
142 /// it should be using intptr_t, but we can't fix this without breaking
143 /// compatibility with GCC...
Jay Foad7c57be32011-07-11 09:56:20 +0000144 llvm::IntegerType *LongTy;
David Chisnall34d00052011-03-26 11:48:37 +0000145 /// LLVM type for C size_t. Used in various runtime data structures.
Chris Lattner2192fe52011-07-18 04:24:23 +0000146 llvm::IntegerType *SizeTy;
David Chisnalle0dc7cb2011-10-08 08:54:36 +0000147 /// LLVM type for C intptr_t.
148 llvm::IntegerType *IntPtrTy;
David Chisnall34d00052011-03-26 11:48:37 +0000149 /// LLVM type for C ptrdiff_t. Mainly used in property accessor functions.
Chris Lattner2192fe52011-07-18 04:24:23 +0000150 llvm::IntegerType *PtrDiffTy;
David Chisnall34d00052011-03-26 11:48:37 +0000151 /// LLVM type for C int*. Used for GCC-ABI-compatible non-fragile instance
152 /// variables.
Chris Lattner2192fe52011-07-18 04:24:23 +0000153 llvm::PointerType *PtrToIntTy;
David Chisnall34d00052011-03-26 11:48:37 +0000154 /// LLVM type for Objective-C BOOL type.
Chris Lattner2192fe52011-07-18 04:24:23 +0000155 llvm::Type *BoolTy;
David Chisnallcdd207e2011-10-04 15:35:30 +0000156 /// 32-bit integer type, to save us needing to look it up every time it's used.
157 llvm::IntegerType *Int32Ty;
158 /// 64-bit integer type, to save us needing to look it up every time it's used.
159 llvm::IntegerType *Int64Ty;
David Chisnall34d00052011-03-26 11:48:37 +0000160 /// Metadata kind used to tie method lookups to message sends. The GNUstep
161 /// runtime provides some LLVM passes that can use this to do things like
162 /// automatic IMP caching and speculative inlining.
David Chisnall76803412011-03-23 22:52:06 +0000163 unsigned msgSendMDKind;
David Chisnall34d00052011-03-26 11:48:37 +0000164 /// Helper function that generates a constant string and returns a pointer to
165 /// the start of the string. The result of this function can be used anywhere
166 /// where the C code specifies const char*.
David Chisnalld3858d62011-03-25 11:57:33 +0000167 llvm::Constant *MakeConstantString(const std::string &Str,
168 const std::string &Name="") {
David Blaikiee3b172a2015-04-02 18:55:21 +0000169 auto *ConstStr = CGM.GetAddrOfConstantCString(Str, Name.c_str());
170 return llvm::ConstantExpr::getGetElementPtr(ConstStr->getValueType(),
171 ConstStr, Zeros);
David Chisnalld3858d62011-03-25 11:57:33 +0000172 }
David Chisnall34d00052011-03-26 11:48:37 +0000173 /// Emits a linkonce_odr string, whose name is the prefix followed by the
174 /// string value. This allows the linker to combine the strings between
175 /// different modules. Used for EH typeinfo names, selector strings, and a
176 /// few other things.
David Chisnalld3858d62011-03-25 11:57:33 +0000177 llvm::Constant *ExportUniqueString(const std::string &Str,
178 const std::string prefix) {
179 std::string name = prefix + Str;
David Blaikiee3b172a2015-04-02 18:55:21 +0000180 auto *ConstStr = TheModule.getGlobalVariable(name);
David Chisnalld3858d62011-03-25 11:57:33 +0000181 if (!ConstStr) {
Chris Lattner9c818332012-02-05 02:30:40 +0000182 llvm::Constant *value = llvm::ConstantDataArray::getString(VMContext,Str);
David Chisnalld3858d62011-03-25 11:57:33 +0000183 ConstStr = new llvm::GlobalVariable(TheModule, value->getType(), true,
184 llvm::GlobalValue::LinkOnceODRLinkage, value, prefix + Str);
185 }
David Blaikiee3b172a2015-04-02 18:55:21 +0000186 return llvm::ConstantExpr::getGetElementPtr(ConstStr->getValueType(),
187 ConstStr, Zeros);
David Chisnalld3858d62011-03-25 11:57:33 +0000188 }
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.
Chris Lattner2192fe52011-07-18 04:24:23 +0000192 llvm::GlobalVariable *MakeGlobal(llvm::StructType *Ty,
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000193 ArrayRef<llvm::Constant *> V,
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) {
197 llvm::Constant *C = llvm::ConstantStruct::get(Ty, V);
198 return new llvm::GlobalVariable(TheModule, Ty, false,
199 linkage, C, Name);
200 }
David Chisnall34d00052011-03-26 11:48:37 +0000201 /// Generates a global array. The vector must contain the same number of
202 /// elements that the array type declares, of the type specified as the array
203 /// element type.
Chris Lattner2192fe52011-07-18 04:24:23 +0000204 llvm::GlobalVariable *MakeGlobal(llvm::ArrayType *Ty,
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000205 ArrayRef<llvm::Constant *> V,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000206 StringRef Name="",
David Chisnalld3858d62011-03-25 11:57:33 +0000207 llvm::GlobalValue::LinkageTypes linkage
208 =llvm::GlobalValue::InternalLinkage) {
209 llvm::Constant *C = llvm::ConstantArray::get(Ty, V);
210 return new llvm::GlobalVariable(TheModule, Ty, false,
211 linkage, C, Name);
212 }
David Chisnall34d00052011-03-26 11:48:37 +0000213 /// Generates a global array, inferring the array type from the specified
214 /// element type and the size of the initialiser.
Chris Lattner2192fe52011-07-18 04:24:23 +0000215 llvm::GlobalVariable *MakeGlobalArray(llvm::Type *Ty,
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000216 ArrayRef<llvm::Constant *> V,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000217 StringRef Name="",
David Chisnalld3858d62011-03-25 11:57:33 +0000218 llvm::GlobalValue::LinkageTypes linkage
219 =llvm::GlobalValue::InternalLinkage) {
220 llvm::ArrayType *ArrayTy = llvm::ArrayType::get(Ty, V.size());
221 return MakeGlobal(ArrayTy, V, Name, linkage);
222 }
David Chisnalla5f59412012-10-16 15:11:55 +0000223 /// Returns a property name and encoding string.
224 llvm::Constant *MakePropertyEncodingString(const ObjCPropertyDecl *PD,
225 const Decl *Container) {
David Chisnallbeb80132013-02-28 13:59:29 +0000226 const ObjCRuntime &R = CGM.getLangOpts().ObjCRuntime;
David Chisnalla5f59412012-10-16 15:11:55 +0000227 if ((R.getKind() == ObjCRuntime::GNUstep) &&
228 (R.getVersion() >= VersionTuple(1, 6))) {
229 std::string NameAndAttributes;
230 std::string TypeStr;
231 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container, TypeStr);
232 NameAndAttributes += '\0';
233 NameAndAttributes += TypeStr.length() + 3;
234 NameAndAttributes += TypeStr;
235 NameAndAttributes += '\0';
236 NameAndAttributes += PD->getNameAsString();
David Blaikiee3b172a2015-04-02 18:55:21 +0000237 auto *ConstStr = CGM.GetAddrOfConstantCString(NameAndAttributes);
238 return llvm::ConstantExpr::getGetElementPtr(ConstStr->getValueType(),
239 ConstStr, Zeros);
David Chisnalla5f59412012-10-16 15:11:55 +0000240 }
241 return MakeConstantString(PD->getNameAsString());
242 }
David Chisnallbeb80132013-02-28 13:59:29 +0000243 /// Push the property attributes into two structure fields.
244 void PushPropertyAttributes(std::vector<llvm::Constant*> &Fields,
245 ObjCPropertyDecl *property, bool isSynthesized=true, bool
246 isDynamic=true) {
247 int attrs = property->getPropertyAttributes();
248 // For read-only properties, clear the copy and retain flags
249 if (attrs & ObjCPropertyDecl::OBJC_PR_readonly) {
250 attrs &= ~ObjCPropertyDecl::OBJC_PR_copy;
251 attrs &= ~ObjCPropertyDecl::OBJC_PR_retain;
252 attrs &= ~ObjCPropertyDecl::OBJC_PR_weak;
253 attrs &= ~ObjCPropertyDecl::OBJC_PR_strong;
254 }
255 // The first flags field has the same attribute values as clang uses internally
256 Fields.push_back(llvm::ConstantInt::get(Int8Ty, attrs & 0xff));
257 attrs >>= 8;
258 attrs <<= 2;
259 // For protocol properties, synthesized and dynamic have no meaning, so we
260 // reuse these flags to indicate that this is a protocol property (both set
261 // has no meaning, as a property can't be both synthesized and dynamic)
262 attrs |= isSynthesized ? (1<<0) : 0;
263 attrs |= isDynamic ? (1<<1) : 0;
264 // The second field is the next four fields left shifted by two, with the
265 // low bit set to indicate whether the field is synthesized or dynamic.
266 Fields.push_back(llvm::ConstantInt::get(Int8Ty, attrs & 0xff));
267 // Two padding fields
268 Fields.push_back(llvm::ConstantInt::get(Int8Ty, 0));
269 Fields.push_back(llvm::ConstantInt::get(Int8Ty, 0));
270 }
David Chisnall34d00052011-03-26 11:48:37 +0000271 /// Ensures that the value has the required type, by inserting a bitcast if
272 /// required. This function lets us avoid inserting bitcasts that are
273 /// redundant.
John McCall882987f2013-02-28 19:01:20 +0000274 llvm::Value* EnforceType(CGBuilderTy &B, llvm::Value *V, llvm::Type *Ty) {
David Chisnall76803412011-03-23 22:52:06 +0000275 if (V->getType() == Ty) return V;
276 return B.CreateBitCast(V, Ty);
277 }
278 // Some zeros used for GEPs in lots of places.
279 llvm::Constant *Zeros[2];
David Chisnall34d00052011-03-26 11:48:37 +0000280 /// Null pointer value. Mainly used as a terminator in various arrays.
David Chisnall76803412011-03-23 22:52:06 +0000281 llvm::Constant *NULLPtr;
David Chisnall34d00052011-03-26 11:48:37 +0000282 /// LLVM context.
David Chisnall76803412011-03-23 22:52:06 +0000283 llvm::LLVMContext &VMContext;
284private:
David Chisnall34d00052011-03-26 11:48:37 +0000285 /// Placeholder for the class. Lots of things refer to the class before we've
286 /// actually emitted it. We use this alias as a placeholder, and then replace
287 /// it with a pointer to the class structure before finally emitting the
288 /// module.
Daniel Dunbar566421c2009-05-04 15:31:17 +0000289 llvm::GlobalAlias *ClassPtrAlias;
David Chisnall34d00052011-03-26 11:48:37 +0000290 /// Placeholder for the metaclass. Lots of things refer to the class before
291 /// we've / actually emitted it. We use this alias as a placeholder, and then
292 /// replace / it with a pointer to the metaclass structure before finally
293 /// emitting the / module.
Daniel Dunbar566421c2009-05-04 15:31:17 +0000294 llvm::GlobalAlias *MetaClassPtrAlias;
David Chisnall34d00052011-03-26 11:48:37 +0000295 /// All of the classes that have been generated for this compilation units.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000296 std::vector<llvm::Constant*> Classes;
David Chisnall34d00052011-03-26 11:48:37 +0000297 /// All of the categories that have been generated for this compilation units.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000298 std::vector<llvm::Constant*> Categories;
David Chisnall34d00052011-03-26 11:48:37 +0000299 /// All of the Objective-C constant strings that have been generated for this
300 /// compilation units.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000301 std::vector<llvm::Constant*> ConstantStrings;
David Chisnall34d00052011-03-26 11:48:37 +0000302 /// Map from string values to Objective-C constant strings in the output.
303 /// Used to prevent emitting Objective-C strings more than once. This should
304 /// not be required at all - CodeGenModule should manage this list.
David Chisnall358e7512010-01-27 12:49:23 +0000305 llvm::StringMap<llvm::Constant*> ObjCStrings;
David Chisnall34d00052011-03-26 11:48:37 +0000306 /// All of the protocols that have been declared.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000307 llvm::StringMap<llvm::Constant*> ExistingProtocols;
David Chisnall34d00052011-03-26 11:48:37 +0000308 /// For each variant of a selector, we store the type encoding and a
309 /// placeholder value. For an untyped selector, the type will be the empty
310 /// string. Selector references are all done via the module's selector table,
311 /// so we create an alias as a placeholder and then replace it with the real
312 /// value later.
David Chisnalld7972f52011-03-23 16:36:54 +0000313 typedef std::pair<std::string, llvm::GlobalAlias*> TypedSelector;
David Chisnall34d00052011-03-26 11:48:37 +0000314 /// Type of the selector map. This is roughly equivalent to the structure
315 /// used in the GNUstep runtime, which maintains a list of all of the valid
316 /// types for a selector in a table.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000317 typedef llvm::DenseMap<Selector, SmallVector<TypedSelector, 2> >
David Chisnalld7972f52011-03-23 16:36:54 +0000318 SelectorMap;
David Chisnall34d00052011-03-26 11:48:37 +0000319 /// A map from selectors to selector types. This allows us to emit all
320 /// selectors of the same name and type together.
David Chisnalld7972f52011-03-23 16:36:54 +0000321 SelectorMap SelectorTable;
322
David Chisnall34d00052011-03-26 11:48:37 +0000323 /// Selectors related to memory management. When compiling in GC mode, we
324 /// omit these.
David Chisnall5bb4efd2010-02-03 15:59:02 +0000325 Selector RetainSel, ReleaseSel, AutoreleaseSel;
David Chisnall34d00052011-03-26 11:48:37 +0000326 /// Runtime functions used for memory management in GC mode. Note that clang
327 /// supports code generation for calling these functions, but neither GNU
328 /// runtime actually supports this API properly yet.
David Chisnalld7972f52011-03-23 16:36:54 +0000329 LazyRuntimeFunction IvarAssignFn, StrongCastAssignFn, MemMoveFn, WeakReadFn,
330 WeakAssignFn, GlobalAssignFn;
David Chisnalld7972f52011-03-23 16:36:54 +0000331
David Chisnall92d436b2012-01-31 18:59:20 +0000332 typedef std::pair<std::string, std::string> ClassAliasPair;
333 /// All classes that have aliases set for them.
334 std::vector<ClassAliasPair> ClassAliases;
335
David Chisnalld3858d62011-03-25 11:57:33 +0000336protected:
David Chisnall34d00052011-03-26 11:48:37 +0000337 /// Function used for throwing Objective-C exceptions.
David Chisnalld7972f52011-03-23 16:36:54 +0000338 LazyRuntimeFunction ExceptionThrowFn;
James Dennettb9199ee2012-06-13 22:07:09 +0000339 /// Function used for rethrowing exceptions, used at the end of \@finally or
340 /// \@synchronize blocks.
David Chisnalld3858d62011-03-25 11:57:33 +0000341 LazyRuntimeFunction ExceptionReThrowFn;
David Chisnall34d00052011-03-26 11:48:37 +0000342 /// Function called when entering a catch function. This is required for
343 /// differentiating Objective-C exceptions and foreign exceptions.
David Chisnalld3858d62011-03-25 11:57:33 +0000344 LazyRuntimeFunction EnterCatchFn;
David Chisnall34d00052011-03-26 11:48:37 +0000345 /// Function called when exiting from a catch block. Used to do exception
346 /// cleanup.
David Chisnalld3858d62011-03-25 11:57:33 +0000347 LazyRuntimeFunction ExitCatchFn;
James Dennettb9199ee2012-06-13 22:07:09 +0000348 /// Function called when entering an \@synchronize block. Acquires the lock.
David Chisnalld7972f52011-03-23 16:36:54 +0000349 LazyRuntimeFunction SyncEnterFn;
James Dennettb9199ee2012-06-13 22:07:09 +0000350 /// Function called when exiting an \@synchronize block. Releases the lock.
David Chisnalld7972f52011-03-23 16:36:54 +0000351 LazyRuntimeFunction SyncExitFn;
352
David Chisnalld3858d62011-03-25 11:57:33 +0000353private:
354
David Chisnall34d00052011-03-26 11:48:37 +0000355 /// Function called if fast enumeration detects that the collection is
356 /// modified during the update.
David Chisnalld7972f52011-03-23 16:36:54 +0000357 LazyRuntimeFunction EnumerationMutationFn;
David Chisnall34d00052011-03-26 11:48:37 +0000358 /// Function for implementing synthesized property getters that return an
359 /// object.
David Chisnalld7972f52011-03-23 16:36:54 +0000360 LazyRuntimeFunction GetPropertyFn;
David Chisnall34d00052011-03-26 11:48:37 +0000361 /// Function for implementing synthesized property setters that return an
362 /// object.
David Chisnalld7972f52011-03-23 16:36:54 +0000363 LazyRuntimeFunction SetPropertyFn;
David Chisnall34d00052011-03-26 11:48:37 +0000364 /// Function used for non-object declared property getters.
David Chisnalld7972f52011-03-23 16:36:54 +0000365 LazyRuntimeFunction GetStructPropertyFn;
David Chisnall34d00052011-03-26 11:48:37 +0000366 /// Function used for non-object declared property setters.
David Chisnalld7972f52011-03-23 16:36:54 +0000367 LazyRuntimeFunction SetStructPropertyFn;
368
David Chisnall34d00052011-03-26 11:48:37 +0000369 /// The version of the runtime that this class targets. Must match the
370 /// version in the runtime.
David Chisnall5c511772011-05-22 22:37:08 +0000371 int RuntimeVersion;
David Chisnall34d00052011-03-26 11:48:37 +0000372 /// The version of the protocol class. Used to differentiate between ObjC1
373 /// and ObjC2 protocols. Objective-C 1 protocols can not contain optional
374 /// components and can not contain declared properties. We always emit
375 /// Objective-C 2 property structures, but we have to pretend that they're
376 /// Objective-C 1 property structures when targeting the GCC runtime or it
377 /// will abort.
David Chisnalld7972f52011-03-23 16:36:54 +0000378 const int ProtocolVersion;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000379private:
David Chisnall34d00052011-03-26 11:48:37 +0000380 /// Generates an instance variable list structure. This is a structure
381 /// containing a size and an array of structures containing instance variable
382 /// metadata. This is used purely for introspection in the fragile ABI. In
383 /// the non-fragile ABI, it's used for instance variable fixup.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000384 llvm::Constant *GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
385 ArrayRef<llvm::Constant *> IvarTypes,
386 ArrayRef<llvm::Constant *> IvarOffsets);
David Chisnall34d00052011-03-26 11:48:37 +0000387 /// Generates a method list structure. This is a structure containing a size
388 /// and an array of structures containing method metadata.
389 ///
390 /// This structure is used by both classes and categories, and contains a next
391 /// pointer allowing them to be chained together in a linked list.
Craig Topperbf3e3272014-08-30 16:55:52 +0000392 llvm::Constant *GenerateMethodList(StringRef ClassName,
393 StringRef CategoryName,
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000394 ArrayRef<Selector> MethodSels,
395 ArrayRef<llvm::Constant *> MethodTypes,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000396 bool isClassMethodList);
James Dennettb9199ee2012-06-13 22:07:09 +0000397 /// Emits an empty protocol. This is used for \@protocol() where no protocol
David Chisnall34d00052011-03-26 11:48:37 +0000398 /// is found. The runtime will (hopefully) fix up the pointer to refer to the
399 /// real protocol.
Fariborz Jahanian89d23972009-03-31 18:27:22 +0000400 llvm::Constant *GenerateEmptyProtocol(const std::string &ProtocolName);
David Chisnall34d00052011-03-26 11:48:37 +0000401 /// Generates a list of property metadata structures. This follows the same
402 /// pattern as method and instance variable metadata lists.
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000403 llvm::Constant *GeneratePropertyList(const ObjCImplementationDecl *OID,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000404 SmallVectorImpl<Selector> &InstanceMethodSels,
405 SmallVectorImpl<llvm::Constant*> &InstanceMethodTypes);
David Chisnall34d00052011-03-26 11:48:37 +0000406 /// Generates a list of referenced protocols. Classes, categories, and
407 /// protocols all use this structure.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000408 llvm::Constant *GenerateProtocolList(ArrayRef<std::string> Protocols);
David Chisnall34d00052011-03-26 11:48:37 +0000409 /// To ensure that all protocols are seen by the runtime, we add a category on
410 /// a class defined in the runtime, declaring no methods, but adopting the
411 /// protocols. This is a horribly ugly hack, but it allows us to collect all
412 /// of the protocols without changing the ABI.
Dmitri Gribenkob2aa9232012-11-15 14:28:07 +0000413 void GenerateProtocolHolderCategory();
David Chisnall34d00052011-03-26 11:48:37 +0000414 /// Generates a class structure.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000415 llvm::Constant *GenerateClassStructure(
416 llvm::Constant *MetaClass,
417 llvm::Constant *SuperClass,
418 unsigned info,
Chris Lattnerda35bc82008-06-26 04:47:04 +0000419 const char *Name,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000420 llvm::Constant *Version,
421 llvm::Constant *InstanceSize,
422 llvm::Constant *IVars,
423 llvm::Constant *Methods,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000424 llvm::Constant *Protocols,
425 llvm::Constant *IvarOffsets,
David Chisnalld472c852010-04-28 14:29:56 +0000426 llvm::Constant *Properties,
David Chisnallcdd207e2011-10-04 15:35:30 +0000427 llvm::Constant *StrongIvarBitmap,
428 llvm::Constant *WeakIvarBitmap,
David Chisnalld472c852010-04-28 14:29:56 +0000429 bool isMeta=false);
David Chisnall34d00052011-03-26 11:48:37 +0000430 /// Generates a method list. This is used by protocols to define the required
431 /// and optional methods.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000432 llvm::Constant *GenerateProtocolMethodList(
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000433 ArrayRef<llvm::Constant *> MethodNames,
434 ArrayRef<llvm::Constant *> MethodTypes);
David Chisnall34d00052011-03-26 11:48:37 +0000435 /// Returns a selector with the specified type encoding. An empty string is
436 /// used to return an untyped selector (with the types field set to NULL).
John McCall882987f2013-02-28 19:01:20 +0000437 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel,
David Chisnalld7972f52011-03-23 16:36:54 +0000438 const std::string &TypeEncoding, bool lval);
David Chisnall34d00052011-03-26 11:48:37 +0000439 /// Returns the variable used to store the offset of an instance variable.
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +0000440 llvm::GlobalVariable *ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
441 const ObjCIvarDecl *Ivar);
David Chisnall34d00052011-03-26 11:48:37 +0000442 /// Emits a reference to a class. This allows the linker to object if there
443 /// is no class of the matching name.
John McCall775086e2012-07-12 02:07:58 +0000444protected:
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000445 void EmitClassRef(const std::string &className);
David Chisnall920e83b2011-06-29 13:16:41 +0000446 /// Emits a pointer to the named class
John McCall882987f2013-02-28 19:01:20 +0000447 virtual llvm::Value *GetClassNamed(CodeGenFunction &CGF,
John McCall775086e2012-07-12 02:07:58 +0000448 const std::string &Name, bool isWeak);
David Chisnall34d00052011-03-26 11:48:37 +0000449 /// Looks up the method for sending a message to the specified object. This
450 /// mechanism differs between the GCC and GNU runtimes, so this method must be
451 /// overridden in subclasses.
David Chisnall76803412011-03-23 22:52:06 +0000452 virtual llvm::Value *LookupIMP(CodeGenFunction &CGF,
453 llvm::Value *&Receiver,
454 llvm::Value *cmd,
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000455 llvm::MDNode *node,
456 MessageSendInfo &MSI) = 0;
David Chisnallcdd207e2011-10-04 15:35:30 +0000457 /// Looks up the method for sending a message to a superclass. This
458 /// mechanism differs between the GCC and GNU runtimes, so this method must
459 /// be overridden in subclasses.
David Chisnall76803412011-03-23 22:52:06 +0000460 virtual llvm::Value *LookupIMPSuper(CodeGenFunction &CGF,
461 llvm::Value *ObjCSuper,
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000462 llvm::Value *cmd,
463 MessageSendInfo &MSI) = 0;
David Chisnallcdd207e2011-10-04 15:35:30 +0000464 /// Libobjc2 uses a bitfield representation where small(ish) bitfields are
465 /// stored in a 64-bit value with the low bit set to 1 and the remaining 63
466 /// bits set to their values, LSB first, while larger ones are stored in a
467 /// structure of this / form:
468 ///
469 /// struct { int32_t length; int32_t values[length]; };
470 ///
471 /// The values in the array are stored in host-endian format, with the least
472 /// significant bit being assumed to come first in the bitfield. Therefore,
473 /// a bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] },
474 /// while a bitfield / with the 63rd bit set will be 1<<64.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000475 llvm::Constant *MakeBitField(ArrayRef<bool> bits);
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
Craig Topper4f12f102014-03-12 06:41:41 +0000480 llvm::Constant *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;
497 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel,
498 bool lval = false) override;
499 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,
530 llvm::Value *AddrWeakObj) override;
531 void EmitObjCWeakAssign(CodeGenFunction &CGF,
532 llvm::Value *src, llvm::Value *dst) override;
533 void EmitObjCGlobalAssign(CodeGenFunction &CGF,
534 llvm::Value *src, llvm::Value *dest,
535 bool threadlocal=false) override;
536 void EmitObjCIvarAssign(CodeGenFunction &CGF, llvm::Value *src,
537 llvm::Value *dest, llvm::Value *ivarOffset) override;
538 void EmitObjCStrongCastAssign(CodeGenFunction &CGF,
539 llvm::Value *src, llvm::Value *dest) override;
540 void EmitGCMemmoveCollectable(CodeGenFunction &CGF, llvm::Value *DestPtr,
541 llvm::Value *SrcPtr,
542 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 }
Rafael Espindola554256c2014-02-26 22:25:45 +0000562
563 llvm::GlobalVariable *GetClassGlobal(const std::string &Name,
Craig Toppera798a9d2014-03-02 09:32:10 +0000564 bool Weak = false) override {
Craig Topper8a13c412014-05-21 05:09:00 +0000565 return nullptr;
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +0000566 }
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000567};
David Chisnall34d00052011-03-26 11:48:37 +0000568/// Class representing the legacy GCC Objective-C ABI. This is the default when
569/// -fobjc-nonfragile-abi is not specified.
570///
571/// The GCC ABI target actually generates code that is approximately compatible
572/// with the new GNUstep runtime ABI, but refrains from using any features that
573/// would not work with the GCC runtime. For example, clang always generates
574/// the extended form of the class structure, and the extra fields are simply
575/// ignored by GCC libobjc.
David Chisnalld7972f52011-03-23 16:36:54 +0000576class CGObjCGCC : public CGObjCGNU {
David Chisnall34d00052011-03-26 11:48:37 +0000577 /// The GCC ABI message lookup function. Returns an IMP pointing to the
578 /// method implementation for this message.
David Chisnall76803412011-03-23 22:52:06 +0000579 LazyRuntimeFunction MsgLookupFn;
David Chisnall34d00052011-03-26 11:48:37 +0000580 /// The GCC ABI superclass message lookup function. Takes a pointer to a
581 /// structure describing the receiver and the class, and a selector as
582 /// arguments. Returns the IMP for the corresponding method.
David Chisnall76803412011-03-23 22:52:06 +0000583 LazyRuntimeFunction MsgLookupSuperFn;
584protected:
Craig Topper4f12f102014-03-12 06:41:41 +0000585 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
586 llvm::Value *cmd, llvm::MDNode *node,
587 MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000588 CGBuilderTy &Builder = CGF.Builder;
David Chisnall0cc83e72011-10-28 17:55:06 +0000589 llvm::Value *args[] = {
David Chisnall76803412011-03-23 22:52:06 +0000590 EnforceType(Builder, Receiver, IdTy),
David Chisnall0cc83e72011-10-28 17:55:06 +0000591 EnforceType(Builder, cmd, SelectorTy) };
John McCall882987f2013-02-28 19:01:20 +0000592 llvm::CallSite imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFn, args);
David Chisnall0cc83e72011-10-28 17:55:06 +0000593 imp->setMetadata(msgSendMDKind, node);
594 return imp.getInstruction();
David Chisnall76803412011-03-23 22:52:06 +0000595 }
Craig Topper4f12f102014-03-12 06:41:41 +0000596 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, llvm::Value *ObjCSuper,
597 llvm::Value *cmd, MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000598 CGBuilderTy &Builder = CGF.Builder;
599 llvm::Value *lookupArgs[] = {EnforceType(Builder, ObjCSuper,
600 PtrToObjCSuperTy), cmd};
John McCall882987f2013-02-28 19:01:20 +0000601 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
David Chisnall76803412011-03-23 22:52:06 +0000602 }
David Chisnalld7972f52011-03-23 16:36:54 +0000603 public:
David Chisnall76803412011-03-23 22:52:06 +0000604 CGObjCGCC(CodeGenModule &Mod) : CGObjCGNU(Mod, 8, 2) {
605 // IMP objc_msg_lookup(id, SEL);
Craig Topper8a13c412014-05-21 05:09:00 +0000606 MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy,
607 nullptr);
David Chisnall76803412011-03-23 22:52:06 +0000608 // IMP objc_msg_lookup_super(struct objc_super*, SEL);
609 MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000610 PtrToObjCSuperTy, SelectorTy, nullptr);
David Chisnall76803412011-03-23 22:52:06 +0000611 }
David Chisnalld7972f52011-03-23 16:36:54 +0000612};
David Chisnall34d00052011-03-26 11:48:37 +0000613/// Class used when targeting the new GNUstep runtime ABI.
David Chisnalld7972f52011-03-23 16:36:54 +0000614class CGObjCGNUstep : public CGObjCGNU {
David Chisnall34d00052011-03-26 11:48:37 +0000615 /// The slot lookup function. Returns a pointer to a cacheable structure
616 /// that contains (among other things) the IMP.
David Chisnall76803412011-03-23 22:52:06 +0000617 LazyRuntimeFunction SlotLookupFn;
David Chisnall34d00052011-03-26 11:48:37 +0000618 /// The GNUstep ABI superclass message lookup function. Takes a pointer to
619 /// a structure describing the receiver and the class, and a selector as
620 /// arguments. Returns the slot for the corresponding method. Superclass
621 /// message lookup rarely changes, so this is a good caching opportunity.
David Chisnall76803412011-03-23 22:52:06 +0000622 LazyRuntimeFunction SlotLookupSuperFn;
David Chisnall0d75e062012-12-17 18:54:24 +0000623 /// Specialised function for setting atomic retain properties
624 LazyRuntimeFunction SetPropertyAtomic;
625 /// Specialised function for setting atomic copy properties
626 LazyRuntimeFunction SetPropertyAtomicCopy;
627 /// Specialised function for setting nonatomic retain properties
628 LazyRuntimeFunction SetPropertyNonAtomic;
629 /// Specialised function for setting nonatomic copy properties
630 LazyRuntimeFunction SetPropertyNonAtomicCopy;
631 /// Function to perform atomic copies of C++ objects with nontrivial copy
632 /// constructors from Objective-C ivars.
633 LazyRuntimeFunction CxxAtomicObjectGetFn;
634 /// Function to perform atomic copies of C++ objects with nontrivial copy
635 /// constructors to Objective-C ivars.
636 LazyRuntimeFunction CxxAtomicObjectSetFn;
David Chisnall34d00052011-03-26 11:48:37 +0000637 /// Type of an slot structure pointer. This is returned by the various
638 /// lookup functions.
David Chisnall76803412011-03-23 22:52:06 +0000639 llvm::Type *SlotTy;
John McCallc31d8932012-11-14 09:08:34 +0000640 public:
Craig Topper4f12f102014-03-12 06:41:41 +0000641 llvm::Constant *GetEHType(QualType T) override;
David Chisnall76803412011-03-23 22:52:06 +0000642 protected:
Craig Topper4f12f102014-03-12 06:41:41 +0000643 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
644 llvm::Value *cmd, llvm::MDNode *node,
645 MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000646 CGBuilderTy &Builder = CGF.Builder;
647 llvm::Function *LookupFn = SlotLookupFn;
648
649 // Store the receiver on the stack so that we can reload it later
650 llvm::Value *ReceiverPtr = CGF.CreateTempAlloca(Receiver->getType());
651 Builder.CreateStore(Receiver, ReceiverPtr);
652
653 llvm::Value *self;
654
655 if (isa<ObjCMethodDecl>(CGF.CurCodeDecl)) {
656 self = CGF.LoadObjCSelf();
657 } else {
658 self = llvm::ConstantPointerNull::get(IdTy);
659 }
660
661 // The lookup function is guaranteed not to capture the receiver pointer.
662 LookupFn->setDoesNotCapture(1);
663
David Chisnall0cc83e72011-10-28 17:55:06 +0000664 llvm::Value *args[] = {
David Chisnall76803412011-03-23 22:52:06 +0000665 EnforceType(Builder, ReceiverPtr, PtrToIdTy),
666 EnforceType(Builder, cmd, SelectorTy),
David Chisnall0cc83e72011-10-28 17:55:06 +0000667 EnforceType(Builder, self, IdTy) };
John McCall882987f2013-02-28 19:01:20 +0000668 llvm::CallSite slot = CGF.EmitRuntimeCallOrInvoke(LookupFn, args);
David Chisnall0cc83e72011-10-28 17:55:06 +0000669 slot.setOnlyReadsMemory();
David Chisnall76803412011-03-23 22:52:06 +0000670 slot->setMetadata(msgSendMDKind, node);
671
672 // Load the imp from the slot
David Blaikie1ed728c2015-04-05 22:45:47 +0000673 llvm::Value *imp = Builder.CreateLoad(
674 Builder.CreateStructGEP(nullptr, slot.getInstruction(), 4));
David Chisnall76803412011-03-23 22:52:06 +0000675
676 // The lookup function may have changed the receiver, so make sure we use
677 // the new one.
678 Receiver = Builder.CreateLoad(ReceiverPtr, true);
679 return imp;
680 }
Craig Topper4f12f102014-03-12 06:41:41 +0000681 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, llvm::Value *ObjCSuper,
682 llvm::Value *cmd,
683 MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000684 CGBuilderTy &Builder = CGF.Builder;
685 llvm::Value *lookupArgs[] = {ObjCSuper, cmd};
686
John McCall882987f2013-02-28 19:01:20 +0000687 llvm::CallInst *slot =
688 CGF.EmitNounwindRuntimeCall(SlotLookupSuperFn, lookupArgs);
David Chisnall76803412011-03-23 22:52:06 +0000689 slot->setOnlyReadsMemory();
690
David Blaikie1ed728c2015-04-05 22:45:47 +0000691 return Builder.CreateLoad(Builder.CreateStructGEP(nullptr, slot, 4));
David Chisnall76803412011-03-23 22:52:06 +0000692 }
David Chisnalld7972f52011-03-23 16:36:54 +0000693 public:
David Chisnall76803412011-03-23 22:52:06 +0000694 CGObjCGNUstep(CodeGenModule &Mod) : CGObjCGNU(Mod, 9, 3) {
David Chisnallbeb80132013-02-28 13:59:29 +0000695 const ObjCRuntime &R = CGM.getLangOpts().ObjCRuntime;
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000696
Chris Lattner845511f2011-06-18 22:49:11 +0000697 llvm::StructType *SlotStructTy = llvm::StructType::get(PtrTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000698 PtrTy, PtrTy, IntTy, IMPTy, nullptr);
David Chisnall76803412011-03-23 22:52:06 +0000699 SlotTy = llvm::PointerType::getUnqual(SlotStructTy);
700 // Slot_t objc_msg_lookup_sender(id *receiver, SEL selector, id sender);
701 SlotLookupFn.init(&CGM, "objc_msg_lookup_sender", SlotTy, PtrToIdTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000702 SelectorTy, IdTy, nullptr);
David Chisnall76803412011-03-23 22:52:06 +0000703 // Slot_t objc_msg_lookup_super(struct objc_super*, SEL);
704 SlotLookupSuperFn.init(&CGM, "objc_slot_lookup_super", SlotTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000705 PtrToObjCSuperTy, SelectorTy, nullptr);
David Chisnalld3858d62011-03-25 11:57:33 +0000706 // If we're in ObjC++ mode, then we want to make
David Blaikiebbafb8a2012-03-11 07:00:24 +0000707 if (CGM.getLangOpts().CPlusPlus) {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000708 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
David Chisnalld3858d62011-03-25 11:57:33 +0000709 // void *__cxa_begin_catch(void *e)
Craig Topper8a13c412014-05-21 05:09:00 +0000710 EnterCatchFn.init(&CGM, "__cxa_begin_catch", PtrTy, PtrTy, nullptr);
David Chisnalld3858d62011-03-25 11:57:33 +0000711 // void __cxa_end_catch(void)
Craig Topper8a13c412014-05-21 05:09:00 +0000712 ExitCatchFn.init(&CGM, "__cxa_end_catch", VoidTy, nullptr);
David Chisnalld3858d62011-03-25 11:57:33 +0000713 // void _Unwind_Resume_or_Rethrow(void*)
David Chisnall0d75e062012-12-17 18:54:24 +0000714 ExceptionReThrowFn.init(&CGM, "_Unwind_Resume_or_Rethrow", VoidTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000715 PtrTy, nullptr);
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000716 } else if (R.getVersion() >= VersionTuple(1, 7)) {
717 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
718 // id objc_begin_catch(void *e)
Craig Topper8a13c412014-05-21 05:09:00 +0000719 EnterCatchFn.init(&CGM, "objc_begin_catch", IdTy, PtrTy, nullptr);
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000720 // void objc_end_catch(void)
Craig Topper8a13c412014-05-21 05:09:00 +0000721 ExitCatchFn.init(&CGM, "objc_end_catch", VoidTy, nullptr);
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000722 // void _Unwind_Resume_or_Rethrow(void*)
723 ExceptionReThrowFn.init(&CGM, "objc_exception_rethrow", VoidTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000724 PtrTy, nullptr);
David Chisnalld3858d62011-03-25 11:57:33 +0000725 }
David Chisnall0d75e062012-12-17 18:54:24 +0000726 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
727 SetPropertyAtomic.init(&CGM, "objc_setProperty_atomic", VoidTy, IdTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000728 SelectorTy, IdTy, PtrDiffTy, nullptr);
David Chisnall0d75e062012-12-17 18:54:24 +0000729 SetPropertyAtomicCopy.init(&CGM, "objc_setProperty_atomic_copy", VoidTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000730 IdTy, SelectorTy, IdTy, PtrDiffTy, nullptr);
David Chisnall0d75e062012-12-17 18:54:24 +0000731 SetPropertyNonAtomic.init(&CGM, "objc_setProperty_nonatomic", VoidTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000732 IdTy, SelectorTy, IdTy, PtrDiffTy, nullptr);
David Chisnall0d75e062012-12-17 18:54:24 +0000733 SetPropertyNonAtomicCopy.init(&CGM, "objc_setProperty_nonatomic_copy",
Craig Topper8a13c412014-05-21 05:09:00 +0000734 VoidTy, IdTy, SelectorTy, IdTy, PtrDiffTy, nullptr);
David Chisnall0d75e062012-12-17 18:54:24 +0000735 // void objc_setCppObjectAtomic(void *dest, const void *src, void
736 // *helper);
737 CxxAtomicObjectSetFn.init(&CGM, "objc_setCppObjectAtomic", VoidTy, PtrTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000738 PtrTy, PtrTy, nullptr);
David Chisnall0d75e062012-12-17 18:54:24 +0000739 // void objc_getCppObjectAtomic(void *dest, const void *src, void
740 // *helper);
741 CxxAtomicObjectGetFn.init(&CGM, "objc_getCppObjectAtomic", VoidTy, PtrTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000742 PtrTy, PtrTy, nullptr);
David Chisnall0d75e062012-12-17 18:54:24 +0000743 }
Craig Topper4f12f102014-03-12 06:41:41 +0000744 llvm::Constant *GetCppAtomicObjectGetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +0000745 // The optimised functions were added in version 1.7 of the GNUstep
746 // runtime.
747 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
748 VersionTuple(1, 7));
749 return CxxAtomicObjectGetFn;
750 }
Craig Topper4f12f102014-03-12 06:41:41 +0000751 llvm::Constant *GetCppAtomicObjectSetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +0000752 // The optimised functions were added in version 1.7 of the GNUstep
753 // runtime.
754 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
755 VersionTuple(1, 7));
756 return CxxAtomicObjectSetFn;
757 }
Craig Topper4f12f102014-03-12 06:41:41 +0000758 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
759 bool copy) override {
David Chisnall0d75e062012-12-17 18:54:24 +0000760 // The optimised property functions omit the GC check, and so are not
761 // safe to use in GC mode. The standard functions are fast in GC mode,
762 // so there is less advantage in using them.
763 assert ((CGM.getLangOpts().getGC() == LangOptions::NonGC));
764 // The optimised functions were added in version 1.7 of the GNUstep
765 // runtime.
766 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
767 VersionTuple(1, 7));
768
769 if (atomic) {
770 if (copy) return SetPropertyAtomicCopy;
771 return SetPropertyAtomic;
772 }
David Chisnall0d75e062012-12-17 18:54:24 +0000773
Ted Kremenek090a2732014-03-07 18:53:05 +0000774 return copy ? SetPropertyNonAtomicCopy : SetPropertyNonAtomic;
David Chisnall76803412011-03-23 22:52:06 +0000775 }
David Chisnalld7972f52011-03-23 16:36:54 +0000776};
777
Alp Toker272e9bc2013-11-25 00:40:53 +0000778/// Support for the ObjFW runtime.
John McCall3deb1ad2012-08-21 02:47:43 +0000779class CGObjCObjFW: public CGObjCGNU {
780protected:
781 /// The GCC ABI message lookup function. Returns an IMP pointing to the
782 /// method implementation for this message.
783 LazyRuntimeFunction MsgLookupFn;
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000784 /// stret lookup function. While this does not seem to make sense at the
785 /// first look, this is required to call the correct forwarding function.
786 LazyRuntimeFunction MsgLookupFnSRet;
John McCall3deb1ad2012-08-21 02:47:43 +0000787 /// The GCC ABI superclass message lookup function. Takes a pointer to a
788 /// structure describing the receiver and the class, and a selector as
789 /// arguments. Returns the IMP for the corresponding method.
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000790 LazyRuntimeFunction MsgLookupSuperFn, MsgLookupSuperFnSRet;
John McCall3deb1ad2012-08-21 02:47:43 +0000791
Craig Topper4f12f102014-03-12 06:41:41 +0000792 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
793 llvm::Value *cmd, llvm::MDNode *node,
794 MessageSendInfo &MSI) override {
John McCall3deb1ad2012-08-21 02:47:43 +0000795 CGBuilderTy &Builder = CGF.Builder;
796 llvm::Value *args[] = {
797 EnforceType(Builder, Receiver, IdTy),
798 EnforceType(Builder, cmd, SelectorTy) };
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000799
800 llvm::CallSite imp;
801 if (CGM.ReturnTypeUsesSRet(MSI.CallInfo))
802 imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFnSRet, args);
803 else
804 imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFn, args);
805
John McCall3deb1ad2012-08-21 02:47:43 +0000806 imp->setMetadata(msgSendMDKind, node);
807 return imp.getInstruction();
808 }
809
Craig Topper4f12f102014-03-12 06:41:41 +0000810 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, llvm::Value *ObjCSuper,
811 llvm::Value *cmd, MessageSendInfo &MSI) override {
John McCall3deb1ad2012-08-21 02:47:43 +0000812 CGBuilderTy &Builder = CGF.Builder;
813 llvm::Value *lookupArgs[] = {EnforceType(Builder, ObjCSuper,
814 PtrToObjCSuperTy), cmd};
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000815
816 if (CGM.ReturnTypeUsesSRet(MSI.CallInfo))
817 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFnSRet, lookupArgs);
818 else
819 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
John McCall3deb1ad2012-08-21 02:47:43 +0000820 }
821
Craig Topper4f12f102014-03-12 06:41:41 +0000822 llvm::Value *GetClassNamed(CodeGenFunction &CGF,
823 const std::string &Name, bool isWeak) override {
John McCall775086e2012-07-12 02:07:58 +0000824 if (isWeak)
John McCall882987f2013-02-28 19:01:20 +0000825 return CGObjCGNU::GetClassNamed(CGF, Name, isWeak);
John McCall775086e2012-07-12 02:07:58 +0000826
827 EmitClassRef(Name);
828
829 std::string SymbolName = "_OBJC_CLASS_" + Name;
830
831 llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(SymbolName);
832
833 if (!ClassSymbol)
834 ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false,
835 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +0000836 nullptr, SymbolName);
John McCall775086e2012-07-12 02:07:58 +0000837
838 return ClassSymbol;
839 }
840
841public:
John McCall3deb1ad2012-08-21 02:47:43 +0000842 CGObjCObjFW(CodeGenModule &Mod): CGObjCGNU(Mod, 9, 3) {
843 // IMP objc_msg_lookup(id, SEL);
Craig Topper8a13c412014-05-21 05:09:00 +0000844 MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy, nullptr);
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000845 MsgLookupFnSRet.init(&CGM, "objc_msg_lookup_stret", IMPTy, IdTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000846 SelectorTy, nullptr);
John McCall3deb1ad2012-08-21 02:47:43 +0000847 // IMP objc_msg_lookup_super(struct objc_super*, SEL);
848 MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000849 PtrToObjCSuperTy, SelectorTy, nullptr);
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000850 MsgLookupSuperFnSRet.init(&CGM, "objc_msg_lookup_super_stret", IMPTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000851 PtrToObjCSuperTy, SelectorTy, nullptr);
John McCall3deb1ad2012-08-21 02:47:43 +0000852 }
John McCall775086e2012-07-12 02:07:58 +0000853};
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000854} // end anonymous namespace
855
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000856
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000857/// Emits a reference to a dummy variable which is emitted with each class.
858/// This ensures that a linker error will be generated when trying to link
859/// together modules where a referenced class is not defined.
Mike Stumpdd93a192009-07-31 21:31:32 +0000860void CGObjCGNU::EmitClassRef(const std::string &className) {
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000861 std::string symbolRef = "__objc_class_ref_" + className;
862 // Don't emit two copies of the same symbol
Mike Stumpdd93a192009-07-31 21:31:32 +0000863 if (TheModule.getGlobalVariable(symbolRef))
864 return;
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000865 std::string symbolName = "__objc_class_name_" + className;
866 llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(symbolName);
867 if (!ClassSymbol) {
Owen Andersonc10c8d32009-07-08 19:05:04 +0000868 ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +0000869 llvm::GlobalValue::ExternalLinkage,
870 nullptr, symbolName);
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000871 }
Owen Andersonc10c8d32009-07-08 19:05:04 +0000872 new llvm::GlobalVariable(TheModule, ClassSymbol->getType(), true,
Chris Lattnerc58e5692009-08-05 05:25:18 +0000873 llvm::GlobalValue::WeakAnyLinkage, ClassSymbol, symbolRef);
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000874}
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000875
Craig Topperbf3e3272014-08-30 16:55:52 +0000876static std::string SymbolNameForMethod( StringRef ClassName,
877 StringRef CategoryName, const Selector MethodName,
David Chisnalld7972f52011-03-23 16:36:54 +0000878 bool isClassMethod) {
879 std::string MethodNameColonStripped = MethodName.getAsString();
David Chisnall035ead22010-01-14 14:08:19 +0000880 std::replace(MethodNameColonStripped.begin(), MethodNameColonStripped.end(),
881 ':', '_');
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000882 return (Twine(isClassMethod ? "_c_" : "_i_") + ClassName + "_" +
David Chisnalld7972f52011-03-23 16:36:54 +0000883 CategoryName + "_" + MethodNameColonStripped).str();
David Chisnall0a24fd32010-05-08 20:58:05 +0000884}
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000885
David Chisnalld7972f52011-03-23 16:36:54 +0000886CGObjCGNU::CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion,
Craig Topper8a13c412014-05-21 05:09:00 +0000887 unsigned protocolClassVersion)
John McCalla729c622012-02-17 03:33:10 +0000888 : CGObjCRuntime(cgm), TheModule(CGM.getModule()),
Craig Topper8a13c412014-05-21 05:09:00 +0000889 VMContext(cgm.getLLVMContext()), ClassPtrAlias(nullptr),
890 MetaClassPtrAlias(nullptr), RuntimeVersion(runtimeABIVersion),
891 ProtocolVersion(protocolClassVersion) {
David Chisnall01aa4672010-04-28 19:33:36 +0000892
893 msgSendMDKind = VMContext.getMDKindID("GNUObjCMessageSend");
894
David Chisnalld7972f52011-03-23 16:36:54 +0000895 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner8d3f4a42009-01-27 05:06:01 +0000896 IntTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +0000897 Types.ConvertType(CGM.getContext().IntTy));
Chris Lattner8d3f4a42009-01-27 05:06:01 +0000898 LongTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +0000899 Types.ConvertType(CGM.getContext().LongTy));
David Chisnall168b80f2010-12-26 22:13:16 +0000900 SizeTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +0000901 Types.ConvertType(CGM.getContext().getSizeType()));
David Chisnall168b80f2010-12-26 22:13:16 +0000902 PtrDiffTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +0000903 Types.ConvertType(CGM.getContext().getPointerDiffType()));
David Chisnall168b80f2010-12-26 22:13:16 +0000904 BoolTy = CGM.getTypes().ConvertType(CGM.getContext().BoolTy);
Mike Stump11289f42009-09-09 15:08:12 +0000905
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000906 Int8Ty = llvm::Type::getInt8Ty(VMContext);
907 // C string type. Used in lots of places.
908 PtrToInt8Ty = llvm::PointerType::getUnqual(Int8Ty);
909
Owen Andersonb7a2fe62009-07-24 23:12:58 +0000910 Zeros[0] = llvm::ConstantInt::get(LongTy, 0);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000911 Zeros[1] = Zeros[0];
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000912 NULLPtr = llvm::ConstantPointerNull::get(PtrToInt8Ty);
Chris Lattner4bd55962008-03-30 23:03:07 +0000913 // Get the selector Type.
David Chisnall481e3a82010-01-23 02:40:42 +0000914 QualType selTy = CGM.getContext().getObjCSelType();
915 if (QualType() == selTy) {
916 SelectorTy = PtrToInt8Ty;
917 } else {
918 SelectorTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(selTy));
919 }
Chris Lattner8d3f4a42009-01-27 05:06:01 +0000920
Owen Anderson9793f0e2009-07-29 22:16:19 +0000921 PtrToIntTy = llvm::PointerType::getUnqual(IntTy);
Chris Lattner4bd55962008-03-30 23:03:07 +0000922 PtrTy = PtrToInt8Ty;
Mike Stump11289f42009-09-09 15:08:12 +0000923
David Chisnallcdd207e2011-10-04 15:35:30 +0000924 Int32Ty = llvm::Type::getInt32Ty(VMContext);
925 Int64Ty = llvm::Type::getInt64Ty(VMContext);
926
Rafael Espindola3cc5c2d2014-01-09 21:32:51 +0000927 IntPtrTy =
928 CGM.getDataLayout().getPointerSizeInBits() == 32 ? Int32Ty : Int64Ty;
David Chisnalle0dc7cb2011-10-08 08:54:36 +0000929
Chris Lattner4bd55962008-03-30 23:03:07 +0000930 // Object type
David Chisnall10d2ded2011-04-29 14:10:35 +0000931 QualType UnqualIdTy = CGM.getContext().getObjCIdType();
932 ASTIdTy = CanQualType();
933 if (UnqualIdTy != QualType()) {
934 ASTIdTy = CGM.getContext().getCanonicalType(UnqualIdTy);
David Chisnall481e3a82010-01-23 02:40:42 +0000935 IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy));
David Chisnall10d2ded2011-04-29 14:10:35 +0000936 } else {
937 IdTy = PtrToInt8Ty;
David Chisnall481e3a82010-01-23 02:40:42 +0000938 }
David Chisnall5bb4efd2010-02-03 15:59:02 +0000939 PtrToIdTy = llvm::PointerType::getUnqual(IdTy);
Mike Stump11289f42009-09-09 15:08:12 +0000940
Craig Topper8a13c412014-05-21 05:09:00 +0000941 ObjCSuperTy = llvm::StructType::get(IdTy, IdTy, nullptr);
David Chisnall76803412011-03-23 22:52:06 +0000942 PtrToObjCSuperTy = llvm::PointerType::getUnqual(ObjCSuperTy);
943
Chris Lattnera5f58b02011-07-09 17:41:47 +0000944 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
David Chisnalld7972f52011-03-23 16:36:54 +0000945
946 // void objc_exception_throw(id);
Craig Topper8a13c412014-05-21 05:09:00 +0000947 ExceptionThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy, nullptr);
948 ExceptionReThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy, nullptr);
David Chisnalld7972f52011-03-23 16:36:54 +0000949 // int objc_sync_enter(id);
Craig Topper8a13c412014-05-21 05:09:00 +0000950 SyncEnterFn.init(&CGM, "objc_sync_enter", IntTy, IdTy, nullptr);
David Chisnalld7972f52011-03-23 16:36:54 +0000951 // int objc_sync_exit(id);
Craig Topper8a13c412014-05-21 05:09:00 +0000952 SyncExitFn.init(&CGM, "objc_sync_exit", IntTy, IdTy, nullptr);
David Chisnalld7972f52011-03-23 16:36:54 +0000953
954 // void objc_enumerationMutation (id)
955 EnumerationMutationFn.init(&CGM, "objc_enumerationMutation", VoidTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000956 IdTy, nullptr);
David Chisnalld7972f52011-03-23 16:36:54 +0000957
958 // id objc_getProperty(id, SEL, ptrdiff_t, BOOL)
959 GetPropertyFn.init(&CGM, "objc_getProperty", IdTy, IdTy, SelectorTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000960 PtrDiffTy, BoolTy, nullptr);
David Chisnalld7972f52011-03-23 16:36:54 +0000961 // void objc_setProperty(id, SEL, ptrdiff_t, id, BOOL, BOOL)
962 SetPropertyFn.init(&CGM, "objc_setProperty", VoidTy, IdTy, SelectorTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000963 PtrDiffTy, IdTy, BoolTy, BoolTy, nullptr);
David Chisnalld7972f52011-03-23 16:36:54 +0000964 // void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL)
965 GetStructPropertyFn.init(&CGM, "objc_getPropertyStruct", VoidTy, PtrTy, PtrTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000966 PtrDiffTy, BoolTy, BoolTy, nullptr);
David Chisnalld7972f52011-03-23 16:36:54 +0000967 // void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL)
968 SetStructPropertyFn.init(&CGM, "objc_setPropertyStruct", VoidTy, PtrTy, PtrTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000969 PtrDiffTy, BoolTy, BoolTy, nullptr);
David Chisnalld7972f52011-03-23 16:36:54 +0000970
Chris Lattner4bd55962008-03-30 23:03:07 +0000971 // IMP type
Chris Lattnera5f58b02011-07-09 17:41:47 +0000972 llvm::Type *IMPArgs[] = { IdTy, SelectorTy };
David Chisnall76803412011-03-23 22:52:06 +0000973 IMPTy = llvm::PointerType::getUnqual(llvm::FunctionType::get(IdTy, IMPArgs,
974 true));
David Chisnall5bb4efd2010-02-03 15:59:02 +0000975
David Blaikiebbafb8a2012-03-11 07:00:24 +0000976 const LangOptions &Opts = CGM.getLangOpts();
Douglas Gregor79a91412011-09-13 17:21:33 +0000977 if ((Opts.getGC() != LangOptions::NonGC) || Opts.ObjCAutoRefCount)
David Chisnalla918b882011-07-07 11:22:31 +0000978 RuntimeVersion = 10;
979
David Chisnalld3858d62011-03-25 11:57:33 +0000980 // Don't bother initialising the GC stuff unless we're compiling in GC mode
Douglas Gregor79a91412011-09-13 17:21:33 +0000981 if (Opts.getGC() != LangOptions::NonGC) {
David Chisnall5c511772011-05-22 22:37:08 +0000982 // This is a bit of an hack. We should sort this out by having a proper
983 // CGObjCGNUstep subclass for GC, but we may want to really support the old
984 // ABI and GC added in ObjectiveC2.framework, so we fudge it a bit for now
David Chisnall5bb4efd2010-02-03 15:59:02 +0000985 // Get selectors needed in GC mode
986 RetainSel = GetNullarySelector("retain", CGM.getContext());
987 ReleaseSel = GetNullarySelector("release", CGM.getContext());
988 AutoreleaseSel = GetNullarySelector("autorelease", CGM.getContext());
989
990 // Get functions needed in GC mode
991
992 // id objc_assign_ivar(id, id, ptrdiff_t);
David Chisnalld7972f52011-03-23 16:36:54 +0000993 IvarAssignFn.init(&CGM, "objc_assign_ivar", IdTy, IdTy, IdTy, PtrDiffTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000994 nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +0000995 // id objc_assign_strongCast (id, id*)
David Chisnalld7972f52011-03-23 16:36:54 +0000996 StrongCastAssignFn.init(&CGM, "objc_assign_strongCast", IdTy, IdTy,
Craig Topper8a13c412014-05-21 05:09:00 +0000997 PtrToIdTy, nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +0000998 // id objc_assign_global(id, id*);
David Chisnalld7972f52011-03-23 16:36:54 +0000999 GlobalAssignFn.init(&CGM, "objc_assign_global", IdTy, IdTy, PtrToIdTy,
Craig Topper8a13c412014-05-21 05:09:00 +00001000 nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001001 // id objc_assign_weak(id, id*);
Craig Topper8a13c412014-05-21 05:09:00 +00001002 WeakAssignFn.init(&CGM, "objc_assign_weak", IdTy, IdTy, PtrToIdTy, nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001003 // id objc_read_weak(id*);
Craig Topper8a13c412014-05-21 05:09:00 +00001004 WeakReadFn.init(&CGM, "objc_read_weak", IdTy, PtrToIdTy, nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001005 // void *objc_memmove_collectable(void*, void *, size_t);
David Chisnalld7972f52011-03-23 16:36:54 +00001006 MemMoveFn.init(&CGM, "objc_memmove_collectable", PtrTy, PtrTy, PtrTy,
Craig Topper8a13c412014-05-21 05:09:00 +00001007 SizeTy, nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001008 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001009}
Mike Stumpdd93a192009-07-31 21:31:32 +00001010
John McCall882987f2013-02-28 19:01:20 +00001011llvm::Value *CGObjCGNU::GetClassNamed(CodeGenFunction &CGF,
David Chisnall08d67332011-06-30 10:14:37 +00001012 const std::string &Name,
1013 bool isWeak) {
David Blaikie1ed728c2015-04-05 22:45:47 +00001014 llvm::GlobalVariable *ClassNameGV = CGM.GetAddrOfConstantCString(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);
David Blaikie1ed728c2015-04-05 22:45:47 +00001024 llvm::Value *ClassName =
1025 CGF.Builder.CreateStructGEP(ClassNameGV->getValueType(), ClassNameGV, 0);
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +00001026
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001027 llvm::Constant *ClassLookupFn =
Jay Foad5709f7c2011-07-29 13:56:53 +00001028 CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, PtrToInt8Ty, true),
Fariborz Jahanian3b636c12009-03-30 18:02:14 +00001029 "objc_lookup_class");
John McCall882987f2013-02-28 19:01:20 +00001030 return CGF.EmitNounwindRuntimeCall(ClassLookupFn, ClassName);
Chris Lattner4bd55962008-03-30 23:03:07 +00001031}
1032
David Chisnall920e83b2011-06-29 13:16:41 +00001033// This has to perform the lookup every time, since posing and related
1034// techniques can modify the name -> class mapping.
John McCall882987f2013-02-28 19:01:20 +00001035llvm::Value *CGObjCGNU::GetClass(CodeGenFunction &CGF,
David Chisnall920e83b2011-06-29 13:16:41 +00001036 const ObjCInterfaceDecl *OID) {
John McCall882987f2013-02-28 19:01:20 +00001037 return GetClassNamed(CGF, OID->getNameAsString(), OID->isWeakImported());
David Chisnall920e83b2011-06-29 13:16:41 +00001038}
John McCall882987f2013-02-28 19:01:20 +00001039llvm::Value *CGObjCGNU::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
1040 return GetClassNamed(CGF, "NSAutoreleasePool", false);
David Chisnall920e83b2011-06-29 13:16:41 +00001041}
1042
John McCall882987f2013-02-28 19:01:20 +00001043llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF, Selector Sel,
David Chisnalld7972f52011-03-23 16:36:54 +00001044 const std::string &TypeEncoding, bool lval) {
1045
Craig Topperfa159c12013-07-14 16:47:36 +00001046 SmallVectorImpl<TypedSelector> &Types = SelectorTable[Sel];
Craig Topper8a13c412014-05-21 05:09:00 +00001047 llvm::GlobalAlias *SelValue = nullptr;
David Chisnalld7972f52011-03-23 16:36:54 +00001048
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001049 for (SmallVectorImpl<TypedSelector>::iterator i = Types.begin(),
David Chisnalld7972f52011-03-23 16:36:54 +00001050 e = Types.end() ; i!=e ; i++) {
1051 if (i->first == TypeEncoding) {
1052 SelValue = i->second;
1053 break;
1054 }
1055 }
Craig Topper8a13c412014-05-21 05:09:00 +00001056 if (!SelValue) {
Rafael Espindola234405b2014-05-17 21:30:14 +00001057 SelValue = llvm::GlobalAlias::create(
David Blaikie881b2342015-04-29 21:22:47 +00001058 SelectorTy, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola61722772014-05-17 19:58:16 +00001059 ".objc_selector_" + Sel.getAsString(), &TheModule);
David Chisnalld7972f52011-03-23 16:36:54 +00001060 Types.push_back(TypedSelector(TypeEncoding, SelValue));
1061 }
1062
David Chisnall76803412011-03-23 22:52:06 +00001063 if (lval) {
John McCall882987f2013-02-28 19:01:20 +00001064 llvm::Value *tmp = CGF.CreateTempAlloca(SelValue->getType());
1065 CGF.Builder.CreateStore(SelValue, tmp);
David Chisnall76803412011-03-23 22:52:06 +00001066 return tmp;
1067 }
1068 return SelValue;
David Chisnalld7972f52011-03-23 16:36:54 +00001069}
1070
John McCall882987f2013-02-28 19:01:20 +00001071llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF, Selector Sel,
David Chisnalld7972f52011-03-23 16:36:54 +00001072 bool lval) {
John McCall882987f2013-02-28 19:01:20 +00001073 return GetSelector(CGF, Sel, std::string(), lval);
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001074}
1075
John McCall882987f2013-02-28 19:01:20 +00001076llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF,
1077 const ObjCMethodDecl *Method) {
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001078 std::string SelTypes;
1079 CGM.getContext().getObjCEncodingForMethodDecl(Method, SelTypes);
John McCall882987f2013-02-28 19:01:20 +00001080 return GetSelector(CGF, Method->getSelector(), SelTypes, false);
Chris Lattner6d522c02008-06-26 04:37:12 +00001081}
1082
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001083llvm::Constant *CGObjCGNU::GetEHType(QualType T) {
John McCallc31d8932012-11-14 09:08:34 +00001084 if (T->isObjCIdType() || T->isObjCQualifiedIdType()) {
1085 // With the old ABI, there was only one kind of catchall, which broke
1086 // foreign exceptions. With the new ABI, we use __objc_id_typeinfo as
1087 // a pointer indicating object catchalls, and NULL to indicate real
1088 // catchalls
1089 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1090 return MakeConstantString("@id");
1091 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00001092 return nullptr;
John McCallc31d8932012-11-14 09:08:34 +00001093 }
David Chisnalld3858d62011-03-25 11:57:33 +00001094 }
John McCallc31d8932012-11-14 09:08:34 +00001095
1096 // All other types should be Objective-C interface pointer types.
1097 const ObjCObjectPointerType *OPT = T->getAs<ObjCObjectPointerType>();
1098 assert(OPT && "Invalid @catch type.");
1099 const ObjCInterfaceDecl *IDecl = OPT->getObjectType()->getInterface();
1100 assert(IDecl && "Invalid @catch type.");
1101 return MakeConstantString(IDecl->getIdentifier()->getName());
1102}
1103
1104llvm::Constant *CGObjCGNUstep::GetEHType(QualType T) {
1105 if (!CGM.getLangOpts().CPlusPlus)
1106 return CGObjCGNU::GetEHType(T);
1107
David Chisnalle1d2584d2011-03-20 21:35:39 +00001108 // For Objective-C++, we want to provide the ability to catch both C++ and
1109 // Objective-C objects in the same function.
1110
1111 // There's a particular fixed type info for 'id'.
1112 if (T->isObjCIdType() ||
1113 T->isObjCQualifiedIdType()) {
1114 llvm::Constant *IDEHType =
1115 CGM.getModule().getGlobalVariable("__objc_id_type_info");
1116 if (!IDEHType)
1117 IDEHType =
1118 new llvm::GlobalVariable(CGM.getModule(), PtrToInt8Ty,
1119 false,
1120 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00001121 nullptr, "__objc_id_type_info");
David Chisnalle1d2584d2011-03-20 21:35:39 +00001122 return llvm::ConstantExpr::getBitCast(IDEHType, PtrToInt8Ty);
1123 }
1124
1125 const ObjCObjectPointerType *PT =
1126 T->getAs<ObjCObjectPointerType>();
1127 assert(PT && "Invalid @catch type.");
1128 const ObjCInterfaceType *IT = PT->getInterfaceType();
1129 assert(IT && "Invalid @catch type.");
1130 std::string className = IT->getDecl()->getIdentifier()->getName();
1131
1132 std::string typeinfoName = "__objc_eh_typeinfo_" + className;
1133
1134 // Return the existing typeinfo if it exists
1135 llvm::Constant *typeinfo = TheModule.getGlobalVariable(typeinfoName);
David Chisnalld6639342012-03-20 16:25:52 +00001136 if (typeinfo)
1137 return llvm::ConstantExpr::getBitCast(typeinfo, PtrToInt8Ty);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001138
1139 // Otherwise create it.
1140
1141 // vtable for gnustep::libobjc::__objc_class_type_info
1142 // It's quite ugly hard-coding this. Ideally we'd generate it using the host
1143 // platform's name mangling.
1144 const char *vtableName = "_ZTVN7gnustep7libobjc22__objc_class_type_infoE";
David Blaikiee3b172a2015-04-02 18:55:21 +00001145 auto *Vtable = TheModule.getGlobalVariable(vtableName);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001146 if (!Vtable) {
1147 Vtable = new llvm::GlobalVariable(TheModule, PtrToInt8Ty, true,
Craig Topper8a13c412014-05-21 05:09:00 +00001148 llvm::GlobalValue::ExternalLinkage,
1149 nullptr, vtableName);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001150 }
1151 llvm::Constant *Two = llvm::ConstantInt::get(IntTy, 2);
David Blaikiee3b172a2015-04-02 18:55:21 +00001152 auto *BVtable = llvm::ConstantExpr::getBitCast(
1153 llvm::ConstantExpr::getGetElementPtr(Vtable->getValueType(), Vtable, Two),
1154 PtrToInt8Ty);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001155
1156 llvm::Constant *typeName =
1157 ExportUniqueString(className, "__objc_eh_typename_");
1158
1159 std::vector<llvm::Constant*> fields;
David Blaikiee3b172a2015-04-02 18:55:21 +00001160 fields.push_back(BVtable);
David Chisnalle1d2584d2011-03-20 21:35:39 +00001161 fields.push_back(typeName);
1162 llvm::Constant *TI =
Chris Lattner845511f2011-06-18 22:49:11 +00001163 MakeGlobal(llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00001164 nullptr), fields, "__objc_eh_typeinfo_" + className,
David Chisnalle1d2584d2011-03-20 21:35:39 +00001165 llvm::GlobalValue::LinkOnceODRLinkage);
1166 return llvm::ConstantExpr::getBitCast(TI, PtrToInt8Ty);
John McCall2ca705e2010-07-24 00:37:23 +00001167}
1168
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001169/// Generate an NSConstantString object.
David Chisnall481e3a82010-01-23 02:40:42 +00001170llvm::Constant *CGObjCGNU::GenerateConstantString(const StringLiteral *SL) {
David Chisnall358e7512010-01-27 12:49:23 +00001171
Benjamin Kramer35b077e2010-08-17 12:54:38 +00001172 std::string Str = SL->getString().str();
David Chisnall481e3a82010-01-23 02:40:42 +00001173
David Chisnall358e7512010-01-27 12:49:23 +00001174 // Look for an existing one
1175 llvm::StringMap<llvm::Constant*>::iterator old = ObjCStrings.find(Str);
1176 if (old != ObjCStrings.end())
1177 return old->getValue();
1178
David Blaikiebbafb8a2012-03-11 07:00:24 +00001179 StringRef StringClass = CGM.getLangOpts().ObjCConstantStringClass;
David Chisnall207a6302012-01-04 12:02:13 +00001180
1181 if (StringClass.empty()) StringClass = "NXConstantString";
1182
1183 std::string Sym = "_OBJC_CLASS_";
1184 Sym += StringClass;
1185
1186 llvm::Constant *isa = TheModule.getNamedGlobal(Sym);
1187
1188 if (!isa)
1189 isa = new llvm::GlobalVariable(TheModule, IdTy, /* isConstant */false,
Craig Topper8a13c412014-05-21 05:09:00 +00001190 llvm::GlobalValue::ExternalWeakLinkage, nullptr, Sym);
David Chisnall207a6302012-01-04 12:02:13 +00001191 else if (isa->getType() != PtrToIdTy)
1192 isa = llvm::ConstantExpr::getBitCast(isa, PtrToIdTy);
1193
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001194 std::vector<llvm::Constant*> Ivars;
David Chisnall207a6302012-01-04 12:02:13 +00001195 Ivars.push_back(isa);
Chris Lattner091f6982008-06-21 21:44:18 +00001196 Ivars.push_back(MakeConstantString(Str));
Owen Andersonb7a2fe62009-07-24 23:12:58 +00001197 Ivars.push_back(llvm::ConstantInt::get(IntTy, Str.size()));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001198 llvm::Constant *ObjCStr = MakeGlobal(
Craig Topper8a13c412014-05-21 05:09:00 +00001199 llvm::StructType::get(PtrToIdTy, PtrToInt8Ty, IntTy, nullptr),
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001200 Ivars, ".objc_str");
David Chisnall358e7512010-01-27 12:49:23 +00001201 ObjCStr = llvm::ConstantExpr::getBitCast(ObjCStr, PtrToInt8Ty);
1202 ObjCStrings[Str] = ObjCStr;
1203 ConstantStrings.push_back(ObjCStr);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001204 return ObjCStr;
1205}
1206
1207///Generates a message send where the super is the receiver. This is a message
1208///send to self with special delivery semantics indicating which class's method
1209///should be called.
David Chisnalld7972f52011-03-23 16:36:54 +00001210RValue
1211CGObjCGNU::GenerateMessageSendSuper(CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001212 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001213 QualType ResultType,
1214 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001215 const ObjCInterfaceDecl *Class,
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001216 bool isCategoryImpl,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001217 llvm::Value *Receiver,
Daniel Dunbarc722b852008-08-30 03:02:31 +00001218 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001219 const CallArgList &CallArgs,
1220 const ObjCMethodDecl *Method) {
David Chisnall8a42d192011-05-28 14:09:01 +00001221 CGBuilderTy &Builder = CGF.Builder;
David Blaikiebbafb8a2012-03-11 07:00:24 +00001222 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
David Chisnall5bb4efd2010-02-03 15:59:02 +00001223 if (Sel == RetainSel || Sel == AutoreleaseSel) {
David Chisnall8a42d192011-05-28 14:09:01 +00001224 return RValue::get(EnforceType(Builder, Receiver,
1225 CGM.getTypes().ConvertType(ResultType)));
David Chisnall5bb4efd2010-02-03 15:59:02 +00001226 }
1227 if (Sel == ReleaseSel) {
Craig Topper8a13c412014-05-21 05:09:00 +00001228 return RValue::get(nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001229 }
1230 }
David Chisnallea529a42010-05-01 12:37:16 +00001231
John McCall882987f2013-02-28 19:01:20 +00001232 llvm::Value *cmd = GetSelector(CGF, Sel);
David Chisnallea529a42010-05-01 12:37:16 +00001233
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00001234
1235 CallArgList ActualArgs;
1236
Eli Friedman43dca6a2011-05-02 17:57:46 +00001237 ActualArgs.add(RValue::get(EnforceType(Builder, Receiver, IdTy)), ASTIdTy);
1238 ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00001239 ActualArgs.addFrom(CallArgs);
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00001240
John McCalla729c622012-02-17 03:33:10 +00001241 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00001242
Craig Topper8a13c412014-05-21 05:09:00 +00001243 llvm::Value *ReceiverClass = nullptr;
Chris Lattnera02cb802009-05-08 15:39:58 +00001244 if (isCategoryImpl) {
Craig Topper8a13c412014-05-21 05:09:00 +00001245 llvm::Constant *classLookupFunction = nullptr;
Chris Lattnera02cb802009-05-08 15:39:58 +00001246 if (IsClassMessage) {
Owen Anderson9793f0e2009-07-29 22:16:19 +00001247 classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get(
Jay Foad5709f7c2011-07-29 13:56:53 +00001248 IdTy, PtrTy, true), "objc_get_meta_class");
Chris Lattnera02cb802009-05-08 15:39:58 +00001249 } else {
Owen Anderson9793f0e2009-07-29 22:16:19 +00001250 classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get(
Jay Foad5709f7c2011-07-29 13:56:53 +00001251 IdTy, PtrTy, true), "objc_get_class");
Daniel Dunbar566421c2009-05-04 15:31:17 +00001252 }
David Chisnallea529a42010-05-01 12:37:16 +00001253 ReceiverClass = Builder.CreateCall(classLookupFunction,
Chris Lattnera02cb802009-05-08 15:39:58 +00001254 MakeConstantString(Class->getNameAsString()));
Daniel Dunbar566421c2009-05-04 15:31:17 +00001255 } else {
Chris Lattnera02cb802009-05-08 15:39:58 +00001256 // Set up global aliases for the metaclass or class pointer if they do not
1257 // already exist. These will are forward-references which will be set to
Mike Stumpdd93a192009-07-31 21:31:32 +00001258 // pointers to the class and metaclass structure created for the runtime
1259 // load function. To send a message to super, we look up the value of the
Chris Lattnera02cb802009-05-08 15:39:58 +00001260 // super_class pointer from either the class or metaclass structure.
1261 if (IsClassMessage) {
1262 if (!MetaClassPtrAlias) {
Rafael Espindola234405b2014-05-17 21:30:14 +00001263 MetaClassPtrAlias = llvm::GlobalAlias::create(
David Blaikie881b2342015-04-29 21:22:47 +00001264 IdTy, llvm::GlobalValue::InternalLinkage,
Rafael Espindola61722772014-05-17 19:58:16 +00001265 ".objc_metaclass_ref" + Class->getNameAsString(), &TheModule);
Chris Lattnera02cb802009-05-08 15:39:58 +00001266 }
1267 ReceiverClass = MetaClassPtrAlias;
1268 } else {
1269 if (!ClassPtrAlias) {
Rafael Espindola234405b2014-05-17 21:30:14 +00001270 ClassPtrAlias = llvm::GlobalAlias::create(
David Blaikie881b2342015-04-29 21:22:47 +00001271 IdTy, llvm::GlobalValue::InternalLinkage,
Rafael Espindola61722772014-05-17 19:58:16 +00001272 ".objc_class_ref" + Class->getNameAsString(), &TheModule);
Chris Lattnera02cb802009-05-08 15:39:58 +00001273 }
1274 ReceiverClass = ClassPtrAlias;
Daniel Dunbar566421c2009-05-04 15:31:17 +00001275 }
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00001276 }
Daniel Dunbar566421c2009-05-04 15:31:17 +00001277 // Cast the pointer to a simplified version of the class structure
David Blaikie1ed728c2015-04-05 22:45:47 +00001278 llvm::Type *CastTy = llvm::StructType::get(IdTy, IdTy, nullptr);
David Chisnallea529a42010-05-01 12:37:16 +00001279 ReceiverClass = Builder.CreateBitCast(ReceiverClass,
David Blaikie1ed728c2015-04-05 22:45:47 +00001280 llvm::PointerType::getUnqual(CastTy));
Daniel Dunbar566421c2009-05-04 15:31:17 +00001281 // Get the superclass pointer
David Blaikie1ed728c2015-04-05 22:45:47 +00001282 ReceiverClass = Builder.CreateStructGEP(CastTy, ReceiverClass, 1);
Daniel Dunbar566421c2009-05-04 15:31:17 +00001283 // Load the superclass pointer
David Chisnallea529a42010-05-01 12:37:16 +00001284 ReceiverClass = Builder.CreateLoad(ReceiverClass);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001285 // Construct the structure used to look up the IMP
Chris Lattner845511f2011-06-18 22:49:11 +00001286 llvm::StructType *ObjCSuperTy = llvm::StructType::get(
Craig Topper8a13c412014-05-21 05:09:00 +00001287 Receiver->getType(), IdTy, nullptr);
David Chisnallea529a42010-05-01 12:37:16 +00001288 llvm::Value *ObjCSuper = Builder.CreateAlloca(ObjCSuperTy);
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00001289
David Blaikie2e804282015-04-05 22:47:07 +00001290 Builder.CreateStore(Receiver,
1291 Builder.CreateStructGEP(ObjCSuperTy, ObjCSuper, 0));
1292 Builder.CreateStore(ReceiverClass,
1293 Builder.CreateStructGEP(ObjCSuperTy, ObjCSuper, 1));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001294
David Chisnall76803412011-03-23 22:52:06 +00001295 ObjCSuper = EnforceType(Builder, ObjCSuper, PtrToObjCSuperTy);
David Chisnall76803412011-03-23 22:52:06 +00001296
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001297 // Get the IMP
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00001298 llvm::Value *imp = LookupIMPSuper(CGF, ObjCSuper, cmd, MSI);
John McCalla729c622012-02-17 03:33:10 +00001299 imp = EnforceType(Builder, imp, MSI.MessengerType);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001300
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001301 llvm::Metadata *impMD[] = {
David Chisnall9eecafa2010-05-01 11:15:56 +00001302 llvm::MDString::get(VMContext, Sel.getAsString()),
1303 llvm::MDString::get(VMContext, Class->getSuperClass()->getNameAsString()),
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001304 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
1305 llvm::Type::getInt1Ty(VMContext), IsClassMessage))};
Jay Foadea324f12011-04-21 19:59:12 +00001306 llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD);
David Chisnall9eecafa2010-05-01 11:15:56 +00001307
David Chisnallff5f88c2010-05-02 13:41:58 +00001308 llvm::Instruction *call;
Craig Topper8a13c412014-05-21 05:09:00 +00001309 RValue msgRet = CGF.EmitCall(MSI.CallInfo, imp, Return, ActualArgs, nullptr,
1310 &call);
David Chisnallff5f88c2010-05-02 13:41:58 +00001311 call->setMetadata(msgSendMDKind, node);
1312 return msgRet;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001313}
1314
Mike Stump11289f42009-09-09 15:08:12 +00001315/// Generate code for a message send expression.
David Chisnalld7972f52011-03-23 16:36:54 +00001316RValue
1317CGObjCGNU::GenerateMessageSend(CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001318 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001319 QualType ResultType,
1320 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001321 llvm::Value *Receiver,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001322 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00001323 const ObjCInterfaceDecl *Class,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001324 const ObjCMethodDecl *Method) {
David Chisnall8a42d192011-05-28 14:09:01 +00001325 CGBuilderTy &Builder = CGF.Builder;
1326
David Chisnall75afda62010-04-27 15:08:48 +00001327 // Strip out message sends to retain / release in GC mode
David Blaikiebbafb8a2012-03-11 07:00:24 +00001328 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
David Chisnall5bb4efd2010-02-03 15:59:02 +00001329 if (Sel == RetainSel || Sel == AutoreleaseSel) {
David Chisnall8a42d192011-05-28 14:09:01 +00001330 return RValue::get(EnforceType(Builder, Receiver,
1331 CGM.getTypes().ConvertType(ResultType)));
David Chisnall5bb4efd2010-02-03 15:59:02 +00001332 }
1333 if (Sel == ReleaseSel) {
Craig Topper8a13c412014-05-21 05:09:00 +00001334 return RValue::get(nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +00001335 }
1336 }
David Chisnall75afda62010-04-27 15:08:48 +00001337
David Chisnall75afda62010-04-27 15:08:48 +00001338 // If the return type is something that goes in an integer register, the
1339 // runtime will handle 0 returns. For other cases, we fill in the 0 value
1340 // ourselves.
1341 //
1342 // The language spec says the result of this kind of message send is
1343 // undefined, but lots of people seem to have forgotten to read that
1344 // paragraph and insist on sending messages to nil that have structure
1345 // returns. With GCC, this generates a random return value (whatever happens
1346 // to be on the stack / in those registers at the time) on most platforms,
David Chisnall76803412011-03-23 22:52:06 +00001347 // and generates an illegal instruction trap on SPARC. With LLVM it corrupts
1348 // the stack.
1349 bool isPointerSizedReturn = (ResultType->isAnyPointerType() ||
1350 ResultType->isIntegralOrEnumerationType() || ResultType->isVoidType());
David Chisnall75afda62010-04-27 15:08:48 +00001351
Craig Topper8a13c412014-05-21 05:09:00 +00001352 llvm::BasicBlock *startBB = nullptr;
1353 llvm::BasicBlock *messageBB = nullptr;
1354 llvm::BasicBlock *continueBB = nullptr;
David Chisnall75afda62010-04-27 15:08:48 +00001355
1356 if (!isPointerSizedReturn) {
1357 startBB = Builder.GetInsertBlock();
1358 messageBB = CGF.createBasicBlock("msgSend");
David Chisnall29cefd12010-05-20 13:45:48 +00001359 continueBB = CGF.createBasicBlock("continue");
David Chisnall75afda62010-04-27 15:08:48 +00001360
1361 llvm::Value *isNil = Builder.CreateICmpEQ(Receiver,
1362 llvm::Constant::getNullValue(Receiver->getType()));
David Chisnall29cefd12010-05-20 13:45:48 +00001363 Builder.CreateCondBr(isNil, continueBB, messageBB);
David Chisnall75afda62010-04-27 15:08:48 +00001364 CGF.EmitBlock(messageBB);
1365 }
1366
David Chisnall9f57c292009-08-17 16:35:33 +00001367 IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy));
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001368 llvm::Value *cmd;
1369 if (Method)
John McCall882987f2013-02-28 19:01:20 +00001370 cmd = GetSelector(CGF, Method);
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001371 else
John McCall882987f2013-02-28 19:01:20 +00001372 cmd = GetSelector(CGF, Sel);
David Chisnall76803412011-03-23 22:52:06 +00001373 cmd = EnforceType(Builder, cmd, SelectorTy);
1374 Receiver = EnforceType(Builder, Receiver, IdTy);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001375
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00001376 llvm::Metadata *impMD[] = {
1377 llvm::MDString::get(VMContext, Sel.getAsString()),
1378 llvm::MDString::get(VMContext, Class ? Class->getNameAsString() : ""),
1379 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
1380 llvm::Type::getInt1Ty(VMContext), Class != nullptr))};
Jay Foadea324f12011-04-21 19:59:12 +00001381 llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD);
David Chisnall76803412011-03-23 22:52:06 +00001382
David Chisnall76803412011-03-23 22:52:06 +00001383 CallArgList ActualArgs;
Eli Friedman43dca6a2011-05-02 17:57:46 +00001384 ActualArgs.add(RValue::get(Receiver), ASTIdTy);
1385 ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00001386 ActualArgs.addFrom(CallArgs);
John McCalla729c622012-02-17 03:33:10 +00001387
1388 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
1389
David Chisnall8c93cf22011-10-24 14:07:03 +00001390 // Get the IMP to call
1391 llvm::Value *imp;
1392
1393 // If we have non-legacy dispatch specified, we try using the objc_msgSend()
1394 // functions. These are not supported on all platforms (or all runtimes on a
1395 // given platform), so we
1396 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
David Chisnall8c93cf22011-10-24 14:07:03 +00001397 case CodeGenOptions::Legacy:
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00001398 imp = LookupIMP(CGF, Receiver, cmd, node, MSI);
David Chisnall8c93cf22011-10-24 14:07:03 +00001399 break;
1400 case CodeGenOptions::Mixed:
David Chisnall8c93cf22011-10-24 14:07:03 +00001401 case CodeGenOptions::NonLegacy:
David Chisnall0cc83e72011-10-28 17:55:06 +00001402 if (CGM.ReturnTypeUsesFPRet(ResultType)) {
1403 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
1404 "objc_msgSend_fpret");
John McCalla729c622012-02-17 03:33:10 +00001405 } else if (CGM.ReturnTypeUsesSRet(MSI.CallInfo)) {
David Chisnall8c93cf22011-10-24 14:07:03 +00001406 // The actual types here don't matter - we're going to bitcast the
1407 // function anyway
1408 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
1409 "objc_msgSend_stret");
1410 } else {
1411 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
1412 "objc_msgSend");
1413 }
1414 }
1415
David Chisnall6aec31a2011-12-01 18:40:09 +00001416 // Reset the receiver in case the lookup modified it
1417 ActualArgs[0] = CallArg(RValue::get(Receiver), ASTIdTy, false);
David Chisnall8c93cf22011-10-24 14:07:03 +00001418
John McCalla729c622012-02-17 03:33:10 +00001419 imp = EnforceType(Builder, imp, MSI.MessengerType);
David Chisnallc0cf4222010-05-01 12:56:56 +00001420
David Chisnallff5f88c2010-05-02 13:41:58 +00001421 llvm::Instruction *call;
Craig Topper8a13c412014-05-21 05:09:00 +00001422 RValue msgRet = CGF.EmitCall(MSI.CallInfo, imp, Return, ActualArgs, nullptr,
1423 &call);
David Chisnallff5f88c2010-05-02 13:41:58 +00001424 call->setMetadata(msgSendMDKind, node);
David Chisnall75afda62010-04-27 15:08:48 +00001425
David Chisnall29cefd12010-05-20 13:45:48 +00001426
David Chisnall75afda62010-04-27 15:08:48 +00001427 if (!isPointerSizedReturn) {
David Chisnall29cefd12010-05-20 13:45:48 +00001428 messageBB = CGF.Builder.GetInsertBlock();
1429 CGF.Builder.CreateBr(continueBB);
1430 CGF.EmitBlock(continueBB);
David Chisnall75afda62010-04-27 15:08:48 +00001431 if (msgRet.isScalar()) {
1432 llvm::Value *v = msgRet.getScalarVal();
Jay Foad20c0f022011-03-30 11:28:58 +00001433 llvm::PHINode *phi = Builder.CreatePHI(v->getType(), 2);
David Chisnall75afda62010-04-27 15:08:48 +00001434 phi->addIncoming(v, messageBB);
1435 phi->addIncoming(llvm::Constant::getNullValue(v->getType()), startBB);
1436 msgRet = RValue::get(phi);
1437 } else if (msgRet.isAggregate()) {
1438 llvm::Value *v = msgRet.getAggregateAddr();
Jay Foad20c0f022011-03-30 11:28:58 +00001439 llvm::PHINode *phi = Builder.CreatePHI(v->getType(), 2);
Chris Lattner2192fe52011-07-18 04:24:23 +00001440 llvm::PointerType *RetTy = cast<llvm::PointerType>(v->getType());
David Chisnalld6a6af62010-04-30 13:36:12 +00001441 llvm::AllocaInst *NullVal =
1442 CGF.CreateTempAlloca(RetTy->getElementType(), "null");
David Chisnall75afda62010-04-27 15:08:48 +00001443 CGF.InitTempAlloca(NullVal,
1444 llvm::Constant::getNullValue(RetTy->getElementType()));
1445 phi->addIncoming(v, messageBB);
1446 phi->addIncoming(NullVal, startBB);
1447 msgRet = RValue::getAggregate(phi);
1448 } else /* isComplex() */ {
1449 std::pair<llvm::Value*,llvm::Value*> v = msgRet.getComplexVal();
Jay Foad20c0f022011-03-30 11:28:58 +00001450 llvm::PHINode *phi = Builder.CreatePHI(v.first->getType(), 2);
David Chisnall75afda62010-04-27 15:08:48 +00001451 phi->addIncoming(v.first, messageBB);
1452 phi->addIncoming(llvm::Constant::getNullValue(v.first->getType()),
1453 startBB);
Jay Foad20c0f022011-03-30 11:28:58 +00001454 llvm::PHINode *phi2 = Builder.CreatePHI(v.second->getType(), 2);
David Chisnall75afda62010-04-27 15:08:48 +00001455 phi2->addIncoming(v.second, messageBB);
1456 phi2->addIncoming(llvm::Constant::getNullValue(v.second->getType()),
1457 startBB);
1458 msgRet = RValue::getComplex(phi, phi2);
1459 }
1460 }
1461 return msgRet;
Chris Lattnerb7256cd2008-03-01 08:50:34 +00001462}
1463
Mike Stump11289f42009-09-09 15:08:12 +00001464/// Generates a MethodList. Used in construction of a objc_class and
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001465/// objc_category structures.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001466llvm::Constant *CGObjCGNU::
Craig Topperbf3e3272014-08-30 16:55:52 +00001467GenerateMethodList(StringRef ClassName,
1468 StringRef CategoryName,
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001469 ArrayRef<Selector> MethodSels,
1470 ArrayRef<llvm::Constant *> MethodTypes,
1471 bool isClassMethodList) {
David Chisnall9f57c292009-08-17 16:35:33 +00001472 if (MethodSels.empty())
1473 return NULLPtr;
Mike Stump11289f42009-09-09 15:08:12 +00001474 // Get the method structure type.
Chris Lattner845511f2011-06-18 22:49:11 +00001475 llvm::StructType *ObjCMethodTy = llvm::StructType::get(
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001476 PtrToInt8Ty, // Really a selector, but the runtime creates it us.
1477 PtrToInt8Ty, // Method types
David Chisnall76803412011-03-23 22:52:06 +00001478 IMPTy, //Method pointer
Craig Topper8a13c412014-05-21 05:09:00 +00001479 nullptr);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001480 std::vector<llvm::Constant*> Methods;
1481 std::vector<llvm::Constant*> Elements;
1482 for (unsigned int i = 0, e = MethodTypes.size(); i < e; ++i) {
1483 Elements.clear();
David Chisnalld7972f52011-03-23 16:36:54 +00001484 llvm::Constant *Method =
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001485 TheModule.getFunction(SymbolNameForMethod(ClassName, CategoryName,
David Chisnalld7972f52011-03-23 16:36:54 +00001486 MethodSels[i],
1487 isClassMethodList));
1488 assert(Method && "Can't generate metadata for method that doesn't exist");
1489 llvm::Constant *C = MakeConstantString(MethodSels[i].getAsString());
1490 Elements.push_back(C);
1491 Elements.push_back(MethodTypes[i]);
1492 Method = llvm::ConstantExpr::getBitCast(Method,
David Chisnall76803412011-03-23 22:52:06 +00001493 IMPTy);
David Chisnalld7972f52011-03-23 16:36:54 +00001494 Elements.push_back(Method);
1495 Methods.push_back(llvm::ConstantStruct::get(ObjCMethodTy, Elements));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001496 }
1497
1498 // Array of method structures
Owen Anderson9793f0e2009-07-29 22:16:19 +00001499 llvm::ArrayType *ObjCMethodArrayTy = llvm::ArrayType::get(ObjCMethodTy,
Fariborz Jahanian078cd522009-05-17 16:49:27 +00001500 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00001501 llvm::Constant *MethodArray = llvm::ConstantArray::get(ObjCMethodArrayTy,
Chris Lattner882034d2008-06-26 04:52:29 +00001502 Methods);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001503
1504 // Structure containing list pointer, array and array count
Chris Lattner5ec04a52011-08-12 17:43:31 +00001505 llvm::StructType *ObjCMethodListTy = llvm::StructType::create(VMContext);
Chris Lattnera5f58b02011-07-09 17:41:47 +00001506 llvm::Type *NextPtrTy = llvm::PointerType::getUnqual(ObjCMethodListTy);
1507 ObjCMethodListTy->setBody(
Mike Stump11289f42009-09-09 15:08:12 +00001508 NextPtrTy,
1509 IntTy,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001510 ObjCMethodArrayTy,
Craig Topper8a13c412014-05-21 05:09:00 +00001511 nullptr);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001512
1513 Methods.clear();
Owen Anderson7ec07a52009-07-30 23:11:26 +00001514 Methods.push_back(llvm::ConstantPointerNull::get(
Owen Anderson9793f0e2009-07-29 22:16:19 +00001515 llvm::PointerType::getUnqual(ObjCMethodListTy)));
David Chisnallcdd207e2011-10-04 15:35:30 +00001516 Methods.push_back(llvm::ConstantInt::get(Int32Ty, MethodTypes.size()));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001517 Methods.push_back(MethodArray);
Mike Stump11289f42009-09-09 15:08:12 +00001518
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001519 // Create an instance of the structure
1520 return MakeGlobal(ObjCMethodListTy, Methods, ".objc_method_list");
1521}
1522
1523/// Generates an IvarList. Used in construction of a objc_class.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001524llvm::Constant *CGObjCGNU::
1525GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
1526 ArrayRef<llvm::Constant *> IvarTypes,
1527 ArrayRef<llvm::Constant *> IvarOffsets) {
David Chisnallb3b44ce2009-11-16 19:05:54 +00001528 if (IvarNames.size() == 0)
1529 return NULLPtr;
Mike Stump11289f42009-09-09 15:08:12 +00001530 // Get the method structure type.
Chris Lattner845511f2011-06-18 22:49:11 +00001531 llvm::StructType *ObjCIvarTy = llvm::StructType::get(
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001532 PtrToInt8Ty,
1533 PtrToInt8Ty,
1534 IntTy,
Craig Topper8a13c412014-05-21 05:09:00 +00001535 nullptr);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001536 std::vector<llvm::Constant*> Ivars;
1537 std::vector<llvm::Constant*> Elements;
1538 for (unsigned int i = 0, e = IvarNames.size() ; i < e ; i++) {
1539 Elements.clear();
David Chisnall5778fce2009-08-31 16:41:57 +00001540 Elements.push_back(IvarNames[i]);
1541 Elements.push_back(IvarTypes[i]);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001542 Elements.push_back(IvarOffsets[i]);
Owen Anderson0e0189d2009-07-27 22:29:56 +00001543 Ivars.push_back(llvm::ConstantStruct::get(ObjCIvarTy, Elements));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001544 }
1545
1546 // Array of method structures
Owen Anderson9793f0e2009-07-29 22:16:19 +00001547 llvm::ArrayType *ObjCIvarArrayTy = llvm::ArrayType::get(ObjCIvarTy,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001548 IvarNames.size());
1549
Mike Stump11289f42009-09-09 15:08:12 +00001550
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001551 Elements.clear();
Owen Andersonb7a2fe62009-07-24 23:12:58 +00001552 Elements.push_back(llvm::ConstantInt::get(IntTy, (int)IvarNames.size()));
Owen Anderson47034e12009-07-28 18:33:04 +00001553 Elements.push_back(llvm::ConstantArray::get(ObjCIvarArrayTy, Ivars));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001554 // Structure containing array and array count
Chris Lattner845511f2011-06-18 22:49:11 +00001555 llvm::StructType *ObjCIvarListTy = llvm::StructType::get(IntTy,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001556 ObjCIvarArrayTy,
Craig Topper8a13c412014-05-21 05:09:00 +00001557 nullptr);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001558
1559 // Create an instance of the structure
1560 return MakeGlobal(ObjCIvarListTy, Elements, ".objc_ivar_list");
1561}
1562
1563/// Generate a class structure
1564llvm::Constant *CGObjCGNU::GenerateClassStructure(
1565 llvm::Constant *MetaClass,
1566 llvm::Constant *SuperClass,
1567 unsigned info,
Chris Lattnerda35bc82008-06-26 04:47:04 +00001568 const char *Name,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001569 llvm::Constant *Version,
1570 llvm::Constant *InstanceSize,
1571 llvm::Constant *IVars,
1572 llvm::Constant *Methods,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001573 llvm::Constant *Protocols,
1574 llvm::Constant *IvarOffsets,
David Chisnalld472c852010-04-28 14:29:56 +00001575 llvm::Constant *Properties,
David Chisnallcdd207e2011-10-04 15:35:30 +00001576 llvm::Constant *StrongIvarBitmap,
1577 llvm::Constant *WeakIvarBitmap,
David Chisnalld472c852010-04-28 14:29:56 +00001578 bool isMeta) {
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001579 // Set up the class structure
1580 // Note: Several of these are char*s when they should be ids. This is
1581 // because the runtime performs this translation on load.
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001582 //
1583 // Fields marked New ABI are part of the GNUstep runtime. We emit them
1584 // anyway; the classes will still work with the GNU runtime, they will just
1585 // be ignored.
Chris Lattner845511f2011-06-18 22:49:11 +00001586 llvm::StructType *ClassTy = llvm::StructType::get(
David Chisnall207a6302012-01-04 12:02:13 +00001587 PtrToInt8Ty, // isa
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001588 PtrToInt8Ty, // super_class
1589 PtrToInt8Ty, // name
1590 LongTy, // version
1591 LongTy, // info
1592 LongTy, // instance_size
1593 IVars->getType(), // ivars
1594 Methods->getType(), // methods
Mike Stump11289f42009-09-09 15:08:12 +00001595 // These are all filled in by the runtime, so we pretend
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001596 PtrTy, // dtable
1597 PtrTy, // subclass_list
1598 PtrTy, // sibling_class
1599 PtrTy, // protocols
1600 PtrTy, // gc_object_type
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001601 // New ABI:
1602 LongTy, // abi_version
1603 IvarOffsets->getType(), // ivar_offsets
1604 Properties->getType(), // properties
David Chisnalle89ac062011-10-25 10:12:21 +00001605 IntPtrTy, // strong_pointers
1606 IntPtrTy, // weak_pointers
Craig Topper8a13c412014-05-21 05:09:00 +00001607 nullptr);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00001608 llvm::Constant *Zero = llvm::ConstantInt::get(LongTy, 0);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001609 // Fill in the structure
1610 std::vector<llvm::Constant*> Elements;
Owen Andersonade90fd2009-07-29 18:54:39 +00001611 Elements.push_back(llvm::ConstantExpr::getBitCast(MetaClass, PtrToInt8Ty));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001612 Elements.push_back(SuperClass);
Chris Lattnerda35bc82008-06-26 04:47:04 +00001613 Elements.push_back(MakeConstantString(Name, ".class_name"));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001614 Elements.push_back(Zero);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00001615 Elements.push_back(llvm::ConstantInt::get(LongTy, info));
David Chisnall055f0642011-02-21 23:47:40 +00001616 if (isMeta) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00001617 llvm::DataLayout td(&TheModule);
Ken Dyck0fed10e2011-04-22 17:59:22 +00001618 Elements.push_back(
1619 llvm::ConstantInt::get(LongTy,
1620 td.getTypeSizeInBits(ClassTy) /
1621 CGM.getContext().getCharWidth()));
David Chisnall055f0642011-02-21 23:47:40 +00001622 } else
1623 Elements.push_back(InstanceSize);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001624 Elements.push_back(IVars);
1625 Elements.push_back(Methods);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001626 Elements.push_back(NULLPtr);
1627 Elements.push_back(NULLPtr);
1628 Elements.push_back(NULLPtr);
Owen Andersonade90fd2009-07-29 18:54:39 +00001629 Elements.push_back(llvm::ConstantExpr::getBitCast(Protocols, PtrTy));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001630 Elements.push_back(NULLPtr);
David Chisnallcdd207e2011-10-04 15:35:30 +00001631 Elements.push_back(llvm::ConstantInt::get(LongTy, 1));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001632 Elements.push_back(IvarOffsets);
1633 Elements.push_back(Properties);
David Chisnallcdd207e2011-10-04 15:35:30 +00001634 Elements.push_back(StrongIvarBitmap);
1635 Elements.push_back(WeakIvarBitmap);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001636 // Create an instance of the structure
David Chisnalldf349172010-01-08 00:14:31 +00001637 // This is now an externally visible symbol, so that we can speed up class
David Chisnall207a6302012-01-04 12:02:13 +00001638 // messages in the next ABI. We may already have some weak references to
1639 // this, so check and fix them properly.
1640 std::string ClassSym((isMeta ? "_OBJC_METACLASS_": "_OBJC_CLASS_") +
1641 std::string(Name));
1642 llvm::GlobalVariable *ClassRef = TheModule.getNamedGlobal(ClassSym);
1643 llvm::Constant *Class = MakeGlobal(ClassTy, Elements, ClassSym,
1644 llvm::GlobalValue::ExternalLinkage);
1645 if (ClassRef) {
1646 ClassRef->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(Class,
1647 ClassRef->getType()));
1648 ClassRef->removeFromParent();
1649 Class->setName(ClassSym);
1650 }
1651 return Class;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001652}
1653
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001654llvm::Constant *CGObjCGNU::
1655GenerateProtocolMethodList(ArrayRef<llvm::Constant *> MethodNames,
1656 ArrayRef<llvm::Constant *> MethodTypes) {
Mike Stump11289f42009-09-09 15:08:12 +00001657 // Get the method structure type.
Chris Lattner845511f2011-06-18 22:49:11 +00001658 llvm::StructType *ObjCMethodDescTy = llvm::StructType::get(
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001659 PtrToInt8Ty, // Really a selector, but the runtime does the casting for us.
1660 PtrToInt8Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00001661 nullptr);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001662 std::vector<llvm::Constant*> Methods;
1663 std::vector<llvm::Constant*> Elements;
1664 for (unsigned int i = 0, e = MethodTypes.size() ; i < e ; i++) {
1665 Elements.clear();
Mike Stump11289f42009-09-09 15:08:12 +00001666 Elements.push_back(MethodNames[i]);
David Chisnall5778fce2009-08-31 16:41:57 +00001667 Elements.push_back(MethodTypes[i]);
Owen Anderson0e0189d2009-07-27 22:29:56 +00001668 Methods.push_back(llvm::ConstantStruct::get(ObjCMethodDescTy, Elements));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001669 }
Owen Anderson9793f0e2009-07-29 22:16:19 +00001670 llvm::ArrayType *ObjCMethodArrayTy = llvm::ArrayType::get(ObjCMethodDescTy,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001671 MethodNames.size());
Owen Anderson47034e12009-07-28 18:33:04 +00001672 llvm::Constant *Array = llvm::ConstantArray::get(ObjCMethodArrayTy,
Mike Stumpdd93a192009-07-31 21:31:32 +00001673 Methods);
Chris Lattner845511f2011-06-18 22:49:11 +00001674 llvm::StructType *ObjCMethodDescListTy = llvm::StructType::get(
Craig Topper8a13c412014-05-21 05:09:00 +00001675 IntTy, ObjCMethodArrayTy, nullptr);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001676 Methods.clear();
Owen Andersonb7a2fe62009-07-24 23:12:58 +00001677 Methods.push_back(llvm::ConstantInt::get(IntTy, MethodNames.size()));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001678 Methods.push_back(Array);
1679 return MakeGlobal(ObjCMethodDescListTy, Methods, ".objc_method_list");
1680}
Mike Stumpdd93a192009-07-31 21:31:32 +00001681
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001682// Create the protocol list structure used in classes, categories and so on
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001683llvm::Constant *CGObjCGNU::GenerateProtocolList(ArrayRef<std::string>Protocols){
Owen Anderson9793f0e2009-07-29 22:16:19 +00001684 llvm::ArrayType *ProtocolArrayTy = llvm::ArrayType::get(PtrToInt8Ty,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001685 Protocols.size());
Chris Lattner845511f2011-06-18 22:49:11 +00001686 llvm::StructType *ProtocolListTy = llvm::StructType::get(
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001687 PtrTy, //Should be a recurisve pointer, but it's always NULL here.
David Chisnall168b80f2010-12-26 22:13:16 +00001688 SizeTy,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001689 ProtocolArrayTy,
Craig Topper8a13c412014-05-21 05:09:00 +00001690 nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00001691 std::vector<llvm::Constant*> Elements;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001692 for (const std::string *iter = Protocols.begin(), *endIter = Protocols.end();
1693 iter != endIter ; iter++) {
Craig Topper8a13c412014-05-21 05:09:00 +00001694 llvm::Constant *protocol = nullptr;
David Chisnallbc8bdea2009-11-20 14:50:59 +00001695 llvm::StringMap<llvm::Constant*>::iterator value =
1696 ExistingProtocols.find(*iter);
1697 if (value == ExistingProtocols.end()) {
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001698 protocol = GenerateEmptyProtocol(*iter);
David Chisnallbc8bdea2009-11-20 14:50:59 +00001699 } else {
1700 protocol = value->getValue();
1701 }
Owen Andersonade90fd2009-07-29 18:54:39 +00001702 llvm::Constant *Ptr = llvm::ConstantExpr::getBitCast(protocol,
Owen Anderson170229f2009-07-14 23:10:40 +00001703 PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001704 Elements.push_back(Ptr);
1705 }
Owen Anderson47034e12009-07-28 18:33:04 +00001706 llvm::Constant * ProtocolArray = llvm::ConstantArray::get(ProtocolArrayTy,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001707 Elements);
1708 Elements.clear();
1709 Elements.push_back(NULLPtr);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00001710 Elements.push_back(llvm::ConstantInt::get(LongTy, Protocols.size()));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001711 Elements.push_back(ProtocolArray);
1712 return MakeGlobal(ProtocolListTy, Elements, ".objc_protocol_list");
1713}
1714
John McCall882987f2013-02-28 19:01:20 +00001715llvm::Value *CGObjCGNU::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001716 const ObjCProtocolDecl *PD) {
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001717 llvm::Value *protocol = ExistingProtocols[PD->getNameAsString()];
Chris Lattner2192fe52011-07-18 04:24:23 +00001718 llvm::Type *T =
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001719 CGM.getTypes().ConvertType(CGM.getContext().getObjCProtoType());
John McCall882987f2013-02-28 19:01:20 +00001720 return CGF.Builder.CreateBitCast(protocol, llvm::PointerType::getUnqual(T));
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001721}
1722
1723llvm::Constant *CGObjCGNU::GenerateEmptyProtocol(
1724 const std::string &ProtocolName) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001725 SmallVector<std::string, 0> EmptyStringVector;
1726 SmallVector<llvm::Constant*, 0> EmptyConstantVector;
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001727
1728 llvm::Constant *ProtocolList = GenerateProtocolList(EmptyStringVector);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001729 llvm::Constant *MethodList =
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001730 GenerateProtocolMethodList(EmptyConstantVector, EmptyConstantVector);
1731 // Protocols are objects containing lists of the methods implemented and
1732 // protocols adopted.
Chris Lattner845511f2011-06-18 22:49:11 +00001733 llvm::StructType *ProtocolTy = llvm::StructType::get(IdTy,
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001734 PtrToInt8Ty,
1735 ProtocolList->getType(),
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001736 MethodList->getType(),
1737 MethodList->getType(),
1738 MethodList->getType(),
1739 MethodList->getType(),
Craig Topper8a13c412014-05-21 05:09:00 +00001740 nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00001741 std::vector<llvm::Constant*> Elements;
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001742 // The isa pointer must be set to a magic number so the runtime knows it's
1743 // the correct layout.
Owen Andersonade90fd2009-07-29 18:54:39 +00001744 Elements.push_back(llvm::ConstantExpr::getIntToPtr(
David Chisnallcdd207e2011-10-04 15:35:30 +00001745 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001746 Elements.push_back(MakeConstantString(ProtocolName, ".objc_protocol_name"));
1747 Elements.push_back(ProtocolList);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001748 Elements.push_back(MethodList);
1749 Elements.push_back(MethodList);
1750 Elements.push_back(MethodList);
1751 Elements.push_back(MethodList);
Fariborz Jahanian89d23972009-03-31 18:27:22 +00001752 return MakeGlobal(ProtocolTy, Elements, ".objc_protocol");
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001753}
1754
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001755void CGObjCGNU::GenerateProtocol(const ObjCProtocolDecl *PD) {
1756 ASTContext &Context = CGM.getContext();
Chris Lattner86d7d912008-11-24 03:54:41 +00001757 std::string ProtocolName = PD->getNameAsString();
Douglas Gregora715bff2012-01-01 19:51:50 +00001758
1759 // Use the protocol definition, if there is one.
1760 if (const ObjCProtocolDecl *Def = PD->getDefinition())
1761 PD = Def;
1762
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001763 SmallVector<std::string, 16> Protocols;
Aaron Ballman0f6e64d2014-03-13 22:58:06 +00001764 for (const auto *PI : PD->protocols())
1765 Protocols.push_back(PI->getNameAsString());
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001766 SmallVector<llvm::Constant*, 16> InstanceMethodNames;
1767 SmallVector<llvm::Constant*, 16> InstanceMethodTypes;
1768 SmallVector<llvm::Constant*, 16> OptionalInstanceMethodNames;
1769 SmallVector<llvm::Constant*, 16> OptionalInstanceMethodTypes;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00001770 for (const auto *I : PD->instance_methods()) {
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001771 std::string TypeStr;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00001772 Context.getObjCEncodingForMethodDecl(I, TypeStr);
1773 if (I->getImplementationControl() == ObjCMethodDecl::Optional) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001774 OptionalInstanceMethodNames.push_back(
Aaron Ballmanf26acce2014-03-13 19:50:17 +00001775 MakeConstantString(I->getSelector().getAsString()));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001776 OptionalInstanceMethodTypes.push_back(MakeConstantString(TypeStr));
David Chisnall12d81352012-08-23 12:17:21 +00001777 } else {
1778 InstanceMethodNames.push_back(
Aaron Ballmanf26acce2014-03-13 19:50:17 +00001779 MakeConstantString(I->getSelector().getAsString()));
David Chisnall12d81352012-08-23 12:17:21 +00001780 InstanceMethodTypes.push_back(MakeConstantString(TypeStr));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001781 }
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001782 }
1783 // Collect information about class methods:
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001784 SmallVector<llvm::Constant*, 16> ClassMethodNames;
1785 SmallVector<llvm::Constant*, 16> ClassMethodTypes;
1786 SmallVector<llvm::Constant*, 16> OptionalClassMethodNames;
1787 SmallVector<llvm::Constant*, 16> OptionalClassMethodTypes;
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00001788 for (const auto *I : PD->class_methods()) {
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001789 std::string TypeStr;
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00001790 Context.getObjCEncodingForMethodDecl(I,TypeStr);
1791 if (I->getImplementationControl() == ObjCMethodDecl::Optional) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001792 OptionalClassMethodNames.push_back(
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00001793 MakeConstantString(I->getSelector().getAsString()));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001794 OptionalClassMethodTypes.push_back(MakeConstantString(TypeStr));
David Chisnall12d81352012-08-23 12:17:21 +00001795 } else {
1796 ClassMethodNames.push_back(
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00001797 MakeConstantString(I->getSelector().getAsString()));
David Chisnall12d81352012-08-23 12:17:21 +00001798 ClassMethodTypes.push_back(MakeConstantString(TypeStr));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001799 }
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00001800 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001801
1802 llvm::Constant *ProtocolList = GenerateProtocolList(Protocols);
1803 llvm::Constant *InstanceMethodList =
1804 GenerateProtocolMethodList(InstanceMethodNames, InstanceMethodTypes);
1805 llvm::Constant *ClassMethodList =
1806 GenerateProtocolMethodList(ClassMethodNames, ClassMethodTypes);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001807 llvm::Constant *OptionalInstanceMethodList =
1808 GenerateProtocolMethodList(OptionalInstanceMethodNames,
1809 OptionalInstanceMethodTypes);
1810 llvm::Constant *OptionalClassMethodList =
1811 GenerateProtocolMethodList(OptionalClassMethodNames,
1812 OptionalClassMethodTypes);
1813
1814 // Property metadata: name, attributes, isSynthesized, setter name, setter
1815 // types, getter name, getter types.
1816 // The isSynthesized value is always set to 0 in a protocol. It exists to
1817 // simplify the runtime library by allowing it to use the same data
1818 // structures for protocol metadata everywhere.
Chris Lattner845511f2011-06-18 22:49:11 +00001819 llvm::StructType *PropertyMetadataTy = llvm::StructType::get(
David Chisnallbeb80132013-02-28 13:59:29 +00001820 PtrToInt8Ty, Int8Ty, Int8Ty, Int8Ty, Int8Ty, PtrToInt8Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00001821 PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty, nullptr);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001822 std::vector<llvm::Constant*> Properties;
1823 std::vector<llvm::Constant*> OptionalProperties;
1824
1825 // Add all of the property methods need adding to the method list and to the
1826 // property metadata list.
Aaron Ballmand174edf2014-03-13 19:11:50 +00001827 for (auto *property : PD->properties()) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001828 std::vector<llvm::Constant*> Fields;
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001829
Craig Topper8a13c412014-05-21 05:09:00 +00001830 Fields.push_back(MakePropertyEncodingString(property, nullptr));
David Chisnallbeb80132013-02-28 13:59:29 +00001831 PushPropertyAttributes(Fields, property);
David Chisnalla5f59412012-10-16 15:11:55 +00001832
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001833 if (ObjCMethodDecl *getter = property->getGetterMethodDecl()) {
1834 std::string TypeStr;
1835 Context.getObjCEncodingForMethodDecl(getter,TypeStr);
1836 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
1837 InstanceMethodTypes.push_back(TypeEncoding);
1838 Fields.push_back(MakeConstantString(getter->getSelector().getAsString()));
1839 Fields.push_back(TypeEncoding);
1840 } else {
1841 Fields.push_back(NULLPtr);
1842 Fields.push_back(NULLPtr);
1843 }
1844 if (ObjCMethodDecl *setter = property->getSetterMethodDecl()) {
1845 std::string TypeStr;
1846 Context.getObjCEncodingForMethodDecl(setter,TypeStr);
1847 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
1848 InstanceMethodTypes.push_back(TypeEncoding);
1849 Fields.push_back(MakeConstantString(setter->getSelector().getAsString()));
1850 Fields.push_back(TypeEncoding);
1851 } else {
1852 Fields.push_back(NULLPtr);
1853 Fields.push_back(NULLPtr);
1854 }
1855 if (property->getPropertyImplementation() == ObjCPropertyDecl::Optional) {
1856 OptionalProperties.push_back(llvm::ConstantStruct::get(PropertyMetadataTy, Fields));
1857 } else {
1858 Properties.push_back(llvm::ConstantStruct::get(PropertyMetadataTy, Fields));
1859 }
1860 }
1861 llvm::Constant *PropertyArray = llvm::ConstantArray::get(
1862 llvm::ArrayType::get(PropertyMetadataTy, Properties.size()), Properties);
1863 llvm::Constant* PropertyListInitFields[] =
1864 {llvm::ConstantInt::get(IntTy, Properties.size()), NULLPtr, PropertyArray};
1865
1866 llvm::Constant *PropertyListInit =
Chris Lattnere64d7ba2011-06-20 04:01:35 +00001867 llvm::ConstantStruct::getAnon(PropertyListInitFields);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001868 llvm::Constant *PropertyList = new llvm::GlobalVariable(TheModule,
1869 PropertyListInit->getType(), false, llvm::GlobalValue::InternalLinkage,
1870 PropertyListInit, ".objc_property_list");
1871
1872 llvm::Constant *OptionalPropertyArray =
1873 llvm::ConstantArray::get(llvm::ArrayType::get(PropertyMetadataTy,
1874 OptionalProperties.size()) , OptionalProperties);
1875 llvm::Constant* OptionalPropertyListInitFields[] = {
1876 llvm::ConstantInt::get(IntTy, OptionalProperties.size()), NULLPtr,
1877 OptionalPropertyArray };
1878
1879 llvm::Constant *OptionalPropertyListInit =
Chris Lattnere64d7ba2011-06-20 04:01:35 +00001880 llvm::ConstantStruct::getAnon(OptionalPropertyListInitFields);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001881 llvm::Constant *OptionalPropertyList = new llvm::GlobalVariable(TheModule,
1882 OptionalPropertyListInit->getType(), false,
1883 llvm::GlobalValue::InternalLinkage, OptionalPropertyListInit,
1884 ".objc_property_list");
1885
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001886 // Protocols are objects containing lists of the methods implemented and
1887 // protocols adopted.
Chris Lattner845511f2011-06-18 22:49:11 +00001888 llvm::StructType *ProtocolTy = llvm::StructType::get(IdTy,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001889 PtrToInt8Ty,
1890 ProtocolList->getType(),
1891 InstanceMethodList->getType(),
1892 ClassMethodList->getType(),
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001893 OptionalInstanceMethodList->getType(),
1894 OptionalClassMethodList->getType(),
1895 PropertyList->getType(),
1896 OptionalPropertyList->getType(),
Craig Topper8a13c412014-05-21 05:09:00 +00001897 nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00001898 std::vector<llvm::Constant*> Elements;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001899 // The isa pointer must be set to a magic number so the runtime knows it's
1900 // the correct layout.
Owen Andersonade90fd2009-07-29 18:54:39 +00001901 Elements.push_back(llvm::ConstantExpr::getIntToPtr(
David Chisnallcdd207e2011-10-04 15:35:30 +00001902 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001903 Elements.push_back(MakeConstantString(ProtocolName, ".objc_protocol_name"));
1904 Elements.push_back(ProtocolList);
1905 Elements.push_back(InstanceMethodList);
1906 Elements.push_back(ClassMethodList);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001907 Elements.push_back(OptionalInstanceMethodList);
1908 Elements.push_back(OptionalClassMethodList);
1909 Elements.push_back(PropertyList);
1910 Elements.push_back(OptionalPropertyList);
Mike Stump11289f42009-09-09 15:08:12 +00001911 ExistingProtocols[ProtocolName] =
Owen Andersonade90fd2009-07-29 18:54:39 +00001912 llvm::ConstantExpr::getBitCast(MakeGlobal(ProtocolTy, Elements,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001913 ".objc_protocol"), IdTy);
1914}
Dmitri Gribenkob2aa9232012-11-15 14:28:07 +00001915void CGObjCGNU::GenerateProtocolHolderCategory() {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001916 // Collect information about instance methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001917 SmallVector<Selector, 1> MethodSels;
1918 SmallVector<llvm::Constant*, 1> MethodTypes;
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001919
1920 std::vector<llvm::Constant*> Elements;
1921 const std::string ClassName = "__ObjC_Protocol_Holder_Ugly_Hack";
1922 const std::string CategoryName = "AnotherHack";
1923 Elements.push_back(MakeConstantString(CategoryName));
1924 Elements.push_back(MakeConstantString(ClassName));
1925 // Instance method list
1926 Elements.push_back(llvm::ConstantExpr::getBitCast(GenerateMethodList(
1927 ClassName, CategoryName, MethodSels, MethodTypes, false), PtrTy));
1928 // Class method list
1929 Elements.push_back(llvm::ConstantExpr::getBitCast(GenerateMethodList(
1930 ClassName, CategoryName, MethodSels, MethodTypes, true), PtrTy));
1931 // Protocol list
1932 llvm::ArrayType *ProtocolArrayTy = llvm::ArrayType::get(PtrTy,
1933 ExistingProtocols.size());
Chris Lattner845511f2011-06-18 22:49:11 +00001934 llvm::StructType *ProtocolListTy = llvm::StructType::get(
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001935 PtrTy, //Should be a recurisve pointer, but it's always NULL here.
David Chisnall168b80f2010-12-26 22:13:16 +00001936 SizeTy,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001937 ProtocolArrayTy,
Craig Topper8a13c412014-05-21 05:09:00 +00001938 nullptr);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001939 std::vector<llvm::Constant*> ProtocolElements;
1940 for (llvm::StringMapIterator<llvm::Constant*> iter =
1941 ExistingProtocols.begin(), endIter = ExistingProtocols.end();
1942 iter != endIter ; iter++) {
1943 llvm::Constant *Ptr = llvm::ConstantExpr::getBitCast(iter->getValue(),
1944 PtrTy);
1945 ProtocolElements.push_back(Ptr);
1946 }
1947 llvm::Constant * ProtocolArray = llvm::ConstantArray::get(ProtocolArrayTy,
1948 ProtocolElements);
1949 ProtocolElements.clear();
1950 ProtocolElements.push_back(NULLPtr);
1951 ProtocolElements.push_back(llvm::ConstantInt::get(LongTy,
1952 ExistingProtocols.size()));
1953 ProtocolElements.push_back(ProtocolArray);
1954 Elements.push_back(llvm::ConstantExpr::getBitCast(MakeGlobal(ProtocolListTy,
1955 ProtocolElements, ".objc_protocol_list"), PtrTy));
1956 Categories.push_back(llvm::ConstantExpr::getBitCast(
Chris Lattner845511f2011-06-18 22:49:11 +00001957 MakeGlobal(llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00001958 PtrTy, PtrTy, PtrTy, nullptr), Elements), PtrTy));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00001959}
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00001960
David Chisnallcdd207e2011-10-04 15:35:30 +00001961/// Libobjc2 uses a bitfield representation where small(ish) bitfields are
1962/// stored in a 64-bit value with the low bit set to 1 and the remaining 63
1963/// bits set to their values, LSB first, while larger ones are stored in a
1964/// structure of this / form:
1965///
1966/// struct { int32_t length; int32_t values[length]; };
1967///
1968/// The values in the array are stored in host-endian format, with the least
1969/// significant bit being assumed to come first in the bitfield. Therefore, a
1970/// bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] }, while a
1971/// bitfield / with the 63rd bit set will be 1<<64.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00001972llvm::Constant *CGObjCGNU::MakeBitField(ArrayRef<bool> bits) {
David Chisnallcdd207e2011-10-04 15:35:30 +00001973 int bitCount = bits.size();
Rafael Espindola3cc5c2d2014-01-09 21:32:51 +00001974 int ptrBits = CGM.getDataLayout().getPointerSizeInBits();
David Chisnalle89ac062011-10-25 10:12:21 +00001975 if (bitCount < ptrBits) {
David Chisnallcdd207e2011-10-04 15:35:30 +00001976 uint64_t val = 1;
1977 for (int i=0 ; i<bitCount ; ++i) {
Eli Friedman23526672011-10-08 01:03:47 +00001978 if (bits[i]) val |= 1ULL<<(i+1);
David Chisnallcdd207e2011-10-04 15:35:30 +00001979 }
David Chisnalle89ac062011-10-25 10:12:21 +00001980 return llvm::ConstantInt::get(IntPtrTy, val);
David Chisnallcdd207e2011-10-04 15:35:30 +00001981 }
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001982 SmallVector<llvm::Constant *, 8> values;
David Chisnallcdd207e2011-10-04 15:35:30 +00001983 int v=0;
1984 while (v < bitCount) {
1985 int32_t word = 0;
1986 for (int i=0 ; (i<32) && (v<bitCount) ; ++i) {
1987 if (bits[v]) word |= 1<<i;
1988 v++;
1989 }
1990 values.push_back(llvm::ConstantInt::get(Int32Ty, word));
1991 }
1992 llvm::ArrayType *arrayTy = llvm::ArrayType::get(Int32Ty, values.size());
1993 llvm::Constant *array = llvm::ConstantArray::get(arrayTy, values);
1994 llvm::Constant *fields[2] = {
1995 llvm::ConstantInt::get(Int32Ty, values.size()),
1996 array };
1997 llvm::Constant *GS = MakeGlobal(llvm::StructType::get(Int32Ty, arrayTy,
Craig Topper8a13c412014-05-21 05:09:00 +00001998 nullptr), fields);
David Chisnalle0dc7cb2011-10-08 08:54:36 +00001999 llvm::Constant *ptr = llvm::ConstantExpr::getPtrToInt(GS, IntPtrTy);
David Chisnalle0dc7cb2011-10-08 08:54:36 +00002000 return ptr;
David Chisnallcdd207e2011-10-04 15:35:30 +00002001}
2002
Daniel Dunbar92992502008-08-15 22:20:32 +00002003void CGObjCGNU::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Chris Lattner86d7d912008-11-24 03:54:41 +00002004 std::string ClassName = OCD->getClassInterface()->getNameAsString();
2005 std::string CategoryName = OCD->getNameAsString();
Daniel Dunbar92992502008-08-15 22:20:32 +00002006 // Collect information about instance methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002007 SmallVector<Selector, 16> InstanceMethodSels;
2008 SmallVector<llvm::Constant*, 16> InstanceMethodTypes;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002009 for (const auto *I : OCD->instance_methods()) {
2010 InstanceMethodSels.push_back(I->getSelector());
Daniel Dunbar92992502008-08-15 22:20:32 +00002011 std::string TypeStr;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002012 CGM.getContext().getObjCEncodingForMethodDecl(I,TypeStr);
David Chisnall5778fce2009-08-31 16:41:57 +00002013 InstanceMethodTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002014 }
2015
2016 // Collect information about class methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002017 SmallVector<Selector, 16> ClassMethodSels;
2018 SmallVector<llvm::Constant*, 16> ClassMethodTypes;
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002019 for (const auto *I : OCD->class_methods()) {
2020 ClassMethodSels.push_back(I->getSelector());
Daniel Dunbar92992502008-08-15 22:20:32 +00002021 std::string TypeStr;
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002022 CGM.getContext().getObjCEncodingForMethodDecl(I,TypeStr);
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
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002034 std::vector<llvm::Constant*> Elements;
2035 Elements.push_back(MakeConstantString(CategoryName));
2036 Elements.push_back(MakeConstantString(ClassName));
Mike Stump11289f42009-09-09 15:08:12 +00002037 // Instance method list
Owen Andersonade90fd2009-07-29 18:54:39 +00002038 Elements.push_back(llvm::ConstantExpr::getBitCast(GenerateMethodList(
Chris Lattnerbf231a62008-06-26 05:08:00 +00002039 ClassName, CategoryName, InstanceMethodSels, InstanceMethodTypes,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002040 false), PtrTy));
2041 // Class method list
Owen Andersonade90fd2009-07-29 18:54:39 +00002042 Elements.push_back(llvm::ConstantExpr::getBitCast(GenerateMethodList(
Chris Lattnerbf231a62008-06-26 05:08:00 +00002043 ClassName, CategoryName, ClassMethodSels, ClassMethodTypes, true),
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002044 PtrTy));
2045 // Protocol list
Owen Andersonade90fd2009-07-29 18:54:39 +00002046 Elements.push_back(llvm::ConstantExpr::getBitCast(
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002047 GenerateProtocolList(Protocols), PtrTy));
Owen Andersonade90fd2009-07-29 18:54:39 +00002048 Categories.push_back(llvm::ConstantExpr::getBitCast(
Chris Lattner845511f2011-06-18 22:49:11 +00002049 MakeGlobal(llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00002050 PtrTy, PtrTy, PtrTy, nullptr), Elements), PtrTy));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002051}
Daniel Dunbar92992502008-08-15 22:20:32 +00002052
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002053llvm::Constant *CGObjCGNU::GeneratePropertyList(const ObjCImplementationDecl *OID,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002054 SmallVectorImpl<Selector> &InstanceMethodSels,
2055 SmallVectorImpl<llvm::Constant*> &InstanceMethodTypes) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002056 ASTContext &Context = CGM.getContext();
David Chisnallbeb80132013-02-28 13:59:29 +00002057 // Property metadata: name, attributes, attributes2, padding1, padding2,
2058 // setter name, setter types, getter name, getter types.
Chris Lattner845511f2011-06-18 22:49:11 +00002059 llvm::StructType *PropertyMetadataTy = llvm::StructType::get(
David Chisnallbeb80132013-02-28 13:59:29 +00002060 PtrToInt8Ty, Int8Ty, Int8Ty, Int8Ty, Int8Ty, PtrToInt8Ty,
Craig Topper8a13c412014-05-21 05:09:00 +00002061 PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty, nullptr);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002062 std::vector<llvm::Constant*> Properties;
2063
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002064 // Add all of the property methods need adding to the method list and to the
2065 // property metadata list.
Aaron Ballmand85eff42014-03-14 15:02:45 +00002066 for (auto *propertyImpl : OID->property_impls()) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002067 std::vector<llvm::Constant*> Fields;
Aaron Ballmand85eff42014-03-14 15:02:45 +00002068 ObjCPropertyDecl *property = propertyImpl->getPropertyDecl();
David Chisnall36c63202010-02-26 01:11:38 +00002069 bool isSynthesized = (propertyImpl->getPropertyImplementation() ==
2070 ObjCPropertyImplDecl::Synthesize);
David Chisnallbeb80132013-02-28 13:59:29 +00002071 bool isDynamic = (propertyImpl->getPropertyImplementation() ==
2072 ObjCPropertyImplDecl::Dynamic);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002073
David Chisnalla5f59412012-10-16 15:11:55 +00002074 Fields.push_back(MakePropertyEncodingString(property, OID));
David Chisnallbeb80132013-02-28 13:59:29 +00002075 PushPropertyAttributes(Fields, property, isSynthesized, isDynamic);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002076 if (ObjCMethodDecl *getter = property->getGetterMethodDecl()) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002077 std::string TypeStr;
2078 Context.getObjCEncodingForMethodDecl(getter,TypeStr);
2079 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
David Chisnall36c63202010-02-26 01:11:38 +00002080 if (isSynthesized) {
2081 InstanceMethodTypes.push_back(TypeEncoding);
2082 InstanceMethodSels.push_back(getter->getSelector());
2083 }
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002084 Fields.push_back(MakeConstantString(getter->getSelector().getAsString()));
2085 Fields.push_back(TypeEncoding);
2086 } else {
2087 Fields.push_back(NULLPtr);
2088 Fields.push_back(NULLPtr);
2089 }
2090 if (ObjCMethodDecl *setter = property->getSetterMethodDecl()) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002091 std::string TypeStr;
2092 Context.getObjCEncodingForMethodDecl(setter,TypeStr);
2093 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
David Chisnall36c63202010-02-26 01:11:38 +00002094 if (isSynthesized) {
2095 InstanceMethodTypes.push_back(TypeEncoding);
2096 InstanceMethodSels.push_back(setter->getSelector());
2097 }
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002098 Fields.push_back(MakeConstantString(setter->getSelector().getAsString()));
2099 Fields.push_back(TypeEncoding);
2100 } else {
2101 Fields.push_back(NULLPtr);
2102 Fields.push_back(NULLPtr);
2103 }
2104 Properties.push_back(llvm::ConstantStruct::get(PropertyMetadataTy, Fields));
2105 }
2106 llvm::ArrayType *PropertyArrayTy =
2107 llvm::ArrayType::get(PropertyMetadataTy, Properties.size());
2108 llvm::Constant *PropertyArray = llvm::ConstantArray::get(PropertyArrayTy,
2109 Properties);
2110 llvm::Constant* PropertyListInitFields[] =
2111 {llvm::ConstantInt::get(IntTy, Properties.size()), NULLPtr, PropertyArray};
2112
2113 llvm::Constant *PropertyListInit =
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002114 llvm::ConstantStruct::getAnon(PropertyListInitFields);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002115 return new llvm::GlobalVariable(TheModule, PropertyListInit->getType(), false,
2116 llvm::GlobalValue::InternalLinkage, PropertyListInit,
2117 ".objc_property_list");
2118}
2119
David Chisnall92d436b2012-01-31 18:59:20 +00002120void CGObjCGNU::RegisterAlias(const ObjCCompatibleAliasDecl *OAD) {
2121 // Get the class declaration for which the alias is specified.
2122 ObjCInterfaceDecl *ClassDecl =
2123 const_cast<ObjCInterfaceDecl *>(OAD->getClassInterface());
2124 std::string ClassName = ClassDecl->getNameAsString();
2125 std::string AliasName = OAD->getNameAsString();
2126 ClassAliases.push_back(ClassAliasPair(ClassName,AliasName));
2127}
2128
Daniel Dunbar92992502008-08-15 22:20:32 +00002129void CGObjCGNU::GenerateClass(const ObjCImplementationDecl *OID) {
2130 ASTContext &Context = CGM.getContext();
2131
2132 // Get the superclass name.
Mike Stump11289f42009-09-09 15:08:12 +00002133 const ObjCInterfaceDecl * SuperClassDecl =
Daniel Dunbar92992502008-08-15 22:20:32 +00002134 OID->getClassInterface()->getSuperClass();
Chris Lattner86d7d912008-11-24 03:54:41 +00002135 std::string SuperClassName;
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002136 if (SuperClassDecl) {
Chris Lattner86d7d912008-11-24 03:54:41 +00002137 SuperClassName = SuperClassDecl->getNameAsString();
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002138 EmitClassRef(SuperClassName);
2139 }
Daniel Dunbar92992502008-08-15 22:20:32 +00002140
2141 // Get the class name
Chris Lattner87bc3872009-04-01 02:00:48 +00002142 ObjCInterfaceDecl *ClassDecl =
2143 const_cast<ObjCInterfaceDecl *>(OID->getClassInterface());
Chris Lattner86d7d912008-11-24 03:54:41 +00002144 std::string ClassName = ClassDecl->getNameAsString();
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002145 // Emit the symbol that is used to generate linker errors if this class is
2146 // referenced in other modules but not declared.
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00002147 std::string classSymbolName = "__objc_class_name_" + ClassName;
Mike Stump11289f42009-09-09 15:08:12 +00002148 if (llvm::GlobalVariable *symbol =
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00002149 TheModule.getGlobalVariable(classSymbolName)) {
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002150 symbol->setInitializer(llvm::ConstantInt::get(LongTy, 0));
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00002151 } else {
Owen Andersonc10c8d32009-07-08 19:05:04 +00002152 new llvm::GlobalVariable(TheModule, LongTy, false,
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002153 llvm::GlobalValue::ExternalLinkage, llvm::ConstantInt::get(LongTy, 0),
Owen Andersonc10c8d32009-07-08 19:05:04 +00002154 classSymbolName);
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00002155 }
Mike Stump11289f42009-09-09 15:08:12 +00002156
Daniel Dunbar12119b92009-05-03 10:46:44 +00002157 // Get the size of instances.
Ken Dyckc8ae5502011-02-09 01:59:34 +00002158 int instanceSize =
2159 Context.getASTObjCImplementationLayout(OID).getSize().getQuantity();
Daniel Dunbar92992502008-08-15 22:20:32 +00002160
2161 // Collect information about instance variables.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002162 SmallVector<llvm::Constant*, 16> IvarNames;
2163 SmallVector<llvm::Constant*, 16> IvarTypes;
2164 SmallVector<llvm::Constant*, 16> IvarOffsets;
Mike Stump11289f42009-09-09 15:08:12 +00002165
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002166 std::vector<llvm::Constant*> IvarOffsetValues;
David Chisnallcdd207e2011-10-04 15:35:30 +00002167 SmallVector<bool, 16> WeakIvars;
2168 SmallVector<bool, 16> StrongIvars;
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002169
Mike Stump11289f42009-09-09 15:08:12 +00002170 int superInstanceSize = !SuperClassDecl ? 0 :
Ken Dyckc8ae5502011-02-09 01:59:34 +00002171 Context.getASTObjCInterfaceLayout(SuperClassDecl).getSize().getQuantity();
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002172 // For non-fragile ivars, set the instance size to 0 - {the size of just this
2173 // class}. The runtime will then set this to the correct value on load.
Richard Smith9c6890a2012-11-01 22:30:59 +00002174 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002175 instanceSize = 0 - (instanceSize - superInstanceSize);
2176 }
David Chisnall18cf7372010-04-19 00:45:34 +00002177
Jordy Rosea91768e2011-07-22 02:08:32 +00002178 for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD;
2179 IVD = IVD->getNextIvar()) {
Daniel Dunbar92992502008-08-15 22:20:32 +00002180 // Store the name
David Chisnall18cf7372010-04-19 00:45:34 +00002181 IvarNames.push_back(MakeConstantString(IVD->getNameAsString()));
Daniel Dunbar92992502008-08-15 22:20:32 +00002182 // Get the type encoding for this ivar
2183 std::string TypeStr;
David Chisnall18cf7372010-04-19 00:45:34 +00002184 Context.getObjCEncodingForType(IVD->getType(), TypeStr);
David Chisnall5778fce2009-08-31 16:41:57 +00002185 IvarTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002186 // Get the offset
Eli Friedman8cbca202012-11-06 22:15:52 +00002187 uint64_t BaseOffset = ComputeIvarBaseOffset(CGM, OID, IVD);
David Chisnallcb1b7bf2009-11-17 19:32:15 +00002188 uint64_t Offset = BaseOffset;
Richard Smith9c6890a2012-11-01 22:30:59 +00002189 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002190 Offset = BaseOffset - superInstanceSize;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002191 }
David Chisnall1bfe6d32011-07-07 12:34:51 +00002192 llvm::Constant *OffsetValue = llvm::ConstantInt::get(IntTy, Offset);
2193 // Create the direct offset value
2194 std::string OffsetName = "__objc_ivar_offset_value_" + ClassName +"." +
2195 IVD->getNameAsString();
2196 llvm::GlobalVariable *OffsetVar = TheModule.getGlobalVariable(OffsetName);
2197 if (OffsetVar) {
2198 OffsetVar->setInitializer(OffsetValue);
2199 // If this is the real definition, change its linkage type so that
2200 // different modules will use this one, rather than their private
2201 // copy.
2202 OffsetVar->setLinkage(llvm::GlobalValue::ExternalLinkage);
2203 } else
2204 OffsetVar = new llvm::GlobalVariable(TheModule, IntTy,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002205 false, llvm::GlobalValue::ExternalLinkage,
David Chisnall1bfe6d32011-07-07 12:34:51 +00002206 OffsetValue,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002207 "__objc_ivar_offset_value_" + ClassName +"." +
David Chisnall1bfe6d32011-07-07 12:34:51 +00002208 IVD->getNameAsString());
2209 IvarOffsets.push_back(OffsetValue);
2210 IvarOffsetValues.push_back(OffsetVar);
David Chisnallcdd207e2011-10-04 15:35:30 +00002211 Qualifiers::ObjCLifetime lt = IVD->getType().getQualifiers().getObjCLifetime();
2212 switch (lt) {
2213 case Qualifiers::OCL_Strong:
2214 StrongIvars.push_back(true);
2215 WeakIvars.push_back(false);
2216 break;
2217 case Qualifiers::OCL_Weak:
2218 StrongIvars.push_back(false);
2219 WeakIvars.push_back(true);
2220 break;
2221 default:
2222 StrongIvars.push_back(false);
2223 WeakIvars.push_back(false);
2224 }
Daniel Dunbar92992502008-08-15 22:20:32 +00002225 }
David Chisnallcdd207e2011-10-04 15:35:30 +00002226 llvm::Constant *StrongIvarBitmap = MakeBitField(StrongIvars);
2227 llvm::Constant *WeakIvarBitmap = MakeBitField(WeakIvars);
David Chisnalld7972f52011-03-23 16:36:54 +00002228 llvm::GlobalVariable *IvarOffsetArray =
2229 MakeGlobalArray(PtrToIntTy, IvarOffsetValues, ".ivar.offsets");
2230
Daniel Dunbar92992502008-08-15 22:20:32 +00002231
2232 // Collect information about instance methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002233 SmallVector<Selector, 16> InstanceMethodSels;
2234 SmallVector<llvm::Constant*, 16> InstanceMethodTypes;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002235 for (const auto *I : OID->instance_methods()) {
2236 InstanceMethodSels.push_back(I->getSelector());
Daniel Dunbar92992502008-08-15 22:20:32 +00002237 std::string TypeStr;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002238 Context.getObjCEncodingForMethodDecl(I,TypeStr);
David Chisnall5778fce2009-08-31 16:41:57 +00002239 InstanceMethodTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002240 }
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002241
2242 llvm::Constant *Properties = GeneratePropertyList(OID, InstanceMethodSels,
2243 InstanceMethodTypes);
2244
Daniel Dunbar92992502008-08-15 22:20:32 +00002245
2246 // Collect information about class methods
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002247 SmallVector<Selector, 16> ClassMethodSels;
2248 SmallVector<llvm::Constant*, 16> ClassMethodTypes;
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002249 for (const auto *I : OID->class_methods()) {
2250 ClassMethodSels.push_back(I->getSelector());
Daniel Dunbar92992502008-08-15 22:20:32 +00002251 std::string TypeStr;
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002252 Context.getObjCEncodingForMethodDecl(I,TypeStr);
David Chisnall5778fce2009-08-31 16:41:57 +00002253 ClassMethodTypes.push_back(MakeConstantString(TypeStr));
Daniel Dunbar92992502008-08-15 22:20:32 +00002254 }
2255 // Collect the names of referenced protocols
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002256 SmallVector<std::string, 16> Protocols;
Aaron Ballmana49c5062014-03-13 20:29:09 +00002257 for (const auto *I : ClassDecl->protocols())
2258 Protocols.push_back(I->getNameAsString());
Daniel Dunbar92992502008-08-15 22:20:32 +00002259
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002260 // Get the superclass pointer.
2261 llvm::Constant *SuperClass;
Chris Lattner86d7d912008-11-24 03:54:41 +00002262 if (!SuperClassName.empty()) {
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002263 SuperClass = MakeConstantString(SuperClassName, ".super_class_name");
2264 } else {
Owen Anderson7ec07a52009-07-30 23:11:26 +00002265 SuperClass = llvm::ConstantPointerNull::get(PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002266 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002267 // Empty vector used to construct empty method lists
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002268 SmallVector<llvm::Constant*, 1> empty;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002269 // Generate the method and instance variable lists
2270 llvm::Constant *MethodList = GenerateMethodList(ClassName, "",
Chris Lattnerbf231a62008-06-26 05:08:00 +00002271 InstanceMethodSels, InstanceMethodTypes, false);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002272 llvm::Constant *ClassMethodList = GenerateMethodList(ClassName, "",
Chris Lattnerbf231a62008-06-26 05:08:00 +00002273 ClassMethodSels, ClassMethodTypes, true);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002274 llvm::Constant *IvarList = GenerateIvarList(IvarNames, IvarTypes,
2275 IvarOffsets);
Mike Stump11289f42009-09-09 15:08:12 +00002276 // Irrespective of whether we are compiling for a fragile or non-fragile ABI,
David Chisnall5778fce2009-08-31 16:41:57 +00002277 // we emit a symbol containing the offset for each ivar in the class. This
2278 // allows code compiled for the non-Fragile ABI to inherit from code compiled
2279 // for the legacy ABI, without causing problems. The converse is also
2280 // possible, but causes all ivar accesses to be fragile.
David Chisnalle8431a72010-11-03 16:12:44 +00002281
David Chisnall5778fce2009-08-31 16:41:57 +00002282 // Offset pointer for getting at the correct field in the ivar list when
2283 // setting up the alias. These are: The base address for the global, the
2284 // ivar array (second field), the ivar in this list (set for each ivar), and
2285 // the offset (third field in ivar structure)
David Chisnallcdd207e2011-10-04 15:35:30 +00002286 llvm::Type *IndexTy = Int32Ty;
David Chisnall5778fce2009-08-31 16:41:57 +00002287 llvm::Constant *offsetPointerIndexes[] = {Zeros[0],
Craig Topper8a13c412014-05-21 05:09:00 +00002288 llvm::ConstantInt::get(IndexTy, 1), nullptr,
David Chisnall5778fce2009-08-31 16:41:57 +00002289 llvm::ConstantInt::get(IndexTy, 2) };
2290
Jordy Rosea91768e2011-07-22 02:08:32 +00002291 unsigned ivarIndex = 0;
2292 for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD;
2293 IVD = IVD->getNextIvar()) {
David Chisnall5778fce2009-08-31 16:41:57 +00002294 const std::string Name = "__objc_ivar_offset_" + ClassName + '.'
David Chisnalle8431a72010-11-03 16:12:44 +00002295 + IVD->getNameAsString();
Jordy Rosea91768e2011-07-22 02:08:32 +00002296 offsetPointerIndexes[2] = llvm::ConstantInt::get(IndexTy, ivarIndex);
David Chisnall5778fce2009-08-31 16:41:57 +00002297 // Get the correct ivar field
2298 llvm::Constant *offsetValue = llvm::ConstantExpr::getGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00002299 cast<llvm::GlobalVariable>(IvarList)->getValueType(), IvarList,
2300 offsetPointerIndexes);
David Chisnalle8431a72010-11-03 16:12:44 +00002301 // Get the existing variable, if one exists.
David Chisnall5778fce2009-08-31 16:41:57 +00002302 llvm::GlobalVariable *offset = TheModule.getNamedGlobal(Name);
2303 if (offset) {
Ted Kremenek669669f2012-04-04 00:55:25 +00002304 offset->setInitializer(offsetValue);
2305 // If this is the real definition, change its linkage type so that
2306 // different modules will use this one, rather than their private
2307 // copy.
2308 offset->setLinkage(llvm::GlobalValue::ExternalLinkage);
David Chisnall5778fce2009-08-31 16:41:57 +00002309 } else {
Ted Kremenek669669f2012-04-04 00:55:25 +00002310 // Add a new alias if there isn't one already.
2311 offset = new llvm::GlobalVariable(TheModule, offsetValue->getType(),
2312 false, llvm::GlobalValue::ExternalLinkage, offsetValue, Name);
2313 (void) offset; // Silence dead store warning.
David Chisnall5778fce2009-08-31 16:41:57 +00002314 }
Jordy Rosea91768e2011-07-22 02:08:32 +00002315 ++ivarIndex;
David Chisnall5778fce2009-08-31 16:41:57 +00002316 }
David Chisnalle89ac062011-10-25 10:12:21 +00002317 llvm::Constant *ZeroPtr = llvm::ConstantInt::get(IntPtrTy, 0);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002318 //Generate metaclass for class methods
2319 llvm::Constant *MetaClassStruct = GenerateClassStructure(NULLPtr,
Craig Topper8a13c412014-05-21 05:09:00 +00002320 NULLPtr, 0x12L, ClassName.c_str(), nullptr, Zeros[0], GenerateIvarList(
David Chisnallcdd207e2011-10-04 15:35:30 +00002321 empty, empty, empty), ClassMethodList, NULLPtr,
David Chisnalle89ac062011-10-25 10:12:21 +00002322 NULLPtr, NULLPtr, ZeroPtr, ZeroPtr, true);
Daniel Dunbar566421c2009-05-04 15:31:17 +00002323
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002324 // Generate the class structure
Chris Lattner86d7d912008-11-24 03:54:41 +00002325 llvm::Constant *ClassStruct =
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002326 GenerateClassStructure(MetaClassStruct, SuperClass, 0x11L,
Craig Topper8a13c412014-05-21 05:09:00 +00002327 ClassName.c_str(), nullptr,
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002328 llvm::ConstantInt::get(LongTy, instanceSize), IvarList,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002329 MethodList, GenerateProtocolList(Protocols), IvarOffsetArray,
David Chisnallcdd207e2011-10-04 15:35:30 +00002330 Properties, StrongIvarBitmap, WeakIvarBitmap);
Daniel Dunbar566421c2009-05-04 15:31:17 +00002331
2332 // Resolve the class aliases, if they exist.
2333 if (ClassPtrAlias) {
David Chisnall82f755c2010-11-09 11:21:43 +00002334 ClassPtrAlias->replaceAllUsesWith(
Owen Andersonade90fd2009-07-29 18:54:39 +00002335 llvm::ConstantExpr::getBitCast(ClassStruct, IdTy));
David Chisnall82f755c2010-11-09 11:21:43 +00002336 ClassPtrAlias->eraseFromParent();
Craig Topper8a13c412014-05-21 05:09:00 +00002337 ClassPtrAlias = nullptr;
Daniel Dunbar566421c2009-05-04 15:31:17 +00002338 }
2339 if (MetaClassPtrAlias) {
David Chisnall82f755c2010-11-09 11:21:43 +00002340 MetaClassPtrAlias->replaceAllUsesWith(
Owen Andersonade90fd2009-07-29 18:54:39 +00002341 llvm::ConstantExpr::getBitCast(MetaClassStruct, IdTy));
David Chisnall82f755c2010-11-09 11:21:43 +00002342 MetaClassPtrAlias->eraseFromParent();
Craig Topper8a13c412014-05-21 05:09:00 +00002343 MetaClassPtrAlias = nullptr;
Daniel Dunbar566421c2009-05-04 15:31:17 +00002344 }
2345
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002346 // Add class structure to list to be added to the symtab later
Owen Andersonade90fd2009-07-29 18:54:39 +00002347 ClassStruct = llvm::ConstantExpr::getBitCast(ClassStruct, PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002348 Classes.push_back(ClassStruct);
2349}
2350
Fariborz Jahanian248c7192009-06-23 21:47:46 +00002351
Mike Stump11289f42009-09-09 15:08:12 +00002352llvm::Function *CGObjCGNU::ModuleInitFunction() {
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002353 // Only emit an ObjC load function if no Objective-C stuff has been called
2354 if (Classes.empty() && Categories.empty() && ConstantStrings.empty() &&
David Chisnalld7972f52011-03-23 16:36:54 +00002355 ExistingProtocols.empty() && SelectorTable.empty())
Craig Topper8a13c412014-05-21 05:09:00 +00002356 return nullptr;
Eli Friedman412c6682008-06-01 16:00:02 +00002357
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002358 // Add all referenced protocols to a category.
2359 GenerateProtocolHolderCategory();
2360
Chris Lattner2192fe52011-07-18 04:24:23 +00002361 llvm::StructType *SelStructTy = dyn_cast<llvm::StructType>(
Chris Lattner8d3f4a42009-01-27 05:06:01 +00002362 SelectorTy->getElementType());
Jay Foad7c57be32011-07-11 09:56:20 +00002363 llvm::Type *SelStructPtrTy = SelectorTy;
Craig Topper8a13c412014-05-21 05:09:00 +00002364 if (!SelStructTy) {
2365 SelStructTy = llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00002366 SelStructPtrTy = llvm::PointerType::getUnqual(SelStructTy);
Chris Lattner8d3f4a42009-01-27 05:06:01 +00002367 }
2368
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002369 std::vector<llvm::Constant*> Elements;
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00002370 llvm::Constant *Statics = NULLPtr;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002371 // Generate statics list:
Alexander Kornienko6ee521c2015-01-23 15:36:10 +00002372 if (!ConstantStrings.empty()) {
Owen Anderson9793f0e2009-07-29 22:16:19 +00002373 llvm::ArrayType *StaticsArrayTy = llvm::ArrayType::get(PtrToInt8Ty,
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00002374 ConstantStrings.size() + 1);
2375 ConstantStrings.push_back(NULLPtr);
David Chisnall5778fce2009-08-31 16:41:57 +00002376
David Blaikiebbafb8a2012-03-11 07:00:24 +00002377 StringRef StringClass = CGM.getLangOpts().ObjCConstantStringClass;
David Chisnalld7972f52011-03-23 16:36:54 +00002378
Daniel Dunbar75fa84e2009-11-29 02:38:47 +00002379 if (StringClass.empty()) StringClass = "NXConstantString";
David Chisnalld7972f52011-03-23 16:36:54 +00002380
David Chisnall5778fce2009-08-31 16:41:57 +00002381 Elements.push_back(MakeConstantString(StringClass,
2382 ".objc_static_class_name"));
Owen Anderson47034e12009-07-28 18:33:04 +00002383 Elements.push_back(llvm::ConstantArray::get(StaticsArrayTy,
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00002384 ConstantStrings));
Mike Stump11289f42009-09-09 15:08:12 +00002385 llvm::StructType *StaticsListTy =
Craig Topper8a13c412014-05-21 05:09:00 +00002386 llvm::StructType::get(PtrToInt8Ty, StaticsArrayTy, nullptr);
Owen Anderson170229f2009-07-14 23:10:40 +00002387 llvm::Type *StaticsListPtrTy =
Owen Anderson9793f0e2009-07-29 22:16:19 +00002388 llvm::PointerType::getUnqual(StaticsListTy);
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00002389 Statics = MakeGlobal(StaticsListTy, Elements, ".objc_statics");
Mike Stump11289f42009-09-09 15:08:12 +00002390 llvm::ArrayType *StaticsListArrayTy =
Owen Anderson9793f0e2009-07-29 22:16:19 +00002391 llvm::ArrayType::get(StaticsListPtrTy, 2);
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00002392 Elements.clear();
2393 Elements.push_back(Statics);
Owen Anderson0b75f232009-07-31 20:28:54 +00002394 Elements.push_back(llvm::Constant::getNullValue(StaticsListPtrTy));
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00002395 Statics = MakeGlobal(StaticsListArrayTy, Elements, ".objc_statics_ptr");
Owen Andersonade90fd2009-07-29 18:54:39 +00002396 Statics = llvm::ConstantExpr::getBitCast(Statics, PtrTy);
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00002397 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002398 // Array of classes, categories, and constant objects
Owen Anderson9793f0e2009-07-29 22:16:19 +00002399 llvm::ArrayType *ClassListTy = llvm::ArrayType::get(PtrToInt8Ty,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002400 Classes.size() + Categories.size() + 2);
Chris Lattner845511f2011-06-18 22:49:11 +00002401 llvm::StructType *SymTabTy = llvm::StructType::get(LongTy, SelStructPtrTy,
Owen Anderson41a75022009-08-13 21:57:51 +00002402 llvm::Type::getInt16Ty(VMContext),
2403 llvm::Type::getInt16Ty(VMContext),
Craig Topper8a13c412014-05-21 05:09:00 +00002404 ClassListTy, nullptr);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002405
2406 Elements.clear();
2407 // Pointer to an array of selectors used in this module.
2408 std::vector<llvm::Constant*> Selectors;
David Chisnalld7972f52011-03-23 16:36:54 +00002409 std::vector<llvm::GlobalAlias*> SelectorAliases;
2410 for (SelectorMap::iterator iter = SelectorTable.begin(),
2411 iterEnd = SelectorTable.end(); iter != iterEnd ; ++iter) {
2412
2413 std::string SelNameStr = iter->first.getAsString();
2414 llvm::Constant *SelName = ExportUniqueString(SelNameStr, ".objc_sel_name");
2415
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002416 SmallVectorImpl<TypedSelector> &Types = iter->second;
2417 for (SmallVectorImpl<TypedSelector>::iterator i = Types.begin(),
David Chisnalld7972f52011-03-23 16:36:54 +00002418 e = Types.end() ; i!=e ; i++) {
2419
2420 llvm::Constant *SelectorTypeEncoding = NULLPtr;
2421 if (!i->first.empty())
2422 SelectorTypeEncoding = MakeConstantString(i->first, ".objc_sel_types");
2423
2424 Elements.push_back(SelName);
2425 Elements.push_back(SelectorTypeEncoding);
2426 Selectors.push_back(llvm::ConstantStruct::get(SelStructTy, Elements));
2427 Elements.clear();
2428
2429 // Store the selector alias for later replacement
2430 SelectorAliases.push_back(i->second);
2431 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002432 }
David Chisnalld7972f52011-03-23 16:36:54 +00002433 unsigned SelectorCount = Selectors.size();
2434 // NULL-terminate the selector list. This should not actually be required,
2435 // because the selector list has a length field. Unfortunately, the GCC
2436 // runtime decides to ignore the length field and expects a NULL terminator,
2437 // and GCC cooperates with this by always setting the length to 0.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002438 Elements.push_back(NULLPtr);
2439 Elements.push_back(NULLPtr);
Owen Anderson0e0189d2009-07-27 22:29:56 +00002440 Selectors.push_back(llvm::ConstantStruct::get(SelStructTy, Elements));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002441 Elements.clear();
David Chisnalld7972f52011-03-23 16:36:54 +00002442
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002443 // Number of static selectors
David Chisnalld7972f52011-03-23 16:36:54 +00002444 Elements.push_back(llvm::ConstantInt::get(LongTy, SelectorCount));
David Blaikiee3b172a2015-04-02 18:55:21 +00002445 llvm::GlobalVariable *SelectorList =
2446 MakeGlobalArray(SelStructTy, Selectors, ".objc_selector_list");
Mike Stump11289f42009-09-09 15:08:12 +00002447 Elements.push_back(llvm::ConstantExpr::getBitCast(SelectorList,
Chris Lattner8d3f4a42009-01-27 05:06:01 +00002448 SelStructPtrTy));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002449
2450 // Now that all of the static selectors exist, create pointers to them.
David Chisnalld7972f52011-03-23 16:36:54 +00002451 for (unsigned int i=0 ; i<SelectorCount ; i++) {
2452
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002453 llvm::Constant *Idxs[] = {Zeros[0],
David Chisnallcdd207e2011-10-04 15:35:30 +00002454 llvm::ConstantInt::get(Int32Ty, i), Zeros[0]};
David Chisnalld7972f52011-03-23 16:36:54 +00002455 // FIXME: We're generating redundant loads and stores here!
David Blaikiee3b172a2015-04-02 18:55:21 +00002456 llvm::Constant *SelPtr = llvm::ConstantExpr::getGetElementPtr(
2457 SelectorList->getValueType(), SelectorList, makeArrayRef(Idxs, 2));
Chris Lattner8d3f4a42009-01-27 05:06:01 +00002458 // If selectors are defined as an opaque type, cast the pointer to this
2459 // type.
David Chisnall76803412011-03-23 22:52:06 +00002460 SelPtr = llvm::ConstantExpr::getBitCast(SelPtr, SelectorTy);
David Chisnalld7972f52011-03-23 16:36:54 +00002461 SelectorAliases[i]->replaceAllUsesWith(SelPtr);
2462 SelectorAliases[i]->eraseFromParent();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002463 }
David Chisnalld7972f52011-03-23 16:36:54 +00002464
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002465 // Number of classes defined.
Mike Stump11289f42009-09-09 15:08:12 +00002466 Elements.push_back(llvm::ConstantInt::get(llvm::Type::getInt16Ty(VMContext),
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002467 Classes.size()));
2468 // Number of categories defined
Mike Stump11289f42009-09-09 15:08:12 +00002469 Elements.push_back(llvm::ConstantInt::get(llvm::Type::getInt16Ty(VMContext),
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002470 Categories.size()));
2471 // Create an array of classes, then categories, then static object instances
2472 Classes.insert(Classes.end(), Categories.begin(), Categories.end());
2473 // NULL-terminated list of static object instances (mainly constant strings)
2474 Classes.push_back(Statics);
2475 Classes.push_back(NULLPtr);
Owen Anderson47034e12009-07-28 18:33:04 +00002476 llvm::Constant *ClassList = llvm::ConstantArray::get(ClassListTy, Classes);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002477 Elements.push_back(ClassList);
Mike Stump11289f42009-09-09 15:08:12 +00002478 // Construct the symbol table
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002479 llvm::Constant *SymTab= MakeGlobal(SymTabTy, Elements);
2480
2481 // The symbol table is contained in a module which has some version-checking
2482 // constants
Chris Lattner845511f2011-06-18 22:49:11 +00002483 llvm::StructType * ModuleTy = llvm::StructType::get(LongTy, LongTy,
David Chisnall5c511772011-05-22 22:37:08 +00002484 PtrToInt8Ty, llvm::PointerType::getUnqual(SymTabTy),
Craig Topper8a13c412014-05-21 05:09:00 +00002485 (RuntimeVersion >= 10) ? IntTy : nullptr, nullptr);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002486 Elements.clear();
David Chisnalld7972f52011-03-23 16:36:54 +00002487 // Runtime version, used for ABI compatibility checking.
2488 Elements.push_back(llvm::ConstantInt::get(LongTy, RuntimeVersion));
Fariborz Jahanianc2d56182009-04-01 19:49:42 +00002489 // sizeof(ModuleTy)
Micah Villmowdd31ca12012-10-08 16:25:52 +00002490 llvm::DataLayout td(&TheModule);
Ken Dyck0fed10e2011-04-22 17:59:22 +00002491 Elements.push_back(
2492 llvm::ConstantInt::get(LongTy,
2493 td.getTypeSizeInBits(ModuleTy) /
2494 CGM.getContext().getCharWidth()));
David Chisnalld7972f52011-03-23 16:36:54 +00002495
2496 // The path to the source file where this module was declared
2497 SourceManager &SM = CGM.getContext().getSourceManager();
2498 const FileEntry *mainFile = SM.getFileEntryForID(SM.getMainFileID());
2499 std::string path =
2500 std::string(mainFile->getDir()->getName()) + '/' + mainFile->getName();
2501 Elements.push_back(MakeConstantString(path, ".objc_source_file_name"));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002502 Elements.push_back(SymTab);
David Chisnall5c511772011-05-22 22:37:08 +00002503
David Chisnalla918b882011-07-07 11:22:31 +00002504 if (RuntimeVersion >= 10)
David Blaikiebbafb8a2012-03-11 07:00:24 +00002505 switch (CGM.getLangOpts().getGC()) {
David Chisnalla918b882011-07-07 11:22:31 +00002506 case LangOptions::GCOnly:
David Chisnall5c511772011-05-22 22:37:08 +00002507 Elements.push_back(llvm::ConstantInt::get(IntTy, 2));
David Chisnall5c511772011-05-22 22:37:08 +00002508 break;
David Chisnalla918b882011-07-07 11:22:31 +00002509 case LangOptions::NonGC:
David Blaikiebbafb8a2012-03-11 07:00:24 +00002510 if (CGM.getLangOpts().ObjCAutoRefCount)
David Chisnalla918b882011-07-07 11:22:31 +00002511 Elements.push_back(llvm::ConstantInt::get(IntTy, 1));
2512 else
2513 Elements.push_back(llvm::ConstantInt::get(IntTy, 0));
2514 break;
2515 case LangOptions::HybridGC:
2516 Elements.push_back(llvm::ConstantInt::get(IntTy, 1));
2517 break;
2518 }
David Chisnall5c511772011-05-22 22:37:08 +00002519
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002520 llvm::Value *Module = MakeGlobal(ModuleTy, Elements);
2521
2522 // Create the load function calling the runtime entry point with the module
2523 // structure
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002524 llvm::Function * LoadFunction = llvm::Function::Create(
Owen Anderson41a75022009-08-13 21:57:51 +00002525 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext), false),
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002526 llvm::GlobalValue::InternalLinkage, ".objc_load_function",
2527 &TheModule);
Owen Anderson41a75022009-08-13 21:57:51 +00002528 llvm::BasicBlock *EntryBB =
2529 llvm::BasicBlock::Create(VMContext, "entry", LoadFunction);
Owen Anderson170229f2009-07-14 23:10:40 +00002530 CGBuilderTy Builder(VMContext);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002531 Builder.SetInsertPoint(EntryBB);
Fariborz Jahanian3b636c12009-03-30 18:02:14 +00002532
Benjamin Kramerdf1fb132011-05-28 14:26:31 +00002533 llvm::FunctionType *FT =
Jay Foad5709f7c2011-07-29 13:56:53 +00002534 llvm::FunctionType::get(Builder.getVoidTy(),
2535 llvm::PointerType::getUnqual(ModuleTy), true);
Benjamin Kramerdf1fb132011-05-28 14:26:31 +00002536 llvm::Value *Register = CGM.CreateRuntimeFunction(FT, "__objc_exec_class");
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002537 Builder.CreateCall(Register, Module);
David Chisnall92d436b2012-01-31 18:59:20 +00002538
David Chisnallaf066bbb2012-02-01 19:16:56 +00002539 if (!ClassAliases.empty()) {
David Chisnall92d436b2012-01-31 18:59:20 +00002540 llvm::Type *ArgTypes[2] = {PtrTy, PtrToInt8Ty};
2541 llvm::FunctionType *RegisterAliasTy =
2542 llvm::FunctionType::get(Builder.getVoidTy(),
2543 ArgTypes, false);
2544 llvm::Function *RegisterAlias = llvm::Function::Create(
2545 RegisterAliasTy,
2546 llvm::GlobalValue::ExternalWeakLinkage, "class_registerAlias_np",
2547 &TheModule);
2548 llvm::BasicBlock *AliasBB =
2549 llvm::BasicBlock::Create(VMContext, "alias", LoadFunction);
2550 llvm::BasicBlock *NoAliasBB =
2551 llvm::BasicBlock::Create(VMContext, "no_alias", LoadFunction);
2552
2553 // Branch based on whether the runtime provided class_registerAlias_np()
2554 llvm::Value *HasRegisterAlias = Builder.CreateICmpNE(RegisterAlias,
2555 llvm::Constant::getNullValue(RegisterAlias->getType()));
2556 Builder.CreateCondBr(HasRegisterAlias, AliasBB, NoAliasBB);
2557
Alp Tokerf6a24ce2013-12-05 16:25:25 +00002558 // The true branch (has alias registration function):
David Chisnall92d436b2012-01-31 18:59:20 +00002559 Builder.SetInsertPoint(AliasBB);
2560 // Emit alias registration calls:
2561 for (std::vector<ClassAliasPair>::iterator iter = ClassAliases.begin();
2562 iter != ClassAliases.end(); ++iter) {
2563 llvm::Constant *TheClass =
2564 TheModule.getGlobalVariable(("_OBJC_CLASS_" + iter->first).c_str(),
2565 true);
Craig Topper8a13c412014-05-21 05:09:00 +00002566 if (TheClass) {
David Chisnall92d436b2012-01-31 18:59:20 +00002567 TheClass = llvm::ConstantExpr::getBitCast(TheClass, PtrTy);
David Blaikie43f9bb72015-05-18 22:14:03 +00002568 Builder.CreateCall(RegisterAlias,
2569 {TheClass, MakeConstantString(iter->second)});
David Chisnall92d436b2012-01-31 18:59:20 +00002570 }
2571 }
2572 // Jump to end:
2573 Builder.CreateBr(NoAliasBB);
2574
2575 // Missing alias registration function, just return from the function:
2576 Builder.SetInsertPoint(NoAliasBB);
2577 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002578 Builder.CreateRetVoid();
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002579
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002580 return LoadFunction;
2581}
Daniel Dunbar92992502008-08-15 22:20:32 +00002582
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00002583llvm::Function *CGObjCGNU::GenerateMethod(const ObjCMethodDecl *OMD,
Mike Stump11289f42009-09-09 15:08:12 +00002584 const ObjCContainerDecl *CD) {
2585 const ObjCCategoryImplDecl *OCD =
Steve Naroff11b387f2009-01-08 19:41:02 +00002586 dyn_cast<ObjCCategoryImplDecl>(OMD->getDeclContext());
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002587 StringRef CategoryName = OCD ? OCD->getName() : "";
2588 StringRef ClassName = CD->getName();
David Chisnalld7972f52011-03-23 16:36:54 +00002589 Selector MethodName = OMD->getSelector();
Douglas Gregorffca3a22009-01-09 17:18:27 +00002590 bool isClassMethod = !OMD->isInstanceMethod();
Daniel Dunbar92992502008-08-15 22:20:32 +00002591
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00002592 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00002593 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00002594 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002595 std::string FunctionName = SymbolNameForMethod(ClassName, CategoryName,
2596 MethodName, isClassMethod);
2597
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00002598 llvm::Function *Method
Mike Stump11289f42009-09-09 15:08:12 +00002599 = llvm::Function::Create(MethodTy,
2600 llvm::GlobalValue::InternalLinkage,
2601 FunctionName,
2602 &TheModule);
Chris Lattner4bd55962008-03-30 23:03:07 +00002603 return Method;
2604}
2605
David Chisnall3fe89562011-05-23 22:33:28 +00002606llvm::Constant *CGObjCGNU::GetPropertyGetFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002607 return GetPropertyFn;
Daniel Dunbara91c3e02008-09-24 03:38:44 +00002608}
2609
David Chisnall3fe89562011-05-23 22:33:28 +00002610llvm::Constant *CGObjCGNU::GetPropertySetFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002611 return SetPropertyFn;
Daniel Dunbara91c3e02008-09-24 03:38:44 +00002612}
2613
Ted Kremeneke65b0862012-03-06 20:05:56 +00002614llvm::Constant *CGObjCGNU::GetOptimizedPropertySetFunction(bool atomic,
2615 bool copy) {
Craig Topper8a13c412014-05-21 05:09:00 +00002616 return nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +00002617}
2618
David Chisnall3fe89562011-05-23 22:33:28 +00002619llvm::Constant *CGObjCGNU::GetGetStructFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002620 return GetStructPropertyFn;
David Chisnall168b80f2010-12-26 22:13:16 +00002621}
David Chisnall3fe89562011-05-23 22:33:28 +00002622llvm::Constant *CGObjCGNU::GetSetStructFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002623 return SetStructPropertyFn;
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00002624}
David Chisnall0d75e062012-12-17 18:54:24 +00002625llvm::Constant *CGObjCGNU::GetCppAtomicObjectGetFunction() {
Craig Topper8a13c412014-05-21 05:09:00 +00002626 return nullptr;
David Chisnall0d75e062012-12-17 18:54:24 +00002627}
2628llvm::Constant *CGObjCGNU::GetCppAtomicObjectSetFunction() {
Craig Topper8a13c412014-05-21 05:09:00 +00002629 return nullptr;
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00002630}
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00002631
Daniel Dunbarc46a0792009-07-24 07:40:24 +00002632llvm::Constant *CGObjCGNU::EnumerationMutationFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00002633 return EnumerationMutationFn;
Anders Carlsson3f35a262008-08-31 04:05:03 +00002634}
2635
David Chisnalld7972f52011-03-23 16:36:54 +00002636void CGObjCGNU::EmitSynchronizedStmt(CodeGenFunction &CGF,
John McCallbd309292010-07-06 01:34:17 +00002637 const ObjCAtSynchronizedStmt &S) {
David Chisnalld3858d62011-03-25 11:57:33 +00002638 EmitAtSynchronizedStmt(CGF, S, SyncEnterFn, SyncExitFn);
John McCallbd309292010-07-06 01:34:17 +00002639}
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002640
David Chisnall3a509cd2009-12-24 02:26:34 +00002641
David Chisnalld7972f52011-03-23 16:36:54 +00002642void CGObjCGNU::EmitTryStmt(CodeGenFunction &CGF,
John McCallbd309292010-07-06 01:34:17 +00002643 const ObjCAtTryStmt &S) {
2644 // Unlike the Apple non-fragile runtimes, which also uses
2645 // unwind-based zero cost exceptions, the GNU Objective C runtime's
2646 // EH support isn't a veneer over C++ EH. Instead, exception
David Chisnall9a837be2012-11-07 16:50:40 +00002647 // objects are created by objc_exception_throw and destroyed by
John McCallbd309292010-07-06 01:34:17 +00002648 // the personality function; this avoids the need for bracketing
2649 // catch handlers with calls to __blah_begin_catch/__blah_end_catch
2650 // (or even _Unwind_DeleteException), but probably doesn't
2651 // interoperate very well with foreign exceptions.
David Chisnalld3858d62011-03-25 11:57:33 +00002652 //
David Chisnalle1d2584d2011-03-20 21:35:39 +00002653 // In Objective-C++ mode, we actually emit something equivalent to the C++
David Chisnalld3858d62011-03-25 11:57:33 +00002654 // exception handler.
2655 EmitTryCatchStmt(CGF, S, EnterCatchFn, ExitCatchFn, ExceptionReThrowFn);
2656 return ;
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002657}
2658
David Chisnalld7972f52011-03-23 16:36:54 +00002659void CGObjCGNU::EmitThrowStmt(CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00002660 const ObjCAtThrowStmt &S,
2661 bool ClearInsertionPoint) {
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002662 llvm::Value *ExceptionAsObject;
2663
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002664 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00002665 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Fariborz Jahanian078cd522009-05-17 16:49:27 +00002666 ExceptionAsObject = Exception;
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002667 } else {
Mike Stump11289f42009-09-09 15:08:12 +00002668 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00002669 "Unexpected rethrow outside @catch block.");
2670 ExceptionAsObject = CGF.ObjCEHValueStack.back();
2671 }
Benjamin Kramer76399eb2011-09-27 21:06:10 +00002672 ExceptionAsObject = CGF.Builder.CreateBitCast(ExceptionAsObject, IdTy);
David Chisnall9a837be2012-11-07 16:50:40 +00002673 llvm::CallSite Throw =
John McCall882987f2013-02-28 19:01:20 +00002674 CGF.EmitRuntimeCallOrInvoke(ExceptionThrowFn, ExceptionAsObject);
David Chisnall9a837be2012-11-07 16:50:40 +00002675 Throw.setDoesNotReturn();
Eli Friedmandc009da2012-08-10 21:26:17 +00002676 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00002677 if (ClearInsertionPoint)
2678 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00002679}
2680
David Chisnalld7972f52011-03-23 16:36:54 +00002681llvm::Value * CGObjCGNU::EmitObjCWeakRead(CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00002682 llvm::Value *AddrWeakObj) {
John McCall882987f2013-02-28 19:01:20 +00002683 CGBuilderTy &B = CGF.Builder;
David Chisnallfcb37e92011-05-30 12:00:26 +00002684 AddrWeakObj = EnforceType(B, AddrWeakObj, PtrToIdTy);
David Blaikiebf178d32015-05-19 21:31:34 +00002685 return B.CreateCall(WeakReadFn.getType(), WeakReadFn, AddrWeakObj);
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00002686}
2687
David Chisnalld7972f52011-03-23 16:36:54 +00002688void CGObjCGNU::EmitObjCWeakAssign(CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00002689 llvm::Value *src, llvm::Value *dst) {
John McCall882987f2013-02-28 19:01:20 +00002690 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00002691 src = EnforceType(B, src, IdTy);
2692 dst = EnforceType(B, dst, PtrToIdTy);
David Blaikiebf178d32015-05-19 21:31:34 +00002693 B.CreateCall(WeakAssignFn.getType(), WeakAssignFn, {src, dst});
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00002694}
2695
David Chisnalld7972f52011-03-23 16:36:54 +00002696void CGObjCGNU::EmitObjCGlobalAssign(CodeGenFunction &CGF,
Fariborz Jahanian217af242010-07-20 20:30:03 +00002697 llvm::Value *src, llvm::Value *dst,
2698 bool threadlocal) {
John McCall882987f2013-02-28 19:01:20 +00002699 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00002700 src = EnforceType(B, src, IdTy);
2701 dst = EnforceType(B, dst, PtrToIdTy);
David Blaikie43f9bb72015-05-18 22:14:03 +00002702 // FIXME. Add threadloca assign API
2703 assert(!threadlocal && "EmitObjCGlobalAssign - Threal Local API NYI");
David Blaikiebf178d32015-05-19 21:31:34 +00002704 B.CreateCall(GlobalAssignFn.getType(), GlobalAssignFn, {src, dst});
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00002705}
2706
David Chisnalld7972f52011-03-23 16:36:54 +00002707void CGObjCGNU::EmitObjCIvarAssign(CodeGenFunction &CGF,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00002708 llvm::Value *src, llvm::Value *dst,
2709 llvm::Value *ivarOffset) {
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);
David Chisnalle4e5c0f2011-05-25 20:33:17 +00002712 dst = EnforceType(B, dst, IdTy);
David Blaikiebf178d32015-05-19 21:31:34 +00002713 B.CreateCall(IvarAssignFn.getType(), IvarAssignFn, {src, dst, ivarOffset});
Fariborz Jahaniane881b532008-11-20 19:23:36 +00002714}
2715
David Chisnalld7972f52011-03-23 16:36:54 +00002716void CGObjCGNU::EmitObjCStrongCastAssign(CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00002717 llvm::Value *src, llvm::Value *dst) {
John McCall882987f2013-02-28 19:01:20 +00002718 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00002719 src = EnforceType(B, src, IdTy);
2720 dst = EnforceType(B, dst, PtrToIdTy);
David Blaikiebf178d32015-05-19 21:31:34 +00002721 B.CreateCall(StrongCastAssignFn.getType(), StrongCastAssignFn, {src, dst});
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00002722}
2723
David Chisnalld7972f52011-03-23 16:36:54 +00002724void CGObjCGNU::EmitGCMemmoveCollectable(CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00002725 llvm::Value *DestPtr,
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002726 llvm::Value *SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00002727 llvm::Value *Size) {
John McCall882987f2013-02-28 19:01:20 +00002728 CGBuilderTy &B = CGF.Builder;
David Chisnall7441d882011-05-28 14:23:43 +00002729 DestPtr = EnforceType(B, DestPtr, PtrTy);
2730 SrcPtr = EnforceType(B, SrcPtr, PtrTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00002731
David Blaikiebf178d32015-05-19 21:31:34 +00002732 B.CreateCall(MemMoveFn.getType(), MemMoveFn, {DestPtr, SrcPtr, Size});
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00002733}
2734
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002735llvm::GlobalVariable *CGObjCGNU::ObjCIvarOffsetVariable(
2736 const ObjCInterfaceDecl *ID,
2737 const ObjCIvarDecl *Ivar) {
2738 const std::string Name = "__objc_ivar_offset_" + ID->getNameAsString()
2739 + '.' + Ivar->getNameAsString();
2740 // Emit the variable and initialize it with what we think the correct value
2741 // is. This allows code compiled with non-fragile ivars to work correctly
2742 // when linked against code which isn't (most of the time).
David Chisnall5778fce2009-08-31 16:41:57 +00002743 llvm::GlobalVariable *IvarOffsetPointer = TheModule.getNamedGlobal(Name);
2744 if (!IvarOffsetPointer) {
David Chisnalle8431a72010-11-03 16:12:44 +00002745 // This will cause a run-time crash if we accidentally use it. A value of
2746 // 0 would seem more sensible, but will silently overwrite the isa pointer
2747 // causing a great deal of confusion.
2748 uint64_t Offset = -1;
2749 // We can't call ComputeIvarBaseOffset() here if we have the
2750 // implementation, because it will create an invalid ASTRecordLayout object
2751 // that we are then stuck with forever, so we only initialize the ivar
2752 // offset variable with a guess if we only have the interface. The
2753 // initializer will be reset later anyway, when we are generating the class
2754 // description.
2755 if (!CGM.getContext().getObjCImplementation(
Dan Gohman145f3f12010-04-19 16:39:44 +00002756 const_cast<ObjCInterfaceDecl *>(ID)))
Eli Friedman8cbca202012-11-06 22:15:52 +00002757 Offset = ComputeIvarBaseOffset(CGM, ID, Ivar);
David Chisnall44ec5552010-04-19 01:37:25 +00002758
David Chisnalle0dc7cb2011-10-08 08:54:36 +00002759 llvm::ConstantInt *OffsetGuess = llvm::ConstantInt::get(Int32Ty, Offset,
Richard Trieue4f31802011-09-21 02:46:06 +00002760 /*isSigned*/true);
David Chisnall5778fce2009-08-31 16:41:57 +00002761 // Don't emit the guess in non-PIC code because the linker will not be able
2762 // to replace it with the real version for a library. In non-PIC code you
2763 // must compile with the fragile ABI if you want to use ivars from a
Mike Stump11289f42009-09-09 15:08:12 +00002764 // GCC-compiled class.
Chandler Carruthc0c04552012-04-08 16:40:35 +00002765 if (CGM.getLangOpts().PICLevel || CGM.getLangOpts().PIELevel) {
David Chisnall5778fce2009-08-31 16:41:57 +00002766 llvm::GlobalVariable *IvarOffsetGV = new llvm::GlobalVariable(TheModule,
David Chisnallcdd207e2011-10-04 15:35:30 +00002767 Int32Ty, false,
David Chisnall5778fce2009-08-31 16:41:57 +00002768 llvm::GlobalValue::PrivateLinkage, OffsetGuess, Name+".guess");
2769 IvarOffsetPointer = new llvm::GlobalVariable(TheModule,
2770 IvarOffsetGV->getType(), false, llvm::GlobalValue::LinkOnceAnyLinkage,
2771 IvarOffsetGV, Name);
2772 } else {
2773 IvarOffsetPointer = new llvm::GlobalVariable(TheModule,
Benjamin Kramerabd5b902009-10-13 10:07:13 +00002774 llvm::Type::getInt32PtrTy(VMContext), false,
Craig Topper8a13c412014-05-21 05:09:00 +00002775 llvm::GlobalValue::ExternalLinkage, nullptr, Name);
David Chisnall5778fce2009-08-31 16:41:57 +00002776 }
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002777 }
David Chisnall5778fce2009-08-31 16:41:57 +00002778 return IvarOffsetPointer;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002779}
2780
David Chisnalld7972f52011-03-23 16:36:54 +00002781LValue CGObjCGNU::EmitObjCValueForIvar(CodeGenFunction &CGF,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00002782 QualType ObjectTy,
2783 llvm::Value *BaseValue,
2784 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00002785 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00002786 const ObjCInterfaceDecl *ID =
2787 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00002788 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
2789 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00002790}
Mike Stumpdd93a192009-07-31 21:31:32 +00002791
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002792static const ObjCInterfaceDecl *FindIvarInterface(ASTContext &Context,
2793 const ObjCInterfaceDecl *OID,
2794 const ObjCIvarDecl *OIVD) {
Jordy Rosea91768e2011-07-22 02:08:32 +00002795 for (const ObjCIvarDecl *next = OID->all_declared_ivar_begin(); next;
2796 next = next->getNextIvar()) {
2797 if (OIVD == next)
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002798 return OID;
2799 }
Mike Stump11289f42009-09-09 15:08:12 +00002800
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002801 // Otherwise check in the super class.
2802 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
2803 return FindIvarInterface(Context, Super, OIVD);
Mike Stump11289f42009-09-09 15:08:12 +00002804
Craig Topper8a13c412014-05-21 05:09:00 +00002805 return nullptr;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002806}
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00002807
David Chisnalld7972f52011-03-23 16:36:54 +00002808llvm::Value *CGObjCGNU::EmitIvarOffset(CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00002809 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00002810 const ObjCIvarDecl *Ivar) {
John McCall5fb5df92012-06-20 06:18:46 +00002811 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002812 Interface = FindIvarInterface(CGM.getContext(), Interface, Ivar);
David Chisnall1bfe6d32011-07-07 12:34:51 +00002813 if (RuntimeVersion < 10)
2814 return CGF.Builder.CreateZExtOrBitCast(
2815 CGF.Builder.CreateLoad(CGF.Builder.CreateLoad(
2816 ObjCIvarOffsetVariable(Interface, Ivar), false, "ivar")),
2817 PtrDiffTy);
2818 std::string name = "__objc_ivar_offset_value_" +
2819 Interface->getNameAsString() +"." + Ivar->getNameAsString();
2820 llvm::Value *Offset = TheModule.getGlobalVariable(name);
2821 if (!Offset)
2822 Offset = new llvm::GlobalVariable(TheModule, IntTy,
David Chisnall28dc7f92011-08-01 17:36:53 +00002823 false, llvm::GlobalValue::LinkOnceAnyLinkage,
2824 llvm::Constant::getNullValue(IntTy), name);
David Chisnalla79b4692012-04-06 15:39:12 +00002825 Offset = CGF.Builder.CreateLoad(Offset);
2826 if (Offset->getType() != PtrDiffTy)
2827 Offset = CGF.Builder.CreateZExtOrBitCast(Offset, PtrDiffTy);
2828 return Offset;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00002829 }
Eli Friedman8cbca202012-11-06 22:15:52 +00002830 uint64_t Offset = ComputeIvarBaseOffset(CGF.CGM, Interface, Ivar);
2831 return llvm::ConstantInt::get(PtrDiffTy, Offset, /*isSigned*/true);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00002832}
2833
David Chisnalld7972f52011-03-23 16:36:54 +00002834CGObjCRuntime *
2835clang::CodeGen::CreateGNUObjCRuntime(CodeGenModule &CGM) {
John McCall5fb5df92012-06-20 06:18:46 +00002836 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
David Chisnallb601c962012-07-03 20:49:52 +00002837 case ObjCRuntime::GNUstep:
David Chisnalld7972f52011-03-23 16:36:54 +00002838 return new CGObjCGNUstep(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00002839
David Chisnallb601c962012-07-03 20:49:52 +00002840 case ObjCRuntime::GCC:
John McCall5fb5df92012-06-20 06:18:46 +00002841 return new CGObjCGCC(CGM);
2842
John McCall775086e2012-07-12 02:07:58 +00002843 case ObjCRuntime::ObjFW:
2844 return new CGObjCObjFW(CGM);
2845
John McCall5fb5df92012-06-20 06:18:46 +00002846 case ObjCRuntime::FragileMacOSX:
2847 case ObjCRuntime::MacOSX:
2848 case ObjCRuntime::iOS:
2849 llvm_unreachable("these runtimes are not GNU runtimes");
2850 }
2851 llvm_unreachable("bad runtime");
Chris Lattnerb7256cd2008-03-01 08:50:34 +00002852}