blob: 479cd8ec77cecdde9d7a0681af41761ddc3a5126 [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//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Chris Lattnerb7256cd2008-03-01 08:50:34 +00006//
7//===----------------------------------------------------------------------===//
8//
Chris Lattner57540c52011-04-15 05:22:18 +00009// This provides Objective-C code generation targeting the GNU runtime. The
Anton Korobeynikov1200aca2008-06-01 14:13:53 +000010// class in this file generates structures used by the GNU Objective-C runtime
11// library. These structures are defined in objc/objc.h and objc/objc-api.h in
12// the GNU runtime distribution.
Chris Lattnerb7256cd2008-03-01 08:50:34 +000013//
14//===----------------------------------------------------------------------===//
15
Reid Kleckner98031782019-12-09 16:11:56 -080016#include "CGCXXABI.h"
John McCalled1ae862011-01-28 11:13:47 +000017#include "CGCleanup.h"
Reid Kleckner98031782019-12-09 16:11:56 -080018#include "CGObjCRuntime.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"
Reid Kleckner98031782019-12-09 16:11:56 -080022#include "clang/AST/Attr.h"
Daniel Dunbar221fa942008-08-11 04:54:23 +000023#include "clang/AST/Decl.h"
Daniel Dunbar89da6ad2008-08-13 00:59:25 +000024#include "clang/AST/DeclObjC.h"
Anders Carlsson15b73de2009-07-18 19:43:29 +000025#include "clang/AST/RecordLayout.h"
Chris Lattnerf0b64d72009-04-26 01:32:48 +000026#include "clang/AST/StmtObjC.h"
David Chisnalld7972f52011-03-23 16:36:54 +000027#include "clang/Basic/FileManager.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000028#include "clang/Basic/SourceManager.h"
Reid Kleckner98031782019-12-09 16:11:56 -080029#include "clang/CodeGen/ConstantInitBuilder.h"
Chris Lattnerb7256cd2008-03-01 08:50:34 +000030#include "llvm/ADT/SmallVector.h"
Anton Korobeynikov1200aca2008-06-01 14:13:53 +000031#include "llvm/ADT/StringMap.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000032#include "llvm/IR/DataLayout.h"
33#include "llvm/IR/Intrinsics.h"
34#include "llvm/IR/LLVMContext.h"
35#include "llvm/IR/Module.h"
Daniel Dunbar92992502008-08-15 22:20:32 +000036#include "llvm/Support/Compiler.h"
David Chisnall79356ee2018-05-22 06:09:23 +000037#include "llvm/Support/ConvertUTF.h"
David Chisnall404bbcb2018-05-22 10:13:06 +000038#include <cctype>
Chris Lattner8d3f4a42009-01-27 05:06:01 +000039
Chris Lattner87ab27d2008-06-26 04:19:03 +000040using namespace clang;
Daniel Dunbar41cf9de2008-09-09 01:06:48 +000041using namespace CodeGen;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +000042
Chris Lattnerb7256cd2008-03-01 08:50:34 +000043namespace {
David Chisnall404bbcb2018-05-22 10:13:06 +000044
45std::string SymbolNameForMethod( StringRef ClassName,
46 StringRef CategoryName, const Selector MethodName,
47 bool isClassMethod) {
48 std::string MethodNameColonStripped = MethodName.getAsString();
49 std::replace(MethodNameColonStripped.begin(), MethodNameColonStripped.end(),
50 ':', '_');
51 return (Twine(isClassMethod ? "_c_" : "_i_") + ClassName + "_" +
52 CategoryName + "_" + MethodNameColonStripped).str();
53}
54
David Chisnall34d00052011-03-26 11:48:37 +000055/// Class that lazily initialises the runtime function. Avoids inserting the
56/// types and the function declaration into a module if they're not used, and
57/// avoids constructing the type more than once if it's used more than once.
David Chisnalld7972f52011-03-23 16:36:54 +000058class LazyRuntimeFunction {
59 CodeGenModule *CGM;
David Blaikiebf178d32015-05-19 21:31:34 +000060 llvm::FunctionType *FTy;
David Chisnalld7972f52011-03-23 16:36:54 +000061 const char *FunctionName;
James Y Knight9871db02019-02-05 16:42:33 +000062 llvm::FunctionCallee Function;
David Blaikie7d9e7922015-05-18 22:51:39 +000063
64public:
65 /// Constructor leaves this class uninitialized, because it is intended to
66 /// be used as a field in another class and not all of the types that are
67 /// used as arguments will necessarily be available at construction time.
68 LazyRuntimeFunction()
Craig Topper8a13c412014-05-21 05:09:00 +000069 : CGM(nullptr), FunctionName(nullptr), Function(nullptr) {}
David Chisnalld7972f52011-03-23 16:36:54 +000070
David Blaikie7d9e7922015-05-18 22:51:39 +000071 /// Initialises the lazy function with the name, return type, and the types
72 /// of the arguments.
Serge Guelton1d993272017-05-09 19:31:30 +000073 template <typename... Tys>
74 void init(CodeGenModule *Mod, const char *name, llvm::Type *RetTy,
75 Tys *... Types) {
David Blaikie7d9e7922015-05-18 22:51:39 +000076 CGM = Mod;
77 FunctionName = name;
78 Function = nullptr;
Serge Guelton29405c92017-05-09 21:19:44 +000079 if(sizeof...(Tys)) {
80 SmallVector<llvm::Type *, 8> ArgTys({Types...});
81 FTy = llvm::FunctionType::get(RetTy, ArgTys, false);
82 }
83 else {
84 FTy = llvm::FunctionType::get(RetTy, None, false);
85 }
David Blaikie7d9e7922015-05-18 22:51:39 +000086 }
David Blaikiebf178d32015-05-19 21:31:34 +000087
88 llvm::FunctionType *getType() { return FTy; }
89
David Blaikie7d9e7922015-05-18 22:51:39 +000090 /// Overloaded cast operator, allows the class to be implicitly cast to an
91 /// LLVM constant.
James Y Knight9871db02019-02-05 16:42:33 +000092 operator llvm::FunctionCallee() {
David Blaikie7d9e7922015-05-18 22:51:39 +000093 if (!Function) {
94 if (!FunctionName)
95 return nullptr;
George Burgess IV00f70bd2018-03-01 05:43:23 +000096 Function = CGM->CreateRuntimeFunction(FTy, FunctionName);
David Blaikie7d9e7922015-05-18 22:51:39 +000097 }
98 return Function;
99 }
David Chisnalld7972f52011-03-23 16:36:54 +0000100};
101
102
David Chisnall34d00052011-03-26 11:48:37 +0000103/// GNU Objective-C runtime code generation. This class implements the parts of
John McCall775086e2012-07-12 02:07:58 +0000104/// Objective-C support that are specific to the GNU family of runtimes (GCC,
105/// GNUstep and ObjFW).
David Chisnalld7972f52011-03-23 16:36:54 +0000106class CGObjCGNU : public CGObjCRuntime {
David Chisnall76803412011-03-23 22:52:06 +0000107protected:
David Chisnall34d00052011-03-26 11:48:37 +0000108 /// The LLVM module into which output is inserted
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000109 llvm::Module &TheModule;
David Chisnall34d00052011-03-26 11:48:37 +0000110 /// strut objc_super. Used for sending messages to super. This structure
111 /// contains the receiver (object) and the expected class.
Chris Lattner2192fe52011-07-18 04:24:23 +0000112 llvm::StructType *ObjCSuperTy;
David Chisnall34d00052011-03-26 11:48:37 +0000113 /// struct objc_super*. The type of the argument to the superclass message
Fangrui Song6907ce22018-07-30 19:24:48 +0000114 /// lookup functions.
Chris Lattner2192fe52011-07-18 04:24:23 +0000115 llvm::PointerType *PtrToObjCSuperTy;
David Chisnall34d00052011-03-26 11:48:37 +0000116 /// LLVM type for selectors. Opaque pointer (i8*) unless a header declaring
117 /// SEL is included in a header somewhere, in which case it will be whatever
118 /// type is declared in that header, most likely {i8*, i8*}.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000119 llvm::PointerType *SelectorTy;
David Chisnall34d00052011-03-26 11:48:37 +0000120 /// LLVM i8 type. Cached here to avoid repeatedly getting it in all of the
121 /// places where it's used
Chris Lattner2192fe52011-07-18 04:24:23 +0000122 llvm::IntegerType *Int8Ty;
David Chisnall34d00052011-03-26 11:48:37 +0000123 /// Pointer to i8 - LLVM type of char*, for all of the places where the
124 /// runtime needs to deal with C strings.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000125 llvm::PointerType *PtrToInt8Ty;
David Chisnall404bbcb2018-05-22 10:13:06 +0000126 /// struct objc_protocol type
127 llvm::StructType *ProtocolTy;
128 /// Protocol * type.
129 llvm::PointerType *ProtocolPtrTy;
David Chisnall34d00052011-03-26 11:48:37 +0000130 /// Instance Method Pointer type. This is a pointer to a function that takes,
131 /// at a minimum, an object and a selector, and is the generic type for
132 /// Objective-C methods. Due to differences between variadic / non-variadic
133 /// calling conventions, it must always be cast to the correct type before
134 /// actually being used.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000135 llvm::PointerType *IMPTy;
David Chisnall34d00052011-03-26 11:48:37 +0000136 /// Type of an untyped Objective-C object. Clang treats id as a built-in type
137 /// when compiling Objective-C code, so this may be an opaque pointer (i8*),
138 /// but if the runtime header declaring it is included then it may be a
139 /// pointer to a structure.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000140 llvm::PointerType *IdTy;
David Chisnall34d00052011-03-26 11:48:37 +0000141 /// Pointer to a pointer to an Objective-C object. Used in the new ABI
142 /// message lookup function and some GC-related functions.
Chris Lattner2192fe52011-07-18 04:24:23 +0000143 llvm::PointerType *PtrToIdTy;
David Chisnall34d00052011-03-26 11:48:37 +0000144 /// The clang type of id. Used when using the clang CGCall infrastructure to
145 /// call Objective-C methods.
John McCall2da83a32010-02-26 00:48:12 +0000146 CanQualType ASTIdTy;
David Chisnall34d00052011-03-26 11:48:37 +0000147 /// LLVM type for C int type.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000148 llvm::IntegerType *IntTy;
David Chisnall34d00052011-03-26 11:48:37 +0000149 /// LLVM type for an opaque pointer. This is identical to PtrToInt8Ty, but is
150 /// used in the code to document the difference between i8* meaning a pointer
151 /// to a C string and i8* meaning a pointer to some opaque type.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000152 llvm::PointerType *PtrTy;
David Chisnall34d00052011-03-26 11:48:37 +0000153 /// LLVM type for C long type. The runtime uses this in a lot of places where
154 /// it should be using intptr_t, but we can't fix this without breaking
155 /// compatibility with GCC...
Jay Foad7c57be32011-07-11 09:56:20 +0000156 llvm::IntegerType *LongTy;
David Chisnall34d00052011-03-26 11:48:37 +0000157 /// LLVM type for C size_t. Used in various runtime data structures.
Chris Lattner2192fe52011-07-18 04:24:23 +0000158 llvm::IntegerType *SizeTy;
Fangrui Song6907ce22018-07-30 19:24:48 +0000159 /// LLVM type for C intptr_t.
David Chisnalle0dc7cb2011-10-08 08:54:36 +0000160 llvm::IntegerType *IntPtrTy;
David Chisnall34d00052011-03-26 11:48:37 +0000161 /// LLVM type for C ptrdiff_t. Mainly used in property accessor functions.
Chris Lattner2192fe52011-07-18 04:24:23 +0000162 llvm::IntegerType *PtrDiffTy;
David Chisnall34d00052011-03-26 11:48:37 +0000163 /// LLVM type for C int*. Used for GCC-ABI-compatible non-fragile instance
164 /// variables.
Chris Lattner2192fe52011-07-18 04:24:23 +0000165 llvm::PointerType *PtrToIntTy;
David Chisnall34d00052011-03-26 11:48:37 +0000166 /// LLVM type for Objective-C BOOL type.
Chris Lattner2192fe52011-07-18 04:24:23 +0000167 llvm::Type *BoolTy;
David Chisnallcdd207e2011-10-04 15:35:30 +0000168 /// 32-bit integer type, to save us needing to look it up every time it's used.
169 llvm::IntegerType *Int32Ty;
170 /// 64-bit integer type, to save us needing to look it up every time it's used.
171 llvm::IntegerType *Int64Ty;
David Chisnall404bbcb2018-05-22 10:13:06 +0000172 /// The type of struct objc_property.
173 llvm::StructType *PropertyMetadataTy;
David Chisnall34d00052011-03-26 11:48:37 +0000174 /// Metadata kind used to tie method lookups to message sends. The GNUstep
175 /// runtime provides some LLVM passes that can use this to do things like
176 /// automatic IMP caching and speculative inlining.
David Chisnall76803412011-03-23 22:52:06 +0000177 unsigned msgSendMDKind;
David Chisnall93ce0182018-08-10 12:53:13 +0000178 /// Does the current target use SEH-based exceptions? False implies
179 /// Itanium-style DWARF unwinding.
180 bool usesSEHExceptions;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000181
David Chisnall404bbcb2018-05-22 10:13:06 +0000182 /// Helper to check if we are targeting a specific runtime version or later.
183 bool isRuntime(ObjCRuntime::Kind kind, unsigned major, unsigned minor=0) {
184 const ObjCRuntime &R = CGM.getLangOpts().ObjCRuntime;
185 return (R.getKind() == kind) &&
186 (R.getVersion() >= VersionTuple(major, minor));
187 }
188
David Chisnall7b36a862019-03-31 11:22:33 +0000189 std::string ManglePublicSymbol(StringRef Name) {
190 return (StringRef(CGM.getTriple().isOSBinFormatCOFF() ? "$_" : "._") + Name).str();
191 }
192
193 std::string SymbolForProtocol(Twine Name) {
194 return (ManglePublicSymbol("OBJC_PROTOCOL_") + Name).str();
David Chisnall404bbcb2018-05-22 10:13:06 +0000195 }
196
197 std::string SymbolForProtocolRef(StringRef Name) {
David Chisnall7b36a862019-03-31 11:22:33 +0000198 return (ManglePublicSymbol("OBJC_REF_PROTOCOL_") + Name).str();
David Chisnall404bbcb2018-05-22 10:13:06 +0000199 }
200
201
David Chisnall34d00052011-03-26 11:48:37 +0000202 /// Helper function that generates a constant string and returns a pointer to
203 /// the start of the string. The result of this function can be used anywhere
Fangrui Song6907ce22018-07-30 19:24:48 +0000204 /// where the C code specifies const char*.
John McCallecee86f2016-11-30 20:19:46 +0000205 llvm::Constant *MakeConstantString(StringRef Str, const char *Name = "") {
206 ConstantAddress Array = CGM.GetAddrOfConstantCString(Str, Name);
John McCall7f416cc2015-09-08 08:05:57 +0000207 return llvm::ConstantExpr::getGetElementPtr(Array.getElementType(),
208 Array.getPointer(), Zeros);
David Chisnalld3858d62011-03-25 11:57:33 +0000209 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000210
David Chisnall34d00052011-03-26 11:48:37 +0000211 /// Emits a linkonce_odr string, whose name is the prefix followed by the
212 /// string value. This allows the linker to combine the strings between
213 /// different modules. Used for EH typeinfo names, selector strings, and a
214 /// few other things.
David Chisnall404bbcb2018-05-22 10:13:06 +0000215 llvm::Constant *ExportUniqueString(const std::string &Str,
216 const std::string &prefix,
217 bool Private=false) {
218 std::string name = prefix + Str;
219 auto *ConstStr = TheModule.getGlobalVariable(name);
David Chisnalld3858d62011-03-25 11:57:33 +0000220 if (!ConstStr) {
Chris Lattner9c818332012-02-05 02:30:40 +0000221 llvm::Constant *value = llvm::ConstantDataArray::getString(VMContext,Str);
David Chisnall404bbcb2018-05-22 10:13:06 +0000222 auto *GV = new llvm::GlobalVariable(TheModule, value->getType(), true,
223 llvm::GlobalValue::LinkOnceODRLinkage, value, name);
David Chisnall93ce0182018-08-10 12:53:13 +0000224 GV->setComdat(TheModule.getOrInsertComdat(name));
David Chisnall404bbcb2018-05-22 10:13:06 +0000225 if (Private)
226 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
227 ConstStr = GV;
David Chisnalld3858d62011-03-25 11:57:33 +0000228 }
David Blaikiee3b172a2015-04-02 18:55:21 +0000229 return llvm::ConstantExpr::getGetElementPtr(ConstStr->getValueType(),
230 ConstStr, Zeros);
David Chisnalld3858d62011-03-25 11:57:33 +0000231 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000232
David Chisnalla5f59412012-10-16 15:11:55 +0000233 /// Returns a property name and encoding string.
234 llvm::Constant *MakePropertyEncodingString(const ObjCPropertyDecl *PD,
235 const Decl *Container) {
David Chisnall404bbcb2018-05-22 10:13:06 +0000236 assert(!isRuntime(ObjCRuntime::GNUstep, 2));
237 if (isRuntime(ObjCRuntime::GNUstep, 1, 6)) {
David Chisnalla5f59412012-10-16 15:11:55 +0000238 std::string NameAndAttributes;
John McCall843dfcc2016-11-29 21:57:00 +0000239 std::string TypeStr =
240 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container);
David Chisnalla5f59412012-10-16 15:11:55 +0000241 NameAndAttributes += '\0';
242 NameAndAttributes += TypeStr.length() + 3;
243 NameAndAttributes += TypeStr;
244 NameAndAttributes += '\0';
245 NameAndAttributes += PD->getNameAsString();
John McCall7f416cc2015-09-08 08:05:57 +0000246 return MakeConstantString(NameAndAttributes);
David Chisnalla5f59412012-10-16 15:11:55 +0000247 }
248 return MakeConstantString(PD->getNameAsString());
249 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000250
Fangrui Song6907ce22018-07-30 19:24:48 +0000251 /// Push the property attributes into two structure fields.
John McCall23c9dc62016-11-28 22:18:27 +0000252 void PushPropertyAttributes(ConstantStructBuilder &Fields,
David Chisnall404bbcb2018-05-22 10:13:06 +0000253 const ObjCPropertyDecl *property, bool isSynthesized=true, bool
David Chisnallbeb80132013-02-28 13:59:29 +0000254 isDynamic=true) {
255 int attrs = property->getPropertyAttributes();
256 // For read-only properties, clear the copy and retain flags
257 if (attrs & ObjCPropertyDecl::OBJC_PR_readonly) {
258 attrs &= ~ObjCPropertyDecl::OBJC_PR_copy;
259 attrs &= ~ObjCPropertyDecl::OBJC_PR_retain;
260 attrs &= ~ObjCPropertyDecl::OBJC_PR_weak;
261 attrs &= ~ObjCPropertyDecl::OBJC_PR_strong;
262 }
263 // The first flags field has the same attribute values as clang uses internally
John McCall6c9f1fdb2016-11-19 08:17:24 +0000264 Fields.addInt(Int8Ty, attrs & 0xff);
David Chisnallbeb80132013-02-28 13:59:29 +0000265 attrs >>= 8;
266 attrs <<= 2;
267 // For protocol properties, synthesized and dynamic have no meaning, so we
268 // reuse these flags to indicate that this is a protocol property (both set
269 // has no meaning, as a property can't be both synthesized and dynamic)
270 attrs |= isSynthesized ? (1<<0) : 0;
271 attrs |= isDynamic ? (1<<1) : 0;
272 // The second field is the next four fields left shifted by two, with the
273 // low bit set to indicate whether the field is synthesized or dynamic.
John McCall6c9f1fdb2016-11-19 08:17:24 +0000274 Fields.addInt(Int8Ty, attrs & 0xff);
David Chisnallbeb80132013-02-28 13:59:29 +0000275 // Two padding fields
John McCall6c9f1fdb2016-11-19 08:17:24 +0000276 Fields.addInt(Int8Ty, 0);
277 Fields.addInt(Int8Ty, 0);
David Chisnallbeb80132013-02-28 13:59:29 +0000278 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000279
David Chisnall386477a2018-12-28 17:44:54 +0000280 virtual llvm::Constant *GenerateCategoryProtocolList(const
281 ObjCCategoryDecl *OCD);
David Chisnall404bbcb2018-05-22 10:13:06 +0000282 virtual ConstantArrayBuilder PushPropertyListHeader(ConstantStructBuilder &Fields,
283 int count) {
284 // int count;
285 Fields.addInt(IntTy, count);
286 // int size; (only in GNUstep v2 ABI.
287 if (isRuntime(ObjCRuntime::GNUstep, 2)) {
288 llvm::DataLayout td(&TheModule);
289 Fields.addInt(IntTy, td.getTypeSizeInBits(PropertyMetadataTy) /
290 CGM.getContext().getCharWidth());
291 }
292 // struct objc_property_list *next;
293 Fields.add(NULLPtr);
294 // struct objc_property properties[]
295 return Fields.beginArray(PropertyMetadataTy);
296 }
297 virtual void PushProperty(ConstantArrayBuilder &PropertiesArray,
298 const ObjCPropertyDecl *property,
299 const Decl *OCD,
300 bool isSynthesized=true, bool
301 isDynamic=true) {
302 auto Fields = PropertiesArray.beginStruct(PropertyMetadataTy);
303 ASTContext &Context = CGM.getContext();
304 Fields.add(MakePropertyEncodingString(property, OCD));
305 PushPropertyAttributes(Fields, property, isSynthesized, isDynamic);
306 auto addPropertyMethod = [&](const ObjCMethodDecl *accessor) {
307 if (accessor) {
308 std::string TypeStr = Context.getObjCEncodingForMethodDecl(accessor);
309 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
310 Fields.add(MakeConstantString(accessor->getSelector().getAsString()));
311 Fields.add(TypeEncoding);
312 } else {
313 Fields.add(NULLPtr);
314 Fields.add(NULLPtr);
315 }
316 };
317 addPropertyMethod(property->getGetterMethodDecl());
318 addPropertyMethod(property->getSetterMethodDecl());
319 Fields.finishAndAddTo(PropertiesArray);
320 }
321
David Chisnall34d00052011-03-26 11:48:37 +0000322 /// Ensures that the value has the required type, by inserting a bitcast if
323 /// required. This function lets us avoid inserting bitcasts that are
324 /// redundant.
John McCall882987f2013-02-28 19:01:20 +0000325 llvm::Value* EnforceType(CGBuilderTy &B, llvm::Value *V, llvm::Type *Ty) {
David Chisnall76803412011-03-23 22:52:06 +0000326 if (V->getType() == Ty) return V;
327 return B.CreateBitCast(V, Ty);
328 }
John McCall7f416cc2015-09-08 08:05:57 +0000329 Address EnforceType(CGBuilderTy &B, Address V, llvm::Type *Ty) {
330 if (V.getType() == Ty) return V;
331 return B.CreateBitCast(V, Ty);
332 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000333
David Chisnall76803412011-03-23 22:52:06 +0000334 // Some zeros used for GEPs in lots of places.
335 llvm::Constant *Zeros[2];
David Chisnall34d00052011-03-26 11:48:37 +0000336 /// Null pointer value. Mainly used as a terminator in various arrays.
David Chisnall76803412011-03-23 22:52:06 +0000337 llvm::Constant *NULLPtr;
David Chisnall34d00052011-03-26 11:48:37 +0000338 /// LLVM context.
David Chisnall76803412011-03-23 22:52:06 +0000339 llvm::LLVMContext &VMContext;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000340
David Chisnall404bbcb2018-05-22 10:13:06 +0000341protected:
342
David Chisnall34d00052011-03-26 11:48:37 +0000343 /// Placeholder for the class. Lots of things refer to the class before we've
344 /// actually emitted it. We use this alias as a placeholder, and then replace
345 /// it with a pointer to the class structure before finally emitting the
346 /// module.
Daniel Dunbar566421c2009-05-04 15:31:17 +0000347 llvm::GlobalAlias *ClassPtrAlias;
David Chisnall34d00052011-03-26 11:48:37 +0000348 /// Placeholder for the metaclass. Lots of things refer to the class before
349 /// we've / actually emitted it. We use this alias as a placeholder, and then
350 /// replace / it with a pointer to the metaclass structure before finally
351 /// emitting the / module.
Daniel Dunbar566421c2009-05-04 15:31:17 +0000352 llvm::GlobalAlias *MetaClassPtrAlias;
David Chisnall34d00052011-03-26 11:48:37 +0000353 /// All of the classes that have been generated for this compilation units.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000354 std::vector<llvm::Constant*> Classes;
David Chisnall34d00052011-03-26 11:48:37 +0000355 /// All of the categories that have been generated for this compilation units.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000356 std::vector<llvm::Constant*> Categories;
David Chisnall34d00052011-03-26 11:48:37 +0000357 /// All of the Objective-C constant strings that have been generated for this
358 /// compilation units.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000359 std::vector<llvm::Constant*> ConstantStrings;
David Chisnall34d00052011-03-26 11:48:37 +0000360 /// Map from string values to Objective-C constant strings in the output.
361 /// Used to prevent emitting Objective-C strings more than once. This should
362 /// not be required at all - CodeGenModule should manage this list.
David Chisnall358e7512010-01-27 12:49:23 +0000363 llvm::StringMap<llvm::Constant*> ObjCStrings;
David Chisnall34d00052011-03-26 11:48:37 +0000364 /// All of the protocols that have been declared.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000365 llvm::StringMap<llvm::Constant*> ExistingProtocols;
David Chisnall34d00052011-03-26 11:48:37 +0000366 /// For each variant of a selector, we store the type encoding and a
367 /// placeholder value. For an untyped selector, the type will be the empty
368 /// string. Selector references are all done via the module's selector table,
369 /// so we create an alias as a placeholder and then replace it with the real
370 /// value later.
David Chisnalld7972f52011-03-23 16:36:54 +0000371 typedef std::pair<std::string, llvm::GlobalAlias*> TypedSelector;
David Chisnall34d00052011-03-26 11:48:37 +0000372 /// Type of the selector map. This is roughly equivalent to the structure
373 /// used in the GNUstep runtime, which maintains a list of all of the valid
374 /// types for a selector in a table.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000375 typedef llvm::DenseMap<Selector, SmallVector<TypedSelector, 2> >
David Chisnalld7972f52011-03-23 16:36:54 +0000376 SelectorMap;
David Chisnall34d00052011-03-26 11:48:37 +0000377 /// A map from selectors to selector types. This allows us to emit all
378 /// selectors of the same name and type together.
David Chisnalld7972f52011-03-23 16:36:54 +0000379 SelectorMap SelectorTable;
380
David Chisnall34d00052011-03-26 11:48:37 +0000381 /// Selectors related to memory management. When compiling in GC mode, we
382 /// omit these.
David Chisnall5bb4efd2010-02-03 15:59:02 +0000383 Selector RetainSel, ReleaseSel, AutoreleaseSel;
David Chisnall34d00052011-03-26 11:48:37 +0000384 /// Runtime functions used for memory management in GC mode. Note that clang
385 /// supports code generation for calling these functions, but neither GNU
386 /// runtime actually supports this API properly yet.
Fangrui Song6907ce22018-07-30 19:24:48 +0000387 LazyRuntimeFunction IvarAssignFn, StrongCastAssignFn, MemMoveFn, WeakReadFn,
David Chisnalld7972f52011-03-23 16:36:54 +0000388 WeakAssignFn, GlobalAssignFn;
David Chisnalld7972f52011-03-23 16:36:54 +0000389
David Chisnall92d436b2012-01-31 18:59:20 +0000390 typedef std::pair<std::string, std::string> ClassAliasPair;
391 /// All classes that have aliases set for them.
392 std::vector<ClassAliasPair> ClassAliases;
393
David Chisnalld3858d62011-03-25 11:57:33 +0000394protected:
David Chisnall34d00052011-03-26 11:48:37 +0000395 /// Function used for throwing Objective-C exceptions.
David Chisnalld7972f52011-03-23 16:36:54 +0000396 LazyRuntimeFunction ExceptionThrowFn;
James Dennettb9199ee2012-06-13 22:07:09 +0000397 /// Function used for rethrowing exceptions, used at the end of \@finally or
398 /// \@synchronize blocks.
David Chisnalld3858d62011-03-25 11:57:33 +0000399 LazyRuntimeFunction ExceptionReThrowFn;
David Chisnall34d00052011-03-26 11:48:37 +0000400 /// Function called when entering a catch function. This is required for
401 /// differentiating Objective-C exceptions and foreign exceptions.
David Chisnalld3858d62011-03-25 11:57:33 +0000402 LazyRuntimeFunction EnterCatchFn;
David Chisnall34d00052011-03-26 11:48:37 +0000403 /// Function called when exiting from a catch block. Used to do exception
404 /// cleanup.
David Chisnalld3858d62011-03-25 11:57:33 +0000405 LazyRuntimeFunction ExitCatchFn;
James Dennettb9199ee2012-06-13 22:07:09 +0000406 /// Function called when entering an \@synchronize block. Acquires the lock.
David Chisnalld7972f52011-03-23 16:36:54 +0000407 LazyRuntimeFunction SyncEnterFn;
James Dennettb9199ee2012-06-13 22:07:09 +0000408 /// Function called when exiting an \@synchronize block. Releases the lock.
David Chisnalld7972f52011-03-23 16:36:54 +0000409 LazyRuntimeFunction SyncExitFn;
410
David Chisnalld3858d62011-03-25 11:57:33 +0000411private:
David Chisnall34d00052011-03-26 11:48:37 +0000412 /// Function called if fast enumeration detects that the collection is
413 /// modified during the update.
David Chisnalld7972f52011-03-23 16:36:54 +0000414 LazyRuntimeFunction EnumerationMutationFn;
David Chisnall34d00052011-03-26 11:48:37 +0000415 /// Function for implementing synthesized property getters that return an
416 /// object.
David Chisnalld7972f52011-03-23 16:36:54 +0000417 LazyRuntimeFunction GetPropertyFn;
David Chisnall34d00052011-03-26 11:48:37 +0000418 /// Function for implementing synthesized property setters that return an
419 /// object.
David Chisnalld7972f52011-03-23 16:36:54 +0000420 LazyRuntimeFunction SetPropertyFn;
David Chisnall34d00052011-03-26 11:48:37 +0000421 /// Function used for non-object declared property getters.
David Chisnalld7972f52011-03-23 16:36:54 +0000422 LazyRuntimeFunction GetStructPropertyFn;
David Chisnall34d00052011-03-26 11:48:37 +0000423 /// Function used for non-object declared property setters.
David Chisnalld7972f52011-03-23 16:36:54 +0000424 LazyRuntimeFunction SetStructPropertyFn;
425
David Chisnall404bbcb2018-05-22 10:13:06 +0000426protected:
David Chisnall34d00052011-03-26 11:48:37 +0000427 /// The version of the runtime that this class targets. Must match the
428 /// version in the runtime.
David Chisnall5c511772011-05-22 22:37:08 +0000429 int RuntimeVersion;
David Chisnall34d00052011-03-26 11:48:37 +0000430 /// The version of the protocol class. Used to differentiate between ObjC1
431 /// and ObjC2 protocols. Objective-C 1 protocols can not contain optional
432 /// components and can not contain declared properties. We always emit
433 /// Objective-C 2 property structures, but we have to pretend that they're
434 /// Objective-C 1 property structures when targeting the GCC runtime or it
435 /// will abort.
David Chisnalld7972f52011-03-23 16:36:54 +0000436 const int ProtocolVersion;
David Chisnall404bbcb2018-05-22 10:13:06 +0000437 /// The version of the class ABI. This value is used in the class structure
438 /// and indicates how various fields should be interpreted.
439 const int ClassABIVersion;
David Chisnall34d00052011-03-26 11:48:37 +0000440 /// Generates an instance variable list structure. This is a structure
441 /// containing a size and an array of structures containing instance variable
442 /// metadata. This is used purely for introspection in the fragile ABI. In
443 /// the non-fragile ABI, it's used for instance variable fixup.
David Chisnall404bbcb2018-05-22 10:13:06 +0000444 virtual llvm::Constant *GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
445 ArrayRef<llvm::Constant *> IvarTypes,
446 ArrayRef<llvm::Constant *> IvarOffsets,
447 ArrayRef<llvm::Constant *> IvarAlign,
448 ArrayRef<Qualifiers::ObjCLifetime> IvarOwnership);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000449
David Chisnall34d00052011-03-26 11:48:37 +0000450 /// Generates a method list structure. This is a structure containing a size
451 /// and an array of structures containing method metadata.
452 ///
453 /// This structure is used by both classes and categories, and contains a next
454 /// pointer allowing them to be chained together in a linked list.
Craig Topperbf3e3272014-08-30 16:55:52 +0000455 llvm::Constant *GenerateMethodList(StringRef ClassName,
456 StringRef CategoryName,
David Chisnall404bbcb2018-05-22 10:13:06 +0000457 ArrayRef<const ObjCMethodDecl*> Methods,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000458 bool isClassMethodList);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000459
James Dennettb9199ee2012-06-13 22:07:09 +0000460 /// Emits an empty protocol. This is used for \@protocol() where no protocol
David Chisnall34d00052011-03-26 11:48:37 +0000461 /// is found. The runtime will (hopefully) fix up the pointer to refer to the
462 /// real protocol.
David Chisnall404bbcb2018-05-22 10:13:06 +0000463 virtual llvm::Constant *GenerateEmptyProtocol(StringRef ProtocolName);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000464
David Chisnall34d00052011-03-26 11:48:37 +0000465 /// Generates a list of property metadata structures. This follows the same
466 /// pattern as method and instance variable metadata lists.
David Chisnall404bbcb2018-05-22 10:13:06 +0000467 llvm::Constant *GeneratePropertyList(const Decl *Container,
468 const ObjCContainerDecl *OCD,
469 bool isClassProperty=false,
470 bool protocolOptionalProperties=false);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000471
David Chisnall34d00052011-03-26 11:48:37 +0000472 /// Generates a list of referenced protocols. Classes, categories, and
473 /// protocols all use this structure.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000474 llvm::Constant *GenerateProtocolList(ArrayRef<std::string> Protocols);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000475
David Chisnall34d00052011-03-26 11:48:37 +0000476 /// To ensure that all protocols are seen by the runtime, we add a category on
477 /// a class defined in the runtime, declaring no methods, but adopting the
478 /// protocols. This is a horribly ugly hack, but it allows us to collect all
479 /// of the protocols without changing the ABI.
Dmitri Gribenkob2aa9232012-11-15 14:28:07 +0000480 void GenerateProtocolHolderCategory();
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000481
David Chisnall34d00052011-03-26 11:48:37 +0000482 /// Generates a class structure.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000483 llvm::Constant *GenerateClassStructure(
484 llvm::Constant *MetaClass,
485 llvm::Constant *SuperClass,
486 unsigned info,
Chris Lattnerda35bc82008-06-26 04:47:04 +0000487 const char *Name,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +0000488 llvm::Constant *Version,
489 llvm::Constant *InstanceSize,
490 llvm::Constant *IVars,
491 llvm::Constant *Methods,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +0000492 llvm::Constant *Protocols,
493 llvm::Constant *IvarOffsets,
David Chisnalld472c852010-04-28 14:29:56 +0000494 llvm::Constant *Properties,
David Chisnallcdd207e2011-10-04 15:35:30 +0000495 llvm::Constant *StrongIvarBitmap,
496 llvm::Constant *WeakIvarBitmap,
David Chisnalld472c852010-04-28 14:29:56 +0000497 bool isMeta=false);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000498
David Chisnall34d00052011-03-26 11:48:37 +0000499 /// Generates a method list. This is used by protocols to define the required
500 /// and optional methods.
David Chisnall404bbcb2018-05-22 10:13:06 +0000501 virtual llvm::Constant *GenerateProtocolMethodList(
502 ArrayRef<const ObjCMethodDecl*> Methods);
503 /// Emits optional and required method lists.
504 template<class T>
505 void EmitProtocolMethodList(T &&Methods, llvm::Constant *&Required,
506 llvm::Constant *&Optional) {
507 SmallVector<const ObjCMethodDecl*, 16> RequiredMethods;
508 SmallVector<const ObjCMethodDecl*, 16> OptionalMethods;
509 for (const auto *I : Methods)
510 if (I->isOptional())
511 OptionalMethods.push_back(I);
512 else
513 RequiredMethods.push_back(I);
514 Required = GenerateProtocolMethodList(RequiredMethods);
515 Optional = GenerateProtocolMethodList(OptionalMethods);
516 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000517
David Chisnall34d00052011-03-26 11:48:37 +0000518 /// Returns a selector with the specified type encoding. An empty string is
519 /// used to return an untyped selector (with the types field set to NULL).
Simon Pilgrim04c5a342018-08-08 15:53:14 +0000520 virtual llvm::Value *GetTypedSelector(CodeGenFunction &CGF, Selector Sel,
521 const std::string &TypeEncoding);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000522
David Chisnall404bbcb2018-05-22 10:13:06 +0000523 /// Returns the name of ivar offset variables. In the GNUstep v1 ABI, this
524 /// contains the class and ivar names, in the v2 ABI this contains the type
525 /// encoding as well.
526 virtual std::string GetIVarOffsetVariableName(const ObjCInterfaceDecl *ID,
527 const ObjCIvarDecl *Ivar) {
528 const std::string Name = "__objc_ivar_offset_" + ID->getNameAsString()
529 + '.' + Ivar->getNameAsString();
530 return Name;
531 }
David Chisnall34d00052011-03-26 11:48:37 +0000532 /// Returns the variable used to store the offset of an instance variable.
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +0000533 llvm::GlobalVariable *ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
534 const ObjCIvarDecl *Ivar);
David Chisnall34d00052011-03-26 11:48:37 +0000535 /// Emits a reference to a class. This allows the linker to object if there
536 /// is no class of the matching name.
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +0000537 void EmitClassRef(const std::string &className);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000538
David Chisnall920e83b2011-06-29 13:16:41 +0000539 /// Emits a pointer to the named class
John McCall882987f2013-02-28 19:01:20 +0000540 virtual llvm::Value *GetClassNamed(CodeGenFunction &CGF,
John McCall775086e2012-07-12 02:07:58 +0000541 const std::string &Name, bool isWeak);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000542
David Chisnall34d00052011-03-26 11:48:37 +0000543 /// Looks up the method for sending a message to the specified object. This
544 /// mechanism differs between the GCC and GNU runtimes, so this method must be
545 /// overridden in subclasses.
David Chisnall76803412011-03-23 22:52:06 +0000546 virtual llvm::Value *LookupIMP(CodeGenFunction &CGF,
547 llvm::Value *&Receiver,
548 llvm::Value *cmd,
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000549 llvm::MDNode *node,
550 MessageSendInfo &MSI) = 0;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000551
David Chisnallcdd207e2011-10-04 15:35:30 +0000552 /// Looks up the method for sending a message to a superclass. This
553 /// mechanism differs between the GCC and GNU runtimes, so this method must
554 /// be overridden in subclasses.
David Chisnall76803412011-03-23 22:52:06 +0000555 virtual llvm::Value *LookupIMPSuper(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000556 Address ObjCSuper,
Eli Friedmanf24bd3b2013-07-26 00:53:29 +0000557 llvm::Value *cmd,
558 MessageSendInfo &MSI) = 0;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000559
David Chisnallcdd207e2011-10-04 15:35:30 +0000560 /// Libobjc2 uses a bitfield representation where small(ish) bitfields are
561 /// stored in a 64-bit value with the low bit set to 1 and the remaining 63
562 /// bits set to their values, LSB first, while larger ones are stored in a
563 /// structure of this / form:
Fangrui Song6907ce22018-07-30 19:24:48 +0000564 ///
David Chisnallcdd207e2011-10-04 15:35:30 +0000565 /// struct { int32_t length; int32_t values[length]; };
566 ///
567 /// The values in the array are stored in host-endian format, with the least
568 /// significant bit being assumed to come first in the bitfield. Therefore,
569 /// a bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] },
570 /// while a bitfield / with the 63rd bit set will be 1<<64.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +0000571 llvm::Constant *MakeBitField(ArrayRef<bool> bits);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000572
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000573public:
David Chisnalld7972f52011-03-23 16:36:54 +0000574 CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion,
David Chisnall404bbcb2018-05-22 10:13:06 +0000575 unsigned protocolClassVersion, unsigned classABI=1);
David Chisnalld7972f52011-03-23 16:36:54 +0000576
John McCall7f416cc2015-09-08 08:05:57 +0000577 ConstantAddress GenerateConstantString(const StringLiteral *) override;
David Chisnalld7972f52011-03-23 16:36:54 +0000578
Craig Topper4f12f102014-03-12 06:41:41 +0000579 RValue
580 GenerateMessageSend(CodeGenFunction &CGF, ReturnValueSlot Return,
581 QualType ResultType, Selector Sel,
582 llvm::Value *Receiver, const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +0000583 const ObjCInterfaceDecl *Class,
Craig Topper4f12f102014-03-12 06:41:41 +0000584 const ObjCMethodDecl *Method) override;
585 RValue
586 GenerateMessageSendSuper(CodeGenFunction &CGF, ReturnValueSlot Return,
587 QualType ResultType, Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +0000588 const ObjCInterfaceDecl *Class,
Craig Topper4f12f102014-03-12 06:41:41 +0000589 bool isCategoryImpl, llvm::Value *Receiver,
590 bool IsClassMessage, const CallArgList &CallArgs,
591 const ObjCMethodDecl *Method) override;
592 llvm::Value *GetClass(CodeGenFunction &CGF,
593 const ObjCInterfaceDecl *OID) override;
John McCall7f416cc2015-09-08 08:05:57 +0000594 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
595 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000596 llvm::Value *GetSelector(CodeGenFunction &CGF,
597 const ObjCMethodDecl *Method) override;
David Chisnall404bbcb2018-05-22 10:13:06 +0000598 virtual llvm::Constant *GetConstantSelector(Selector Sel,
599 const std::string &TypeEncoding) {
600 llvm_unreachable("Runtime unable to generate constant selector");
601 }
602 llvm::Constant *GetConstantSelector(const ObjCMethodDecl *M) {
603 return GetConstantSelector(M->getSelector(),
604 CGM.getContext().getObjCEncodingForMethodDecl(M));
605 }
Craig Topper4f12f102014-03-12 06:41:41 +0000606 llvm::Constant *GetEHType(QualType T) override;
Mike Stump11289f42009-09-09 15:08:12 +0000607
Craig Topper4f12f102014-03-12 06:41:41 +0000608 llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
609 const ObjCContainerDecl *CD) override;
Pierre Habouzitd4e1ba32019-11-07 23:14:58 -0800610 void GenerateDirectMethodPrologue(CodeGenFunction &CGF, llvm::Function *Fn,
611 const ObjCMethodDecl *OMD,
612 const ObjCContainerDecl *CD) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000613 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
614 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
615 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override;
616 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
617 const ObjCProtocolDecl *PD) override;
618 void GenerateProtocol(const ObjCProtocolDecl *PD) override;
619 llvm::Function *ModuleInitFunction() override;
James Y Knight9871db02019-02-05 16:42:33 +0000620 llvm::FunctionCallee GetPropertyGetFunction() override;
621 llvm::FunctionCallee GetPropertySetFunction() override;
622 llvm::FunctionCallee GetOptimizedPropertySetFunction(bool atomic,
623 bool copy) override;
624 llvm::FunctionCallee GetSetStructFunction() override;
625 llvm::FunctionCallee GetGetStructFunction() override;
626 llvm::FunctionCallee GetCppAtomicObjectGetFunction() override;
627 llvm::FunctionCallee GetCppAtomicObjectSetFunction() override;
628 llvm::FunctionCallee EnumerationMutationFunction() override;
Mike Stump11289f42009-09-09 15:08:12 +0000629
Craig Topper4f12f102014-03-12 06:41:41 +0000630 void EmitTryStmt(CodeGenFunction &CGF,
631 const ObjCAtTryStmt &S) override;
632 void EmitSynchronizedStmt(CodeGenFunction &CGF,
633 const ObjCAtSynchronizedStmt &S) override;
634 void EmitThrowStmt(CodeGenFunction &CGF,
635 const ObjCAtThrowStmt &S,
636 bool ClearInsertionPoint=true) override;
637 llvm::Value * EmitObjCWeakRead(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000638 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000639 void EmitObjCWeakAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000640 llvm::Value *src, Address dst) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000641 void EmitObjCGlobalAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000642 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +0000643 bool threadlocal=false) override;
644 void EmitObjCIvarAssign(CodeGenFunction &CGF, llvm::Value *src,
John McCall7f416cc2015-09-08 08:05:57 +0000645 Address dest, llvm::Value *ivarOffset) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000646 void EmitObjCStrongCastAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000647 llvm::Value *src, Address dest) override;
648 void EmitGCMemmoveCollectable(CodeGenFunction &CGF, Address DestPtr,
649 Address SrcPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000650 llvm::Value *Size) override;
651 LValue EmitObjCValueForIvar(CodeGenFunction &CGF, QualType ObjectTy,
652 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
653 unsigned CVRQualifiers) override;
654 llvm::Value *EmitIvarOffset(CodeGenFunction &CGF,
655 const ObjCInterfaceDecl *Interface,
656 const ObjCIvarDecl *Ivar) override;
657 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
658 llvm::Constant *BuildGCBlockLayout(CodeGenModule &CGM,
659 const CGBlockInfo &blockInfo) override {
Fariborz Jahanianc05349e2010-08-04 16:57:49 +0000660 return NULLPtr;
661 }
Craig Topper4f12f102014-03-12 06:41:41 +0000662 llvm::Constant *BuildRCBlockLayout(CodeGenModule &CGM,
663 const CGBlockInfo &blockInfo) override {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +0000664 return NULLPtr;
665 }
Craig Topper4f12f102014-03-12 06:41:41 +0000666
667 llvm::Constant *BuildByrefLayout(CodeGenModule &CGM, QualType T) override {
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000668 return NULLPtr;
669 }
Chris Lattnerb7256cd2008-03-01 08:50:34 +0000670};
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000671
David Chisnall34d00052011-03-26 11:48:37 +0000672/// Class representing the legacy GCC Objective-C ABI. This is the default when
673/// -fobjc-nonfragile-abi is not specified.
674///
675/// The GCC ABI target actually generates code that is approximately compatible
676/// with the new GNUstep runtime ABI, but refrains from using any features that
677/// would not work with the GCC runtime. For example, clang always generates
678/// the extended form of the class structure, and the extra fields are simply
679/// ignored by GCC libobjc.
David Chisnalld7972f52011-03-23 16:36:54 +0000680class CGObjCGCC : public CGObjCGNU {
David Chisnall34d00052011-03-26 11:48:37 +0000681 /// The GCC ABI message lookup function. Returns an IMP pointing to the
682 /// method implementation for this message.
David Chisnall76803412011-03-23 22:52:06 +0000683 LazyRuntimeFunction MsgLookupFn;
David Chisnall34d00052011-03-26 11:48:37 +0000684 /// The GCC ABI superclass message lookup function. Takes a pointer to a
685 /// structure describing the receiver and the class, and a selector as
686 /// arguments. Returns the IMP for the corresponding method.
David Chisnall76803412011-03-23 22:52:06 +0000687 LazyRuntimeFunction MsgLookupSuperFn;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000688
David Chisnall76803412011-03-23 22:52:06 +0000689protected:
Craig Topper4f12f102014-03-12 06:41:41 +0000690 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
691 llvm::Value *cmd, llvm::MDNode *node,
692 MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000693 CGBuilderTy &Builder = CGF.Builder;
David Chisnall0cc83e72011-10-28 17:55:06 +0000694 llvm::Value *args[] = {
David Chisnall76803412011-03-23 22:52:06 +0000695 EnforceType(Builder, Receiver, IdTy),
David Chisnall0cc83e72011-10-28 17:55:06 +0000696 EnforceType(Builder, cmd, SelectorTy) };
James Y Knight3933add2019-01-30 02:54:28 +0000697 llvm::CallBase *imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFn, args);
David Chisnall0cc83e72011-10-28 17:55:06 +0000698 imp->setMetadata(msgSendMDKind, node);
James Y Knight3933add2019-01-30 02:54:28 +0000699 return imp;
David Chisnall76803412011-03-23 22:52:06 +0000700 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000701
John McCall7f416cc2015-09-08 08:05:57 +0000702 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
Craig Topper4f12f102014-03-12 06:41:41 +0000703 llvm::Value *cmd, MessageSendInfo &MSI) override {
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000704 CGBuilderTy &Builder = CGF.Builder;
705 llvm::Value *lookupArgs[] = {EnforceType(Builder, ObjCSuper,
706 PtrToObjCSuperTy).getPointer(), cmd};
707 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
708 }
709
710public:
711 CGObjCGCC(CodeGenModule &Mod) : CGObjCGNU(Mod, 8, 2) {
712 // IMP objc_msg_lookup(id, SEL);
Serge Guelton1d993272017-05-09 19:31:30 +0000713 MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000714 // IMP objc_msg_lookup_super(struct objc_super*, SEL);
715 MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000716 PtrToObjCSuperTy, SelectorTy);
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000717 }
David Chisnalld7972f52011-03-23 16:36:54 +0000718};
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000719
David Chisnall34d00052011-03-26 11:48:37 +0000720/// Class used when targeting the new GNUstep runtime ABI.
David Chisnalld7972f52011-03-23 16:36:54 +0000721class CGObjCGNUstep : public CGObjCGNU {
David Chisnall34d00052011-03-26 11:48:37 +0000722 /// The slot lookup function. Returns a pointer to a cacheable structure
723 /// that contains (among other things) the IMP.
David Chisnall76803412011-03-23 22:52:06 +0000724 LazyRuntimeFunction SlotLookupFn;
David Chisnall34d00052011-03-26 11:48:37 +0000725 /// The GNUstep ABI superclass message lookup function. Takes a pointer to
726 /// a structure describing the receiver and the class, and a selector as
727 /// arguments. Returns the slot for the corresponding method. Superclass
728 /// message lookup rarely changes, so this is a good caching opportunity.
David Chisnall76803412011-03-23 22:52:06 +0000729 LazyRuntimeFunction SlotLookupSuperFn;
David Chisnall0d75e062012-12-17 18:54:24 +0000730 /// Specialised function for setting atomic retain properties
731 LazyRuntimeFunction SetPropertyAtomic;
732 /// Specialised function for setting atomic copy properties
733 LazyRuntimeFunction SetPropertyAtomicCopy;
734 /// Specialised function for setting nonatomic retain properties
735 LazyRuntimeFunction SetPropertyNonAtomic;
736 /// Specialised function for setting nonatomic copy properties
737 LazyRuntimeFunction SetPropertyNonAtomicCopy;
738 /// Function to perform atomic copies of C++ objects with nontrivial copy
739 /// constructors from Objective-C ivars.
740 LazyRuntimeFunction CxxAtomicObjectGetFn;
741 /// Function to perform atomic copies of C++ objects with nontrivial copy
742 /// constructors to Objective-C ivars.
743 LazyRuntimeFunction CxxAtomicObjectSetFn;
David Chisnall34d00052011-03-26 11:48:37 +0000744 /// Type of an slot structure pointer. This is returned by the various
745 /// lookup functions.
David Chisnall76803412011-03-23 22:52:06 +0000746 llvm::Type *SlotTy;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000747
John McCallc31d8932012-11-14 09:08:34 +0000748 public:
Craig Topper4f12f102014-03-12 06:41:41 +0000749 llvm::Constant *GetEHType(QualType T) override;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000750
David Chisnall76803412011-03-23 22:52:06 +0000751 protected:
Craig Topper4f12f102014-03-12 06:41:41 +0000752 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
753 llvm::Value *cmd, llvm::MDNode *node,
754 MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000755 CGBuilderTy &Builder = CGF.Builder;
James Y Knight9871db02019-02-05 16:42:33 +0000756 llvm::FunctionCallee LookupFn = SlotLookupFn;
David Chisnall76803412011-03-23 22:52:06 +0000757
758 // Store the receiver on the stack so that we can reload it later
John McCall7f416cc2015-09-08 08:05:57 +0000759 Address ReceiverPtr =
760 CGF.CreateTempAlloca(Receiver->getType(), CGF.getPointerAlign());
David Chisnall76803412011-03-23 22:52:06 +0000761 Builder.CreateStore(Receiver, ReceiverPtr);
762
763 llvm::Value *self;
764
765 if (isa<ObjCMethodDecl>(CGF.CurCodeDecl)) {
766 self = CGF.LoadObjCSelf();
767 } else {
768 self = llvm::ConstantPointerNull::get(IdTy);
769 }
770
771 // The lookup function is guaranteed not to capture the receiver pointer.
James Y Knight9871db02019-02-05 16:42:33 +0000772 if (auto *LookupFn2 = dyn_cast<llvm::Function>(LookupFn.getCallee()))
773 LookupFn2->addParamAttr(0, llvm::Attribute::NoCapture);
David Chisnall76803412011-03-23 22:52:06 +0000774
David Chisnall0cc83e72011-10-28 17:55:06 +0000775 llvm::Value *args[] = {
John McCall7f416cc2015-09-08 08:05:57 +0000776 EnforceType(Builder, ReceiverPtr.getPointer(), PtrToIdTy),
David Chisnall76803412011-03-23 22:52:06 +0000777 EnforceType(Builder, cmd, SelectorTy),
David Chisnall0cc83e72011-10-28 17:55:06 +0000778 EnforceType(Builder, self, IdTy) };
James Y Knight3933add2019-01-30 02:54:28 +0000779 llvm::CallBase *slot = CGF.EmitRuntimeCallOrInvoke(LookupFn, args);
780 slot->setOnlyReadsMemory();
David Chisnall76803412011-03-23 22:52:06 +0000781 slot->setMetadata(msgSendMDKind, node);
782
783 // Load the imp from the slot
John McCall7f416cc2015-09-08 08:05:57 +0000784 llvm::Value *imp = Builder.CreateAlignedLoad(
James Y Knight3933add2019-01-30 02:54:28 +0000785 Builder.CreateStructGEP(nullptr, slot, 4), CGF.getPointerAlign());
David Chisnall76803412011-03-23 22:52:06 +0000786
787 // The lookup function may have changed the receiver, so make sure we use
788 // the new one.
789 Receiver = Builder.CreateLoad(ReceiverPtr, true);
790 return imp;
791 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000792
John McCall7f416cc2015-09-08 08:05:57 +0000793 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
Craig Topper4f12f102014-03-12 06:41:41 +0000794 llvm::Value *cmd,
795 MessageSendInfo &MSI) override {
David Chisnall76803412011-03-23 22:52:06 +0000796 CGBuilderTy &Builder = CGF.Builder;
John McCall7f416cc2015-09-08 08:05:57 +0000797 llvm::Value *lookupArgs[] = {ObjCSuper.getPointer(), cmd};
David Chisnall76803412011-03-23 22:52:06 +0000798
John McCall882987f2013-02-28 19:01:20 +0000799 llvm::CallInst *slot =
800 CGF.EmitNounwindRuntimeCall(SlotLookupSuperFn, lookupArgs);
David Chisnall76803412011-03-23 22:52:06 +0000801 slot->setOnlyReadsMemory();
802
John McCall7f416cc2015-09-08 08:05:57 +0000803 return Builder.CreateAlignedLoad(Builder.CreateStructGEP(nullptr, slot, 4),
804 CGF.getPointerAlign());
David Chisnall76803412011-03-23 22:52:06 +0000805 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000806
David Chisnalld7972f52011-03-23 16:36:54 +0000807 public:
David Chisnall404bbcb2018-05-22 10:13:06 +0000808 CGObjCGNUstep(CodeGenModule &Mod) : CGObjCGNUstep(Mod, 9, 3, 1) {}
809 CGObjCGNUstep(CodeGenModule &Mod, unsigned ABI, unsigned ProtocolABI,
810 unsigned ClassABI) :
811 CGObjCGNU(Mod, ABI, ProtocolABI, ClassABI) {
David Chisnallbeb80132013-02-28 13:59:29 +0000812 const ObjCRuntime &R = CGM.getLangOpts().ObjCRuntime;
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000813
Serge Guelton1d993272017-05-09 19:31:30 +0000814 llvm::StructType *SlotStructTy =
815 llvm::StructType::get(PtrTy, PtrTy, PtrTy, IntTy, IMPTy);
David Chisnall76803412011-03-23 22:52:06 +0000816 SlotTy = llvm::PointerType::getUnqual(SlotStructTy);
817 // Slot_t objc_msg_lookup_sender(id *receiver, SEL selector, id sender);
818 SlotLookupFn.init(&CGM, "objc_msg_lookup_sender", SlotTy, PtrToIdTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000819 SelectorTy, IdTy);
David Chisnall404bbcb2018-05-22 10:13:06 +0000820 // Slot_t objc_slot_lookup_super(struct objc_super*, SEL);
David Chisnall76803412011-03-23 22:52:06 +0000821 SlotLookupSuperFn.init(&CGM, "objc_slot_lookup_super", SlotTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000822 PtrToObjCSuperTy, SelectorTy);
David Chisnall93ce0182018-08-10 12:53:13 +0000823 // If we're in ObjC++ mode, then we want to make
824 if (usesSEHExceptions) {
825 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
826 // void objc_exception_rethrow(void)
827 ExceptionReThrowFn.init(&CGM, "objc_exception_rethrow", VoidTy);
828 } else if (CGM.getLangOpts().CPlusPlus) {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000829 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
David Chisnalld3858d62011-03-25 11:57:33 +0000830 // void *__cxa_begin_catch(void *e)
Serge Guelton1d993272017-05-09 19:31:30 +0000831 EnterCatchFn.init(&CGM, "__cxa_begin_catch", PtrTy, PtrTy);
David Chisnalld3858d62011-03-25 11:57:33 +0000832 // void __cxa_end_catch(void)
Serge Guelton1d993272017-05-09 19:31:30 +0000833 ExitCatchFn.init(&CGM, "__cxa_end_catch", VoidTy);
David Chisnalld3858d62011-03-25 11:57:33 +0000834 // void _Unwind_Resume_or_Rethrow(void*)
David Chisnall0d75e062012-12-17 18:54:24 +0000835 ExceptionReThrowFn.init(&CGM, "_Unwind_Resume_or_Rethrow", VoidTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000836 PtrTy);
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000837 } else if (R.getVersion() >= VersionTuple(1, 7)) {
838 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
839 // id objc_begin_catch(void *e)
Serge Guelton1d993272017-05-09 19:31:30 +0000840 EnterCatchFn.init(&CGM, "objc_begin_catch", IdTy, PtrTy);
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000841 // void objc_end_catch(void)
Serge Guelton1d993272017-05-09 19:31:30 +0000842 ExitCatchFn.init(&CGM, "objc_end_catch", VoidTy);
David Chisnall2ec1b10d2013-01-11 15:33:01 +0000843 // void _Unwind_Resume_or_Rethrow(void*)
Serge Guelton1d993272017-05-09 19:31:30 +0000844 ExceptionReThrowFn.init(&CGM, "objc_exception_rethrow", VoidTy, PtrTy);
David Chisnalld3858d62011-03-25 11:57:33 +0000845 }
David Chisnall0d75e062012-12-17 18:54:24 +0000846 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
847 SetPropertyAtomic.init(&CGM, "objc_setProperty_atomic", VoidTy, IdTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000848 SelectorTy, IdTy, PtrDiffTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000849 SetPropertyAtomicCopy.init(&CGM, "objc_setProperty_atomic_copy", VoidTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000850 IdTy, SelectorTy, IdTy, PtrDiffTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000851 SetPropertyNonAtomic.init(&CGM, "objc_setProperty_nonatomic", VoidTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000852 IdTy, SelectorTy, IdTy, PtrDiffTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000853 SetPropertyNonAtomicCopy.init(&CGM, "objc_setProperty_nonatomic_copy",
Serge Guelton1d993272017-05-09 19:31:30 +0000854 VoidTy, IdTy, SelectorTy, IdTy, PtrDiffTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000855 // void objc_setCppObjectAtomic(void *dest, const void *src, void
856 // *helper);
857 CxxAtomicObjectSetFn.init(&CGM, "objc_setCppObjectAtomic", VoidTy, PtrTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000858 PtrTy, PtrTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000859 // void objc_getCppObjectAtomic(void *dest, const void *src, void
860 // *helper);
861 CxxAtomicObjectGetFn.init(&CGM, "objc_getCppObjectAtomic", VoidTy, PtrTy,
Serge Guelton1d993272017-05-09 19:31:30 +0000862 PtrTy, PtrTy);
David Chisnall0d75e062012-12-17 18:54:24 +0000863 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000864
James Y Knight9871db02019-02-05 16:42:33 +0000865 llvm::FunctionCallee GetCppAtomicObjectGetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +0000866 // The optimised functions were added in version 1.7 of the GNUstep
867 // runtime.
868 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
869 VersionTuple(1, 7));
870 return CxxAtomicObjectGetFn;
871 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000872
James Y Knight9871db02019-02-05 16:42:33 +0000873 llvm::FunctionCallee GetCppAtomicObjectSetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +0000874 // The optimised functions were added in version 1.7 of the GNUstep
875 // runtime.
876 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
877 VersionTuple(1, 7));
878 return CxxAtomicObjectSetFn;
879 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +0000880
James Y Knight9871db02019-02-05 16:42:33 +0000881 llvm::FunctionCallee GetOptimizedPropertySetFunction(bool atomic,
882 bool copy) override {
David Chisnall0d75e062012-12-17 18:54:24 +0000883 // The optimised property functions omit the GC check, and so are not
884 // safe to use in GC mode. The standard functions are fast in GC mode,
885 // so there is less advantage in using them.
886 assert ((CGM.getLangOpts().getGC() == LangOptions::NonGC));
887 // The optimised functions were added in version 1.7 of the GNUstep
888 // runtime.
889 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
890 VersionTuple(1, 7));
891
892 if (atomic) {
893 if (copy) return SetPropertyAtomicCopy;
894 return SetPropertyAtomic;
895 }
David Chisnall0d75e062012-12-17 18:54:24 +0000896
Ted Kremenek090a2732014-03-07 18:53:05 +0000897 return copy ? SetPropertyNonAtomicCopy : SetPropertyNonAtomic;
David Chisnall76803412011-03-23 22:52:06 +0000898 }
David Chisnalld7972f52011-03-23 16:36:54 +0000899};
900
David Chisnall404bbcb2018-05-22 10:13:06 +0000901/// GNUstep Objective-C ABI version 2 implementation.
902/// This is the ABI that provides a clean break with the legacy GCC ABI and
903/// cleans up a number of things that were added to work around 1980s linkers.
904class CGObjCGNUstep2 : public CGObjCGNUstep {
David Chisnall93ce0182018-08-10 12:53:13 +0000905 enum SectionKind
906 {
907 SelectorSection = 0,
908 ClassSection,
909 ClassReferenceSection,
910 CategorySection,
911 ProtocolSection,
912 ProtocolReferenceSection,
913 ClassAliasSection,
914 ConstantStringSection
915 };
916 static const char *const SectionsBaseNames[8];
David Chisnall7b36a862019-03-31 11:22:33 +0000917 static const char *const PECOFFSectionsBaseNames[8];
David Chisnall93ce0182018-08-10 12:53:13 +0000918 template<SectionKind K>
919 std::string sectionName() {
David Chisnall7b36a862019-03-31 11:22:33 +0000920 if (CGM.getTriple().isOSBinFormatCOFF()) {
921 std::string name(PECOFFSectionsBaseNames[K]);
David Chisnall93ce0182018-08-10 12:53:13 +0000922 name += "$m";
David Chisnall7b36a862019-03-31 11:22:33 +0000923 return name;
924 }
925 return SectionsBaseNames[K];
David Chisnall93ce0182018-08-10 12:53:13 +0000926 }
David Chisnall404bbcb2018-05-22 10:13:06 +0000927 /// The GCC ABI superclass message lookup function. Takes a pointer to a
928 /// structure describing the receiver and the class, and a selector as
929 /// arguments. Returns the IMP for the corresponding method.
930 LazyRuntimeFunction MsgLookupSuperFn;
931 /// A flag indicating if we've emitted at least one protocol.
932 /// If we haven't, then we need to emit an empty protocol, to ensure that the
933 /// __start__objc_protocols and __stop__objc_protocols sections exist.
934 bool EmittedProtocol = false;
935 /// A flag indicating if we've emitted at least one protocol reference.
936 /// If we haven't, then we need to emit an empty protocol, to ensure that the
937 /// __start__objc_protocol_refs and __stop__objc_protocol_refs sections
938 /// exist.
939 bool EmittedProtocolRef = false;
940 /// A flag indicating if we've emitted at least one class.
941 /// If we haven't, then we need to emit an empty protocol, to ensure that the
942 /// __start__objc_classes and __stop__objc_classes sections / exist.
943 bool EmittedClass = false;
944 /// Generate the name of a symbol for a reference to a class. Accesses to
945 /// classes should be indirected via this.
David Chisnall7b36a862019-03-31 11:22:33 +0000946
947 typedef std::pair<std::string, std::pair<llvm::Constant*, int>> EarlyInitPair;
948 std::vector<EarlyInitPair> EarlyInitList;
949
David Chisnall404bbcb2018-05-22 10:13:06 +0000950 std::string SymbolForClassRef(StringRef Name, bool isWeak) {
951 if (isWeak)
David Chisnall7b36a862019-03-31 11:22:33 +0000952 return (ManglePublicSymbol("OBJC_WEAK_REF_CLASS_") + Name).str();
David Chisnall404bbcb2018-05-22 10:13:06 +0000953 else
David Chisnall7b36a862019-03-31 11:22:33 +0000954 return (ManglePublicSymbol("OBJC_REF_CLASS_") + Name).str();
David Chisnall404bbcb2018-05-22 10:13:06 +0000955 }
956 /// Generate the name of a class symbol.
957 std::string SymbolForClass(StringRef Name) {
David Chisnall7b36a862019-03-31 11:22:33 +0000958 return (ManglePublicSymbol("OBJC_CLASS_") + Name).str();
David Chisnall404bbcb2018-05-22 10:13:06 +0000959 }
960 void CallRuntimeFunction(CGBuilderTy &B, StringRef FunctionName,
961 ArrayRef<llvm::Value*> Args) {
962 SmallVector<llvm::Type *,8> Types;
963 for (auto *Arg : Args)
964 Types.push_back(Arg->getType());
965 llvm::FunctionType *FT = llvm::FunctionType::get(B.getVoidTy(), Types,
966 false);
James Y Knight9871db02019-02-05 16:42:33 +0000967 llvm::FunctionCallee Fn = CGM.CreateRuntimeFunction(FT, FunctionName);
David Chisnall404bbcb2018-05-22 10:13:06 +0000968 B.CreateCall(Fn, Args);
969 }
970
971 ConstantAddress GenerateConstantString(const StringLiteral *SL) override {
972
973 auto Str = SL->getString();
974 CharUnits Align = CGM.getPointerAlign();
975
976 // Look for an existing one
977 llvm::StringMap<llvm::Constant*>::iterator old = ObjCStrings.find(Str);
978 if (old != ObjCStrings.end())
979 return ConstantAddress(old->getValue(), Align);
980
981 bool isNonASCII = SL->containsNonAscii();
982
Fangrui Song6907ce22018-07-30 19:24:48 +0000983 auto LiteralLength = SL->getLength();
984
David Chisnall404bbcb2018-05-22 10:13:06 +0000985 if ((CGM.getTarget().getPointerWidth(0) == 64) &&
986 (LiteralLength < 9) && !isNonASCII) {
987 // Tiny strings are only used on 64-bit platforms. They store 8 7-bit
988 // ASCII characters in the high 56 bits, followed by a 4-bit length and a
989 // 3-bit tag (which is always 4).
990 uint64_t str = 0;
991 // Fill in the characters
992 for (unsigned i=0 ; i<LiteralLength ; i++)
993 str |= ((uint64_t)SL->getCodeUnit(i)) << ((64 - 4 - 3) - (i*7));
994 // Fill in the length
995 str |= LiteralLength << 3;
996 // Set the tag
997 str |= 4;
998 auto *ObjCStr = llvm::ConstantExpr::getIntToPtr(
999 llvm::ConstantInt::get(Int64Ty, str), IdTy);
1000 ObjCStrings[Str] = ObjCStr;
1001 return ConstantAddress(ObjCStr, Align);
1002 }
1003
1004 StringRef StringClass = CGM.getLangOpts().ObjCConstantStringClass;
1005
1006 if (StringClass.empty()) StringClass = "NSConstantString";
1007
1008 std::string Sym = SymbolForClass(StringClass);
1009
1010 llvm::Constant *isa = TheModule.getNamedGlobal(Sym);
1011
David Chisnall7b36a862019-03-31 11:22:33 +00001012 if (!isa) {
David Chisnall404bbcb2018-05-22 10:13:06 +00001013 isa = new llvm::GlobalVariable(TheModule, IdTy, /* isConstant */false,
1014 llvm::GlobalValue::ExternalLinkage, nullptr, Sym);
David Chisnall7b36a862019-03-31 11:22:33 +00001015 if (CGM.getTriple().isOSBinFormatCOFF()) {
1016 cast<llvm::GlobalValue>(isa)->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1017 }
1018 } else if (isa->getType() != PtrToIdTy)
David Chisnall404bbcb2018-05-22 10:13:06 +00001019 isa = llvm::ConstantExpr::getBitCast(isa, PtrToIdTy);
1020
1021 // struct
1022 // {
1023 // Class isa;
1024 // uint32_t flags;
1025 // uint32_t length; // Number of codepoints
1026 // uint32_t size; // Number of bytes
1027 // uint32_t hash;
1028 // const char *data;
1029 // };
1030
1031 ConstantInitBuilder Builder(CGM);
1032 auto Fields = Builder.beginStruct();
David Chisnall7b36a862019-03-31 11:22:33 +00001033 if (!CGM.getTriple().isOSBinFormatCOFF()) {
1034 Fields.add(isa);
1035 } else {
1036 Fields.addNullPointer(PtrTy);
1037 }
David Chisnall404bbcb2018-05-22 10:13:06 +00001038 // For now, all non-ASCII strings are represented as UTF-16. As such, the
1039 // number of bytes is simply double the number of UTF-16 codepoints. In
1040 // ASCII strings, the number of bytes is equal to the number of non-ASCII
1041 // codepoints.
1042 if (isNonASCII) {
1043 unsigned NumU8CodeUnits = Str.size();
1044 // A UTF-16 representation of a unicode string contains at most the same
1045 // number of code units as a UTF-8 representation. Allocate that much
1046 // space, plus one for the final null character.
1047 SmallVector<llvm::UTF16, 128> ToBuf(NumU8CodeUnits + 1);
1048 const llvm::UTF8 *FromPtr = (const llvm::UTF8 *)Str.data();
1049 llvm::UTF16 *ToPtr = &ToBuf[0];
1050 (void)llvm::ConvertUTF8toUTF16(&FromPtr, FromPtr + NumU8CodeUnits,
1051 &ToPtr, ToPtr + NumU8CodeUnits, llvm::strictConversion);
1052 uint32_t StringLength = ToPtr - &ToBuf[0];
1053 // Add null terminator
1054 *ToPtr = 0;
1055 // Flags: 2 indicates UTF-16 encoding
1056 Fields.addInt(Int32Ty, 2);
1057 // Number of UTF-16 codepoints
1058 Fields.addInt(Int32Ty, StringLength);
1059 // Number of bytes
1060 Fields.addInt(Int32Ty, StringLength * 2);
1061 // Hash. Not currently initialised by the compiler.
1062 Fields.addInt(Int32Ty, 0);
1063 // pointer to the data string.
1064 auto Arr = llvm::makeArrayRef(&ToBuf[0], ToPtr+1);
1065 auto *C = llvm::ConstantDataArray::get(VMContext, Arr);
1066 auto *Buffer = new llvm::GlobalVariable(TheModule, C->getType(),
1067 /*isConstant=*/true, llvm::GlobalValue::PrivateLinkage, C, ".str");
1068 Buffer->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1069 Fields.add(Buffer);
1070 } else {
1071 // Flags: 0 indicates ASCII encoding
1072 Fields.addInt(Int32Ty, 0);
1073 // Number of UTF-16 codepoints, each ASCII byte is a UTF-16 codepoint
1074 Fields.addInt(Int32Ty, Str.size());
1075 // Number of bytes
1076 Fields.addInt(Int32Ty, Str.size());
1077 // Hash. Not currently initialised by the compiler.
1078 Fields.addInt(Int32Ty, 0);
1079 // Data pointer
1080 Fields.add(MakeConstantString(Str));
1081 }
1082 std::string StringName;
1083 bool isNamed = !isNonASCII;
1084 if (isNamed) {
1085 StringName = ".objc_str_";
1086 for (int i=0,e=Str.size() ; i<e ; ++i) {
David Chisnall48a7afa2018-05-22 10:13:17 +00001087 unsigned char c = Str[i];
David Chisnall88e754f2018-05-22 10:13:11 +00001088 if (isalnum(c))
David Chisnall404bbcb2018-05-22 10:13:06 +00001089 StringName += c;
1090 else if (c == ' ')
1091 StringName += '_';
1092 else {
1093 isNamed = false;
1094 break;
1095 }
1096 }
1097 }
1098 auto *ObjCStrGV =
1099 Fields.finishAndCreateGlobal(
1100 isNamed ? StringRef(StringName) : ".objc_string",
1101 Align, false, isNamed ? llvm::GlobalValue::LinkOnceODRLinkage
1102 : llvm::GlobalValue::PrivateLinkage);
David Chisnall93ce0182018-08-10 12:53:13 +00001103 ObjCStrGV->setSection(sectionName<ConstantStringSection>());
David Chisnall404bbcb2018-05-22 10:13:06 +00001104 if (isNamed) {
1105 ObjCStrGV->setComdat(TheModule.getOrInsertComdat(StringName));
1106 ObjCStrGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
1107 }
David Chisnall7b36a862019-03-31 11:22:33 +00001108 if (CGM.getTriple().isOSBinFormatCOFF()) {
1109 std::pair<llvm::Constant*, int> v{ObjCStrGV, 0};
1110 EarlyInitList.emplace_back(Sym, v);
1111 }
David Chisnall404bbcb2018-05-22 10:13:06 +00001112 llvm::Constant *ObjCStr = llvm::ConstantExpr::getBitCast(ObjCStrGV, IdTy);
1113 ObjCStrings[Str] = ObjCStr;
1114 ConstantStrings.push_back(ObjCStr);
1115 return ConstantAddress(ObjCStr, Align);
1116 }
1117
1118 void PushProperty(ConstantArrayBuilder &PropertiesArray,
1119 const ObjCPropertyDecl *property,
1120 const Decl *OCD,
1121 bool isSynthesized=true, bool
1122 isDynamic=true) override {
1123 // struct objc_property
1124 // {
1125 // const char *name;
1126 // const char *attributes;
1127 // const char *type;
1128 // SEL getter;
1129 // SEL setter;
1130 // };
1131 auto Fields = PropertiesArray.beginStruct(PropertyMetadataTy);
1132 ASTContext &Context = CGM.getContext();
1133 Fields.add(MakeConstantString(property->getNameAsString()));
1134 std::string TypeStr =
1135 CGM.getContext().getObjCEncodingForPropertyDecl(property, OCD);
1136 Fields.add(MakeConstantString(TypeStr));
1137 std::string typeStr;
1138 Context.getObjCEncodingForType(property->getType(), typeStr);
1139 Fields.add(MakeConstantString(typeStr));
1140 auto addPropertyMethod = [&](const ObjCMethodDecl *accessor) {
1141 if (accessor) {
1142 std::string TypeStr = Context.getObjCEncodingForMethodDecl(accessor);
1143 Fields.add(GetConstantSelector(accessor->getSelector(), TypeStr));
1144 } else {
1145 Fields.add(NULLPtr);
1146 }
1147 };
1148 addPropertyMethod(property->getGetterMethodDecl());
1149 addPropertyMethod(property->getSetterMethodDecl());
1150 Fields.finishAndAddTo(PropertiesArray);
1151 }
1152
1153 llvm::Constant *
1154 GenerateProtocolMethodList(ArrayRef<const ObjCMethodDecl*> Methods) override {
1155 // struct objc_protocol_method_description
1156 // {
1157 // SEL selector;
1158 // const char *types;
1159 // };
1160 llvm::StructType *ObjCMethodDescTy =
1161 llvm::StructType::get(CGM.getLLVMContext(),
1162 { PtrToInt8Ty, PtrToInt8Ty });
1163 ASTContext &Context = CGM.getContext();
1164 ConstantInitBuilder Builder(CGM);
1165 // struct objc_protocol_method_description_list
1166 // {
1167 // int count;
1168 // int size;
1169 // struct objc_protocol_method_description methods[];
1170 // };
1171 auto MethodList = Builder.beginStruct();
1172 // int count;
1173 MethodList.addInt(IntTy, Methods.size());
1174 // int size; // sizeof(struct objc_method_description)
1175 llvm::DataLayout td(&TheModule);
1176 MethodList.addInt(IntTy, td.getTypeSizeInBits(ObjCMethodDescTy) /
1177 CGM.getContext().getCharWidth());
1178 // struct objc_method_description[]
1179 auto MethodArray = MethodList.beginArray(ObjCMethodDescTy);
1180 for (auto *M : Methods) {
1181 auto Method = MethodArray.beginStruct(ObjCMethodDescTy);
1182 Method.add(CGObjCGNU::GetConstantSelector(M));
1183 Method.add(GetTypeString(Context.getObjCEncodingForMethodDecl(M, true)));
1184 Method.finishAndAddTo(MethodArray);
1185 }
1186 MethodArray.finishAndAddTo(MethodList);
1187 return MethodList.finishAndCreateGlobal(".objc_protocol_method_list",
1188 CGM.getPointerAlign());
1189 }
David Chisnall386477a2018-12-28 17:44:54 +00001190 llvm::Constant *GenerateCategoryProtocolList(const ObjCCategoryDecl *OCD)
1191 override {
1192 SmallVector<llvm::Constant*, 16> Protocols;
1193 for (const auto *PI : OCD->getReferencedProtocols())
1194 Protocols.push_back(
1195 llvm::ConstantExpr::getBitCast(GenerateProtocolRef(PI),
1196 ProtocolPtrTy));
1197 return GenerateProtocolList(Protocols);
1198 }
David Chisnall404bbcb2018-05-22 10:13:06 +00001199
1200 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
1201 llvm::Value *cmd, MessageSendInfo &MSI) override {
1202 // Don't access the slot unless we're trying to cache the result.
1203 CGBuilderTy &Builder = CGF.Builder;
1204 llvm::Value *lookupArgs[] = {CGObjCGNU::EnforceType(Builder, ObjCSuper,
1205 PtrToObjCSuperTy).getPointer(), cmd};
1206 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
1207 }
1208
1209 llvm::GlobalVariable *GetClassVar(StringRef Name, bool isWeak=false) {
1210 std::string SymbolName = SymbolForClassRef(Name, isWeak);
1211 auto *ClassSymbol = TheModule.getNamedGlobal(SymbolName);
1212 if (ClassSymbol)
1213 return ClassSymbol;
1214 ClassSymbol = new llvm::GlobalVariable(TheModule,
1215 IdTy, false, llvm::GlobalValue::ExternalLinkage,
1216 nullptr, SymbolName);
1217 // If this is a weak symbol, then we are creating a valid definition for
1218 // the symbol, pointing to a weak definition of the real class pointer. If
1219 // this is not a weak reference, then we are expecting another compilation
1220 // unit to provide the real indirection symbol.
1221 if (isWeak)
1222 ClassSymbol->setInitializer(new llvm::GlobalVariable(TheModule,
1223 Int8Ty, false, llvm::GlobalValue::ExternalWeakLinkage,
1224 nullptr, SymbolForClass(Name)));
David Chisnall7b36a862019-03-31 11:22:33 +00001225 else {
1226 if (CGM.getTriple().isOSBinFormatCOFF()) {
1227 IdentifierInfo &II = CGM.getContext().Idents.get(Name);
1228 TranslationUnitDecl *TUDecl = CGM.getContext().getTranslationUnitDecl();
1229 DeclContext *DC = TranslationUnitDecl::castToDeclContext(TUDecl);
1230
1231 const ObjCInterfaceDecl *OID = nullptr;
1232 for (const auto &Result : DC->lookup(&II))
1233 if ((OID = dyn_cast<ObjCInterfaceDecl>(Result)))
1234 break;
1235
1236 // The first Interface we find may be a @class,
1237 // which should only be treated as the source of
1238 // truth in the absence of a true declaration.
1239 const ObjCInterfaceDecl *OIDDef = OID->getDefinition();
1240 if (OIDDef != nullptr)
1241 OID = OIDDef;
1242
1243 auto Storage = llvm::GlobalValue::DefaultStorageClass;
1244 if (OID->hasAttr<DLLImportAttr>())
1245 Storage = llvm::GlobalValue::DLLImportStorageClass;
1246 else if (OID->hasAttr<DLLExportAttr>())
1247 Storage = llvm::GlobalValue::DLLExportStorageClass;
1248
1249 cast<llvm::GlobalValue>(ClassSymbol)->setDLLStorageClass(Storage);
1250 }
1251 }
David Chisnall404bbcb2018-05-22 10:13:06 +00001252 assert(ClassSymbol->getName() == SymbolName);
1253 return ClassSymbol;
1254 }
1255 llvm::Value *GetClassNamed(CodeGenFunction &CGF,
1256 const std::string &Name,
1257 bool isWeak) override {
1258 return CGF.Builder.CreateLoad(Address(GetClassVar(Name, isWeak),
1259 CGM.getPointerAlign()));
1260 }
1261 int32_t FlagsForOwnership(Qualifiers::ObjCLifetime Ownership) {
1262 // typedef enum {
1263 // ownership_invalid = 0,
1264 // ownership_strong = 1,
1265 // ownership_weak = 2,
1266 // ownership_unsafe = 3
1267 // } ivar_ownership;
1268 int Flag;
1269 switch (Ownership) {
1270 case Qualifiers::OCL_Strong:
1271 Flag = 1;
1272 break;
1273 case Qualifiers::OCL_Weak:
1274 Flag = 2;
1275 break;
1276 case Qualifiers::OCL_ExplicitNone:
1277 Flag = 3;
1278 break;
1279 case Qualifiers::OCL_None:
1280 case Qualifiers::OCL_Autoreleasing:
1281 assert(Ownership != Qualifiers::OCL_Autoreleasing);
1282 Flag = 0;
1283 }
1284 return Flag;
1285 }
1286 llvm::Constant *GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
1287 ArrayRef<llvm::Constant *> IvarTypes,
1288 ArrayRef<llvm::Constant *> IvarOffsets,
1289 ArrayRef<llvm::Constant *> IvarAlign,
1290 ArrayRef<Qualifiers::ObjCLifetime> IvarOwnership) override {
1291 llvm_unreachable("Method should not be called!");
1292 }
1293
1294 llvm::Constant *GenerateEmptyProtocol(StringRef ProtocolName) override {
1295 std::string Name = SymbolForProtocol(ProtocolName);
1296 auto *GV = TheModule.getGlobalVariable(Name);
1297 if (!GV) {
Fangrui Song6907ce22018-07-30 19:24:48 +00001298 // Emit a placeholder symbol.
David Chisnall404bbcb2018-05-22 10:13:06 +00001299 GV = new llvm::GlobalVariable(TheModule, ProtocolTy, false,
1300 llvm::GlobalValue::ExternalLinkage, nullptr, Name);
Guillaume Chateletc79099e2019-10-03 13:00:29 +00001301 GV->setAlignment(CGM.getPointerAlign().getAsAlign());
David Chisnall404bbcb2018-05-22 10:13:06 +00001302 }
1303 return llvm::ConstantExpr::getBitCast(GV, ProtocolPtrTy);
1304 }
1305
1306 /// Existing protocol references.
1307 llvm::StringMap<llvm::Constant*> ExistingProtocolRefs;
1308
1309 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1310 const ObjCProtocolDecl *PD) override {
1311 auto Name = PD->getNameAsString();
1312 auto *&Ref = ExistingProtocolRefs[Name];
1313 if (!Ref) {
1314 auto *&Protocol = ExistingProtocols[Name];
1315 if (!Protocol)
1316 Protocol = GenerateProtocolRef(PD);
1317 std::string RefName = SymbolForProtocolRef(Name);
1318 assert(!TheModule.getGlobalVariable(RefName));
1319 // Emit a reference symbol.
1320 auto GV = new llvm::GlobalVariable(TheModule, ProtocolPtrTy,
David Chisnall93ce0182018-08-10 12:53:13 +00001321 false, llvm::GlobalValue::LinkOnceODRLinkage,
David Chisnall404bbcb2018-05-22 10:13:06 +00001322 llvm::ConstantExpr::getBitCast(Protocol, ProtocolPtrTy), RefName);
David Chisnall93ce0182018-08-10 12:53:13 +00001323 GV->setComdat(TheModule.getOrInsertComdat(RefName));
1324 GV->setSection(sectionName<ProtocolReferenceSection>());
Guillaume Chateletc79099e2019-10-03 13:00:29 +00001325 GV->setAlignment(CGM.getPointerAlign().getAsAlign());
David Chisnall404bbcb2018-05-22 10:13:06 +00001326 Ref = GV;
1327 }
1328 EmittedProtocolRef = true;
1329 return CGF.Builder.CreateAlignedLoad(Ref, CGM.getPointerAlign());
1330 }
1331
1332 llvm::Constant *GenerateProtocolList(ArrayRef<llvm::Constant*> Protocols) {
1333 llvm::ArrayType *ProtocolArrayTy = llvm::ArrayType::get(ProtocolPtrTy,
1334 Protocols.size());
1335 llvm::Constant * ProtocolArray = llvm::ConstantArray::get(ProtocolArrayTy,
1336 Protocols);
1337 ConstantInitBuilder builder(CGM);
1338 auto ProtocolBuilder = builder.beginStruct();
1339 ProtocolBuilder.addNullPointer(PtrTy);
1340 ProtocolBuilder.addInt(SizeTy, Protocols.size());
1341 ProtocolBuilder.add(ProtocolArray);
1342 return ProtocolBuilder.finishAndCreateGlobal(".objc_protocol_list",
1343 CGM.getPointerAlign(), false, llvm::GlobalValue::InternalLinkage);
1344 }
1345
1346 void GenerateProtocol(const ObjCProtocolDecl *PD) override {
1347 // Do nothing - we only emit referenced protocols.
1348 }
1349 llvm::Constant *GenerateProtocolRef(const ObjCProtocolDecl *PD) {
1350 std::string ProtocolName = PD->getNameAsString();
1351 auto *&Protocol = ExistingProtocols[ProtocolName];
1352 if (Protocol)
1353 return Protocol;
1354
1355 EmittedProtocol = true;
Fangrui Song6907ce22018-07-30 19:24:48 +00001356
David Chisnall93ce0182018-08-10 12:53:13 +00001357 auto SymName = SymbolForProtocol(ProtocolName);
1358 auto *OldGV = TheModule.getGlobalVariable(SymName);
1359
David Chisnall404bbcb2018-05-22 10:13:06 +00001360 // Use the protocol definition, if there is one.
1361 if (const ObjCProtocolDecl *Def = PD->getDefinition())
1362 PD = Def;
David Chisnall93ce0182018-08-10 12:53:13 +00001363 else {
1364 // If there is no definition, then create an external linkage symbol and
1365 // hope that someone else fills it in for us (and fail to link if they
1366 // don't).
1367 assert(!OldGV);
1368 Protocol = new llvm::GlobalVariable(TheModule, ProtocolTy,
1369 /*isConstant*/false,
1370 llvm::GlobalValue::ExternalLinkage, nullptr, SymName);
1371 return Protocol;
1372 }
David Chisnall404bbcb2018-05-22 10:13:06 +00001373
1374 SmallVector<llvm::Constant*, 16> Protocols;
1375 for (const auto *PI : PD->protocols())
1376 Protocols.push_back(
1377 llvm::ConstantExpr::getBitCast(GenerateProtocolRef(PI),
1378 ProtocolPtrTy));
1379 llvm::Constant *ProtocolList = GenerateProtocolList(Protocols);
1380
1381 // Collect information about methods
1382 llvm::Constant *InstanceMethodList, *OptionalInstanceMethodList;
1383 llvm::Constant *ClassMethodList, *OptionalClassMethodList;
1384 EmitProtocolMethodList(PD->instance_methods(), InstanceMethodList,
1385 OptionalInstanceMethodList);
1386 EmitProtocolMethodList(PD->class_methods(), ClassMethodList,
1387 OptionalClassMethodList);
1388
David Chisnall404bbcb2018-05-22 10:13:06 +00001389 // The isa pointer must be set to a magic number so the runtime knows it's
1390 // the correct layout.
1391 ConstantInitBuilder builder(CGM);
1392 auto ProtocolBuilder = builder.beginStruct();
1393 ProtocolBuilder.add(llvm::ConstantExpr::getIntToPtr(
1394 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
1395 ProtocolBuilder.add(MakeConstantString(ProtocolName));
1396 ProtocolBuilder.add(ProtocolList);
1397 ProtocolBuilder.add(InstanceMethodList);
1398 ProtocolBuilder.add(ClassMethodList);
1399 ProtocolBuilder.add(OptionalInstanceMethodList);
1400 ProtocolBuilder.add(OptionalClassMethodList);
1401 // Required instance properties
1402 ProtocolBuilder.add(GeneratePropertyList(nullptr, PD, false, false));
1403 // Optional instance properties
1404 ProtocolBuilder.add(GeneratePropertyList(nullptr, PD, false, true));
1405 // Required class properties
1406 ProtocolBuilder.add(GeneratePropertyList(nullptr, PD, true, false));
1407 // Optional class properties
1408 ProtocolBuilder.add(GeneratePropertyList(nullptr, PD, true, true));
1409
1410 auto *GV = ProtocolBuilder.finishAndCreateGlobal(SymName,
1411 CGM.getPointerAlign(), false, llvm::GlobalValue::ExternalLinkage);
David Chisnall93ce0182018-08-10 12:53:13 +00001412 GV->setSection(sectionName<ProtocolSection>());
David Chisnall404bbcb2018-05-22 10:13:06 +00001413 GV->setComdat(TheModule.getOrInsertComdat(SymName));
1414 if (OldGV) {
1415 OldGV->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(GV,
1416 OldGV->getType()));
1417 OldGV->removeFromParent();
1418 GV->setName(SymName);
1419 }
1420 Protocol = GV;
1421 return GV;
1422 }
1423 llvm::Constant *EnforceType(llvm::Constant *Val, llvm::Type *Ty) {
1424 if (Val->getType() == Ty)
1425 return Val;
1426 return llvm::ConstantExpr::getBitCast(Val, Ty);
1427 }
Simon Pilgrim04c5a342018-08-08 15:53:14 +00001428 llvm::Value *GetTypedSelector(CodeGenFunction &CGF, Selector Sel,
1429 const std::string &TypeEncoding) override {
David Chisnall404bbcb2018-05-22 10:13:06 +00001430 return GetConstantSelector(Sel, TypeEncoding);
1431 }
1432 llvm::Constant *GetTypeString(llvm::StringRef TypeEncoding) {
1433 if (TypeEncoding.empty())
1434 return NULLPtr;
1435 std::string MangledTypes = TypeEncoding;
1436 std::replace(MangledTypes.begin(), MangledTypes.end(),
1437 '@', '\1');
1438 std::string TypesVarName = ".objc_sel_types_" + MangledTypes;
1439 auto *TypesGlobal = TheModule.getGlobalVariable(TypesVarName);
1440 if (!TypesGlobal) {
1441 llvm::Constant *Init = llvm::ConstantDataArray::getString(VMContext,
1442 TypeEncoding);
1443 auto *GV = new llvm::GlobalVariable(TheModule, Init->getType(),
1444 true, llvm::GlobalValue::LinkOnceODRLinkage, Init, TypesVarName);
David Chisnall93ce0182018-08-10 12:53:13 +00001445 GV->setComdat(TheModule.getOrInsertComdat(TypesVarName));
David Chisnall404bbcb2018-05-22 10:13:06 +00001446 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
1447 TypesGlobal = GV;
1448 }
1449 return llvm::ConstantExpr::getGetElementPtr(TypesGlobal->getValueType(),
1450 TypesGlobal, Zeros);
1451 }
1452 llvm::Constant *GetConstantSelector(Selector Sel,
1453 const std::string &TypeEncoding) override {
1454 // @ is used as a special character in symbol names (used for symbol
1455 // versioning), so mangle the name to not include it. Replace it with a
1456 // character that is not a valid type encoding character (and, being
1457 // non-printable, never will be!)
1458 std::string MangledTypes = TypeEncoding;
1459 std::replace(MangledTypes.begin(), MangledTypes.end(),
1460 '@', '\1');
1461 auto SelVarName = (StringRef(".objc_selector_") + Sel.getAsString() + "_" +
1462 MangledTypes).str();
1463 if (auto *GV = TheModule.getNamedGlobal(SelVarName))
1464 return EnforceType(GV, SelectorTy);
1465 ConstantInitBuilder builder(CGM);
1466 auto SelBuilder = builder.beginStruct();
1467 SelBuilder.add(ExportUniqueString(Sel.getAsString(), ".objc_sel_name_",
1468 true));
1469 SelBuilder.add(GetTypeString(TypeEncoding));
1470 auto *GV = SelBuilder.finishAndCreateGlobal(SelVarName,
1471 CGM.getPointerAlign(), false, llvm::GlobalValue::LinkOnceODRLinkage);
1472 GV->setComdat(TheModule.getOrInsertComdat(SelVarName));
1473 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
David Chisnall93ce0182018-08-10 12:53:13 +00001474 GV->setSection(sectionName<SelectorSection>());
David Chisnall404bbcb2018-05-22 10:13:06 +00001475 auto *SelVal = EnforceType(GV, SelectorTy);
1476 return SelVal;
1477 }
David Chisnall93ce0182018-08-10 12:53:13 +00001478 llvm::StructType *emptyStruct = nullptr;
1479
1480 /// Return pointers to the start and end of a section. On ELF platforms, we
1481 /// use the __start_ and __stop_ symbols that GNU-compatible linkers will set
1482 /// to the start and end of section names, as long as those section names are
1483 /// valid identifiers and the symbols are referenced but not defined. On
1484 /// Windows, we use the fact that MSVC-compatible linkers will lexically sort
1485 /// by subsections and place everything that we want to reference in a middle
1486 /// subsection and then insert zero-sized symbols in subsections a and z.
David Chisnall404bbcb2018-05-22 10:13:06 +00001487 std::pair<llvm::Constant*,llvm::Constant*>
1488 GetSectionBounds(StringRef Section) {
David Chisnall93ce0182018-08-10 12:53:13 +00001489 if (CGM.getTriple().isOSBinFormatCOFF()) {
1490 if (emptyStruct == nullptr) {
1491 emptyStruct = llvm::StructType::create(VMContext, ".objc_section_sentinel");
1492 emptyStruct->setBody({}, /*isPacked*/true);
1493 }
1494 auto ZeroInit = llvm::Constant::getNullValue(emptyStruct);
1495 auto Sym = [&](StringRef Prefix, StringRef SecSuffix) {
1496 auto *Sym = new llvm::GlobalVariable(TheModule, emptyStruct,
1497 /*isConstant*/false,
1498 llvm::GlobalValue::LinkOnceODRLinkage, ZeroInit, Prefix +
1499 Section);
1500 Sym->setVisibility(llvm::GlobalValue::HiddenVisibility);
1501 Sym->setSection((Section + SecSuffix).str());
1502 Sym->setComdat(TheModule.getOrInsertComdat((Prefix +
1503 Section).str()));
Guillaume Chateletc79099e2019-10-03 13:00:29 +00001504 Sym->setAlignment(CGM.getPointerAlign().getAsAlign());
David Chisnall93ce0182018-08-10 12:53:13 +00001505 return Sym;
1506 };
1507 return { Sym("__start_", "$a"), Sym("__stop", "$z") };
1508 }
David Chisnall404bbcb2018-05-22 10:13:06 +00001509 auto *Start = new llvm::GlobalVariable(TheModule, PtrTy,
1510 /*isConstant*/false,
1511 llvm::GlobalValue::ExternalLinkage, nullptr, StringRef("__start_") +
1512 Section);
1513 Start->setVisibility(llvm::GlobalValue::HiddenVisibility);
1514 auto *Stop = new llvm::GlobalVariable(TheModule, PtrTy,
1515 /*isConstant*/false,
1516 llvm::GlobalValue::ExternalLinkage, nullptr, StringRef("__stop_") +
1517 Section);
1518 Stop->setVisibility(llvm::GlobalValue::HiddenVisibility);
1519 return { Start, Stop };
1520 }
David Chisnall93ce0182018-08-10 12:53:13 +00001521 CatchTypeInfo getCatchAllTypeInfo() override {
1522 return CGM.getCXXABI().getCatchAllTypeInfo();
1523 }
David Chisnall404bbcb2018-05-22 10:13:06 +00001524 llvm::Function *ModuleInitFunction() override {
1525 llvm::Function *LoadFunction = llvm::Function::Create(
1526 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext), false),
1527 llvm::GlobalValue::LinkOnceODRLinkage, ".objcv2_load_function",
1528 &TheModule);
1529 LoadFunction->setVisibility(llvm::GlobalValue::HiddenVisibility);
1530 LoadFunction->setComdat(TheModule.getOrInsertComdat(".objcv2_load_function"));
1531
1532 llvm::BasicBlock *EntryBB =
1533 llvm::BasicBlock::Create(VMContext, "entry", LoadFunction);
1534 CGBuilderTy B(CGM, VMContext);
1535 B.SetInsertPoint(EntryBB);
1536 ConstantInitBuilder builder(CGM);
1537 auto InitStructBuilder = builder.beginStruct();
1538 InitStructBuilder.addInt(Int64Ty, 0);
David Chisnall7b36a862019-03-31 11:22:33 +00001539 auto &sectionVec = CGM.getTriple().isOSBinFormatCOFF() ? PECOFFSectionsBaseNames : SectionsBaseNames;
1540 for (auto *s : sectionVec) {
David Chisnall93ce0182018-08-10 12:53:13 +00001541 auto bounds = GetSectionBounds(s);
David Chisnall404bbcb2018-05-22 10:13:06 +00001542 InitStructBuilder.add(bounds.first);
1543 InitStructBuilder.add(bounds.second);
David Chisnall7b36a862019-03-31 11:22:33 +00001544 }
David Chisnall404bbcb2018-05-22 10:13:06 +00001545 auto *InitStruct = InitStructBuilder.finishAndCreateGlobal(".objc_init",
1546 CGM.getPointerAlign(), false, llvm::GlobalValue::LinkOnceODRLinkage);
1547 InitStruct->setVisibility(llvm::GlobalValue::HiddenVisibility);
1548 InitStruct->setComdat(TheModule.getOrInsertComdat(".objc_init"));
1549
1550 CallRuntimeFunction(B, "__objc_load", {InitStruct});;
1551 B.CreateRetVoid();
1552 // Make sure that the optimisers don't delete this function.
1553 CGM.addCompilerUsedGlobal(LoadFunction);
1554 // FIXME: Currently ELF only!
1555 // We have to do this by hand, rather than with @llvm.ctors, so that the
1556 // linker can remove the duplicate invocations.
1557 auto *InitVar = new llvm::GlobalVariable(TheModule, LoadFunction->getType(),
1558 /*isConstant*/true, llvm::GlobalValue::LinkOnceAnyLinkage,
1559 LoadFunction, ".objc_ctor");
1560 // Check that this hasn't been renamed. This shouldn't happen, because
1561 // this function should be called precisely once.
1562 assert(InitVar->getName() == ".objc_ctor");
David Chisnall93ce0182018-08-10 12:53:13 +00001563 // In Windows, initialisers are sorted by the suffix. XCL is for library
1564 // initialisers, which run before user initialisers. We are running
1565 // Objective-C loads at the end of library load. This means +load methods
1566 // will run before any other static constructors, but that static
1567 // constructors can see a fully initialised Objective-C state.
1568 if (CGM.getTriple().isOSBinFormatCOFF())
1569 InitVar->setSection(".CRT$XCLz");
1570 else
David Chisnall0e9e02c2019-03-31 11:22:19 +00001571 {
1572 if (CGM.getCodeGenOpts().UseInitArray)
1573 InitVar->setSection(".init_array");
1574 else
1575 InitVar->setSection(".ctors");
1576 }
David Chisnall404bbcb2018-05-22 10:13:06 +00001577 InitVar->setVisibility(llvm::GlobalValue::HiddenVisibility);
1578 InitVar->setComdat(TheModule.getOrInsertComdat(".objc_ctor"));
David Chisnall93ce0182018-08-10 12:53:13 +00001579 CGM.addUsedGlobal(InitVar);
David Chisnall404bbcb2018-05-22 10:13:06 +00001580 for (auto *C : Categories) {
1581 auto *Cat = cast<llvm::GlobalVariable>(C->stripPointerCasts());
David Chisnall93ce0182018-08-10 12:53:13 +00001582 Cat->setSection(sectionName<CategorySection>());
David Chisnall404bbcb2018-05-22 10:13:06 +00001583 CGM.addUsedGlobal(Cat);
1584 }
David Chisnall404bbcb2018-05-22 10:13:06 +00001585 auto createNullGlobal = [&](StringRef Name, ArrayRef<llvm::Constant*> Init,
1586 StringRef Section) {
1587 auto nullBuilder = builder.beginStruct();
1588 for (auto *F : Init)
1589 nullBuilder.add(F);
1590 auto GV = nullBuilder.finishAndCreateGlobal(Name, CGM.getPointerAlign(),
1591 false, llvm::GlobalValue::LinkOnceODRLinkage);
1592 GV->setSection(Section);
1593 GV->setComdat(TheModule.getOrInsertComdat(Name));
1594 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
1595 CGM.addUsedGlobal(GV);
1596 return GV;
1597 };
David Chisnall93ce0182018-08-10 12:53:13 +00001598 for (auto clsAlias : ClassAliases)
1599 createNullGlobal(std::string(".objc_class_alias") +
1600 clsAlias.second, { MakeConstantString(clsAlias.second),
1601 GetClassVar(clsAlias.first) }, sectionName<ClassAliasSection>());
1602 // On ELF platforms, add a null value for each special section so that we
1603 // can always guarantee that the _start and _stop symbols will exist and be
1604 // meaningful. This is not required on COFF platforms, where our start and
1605 // stop symbols will create the section.
1606 if (!CGM.getTriple().isOSBinFormatCOFF()) {
1607 createNullGlobal(".objc_null_selector", {NULLPtr, NULLPtr},
1608 sectionName<SelectorSection>());
1609 if (Categories.empty())
1610 createNullGlobal(".objc_null_category", {NULLPtr, NULLPtr,
1611 NULLPtr, NULLPtr, NULLPtr, NULLPtr, NULLPtr},
1612 sectionName<CategorySection>());
1613 if (!EmittedClass) {
1614 createNullGlobal(".objc_null_cls_init_ref", NULLPtr,
David Chisnallddd06822018-12-27 14:44:36 +00001615 sectionName<ClassSection>());
David Chisnall93ce0182018-08-10 12:53:13 +00001616 createNullGlobal(".objc_null_class_ref", { NULLPtr, NULLPtr },
1617 sectionName<ClassReferenceSection>());
1618 }
1619 if (!EmittedProtocol)
1620 createNullGlobal(".objc_null_protocol", {NULLPtr, NULLPtr, NULLPtr,
1621 NULLPtr, NULLPtr, NULLPtr, NULLPtr, NULLPtr, NULLPtr, NULLPtr,
1622 NULLPtr}, sectionName<ProtocolSection>());
1623 if (!EmittedProtocolRef)
1624 createNullGlobal(".objc_null_protocol_ref", {NULLPtr},
1625 sectionName<ProtocolReferenceSection>());
1626 if (ClassAliases.empty())
1627 createNullGlobal(".objc_null_class_alias", { NULLPtr, NULLPtr },
1628 sectionName<ClassAliasSection>());
1629 if (ConstantStrings.empty()) {
1630 auto i32Zero = llvm::ConstantInt::get(Int32Ty, 0);
1631 createNullGlobal(".objc_null_constant_string", { NULLPtr, i32Zero,
1632 i32Zero, i32Zero, i32Zero, NULLPtr },
1633 sectionName<ConstantStringSection>());
1634 }
David Chisnall404bbcb2018-05-22 10:13:06 +00001635 }
1636 ConstantStrings.clear();
1637 Categories.clear();
1638 Classes.clear();
David Chisnall7b36a862019-03-31 11:22:33 +00001639
1640 if (EarlyInitList.size() > 0) {
1641 auto *Init = llvm::Function::Create(llvm::FunctionType::get(CGM.VoidTy,
1642 {}), llvm::GlobalValue::InternalLinkage, ".objc_early_init",
1643 &CGM.getModule());
1644 llvm::IRBuilder<> b(llvm::BasicBlock::Create(CGM.getLLVMContext(), "entry",
1645 Init));
1646 for (const auto &lateInit : EarlyInitList) {
1647 auto *global = TheModule.getGlobalVariable(lateInit.first);
1648 if (global) {
1649 b.CreateAlignedStore(global,
1650 b.CreateStructGEP(lateInit.second.first, lateInit.second.second), CGM.getPointerAlign().getQuantity());
1651 }
1652 }
1653 b.CreateRetVoid();
1654 // We can't use the normal LLVM global initialisation array, because we
1655 // need to specify that this runs early in library initialisation.
1656 auto *InitVar = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
1657 /*isConstant*/true, llvm::GlobalValue::InternalLinkage,
1658 Init, ".objc_early_init_ptr");
1659 InitVar->setSection(".CRT$XCLb");
1660 CGM.addUsedGlobal(InitVar);
1661 }
David Chisnall93ce0182018-08-10 12:53:13 +00001662 return nullptr;
David Chisnall404bbcb2018-05-22 10:13:06 +00001663 }
1664 /// In the v2 ABI, ivar offset variables use the type encoding in their name
1665 /// to trigger linker failures if the types don't match.
1666 std::string GetIVarOffsetVariableName(const ObjCInterfaceDecl *ID,
1667 const ObjCIvarDecl *Ivar) override {
1668 std::string TypeEncoding;
1669 CGM.getContext().getObjCEncodingForType(Ivar->getType(), TypeEncoding);
1670 // Prevent the @ from being interpreted as a symbol version.
1671 std::replace(TypeEncoding.begin(), TypeEncoding.end(),
1672 '@', '\1');
1673 const std::string Name = "__objc_ivar_offset_" + ID->getNameAsString()
1674 + '.' + Ivar->getNameAsString() + '.' + TypeEncoding;
1675 return Name;
1676 }
1677 llvm::Value *EmitIvarOffset(CodeGenFunction &CGF,
1678 const ObjCInterfaceDecl *Interface,
1679 const ObjCIvarDecl *Ivar) override {
1680 const std::string Name = GetIVarOffsetVariableName(Ivar->getContainingInterface(), Ivar);
1681 llvm::GlobalVariable *IvarOffsetPointer = TheModule.getNamedGlobal(Name);
1682 if (!IvarOffsetPointer)
1683 IvarOffsetPointer = new llvm::GlobalVariable(TheModule, IntTy, false,
1684 llvm::GlobalValue::ExternalLinkage, nullptr, Name);
1685 CharUnits Align = CGM.getIntAlign();
1686 llvm::Value *Offset = CGF.Builder.CreateAlignedLoad(IvarOffsetPointer, Align);
1687 if (Offset->getType() != PtrDiffTy)
1688 Offset = CGF.Builder.CreateZExtOrBitCast(Offset, PtrDiffTy);
1689 return Offset;
1690 }
1691 void GenerateClass(const ObjCImplementationDecl *OID) override {
1692 ASTContext &Context = CGM.getContext();
David Chisnall7b36a862019-03-31 11:22:33 +00001693 bool IsCOFF = CGM.getTriple().isOSBinFormatCOFF();
David Chisnall404bbcb2018-05-22 10:13:06 +00001694
1695 // Get the class name
1696 ObjCInterfaceDecl *classDecl =
1697 const_cast<ObjCInterfaceDecl *>(OID->getClassInterface());
1698 std::string className = classDecl->getNameAsString();
1699 auto *classNameConstant = MakeConstantString(className);
1700
1701 ConstantInitBuilder builder(CGM);
1702 auto metaclassFields = builder.beginStruct();
1703 // struct objc_class *isa;
1704 metaclassFields.addNullPointer(PtrTy);
1705 // struct objc_class *super_class;
1706 metaclassFields.addNullPointer(PtrTy);
1707 // const char *name;
1708 metaclassFields.add(classNameConstant);
1709 // long version;
1710 metaclassFields.addInt(LongTy, 0);
1711 // unsigned long info;
1712 // objc_class_flag_meta
1713 metaclassFields.addInt(LongTy, 1);
1714 // long instance_size;
1715 // Setting this to zero is consistent with the older ABI, but it might be
1716 // more sensible to set this to sizeof(struct objc_class)
1717 metaclassFields.addInt(LongTy, 0);
1718 // struct objc_ivar_list *ivars;
1719 metaclassFields.addNullPointer(PtrTy);
1720 // struct objc_method_list *methods
1721 // FIXME: Almost identical code is copied and pasted below for the
1722 // class, but refactoring it cleanly requires C++14 generic lambdas.
1723 if (OID->classmeth_begin() == OID->classmeth_end())
1724 metaclassFields.addNullPointer(PtrTy);
1725 else {
1726 SmallVector<ObjCMethodDecl*, 16> ClassMethods;
1727 ClassMethods.insert(ClassMethods.begin(), OID->classmeth_begin(),
1728 OID->classmeth_end());
1729 metaclassFields.addBitCast(
1730 GenerateMethodList(className, "", ClassMethods, true),
1731 PtrTy);
1732 }
1733 // void *dtable;
1734 metaclassFields.addNullPointer(PtrTy);
1735 // IMP cxx_construct;
1736 metaclassFields.addNullPointer(PtrTy);
1737 // IMP cxx_destruct;
1738 metaclassFields.addNullPointer(PtrTy);
1739 // struct objc_class *subclass_list
1740 metaclassFields.addNullPointer(PtrTy);
1741 // struct objc_class *sibling_class
1742 metaclassFields.addNullPointer(PtrTy);
1743 // struct objc_protocol_list *protocols;
1744 metaclassFields.addNullPointer(PtrTy);
1745 // struct reference_list *extra_data;
1746 metaclassFields.addNullPointer(PtrTy);
1747 // long abi_version;
1748 metaclassFields.addInt(LongTy, 0);
1749 // struct objc_property_list *properties
1750 metaclassFields.add(GeneratePropertyList(OID, classDecl, /*isClassProperty*/true));
1751
David Chisnall7b36a862019-03-31 11:22:33 +00001752 auto *metaclass = metaclassFields.finishAndCreateGlobal(
1753 ManglePublicSymbol("OBJC_METACLASS_") + className,
1754 CGM.getPointerAlign());
David Chisnall404bbcb2018-05-22 10:13:06 +00001755
1756 auto classFields = builder.beginStruct();
1757 // struct objc_class *isa;
1758 classFields.add(metaclass);
1759 // struct objc_class *super_class;
1760 // Get the superclass name.
1761 const ObjCInterfaceDecl * SuperClassDecl =
1762 OID->getClassInterface()->getSuperClass();
David Chisnall7b36a862019-03-31 11:22:33 +00001763 llvm::Constant *SuperClass = nullptr;
David Chisnall404bbcb2018-05-22 10:13:06 +00001764 if (SuperClassDecl) {
1765 auto SuperClassName = SymbolForClass(SuperClassDecl->getNameAsString());
David Chisnall7b36a862019-03-31 11:22:33 +00001766 SuperClass = TheModule.getNamedGlobal(SuperClassName);
David Chisnall404bbcb2018-05-22 10:13:06 +00001767 if (!SuperClass)
1768 {
1769 SuperClass = new llvm::GlobalVariable(TheModule, PtrTy, false,
1770 llvm::GlobalValue::ExternalLinkage, nullptr, SuperClassName);
David Chisnall7b36a862019-03-31 11:22:33 +00001771 if (IsCOFF) {
1772 auto Storage = llvm::GlobalValue::DefaultStorageClass;
1773 if (SuperClassDecl->hasAttr<DLLImportAttr>())
1774 Storage = llvm::GlobalValue::DLLImportStorageClass;
1775 else if (SuperClassDecl->hasAttr<DLLExportAttr>())
1776 Storage = llvm::GlobalValue::DLLExportStorageClass;
1777
1778 cast<llvm::GlobalValue>(SuperClass)->setDLLStorageClass(Storage);
1779 }
David Chisnall404bbcb2018-05-22 10:13:06 +00001780 }
David Chisnall7b36a862019-03-31 11:22:33 +00001781 if (!IsCOFF)
1782 classFields.add(llvm::ConstantExpr::getBitCast(SuperClass, PtrTy));
1783 else
1784 classFields.addNullPointer(PtrTy);
David Chisnall404bbcb2018-05-22 10:13:06 +00001785 } else
1786 classFields.addNullPointer(PtrTy);
1787 // const char *name;
1788 classFields.add(classNameConstant);
1789 // long version;
1790 classFields.addInt(LongTy, 0);
1791 // unsigned long info;
1792 // !objc_class_flag_meta
1793 classFields.addInt(LongTy, 0);
1794 // long instance_size;
1795 int superInstanceSize = !SuperClassDecl ? 0 :
1796 Context.getASTObjCInterfaceLayout(SuperClassDecl).getSize().getQuantity();
1797 // Instance size is negative for classes that have not yet had their ivar
1798 // layout calculated.
1799 classFields.addInt(LongTy,
1800 0 - (Context.getASTObjCImplementationLayout(OID).getSize().getQuantity() -
1801 superInstanceSize));
1802
1803 if (classDecl->all_declared_ivar_begin() == nullptr)
1804 classFields.addNullPointer(PtrTy);
1805 else {
1806 int ivar_count = 0;
1807 for (const ObjCIvarDecl *IVD = classDecl->all_declared_ivar_begin(); IVD;
1808 IVD = IVD->getNextIvar()) ivar_count++;
1809 llvm::DataLayout td(&TheModule);
1810 // struct objc_ivar_list *ivars;
1811 ConstantInitBuilder b(CGM);
1812 auto ivarListBuilder = b.beginStruct();
1813 // int count;
1814 ivarListBuilder.addInt(IntTy, ivar_count);
1815 // size_t size;
1816 llvm::StructType *ObjCIvarTy = llvm::StructType::get(
1817 PtrToInt8Ty,
1818 PtrToInt8Ty,
1819 PtrToInt8Ty,
1820 Int32Ty,
1821 Int32Ty);
1822 ivarListBuilder.addInt(SizeTy, td.getTypeSizeInBits(ObjCIvarTy) /
1823 CGM.getContext().getCharWidth());
1824 // struct objc_ivar ivars[]
1825 auto ivarArrayBuilder = ivarListBuilder.beginArray();
David Chisnall404bbcb2018-05-22 10:13:06 +00001826 for (const ObjCIvarDecl *IVD = classDecl->all_declared_ivar_begin(); IVD;
1827 IVD = IVD->getNextIvar()) {
1828 auto ivarTy = IVD->getType();
1829 auto ivarBuilder = ivarArrayBuilder.beginStruct();
1830 // const char *name;
1831 ivarBuilder.add(MakeConstantString(IVD->getNameAsString()));
1832 // const char *type;
1833 std::string TypeStr;
1834 //Context.getObjCEncodingForType(ivarTy, TypeStr, IVD, true);
1835 Context.getObjCEncodingForMethodParameter(Decl::OBJC_TQ_None, ivarTy, TypeStr, true);
1836 ivarBuilder.add(MakeConstantString(TypeStr));
1837 // int *offset;
1838 uint64_t BaseOffset = ComputeIvarBaseOffset(CGM, OID, IVD);
1839 uint64_t Offset = BaseOffset - superInstanceSize;
1840 llvm::Constant *OffsetValue = llvm::ConstantInt::get(IntTy, Offset);
1841 std::string OffsetName = GetIVarOffsetVariableName(classDecl, IVD);
1842 llvm::GlobalVariable *OffsetVar = TheModule.getGlobalVariable(OffsetName);
1843 if (OffsetVar)
1844 OffsetVar->setInitializer(OffsetValue);
1845 else
1846 OffsetVar = new llvm::GlobalVariable(TheModule, IntTy,
1847 false, llvm::GlobalValue::ExternalLinkage,
1848 OffsetValue, OffsetName);
Fangrui Song6907ce22018-07-30 19:24:48 +00001849 auto ivarVisibility =
David Chisnall404bbcb2018-05-22 10:13:06 +00001850 (IVD->getAccessControl() == ObjCIvarDecl::Private ||
1851 IVD->getAccessControl() == ObjCIvarDecl::Package ||
1852 classDecl->getVisibility() == HiddenVisibility) ?
1853 llvm::GlobalValue::HiddenVisibility :
1854 llvm::GlobalValue::DefaultVisibility;
1855 OffsetVar->setVisibility(ivarVisibility);
1856 ivarBuilder.add(OffsetVar);
1857 // Ivar size
1858 ivarBuilder.addInt(Int32Ty,
David Chisnallccc42862019-02-03 15:05:52 +00001859 CGM.getContext().getTypeSizeInChars(ivarTy).getQuantity());
David Chisnall404bbcb2018-05-22 10:13:06 +00001860 // Alignment will be stored as a base-2 log of the alignment.
Simon Pilgrimd06ee792019-10-02 11:49:32 +00001861 unsigned align =
1862 llvm::Log2_32(Context.getTypeAlignInChars(ivarTy).getQuantity());
David Chisnall404bbcb2018-05-22 10:13:06 +00001863 // Objects that require more than 2^64-byte alignment should be impossible!
1864 assert(align < 64);
1865 // uint32_t flags;
1866 // Bits 0-1 are ownership.
1867 // Bit 2 indicates an extended type encoding
1868 // Bits 3-8 contain log2(aligment)
Fangrui Song6907ce22018-07-30 19:24:48 +00001869 ivarBuilder.addInt(Int32Ty,
David Chisnall404bbcb2018-05-22 10:13:06 +00001870 (align << 3) | (1<<2) |
1871 FlagsForOwnership(ivarTy.getQualifiers().getObjCLifetime()));
1872 ivarBuilder.finishAndAddTo(ivarArrayBuilder);
1873 }
1874 ivarArrayBuilder.finishAndAddTo(ivarListBuilder);
1875 auto ivarList = ivarListBuilder.finishAndCreateGlobal(".objc_ivar_list",
Fangrui Song6907ce22018-07-30 19:24:48 +00001876 CGM.getPointerAlign(), /*constant*/ false,
David Chisnall404bbcb2018-05-22 10:13:06 +00001877 llvm::GlobalValue::PrivateLinkage);
1878 classFields.add(ivarList);
1879 }
1880 // struct objc_method_list *methods
1881 SmallVector<const ObjCMethodDecl*, 16> InstanceMethods;
1882 InstanceMethods.insert(InstanceMethods.begin(), OID->instmeth_begin(),
1883 OID->instmeth_end());
1884 for (auto *propImpl : OID->property_impls())
1885 if (propImpl->getPropertyImplementation() ==
1886 ObjCPropertyImplDecl::Synthesize) {
Adrian Prantl2073dd22019-11-04 14:28:14 -08001887 auto addIfExists = [&](const ObjCMethodDecl *OMD) {
1888 if (OMD && OMD->hasBody())
David Chisnall404bbcb2018-05-22 10:13:06 +00001889 InstanceMethods.push_back(OMD);
1890 };
Adrian Prantl2073dd22019-11-04 14:28:14 -08001891 addIfExists(propImpl->getGetterMethodDecl());
1892 addIfExists(propImpl->getSetterMethodDecl());
David Chisnall404bbcb2018-05-22 10:13:06 +00001893 }
1894
1895 if (InstanceMethods.size() == 0)
1896 classFields.addNullPointer(PtrTy);
1897 else
1898 classFields.addBitCast(
1899 GenerateMethodList(className, "", InstanceMethods, false),
1900 PtrTy);
1901 // void *dtable;
1902 classFields.addNullPointer(PtrTy);
1903 // IMP cxx_construct;
1904 classFields.addNullPointer(PtrTy);
1905 // IMP cxx_destruct;
1906 classFields.addNullPointer(PtrTy);
1907 // struct objc_class *subclass_list
1908 classFields.addNullPointer(PtrTy);
1909 // struct objc_class *sibling_class
1910 classFields.addNullPointer(PtrTy);
1911 // struct objc_protocol_list *protocols;
1912 SmallVector<llvm::Constant*, 16> Protocols;
1913 for (const auto *I : classDecl->protocols())
1914 Protocols.push_back(
1915 llvm::ConstantExpr::getBitCast(GenerateProtocolRef(I),
1916 ProtocolPtrTy));
1917 if (Protocols.empty())
1918 classFields.addNullPointer(PtrTy);
1919 else
1920 classFields.add(GenerateProtocolList(Protocols));
1921 // struct reference_list *extra_data;
1922 classFields.addNullPointer(PtrTy);
1923 // long abi_version;
1924 classFields.addInt(LongTy, 0);
1925 // struct objc_property_list *properties
1926 classFields.add(GeneratePropertyList(OID, classDecl));
1927
1928 auto *classStruct =
1929 classFields.finishAndCreateGlobal(SymbolForClass(className),
1930 CGM.getPointerAlign(), false, llvm::GlobalValue::ExternalLinkage);
1931
David Chisnall404bbcb2018-05-22 10:13:06 +00001932 auto *classRefSymbol = GetClassVar(className);
David Chisnall93ce0182018-08-10 12:53:13 +00001933 classRefSymbol->setSection(sectionName<ClassReferenceSection>());
David Chisnall404bbcb2018-05-22 10:13:06 +00001934 classRefSymbol->setInitializer(llvm::ConstantExpr::getBitCast(classStruct, IdTy));
1935
David Chisnall7b36a862019-03-31 11:22:33 +00001936 if (IsCOFF) {
1937 // we can't import a class struct.
1938 if (OID->getClassInterface()->hasAttr<DLLExportAttr>()) {
1939 cast<llvm::GlobalValue>(classStruct)->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1940 cast<llvm::GlobalValue>(classRefSymbol)->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1941 }
1942
1943 if (SuperClass) {
1944 std::pair<llvm::Constant*, int> v{classStruct, 1};
1945 EarlyInitList.emplace_back(SuperClass->getName(), std::move(v));
1946 }
1947
1948 }
1949
David Chisnall404bbcb2018-05-22 10:13:06 +00001950
1951 // Resolve the class aliases, if they exist.
1952 // FIXME: Class pointer aliases shouldn't exist!
1953 if (ClassPtrAlias) {
1954 ClassPtrAlias->replaceAllUsesWith(
1955 llvm::ConstantExpr::getBitCast(classStruct, IdTy));
1956 ClassPtrAlias->eraseFromParent();
1957 ClassPtrAlias = nullptr;
1958 }
1959 if (auto Placeholder =
1960 TheModule.getNamedGlobal(SymbolForClass(className)))
1961 if (Placeholder != classStruct) {
1962 Placeholder->replaceAllUsesWith(
1963 llvm::ConstantExpr::getBitCast(classStruct, Placeholder->getType()));
1964 Placeholder->eraseFromParent();
1965 classStruct->setName(SymbolForClass(className));
1966 }
1967 if (MetaClassPtrAlias) {
1968 MetaClassPtrAlias->replaceAllUsesWith(
1969 llvm::ConstantExpr::getBitCast(metaclass, IdTy));
1970 MetaClassPtrAlias->eraseFromParent();
1971 MetaClassPtrAlias = nullptr;
1972 }
1973 assert(classStruct->getName() == SymbolForClass(className));
1974
1975 auto classInitRef = new llvm::GlobalVariable(TheModule,
1976 classStruct->getType(), false, llvm::GlobalValue::ExternalLinkage,
David Chisnall7b36a862019-03-31 11:22:33 +00001977 classStruct, ManglePublicSymbol("OBJC_INIT_CLASS_") + className);
David Chisnall93ce0182018-08-10 12:53:13 +00001978 classInitRef->setSection(sectionName<ClassSection>());
David Chisnall404bbcb2018-05-22 10:13:06 +00001979 CGM.addUsedGlobal(classInitRef);
1980
1981 EmittedClass = true;
1982 }
1983 public:
1984 CGObjCGNUstep2(CodeGenModule &Mod) : CGObjCGNUstep(Mod, 10, 4, 2) {
1985 MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
1986 PtrToObjCSuperTy, SelectorTy);
1987 // struct objc_property
1988 // {
1989 // const char *name;
1990 // const char *attributes;
1991 // const char *type;
1992 // SEL getter;
1993 // SEL setter;
1994 // }
1995 PropertyMetadataTy =
1996 llvm::StructType::get(CGM.getLLVMContext(),
1997 { PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty });
1998 }
1999
2000};
2001
David Chisnall93ce0182018-08-10 12:53:13 +00002002const char *const CGObjCGNUstep2::SectionsBaseNames[8] =
2003{
2004"__objc_selectors",
2005"__objc_classes",
2006"__objc_class_refs",
2007"__objc_cats",
2008"__objc_protocols",
2009"__objc_protocol_refs",
2010"__objc_class_aliases",
2011"__objc_constant_string"
2012};
2013
David Chisnall7b36a862019-03-31 11:22:33 +00002014const char *const CGObjCGNUstep2::PECOFFSectionsBaseNames[8] =
2015{
2016".objcrt$SEL",
2017".objcrt$CLS",
2018".objcrt$CLR",
2019".objcrt$CAT",
2020".objcrt$PCL",
2021".objcrt$PCR",
2022".objcrt$CAL",
2023".objcrt$STR"
2024};
2025
Alp Toker272e9bc2013-11-25 00:40:53 +00002026/// Support for the ObjFW runtime.
John McCall3deb1ad2012-08-21 02:47:43 +00002027class CGObjCObjFW: public CGObjCGNU {
2028protected:
2029 /// The GCC ABI message lookup function. Returns an IMP pointing to the
2030 /// method implementation for this message.
2031 LazyRuntimeFunction MsgLookupFn;
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00002032 /// stret lookup function. While this does not seem to make sense at the
2033 /// first look, this is required to call the correct forwarding function.
2034 LazyRuntimeFunction MsgLookupFnSRet;
John McCall3deb1ad2012-08-21 02:47:43 +00002035 /// The GCC ABI superclass message lookup function. Takes a pointer to a
2036 /// structure describing the receiver and the class, and a selector as
2037 /// arguments. Returns the IMP for the corresponding method.
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00002038 LazyRuntimeFunction MsgLookupSuperFn, MsgLookupSuperFnSRet;
John McCall3deb1ad2012-08-21 02:47:43 +00002039
Craig Topper4f12f102014-03-12 06:41:41 +00002040 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
2041 llvm::Value *cmd, llvm::MDNode *node,
2042 MessageSendInfo &MSI) override {
John McCall3deb1ad2012-08-21 02:47:43 +00002043 CGBuilderTy &Builder = CGF.Builder;
2044 llvm::Value *args[] = {
2045 EnforceType(Builder, Receiver, IdTy),
2046 EnforceType(Builder, cmd, SelectorTy) };
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00002047
James Y Knight3933add2019-01-30 02:54:28 +00002048 llvm::CallBase *imp;
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00002049 if (CGM.ReturnTypeUsesSRet(MSI.CallInfo))
2050 imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFnSRet, args);
2051 else
2052 imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFn, args);
2053
John McCall3deb1ad2012-08-21 02:47:43 +00002054 imp->setMetadata(msgSendMDKind, node);
James Y Knight3933add2019-01-30 02:54:28 +00002055 return imp;
John McCall3deb1ad2012-08-21 02:47:43 +00002056 }
2057
John McCall7f416cc2015-09-08 08:05:57 +00002058 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
Craig Topper4f12f102014-03-12 06:41:41 +00002059 llvm::Value *cmd, MessageSendInfo &MSI) override {
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002060 CGBuilderTy &Builder = CGF.Builder;
2061 llvm::Value *lookupArgs[] = {
2062 EnforceType(Builder, ObjCSuper.getPointer(), PtrToObjCSuperTy), cmd,
2063 };
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00002064
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002065 if (CGM.ReturnTypeUsesSRet(MSI.CallInfo))
2066 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFnSRet, lookupArgs);
2067 else
2068 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
2069 }
John McCall3deb1ad2012-08-21 02:47:43 +00002070
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002071 llvm::Value *GetClassNamed(CodeGenFunction &CGF, const std::string &Name,
2072 bool isWeak) override {
John McCall775086e2012-07-12 02:07:58 +00002073 if (isWeak)
John McCall882987f2013-02-28 19:01:20 +00002074 return CGObjCGNU::GetClassNamed(CGF, Name, isWeak);
John McCall775086e2012-07-12 02:07:58 +00002075
2076 EmitClassRef(Name);
John McCall775086e2012-07-12 02:07:58 +00002077 std::string SymbolName = "_OBJC_CLASS_" + Name;
John McCall775086e2012-07-12 02:07:58 +00002078 llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(SymbolName);
John McCall775086e2012-07-12 02:07:58 +00002079 if (!ClassSymbol)
2080 ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false,
2081 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00002082 nullptr, SymbolName);
John McCall775086e2012-07-12 02:07:58 +00002083 return ClassSymbol;
2084 }
2085
2086public:
John McCall3deb1ad2012-08-21 02:47:43 +00002087 CGObjCObjFW(CodeGenModule &Mod): CGObjCGNU(Mod, 9, 3) {
2088 // IMP objc_msg_lookup(id, SEL);
Serge Guelton1d993272017-05-09 19:31:30 +00002089 MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy);
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00002090 MsgLookupFnSRet.init(&CGM, "objc_msg_lookup_stret", IMPTy, IdTy,
Serge Guelton1d993272017-05-09 19:31:30 +00002091 SelectorTy);
John McCall3deb1ad2012-08-21 02:47:43 +00002092 // IMP objc_msg_lookup_super(struct objc_super*, SEL);
2093 MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
Serge Guelton1d993272017-05-09 19:31:30 +00002094 PtrToObjCSuperTy, SelectorTy);
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00002095 MsgLookupSuperFnSRet.init(&CGM, "objc_msg_lookup_super_stret", IMPTy,
Serge Guelton1d993272017-05-09 19:31:30 +00002096 PtrToObjCSuperTy, SelectorTy);
John McCall3deb1ad2012-08-21 02:47:43 +00002097 }
John McCall775086e2012-07-12 02:07:58 +00002098};
Chris Lattnerb7256cd2008-03-01 08:50:34 +00002099} // end anonymous namespace
2100
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002101/// Emits a reference to a dummy variable which is emitted with each class.
2102/// This ensures that a linker error will be generated when trying to link
2103/// together modules where a referenced class is not defined.
Mike Stumpdd93a192009-07-31 21:31:32 +00002104void CGObjCGNU::EmitClassRef(const std::string &className) {
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002105 std::string symbolRef = "__objc_class_ref_" + className;
2106 // Don't emit two copies of the same symbol
Mike Stumpdd93a192009-07-31 21:31:32 +00002107 if (TheModule.getGlobalVariable(symbolRef))
2108 return;
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002109 std::string symbolName = "__objc_class_name_" + className;
2110 llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(symbolName);
2111 if (!ClassSymbol) {
Owen Andersonc10c8d32009-07-08 19:05:04 +00002112 ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00002113 llvm::GlobalValue::ExternalLinkage,
2114 nullptr, symbolName);
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002115 }
Owen Andersonc10c8d32009-07-08 19:05:04 +00002116 new llvm::GlobalVariable(TheModule, ClassSymbol->getType(), true,
Chris Lattnerc58e5692009-08-05 05:25:18 +00002117 llvm::GlobalValue::WeakAnyLinkage, ClassSymbol, symbolRef);
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00002118}
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002119
David Chisnalld7972f52011-03-23 16:36:54 +00002120CGObjCGNU::CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion,
David Chisnall404bbcb2018-05-22 10:13:06 +00002121 unsigned protocolClassVersion, unsigned classABI)
John McCalla729c622012-02-17 03:33:10 +00002122 : CGObjCRuntime(cgm), TheModule(CGM.getModule()),
Craig Topper8a13c412014-05-21 05:09:00 +00002123 VMContext(cgm.getLLVMContext()), ClassPtrAlias(nullptr),
2124 MetaClassPtrAlias(nullptr), RuntimeVersion(runtimeABIVersion),
David Chisnall404bbcb2018-05-22 10:13:06 +00002125 ProtocolVersion(protocolClassVersion), ClassABIVersion(classABI) {
David Chisnall01aa4672010-04-28 19:33:36 +00002126
2127 msgSendMDKind = VMContext.getMDKindID("GNUObjCMessageSend");
David Chisnall93ce0182018-08-10 12:53:13 +00002128 usesSEHExceptions =
2129 cgm.getContext().getTargetInfo().getTriple().isWindowsMSVCEnvironment();
David Chisnall01aa4672010-04-28 19:33:36 +00002130
David Chisnalld7972f52011-03-23 16:36:54 +00002131 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner8d3f4a42009-01-27 05:06:01 +00002132 IntTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +00002133 Types.ConvertType(CGM.getContext().IntTy));
Chris Lattner8d3f4a42009-01-27 05:06:01 +00002134 LongTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +00002135 Types.ConvertType(CGM.getContext().LongTy));
David Chisnall168b80f2010-12-26 22:13:16 +00002136 SizeTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +00002137 Types.ConvertType(CGM.getContext().getSizeType()));
David Chisnall168b80f2010-12-26 22:13:16 +00002138 PtrDiffTy = cast<llvm::IntegerType>(
David Chisnalld7972f52011-03-23 16:36:54 +00002139 Types.ConvertType(CGM.getContext().getPointerDiffType()));
David Chisnall168b80f2010-12-26 22:13:16 +00002140 BoolTy = CGM.getTypes().ConvertType(CGM.getContext().BoolTy);
Mike Stump11289f42009-09-09 15:08:12 +00002141
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002142 Int8Ty = llvm::Type::getInt8Ty(VMContext);
2143 // C string type. Used in lots of places.
2144 PtrToInt8Ty = llvm::PointerType::getUnqual(Int8Ty);
David Chisnall404bbcb2018-05-22 10:13:06 +00002145 ProtocolPtrTy = llvm::PointerType::getUnqual(
2146 Types.ConvertType(CGM.getContext().getObjCProtoType()));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002147
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002148 Zeros[0] = llvm::ConstantInt::get(LongTy, 0);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002149 Zeros[1] = Zeros[0];
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002150 NULLPtr = llvm::ConstantPointerNull::get(PtrToInt8Ty);
Chris Lattner4bd55962008-03-30 23:03:07 +00002151 // Get the selector Type.
David Chisnall481e3a82010-01-23 02:40:42 +00002152 QualType selTy = CGM.getContext().getObjCSelType();
2153 if (QualType() == selTy) {
2154 SelectorTy = PtrToInt8Ty;
2155 } else {
2156 SelectorTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(selTy));
2157 }
Chris Lattner8d3f4a42009-01-27 05:06:01 +00002158
Owen Anderson9793f0e2009-07-29 22:16:19 +00002159 PtrToIntTy = llvm::PointerType::getUnqual(IntTy);
Chris Lattner4bd55962008-03-30 23:03:07 +00002160 PtrTy = PtrToInt8Ty;
Mike Stump11289f42009-09-09 15:08:12 +00002161
David Chisnallcdd207e2011-10-04 15:35:30 +00002162 Int32Ty = llvm::Type::getInt32Ty(VMContext);
2163 Int64Ty = llvm::Type::getInt64Ty(VMContext);
2164
Rafael Espindola3cc5c2d2014-01-09 21:32:51 +00002165 IntPtrTy =
2166 CGM.getDataLayout().getPointerSizeInBits() == 32 ? Int32Ty : Int64Ty;
David Chisnalle0dc7cb2011-10-08 08:54:36 +00002167
Chris Lattner4bd55962008-03-30 23:03:07 +00002168 // Object type
David Chisnall10d2ded2011-04-29 14:10:35 +00002169 QualType UnqualIdTy = CGM.getContext().getObjCIdType();
2170 ASTIdTy = CanQualType();
2171 if (UnqualIdTy != QualType()) {
2172 ASTIdTy = CGM.getContext().getCanonicalType(UnqualIdTy);
David Chisnall481e3a82010-01-23 02:40:42 +00002173 IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy));
David Chisnall10d2ded2011-04-29 14:10:35 +00002174 } else {
2175 IdTy = PtrToInt8Ty;
David Chisnall481e3a82010-01-23 02:40:42 +00002176 }
David Chisnall5bb4efd2010-02-03 15:59:02 +00002177 PtrToIdTy = llvm::PointerType::getUnqual(IdTy);
David Chisnall404bbcb2018-05-22 10:13:06 +00002178 ProtocolTy = llvm::StructType::get(IdTy,
2179 PtrToInt8Ty, // name
2180 PtrToInt8Ty, // protocols
2181 PtrToInt8Ty, // instance methods
2182 PtrToInt8Ty, // class methods
2183 PtrToInt8Ty, // optional instance methods
2184 PtrToInt8Ty, // optional class methods
2185 PtrToInt8Ty, // properties
2186 PtrToInt8Ty);// optional properties
2187
2188 // struct objc_property_gsv1
2189 // {
2190 // const char *name;
2191 // char attributes;
2192 // char attributes2;
2193 // char unused1;
2194 // char unused2;
2195 // const char *getter_name;
2196 // const char *getter_types;
2197 // const char *setter_name;
2198 // const char *setter_types;
2199 // }
2200 PropertyMetadataTy = llvm::StructType::get(CGM.getLLVMContext(), {
2201 PtrToInt8Ty, Int8Ty, Int8Ty, Int8Ty, Int8Ty, PtrToInt8Ty, PtrToInt8Ty,
2202 PtrToInt8Ty, PtrToInt8Ty });
Mike Stump11289f42009-09-09 15:08:12 +00002203
Serge Guelton1d993272017-05-09 19:31:30 +00002204 ObjCSuperTy = llvm::StructType::get(IdTy, IdTy);
David Chisnall76803412011-03-23 22:52:06 +00002205 PtrToObjCSuperTy = llvm::PointerType::getUnqual(ObjCSuperTy);
2206
Chris Lattnera5f58b02011-07-09 17:41:47 +00002207 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
David Chisnalld7972f52011-03-23 16:36:54 +00002208
2209 // void objc_exception_throw(id);
Serge Guelton1d993272017-05-09 19:31:30 +00002210 ExceptionThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy);
2211 ExceptionReThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy);
David Chisnalld7972f52011-03-23 16:36:54 +00002212 // int objc_sync_enter(id);
Serge Guelton1d993272017-05-09 19:31:30 +00002213 SyncEnterFn.init(&CGM, "objc_sync_enter", IntTy, IdTy);
David Chisnalld7972f52011-03-23 16:36:54 +00002214 // int objc_sync_exit(id);
Serge Guelton1d993272017-05-09 19:31:30 +00002215 SyncExitFn.init(&CGM, "objc_sync_exit", IntTy, IdTy);
David Chisnalld7972f52011-03-23 16:36:54 +00002216
2217 // void objc_enumerationMutation (id)
Serge Guelton1d993272017-05-09 19:31:30 +00002218 EnumerationMutationFn.init(&CGM, "objc_enumerationMutation", VoidTy, IdTy);
David Chisnalld7972f52011-03-23 16:36:54 +00002219
2220 // id objc_getProperty(id, SEL, ptrdiff_t, BOOL)
2221 GetPropertyFn.init(&CGM, "objc_getProperty", IdTy, IdTy, SelectorTy,
Serge Guelton1d993272017-05-09 19:31:30 +00002222 PtrDiffTy, BoolTy);
David Chisnalld7972f52011-03-23 16:36:54 +00002223 // void objc_setProperty(id, SEL, ptrdiff_t, id, BOOL, BOOL)
2224 SetPropertyFn.init(&CGM, "objc_setProperty", VoidTy, IdTy, SelectorTy,
Serge Guelton1d993272017-05-09 19:31:30 +00002225 PtrDiffTy, IdTy, BoolTy, BoolTy);
David Chisnalld7972f52011-03-23 16:36:54 +00002226 // void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL)
Serge Guelton1d993272017-05-09 19:31:30 +00002227 GetStructPropertyFn.init(&CGM, "objc_getPropertyStruct", VoidTy, PtrTy, PtrTy,
2228 PtrDiffTy, BoolTy, BoolTy);
David Chisnalld7972f52011-03-23 16:36:54 +00002229 // void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL)
Serge Guelton1d993272017-05-09 19:31:30 +00002230 SetStructPropertyFn.init(&CGM, "objc_setPropertyStruct", VoidTy, PtrTy, PtrTy,
2231 PtrDiffTy, BoolTy, BoolTy);
David Chisnalld7972f52011-03-23 16:36:54 +00002232
Chris Lattner4bd55962008-03-30 23:03:07 +00002233 // IMP type
Chris Lattnera5f58b02011-07-09 17:41:47 +00002234 llvm::Type *IMPArgs[] = { IdTy, SelectorTy };
David Chisnall76803412011-03-23 22:52:06 +00002235 IMPTy = llvm::PointerType::getUnqual(llvm::FunctionType::get(IdTy, IMPArgs,
2236 true));
David Chisnall5bb4efd2010-02-03 15:59:02 +00002237
David Blaikiebbafb8a2012-03-11 07:00:24 +00002238 const LangOptions &Opts = CGM.getLangOpts();
Douglas Gregor79a91412011-09-13 17:21:33 +00002239 if ((Opts.getGC() != LangOptions::NonGC) || Opts.ObjCAutoRefCount)
David Chisnalla918b882011-07-07 11:22:31 +00002240 RuntimeVersion = 10;
2241
David Chisnalld3858d62011-03-25 11:57:33 +00002242 // Don't bother initialising the GC stuff unless we're compiling in GC mode
Douglas Gregor79a91412011-09-13 17:21:33 +00002243 if (Opts.getGC() != LangOptions::NonGC) {
David Chisnall5c511772011-05-22 22:37:08 +00002244 // This is a bit of an hack. We should sort this out by having a proper
2245 // CGObjCGNUstep subclass for GC, but we may want to really support the old
2246 // ABI and GC added in ObjectiveC2.framework, so we fudge it a bit for now
David Chisnall5bb4efd2010-02-03 15:59:02 +00002247 // Get selectors needed in GC mode
2248 RetainSel = GetNullarySelector("retain", CGM.getContext());
2249 ReleaseSel = GetNullarySelector("release", CGM.getContext());
2250 AutoreleaseSel = GetNullarySelector("autorelease", CGM.getContext());
2251
2252 // Get functions needed in GC mode
2253
2254 // id objc_assign_ivar(id, id, ptrdiff_t);
Serge Guelton1d993272017-05-09 19:31:30 +00002255 IvarAssignFn.init(&CGM, "objc_assign_ivar", IdTy, IdTy, IdTy, PtrDiffTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00002256 // id objc_assign_strongCast (id, id*)
David Chisnalld7972f52011-03-23 16:36:54 +00002257 StrongCastAssignFn.init(&CGM, "objc_assign_strongCast", IdTy, IdTy,
Serge Guelton1d993272017-05-09 19:31:30 +00002258 PtrToIdTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00002259 // id objc_assign_global(id, id*);
Serge Guelton1d993272017-05-09 19:31:30 +00002260 GlobalAssignFn.init(&CGM, "objc_assign_global", IdTy, IdTy, PtrToIdTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00002261 // id objc_assign_weak(id, id*);
Serge Guelton1d993272017-05-09 19:31:30 +00002262 WeakAssignFn.init(&CGM, "objc_assign_weak", IdTy, IdTy, PtrToIdTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00002263 // id objc_read_weak(id*);
Serge Guelton1d993272017-05-09 19:31:30 +00002264 WeakReadFn.init(&CGM, "objc_read_weak", IdTy, PtrToIdTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00002265 // void *objc_memmove_collectable(void*, void *, size_t);
David Chisnalld7972f52011-03-23 16:36:54 +00002266 MemMoveFn.init(&CGM, "objc_memmove_collectable", PtrTy, PtrTy, PtrTy,
Serge Guelton1d993272017-05-09 19:31:30 +00002267 SizeTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00002268 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002269}
Mike Stumpdd93a192009-07-31 21:31:32 +00002270
John McCall882987f2013-02-28 19:01:20 +00002271llvm::Value *CGObjCGNU::GetClassNamed(CodeGenFunction &CGF,
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00002272 const std::string &Name, bool isWeak) {
John McCall7f416cc2015-09-08 08:05:57 +00002273 llvm::Constant *ClassName = MakeConstantString(Name);
David Chisnalldf349172010-01-08 00:14:31 +00002274 // With the incompatible ABI, this will need to be replaced with a direct
2275 // reference to the class symbol. For the compatible nonfragile ABI we are
2276 // still performing this lookup at run time but emitting the symbol for the
2277 // class externally so that we can make the switch later.
David Chisnall920e83b2011-06-29 13:16:41 +00002278 //
2279 // Libobjc2 contains an LLVM pass that replaces calls to objc_lookup_class
2280 // with memoized versions or with static references if it's safe to do so.
David Chisnall08d67332011-06-30 10:14:37 +00002281 if (!isWeak)
2282 EmitClassRef(Name);
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +00002283
James Y Knight9871db02019-02-05 16:42:33 +00002284 llvm::FunctionCallee ClassLookupFn = CGM.CreateRuntimeFunction(
2285 llvm::FunctionType::get(IdTy, PtrToInt8Ty, true), "objc_lookup_class");
John McCall882987f2013-02-28 19:01:20 +00002286 return CGF.EmitNounwindRuntimeCall(ClassLookupFn, ClassName);
Chris Lattner4bd55962008-03-30 23:03:07 +00002287}
2288
David Chisnall920e83b2011-06-29 13:16:41 +00002289// This has to perform the lookup every time, since posing and related
2290// techniques can modify the name -> class mapping.
John McCall882987f2013-02-28 19:01:20 +00002291llvm::Value *CGObjCGNU::GetClass(CodeGenFunction &CGF,
David Chisnall920e83b2011-06-29 13:16:41 +00002292 const ObjCInterfaceDecl *OID) {
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00002293 auto *Value =
2294 GetClassNamed(CGF, OID->getNameAsString(), OID->isWeakImported());
Rafael Espindolab7350042018-03-01 00:35:47 +00002295 if (auto *ClassSymbol = dyn_cast<llvm::GlobalVariable>(Value))
2296 CGM.setGVProperties(ClassSymbol, OID);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00002297 return Value;
David Chisnall920e83b2011-06-29 13:16:41 +00002298}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002299
John McCall882987f2013-02-28 19:01:20 +00002300llvm::Value *CGObjCGNU::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00002301 auto *Value = GetClassNamed(CGF, "NSAutoreleasePool", false);
2302 if (CGM.getTriple().isOSBinFormatCOFF()) {
2303 if (auto *ClassSymbol = dyn_cast<llvm::GlobalVariable>(Value)) {
2304 IdentifierInfo &II = CGF.CGM.getContext().Idents.get("NSAutoreleasePool");
2305 TranslationUnitDecl *TUDecl = CGM.getContext().getTranslationUnitDecl();
2306 DeclContext *DC = TranslationUnitDecl::castToDeclContext(TUDecl);
2307
2308 const VarDecl *VD = nullptr;
2309 for (const auto &Result : DC->lookup(&II))
2310 if ((VD = dyn_cast<VarDecl>(Result)))
2311 break;
2312
Rafael Espindolab7350042018-03-01 00:35:47 +00002313 CGM.setGVProperties(ClassSymbol, VD);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00002314 }
2315 }
2316 return Value;
David Chisnall920e83b2011-06-29 13:16:41 +00002317}
2318
Simon Pilgrim04c5a342018-08-08 15:53:14 +00002319llvm::Value *CGObjCGNU::GetTypedSelector(CodeGenFunction &CGF, Selector Sel,
2320 const std::string &TypeEncoding) {
Craig Topperfa159c12013-07-14 16:47:36 +00002321 SmallVectorImpl<TypedSelector> &Types = SelectorTable[Sel];
Craig Topper8a13c412014-05-21 05:09:00 +00002322 llvm::GlobalAlias *SelValue = nullptr;
David Chisnalld7972f52011-03-23 16:36:54 +00002323
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002324 for (SmallVectorImpl<TypedSelector>::iterator i = Types.begin(),
David Chisnalld7972f52011-03-23 16:36:54 +00002325 e = Types.end() ; i!=e ; i++) {
2326 if (i->first == TypeEncoding) {
2327 SelValue = i->second;
2328 break;
2329 }
2330 }
Craig Topper8a13c412014-05-21 05:09:00 +00002331 if (!SelValue) {
Rafael Espindola234405b2014-05-17 21:30:14 +00002332 SelValue = llvm::GlobalAlias::create(
David Blaikieaff29d32015-09-14 18:02:04 +00002333 SelectorTy->getElementType(), 0, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola61722772014-05-17 19:58:16 +00002334 ".objc_selector_" + Sel.getAsString(), &TheModule);
Benjamin Kramer3204b152015-05-29 19:42:19 +00002335 Types.emplace_back(TypeEncoding, SelValue);
David Chisnalld7972f52011-03-23 16:36:54 +00002336 }
2337
David Chisnall76803412011-03-23 22:52:06 +00002338 return SelValue;
David Chisnalld7972f52011-03-23 16:36:54 +00002339}
2340
John McCall7f416cc2015-09-08 08:05:57 +00002341Address CGObjCGNU::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
2342 llvm::Value *SelValue = GetSelector(CGF, Sel);
2343
2344 // Store it to a temporary. Does this satisfy the semantics of
2345 // GetAddrOfSelector? Hopefully.
2346 Address tmp = CGF.CreateTempAlloca(SelValue->getType(),
2347 CGF.getPointerAlign());
2348 CGF.Builder.CreateStore(SelValue, tmp);
2349 return tmp;
2350}
2351
2352llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF, Selector Sel) {
Simon Pilgrim04c5a342018-08-08 15:53:14 +00002353 return GetTypedSelector(CGF, Sel, std::string());
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00002354}
2355
John McCall882987f2013-02-28 19:01:20 +00002356llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF,
2357 const ObjCMethodDecl *Method) {
John McCall843dfcc2016-11-29 21:57:00 +00002358 std::string SelTypes = CGM.getContext().getObjCEncodingForMethodDecl(Method);
Simon Pilgrim04c5a342018-08-08 15:53:14 +00002359 return GetTypedSelector(CGF, Method->getSelector(), SelTypes);
Chris Lattner6d522c02008-06-26 04:37:12 +00002360}
2361
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00002362llvm::Constant *CGObjCGNU::GetEHType(QualType T) {
John McCallc31d8932012-11-14 09:08:34 +00002363 if (T->isObjCIdType() || T->isObjCQualifiedIdType()) {
2364 // With the old ABI, there was only one kind of catchall, which broke
2365 // foreign exceptions. With the new ABI, we use __objc_id_typeinfo as
2366 // a pointer indicating object catchalls, and NULL to indicate real
2367 // catchalls
2368 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2369 return MakeConstantString("@id");
2370 } else {
Craig Topper8a13c412014-05-21 05:09:00 +00002371 return nullptr;
John McCallc31d8932012-11-14 09:08:34 +00002372 }
David Chisnalld3858d62011-03-25 11:57:33 +00002373 }
John McCallc31d8932012-11-14 09:08:34 +00002374
2375 // All other types should be Objective-C interface pointer types.
2376 const ObjCObjectPointerType *OPT = T->getAs<ObjCObjectPointerType>();
2377 assert(OPT && "Invalid @catch type.");
2378 const ObjCInterfaceDecl *IDecl = OPT->getObjectType()->getInterface();
2379 assert(IDecl && "Invalid @catch type.");
2380 return MakeConstantString(IDecl->getIdentifier()->getName());
2381}
2382
2383llvm::Constant *CGObjCGNUstep::GetEHType(QualType T) {
David Chisnall93ce0182018-08-10 12:53:13 +00002384 if (usesSEHExceptions)
2385 return CGM.getCXXABI().getAddrOfRTTIDescriptor(T);
2386
John McCallc31d8932012-11-14 09:08:34 +00002387 if (!CGM.getLangOpts().CPlusPlus)
2388 return CGObjCGNU::GetEHType(T);
2389
David Chisnalle1d2584d2011-03-20 21:35:39 +00002390 // For Objective-C++, we want to provide the ability to catch both C++ and
2391 // Objective-C objects in the same function.
2392
2393 // There's a particular fixed type info for 'id'.
2394 if (T->isObjCIdType() ||
2395 T->isObjCQualifiedIdType()) {
2396 llvm::Constant *IDEHType =
2397 CGM.getModule().getGlobalVariable("__objc_id_type_info");
2398 if (!IDEHType)
2399 IDEHType =
2400 new llvm::GlobalVariable(CGM.getModule(), PtrToInt8Ty,
2401 false,
2402 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00002403 nullptr, "__objc_id_type_info");
David Chisnalle1d2584d2011-03-20 21:35:39 +00002404 return llvm::ConstantExpr::getBitCast(IDEHType, PtrToInt8Ty);
2405 }
2406
2407 const ObjCObjectPointerType *PT =
2408 T->getAs<ObjCObjectPointerType>();
2409 assert(PT && "Invalid @catch type.");
2410 const ObjCInterfaceType *IT = PT->getInterfaceType();
2411 assert(IT && "Invalid @catch type.");
2412 std::string className = IT->getDecl()->getIdentifier()->getName();
2413
2414 std::string typeinfoName = "__objc_eh_typeinfo_" + className;
2415
2416 // Return the existing typeinfo if it exists
2417 llvm::Constant *typeinfo = TheModule.getGlobalVariable(typeinfoName);
David Chisnalld6639342012-03-20 16:25:52 +00002418 if (typeinfo)
2419 return llvm::ConstantExpr::getBitCast(typeinfo, PtrToInt8Ty);
David Chisnalle1d2584d2011-03-20 21:35:39 +00002420
2421 // Otherwise create it.
2422
2423 // vtable for gnustep::libobjc::__objc_class_type_info
2424 // It's quite ugly hard-coding this. Ideally we'd generate it using the host
2425 // platform's name mangling.
2426 const char *vtableName = "_ZTVN7gnustep7libobjc22__objc_class_type_infoE";
David Blaikiee3b172a2015-04-02 18:55:21 +00002427 auto *Vtable = TheModule.getGlobalVariable(vtableName);
David Chisnalle1d2584d2011-03-20 21:35:39 +00002428 if (!Vtable) {
2429 Vtable = new llvm::GlobalVariable(TheModule, PtrToInt8Ty, true,
Craig Topper8a13c412014-05-21 05:09:00 +00002430 llvm::GlobalValue::ExternalLinkage,
2431 nullptr, vtableName);
David Chisnalle1d2584d2011-03-20 21:35:39 +00002432 }
2433 llvm::Constant *Two = llvm::ConstantInt::get(IntTy, 2);
David Blaikiee3b172a2015-04-02 18:55:21 +00002434 auto *BVtable = llvm::ConstantExpr::getBitCast(
2435 llvm::ConstantExpr::getGetElementPtr(Vtable->getValueType(), Vtable, Two),
2436 PtrToInt8Ty);
David Chisnalle1d2584d2011-03-20 21:35:39 +00002437
2438 llvm::Constant *typeName =
2439 ExportUniqueString(className, "__objc_eh_typename_");
2440
John McCall23c9dc62016-11-28 22:18:27 +00002441 ConstantInitBuilder builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002442 auto fields = builder.beginStruct();
2443 fields.add(BVtable);
2444 fields.add(typeName);
2445 llvm::Constant *TI =
2446 fields.finishAndCreateGlobal("__objc_eh_typeinfo_" + className,
2447 CGM.getPointerAlign(),
2448 /*constant*/ false,
2449 llvm::GlobalValue::LinkOnceODRLinkage);
David Chisnalle1d2584d2011-03-20 21:35:39 +00002450 return llvm::ConstantExpr::getBitCast(TI, PtrToInt8Ty);
John McCall2ca705e2010-07-24 00:37:23 +00002451}
2452
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002453/// Generate an NSConstantString object.
John McCall7f416cc2015-09-08 08:05:57 +00002454ConstantAddress CGObjCGNU::GenerateConstantString(const StringLiteral *SL) {
David Chisnall358e7512010-01-27 12:49:23 +00002455
Benjamin Kramer35b077e2010-08-17 12:54:38 +00002456 std::string Str = SL->getString().str();
John McCall7f416cc2015-09-08 08:05:57 +00002457 CharUnits Align = CGM.getPointerAlign();
David Chisnall481e3a82010-01-23 02:40:42 +00002458
David Chisnall358e7512010-01-27 12:49:23 +00002459 // Look for an existing one
2460 llvm::StringMap<llvm::Constant*>::iterator old = ObjCStrings.find(Str);
2461 if (old != ObjCStrings.end())
John McCall7f416cc2015-09-08 08:05:57 +00002462 return ConstantAddress(old->getValue(), Align);
David Chisnall358e7512010-01-27 12:49:23 +00002463
David Blaikiebbafb8a2012-03-11 07:00:24 +00002464 StringRef StringClass = CGM.getLangOpts().ObjCConstantStringClass;
David Chisnall207a6302012-01-04 12:02:13 +00002465
David Chisnall404bbcb2018-05-22 10:13:06 +00002466 if (StringClass.empty()) StringClass = "NSConstantString";
David Chisnall207a6302012-01-04 12:02:13 +00002467
2468 std::string Sym = "_OBJC_CLASS_";
2469 Sym += StringClass;
2470
2471 llvm::Constant *isa = TheModule.getNamedGlobal(Sym);
2472
2473 if (!isa)
2474 isa = new llvm::GlobalVariable(TheModule, IdTy, /* isConstant */false,
Craig Topper8a13c412014-05-21 05:09:00 +00002475 llvm::GlobalValue::ExternalWeakLinkage, nullptr, Sym);
David Chisnall207a6302012-01-04 12:02:13 +00002476 else if (isa->getType() != PtrToIdTy)
2477 isa = llvm::ConstantExpr::getBitCast(isa, PtrToIdTy);
2478
John McCall23c9dc62016-11-28 22:18:27 +00002479 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002480 auto Fields = Builder.beginStruct();
2481 Fields.add(isa);
2482 Fields.add(MakeConstantString(Str));
2483 Fields.addInt(IntTy, Str.size());
2484 llvm::Constant *ObjCStr =
2485 Fields.finishAndCreateGlobal(".objc_str", Align);
David Chisnall358e7512010-01-27 12:49:23 +00002486 ObjCStr = llvm::ConstantExpr::getBitCast(ObjCStr, PtrToInt8Ty);
2487 ObjCStrings[Str] = ObjCStr;
2488 ConstantStrings.push_back(ObjCStr);
John McCall7f416cc2015-09-08 08:05:57 +00002489 return ConstantAddress(ObjCStr, Align);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002490}
2491
2492///Generates a message send where the super is the receiver. This is a message
2493///send to self with special delivery semantics indicating which class's method
2494///should be called.
David Chisnalld7972f52011-03-23 16:36:54 +00002495RValue
2496CGObjCGNU::GenerateMessageSendSuper(CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00002497 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002498 QualType ResultType,
2499 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00002500 const ObjCInterfaceDecl *Class,
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00002501 bool isCategoryImpl,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00002502 llvm::Value *Receiver,
Daniel Dunbarc722b852008-08-30 03:02:31 +00002503 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00002504 const CallArgList &CallArgs,
2505 const ObjCMethodDecl *Method) {
David Chisnall8a42d192011-05-28 14:09:01 +00002506 CGBuilderTy &Builder = CGF.Builder;
David Blaikiebbafb8a2012-03-11 07:00:24 +00002507 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
David Chisnall5bb4efd2010-02-03 15:59:02 +00002508 if (Sel == RetainSel || Sel == AutoreleaseSel) {
David Chisnall8a42d192011-05-28 14:09:01 +00002509 return RValue::get(EnforceType(Builder, Receiver,
2510 CGM.getTypes().ConvertType(ResultType)));
David Chisnall5bb4efd2010-02-03 15:59:02 +00002511 }
2512 if (Sel == ReleaseSel) {
Craig Topper8a13c412014-05-21 05:09:00 +00002513 return RValue::get(nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +00002514 }
2515 }
David Chisnallea529a42010-05-01 12:37:16 +00002516
John McCall882987f2013-02-28 19:01:20 +00002517 llvm::Value *cmd = GetSelector(CGF, Sel);
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00002518 CallArgList ActualArgs;
2519
Eli Friedman43dca6a2011-05-02 17:57:46 +00002520 ActualArgs.add(RValue::get(EnforceType(Builder, Receiver, IdTy)), ASTIdTy);
2521 ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00002522 ActualArgs.addFrom(CallArgs);
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00002523
John McCalla729c622012-02-17 03:33:10 +00002524 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00002525
Craig Topper8a13c412014-05-21 05:09:00 +00002526 llvm::Value *ReceiverClass = nullptr;
David Chisnall404bbcb2018-05-22 10:13:06 +00002527 bool isV2ABI = isRuntime(ObjCRuntime::GNUstep, 2);
2528 if (isV2ABI) {
2529 ReceiverClass = GetClassNamed(CGF,
2530 Class->getSuperClass()->getNameAsString(), /*isWeak*/false);
Chris Lattnera02cb802009-05-08 15:39:58 +00002531 if (IsClassMessage) {
David Chisnall404bbcb2018-05-22 10:13:06 +00002532 // Load the isa pointer of the superclass is this is a class method.
2533 ReceiverClass = Builder.CreateBitCast(ReceiverClass,
2534 llvm::PointerType::getUnqual(IdTy));
2535 ReceiverClass =
2536 Builder.CreateAlignedLoad(ReceiverClass, CGF.getPointerAlign());
Daniel Dunbar566421c2009-05-04 15:31:17 +00002537 }
David Chisnall404bbcb2018-05-22 10:13:06 +00002538 ReceiverClass = EnforceType(Builder, ReceiverClass, IdTy);
Bjorn Pettersson84466332018-05-22 08:16:45 +00002539 } else {
David Chisnall404bbcb2018-05-22 10:13:06 +00002540 if (isCategoryImpl) {
James Y Knight9871db02019-02-05 16:42:33 +00002541 llvm::FunctionCallee classLookupFunction = nullptr;
David Chisnall404bbcb2018-05-22 10:13:06 +00002542 if (IsClassMessage) {
2543 classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get(
2544 IdTy, PtrTy, true), "objc_get_meta_class");
2545 } else {
2546 classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get(
2547 IdTy, PtrTy, true), "objc_get_class");
Bjorn Pettersson84466332018-05-22 08:16:45 +00002548 }
David Chisnall404bbcb2018-05-22 10:13:06 +00002549 ReceiverClass = Builder.CreateCall(classLookupFunction,
2550 MakeConstantString(Class->getNameAsString()));
Bjorn Pettersson84466332018-05-22 08:16:45 +00002551 } else {
David Chisnall404bbcb2018-05-22 10:13:06 +00002552 // Set up global aliases for the metaclass or class pointer if they do not
2553 // already exist. These will are forward-references which will be set to
2554 // pointers to the class and metaclass structure created for the runtime
2555 // load function. To send a message to super, we look up the value of the
2556 // super_class pointer from either the class or metaclass structure.
2557 if (IsClassMessage) {
2558 if (!MetaClassPtrAlias) {
2559 MetaClassPtrAlias = llvm::GlobalAlias::create(
2560 IdTy->getElementType(), 0, llvm::GlobalValue::InternalLinkage,
2561 ".objc_metaclass_ref" + Class->getNameAsString(), &TheModule);
2562 }
2563 ReceiverClass = MetaClassPtrAlias;
2564 } else {
2565 if (!ClassPtrAlias) {
2566 ClassPtrAlias = llvm::GlobalAlias::create(
2567 IdTy->getElementType(), 0, llvm::GlobalValue::InternalLinkage,
2568 ".objc_class_ref" + Class->getNameAsString(), &TheModule);
2569 }
2570 ReceiverClass = ClassPtrAlias;
Bjorn Pettersson84466332018-05-22 08:16:45 +00002571 }
Bjorn Pettersson84466332018-05-22 08:16:45 +00002572 }
David Chisnall404bbcb2018-05-22 10:13:06 +00002573 // Cast the pointer to a simplified version of the class structure
2574 llvm::Type *CastTy = llvm::StructType::get(IdTy, IdTy);
2575 ReceiverClass = Builder.CreateBitCast(ReceiverClass,
2576 llvm::PointerType::getUnqual(CastTy));
2577 // Get the superclass pointer
2578 ReceiverClass = Builder.CreateStructGEP(CastTy, ReceiverClass, 1);
2579 // Load the superclass pointer
2580 ReceiverClass =
2581 Builder.CreateAlignedLoad(ReceiverClass, CGF.getPointerAlign());
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00002582 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002583 // Construct the structure used to look up the IMP
Serge Guelton1d993272017-05-09 19:31:30 +00002584 llvm::StructType *ObjCSuperTy =
2585 llvm::StructType::get(Receiver->getType(), IdTy);
John McCall7f416cc2015-09-08 08:05:57 +00002586
David Chisnall404bbcb2018-05-22 10:13:06 +00002587 Address ObjCSuper = CGF.CreateTempAlloca(ObjCSuperTy,
John McCall7f416cc2015-09-08 08:05:57 +00002588 CGF.getPointerAlign());
Fariborz Jahanianb73a23e2009-02-04 20:31:19 +00002589
James Y Knight751fe282019-02-09 22:22:28 +00002590 Builder.CreateStore(Receiver, Builder.CreateStructGEP(ObjCSuper, 0));
2591 Builder.CreateStore(ReceiverClass, Builder.CreateStructGEP(ObjCSuper, 1));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002592
David Chisnall76803412011-03-23 22:52:06 +00002593 ObjCSuper = EnforceType(Builder, ObjCSuper, PtrToObjCSuperTy);
David Chisnall76803412011-03-23 22:52:06 +00002594
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002595 // Get the IMP
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00002596 llvm::Value *imp = LookupIMPSuper(CGF, ObjCSuper, cmd, MSI);
John McCalla729c622012-02-17 03:33:10 +00002597 imp = EnforceType(Builder, imp, MSI.MessengerType);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002598
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002599 llvm::Metadata *impMD[] = {
David Chisnall9eecafa2010-05-01 11:15:56 +00002600 llvm::MDString::get(VMContext, Sel.getAsString()),
2601 llvm::MDString::get(VMContext, Class->getSuperClass()->getNameAsString()),
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002602 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
2603 llvm::Type::getInt1Ty(VMContext), IsClassMessage))};
Jay Foadea324f12011-04-21 19:59:12 +00002604 llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD);
David Chisnall9eecafa2010-05-01 11:15:56 +00002605
John McCallb92ab1a2016-10-26 23:46:34 +00002606 CGCallee callee(CGCalleeInfo(), imp);
2607
James Y Knight3933add2019-01-30 02:54:28 +00002608 llvm::CallBase *call;
John McCallb92ab1a2016-10-26 23:46:34 +00002609 RValue msgRet = CGF.EmitCall(MSI.CallInfo, callee, Return, ActualArgs, &call);
David Chisnallff5f88c2010-05-02 13:41:58 +00002610 call->setMetadata(msgSendMDKind, node);
2611 return msgRet;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002612}
2613
Mike Stump11289f42009-09-09 15:08:12 +00002614/// Generate code for a message send expression.
David Chisnalld7972f52011-03-23 16:36:54 +00002615RValue
2616CGObjCGNU::GenerateMessageSend(CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00002617 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002618 QualType ResultType,
2619 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00002620 llvm::Value *Receiver,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00002621 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00002622 const ObjCInterfaceDecl *Class,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00002623 const ObjCMethodDecl *Method) {
David Chisnall8a42d192011-05-28 14:09:01 +00002624 CGBuilderTy &Builder = CGF.Builder;
2625
David Chisnall75afda62010-04-27 15:08:48 +00002626 // Strip out message sends to retain / release in GC mode
David Blaikiebbafb8a2012-03-11 07:00:24 +00002627 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
David Chisnall5bb4efd2010-02-03 15:59:02 +00002628 if (Sel == RetainSel || Sel == AutoreleaseSel) {
David Chisnall8a42d192011-05-28 14:09:01 +00002629 return RValue::get(EnforceType(Builder, Receiver,
2630 CGM.getTypes().ConvertType(ResultType)));
David Chisnall5bb4efd2010-02-03 15:59:02 +00002631 }
2632 if (Sel == ReleaseSel) {
Craig Topper8a13c412014-05-21 05:09:00 +00002633 return RValue::get(nullptr);
David Chisnall5bb4efd2010-02-03 15:59:02 +00002634 }
2635 }
David Chisnall75afda62010-04-27 15:08:48 +00002636
David Chisnall75afda62010-04-27 15:08:48 +00002637 // If the return type is something that goes in an integer register, the
2638 // runtime will handle 0 returns. For other cases, we fill in the 0 value
2639 // ourselves.
2640 //
2641 // The language spec says the result of this kind of message send is
2642 // undefined, but lots of people seem to have forgotten to read that
2643 // paragraph and insist on sending messages to nil that have structure
2644 // returns. With GCC, this generates a random return value (whatever happens
2645 // to be on the stack / in those registers at the time) on most platforms,
David Chisnall76803412011-03-23 22:52:06 +00002646 // and generates an illegal instruction trap on SPARC. With LLVM it corrupts
Fangrui Song6907ce22018-07-30 19:24:48 +00002647 // the stack.
David Chisnall76803412011-03-23 22:52:06 +00002648 bool isPointerSizedReturn = (ResultType->isAnyPointerType() ||
2649 ResultType->isIntegralOrEnumerationType() || ResultType->isVoidType());
David Chisnall75afda62010-04-27 15:08:48 +00002650
Craig Topper8a13c412014-05-21 05:09:00 +00002651 llvm::BasicBlock *startBB = nullptr;
2652 llvm::BasicBlock *messageBB = nullptr;
2653 llvm::BasicBlock *continueBB = nullptr;
David Chisnall75afda62010-04-27 15:08:48 +00002654
2655 if (!isPointerSizedReturn) {
2656 startBB = Builder.GetInsertBlock();
2657 messageBB = CGF.createBasicBlock("msgSend");
David Chisnall29cefd12010-05-20 13:45:48 +00002658 continueBB = CGF.createBasicBlock("continue");
David Chisnall75afda62010-04-27 15:08:48 +00002659
Fangrui Song6907ce22018-07-30 19:24:48 +00002660 llvm::Value *isNil = Builder.CreateICmpEQ(Receiver,
David Chisnall75afda62010-04-27 15:08:48 +00002661 llvm::Constant::getNullValue(Receiver->getType()));
David Chisnall29cefd12010-05-20 13:45:48 +00002662 Builder.CreateCondBr(isNil, continueBB, messageBB);
David Chisnall75afda62010-04-27 15:08:48 +00002663 CGF.EmitBlock(messageBB);
2664 }
2665
David Chisnall9f57c292009-08-17 16:35:33 +00002666 IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy));
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00002667 llvm::Value *cmd;
2668 if (Method)
John McCall882987f2013-02-28 19:01:20 +00002669 cmd = GetSelector(CGF, Method);
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00002670 else
John McCall882987f2013-02-28 19:01:20 +00002671 cmd = GetSelector(CGF, Sel);
David Chisnall76803412011-03-23 22:52:06 +00002672 cmd = EnforceType(Builder, cmd, SelectorTy);
2673 Receiver = EnforceType(Builder, Receiver, IdTy);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002674
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00002675 llvm::Metadata *impMD[] = {
2676 llvm::MDString::get(VMContext, Sel.getAsString()),
2677 llvm::MDString::get(VMContext, Class ? Class->getNameAsString() : ""),
2678 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
2679 llvm::Type::getInt1Ty(VMContext), Class != nullptr))};
Jay Foadea324f12011-04-21 19:59:12 +00002680 llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD);
David Chisnall76803412011-03-23 22:52:06 +00002681
David Chisnall76803412011-03-23 22:52:06 +00002682 CallArgList ActualArgs;
Eli Friedman43dca6a2011-05-02 17:57:46 +00002683 ActualArgs.add(RValue::get(Receiver), ASTIdTy);
2684 ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00002685 ActualArgs.addFrom(CallArgs);
John McCalla729c622012-02-17 03:33:10 +00002686
2687 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
2688
David Chisnall8c93cf22011-10-24 14:07:03 +00002689 // Get the IMP to call
2690 llvm::Value *imp;
2691
2692 // If we have non-legacy dispatch specified, we try using the objc_msgSend()
2693 // functions. These are not supported on all platforms (or all runtimes on a
Fangrui Song6907ce22018-07-30 19:24:48 +00002694 // given platform), so we
David Chisnall8c93cf22011-10-24 14:07:03 +00002695 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
David Chisnall8c93cf22011-10-24 14:07:03 +00002696 case CodeGenOptions::Legacy:
Eli Friedmanf24bd3b2013-07-26 00:53:29 +00002697 imp = LookupIMP(CGF, Receiver, cmd, node, MSI);
David Chisnall8c93cf22011-10-24 14:07:03 +00002698 break;
2699 case CodeGenOptions::Mixed:
David Chisnall8c93cf22011-10-24 14:07:03 +00002700 case CodeGenOptions::NonLegacy:
David Chisnall0cc83e72011-10-28 17:55:06 +00002701 if (CGM.ReturnTypeUsesFPRet(ResultType)) {
James Y Knight9871db02019-02-05 16:42:33 +00002702 imp =
2703 CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
2704 "objc_msgSend_fpret")
2705 .getCallee();
John McCalla729c622012-02-17 03:33:10 +00002706 } else if (CGM.ReturnTypeUsesSRet(MSI.CallInfo)) {
David Chisnall8c93cf22011-10-24 14:07:03 +00002707 // The actual types here don't matter - we're going to bitcast the
2708 // function anyway
James Y Knight9871db02019-02-05 16:42:33 +00002709 imp =
2710 CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
2711 "objc_msgSend_stret")
2712 .getCallee();
David Chisnall8c93cf22011-10-24 14:07:03 +00002713 } else {
James Y Knight9871db02019-02-05 16:42:33 +00002714 imp = CGM.CreateRuntimeFunction(
2715 llvm::FunctionType::get(IdTy, IdTy, true), "objc_msgSend")
2716 .getCallee();
David Chisnall8c93cf22011-10-24 14:07:03 +00002717 }
2718 }
2719
David Chisnall6aec31a2011-12-01 18:40:09 +00002720 // Reset the receiver in case the lookup modified it
Yaxun Liu5b330e82018-03-15 15:25:19 +00002721 ActualArgs[0] = CallArg(RValue::get(Receiver), ASTIdTy);
David Chisnall8c93cf22011-10-24 14:07:03 +00002722
John McCalla729c622012-02-17 03:33:10 +00002723 imp = EnforceType(Builder, imp, MSI.MessengerType);
David Chisnallc0cf4222010-05-01 12:56:56 +00002724
James Y Knight3933add2019-01-30 02:54:28 +00002725 llvm::CallBase *call;
John McCallb92ab1a2016-10-26 23:46:34 +00002726 CGCallee callee(CGCalleeInfo(), imp);
2727 RValue msgRet = CGF.EmitCall(MSI.CallInfo, callee, Return, ActualArgs, &call);
David Chisnallff5f88c2010-05-02 13:41:58 +00002728 call->setMetadata(msgSendMDKind, node);
David Chisnall75afda62010-04-27 15:08:48 +00002729
David Chisnall29cefd12010-05-20 13:45:48 +00002730
David Chisnall75afda62010-04-27 15:08:48 +00002731 if (!isPointerSizedReturn) {
David Chisnall29cefd12010-05-20 13:45:48 +00002732 messageBB = CGF.Builder.GetInsertBlock();
2733 CGF.Builder.CreateBr(continueBB);
2734 CGF.EmitBlock(continueBB);
David Chisnall75afda62010-04-27 15:08:48 +00002735 if (msgRet.isScalar()) {
2736 llvm::Value *v = msgRet.getScalarVal();
Jay Foad20c0f022011-03-30 11:28:58 +00002737 llvm::PHINode *phi = Builder.CreatePHI(v->getType(), 2);
David Chisnall75afda62010-04-27 15:08:48 +00002738 phi->addIncoming(v, messageBB);
2739 phi->addIncoming(llvm::Constant::getNullValue(v->getType()), startBB);
2740 msgRet = RValue::get(phi);
2741 } else if (msgRet.isAggregate()) {
John McCall7f416cc2015-09-08 08:05:57 +00002742 Address v = msgRet.getAggregateAddress();
2743 llvm::PHINode *phi = Builder.CreatePHI(v.getType(), 2);
2744 llvm::Type *RetTy = v.getElementType();
2745 Address NullVal = CGF.CreateTempAlloca(RetTy, v.getAlignment(), "null");
2746 CGF.InitTempAlloca(NullVal, llvm::Constant::getNullValue(RetTy));
2747 phi->addIncoming(v.getPointer(), messageBB);
2748 phi->addIncoming(NullVal.getPointer(), startBB);
2749 msgRet = RValue::getAggregate(Address(phi, v.getAlignment()));
David Chisnall75afda62010-04-27 15:08:48 +00002750 } else /* isComplex() */ {
2751 std::pair<llvm::Value*,llvm::Value*> v = msgRet.getComplexVal();
Jay Foad20c0f022011-03-30 11:28:58 +00002752 llvm::PHINode *phi = Builder.CreatePHI(v.first->getType(), 2);
David Chisnall75afda62010-04-27 15:08:48 +00002753 phi->addIncoming(v.first, messageBB);
2754 phi->addIncoming(llvm::Constant::getNullValue(v.first->getType()),
2755 startBB);
Jay Foad20c0f022011-03-30 11:28:58 +00002756 llvm::PHINode *phi2 = Builder.CreatePHI(v.second->getType(), 2);
David Chisnall75afda62010-04-27 15:08:48 +00002757 phi2->addIncoming(v.second, messageBB);
2758 phi2->addIncoming(llvm::Constant::getNullValue(v.second->getType()),
2759 startBB);
2760 msgRet = RValue::getComplex(phi, phi2);
2761 }
2762 }
2763 return msgRet;
Chris Lattnerb7256cd2008-03-01 08:50:34 +00002764}
2765
Mike Stump11289f42009-09-09 15:08:12 +00002766/// Generates a MethodList. Used in construction of a objc_class and
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002767/// objc_category structures.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002768llvm::Constant *CGObjCGNU::
Craig Topperbf3e3272014-08-30 16:55:52 +00002769GenerateMethodList(StringRef ClassName,
2770 StringRef CategoryName,
David Chisnall404bbcb2018-05-22 10:13:06 +00002771 ArrayRef<const ObjCMethodDecl*> Methods,
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002772 bool isClassMethodList) {
David Chisnall404bbcb2018-05-22 10:13:06 +00002773 if (Methods.empty())
David Chisnall9f57c292009-08-17 16:35:33 +00002774 return NULLPtr;
John McCall6c9f1fdb2016-11-19 08:17:24 +00002775
John McCall23c9dc62016-11-28 22:18:27 +00002776 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002777
2778 auto MethodList = Builder.beginStruct();
2779 MethodList.addNullPointer(CGM.Int8PtrTy);
David Chisnall404bbcb2018-05-22 10:13:06 +00002780 MethodList.addInt(Int32Ty, Methods.size());
John McCall6c9f1fdb2016-11-19 08:17:24 +00002781
Mike Stump11289f42009-09-09 15:08:12 +00002782 // Get the method structure type.
John McCallecee86f2016-11-30 20:19:46 +00002783 llvm::StructType *ObjCMethodTy =
2784 llvm::StructType::get(CGM.getLLVMContext(), {
2785 PtrToInt8Ty, // Really a selector, but the runtime creates it us.
2786 PtrToInt8Ty, // Method types
2787 IMPTy // Method pointer
2788 });
David Chisnall404bbcb2018-05-22 10:13:06 +00002789 bool isV2ABI = isRuntime(ObjCRuntime::GNUstep, 2);
2790 if (isV2ABI) {
2791 // size_t size;
2792 llvm::DataLayout td(&TheModule);
2793 MethodList.addInt(SizeTy, td.getTypeSizeInBits(ObjCMethodTy) /
2794 CGM.getContext().getCharWidth());
2795 ObjCMethodTy =
2796 llvm::StructType::get(CGM.getLLVMContext(), {
2797 IMPTy, // Method pointer
2798 PtrToInt8Ty, // Selector
2799 PtrToInt8Ty // Extended type encoding
2800 });
2801 } else {
2802 ObjCMethodTy =
2803 llvm::StructType::get(CGM.getLLVMContext(), {
2804 PtrToInt8Ty, // Really a selector, but the runtime creates it us.
2805 PtrToInt8Ty, // Method types
2806 IMPTy // Method pointer
2807 });
2808 }
2809 auto MethodArray = MethodList.beginArray();
2810 ASTContext &Context = CGM.getContext();
2811 for (const auto *OMD : Methods) {
John McCallecee86f2016-11-30 20:19:46 +00002812 llvm::Constant *FnPtr =
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002813 TheModule.getFunction(SymbolNameForMethod(ClassName, CategoryName,
David Chisnall404bbcb2018-05-22 10:13:06 +00002814 OMD->getSelector(),
David Chisnalld7972f52011-03-23 16:36:54 +00002815 isClassMethodList));
John McCallecee86f2016-11-30 20:19:46 +00002816 assert(FnPtr && "Can't generate metadata for method that doesn't exist");
David Chisnall404bbcb2018-05-22 10:13:06 +00002817 auto Method = MethodArray.beginStruct(ObjCMethodTy);
2818 if (isV2ABI) {
2819 Method.addBitCast(FnPtr, IMPTy);
2820 Method.add(GetConstantSelector(OMD->getSelector(),
2821 Context.getObjCEncodingForMethodDecl(OMD)));
2822 Method.add(MakeConstantString(Context.getObjCEncodingForMethodDecl(OMD, true)));
2823 } else {
2824 Method.add(MakeConstantString(OMD->getSelector().getAsString()));
2825 Method.add(MakeConstantString(Context.getObjCEncodingForMethodDecl(OMD)));
2826 Method.addBitCast(FnPtr, IMPTy);
2827 }
2828 Method.finishAndAddTo(MethodArray);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002829 }
David Chisnall404bbcb2018-05-22 10:13:06 +00002830 MethodArray.finishAndAddTo(MethodList);
Mike Stump11289f42009-09-09 15:08:12 +00002831
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002832 // Create an instance of the structure
John McCall6c9f1fdb2016-11-19 08:17:24 +00002833 return MethodList.finishAndCreateGlobal(".objc_method_list",
2834 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002835}
2836
2837/// Generates an IvarList. Used in construction of a objc_class.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002838llvm::Constant *CGObjCGNU::
2839GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
2840 ArrayRef<llvm::Constant *> IvarTypes,
David Chisnall404bbcb2018-05-22 10:13:06 +00002841 ArrayRef<llvm::Constant *> IvarOffsets,
2842 ArrayRef<llvm::Constant *> IvarAlign,
2843 ArrayRef<Qualifiers::ObjCLifetime> IvarOwnership) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00002844 if (IvarNames.empty())
David Chisnallb3b44ce2009-11-16 19:05:54 +00002845 return NULLPtr;
John McCall6c9f1fdb2016-11-19 08:17:24 +00002846
John McCall23c9dc62016-11-28 22:18:27 +00002847 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002848
2849 // Structure containing array count followed by array.
2850 auto IvarList = Builder.beginStruct();
2851 IvarList.addInt(IntTy, (int)IvarNames.size());
2852
2853 // Get the ivar structure type.
Serge Guelton1d993272017-05-09 19:31:30 +00002854 llvm::StructType *ObjCIvarTy =
2855 llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty, IntTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002856
2857 // Array of ivar structures.
2858 auto Ivars = IvarList.beginArray(ObjCIvarTy);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002859 for (unsigned int i = 0, e = IvarNames.size() ; i < e ; i++) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00002860 auto Ivar = Ivars.beginStruct(ObjCIvarTy);
2861 Ivar.add(IvarNames[i]);
2862 Ivar.add(IvarTypes[i]);
2863 Ivar.add(IvarOffsets[i]);
John McCallf1788632016-11-28 22:18:30 +00002864 Ivar.finishAndAddTo(Ivars);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002865 }
John McCallf1788632016-11-28 22:18:30 +00002866 Ivars.finishAndAddTo(IvarList);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002867
2868 // Create an instance of the structure
John McCall6c9f1fdb2016-11-19 08:17:24 +00002869 return IvarList.finishAndCreateGlobal(".objc_ivar_list",
2870 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002871}
2872
2873/// Generate a class structure
2874llvm::Constant *CGObjCGNU::GenerateClassStructure(
2875 llvm::Constant *MetaClass,
2876 llvm::Constant *SuperClass,
2877 unsigned info,
Chris Lattnerda35bc82008-06-26 04:47:04 +00002878 const char *Name,
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002879 llvm::Constant *Version,
2880 llvm::Constant *InstanceSize,
2881 llvm::Constant *IVars,
2882 llvm::Constant *Methods,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002883 llvm::Constant *Protocols,
2884 llvm::Constant *IvarOffsets,
David Chisnalld472c852010-04-28 14:29:56 +00002885 llvm::Constant *Properties,
David Chisnallcdd207e2011-10-04 15:35:30 +00002886 llvm::Constant *StrongIvarBitmap,
2887 llvm::Constant *WeakIvarBitmap,
David Chisnalld472c852010-04-28 14:29:56 +00002888 bool isMeta) {
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002889 // Set up the class structure
2890 // Note: Several of these are char*s when they should be ids. This is
2891 // because the runtime performs this translation on load.
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002892 //
2893 // Fields marked New ABI are part of the GNUstep runtime. We emit them
2894 // anyway; the classes will still work with the GNU runtime, they will just
2895 // be ignored.
Chris Lattner845511f2011-06-18 22:49:11 +00002896 llvm::StructType *ClassTy = llvm::StructType::get(
Serge Guelton1d993272017-05-09 19:31:30 +00002897 PtrToInt8Ty, // isa
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002898 PtrToInt8Ty, // super_class
2899 PtrToInt8Ty, // name
2900 LongTy, // version
2901 LongTy, // info
2902 LongTy, // instance_size
2903 IVars->getType(), // ivars
2904 Methods->getType(), // methods
Mike Stump11289f42009-09-09 15:08:12 +00002905 // These are all filled in by the runtime, so we pretend
Serge Guelton1d993272017-05-09 19:31:30 +00002906 PtrTy, // dtable
2907 PtrTy, // subclass_list
2908 PtrTy, // sibling_class
2909 PtrTy, // protocols
2910 PtrTy, // gc_object_type
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00002911 // New ABI:
2912 LongTy, // abi_version
2913 IvarOffsets->getType(), // ivar_offsets
2914 Properties->getType(), // properties
David Chisnalle89ac062011-10-25 10:12:21 +00002915 IntPtrTy, // strong_pointers
Serge Guelton1d993272017-05-09 19:31:30 +00002916 IntPtrTy // weak_pointers
2917 );
John McCall6c9f1fdb2016-11-19 08:17:24 +00002918
John McCall23c9dc62016-11-28 22:18:27 +00002919 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002920 auto Elements = Builder.beginStruct(ClassTy);
2921
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002922 // Fill in the structure
John McCall6c9f1fdb2016-11-19 08:17:24 +00002923
Fangrui Song6907ce22018-07-30 19:24:48 +00002924 // isa
John McCallecee86f2016-11-30 20:19:46 +00002925 Elements.addBitCast(MetaClass, PtrToInt8Ty);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002926 // super_class
2927 Elements.add(SuperClass);
2928 // name
2929 Elements.add(MakeConstantString(Name, ".class_name"));
2930 // version
2931 Elements.addInt(LongTy, 0);
2932 // info
2933 Elements.addInt(LongTy, info);
2934 // instance_size
David Chisnall055f0642011-02-21 23:47:40 +00002935 if (isMeta) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00002936 llvm::DataLayout td(&TheModule);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002937 Elements.addInt(LongTy,
2938 td.getTypeSizeInBits(ClassTy) /
2939 CGM.getContext().getCharWidth());
David Chisnall055f0642011-02-21 23:47:40 +00002940 } else
John McCall6c9f1fdb2016-11-19 08:17:24 +00002941 Elements.add(InstanceSize);
2942 // ivars
2943 Elements.add(IVars);
2944 // methods
2945 Elements.add(Methods);
2946 // These are all filled in by the runtime, so we pretend
2947 // dtable
2948 Elements.add(NULLPtr);
2949 // subclass_list
2950 Elements.add(NULLPtr);
2951 // sibling_class
2952 Elements.add(NULLPtr);
2953 // protocols
John McCallecee86f2016-11-30 20:19:46 +00002954 Elements.addBitCast(Protocols, PtrTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002955 // gc_object_type
2956 Elements.add(NULLPtr);
2957 // abi_version
David Chisnall404bbcb2018-05-22 10:13:06 +00002958 Elements.addInt(LongTy, ClassABIVersion);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002959 // ivar_offsets
2960 Elements.add(IvarOffsets);
2961 // properties
2962 Elements.add(Properties);
2963 // strong_pointers
2964 Elements.add(StrongIvarBitmap);
2965 // weak_pointers
2966 Elements.add(WeakIvarBitmap);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002967 // Create an instance of the structure
David Chisnalldf349172010-01-08 00:14:31 +00002968 // This is now an externally visible symbol, so that we can speed up class
David Chisnall207a6302012-01-04 12:02:13 +00002969 // messages in the next ABI. We may already have some weak references to
2970 // this, so check and fix them properly.
2971 std::string ClassSym((isMeta ? "_OBJC_METACLASS_": "_OBJC_CLASS_") +
2972 std::string(Name));
2973 llvm::GlobalVariable *ClassRef = TheModule.getNamedGlobal(ClassSym);
John McCall7f416cc2015-09-08 08:05:57 +00002974 llvm::Constant *Class =
John McCall6c9f1fdb2016-11-19 08:17:24 +00002975 Elements.finishAndCreateGlobal(ClassSym, CGM.getPointerAlign(), false,
2976 llvm::GlobalValue::ExternalLinkage);
David Chisnall207a6302012-01-04 12:02:13 +00002977 if (ClassRef) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00002978 ClassRef->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(Class,
David Chisnall207a6302012-01-04 12:02:13 +00002979 ClassRef->getType()));
John McCall6c9f1fdb2016-11-19 08:17:24 +00002980 ClassRef->removeFromParent();
2981 Class->setName(ClassSym);
David Chisnall207a6302012-01-04 12:02:13 +00002982 }
2983 return Class;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00002984}
2985
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00002986llvm::Constant *CGObjCGNU::
David Chisnall404bbcb2018-05-22 10:13:06 +00002987GenerateProtocolMethodList(ArrayRef<const ObjCMethodDecl*> Methods) {
Mike Stump11289f42009-09-09 15:08:12 +00002988 // Get the method structure type.
John McCall6c9f1fdb2016-11-19 08:17:24 +00002989 llvm::StructType *ObjCMethodDescTy =
2990 llvm::StructType::get(CGM.getLLVMContext(), { PtrToInt8Ty, PtrToInt8Ty });
David Chisnall404bbcb2018-05-22 10:13:06 +00002991 ASTContext &Context = CGM.getContext();
John McCall23c9dc62016-11-28 22:18:27 +00002992 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00002993 auto MethodList = Builder.beginStruct();
David Chisnall404bbcb2018-05-22 10:13:06 +00002994 MethodList.addInt(IntTy, Methods.size());
2995 auto MethodArray = MethodList.beginArray(ObjCMethodDescTy);
2996 for (auto *M : Methods) {
2997 auto Method = MethodArray.beginStruct(ObjCMethodDescTy);
2998 Method.add(MakeConstantString(M->getSelector().getAsString()));
2999 Method.add(MakeConstantString(Context.getObjCEncodingForMethodDecl(M)));
3000 Method.finishAndAddTo(MethodArray);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003001 }
David Chisnall404bbcb2018-05-22 10:13:06 +00003002 MethodArray.finishAndAddTo(MethodList);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003003 return MethodList.finishAndCreateGlobal(".objc_method_list",
3004 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003005}
Mike Stumpdd93a192009-07-31 21:31:32 +00003006
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003007// Create the protocol list structure used in classes, categories and so on
John McCall6c9f1fdb2016-11-19 08:17:24 +00003008llvm::Constant *
3009CGObjCGNU::GenerateProtocolList(ArrayRef<std::string> Protocols) {
3010
John McCall23c9dc62016-11-28 22:18:27 +00003011 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003012 auto ProtocolList = Builder.beginStruct();
3013 ProtocolList.add(NULLPtr);
3014 ProtocolList.addInt(LongTy, Protocols.size());
3015
3016 auto Elements = ProtocolList.beginArray(PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003017 for (const std::string *iter = Protocols.begin(), *endIter = Protocols.end();
3018 iter != endIter ; iter++) {
Craig Topper8a13c412014-05-21 05:09:00 +00003019 llvm::Constant *protocol = nullptr;
David Chisnallbc8bdea2009-11-20 14:50:59 +00003020 llvm::StringMap<llvm::Constant*>::iterator value =
3021 ExistingProtocols.find(*iter);
3022 if (value == ExistingProtocols.end()) {
Fariborz Jahanian89d23972009-03-31 18:27:22 +00003023 protocol = GenerateEmptyProtocol(*iter);
David Chisnallbc8bdea2009-11-20 14:50:59 +00003024 } else {
3025 protocol = value->getValue();
3026 }
John McCallecee86f2016-11-30 20:19:46 +00003027 Elements.addBitCast(protocol, PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003028 }
John McCallf1788632016-11-28 22:18:30 +00003029 Elements.finishAndAddTo(ProtocolList);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003030 return ProtocolList.finishAndCreateGlobal(".objc_protocol_list",
3031 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003032}
3033
John McCall882987f2013-02-28 19:01:20 +00003034llvm::Value *CGObjCGNU::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00003035 const ObjCProtocolDecl *PD) {
David Chisnall404bbcb2018-05-22 10:13:06 +00003036 llvm::Constant *&protocol = ExistingProtocols[PD->getNameAsString()];
3037 if (!protocol)
3038 GenerateProtocol(PD);
Chris Lattner2192fe52011-07-18 04:24:23 +00003039 llvm::Type *T =
Fariborz Jahanian89d23972009-03-31 18:27:22 +00003040 CGM.getTypes().ConvertType(CGM.getContext().getObjCProtoType());
John McCall882987f2013-02-28 19:01:20 +00003041 return CGF.Builder.CreateBitCast(protocol, llvm::PointerType::getUnqual(T));
Fariborz Jahanian89d23972009-03-31 18:27:22 +00003042}
3043
John McCall6c9f1fdb2016-11-19 08:17:24 +00003044llvm::Constant *
David Chisnall404bbcb2018-05-22 10:13:06 +00003045CGObjCGNU::GenerateEmptyProtocol(StringRef ProtocolName) {
John McCall6c9f1fdb2016-11-19 08:17:24 +00003046 llvm::Constant *ProtocolList = GenerateProtocolList({});
David Chisnall404bbcb2018-05-22 10:13:06 +00003047 llvm::Constant *MethodList = GenerateProtocolMethodList({});
3048 MethodList = llvm::ConstantExpr::getBitCast(MethodList, PtrToInt8Ty);
Fariborz Jahanian89d23972009-03-31 18:27:22 +00003049 // Protocols are objects containing lists of the methods implemented and
3050 // protocols adopted.
John McCall23c9dc62016-11-28 22:18:27 +00003051 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003052 auto Elements = Builder.beginStruct();
3053
Fariborz Jahanian89d23972009-03-31 18:27:22 +00003054 // The isa pointer must be set to a magic number so the runtime knows it's
3055 // the correct layout.
John McCall6c9f1fdb2016-11-19 08:17:24 +00003056 Elements.add(llvm::ConstantExpr::getIntToPtr(
3057 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
3058
3059 Elements.add(MakeConstantString(ProtocolName, ".objc_protocol_name"));
David Chisnall10e590e2018-04-12 06:46:15 +00003060 Elements.add(ProtocolList); /* .protocol_list */
3061 Elements.add(MethodList); /* .instance_methods */
3062 Elements.add(MethodList); /* .class_methods */
3063 Elements.add(MethodList); /* .optional_instance_methods */
3064 Elements.add(MethodList); /* .optional_class_methods */
3065 Elements.add(NULLPtr); /* .properties */
3066 Elements.add(NULLPtr); /* .optional_properties */
David Chisnall404bbcb2018-05-22 10:13:06 +00003067 return Elements.finishAndCreateGlobal(SymbolForProtocol(ProtocolName),
John McCall6c9f1fdb2016-11-19 08:17:24 +00003068 CGM.getPointerAlign());
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003069}
3070
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00003071void CGObjCGNU::GenerateProtocol(const ObjCProtocolDecl *PD) {
Chris Lattner86d7d912008-11-24 03:54:41 +00003072 std::string ProtocolName = PD->getNameAsString();
Fangrui Song6907ce22018-07-30 19:24:48 +00003073
Douglas Gregora715bff2012-01-01 19:51:50 +00003074 // Use the protocol definition, if there is one.
3075 if (const ObjCProtocolDecl *Def = PD->getDefinition())
3076 PD = Def;
3077
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003078 SmallVector<std::string, 16> Protocols;
Aaron Ballman0f6e64d2014-03-13 22:58:06 +00003079 for (const auto *PI : PD->protocols())
3080 Protocols.push_back(PI->getNameAsString());
David Chisnall404bbcb2018-05-22 10:13:06 +00003081 SmallVector<const ObjCMethodDecl*, 16> InstanceMethods;
3082 SmallVector<const ObjCMethodDecl*, 16> OptionalInstanceMethods;
3083 for (const auto *I : PD->instance_methods())
3084 if (I->isOptional())
3085 OptionalInstanceMethods.push_back(I);
3086 else
3087 InstanceMethods.push_back(I);
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00003088 // Collect information about class methods:
David Chisnall404bbcb2018-05-22 10:13:06 +00003089 SmallVector<const ObjCMethodDecl*, 16> ClassMethods;
3090 SmallVector<const ObjCMethodDecl*, 16> OptionalClassMethods;
3091 for (const auto *I : PD->class_methods())
3092 if (I->isOptional())
3093 OptionalClassMethods.push_back(I);
3094 else
3095 ClassMethods.push_back(I);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003096
3097 llvm::Constant *ProtocolList = GenerateProtocolList(Protocols);
3098 llvm::Constant *InstanceMethodList =
David Chisnall404bbcb2018-05-22 10:13:06 +00003099 GenerateProtocolMethodList(InstanceMethods);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003100 llvm::Constant *ClassMethodList =
David Chisnall404bbcb2018-05-22 10:13:06 +00003101 GenerateProtocolMethodList(ClassMethods);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003102 llvm::Constant *OptionalInstanceMethodList =
David Chisnall404bbcb2018-05-22 10:13:06 +00003103 GenerateProtocolMethodList(OptionalInstanceMethods);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003104 llvm::Constant *OptionalClassMethodList =
David Chisnall404bbcb2018-05-22 10:13:06 +00003105 GenerateProtocolMethodList(OptionalClassMethods);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003106
3107 // Property metadata: name, attributes, isSynthesized, setter name, setter
3108 // types, getter name, getter types.
3109 // The isSynthesized value is always set to 0 in a protocol. It exists to
3110 // simplify the runtime library by allowing it to use the same data
3111 // structures for protocol metadata everywhere.
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003112
David Chisnall404bbcb2018-05-22 10:13:06 +00003113 llvm::Constant *PropertyList =
3114 GeneratePropertyList(nullptr, PD, false, false);
3115 llvm::Constant *OptionalPropertyList =
3116 GeneratePropertyList(nullptr, PD, false, true);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003117
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003118 // Protocols are objects containing lists of the methods implemented and
3119 // protocols adopted.
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003120 // The isa pointer must be set to a magic number so the runtime knows it's
3121 // the correct layout.
John McCall23c9dc62016-11-28 22:18:27 +00003122 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003123 auto Elements = Builder.beginStruct();
3124 Elements.add(
Benjamin Kramer30934732016-07-02 11:41:41 +00003125 llvm::ConstantExpr::getIntToPtr(
John McCall6c9f1fdb2016-11-19 08:17:24 +00003126 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
David Chisnall404bbcb2018-05-22 10:13:06 +00003127 Elements.add(MakeConstantString(ProtocolName));
John McCall6c9f1fdb2016-11-19 08:17:24 +00003128 Elements.add(ProtocolList);
3129 Elements.add(InstanceMethodList);
3130 Elements.add(ClassMethodList);
3131 Elements.add(OptionalInstanceMethodList);
3132 Elements.add(OptionalClassMethodList);
3133 Elements.add(PropertyList);
3134 Elements.add(OptionalPropertyList);
Mike Stump11289f42009-09-09 15:08:12 +00003135 ExistingProtocols[ProtocolName] =
John McCall6c9f1fdb2016-11-19 08:17:24 +00003136 llvm::ConstantExpr::getBitCast(
3137 Elements.finishAndCreateGlobal(".objc_protocol", CGM.getPointerAlign()),
3138 IdTy);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003139}
Dmitri Gribenkob2aa9232012-11-15 14:28:07 +00003140void CGObjCGNU::GenerateProtocolHolderCategory() {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003141 // Collect information about instance methods
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003142
John McCall23c9dc62016-11-28 22:18:27 +00003143 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003144 auto Elements = Builder.beginStruct();
3145
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003146 const std::string ClassName = "__ObjC_Protocol_Holder_Ugly_Hack";
3147 const std::string CategoryName = "AnotherHack";
John McCall6c9f1fdb2016-11-19 08:17:24 +00003148 Elements.add(MakeConstantString(CategoryName));
3149 Elements.add(MakeConstantString(ClassName));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003150 // Instance method list
John McCallecee86f2016-11-30 20:19:46 +00003151 Elements.addBitCast(GenerateMethodList(
David Chisnall404bbcb2018-05-22 10:13:06 +00003152 ClassName, CategoryName, {}, false), PtrTy);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003153 // Class method list
John McCallecee86f2016-11-30 20:19:46 +00003154 Elements.addBitCast(GenerateMethodList(
David Chisnall404bbcb2018-05-22 10:13:06 +00003155 ClassName, CategoryName, {}, true), PtrTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003156
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003157 // Protocol list
John McCall23c9dc62016-11-28 22:18:27 +00003158 ConstantInitBuilder ProtocolListBuilder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003159 auto ProtocolList = ProtocolListBuilder.beginStruct();
3160 ProtocolList.add(NULLPtr);
3161 ProtocolList.addInt(LongTy, ExistingProtocols.size());
3162 auto ProtocolElements = ProtocolList.beginArray(PtrTy);
3163 for (auto iter = ExistingProtocols.begin(), endIter = ExistingProtocols.end();
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003164 iter != endIter ; iter++) {
John McCallecee86f2016-11-30 20:19:46 +00003165 ProtocolElements.addBitCast(iter->getValue(), PtrTy);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003166 }
John McCallf1788632016-11-28 22:18:30 +00003167 ProtocolElements.finishAndAddTo(ProtocolList);
John McCallecee86f2016-11-30 20:19:46 +00003168 Elements.addBitCast(
John McCall6c9f1fdb2016-11-19 08:17:24 +00003169 ProtocolList.finishAndCreateGlobal(".objc_protocol_list",
3170 CGM.getPointerAlign()),
John McCallecee86f2016-11-30 20:19:46 +00003171 PtrTy);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003172 Categories.push_back(llvm::ConstantExpr::getBitCast(
John McCall6c9f1fdb2016-11-19 08:17:24 +00003173 Elements.finishAndCreateGlobal("", CGM.getPointerAlign()),
John McCall7f416cc2015-09-08 08:05:57 +00003174 PtrTy));
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003175}
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003176
David Chisnallcdd207e2011-10-04 15:35:30 +00003177/// Libobjc2 uses a bitfield representation where small(ish) bitfields are
3178/// stored in a 64-bit value with the low bit set to 1 and the remaining 63
3179/// bits set to their values, LSB first, while larger ones are stored in a
3180/// structure of this / form:
Fangrui Song6907ce22018-07-30 19:24:48 +00003181///
David Chisnallcdd207e2011-10-04 15:35:30 +00003182/// struct { int32_t length; int32_t values[length]; };
3183///
3184/// The values in the array are stored in host-endian format, with the least
3185/// significant bit being assumed to come first in the bitfield. Therefore, a
3186/// bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] }, while a
3187/// bitfield / with the 63rd bit set will be 1<<64.
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003188llvm::Constant *CGObjCGNU::MakeBitField(ArrayRef<bool> bits) {
David Chisnallcdd207e2011-10-04 15:35:30 +00003189 int bitCount = bits.size();
Rafael Espindola3cc5c2d2014-01-09 21:32:51 +00003190 int ptrBits = CGM.getDataLayout().getPointerSizeInBits();
David Chisnalle89ac062011-10-25 10:12:21 +00003191 if (bitCount < ptrBits) {
David Chisnallcdd207e2011-10-04 15:35:30 +00003192 uint64_t val = 1;
3193 for (int i=0 ; i<bitCount ; ++i) {
Eli Friedman23526672011-10-08 01:03:47 +00003194 if (bits[i]) val |= 1ULL<<(i+1);
David Chisnallcdd207e2011-10-04 15:35:30 +00003195 }
David Chisnalle89ac062011-10-25 10:12:21 +00003196 return llvm::ConstantInt::get(IntPtrTy, val);
David Chisnallcdd207e2011-10-04 15:35:30 +00003197 }
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003198 SmallVector<llvm::Constant *, 8> values;
David Chisnallcdd207e2011-10-04 15:35:30 +00003199 int v=0;
3200 while (v < bitCount) {
3201 int32_t word = 0;
3202 for (int i=0 ; (i<32) && (v<bitCount) ; ++i) {
3203 if (bits[v]) word |= 1<<i;
3204 v++;
3205 }
3206 values.push_back(llvm::ConstantInt::get(Int32Ty, word));
3207 }
John McCall6c9f1fdb2016-11-19 08:17:24 +00003208
John McCall23c9dc62016-11-28 22:18:27 +00003209 ConstantInitBuilder builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003210 auto fields = builder.beginStruct();
3211 fields.addInt(Int32Ty, values.size());
3212 auto array = fields.beginArray();
3213 for (auto v : values) array.add(v);
John McCallf1788632016-11-28 22:18:30 +00003214 array.finishAndAddTo(fields);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003215
3216 llvm::Constant *GS =
3217 fields.finishAndCreateGlobal("", CharUnits::fromQuantity(4));
David Chisnalle0dc7cb2011-10-08 08:54:36 +00003218 llvm::Constant *ptr = llvm::ConstantExpr::getPtrToInt(GS, IntPtrTy);
David Chisnalle0dc7cb2011-10-08 08:54:36 +00003219 return ptr;
David Chisnallcdd207e2011-10-04 15:35:30 +00003220}
3221
David Chisnall386477a2018-12-28 17:44:54 +00003222llvm::Constant *CGObjCGNU::GenerateCategoryProtocolList(const
3223 ObjCCategoryDecl *OCD) {
3224 SmallVector<std::string, 16> Protocols;
3225 for (const auto *PD : OCD->getReferencedProtocols())
3226 Protocols.push_back(PD->getNameAsString());
3227 return GenerateProtocolList(Protocols);
3228}
3229
Daniel Dunbar92992502008-08-15 22:20:32 +00003230void CGObjCGNU::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
David Chisnall404bbcb2018-05-22 10:13:06 +00003231 const ObjCInterfaceDecl *Class = OCD->getClassInterface();
3232 std::string ClassName = Class->getNameAsString();
Chris Lattner86d7d912008-11-24 03:54:41 +00003233 std::string CategoryName = OCD->getNameAsString();
Daniel Dunbar92992502008-08-15 22:20:32 +00003234
3235 // Collect the names of referenced protocols
David Chisnall2bfc50b2010-03-13 22:20:45 +00003236 const ObjCCategoryDecl *CatDecl = OCD->getCategoryDecl();
Daniel Dunbar92992502008-08-15 22:20:32 +00003237
John McCall23c9dc62016-11-28 22:18:27 +00003238 ConstantInitBuilder Builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003239 auto Elements = Builder.beginStruct();
3240 Elements.add(MakeConstantString(CategoryName));
3241 Elements.add(MakeConstantString(ClassName));
3242 // Instance method list
David Chisnall404bbcb2018-05-22 10:13:06 +00003243 SmallVector<ObjCMethodDecl*, 16> InstanceMethods;
3244 InstanceMethods.insert(InstanceMethods.begin(), OCD->instmeth_begin(),
3245 OCD->instmeth_end());
John McCallecee86f2016-11-30 20:19:46 +00003246 Elements.addBitCast(
David Chisnall404bbcb2018-05-22 10:13:06 +00003247 GenerateMethodList(ClassName, CategoryName, InstanceMethods, false),
John McCallecee86f2016-11-30 20:19:46 +00003248 PtrTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003249 // Class method list
David Chisnall404bbcb2018-05-22 10:13:06 +00003250
3251 SmallVector<ObjCMethodDecl*, 16> ClassMethods;
3252 ClassMethods.insert(ClassMethods.begin(), OCD->classmeth_begin(),
3253 OCD->classmeth_end());
John McCallecee86f2016-11-30 20:19:46 +00003254 Elements.addBitCast(
David Chisnall404bbcb2018-05-22 10:13:06 +00003255 GenerateMethodList(ClassName, CategoryName, ClassMethods, true),
John McCallecee86f2016-11-30 20:19:46 +00003256 PtrTy);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003257 // Protocol list
David Chisnall386477a2018-12-28 17:44:54 +00003258 Elements.addBitCast(GenerateCategoryProtocolList(CatDecl), PtrTy);
David Chisnall404bbcb2018-05-22 10:13:06 +00003259 if (isRuntime(ObjCRuntime::GNUstep, 2)) {
3260 const ObjCCategoryDecl *Category =
3261 Class->FindCategoryDeclaration(OCD->getIdentifier());
3262 if (Category) {
3263 // Instance properties
3264 Elements.addBitCast(GeneratePropertyList(OCD, Category, false), PtrTy);
3265 // Class properties
3266 Elements.addBitCast(GeneratePropertyList(OCD, Category, true), PtrTy);
3267 } else {
3268 Elements.addNullPointer(PtrTy);
3269 Elements.addNullPointer(PtrTy);
3270 }
3271 }
3272
Owen Andersonade90fd2009-07-29 18:54:39 +00003273 Categories.push_back(llvm::ConstantExpr::getBitCast(
David Chisnall404bbcb2018-05-22 10:13:06 +00003274 Elements.finishAndCreateGlobal(
3275 std::string(".objc_category_")+ClassName+CategoryName,
3276 CGM.getPointerAlign()),
John McCall7f416cc2015-09-08 08:05:57 +00003277 PtrTy));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003278}
Daniel Dunbar92992502008-08-15 22:20:32 +00003279
David Chisnall404bbcb2018-05-22 10:13:06 +00003280llvm::Constant *CGObjCGNU::GeneratePropertyList(const Decl *Container,
3281 const ObjCContainerDecl *OCD,
3282 bool isClassProperty,
3283 bool protocolOptionalProperties) {
David Chisnall79356ee2018-05-22 06:09:23 +00003284
David Chisnall404bbcb2018-05-22 10:13:06 +00003285 SmallVector<const ObjCPropertyDecl *, 16> Properties;
3286 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
3287 bool isProtocol = isa<ObjCProtocolDecl>(OCD);
3288 ASTContext &Context = CGM.getContext();
3289
3290 std::function<void(const ObjCProtocolDecl *Proto)> collectProtocolProperties
3291 = [&](const ObjCProtocolDecl *Proto) {
3292 for (const auto *P : Proto->protocols())
3293 collectProtocolProperties(P);
3294 for (const auto *PD : Proto->properties()) {
3295 if (isClassProperty != PD->isClassProperty())
3296 continue;
3297 // Skip any properties that are declared in protocols that this class
3298 // conforms to but are not actually implemented by this class.
3299 if (!isProtocol && !Context.getObjCPropertyImplDeclForPropertyDecl(PD, Container))
3300 continue;
3301 if (!PropertySet.insert(PD->getIdentifier()).second)
3302 continue;
3303 Properties.push_back(PD);
3304 }
3305 };
3306
3307 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD))
3308 for (const ObjCCategoryDecl *ClassExt : OID->known_extensions())
3309 for (auto *PD : ClassExt->properties()) {
3310 if (isClassProperty != PD->isClassProperty())
3311 continue;
3312 PropertySet.insert(PD->getIdentifier());
3313 Properties.push_back(PD);
3314 }
3315
3316 for (const auto *PD : OCD->properties()) {
3317 if (isClassProperty != PD->isClassProperty())
3318 continue;
3319 // If we're generating a list for a protocol, skip optional / required ones
3320 // when generating the other list.
3321 if (isProtocol && (protocolOptionalProperties != PD->isOptional()))
3322 continue;
3323 // Don't emit duplicate metadata for properties that were already in a
3324 // class extension.
3325 if (!PropertySet.insert(PD->getIdentifier()).second)
3326 continue;
3327
3328 Properties.push_back(PD);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003329 }
3330
David Chisnall404bbcb2018-05-22 10:13:06 +00003331 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD))
3332 for (const auto *P : OID->all_referenced_protocols())
3333 collectProtocolProperties(P);
3334 else if (const ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(OCD))
3335 for (const auto *P : CD->protocols())
3336 collectProtocolProperties(P);
3337
3338 auto numProperties = Properties.size();
3339
3340 if (numProperties == 0)
3341 return NULLPtr;
3342
John McCall23c9dc62016-11-28 22:18:27 +00003343 ConstantInitBuilder builder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003344 auto propertyList = builder.beginStruct();
David Chisnall404bbcb2018-05-22 10:13:06 +00003345 auto properties = PushPropertyListHeader(propertyList, numProperties);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003346
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003347 // Add all of the property methods need adding to the method list and to the
3348 // property metadata list.
David Chisnall404bbcb2018-05-22 10:13:06 +00003349 for (auto *property : Properties) {
3350 bool isSynthesized = false;
3351 bool isDynamic = false;
3352 if (!isProtocol) {
3353 auto *propertyImpl = Context.getObjCPropertyImplDeclForPropertyDecl(property, Container);
3354 if (propertyImpl) {
3355 isSynthesized = (propertyImpl->getPropertyImplementation() ==
3356 ObjCPropertyImplDecl::Synthesize);
3357 isDynamic = (propertyImpl->getPropertyImplementation() ==
3358 ObjCPropertyImplDecl::Dynamic);
David Chisnall36c63202010-02-26 01:11:38 +00003359 }
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003360 }
David Chisnall404bbcb2018-05-22 10:13:06 +00003361 PushProperty(properties, property, Container, isSynthesized, isDynamic);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003362 }
John McCallf1788632016-11-28 22:18:30 +00003363 properties.finishAndAddTo(propertyList);
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003364
John McCall6c9f1fdb2016-11-19 08:17:24 +00003365 return propertyList.finishAndCreateGlobal(".objc_property_list",
3366 CGM.getPointerAlign());
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003367}
3368
David Chisnall92d436b2012-01-31 18:59:20 +00003369void CGObjCGNU::RegisterAlias(const ObjCCompatibleAliasDecl *OAD) {
3370 // Get the class declaration for which the alias is specified.
3371 ObjCInterfaceDecl *ClassDecl =
3372 const_cast<ObjCInterfaceDecl *>(OAD->getClassInterface());
Benjamin Kramer3204b152015-05-29 19:42:19 +00003373 ClassAliases.emplace_back(ClassDecl->getNameAsString(),
3374 OAD->getNameAsString());
David Chisnall92d436b2012-01-31 18:59:20 +00003375}
3376
Daniel Dunbar92992502008-08-15 22:20:32 +00003377void CGObjCGNU::GenerateClass(const ObjCImplementationDecl *OID) {
3378 ASTContext &Context = CGM.getContext();
3379
3380 // Get the superclass name.
Mike Stump11289f42009-09-09 15:08:12 +00003381 const ObjCInterfaceDecl * SuperClassDecl =
Daniel Dunbar92992502008-08-15 22:20:32 +00003382 OID->getClassInterface()->getSuperClass();
Chris Lattner86d7d912008-11-24 03:54:41 +00003383 std::string SuperClassName;
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00003384 if (SuperClassDecl) {
Chris Lattner86d7d912008-11-24 03:54:41 +00003385 SuperClassName = SuperClassDecl->getNameAsString();
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00003386 EmitClassRef(SuperClassName);
3387 }
Daniel Dunbar92992502008-08-15 22:20:32 +00003388
3389 // Get the class name
Chris Lattner87bc3872009-04-01 02:00:48 +00003390 ObjCInterfaceDecl *ClassDecl =
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00003391 const_cast<ObjCInterfaceDecl *>(OID->getClassInterface());
Chris Lattner86d7d912008-11-24 03:54:41 +00003392 std::string ClassName = ClassDecl->getNameAsString();
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00003393
Chris Lattnerc7d2bfa2009-06-15 01:09:11 +00003394 // Emit the symbol that is used to generate linker errors if this class is
3395 // referenced in other modules but not declared.
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00003396 std::string classSymbolName = "__objc_class_name_" + ClassName;
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00003397 if (auto *symbol = TheModule.getGlobalVariable(classSymbolName)) {
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003398 symbol->setInitializer(llvm::ConstantInt::get(LongTy, 0));
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00003399 } else {
Owen Andersonc10c8d32009-07-08 19:05:04 +00003400 new llvm::GlobalVariable(TheModule, LongTy, false,
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00003401 llvm::GlobalValue::ExternalLinkage,
3402 llvm::ConstantInt::get(LongTy, 0),
3403 classSymbolName);
Fariborz Jahanianbacbed92009-07-03 15:10:14 +00003404 }
Mike Stump11289f42009-09-09 15:08:12 +00003405
Daniel Dunbar12119b92009-05-03 10:46:44 +00003406 // Get the size of instances.
Fangrui Song6907ce22018-07-30 19:24:48 +00003407 int instanceSize =
Ken Dyckc8ae5502011-02-09 01:59:34 +00003408 Context.getASTObjCImplementationLayout(OID).getSize().getQuantity();
Daniel Dunbar92992502008-08-15 22:20:32 +00003409
3410 // Collect information about instance variables.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003411 SmallVector<llvm::Constant*, 16> IvarNames;
3412 SmallVector<llvm::Constant*, 16> IvarTypes;
3413 SmallVector<llvm::Constant*, 16> IvarOffsets;
David Chisnall404bbcb2018-05-22 10:13:06 +00003414 SmallVector<llvm::Constant*, 16> IvarAligns;
3415 SmallVector<Qualifiers::ObjCLifetime, 16> IvarOwnership;
Mike Stump11289f42009-09-09 15:08:12 +00003416
John McCall23c9dc62016-11-28 22:18:27 +00003417 ConstantInitBuilder IvarOffsetBuilder(CGM);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003418 auto IvarOffsetValues = IvarOffsetBuilder.beginArray(PtrToIntTy);
David Chisnallcdd207e2011-10-04 15:35:30 +00003419 SmallVector<bool, 16> WeakIvars;
3420 SmallVector<bool, 16> StrongIvars;
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003421
Mike Stump11289f42009-09-09 15:08:12 +00003422 int superInstanceSize = !SuperClassDecl ? 0 :
Ken Dyckc8ae5502011-02-09 01:59:34 +00003423 Context.getASTObjCInterfaceLayout(SuperClassDecl).getSize().getQuantity();
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00003424 // For non-fragile ivars, set the instance size to 0 - {the size of just this
3425 // class}. The runtime will then set this to the correct value on load.
Richard Smith9c6890a2012-11-01 22:30:59 +00003426 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00003427 instanceSize = 0 - (instanceSize - superInstanceSize);
3428 }
David Chisnall18cf7372010-04-19 00:45:34 +00003429
Jordy Rosea91768e2011-07-22 02:08:32 +00003430 for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD;
3431 IVD = IVD->getNextIvar()) {
Daniel Dunbar92992502008-08-15 22:20:32 +00003432 // Store the name
David Chisnall18cf7372010-04-19 00:45:34 +00003433 IvarNames.push_back(MakeConstantString(IVD->getNameAsString()));
Daniel Dunbar92992502008-08-15 22:20:32 +00003434 // Get the type encoding for this ivar
3435 std::string TypeStr;
Akira Hatanakaff8534b2017-03-14 04:00:52 +00003436 Context.getObjCEncodingForType(IVD->getType(), TypeStr, IVD);
David Chisnall5778fce2009-08-31 16:41:57 +00003437 IvarTypes.push_back(MakeConstantString(TypeStr));
David Chisnall404bbcb2018-05-22 10:13:06 +00003438 IvarAligns.push_back(llvm::ConstantInt::get(IntTy,
3439 Context.getTypeSize(IVD->getType())));
Daniel Dunbar92992502008-08-15 22:20:32 +00003440 // Get the offset
Eli Friedman8cbca202012-11-06 22:15:52 +00003441 uint64_t BaseOffset = ComputeIvarBaseOffset(CGM, OID, IVD);
David Chisnallcb1b7bf2009-11-17 19:32:15 +00003442 uint64_t Offset = BaseOffset;
Richard Smith9c6890a2012-11-01 22:30:59 +00003443 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003444 Offset = BaseOffset - superInstanceSize;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00003445 }
David Chisnall1bfe6d32011-07-07 12:34:51 +00003446 llvm::Constant *OffsetValue = llvm::ConstantInt::get(IntTy, Offset);
3447 // Create the direct offset value
3448 std::string OffsetName = "__objc_ivar_offset_value_" + ClassName +"." +
3449 IVD->getNameAsString();
David Chisnall404bbcb2018-05-22 10:13:06 +00003450
David Chisnall1bfe6d32011-07-07 12:34:51 +00003451 llvm::GlobalVariable *OffsetVar = TheModule.getGlobalVariable(OffsetName);
3452 if (OffsetVar) {
3453 OffsetVar->setInitializer(OffsetValue);
3454 // If this is the real definition, change its linkage type so that
3455 // different modules will use this one, rather than their private
3456 // copy.
3457 OffsetVar->setLinkage(llvm::GlobalValue::ExternalLinkage);
3458 } else
David Chisnall404bbcb2018-05-22 10:13:06 +00003459 OffsetVar = new llvm::GlobalVariable(TheModule, Int32Ty,
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003460 false, llvm::GlobalValue::ExternalLinkage,
David Chisnall404bbcb2018-05-22 10:13:06 +00003461 OffsetValue, OffsetName);
David Chisnall1bfe6d32011-07-07 12:34:51 +00003462 IvarOffsets.push_back(OffsetValue);
John McCall6c9f1fdb2016-11-19 08:17:24 +00003463 IvarOffsetValues.add(OffsetVar);
David Chisnallcdd207e2011-10-04 15:35:30 +00003464 Qualifiers::ObjCLifetime lt = IVD->getType().getQualifiers().getObjCLifetime();
David Chisnall404bbcb2018-05-22 10:13:06 +00003465 IvarOwnership.push_back(lt);
David Chisnallcdd207e2011-10-04 15:35:30 +00003466 switch (lt) {
3467 case Qualifiers::OCL_Strong:
3468 StrongIvars.push_back(true);
3469 WeakIvars.push_back(false);
3470 break;
3471 case Qualifiers::OCL_Weak:
3472 StrongIvars.push_back(false);
3473 WeakIvars.push_back(true);
3474 break;
3475 default:
3476 StrongIvars.push_back(false);
3477 WeakIvars.push_back(false);
3478 }
Daniel Dunbar92992502008-08-15 22:20:32 +00003479 }
David Chisnallcdd207e2011-10-04 15:35:30 +00003480 llvm::Constant *StrongIvarBitmap = MakeBitField(StrongIvars);
3481 llvm::Constant *WeakIvarBitmap = MakeBitField(WeakIvars);
David Chisnalld7972f52011-03-23 16:36:54 +00003482 llvm::GlobalVariable *IvarOffsetArray =
John McCall6c9f1fdb2016-11-19 08:17:24 +00003483 IvarOffsetValues.finishAndCreateGlobal(".ivar.offsets",
3484 CGM.getPointerAlign());
David Chisnalld7972f52011-03-23 16:36:54 +00003485
Daniel Dunbar92992502008-08-15 22:20:32 +00003486 // Collect information about instance methods
David Chisnall404bbcb2018-05-22 10:13:06 +00003487 SmallVector<const ObjCMethodDecl*, 16> InstanceMethods;
3488 InstanceMethods.insert(InstanceMethods.begin(), OID->instmeth_begin(),
3489 OID->instmeth_end());
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003490
David Chisnall404bbcb2018-05-22 10:13:06 +00003491 SmallVector<const ObjCMethodDecl*, 16> ClassMethods;
3492 ClassMethods.insert(ClassMethods.begin(), OID->classmeth_begin(),
3493 OID->classmeth_end());
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003494
David Chisnall404bbcb2018-05-22 10:13:06 +00003495 // Collect the same information about synthesized properties, which don't
3496 // show up in the instance method lists.
3497 for (auto *propertyImpl : OID->property_impls())
Fangrui Song6907ce22018-07-30 19:24:48 +00003498 if (propertyImpl->getPropertyImplementation() ==
David Chisnall404bbcb2018-05-22 10:13:06 +00003499 ObjCPropertyImplDecl::Synthesize) {
David Chisnall404bbcb2018-05-22 10:13:06 +00003500 auto addPropertyMethod = [&](const ObjCMethodDecl *accessor) {
3501 if (accessor)
3502 InstanceMethods.push_back(accessor);
3503 };
Adrian Prantl2073dd22019-11-04 14:28:14 -08003504 addPropertyMethod(propertyImpl->getGetterMethodDecl());
3505 addPropertyMethod(propertyImpl->getSetterMethodDecl());
David Chisnall404bbcb2018-05-22 10:13:06 +00003506 }
3507
3508 llvm::Constant *Properties = GeneratePropertyList(OID, ClassDecl);
3509
Daniel Dunbar92992502008-08-15 22:20:32 +00003510 // Collect the names of referenced protocols
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003511 SmallVector<std::string, 16> Protocols;
Aaron Ballmana49c5062014-03-13 20:29:09 +00003512 for (const auto *I : ClassDecl->protocols())
3513 Protocols.push_back(I->getNameAsString());
Daniel Dunbar92992502008-08-15 22:20:32 +00003514
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003515 // Get the superclass pointer.
3516 llvm::Constant *SuperClass;
Chris Lattner86d7d912008-11-24 03:54:41 +00003517 if (!SuperClassName.empty()) {
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003518 SuperClass = MakeConstantString(SuperClassName, ".super_class_name");
3519 } else {
Owen Anderson7ec07a52009-07-30 23:11:26 +00003520 SuperClass = llvm::ConstantPointerNull::get(PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003521 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003522 // Empty vector used to construct empty method lists
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003523 SmallVector<llvm::Constant*, 1> empty;
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003524 // Generate the method and instance variable lists
3525 llvm::Constant *MethodList = GenerateMethodList(ClassName, "",
David Chisnall404bbcb2018-05-22 10:13:06 +00003526 InstanceMethods, false);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003527 llvm::Constant *ClassMethodList = GenerateMethodList(ClassName, "",
David Chisnall404bbcb2018-05-22 10:13:06 +00003528 ClassMethods, true);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003529 llvm::Constant *IvarList = GenerateIvarList(IvarNames, IvarTypes,
David Chisnall404bbcb2018-05-22 10:13:06 +00003530 IvarOffsets, IvarAligns, IvarOwnership);
Mike Stump11289f42009-09-09 15:08:12 +00003531 // Irrespective of whether we are compiling for a fragile or non-fragile ABI,
David Chisnall5778fce2009-08-31 16:41:57 +00003532 // we emit a symbol containing the offset for each ivar in the class. This
3533 // allows code compiled for the non-Fragile ABI to inherit from code compiled
3534 // for the legacy ABI, without causing problems. The converse is also
3535 // possible, but causes all ivar accesses to be fragile.
David Chisnalle8431a72010-11-03 16:12:44 +00003536
David Chisnall5778fce2009-08-31 16:41:57 +00003537 // Offset pointer for getting at the correct field in the ivar list when
3538 // setting up the alias. These are: The base address for the global, the
3539 // ivar array (second field), the ivar in this list (set for each ivar), and
3540 // the offset (third field in ivar structure)
David Chisnallcdd207e2011-10-04 15:35:30 +00003541 llvm::Type *IndexTy = Int32Ty;
David Chisnall5778fce2009-08-31 16:41:57 +00003542 llvm::Constant *offsetPointerIndexes[] = {Zeros[0],
David Chisnall404bbcb2018-05-22 10:13:06 +00003543 llvm::ConstantInt::get(IndexTy, ClassABIVersion > 1 ? 2 : 1), nullptr,
3544 llvm::ConstantInt::get(IndexTy, ClassABIVersion > 1 ? 3 : 2) };
David Chisnall5778fce2009-08-31 16:41:57 +00003545
Jordy Rosea91768e2011-07-22 02:08:32 +00003546 unsigned ivarIndex = 0;
3547 for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD;
3548 IVD = IVD->getNextIvar()) {
David Chisnall404bbcb2018-05-22 10:13:06 +00003549 const std::string Name = GetIVarOffsetVariableName(ClassDecl, IVD);
Jordy Rosea91768e2011-07-22 02:08:32 +00003550 offsetPointerIndexes[2] = llvm::ConstantInt::get(IndexTy, ivarIndex);
David Chisnall5778fce2009-08-31 16:41:57 +00003551 // Get the correct ivar field
3552 llvm::Constant *offsetValue = llvm::ConstantExpr::getGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00003553 cast<llvm::GlobalVariable>(IvarList)->getValueType(), IvarList,
3554 offsetPointerIndexes);
David Chisnalle8431a72010-11-03 16:12:44 +00003555 // Get the existing variable, if one exists.
David Chisnall5778fce2009-08-31 16:41:57 +00003556 llvm::GlobalVariable *offset = TheModule.getNamedGlobal(Name);
3557 if (offset) {
Ted Kremenek669669f2012-04-04 00:55:25 +00003558 offset->setInitializer(offsetValue);
3559 // If this is the real definition, change its linkage type so that
3560 // different modules will use this one, rather than their private
3561 // copy.
3562 offset->setLinkage(llvm::GlobalValue::ExternalLinkage);
David Chisnall404bbcb2018-05-22 10:13:06 +00003563 } else
Ted Kremenek669669f2012-04-04 00:55:25 +00003564 // Add a new alias if there isn't one already.
David Chisnall404bbcb2018-05-22 10:13:06 +00003565 new llvm::GlobalVariable(TheModule, offsetValue->getType(),
Ted Kremenek669669f2012-04-04 00:55:25 +00003566 false, llvm::GlobalValue::ExternalLinkage, offsetValue, Name);
Jordy Rosea91768e2011-07-22 02:08:32 +00003567 ++ivarIndex;
David Chisnall5778fce2009-08-31 16:41:57 +00003568 }
David Chisnalle89ac062011-10-25 10:12:21 +00003569 llvm::Constant *ZeroPtr = llvm::ConstantInt::get(IntPtrTy, 0);
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00003570
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003571 //Generate metaclass for class methods
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00003572 llvm::Constant *MetaClassStruct = GenerateClassStructure(
3573 NULLPtr, NULLPtr, 0x12L, ClassName.c_str(), nullptr, Zeros[0],
David Chisnall404bbcb2018-05-22 10:13:06 +00003574 NULLPtr, ClassMethodList, NULLPtr, NULLPtr,
3575 GeneratePropertyList(OID, ClassDecl, true), ZeroPtr, ZeroPtr, true);
Rafael Espindolab7350042018-03-01 00:35:47 +00003576 CGM.setGVProperties(cast<llvm::GlobalValue>(MetaClassStruct),
3577 OID->getClassInterface());
Daniel Dunbar566421c2009-05-04 15:31:17 +00003578
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003579 // Generate the class structure
Saleem Abdulrasoola088ad92016-07-17 22:27:41 +00003580 llvm::Constant *ClassStruct = GenerateClassStructure(
3581 MetaClassStruct, SuperClass, 0x11L, ClassName.c_str(), nullptr,
3582 llvm::ConstantInt::get(LongTy, instanceSize), IvarList, MethodList,
3583 GenerateProtocolList(Protocols), IvarOffsetArray, Properties,
3584 StrongIvarBitmap, WeakIvarBitmap);
Rafael Espindolab7350042018-03-01 00:35:47 +00003585 CGM.setGVProperties(cast<llvm::GlobalValue>(ClassStruct),
3586 OID->getClassInterface());
Daniel Dunbar566421c2009-05-04 15:31:17 +00003587
3588 // Resolve the class aliases, if they exist.
3589 if (ClassPtrAlias) {
David Chisnall82f755c2010-11-09 11:21:43 +00003590 ClassPtrAlias->replaceAllUsesWith(
Owen Andersonade90fd2009-07-29 18:54:39 +00003591 llvm::ConstantExpr::getBitCast(ClassStruct, IdTy));
David Chisnall82f755c2010-11-09 11:21:43 +00003592 ClassPtrAlias->eraseFromParent();
Craig Topper8a13c412014-05-21 05:09:00 +00003593 ClassPtrAlias = nullptr;
Daniel Dunbar566421c2009-05-04 15:31:17 +00003594 }
3595 if (MetaClassPtrAlias) {
David Chisnall82f755c2010-11-09 11:21:43 +00003596 MetaClassPtrAlias->replaceAllUsesWith(
Owen Andersonade90fd2009-07-29 18:54:39 +00003597 llvm::ConstantExpr::getBitCast(MetaClassStruct, IdTy));
David Chisnall82f755c2010-11-09 11:21:43 +00003598 MetaClassPtrAlias->eraseFromParent();
Craig Topper8a13c412014-05-21 05:09:00 +00003599 MetaClassPtrAlias = nullptr;
Daniel Dunbar566421c2009-05-04 15:31:17 +00003600 }
3601
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003602 // Add class structure to list to be added to the symtab later
Owen Andersonade90fd2009-07-29 18:54:39 +00003603 ClassStruct = llvm::ConstantExpr::getBitCast(ClassStruct, PtrToInt8Ty);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003604 Classes.push_back(ClassStruct);
3605}
3606
Mike Stump11289f42009-09-09 15:08:12 +00003607llvm::Function *CGObjCGNU::ModuleInitFunction() {
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003608 // Only emit an ObjC load function if no Objective-C stuff has been called
3609 if (Classes.empty() && Categories.empty() && ConstantStrings.empty() &&
David Chisnalld7972f52011-03-23 16:36:54 +00003610 ExistingProtocols.empty() && SelectorTable.empty())
Craig Topper8a13c412014-05-21 05:09:00 +00003611 return nullptr;
Eli Friedman412c6682008-06-01 16:00:02 +00003612
Fariborz Jahanian2cde2032009-09-10 21:48:21 +00003613 // Add all referenced protocols to a category.
3614 GenerateProtocolHolderCategory();
3615
John McCallecee86f2016-11-30 20:19:46 +00003616 llvm::StructType *selStructTy =
3617 dyn_cast<llvm::StructType>(SelectorTy->getElementType());
3618 llvm::Type *selStructPtrTy = SelectorTy;
3619 if (!selStructTy) {
3620 selStructTy = llvm::StructType::get(CGM.getLLVMContext(),
3621 { PtrToInt8Ty, PtrToInt8Ty });
3622 selStructPtrTy = llvm::PointerType::getUnqual(selStructTy);
Chris Lattner8d3f4a42009-01-27 05:06:01 +00003623 }
3624
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003625 // Generate statics list:
John McCallecee86f2016-11-30 20:19:46 +00003626 llvm::Constant *statics = NULLPtr;
Alexander Kornienko6ee521c2015-01-23 15:36:10 +00003627 if (!ConstantStrings.empty()) {
John McCallecee86f2016-11-30 20:19:46 +00003628 llvm::GlobalVariable *fileStatics = [&] {
3629 ConstantInitBuilder builder(CGM);
3630 auto staticsStruct = builder.beginStruct();
David Chisnall5778fce2009-08-31 16:41:57 +00003631
John McCallecee86f2016-11-30 20:19:46 +00003632 StringRef stringClass = CGM.getLangOpts().ObjCConstantStringClass;
3633 if (stringClass.empty()) stringClass = "NXConstantString";
3634 staticsStruct.add(MakeConstantString(stringClass,
3635 ".objc_static_class_name"));
David Chisnalld7972f52011-03-23 16:36:54 +00003636
John McCallecee86f2016-11-30 20:19:46 +00003637 auto array = staticsStruct.beginArray();
3638 array.addAll(ConstantStrings);
3639 array.add(NULLPtr);
3640 array.finishAndAddTo(staticsStruct);
David Chisnalld7972f52011-03-23 16:36:54 +00003641
John McCallecee86f2016-11-30 20:19:46 +00003642 return staticsStruct.finishAndCreateGlobal(".objc_statics",
3643 CGM.getPointerAlign());
3644 }();
3645
3646 ConstantInitBuilder builder(CGM);
3647 auto allStaticsArray = builder.beginArray(fileStatics->getType());
3648 allStaticsArray.add(fileStatics);
3649 allStaticsArray.addNullPointer(fileStatics->getType());
3650
3651 statics = allStaticsArray.finishAndCreateGlobal(".objc_statics_ptr",
3652 CGM.getPointerAlign());
3653 statics = llvm::ConstantExpr::getBitCast(statics, PtrTy);
Chris Lattnerc06ce0f2009-04-25 23:19:45 +00003654 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003655
John McCallecee86f2016-11-30 20:19:46 +00003656 // Array of classes, categories, and constant objects.
3657
3658 SmallVector<llvm::GlobalAlias*, 16> selectorAliases;
3659 unsigned selectorCount;
3660
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003661 // Pointer to an array of selectors used in this module.
John McCallecee86f2016-11-30 20:19:46 +00003662 llvm::GlobalVariable *selectorList = [&] {
3663 ConstantInitBuilder builder(CGM);
3664 auto selectors = builder.beginArray(selStructTy);
John McCallf00e2c02016-11-30 20:46:55 +00003665 auto &table = SelectorTable; // MSVC workaround
David Chisnallc66d4802018-08-14 10:05:25 +00003666 std::vector<Selector> allSelectors;
3667 for (auto &entry : table)
3668 allSelectors.push_back(entry.first);
Fangrui Song55fab262018-09-26 22:16:28 +00003669 llvm::sort(allSelectors);
David Chisnalld7972f52011-03-23 16:36:54 +00003670
David Chisnallc66d4802018-08-14 10:05:25 +00003671 for (auto &untypedSel : allSelectors) {
3672 std::string selNameStr = untypedSel.getAsString();
John McCallecee86f2016-11-30 20:19:46 +00003673 llvm::Constant *selName = ExportUniqueString(selNameStr, ".objc_sel_name");
David Chisnalld7972f52011-03-23 16:36:54 +00003674
David Chisnallc66d4802018-08-14 10:05:25 +00003675 for (TypedSelector &sel : table[untypedSel]) {
John McCallecee86f2016-11-30 20:19:46 +00003676 llvm::Constant *selectorTypeEncoding = NULLPtr;
3677 if (!sel.first.empty())
3678 selectorTypeEncoding =
3679 MakeConstantString(sel.first, ".objc_sel_types");
David Chisnalld7972f52011-03-23 16:36:54 +00003680
John McCallecee86f2016-11-30 20:19:46 +00003681 auto selStruct = selectors.beginStruct(selStructTy);
3682 selStruct.add(selName);
3683 selStruct.add(selectorTypeEncoding);
3684 selStruct.finishAndAddTo(selectors);
David Chisnalld7972f52011-03-23 16:36:54 +00003685
John McCallecee86f2016-11-30 20:19:46 +00003686 // Store the selector alias for later replacement
3687 selectorAliases.push_back(sel.second);
3688 }
David Chisnalld7972f52011-03-23 16:36:54 +00003689 }
David Chisnalld7972f52011-03-23 16:36:54 +00003690
John McCallecee86f2016-11-30 20:19:46 +00003691 // Remember the number of entries in the selector table.
3692 selectorCount = selectors.size();
3693
3694 // NULL-terminate the selector list. This should not actually be required,
3695 // because the selector list has a length field. Unfortunately, the GCC
3696 // runtime decides to ignore the length field and expects a NULL terminator,
3697 // and GCC cooperates with this by always setting the length to 0.
3698 auto selStruct = selectors.beginStruct(selStructTy);
3699 selStruct.add(NULLPtr);
3700 selStruct.add(NULLPtr);
3701 selStruct.finishAndAddTo(selectors);
3702
3703 return selectors.finishAndCreateGlobal(".objc_selector_list",
3704 CGM.getPointerAlign());
3705 }();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003706
3707 // Now that all of the static selectors exist, create pointers to them.
John McCallecee86f2016-11-30 20:19:46 +00003708 for (unsigned i = 0; i < selectorCount; ++i) {
3709 llvm::Constant *idxs[] = {
3710 Zeros[0],
3711 llvm::ConstantInt::get(Int32Ty, i)
3712 };
David Chisnalld7972f52011-03-23 16:36:54 +00003713 // FIXME: We're generating redundant loads and stores here!
John McCallecee86f2016-11-30 20:19:46 +00003714 llvm::Constant *selPtr = llvm::ConstantExpr::getGetElementPtr(
3715 selectorList->getValueType(), selectorList, idxs);
Chris Lattner8d3f4a42009-01-27 05:06:01 +00003716 // If selectors are defined as an opaque type, cast the pointer to this
3717 // type.
John McCallecee86f2016-11-30 20:19:46 +00003718 selPtr = llvm::ConstantExpr::getBitCast(selPtr, SelectorTy);
3719 selectorAliases[i]->replaceAllUsesWith(selPtr);
3720 selectorAliases[i]->eraseFromParent();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003721 }
David Chisnalld7972f52011-03-23 16:36:54 +00003722
John McCallecee86f2016-11-30 20:19:46 +00003723 llvm::GlobalVariable *symtab = [&] {
3724 ConstantInitBuilder builder(CGM);
3725 auto symtab = builder.beginStruct();
3726
3727 // Number of static selectors
3728 symtab.addInt(LongTy, selectorCount);
3729
3730 symtab.addBitCast(selectorList, selStructPtrTy);
3731
3732 // Number of classes defined.
3733 symtab.addInt(CGM.Int16Ty, Classes.size());
3734 // Number of categories defined
3735 symtab.addInt(CGM.Int16Ty, Categories.size());
3736
3737 // Create an array of classes, then categories, then static object instances
3738 auto classList = symtab.beginArray(PtrToInt8Ty);
3739 classList.addAll(Classes);
3740 classList.addAll(Categories);
3741 // NULL-terminated list of static object instances (mainly constant strings)
3742 classList.add(statics);
3743 classList.add(NULLPtr);
3744 classList.finishAndAddTo(symtab);
3745
3746 // Construct the symbol table.
3747 return symtab.finishAndCreateGlobal("", CGM.getPointerAlign());
3748 }();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003749
3750 // The symbol table is contained in a module which has some version-checking
3751 // constants
John McCallecee86f2016-11-30 20:19:46 +00003752 llvm::Constant *module = [&] {
3753 llvm::Type *moduleEltTys[] = {
3754 LongTy, LongTy, PtrToInt8Ty, symtab->getType(), IntTy
3755 };
3756 llvm::StructType *moduleTy =
3757 llvm::StructType::get(CGM.getLLVMContext(),
3758 makeArrayRef(moduleEltTys).drop_back(unsigned(RuntimeVersion < 10)));
David Chisnalld7972f52011-03-23 16:36:54 +00003759
John McCallecee86f2016-11-30 20:19:46 +00003760 ConstantInitBuilder builder(CGM);
3761 auto module = builder.beginStruct(moduleTy);
3762 // Runtime version, used for ABI compatibility checking.
3763 module.addInt(LongTy, RuntimeVersion);
3764 // sizeof(ModuleTy)
3765 module.addInt(LongTy, CGM.getDataLayout().getTypeStoreSize(moduleTy));
3766
3767 // The path to the source file where this module was declared
3768 SourceManager &SM = CGM.getContext().getSourceManager();
3769 const FileEntry *mainFile = SM.getFileEntryForID(SM.getMainFileID());
3770 std::string path =
Mehdi Amini004b9c72016-10-10 22:52:47 +00003771 (Twine(mainFile->getDir()->getName()) + "/" + mainFile->getName()).str();
John McCallecee86f2016-11-30 20:19:46 +00003772 module.add(MakeConstantString(path, ".objc_source_file_name"));
3773 module.add(symtab);
David Chisnall5c511772011-05-22 22:37:08 +00003774
John McCallecee86f2016-11-30 20:19:46 +00003775 if (RuntimeVersion >= 10) {
3776 switch (CGM.getLangOpts().getGC()) {
David Chisnalla918b882011-07-07 11:22:31 +00003777 case LangOptions::GCOnly:
John McCallecee86f2016-11-30 20:19:46 +00003778 module.addInt(IntTy, 2);
David Chisnall5c511772011-05-22 22:37:08 +00003779 break;
David Chisnalla918b882011-07-07 11:22:31 +00003780 case LangOptions::NonGC:
David Blaikiebbafb8a2012-03-11 07:00:24 +00003781 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallecee86f2016-11-30 20:19:46 +00003782 module.addInt(IntTy, 1);
David Chisnalla918b882011-07-07 11:22:31 +00003783 else
John McCallecee86f2016-11-30 20:19:46 +00003784 module.addInt(IntTy, 0);
David Chisnalla918b882011-07-07 11:22:31 +00003785 break;
3786 case LangOptions::HybridGC:
John McCallecee86f2016-11-30 20:19:46 +00003787 module.addInt(IntTy, 1);
David Chisnalla918b882011-07-07 11:22:31 +00003788 break;
John McCallecee86f2016-11-30 20:19:46 +00003789 }
David Chisnalla918b882011-07-07 11:22:31 +00003790 }
David Chisnall5c511772011-05-22 22:37:08 +00003791
John McCallecee86f2016-11-30 20:19:46 +00003792 return module.finishAndCreateGlobal("", CGM.getPointerAlign());
3793 }();
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003794
3795 // Create the load function calling the runtime entry point with the module
3796 // structure
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003797 llvm::Function * LoadFunction = llvm::Function::Create(
Owen Anderson41a75022009-08-13 21:57:51 +00003798 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext), false),
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003799 llvm::GlobalValue::InternalLinkage, ".objc_load_function",
3800 &TheModule);
Owen Anderson41a75022009-08-13 21:57:51 +00003801 llvm::BasicBlock *EntryBB =
3802 llvm::BasicBlock::Create(VMContext, "entry", LoadFunction);
John McCall7f416cc2015-09-08 08:05:57 +00003803 CGBuilderTy Builder(CGM, VMContext);
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003804 Builder.SetInsertPoint(EntryBB);
Fariborz Jahanian3b636c12009-03-30 18:02:14 +00003805
Benjamin Kramerdf1fb132011-05-28 14:26:31 +00003806 llvm::FunctionType *FT =
John McCallecee86f2016-11-30 20:19:46 +00003807 llvm::FunctionType::get(Builder.getVoidTy(), module->getType(), true);
James Y Knight9871db02019-02-05 16:42:33 +00003808 llvm::FunctionCallee Register =
3809 CGM.CreateRuntimeFunction(FT, "__objc_exec_class");
John McCallecee86f2016-11-30 20:19:46 +00003810 Builder.CreateCall(Register, module);
David Chisnall92d436b2012-01-31 18:59:20 +00003811
David Chisnallaf066bbb2012-02-01 19:16:56 +00003812 if (!ClassAliases.empty()) {
David Chisnall92d436b2012-01-31 18:59:20 +00003813 llvm::Type *ArgTypes[2] = {PtrTy, PtrToInt8Ty};
3814 llvm::FunctionType *RegisterAliasTy =
3815 llvm::FunctionType::get(Builder.getVoidTy(),
3816 ArgTypes, false);
3817 llvm::Function *RegisterAlias = llvm::Function::Create(
3818 RegisterAliasTy,
3819 llvm::GlobalValue::ExternalWeakLinkage, "class_registerAlias_np",
3820 &TheModule);
3821 llvm::BasicBlock *AliasBB =
3822 llvm::BasicBlock::Create(VMContext, "alias", LoadFunction);
3823 llvm::BasicBlock *NoAliasBB =
3824 llvm::BasicBlock::Create(VMContext, "no_alias", LoadFunction);
3825
3826 // Branch based on whether the runtime provided class_registerAlias_np()
3827 llvm::Value *HasRegisterAlias = Builder.CreateICmpNE(RegisterAlias,
3828 llvm::Constant::getNullValue(RegisterAlias->getType()));
3829 Builder.CreateCondBr(HasRegisterAlias, AliasBB, NoAliasBB);
3830
Alp Tokerf6a24ce2013-12-05 16:25:25 +00003831 // The true branch (has alias registration function):
David Chisnall92d436b2012-01-31 18:59:20 +00003832 Builder.SetInsertPoint(AliasBB);
3833 // Emit alias registration calls:
3834 for (std::vector<ClassAliasPair>::iterator iter = ClassAliases.begin();
3835 iter != ClassAliases.end(); ++iter) {
3836 llvm::Constant *TheClass =
Malcolm Parsonsf76f6502016-11-02 10:39:27 +00003837 TheModule.getGlobalVariable("_OBJC_CLASS_" + iter->first, true);
Craig Topper8a13c412014-05-21 05:09:00 +00003838 if (TheClass) {
David Chisnall92d436b2012-01-31 18:59:20 +00003839 TheClass = llvm::ConstantExpr::getBitCast(TheClass, PtrTy);
David Blaikie43f9bb72015-05-18 22:14:03 +00003840 Builder.CreateCall(RegisterAlias,
3841 {TheClass, MakeConstantString(iter->second)});
David Chisnall92d436b2012-01-31 18:59:20 +00003842 }
3843 }
3844 // Jump to end:
3845 Builder.CreateBr(NoAliasBB);
3846
3847 // Missing alias registration function, just return from the function:
3848 Builder.SetInsertPoint(NoAliasBB);
3849 }
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003850 Builder.CreateRetVoid();
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00003851
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003852 return LoadFunction;
3853}
Daniel Dunbar92992502008-08-15 22:20:32 +00003854
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00003855llvm::Function *CGObjCGNU::GenerateMethod(const ObjCMethodDecl *OMD,
Mike Stump11289f42009-09-09 15:08:12 +00003856 const ObjCContainerDecl *CD) {
3857 const ObjCCategoryImplDecl *OCD =
Steve Naroff11b387f2009-01-08 19:41:02 +00003858 dyn_cast<ObjCCategoryImplDecl>(OMD->getDeclContext());
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003859 StringRef CategoryName = OCD ? OCD->getName() : "";
3860 StringRef ClassName = CD->getName();
David Chisnalld7972f52011-03-23 16:36:54 +00003861 Selector MethodName = OMD->getSelector();
Douglas Gregorffca3a22009-01-09 17:18:27 +00003862 bool isClassMethod = !OMD->isInstanceMethod();
Daniel Dunbar92992502008-08-15 22:20:32 +00003863
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00003864 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00003865 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00003866 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Anton Korobeynikov1200aca2008-06-01 14:13:53 +00003867 std::string FunctionName = SymbolNameForMethod(ClassName, CategoryName,
3868 MethodName, isClassMethod);
3869
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00003870 llvm::Function *Method
Mike Stump11289f42009-09-09 15:08:12 +00003871 = llvm::Function::Create(MethodTy,
3872 llvm::GlobalValue::InternalLinkage,
3873 FunctionName,
3874 &TheModule);
Chris Lattner4bd55962008-03-30 23:03:07 +00003875 return Method;
3876}
3877
Pierre Habouzitd4e1ba32019-11-07 23:14:58 -08003878void CGObjCGNU::GenerateDirectMethodPrologue(CodeGenFunction &CGF,
3879 llvm::Function *Fn,
3880 const ObjCMethodDecl *OMD,
3881 const ObjCContainerDecl *CD) {
3882 // GNU runtime doesn't support direct calls at this time
3883}
3884
James Y Knight9871db02019-02-05 16:42:33 +00003885llvm::FunctionCallee CGObjCGNU::GetPropertyGetFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00003886 return GetPropertyFn;
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003887}
3888
James Y Knight9871db02019-02-05 16:42:33 +00003889llvm::FunctionCallee CGObjCGNU::GetPropertySetFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00003890 return SetPropertyFn;
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003891}
3892
James Y Knight9871db02019-02-05 16:42:33 +00003893llvm::FunctionCallee CGObjCGNU::GetOptimizedPropertySetFunction(bool atomic,
3894 bool copy) {
Craig Topper8a13c412014-05-21 05:09:00 +00003895 return nullptr;
Ted Kremeneke65b0862012-03-06 20:05:56 +00003896}
3897
James Y Knight9871db02019-02-05 16:42:33 +00003898llvm::FunctionCallee CGObjCGNU::GetGetStructFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00003899 return GetStructPropertyFn;
David Chisnall168b80f2010-12-26 22:13:16 +00003900}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003901
James Y Knight9871db02019-02-05 16:42:33 +00003902llvm::FunctionCallee CGObjCGNU::GetSetStructFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00003903 return SetStructPropertyFn;
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00003904}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003905
James Y Knight9871db02019-02-05 16:42:33 +00003906llvm::FunctionCallee CGObjCGNU::GetCppAtomicObjectGetFunction() {
Craig Topper8a13c412014-05-21 05:09:00 +00003907 return nullptr;
David Chisnall0d75e062012-12-17 18:54:24 +00003908}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003909
James Y Knight9871db02019-02-05 16:42:33 +00003910llvm::FunctionCallee CGObjCGNU::GetCppAtomicObjectSetFunction() {
Craig Topper8a13c412014-05-21 05:09:00 +00003911 return nullptr;
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00003912}
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00003913
James Y Knight9871db02019-02-05 16:42:33 +00003914llvm::FunctionCallee CGObjCGNU::EnumerationMutationFunction() {
David Chisnalld7972f52011-03-23 16:36:54 +00003915 return EnumerationMutationFn;
Anders Carlsson3f35a262008-08-31 04:05:03 +00003916}
3917
David Chisnalld7972f52011-03-23 16:36:54 +00003918void CGObjCGNU::EmitSynchronizedStmt(CodeGenFunction &CGF,
John McCallbd309292010-07-06 01:34:17 +00003919 const ObjCAtSynchronizedStmt &S) {
David Chisnalld3858d62011-03-25 11:57:33 +00003920 EmitAtSynchronizedStmt(CGF, S, SyncEnterFn, SyncExitFn);
John McCallbd309292010-07-06 01:34:17 +00003921}
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00003922
David Chisnall3a509cd2009-12-24 02:26:34 +00003923
David Chisnalld7972f52011-03-23 16:36:54 +00003924void CGObjCGNU::EmitTryStmt(CodeGenFunction &CGF,
John McCallbd309292010-07-06 01:34:17 +00003925 const ObjCAtTryStmt &S) {
3926 // Unlike the Apple non-fragile runtimes, which also uses
3927 // unwind-based zero cost exceptions, the GNU Objective C runtime's
3928 // EH support isn't a veneer over C++ EH. Instead, exception
David Chisnall9a837be2012-11-07 16:50:40 +00003929 // objects are created by objc_exception_throw and destroyed by
John McCallbd309292010-07-06 01:34:17 +00003930 // the personality function; this avoids the need for bracketing
3931 // catch handlers with calls to __blah_begin_catch/__blah_end_catch
3932 // (or even _Unwind_DeleteException), but probably doesn't
3933 // interoperate very well with foreign exceptions.
David Chisnalld3858d62011-03-25 11:57:33 +00003934 //
David Chisnalle1d2584d2011-03-20 21:35:39 +00003935 // In Objective-C++ mode, we actually emit something equivalent to the C++
Fangrui Song6907ce22018-07-30 19:24:48 +00003936 // exception handler.
David Chisnalld3858d62011-03-25 11:57:33 +00003937 EmitTryCatchStmt(CGF, S, EnterCatchFn, ExitCatchFn, ExceptionReThrowFn);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00003938}
3939
David Chisnalld7972f52011-03-23 16:36:54 +00003940void CGObjCGNU::EmitThrowStmt(CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00003941 const ObjCAtThrowStmt &S,
3942 bool ClearInsertionPoint) {
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00003943 llvm::Value *ExceptionAsObject;
David Chisnall93ce0182018-08-10 12:53:13 +00003944 bool isRethrow = false;
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00003945
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00003946 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00003947 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Fariborz Jahanian078cd522009-05-17 16:49:27 +00003948 ExceptionAsObject = Exception;
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00003949 } else {
Mike Stump11289f42009-09-09 15:08:12 +00003950 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00003951 "Unexpected rethrow outside @catch block.");
3952 ExceptionAsObject = CGF.ObjCEHValueStack.back();
David Chisnall93ce0182018-08-10 12:53:13 +00003953 isRethrow = true;
Chris Lattnerb6e9eb62009-05-08 00:11:50 +00003954 }
David Chisnall93ce0182018-08-10 12:53:13 +00003955 if (isRethrow && usesSEHExceptions) {
3956 // For SEH, ExceptionAsObject may be undef, because the catch handler is
3957 // not passed it for catchalls and so it is not visible to the catch
3958 // funclet. The real thrown object will still be live on the stack at this
3959 // point and will be rethrown. If we are explicitly rethrowing the object
3960 // that was passed into the `@catch` block, then this code path is not
3961 // reached and we will instead call `objc_exception_throw` with an explicit
3962 // argument.
James Y Knight3933add2019-01-30 02:54:28 +00003963 llvm::CallBase *Throw = CGF.EmitRuntimeCallOrInvoke(ExceptionReThrowFn);
3964 Throw->setDoesNotReturn();
David Chisnall93ce0182018-08-10 12:53:13 +00003965 }
3966 else {
3967 ExceptionAsObject = CGF.Builder.CreateBitCast(ExceptionAsObject, IdTy);
James Y Knight3933add2019-01-30 02:54:28 +00003968 llvm::CallBase *Throw =
David Chisnall93ce0182018-08-10 12:53:13 +00003969 CGF.EmitRuntimeCallOrInvoke(ExceptionThrowFn, ExceptionAsObject);
James Y Knight3933add2019-01-30 02:54:28 +00003970 Throw->setDoesNotReturn();
David Chisnall93ce0182018-08-10 12:53:13 +00003971 }
Eli Friedmandc009da2012-08-10 21:26:17 +00003972 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00003973 if (ClearInsertionPoint)
3974 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00003975}
3976
David Chisnalld7972f52011-03-23 16:36:54 +00003977llvm::Value * CGObjCGNU::EmitObjCWeakRead(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00003978 Address AddrWeakObj) {
John McCall882987f2013-02-28 19:01:20 +00003979 CGBuilderTy &B = CGF.Builder;
David Chisnallfcb37e92011-05-30 12:00:26 +00003980 AddrWeakObj = EnforceType(B, AddrWeakObj, PtrToIdTy);
James Y Knight9871db02019-02-05 16:42:33 +00003981 return B.CreateCall(WeakReadFn, AddrWeakObj.getPointer());
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00003982}
3983
David Chisnalld7972f52011-03-23 16:36:54 +00003984void CGObjCGNU::EmitObjCWeakAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00003985 llvm::Value *src, Address dst) {
John McCall882987f2013-02-28 19:01:20 +00003986 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00003987 src = EnforceType(B, src, IdTy);
3988 dst = EnforceType(B, dst, PtrToIdTy);
James Y Knight9871db02019-02-05 16:42:33 +00003989 B.CreateCall(WeakAssignFn, {src, dst.getPointer()});
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00003990}
3991
David Chisnalld7972f52011-03-23 16:36:54 +00003992void CGObjCGNU::EmitObjCGlobalAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00003993 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00003994 bool threadlocal) {
John McCall882987f2013-02-28 19:01:20 +00003995 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00003996 src = EnforceType(B, src, IdTy);
3997 dst = EnforceType(B, dst, PtrToIdTy);
David Blaikie43f9bb72015-05-18 22:14:03 +00003998 // FIXME. Add threadloca assign API
3999 assert(!threadlocal && "EmitObjCGlobalAssign - Threal Local API NYI");
James Y Knight9871db02019-02-05 16:42:33 +00004000 B.CreateCall(GlobalAssignFn, {src, dst.getPointer()});
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004001}
4002
David Chisnalld7972f52011-03-23 16:36:54 +00004003void CGObjCGNU::EmitObjCIvarAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004004 llvm::Value *src, Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004005 llvm::Value *ivarOffset) {
John McCall882987f2013-02-28 19:01:20 +00004006 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00004007 src = EnforceType(B, src, IdTy);
David Chisnalle4e5c0f2011-05-25 20:33:17 +00004008 dst = EnforceType(B, dst, IdTy);
James Y Knight9871db02019-02-05 16:42:33 +00004009 B.CreateCall(IvarAssignFn, {src, dst.getPointer(), ivarOffset});
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004010}
4011
David Chisnalld7972f52011-03-23 16:36:54 +00004012void CGObjCGNU::EmitObjCStrongCastAssign(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004013 llvm::Value *src, Address dst) {
John McCall882987f2013-02-28 19:01:20 +00004014 CGBuilderTy &B = CGF.Builder;
David Chisnall5bb4efd2010-02-03 15:59:02 +00004015 src = EnforceType(B, src, IdTy);
4016 dst = EnforceType(B, dst, PtrToIdTy);
James Y Knight9871db02019-02-05 16:42:33 +00004017 B.CreateCall(StrongCastAssignFn, {src, dst.getPointer()});
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004018}
4019
David Chisnalld7972f52011-03-23 16:36:54 +00004020void CGObjCGNU::EmitGCMemmoveCollectable(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004021 Address DestPtr,
4022 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00004023 llvm::Value *Size) {
John McCall882987f2013-02-28 19:01:20 +00004024 CGBuilderTy &B = CGF.Builder;
David Chisnall7441d882011-05-28 14:23:43 +00004025 DestPtr = EnforceType(B, DestPtr, PtrTy);
4026 SrcPtr = EnforceType(B, SrcPtr, PtrTy);
David Chisnall5bb4efd2010-02-03 15:59:02 +00004027
James Y Knight9871db02019-02-05 16:42:33 +00004028 B.CreateCall(MemMoveFn, {DestPtr.getPointer(), SrcPtr.getPointer(), Size});
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004029}
4030
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00004031llvm::GlobalVariable *CGObjCGNU::ObjCIvarOffsetVariable(
4032 const ObjCInterfaceDecl *ID,
4033 const ObjCIvarDecl *Ivar) {
David Chisnall404bbcb2018-05-22 10:13:06 +00004034 const std::string Name = GetIVarOffsetVariableName(ID, Ivar);
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00004035 // Emit the variable and initialize it with what we think the correct value
4036 // is. This allows code compiled with non-fragile ivars to work correctly
4037 // when linked against code which isn't (most of the time).
David Chisnall5778fce2009-08-31 16:41:57 +00004038 llvm::GlobalVariable *IvarOffsetPointer = TheModule.getNamedGlobal(Name);
David Chisnall9e310362018-08-07 12:02:46 +00004039 if (!IvarOffsetPointer)
4040 IvarOffsetPointer = new llvm::GlobalVariable(TheModule,
4041 llvm::Type::getInt32PtrTy(VMContext), false,
4042 llvm::GlobalValue::ExternalLinkage, nullptr, Name);
David Chisnall5778fce2009-08-31 16:41:57 +00004043 return IvarOffsetPointer;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00004044}
4045
David Chisnalld7972f52011-03-23 16:36:54 +00004046LValue CGObjCGNU::EmitObjCValueForIvar(CodeGenFunction &CGF,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004047 QualType ObjectTy,
4048 llvm::Value *BaseValue,
4049 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004050 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00004051 const ObjCInterfaceDecl *ID =
Simon Pilgrim7e38f0c2019-10-07 16:42:25 +00004052 ObjectTy->castAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00004053 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
4054 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004055}
Mike Stumpdd93a192009-07-31 21:31:32 +00004056
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00004057static const ObjCInterfaceDecl *FindIvarInterface(ASTContext &Context,
4058 const ObjCInterfaceDecl *OID,
4059 const ObjCIvarDecl *OIVD) {
Jordy Rosea91768e2011-07-22 02:08:32 +00004060 for (const ObjCIvarDecl *next = OID->all_declared_ivar_begin(); next;
4061 next = next->getNextIvar()) {
4062 if (OIVD == next)
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00004063 return OID;
4064 }
Mike Stump11289f42009-09-09 15:08:12 +00004065
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00004066 // Otherwise check in the super class.
4067 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
4068 return FindIvarInterface(Context, Super, OIVD);
Mike Stump11289f42009-09-09 15:08:12 +00004069
Craig Topper8a13c412014-05-21 05:09:00 +00004070 return nullptr;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00004071}
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004072
David Chisnalld7972f52011-03-23 16:36:54 +00004073llvm::Value *CGObjCGNU::EmitIvarOffset(CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00004074 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004075 const ObjCIvarDecl *Ivar) {
John McCall5fb5df92012-06-20 06:18:46 +00004076 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00004077 Interface = FindIvarInterface(CGM.getContext(), Interface, Ivar);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00004078
4079 // The MSVC linker cannot have a single global defined as LinkOnceAnyLinkage
4080 // and ExternalLinkage, so create a reference to the ivar global and rely on
4081 // the definition being created as part of GenerateClass.
4082 if (RuntimeVersion < 10 ||
4083 CGF.CGM.getTarget().getTriple().isKnownWindowsMSVCEnvironment())
David Chisnall1bfe6d32011-07-07 12:34:51 +00004084 return CGF.Builder.CreateZExtOrBitCast(
Peter Collingbourneb367c562016-11-28 22:30:21 +00004085 CGF.Builder.CreateAlignedLoad(
4086 Int32Ty, CGF.Builder.CreateAlignedLoad(
4087 ObjCIvarOffsetVariable(Interface, Ivar),
4088 CGF.getPointerAlign(), "ivar"),
4089 CharUnits::fromQuantity(4)),
David Chisnall1bfe6d32011-07-07 12:34:51 +00004090 PtrDiffTy);
4091 std::string name = "__objc_ivar_offset_value_" +
4092 Interface->getNameAsString() +"." + Ivar->getNameAsString();
John McCall7f416cc2015-09-08 08:05:57 +00004093 CharUnits Align = CGM.getIntAlign();
David Chisnall1bfe6d32011-07-07 12:34:51 +00004094 llvm::Value *Offset = TheModule.getGlobalVariable(name);
John McCall7f416cc2015-09-08 08:05:57 +00004095 if (!Offset) {
4096 auto GV = new llvm::GlobalVariable(TheModule, IntTy,
David Chisnall28dc7f92011-08-01 17:36:53 +00004097 false, llvm::GlobalValue::LinkOnceAnyLinkage,
4098 llvm::Constant::getNullValue(IntTy), name);
Guillaume Chateletc79099e2019-10-03 13:00:29 +00004099 GV->setAlignment(Align.getAsAlign());
John McCall7f416cc2015-09-08 08:05:57 +00004100 Offset = GV;
4101 }
4102 Offset = CGF.Builder.CreateAlignedLoad(Offset, Align);
David Chisnalla79b4692012-04-06 15:39:12 +00004103 if (Offset->getType() != PtrDiffTy)
4104 Offset = CGF.Builder.CreateZExtOrBitCast(Offset, PtrDiffTy);
4105 return Offset;
Fariborz Jahaniand20a03f2009-05-20 18:41:51 +00004106 }
Eli Friedman8cbca202012-11-06 22:15:52 +00004107 uint64_t Offset = ComputeIvarBaseOffset(CGF.CGM, Interface, Ivar);
4108 return llvm::ConstantInt::get(PtrDiffTy, Offset, /*isSigned*/true);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004109}
4110
David Chisnalld7972f52011-03-23 16:36:54 +00004111CGObjCRuntime *
4112clang::CodeGen::CreateGNUObjCRuntime(CodeGenModule &CGM) {
David Chisnall404bbcb2018-05-22 10:13:06 +00004113 auto Runtime = CGM.getLangOpts().ObjCRuntime;
4114 switch (Runtime.getKind()) {
David Chisnallb601c962012-07-03 20:49:52 +00004115 case ObjCRuntime::GNUstep:
David Chisnall404bbcb2018-05-22 10:13:06 +00004116 if (Runtime.getVersion() >= VersionTuple(2, 0))
4117 return new CGObjCGNUstep2(CGM);
David Chisnalld7972f52011-03-23 16:36:54 +00004118 return new CGObjCGNUstep(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00004119
David Chisnallb601c962012-07-03 20:49:52 +00004120 case ObjCRuntime::GCC:
John McCall5fb5df92012-06-20 06:18:46 +00004121 return new CGObjCGCC(CGM);
4122
John McCall775086e2012-07-12 02:07:58 +00004123 case ObjCRuntime::ObjFW:
4124 return new CGObjCObjFW(CGM);
4125
John McCall5fb5df92012-06-20 06:18:46 +00004126 case ObjCRuntime::FragileMacOSX:
4127 case ObjCRuntime::MacOSX:
4128 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +00004129 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +00004130 llvm_unreachable("these runtimes are not GNU runtimes");
4131 }
4132 llvm_unreachable("bad runtime");
Chris Lattnerb7256cd2008-03-01 08:50:34 +00004133}