1 //===------- CGObjCGNU.cpp - Emit LLVM Code from ASTs for a Module --------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This provides Objective-C code generation targeting the GNU runtime. The
11 // class in this file generates structures used by the GNU Objective-C runtime
12 // library. These structures are defined in objc/objc.h and objc/objc-api.h in
13 // the GNU runtime distribution.
15 //===----------------------------------------------------------------------===//
17 #include "CGObjCRuntime.h"
18 #include "CGCleanup.h"
19 #include "CodeGenFunction.h"
20 #include "CodeGenModule.h"
21 #include "clang/AST/ASTContext.h"
22 #include "clang/AST/Decl.h"
23 #include "clang/AST/DeclObjC.h"
24 #include "clang/AST/RecordLayout.h"
25 #include "clang/AST/StmtObjC.h"
26 #include "clang/Basic/FileManager.h"
27 #include "clang/Basic/SourceManager.h"
28 #include "llvm/ADT/SmallVector.h"
29 #include "llvm/ADT/StringMap.h"
30 #include "llvm/IR/CallSite.h"
31 #include "llvm/IR/DataLayout.h"
32 #include "llvm/IR/Intrinsics.h"
33 #include "llvm/IR/LLVMContext.h"
34 #include "llvm/IR/Module.h"
35 #include "llvm/Support/Compiler.h"
39 using namespace clang;
40 using namespace CodeGen;
44 /// Class that lazily initialises the runtime function. Avoids inserting the
45 /// types and the function declaration into a module if they're not used, and
46 /// avoids constructing the type more than once if it's used more than once.
47 class LazyRuntimeFunction {
49 llvm::FunctionType *FTy;
50 const char *FunctionName;
51 llvm::Constant *Function;
54 /// Constructor leaves this class uninitialized, because it is intended to
55 /// be used as a field in another class and not all of the types that are
56 /// used as arguments will necessarily be available at construction time.
58 : CGM(nullptr), FunctionName(nullptr), Function(nullptr) {}
60 /// Initialises the lazy function with the name, return type, and the types
63 void init(CodeGenModule *Mod, const char *name, llvm::Type *RetTy, ...) {
67 std::vector<llvm::Type *> ArgTys;
69 va_start(Args, RetTy);
70 while (llvm::Type *ArgTy = va_arg(Args, llvm::Type *))
71 ArgTys.push_back(ArgTy);
73 FTy = llvm::FunctionType::get(RetTy, ArgTys, false);
76 llvm::FunctionType *getType() { return FTy; }
78 /// Overloaded cast operator, allows the class to be implicitly cast to an
80 operator llvm::Constant *() {
85 cast<llvm::Constant>(CGM->CreateRuntimeFunction(FTy, FunctionName));
89 operator llvm::Function *() {
90 return cast<llvm::Function>((llvm::Constant *)*this);
95 /// GNU Objective-C runtime code generation. This class implements the parts of
96 /// Objective-C support that are specific to the GNU family of runtimes (GCC,
97 /// GNUstep and ObjFW).
98 class CGObjCGNU : public CGObjCRuntime {
100 /// The LLVM module into which output is inserted
101 llvm::Module &TheModule;
102 /// strut objc_super. Used for sending messages to super. This structure
103 /// contains the receiver (object) and the expected class.
104 llvm::StructType *ObjCSuperTy;
105 /// struct objc_super*. The type of the argument to the superclass message
106 /// lookup functions.
107 llvm::PointerType *PtrToObjCSuperTy;
108 /// LLVM type for selectors. Opaque pointer (i8*) unless a header declaring
109 /// SEL is included in a header somewhere, in which case it will be whatever
110 /// type is declared in that header, most likely {i8*, i8*}.
111 llvm::PointerType *SelectorTy;
112 /// LLVM i8 type. Cached here to avoid repeatedly getting it in all of the
113 /// places where it's used
114 llvm::IntegerType *Int8Ty;
115 /// Pointer to i8 - LLVM type of char*, for all of the places where the
116 /// runtime needs to deal with C strings.
117 llvm::PointerType *PtrToInt8Ty;
118 /// Instance Method Pointer type. This is a pointer to a function that takes,
119 /// at a minimum, an object and a selector, and is the generic type for
120 /// Objective-C methods. Due to differences between variadic / non-variadic
121 /// calling conventions, it must always be cast to the correct type before
122 /// actually being used.
123 llvm::PointerType *IMPTy;
124 /// Type of an untyped Objective-C object. Clang treats id as a built-in type
125 /// when compiling Objective-C code, so this may be an opaque pointer (i8*),
126 /// but if the runtime header declaring it is included then it may be a
127 /// pointer to a structure.
128 llvm::PointerType *IdTy;
129 /// Pointer to a pointer to an Objective-C object. Used in the new ABI
130 /// message lookup function and some GC-related functions.
131 llvm::PointerType *PtrToIdTy;
132 /// The clang type of id. Used when using the clang CGCall infrastructure to
133 /// call Objective-C methods.
135 /// LLVM type for C int type.
136 llvm::IntegerType *IntTy;
137 /// LLVM type for an opaque pointer. This is identical to PtrToInt8Ty, but is
138 /// used in the code to document the difference between i8* meaning a pointer
139 /// to a C string and i8* meaning a pointer to some opaque type.
140 llvm::PointerType *PtrTy;
141 /// LLVM type for C long type. The runtime uses this in a lot of places where
142 /// it should be using intptr_t, but we can't fix this without breaking
143 /// compatibility with GCC...
144 llvm::IntegerType *LongTy;
145 /// LLVM type for C size_t. Used in various runtime data structures.
146 llvm::IntegerType *SizeTy;
147 /// LLVM type for C intptr_t.
148 llvm::IntegerType *IntPtrTy;
149 /// LLVM type for C ptrdiff_t. Mainly used in property accessor functions.
150 llvm::IntegerType *PtrDiffTy;
151 /// LLVM type for C int*. Used for GCC-ABI-compatible non-fragile instance
153 llvm::PointerType *PtrToIntTy;
154 /// LLVM type for Objective-C BOOL type.
156 /// 32-bit integer type, to save us needing to look it up every time it's used.
157 llvm::IntegerType *Int32Ty;
158 /// 64-bit integer type, to save us needing to look it up every time it's used.
159 llvm::IntegerType *Int64Ty;
160 /// Metadata kind used to tie method lookups to message sends. The GNUstep
161 /// runtime provides some LLVM passes that can use this to do things like
162 /// automatic IMP caching and speculative inlining.
163 unsigned msgSendMDKind;
164 /// Helper function that generates a constant string and returns a pointer to
165 /// the start of the string. The result of this function can be used anywhere
166 /// where the C code specifies const char*.
167 llvm::Constant *MakeConstantString(const std::string &Str,
168 const std::string &Name="") {
169 auto *ConstStr = CGM.GetAddrOfConstantCString(Str, Name.c_str());
170 return llvm::ConstantExpr::getGetElementPtr(ConstStr->getValueType(),
173 /// Emits a linkonce_odr string, whose name is the prefix followed by the
174 /// string value. This allows the linker to combine the strings between
175 /// different modules. Used for EH typeinfo names, selector strings, and a
176 /// few other things.
177 llvm::Constant *ExportUniqueString(const std::string &Str,
178 const std::string prefix) {
179 std::string name = prefix + Str;
180 auto *ConstStr = TheModule.getGlobalVariable(name);
182 llvm::Constant *value = llvm::ConstantDataArray::getString(VMContext,Str);
183 ConstStr = new llvm::GlobalVariable(TheModule, value->getType(), true,
184 llvm::GlobalValue::LinkOnceODRLinkage, value, prefix + Str);
186 return llvm::ConstantExpr::getGetElementPtr(ConstStr->getValueType(),
189 /// Generates a global structure, initialized by the elements in the vector.
190 /// The element types must match the types of the structure elements in the
192 llvm::GlobalVariable *MakeGlobal(llvm::StructType *Ty,
193 ArrayRef<llvm::Constant *> V,
195 llvm::GlobalValue::LinkageTypes linkage
196 =llvm::GlobalValue::InternalLinkage) {
197 llvm::Constant *C = llvm::ConstantStruct::get(Ty, V);
198 return new llvm::GlobalVariable(TheModule, Ty, false,
201 /// Generates a global array. The vector must contain the same number of
202 /// elements that the array type declares, of the type specified as the array
204 llvm::GlobalVariable *MakeGlobal(llvm::ArrayType *Ty,
205 ArrayRef<llvm::Constant *> V,
207 llvm::GlobalValue::LinkageTypes linkage
208 =llvm::GlobalValue::InternalLinkage) {
209 llvm::Constant *C = llvm::ConstantArray::get(Ty, V);
210 return new llvm::GlobalVariable(TheModule, Ty, false,
213 /// Generates a global array, inferring the array type from the specified
214 /// element type and the size of the initialiser.
215 llvm::GlobalVariable *MakeGlobalArray(llvm::Type *Ty,
216 ArrayRef<llvm::Constant *> V,
218 llvm::GlobalValue::LinkageTypes linkage
219 =llvm::GlobalValue::InternalLinkage) {
220 llvm::ArrayType *ArrayTy = llvm::ArrayType::get(Ty, V.size());
221 return MakeGlobal(ArrayTy, V, Name, linkage);
223 /// Returns a property name and encoding string.
224 llvm::Constant *MakePropertyEncodingString(const ObjCPropertyDecl *PD,
225 const Decl *Container) {
226 const ObjCRuntime &R = CGM.getLangOpts().ObjCRuntime;
227 if ((R.getKind() == ObjCRuntime::GNUstep) &&
228 (R.getVersion() >= VersionTuple(1, 6))) {
229 std::string NameAndAttributes;
231 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container, TypeStr);
232 NameAndAttributes += '\0';
233 NameAndAttributes += TypeStr.length() + 3;
234 NameAndAttributes += TypeStr;
235 NameAndAttributes += '\0';
236 NameAndAttributes += PD->getNameAsString();
237 auto *ConstStr = CGM.GetAddrOfConstantCString(NameAndAttributes);
238 return llvm::ConstantExpr::getGetElementPtr(ConstStr->getValueType(),
241 return MakeConstantString(PD->getNameAsString());
243 /// Push the property attributes into two structure fields.
244 void PushPropertyAttributes(std::vector<llvm::Constant*> &Fields,
245 ObjCPropertyDecl *property, bool isSynthesized=true, bool
247 int attrs = property->getPropertyAttributes();
248 // For read-only properties, clear the copy and retain flags
249 if (attrs & ObjCPropertyDecl::OBJC_PR_readonly) {
250 attrs &= ~ObjCPropertyDecl::OBJC_PR_copy;
251 attrs &= ~ObjCPropertyDecl::OBJC_PR_retain;
252 attrs &= ~ObjCPropertyDecl::OBJC_PR_weak;
253 attrs &= ~ObjCPropertyDecl::OBJC_PR_strong;
255 // The first flags field has the same attribute values as clang uses internally
256 Fields.push_back(llvm::ConstantInt::get(Int8Ty, attrs & 0xff));
259 // For protocol properties, synthesized and dynamic have no meaning, so we
260 // reuse these flags to indicate that this is a protocol property (both set
261 // has no meaning, as a property can't be both synthesized and dynamic)
262 attrs |= isSynthesized ? (1<<0) : 0;
263 attrs |= isDynamic ? (1<<1) : 0;
264 // The second field is the next four fields left shifted by two, with the
265 // low bit set to indicate whether the field is synthesized or dynamic.
266 Fields.push_back(llvm::ConstantInt::get(Int8Ty, attrs & 0xff));
267 // Two padding fields
268 Fields.push_back(llvm::ConstantInt::get(Int8Ty, 0));
269 Fields.push_back(llvm::ConstantInt::get(Int8Ty, 0));
271 /// Ensures that the value has the required type, by inserting a bitcast if
272 /// required. This function lets us avoid inserting bitcasts that are
274 llvm::Value* EnforceType(CGBuilderTy &B, llvm::Value *V, llvm::Type *Ty) {
275 if (V->getType() == Ty) return V;
276 return B.CreateBitCast(V, Ty);
278 // Some zeros used for GEPs in lots of places.
279 llvm::Constant *Zeros[2];
280 /// Null pointer value. Mainly used as a terminator in various arrays.
281 llvm::Constant *NULLPtr;
283 llvm::LLVMContext &VMContext;
285 /// Placeholder for the class. Lots of things refer to the class before we've
286 /// actually emitted it. We use this alias as a placeholder, and then replace
287 /// it with a pointer to the class structure before finally emitting the
289 llvm::GlobalAlias *ClassPtrAlias;
290 /// Placeholder for the metaclass. Lots of things refer to the class before
291 /// we've / actually emitted it. We use this alias as a placeholder, and then
292 /// replace / it with a pointer to the metaclass structure before finally
293 /// emitting the / module.
294 llvm::GlobalAlias *MetaClassPtrAlias;
295 /// All of the classes that have been generated for this compilation units.
296 std::vector<llvm::Constant*> Classes;
297 /// All of the categories that have been generated for this compilation units.
298 std::vector<llvm::Constant*> Categories;
299 /// All of the Objective-C constant strings that have been generated for this
300 /// compilation units.
301 std::vector<llvm::Constant*> ConstantStrings;
302 /// Map from string values to Objective-C constant strings in the output.
303 /// Used to prevent emitting Objective-C strings more than once. This should
304 /// not be required at all - CodeGenModule should manage this list.
305 llvm::StringMap<llvm::Constant*> ObjCStrings;
306 /// All of the protocols that have been declared.
307 llvm::StringMap<llvm::Constant*> ExistingProtocols;
308 /// For each variant of a selector, we store the type encoding and a
309 /// placeholder value. For an untyped selector, the type will be the empty
310 /// string. Selector references are all done via the module's selector table,
311 /// so we create an alias as a placeholder and then replace it with the real
313 typedef std::pair<std::string, llvm::GlobalAlias*> TypedSelector;
314 /// Type of the selector map. This is roughly equivalent to the structure
315 /// used in the GNUstep runtime, which maintains a list of all of the valid
316 /// types for a selector in a table.
317 typedef llvm::DenseMap<Selector, SmallVector<TypedSelector, 2> >
319 /// A map from selectors to selector types. This allows us to emit all
320 /// selectors of the same name and type together.
321 SelectorMap SelectorTable;
323 /// Selectors related to memory management. When compiling in GC mode, we
325 Selector RetainSel, ReleaseSel, AutoreleaseSel;
326 /// Runtime functions used for memory management in GC mode. Note that clang
327 /// supports code generation for calling these functions, but neither GNU
328 /// runtime actually supports this API properly yet.
329 LazyRuntimeFunction IvarAssignFn, StrongCastAssignFn, MemMoveFn, WeakReadFn,
330 WeakAssignFn, GlobalAssignFn;
332 typedef std::pair<std::string, std::string> ClassAliasPair;
333 /// All classes that have aliases set for them.
334 std::vector<ClassAliasPair> ClassAliases;
337 /// Function used for throwing Objective-C exceptions.
338 LazyRuntimeFunction ExceptionThrowFn;
339 /// Function used for rethrowing exceptions, used at the end of \@finally or
340 /// \@synchronize blocks.
341 LazyRuntimeFunction ExceptionReThrowFn;
342 /// Function called when entering a catch function. This is required for
343 /// differentiating Objective-C exceptions and foreign exceptions.
344 LazyRuntimeFunction EnterCatchFn;
345 /// Function called when exiting from a catch block. Used to do exception
347 LazyRuntimeFunction ExitCatchFn;
348 /// Function called when entering an \@synchronize block. Acquires the lock.
349 LazyRuntimeFunction SyncEnterFn;
350 /// Function called when exiting an \@synchronize block. Releases the lock.
351 LazyRuntimeFunction SyncExitFn;
355 /// Function called if fast enumeration detects that the collection is
356 /// modified during the update.
357 LazyRuntimeFunction EnumerationMutationFn;
358 /// Function for implementing synthesized property getters that return an
360 LazyRuntimeFunction GetPropertyFn;
361 /// Function for implementing synthesized property setters that return an
363 LazyRuntimeFunction SetPropertyFn;
364 /// Function used for non-object declared property getters.
365 LazyRuntimeFunction GetStructPropertyFn;
366 /// Function used for non-object declared property setters.
367 LazyRuntimeFunction SetStructPropertyFn;
369 /// The version of the runtime that this class targets. Must match the
370 /// version in the runtime.
372 /// The version of the protocol class. Used to differentiate between ObjC1
373 /// and ObjC2 protocols. Objective-C 1 protocols can not contain optional
374 /// components and can not contain declared properties. We always emit
375 /// Objective-C 2 property structures, but we have to pretend that they're
376 /// Objective-C 1 property structures when targeting the GCC runtime or it
378 const int ProtocolVersion;
380 /// Generates an instance variable list structure. This is a structure
381 /// containing a size and an array of structures containing instance variable
382 /// metadata. This is used purely for introspection in the fragile ABI. In
383 /// the non-fragile ABI, it's used for instance variable fixup.
384 llvm::Constant *GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
385 ArrayRef<llvm::Constant *> IvarTypes,
386 ArrayRef<llvm::Constant *> IvarOffsets);
387 /// Generates a method list structure. This is a structure containing a size
388 /// and an array of structures containing method metadata.
390 /// This structure is used by both classes and categories, and contains a next
391 /// pointer allowing them to be chained together in a linked list.
392 llvm::Constant *GenerateMethodList(StringRef ClassName,
393 StringRef CategoryName,
394 ArrayRef<Selector> MethodSels,
395 ArrayRef<llvm::Constant *> MethodTypes,
396 bool isClassMethodList);
397 /// Emits an empty protocol. This is used for \@protocol() where no protocol
398 /// is found. The runtime will (hopefully) fix up the pointer to refer to the
400 llvm::Constant *GenerateEmptyProtocol(const std::string &ProtocolName);
401 /// Generates a list of property metadata structures. This follows the same
402 /// pattern as method and instance variable metadata lists.
403 llvm::Constant *GeneratePropertyList(const ObjCImplementationDecl *OID,
404 SmallVectorImpl<Selector> &InstanceMethodSels,
405 SmallVectorImpl<llvm::Constant*> &InstanceMethodTypes);
406 /// Generates a list of referenced protocols. Classes, categories, and
407 /// protocols all use this structure.
408 llvm::Constant *GenerateProtocolList(ArrayRef<std::string> Protocols);
409 /// To ensure that all protocols are seen by the runtime, we add a category on
410 /// a class defined in the runtime, declaring no methods, but adopting the
411 /// protocols. This is a horribly ugly hack, but it allows us to collect all
412 /// of the protocols without changing the ABI.
413 void GenerateProtocolHolderCategory();
414 /// Generates a class structure.
415 llvm::Constant *GenerateClassStructure(
416 llvm::Constant *MetaClass,
417 llvm::Constant *SuperClass,
420 llvm::Constant *Version,
421 llvm::Constant *InstanceSize,
422 llvm::Constant *IVars,
423 llvm::Constant *Methods,
424 llvm::Constant *Protocols,
425 llvm::Constant *IvarOffsets,
426 llvm::Constant *Properties,
427 llvm::Constant *StrongIvarBitmap,
428 llvm::Constant *WeakIvarBitmap,
430 /// Generates a method list. This is used by protocols to define the required
431 /// and optional methods.
432 llvm::Constant *GenerateProtocolMethodList(
433 ArrayRef<llvm::Constant *> MethodNames,
434 ArrayRef<llvm::Constant *> MethodTypes);
435 /// Returns a selector with the specified type encoding. An empty string is
436 /// used to return an untyped selector (with the types field set to NULL).
437 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel,
438 const std::string &TypeEncoding, bool lval);
439 /// Returns the variable used to store the offset of an instance variable.
440 llvm::GlobalVariable *ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
441 const ObjCIvarDecl *Ivar);
442 /// Emits a reference to a class. This allows the linker to object if there
443 /// is no class of the matching name.
445 void EmitClassRef(const std::string &className);
446 /// Emits a pointer to the named class
447 virtual llvm::Value *GetClassNamed(CodeGenFunction &CGF,
448 const std::string &Name, bool isWeak);
449 /// Looks up the method for sending a message to the specified object. This
450 /// mechanism differs between the GCC and GNU runtimes, so this method must be
451 /// overridden in subclasses.
452 virtual llvm::Value *LookupIMP(CodeGenFunction &CGF,
453 llvm::Value *&Receiver,
456 MessageSendInfo &MSI) = 0;
457 /// Looks up the method for sending a message to a superclass. This
458 /// mechanism differs between the GCC and GNU runtimes, so this method must
459 /// be overridden in subclasses.
460 virtual llvm::Value *LookupIMPSuper(CodeGenFunction &CGF,
461 llvm::Value *ObjCSuper,
463 MessageSendInfo &MSI) = 0;
464 /// Libobjc2 uses a bitfield representation where small(ish) bitfields are
465 /// stored in a 64-bit value with the low bit set to 1 and the remaining 63
466 /// bits set to their values, LSB first, while larger ones are stored in a
467 /// structure of this / form:
469 /// struct { int32_t length; int32_t values[length]; };
471 /// The values in the array are stored in host-endian format, with the least
472 /// significant bit being assumed to come first in the bitfield. Therefore,
473 /// a bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] },
474 /// while a bitfield / with the 63rd bit set will be 1<<64.
475 llvm::Constant *MakeBitField(ArrayRef<bool> bits);
477 CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion,
478 unsigned protocolClassVersion);
480 llvm::Constant *GenerateConstantString(const StringLiteral *) override;
483 GenerateMessageSend(CodeGenFunction &CGF, ReturnValueSlot Return,
484 QualType ResultType, Selector Sel,
485 llvm::Value *Receiver, const CallArgList &CallArgs,
486 const ObjCInterfaceDecl *Class,
487 const ObjCMethodDecl *Method) override;
489 GenerateMessageSendSuper(CodeGenFunction &CGF, ReturnValueSlot Return,
490 QualType ResultType, Selector Sel,
491 const ObjCInterfaceDecl *Class,
492 bool isCategoryImpl, llvm::Value *Receiver,
493 bool IsClassMessage, const CallArgList &CallArgs,
494 const ObjCMethodDecl *Method) override;
495 llvm::Value *GetClass(CodeGenFunction &CGF,
496 const ObjCInterfaceDecl *OID) override;
497 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel,
498 bool lval = false) override;
499 llvm::Value *GetSelector(CodeGenFunction &CGF,
500 const ObjCMethodDecl *Method) override;
501 llvm::Constant *GetEHType(QualType T) override;
503 llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
504 const ObjCContainerDecl *CD) override;
505 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
506 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
507 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override;
508 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
509 const ObjCProtocolDecl *PD) override;
510 void GenerateProtocol(const ObjCProtocolDecl *PD) override;
511 llvm::Function *ModuleInitFunction() override;
512 llvm::Constant *GetPropertyGetFunction() override;
513 llvm::Constant *GetPropertySetFunction() override;
514 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
516 llvm::Constant *GetSetStructFunction() override;
517 llvm::Constant *GetGetStructFunction() override;
518 llvm::Constant *GetCppAtomicObjectGetFunction() override;
519 llvm::Constant *GetCppAtomicObjectSetFunction() override;
520 llvm::Constant *EnumerationMutationFunction() override;
522 void EmitTryStmt(CodeGenFunction &CGF,
523 const ObjCAtTryStmt &S) override;
524 void EmitSynchronizedStmt(CodeGenFunction &CGF,
525 const ObjCAtSynchronizedStmt &S) override;
526 void EmitThrowStmt(CodeGenFunction &CGF,
527 const ObjCAtThrowStmt &S,
528 bool ClearInsertionPoint=true) override;
529 llvm::Value * EmitObjCWeakRead(CodeGenFunction &CGF,
530 llvm::Value *AddrWeakObj) override;
531 void EmitObjCWeakAssign(CodeGenFunction &CGF,
532 llvm::Value *src, llvm::Value *dst) override;
533 void EmitObjCGlobalAssign(CodeGenFunction &CGF,
534 llvm::Value *src, llvm::Value *dest,
535 bool threadlocal=false) override;
536 void EmitObjCIvarAssign(CodeGenFunction &CGF, llvm::Value *src,
537 llvm::Value *dest, llvm::Value *ivarOffset) override;
538 void EmitObjCStrongCastAssign(CodeGenFunction &CGF,
539 llvm::Value *src, llvm::Value *dest) override;
540 void EmitGCMemmoveCollectable(CodeGenFunction &CGF, llvm::Value *DestPtr,
542 llvm::Value *Size) override;
543 LValue EmitObjCValueForIvar(CodeGenFunction &CGF, QualType ObjectTy,
544 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
545 unsigned CVRQualifiers) override;
546 llvm::Value *EmitIvarOffset(CodeGenFunction &CGF,
547 const ObjCInterfaceDecl *Interface,
548 const ObjCIvarDecl *Ivar) override;
549 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
550 llvm::Constant *BuildGCBlockLayout(CodeGenModule &CGM,
551 const CGBlockInfo &blockInfo) override {
554 llvm::Constant *BuildRCBlockLayout(CodeGenModule &CGM,
555 const CGBlockInfo &blockInfo) override {
559 llvm::Constant *BuildByrefLayout(CodeGenModule &CGM, QualType T) override {
563 llvm::GlobalVariable *GetClassGlobal(const std::string &Name,
564 bool Weak = false) override {
568 /// Class representing the legacy GCC Objective-C ABI. This is the default when
569 /// -fobjc-nonfragile-abi is not specified.
571 /// The GCC ABI target actually generates code that is approximately compatible
572 /// with the new GNUstep runtime ABI, but refrains from using any features that
573 /// would not work with the GCC runtime. For example, clang always generates
574 /// the extended form of the class structure, and the extra fields are simply
575 /// ignored by GCC libobjc.
576 class CGObjCGCC : public CGObjCGNU {
577 /// The GCC ABI message lookup function. Returns an IMP pointing to the
578 /// method implementation for this message.
579 LazyRuntimeFunction MsgLookupFn;
580 /// The GCC ABI superclass message lookup function. Takes a pointer to a
581 /// structure describing the receiver and the class, and a selector as
582 /// arguments. Returns the IMP for the corresponding method.
583 LazyRuntimeFunction MsgLookupSuperFn;
585 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
586 llvm::Value *cmd, llvm::MDNode *node,
587 MessageSendInfo &MSI) override {
588 CGBuilderTy &Builder = CGF.Builder;
589 llvm::Value *args[] = {
590 EnforceType(Builder, Receiver, IdTy),
591 EnforceType(Builder, cmd, SelectorTy) };
592 llvm::CallSite imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFn, args);
593 imp->setMetadata(msgSendMDKind, node);
594 return imp.getInstruction();
596 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, llvm::Value *ObjCSuper,
597 llvm::Value *cmd, MessageSendInfo &MSI) override {
598 CGBuilderTy &Builder = CGF.Builder;
599 llvm::Value *lookupArgs[] = {EnforceType(Builder, ObjCSuper,
600 PtrToObjCSuperTy), cmd};
601 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
604 CGObjCGCC(CodeGenModule &Mod) : CGObjCGNU(Mod, 8, 2) {
605 // IMP objc_msg_lookup(id, SEL);
606 MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy,
608 // IMP objc_msg_lookup_super(struct objc_super*, SEL);
609 MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
610 PtrToObjCSuperTy, SelectorTy, nullptr);
613 /// Class used when targeting the new GNUstep runtime ABI.
614 class CGObjCGNUstep : public CGObjCGNU {
615 /// The slot lookup function. Returns a pointer to a cacheable structure
616 /// that contains (among other things) the IMP.
617 LazyRuntimeFunction SlotLookupFn;
618 /// The GNUstep ABI superclass message lookup function. Takes a pointer to
619 /// a structure describing the receiver and the class, and a selector as
620 /// arguments. Returns the slot for the corresponding method. Superclass
621 /// message lookup rarely changes, so this is a good caching opportunity.
622 LazyRuntimeFunction SlotLookupSuperFn;
623 /// Specialised function for setting atomic retain properties
624 LazyRuntimeFunction SetPropertyAtomic;
625 /// Specialised function for setting atomic copy properties
626 LazyRuntimeFunction SetPropertyAtomicCopy;
627 /// Specialised function for setting nonatomic retain properties
628 LazyRuntimeFunction SetPropertyNonAtomic;
629 /// Specialised function for setting nonatomic copy properties
630 LazyRuntimeFunction SetPropertyNonAtomicCopy;
631 /// Function to perform atomic copies of C++ objects with nontrivial copy
632 /// constructors from Objective-C ivars.
633 LazyRuntimeFunction CxxAtomicObjectGetFn;
634 /// Function to perform atomic copies of C++ objects with nontrivial copy
635 /// constructors to Objective-C ivars.
636 LazyRuntimeFunction CxxAtomicObjectSetFn;
637 /// Type of an slot structure pointer. This is returned by the various
638 /// lookup functions.
641 llvm::Constant *GetEHType(QualType T) override;
643 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
644 llvm::Value *cmd, llvm::MDNode *node,
645 MessageSendInfo &MSI) override {
646 CGBuilderTy &Builder = CGF.Builder;
647 llvm::Function *LookupFn = SlotLookupFn;
649 // Store the receiver on the stack so that we can reload it later
650 llvm::Value *ReceiverPtr = CGF.CreateTempAlloca(Receiver->getType());
651 Builder.CreateStore(Receiver, ReceiverPtr);
655 if (isa<ObjCMethodDecl>(CGF.CurCodeDecl)) {
656 self = CGF.LoadObjCSelf();
658 self = llvm::ConstantPointerNull::get(IdTy);
661 // The lookup function is guaranteed not to capture the receiver pointer.
662 LookupFn->setDoesNotCapture(1);
664 llvm::Value *args[] = {
665 EnforceType(Builder, ReceiverPtr, PtrToIdTy),
666 EnforceType(Builder, cmd, SelectorTy),
667 EnforceType(Builder, self, IdTy) };
668 llvm::CallSite slot = CGF.EmitRuntimeCallOrInvoke(LookupFn, args);
669 slot.setOnlyReadsMemory();
670 slot->setMetadata(msgSendMDKind, node);
672 // Load the imp from the slot
673 llvm::Value *imp = Builder.CreateLoad(
674 Builder.CreateStructGEP(nullptr, slot.getInstruction(), 4));
676 // The lookup function may have changed the receiver, so make sure we use
678 Receiver = Builder.CreateLoad(ReceiverPtr, true);
681 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, llvm::Value *ObjCSuper,
683 MessageSendInfo &MSI) override {
684 CGBuilderTy &Builder = CGF.Builder;
685 llvm::Value *lookupArgs[] = {ObjCSuper, cmd};
687 llvm::CallInst *slot =
688 CGF.EmitNounwindRuntimeCall(SlotLookupSuperFn, lookupArgs);
689 slot->setOnlyReadsMemory();
691 return Builder.CreateLoad(Builder.CreateStructGEP(nullptr, slot, 4));
694 CGObjCGNUstep(CodeGenModule &Mod) : CGObjCGNU(Mod, 9, 3) {
695 const ObjCRuntime &R = CGM.getLangOpts().ObjCRuntime;
697 llvm::StructType *SlotStructTy = llvm::StructType::get(PtrTy,
698 PtrTy, PtrTy, IntTy, IMPTy, nullptr);
699 SlotTy = llvm::PointerType::getUnqual(SlotStructTy);
700 // Slot_t objc_msg_lookup_sender(id *receiver, SEL selector, id sender);
701 SlotLookupFn.init(&CGM, "objc_msg_lookup_sender", SlotTy, PtrToIdTy,
702 SelectorTy, IdTy, nullptr);
703 // Slot_t objc_msg_lookup_super(struct objc_super*, SEL);
704 SlotLookupSuperFn.init(&CGM, "objc_slot_lookup_super", SlotTy,
705 PtrToObjCSuperTy, SelectorTy, nullptr);
706 // If we're in ObjC++ mode, then we want to make
707 if (CGM.getLangOpts().CPlusPlus) {
708 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
709 // void *__cxa_begin_catch(void *e)
710 EnterCatchFn.init(&CGM, "__cxa_begin_catch", PtrTy, PtrTy, nullptr);
711 // void __cxa_end_catch(void)
712 ExitCatchFn.init(&CGM, "__cxa_end_catch", VoidTy, nullptr);
713 // void _Unwind_Resume_or_Rethrow(void*)
714 ExceptionReThrowFn.init(&CGM, "_Unwind_Resume_or_Rethrow", VoidTy,
716 } else if (R.getVersion() >= VersionTuple(1, 7)) {
717 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
718 // id objc_begin_catch(void *e)
719 EnterCatchFn.init(&CGM, "objc_begin_catch", IdTy, PtrTy, nullptr);
720 // void objc_end_catch(void)
721 ExitCatchFn.init(&CGM, "objc_end_catch", VoidTy, nullptr);
722 // void _Unwind_Resume_or_Rethrow(void*)
723 ExceptionReThrowFn.init(&CGM, "objc_exception_rethrow", VoidTy,
726 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
727 SetPropertyAtomic.init(&CGM, "objc_setProperty_atomic", VoidTy, IdTy,
728 SelectorTy, IdTy, PtrDiffTy, nullptr);
729 SetPropertyAtomicCopy.init(&CGM, "objc_setProperty_atomic_copy", VoidTy,
730 IdTy, SelectorTy, IdTy, PtrDiffTy, nullptr);
731 SetPropertyNonAtomic.init(&CGM, "objc_setProperty_nonatomic", VoidTy,
732 IdTy, SelectorTy, IdTy, PtrDiffTy, nullptr);
733 SetPropertyNonAtomicCopy.init(&CGM, "objc_setProperty_nonatomic_copy",
734 VoidTy, IdTy, SelectorTy, IdTy, PtrDiffTy, nullptr);
735 // void objc_setCppObjectAtomic(void *dest, const void *src, void
737 CxxAtomicObjectSetFn.init(&CGM, "objc_setCppObjectAtomic", VoidTy, PtrTy,
738 PtrTy, PtrTy, nullptr);
739 // void objc_getCppObjectAtomic(void *dest, const void *src, void
741 CxxAtomicObjectGetFn.init(&CGM, "objc_getCppObjectAtomic", VoidTy, PtrTy,
742 PtrTy, PtrTy, nullptr);
744 llvm::Constant *GetCppAtomicObjectGetFunction() override {
745 // The optimised functions were added in version 1.7 of the GNUstep
747 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
749 return CxxAtomicObjectGetFn;
751 llvm::Constant *GetCppAtomicObjectSetFunction() override {
752 // The optimised functions were added in version 1.7 of the GNUstep
754 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
756 return CxxAtomicObjectSetFn;
758 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
759 bool copy) override {
760 // The optimised property functions omit the GC check, and so are not
761 // safe to use in GC mode. The standard functions are fast in GC mode,
762 // so there is less advantage in using them.
763 assert ((CGM.getLangOpts().getGC() == LangOptions::NonGC));
764 // The optimised functions were added in version 1.7 of the GNUstep
766 assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=
770 if (copy) return SetPropertyAtomicCopy;
771 return SetPropertyAtomic;
774 return copy ? SetPropertyNonAtomicCopy : SetPropertyNonAtomic;
778 /// Support for the ObjFW runtime.
779 class CGObjCObjFW: public CGObjCGNU {
781 /// The GCC ABI message lookup function. Returns an IMP pointing to the
782 /// method implementation for this message.
783 LazyRuntimeFunction MsgLookupFn;
784 /// stret lookup function. While this does not seem to make sense at the
785 /// first look, this is required to call the correct forwarding function.
786 LazyRuntimeFunction MsgLookupFnSRet;
787 /// The GCC ABI superclass message lookup function. Takes a pointer to a
788 /// structure describing the receiver and the class, and a selector as
789 /// arguments. Returns the IMP for the corresponding method.
790 LazyRuntimeFunction MsgLookupSuperFn, MsgLookupSuperFnSRet;
792 llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
793 llvm::Value *cmd, llvm::MDNode *node,
794 MessageSendInfo &MSI) override {
795 CGBuilderTy &Builder = CGF.Builder;
796 llvm::Value *args[] = {
797 EnforceType(Builder, Receiver, IdTy),
798 EnforceType(Builder, cmd, SelectorTy) };
801 if (CGM.ReturnTypeUsesSRet(MSI.CallInfo))
802 imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFnSRet, args);
804 imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFn, args);
806 imp->setMetadata(msgSendMDKind, node);
807 return imp.getInstruction();
810 llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, llvm::Value *ObjCSuper,
811 llvm::Value *cmd, MessageSendInfo &MSI) override {
812 CGBuilderTy &Builder = CGF.Builder;
813 llvm::Value *lookupArgs[] = {EnforceType(Builder, ObjCSuper,
814 PtrToObjCSuperTy), cmd};
816 if (CGM.ReturnTypeUsesSRet(MSI.CallInfo))
817 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFnSRet, lookupArgs);
819 return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
822 llvm::Value *GetClassNamed(CodeGenFunction &CGF,
823 const std::string &Name, bool isWeak) override {
825 return CGObjCGNU::GetClassNamed(CGF, Name, isWeak);
829 std::string SymbolName = "_OBJC_CLASS_" + Name;
831 llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(SymbolName);
834 ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false,
835 llvm::GlobalValue::ExternalLinkage,
836 nullptr, SymbolName);
842 CGObjCObjFW(CodeGenModule &Mod): CGObjCGNU(Mod, 9, 3) {
843 // IMP objc_msg_lookup(id, SEL);
844 MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy, nullptr);
845 MsgLookupFnSRet.init(&CGM, "objc_msg_lookup_stret", IMPTy, IdTy,
846 SelectorTy, nullptr);
847 // IMP objc_msg_lookup_super(struct objc_super*, SEL);
848 MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
849 PtrToObjCSuperTy, SelectorTy, nullptr);
850 MsgLookupSuperFnSRet.init(&CGM, "objc_msg_lookup_super_stret", IMPTy,
851 PtrToObjCSuperTy, SelectorTy, nullptr);
854 } // end anonymous namespace
857 /// Emits a reference to a dummy variable which is emitted with each class.
858 /// This ensures that a linker error will be generated when trying to link
859 /// together modules where a referenced class is not defined.
860 void CGObjCGNU::EmitClassRef(const std::string &className) {
861 std::string symbolRef = "__objc_class_ref_" + className;
862 // Don't emit two copies of the same symbol
863 if (TheModule.getGlobalVariable(symbolRef))
865 std::string symbolName = "__objc_class_name_" + className;
866 llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(symbolName);
868 ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false,
869 llvm::GlobalValue::ExternalLinkage,
870 nullptr, symbolName);
872 new llvm::GlobalVariable(TheModule, ClassSymbol->getType(), true,
873 llvm::GlobalValue::WeakAnyLinkage, ClassSymbol, symbolRef);
876 static std::string SymbolNameForMethod( StringRef ClassName,
877 StringRef CategoryName, const Selector MethodName,
878 bool isClassMethod) {
879 std::string MethodNameColonStripped = MethodName.getAsString();
880 std::replace(MethodNameColonStripped.begin(), MethodNameColonStripped.end(),
882 return (Twine(isClassMethod ? "_c_" : "_i_") + ClassName + "_" +
883 CategoryName + "_" + MethodNameColonStripped).str();
886 CGObjCGNU::CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion,
887 unsigned protocolClassVersion)
888 : CGObjCRuntime(cgm), TheModule(CGM.getModule()),
889 VMContext(cgm.getLLVMContext()), ClassPtrAlias(nullptr),
890 MetaClassPtrAlias(nullptr), RuntimeVersion(runtimeABIVersion),
891 ProtocolVersion(protocolClassVersion) {
893 msgSendMDKind = VMContext.getMDKindID("GNUObjCMessageSend");
895 CodeGenTypes &Types = CGM.getTypes();
896 IntTy = cast<llvm::IntegerType>(
897 Types.ConvertType(CGM.getContext().IntTy));
898 LongTy = cast<llvm::IntegerType>(
899 Types.ConvertType(CGM.getContext().LongTy));
900 SizeTy = cast<llvm::IntegerType>(
901 Types.ConvertType(CGM.getContext().getSizeType()));
902 PtrDiffTy = cast<llvm::IntegerType>(
903 Types.ConvertType(CGM.getContext().getPointerDiffType()));
904 BoolTy = CGM.getTypes().ConvertType(CGM.getContext().BoolTy);
906 Int8Ty = llvm::Type::getInt8Ty(VMContext);
907 // C string type. Used in lots of places.
908 PtrToInt8Ty = llvm::PointerType::getUnqual(Int8Ty);
910 Zeros[0] = llvm::ConstantInt::get(LongTy, 0);
912 NULLPtr = llvm::ConstantPointerNull::get(PtrToInt8Ty);
913 // Get the selector Type.
914 QualType selTy = CGM.getContext().getObjCSelType();
915 if (QualType() == selTy) {
916 SelectorTy = PtrToInt8Ty;
918 SelectorTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(selTy));
921 PtrToIntTy = llvm::PointerType::getUnqual(IntTy);
924 Int32Ty = llvm::Type::getInt32Ty(VMContext);
925 Int64Ty = llvm::Type::getInt64Ty(VMContext);
928 CGM.getDataLayout().getPointerSizeInBits() == 32 ? Int32Ty : Int64Ty;
931 QualType UnqualIdTy = CGM.getContext().getObjCIdType();
932 ASTIdTy = CanQualType();
933 if (UnqualIdTy != QualType()) {
934 ASTIdTy = CGM.getContext().getCanonicalType(UnqualIdTy);
935 IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy));
939 PtrToIdTy = llvm::PointerType::getUnqual(IdTy);
941 ObjCSuperTy = llvm::StructType::get(IdTy, IdTy, nullptr);
942 PtrToObjCSuperTy = llvm::PointerType::getUnqual(ObjCSuperTy);
944 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
946 // void objc_exception_throw(id);
947 ExceptionThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy, nullptr);
948 ExceptionReThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy, nullptr);
949 // int objc_sync_enter(id);
950 SyncEnterFn.init(&CGM, "objc_sync_enter", IntTy, IdTy, nullptr);
951 // int objc_sync_exit(id);
952 SyncExitFn.init(&CGM, "objc_sync_exit", IntTy, IdTy, nullptr);
954 // void objc_enumerationMutation (id)
955 EnumerationMutationFn.init(&CGM, "objc_enumerationMutation", VoidTy,
958 // id objc_getProperty(id, SEL, ptrdiff_t, BOOL)
959 GetPropertyFn.init(&CGM, "objc_getProperty", IdTy, IdTy, SelectorTy,
960 PtrDiffTy, BoolTy, nullptr);
961 // void objc_setProperty(id, SEL, ptrdiff_t, id, BOOL, BOOL)
962 SetPropertyFn.init(&CGM, "objc_setProperty", VoidTy, IdTy, SelectorTy,
963 PtrDiffTy, IdTy, BoolTy, BoolTy, nullptr);
964 // void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL)
965 GetStructPropertyFn.init(&CGM, "objc_getPropertyStruct", VoidTy, PtrTy, PtrTy,
966 PtrDiffTy, BoolTy, BoolTy, nullptr);
967 // void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL)
968 SetStructPropertyFn.init(&CGM, "objc_setPropertyStruct", VoidTy, PtrTy, PtrTy,
969 PtrDiffTy, BoolTy, BoolTy, nullptr);
972 llvm::Type *IMPArgs[] = { IdTy, SelectorTy };
973 IMPTy = llvm::PointerType::getUnqual(llvm::FunctionType::get(IdTy, IMPArgs,
976 const LangOptions &Opts = CGM.getLangOpts();
977 if ((Opts.getGC() != LangOptions::NonGC) || Opts.ObjCAutoRefCount)
980 // Don't bother initialising the GC stuff unless we're compiling in GC mode
981 if (Opts.getGC() != LangOptions::NonGC) {
982 // This is a bit of an hack. We should sort this out by having a proper
983 // CGObjCGNUstep subclass for GC, but we may want to really support the old
984 // ABI and GC added in ObjectiveC2.framework, so we fudge it a bit for now
985 // Get selectors needed in GC mode
986 RetainSel = GetNullarySelector("retain", CGM.getContext());
987 ReleaseSel = GetNullarySelector("release", CGM.getContext());
988 AutoreleaseSel = GetNullarySelector("autorelease", CGM.getContext());
990 // Get functions needed in GC mode
992 // id objc_assign_ivar(id, id, ptrdiff_t);
993 IvarAssignFn.init(&CGM, "objc_assign_ivar", IdTy, IdTy, IdTy, PtrDiffTy,
995 // id objc_assign_strongCast (id, id*)
996 StrongCastAssignFn.init(&CGM, "objc_assign_strongCast", IdTy, IdTy,
998 // id objc_assign_global(id, id*);
999 GlobalAssignFn.init(&CGM, "objc_assign_global", IdTy, IdTy, PtrToIdTy,
1001 // id objc_assign_weak(id, id*);
1002 WeakAssignFn.init(&CGM, "objc_assign_weak", IdTy, IdTy, PtrToIdTy, nullptr);
1003 // id objc_read_weak(id*);
1004 WeakReadFn.init(&CGM, "objc_read_weak", IdTy, PtrToIdTy, nullptr);
1005 // void *objc_memmove_collectable(void*, void *, size_t);
1006 MemMoveFn.init(&CGM, "objc_memmove_collectable", PtrTy, PtrTy, PtrTy,
1011 llvm::Value *CGObjCGNU::GetClassNamed(CodeGenFunction &CGF,
1012 const std::string &Name,
1014 llvm::GlobalVariable *ClassNameGV = CGM.GetAddrOfConstantCString(Name);
1015 // With the incompatible ABI, this will need to be replaced with a direct
1016 // reference to the class symbol. For the compatible nonfragile ABI we are
1017 // still performing this lookup at run time but emitting the symbol for the
1018 // class externally so that we can make the switch later.
1020 // Libobjc2 contains an LLVM pass that replaces calls to objc_lookup_class
1021 // with memoized versions or with static references if it's safe to do so.
1024 llvm::Value *ClassName =
1025 CGF.Builder.CreateStructGEP(ClassNameGV->getValueType(), ClassNameGV, 0);
1027 llvm::Constant *ClassLookupFn =
1028 CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, PtrToInt8Ty, true),
1029 "objc_lookup_class");
1030 return CGF.EmitNounwindRuntimeCall(ClassLookupFn, ClassName);
1033 // This has to perform the lookup every time, since posing and related
1034 // techniques can modify the name -> class mapping.
1035 llvm::Value *CGObjCGNU::GetClass(CodeGenFunction &CGF,
1036 const ObjCInterfaceDecl *OID) {
1037 return GetClassNamed(CGF, OID->getNameAsString(), OID->isWeakImported());
1039 llvm::Value *CGObjCGNU::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
1040 return GetClassNamed(CGF, "NSAutoreleasePool", false);
1043 llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF, Selector Sel,
1044 const std::string &TypeEncoding, bool lval) {
1046 SmallVectorImpl<TypedSelector> &Types = SelectorTable[Sel];
1047 llvm::GlobalAlias *SelValue = nullptr;
1049 for (SmallVectorImpl<TypedSelector>::iterator i = Types.begin(),
1050 e = Types.end() ; i!=e ; i++) {
1051 if (i->first == TypeEncoding) {
1052 SelValue = i->second;
1057 SelValue = llvm::GlobalAlias::create(
1058 SelectorTy, llvm::GlobalValue::PrivateLinkage,
1059 ".objc_selector_" + Sel.getAsString(), &TheModule);
1060 Types.push_back(TypedSelector(TypeEncoding, SelValue));
1064 llvm::Value *tmp = CGF.CreateTempAlloca(SelValue->getType());
1065 CGF.Builder.CreateStore(SelValue, tmp);
1071 llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF, Selector Sel,
1073 return GetSelector(CGF, Sel, std::string(), lval);
1076 llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF,
1077 const ObjCMethodDecl *Method) {
1078 std::string SelTypes;
1079 CGM.getContext().getObjCEncodingForMethodDecl(Method, SelTypes);
1080 return GetSelector(CGF, Method->getSelector(), SelTypes, false);
1083 llvm::Constant *CGObjCGNU::GetEHType(QualType T) {
1084 if (T->isObjCIdType() || T->isObjCQualifiedIdType()) {
1085 // With the old ABI, there was only one kind of catchall, which broke
1086 // foreign exceptions. With the new ABI, we use __objc_id_typeinfo as
1087 // a pointer indicating object catchalls, and NULL to indicate real
1089 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
1090 return MakeConstantString("@id");
1096 // All other types should be Objective-C interface pointer types.
1097 const ObjCObjectPointerType *OPT = T->getAs<ObjCObjectPointerType>();
1098 assert(OPT && "Invalid @catch type.");
1099 const ObjCInterfaceDecl *IDecl = OPT->getObjectType()->getInterface();
1100 assert(IDecl && "Invalid @catch type.");
1101 return MakeConstantString(IDecl->getIdentifier()->getName());
1104 llvm::Constant *CGObjCGNUstep::GetEHType(QualType T) {
1105 if (!CGM.getLangOpts().CPlusPlus)
1106 return CGObjCGNU::GetEHType(T);
1108 // For Objective-C++, we want to provide the ability to catch both C++ and
1109 // Objective-C objects in the same function.
1111 // There's a particular fixed type info for 'id'.
1112 if (T->isObjCIdType() ||
1113 T->isObjCQualifiedIdType()) {
1114 llvm::Constant *IDEHType =
1115 CGM.getModule().getGlobalVariable("__objc_id_type_info");
1118 new llvm::GlobalVariable(CGM.getModule(), PtrToInt8Ty,
1120 llvm::GlobalValue::ExternalLinkage,
1121 nullptr, "__objc_id_type_info");
1122 return llvm::ConstantExpr::getBitCast(IDEHType, PtrToInt8Ty);
1125 const ObjCObjectPointerType *PT =
1126 T->getAs<ObjCObjectPointerType>();
1127 assert(PT && "Invalid @catch type.");
1128 const ObjCInterfaceType *IT = PT->getInterfaceType();
1129 assert(IT && "Invalid @catch type.");
1130 std::string className = IT->getDecl()->getIdentifier()->getName();
1132 std::string typeinfoName = "__objc_eh_typeinfo_" + className;
1134 // Return the existing typeinfo if it exists
1135 llvm::Constant *typeinfo = TheModule.getGlobalVariable(typeinfoName);
1137 return llvm::ConstantExpr::getBitCast(typeinfo, PtrToInt8Ty);
1139 // Otherwise create it.
1141 // vtable for gnustep::libobjc::__objc_class_type_info
1142 // It's quite ugly hard-coding this. Ideally we'd generate it using the host
1143 // platform's name mangling.
1144 const char *vtableName = "_ZTVN7gnustep7libobjc22__objc_class_type_infoE";
1145 auto *Vtable = TheModule.getGlobalVariable(vtableName);
1147 Vtable = new llvm::GlobalVariable(TheModule, PtrToInt8Ty, true,
1148 llvm::GlobalValue::ExternalLinkage,
1149 nullptr, vtableName);
1151 llvm::Constant *Two = llvm::ConstantInt::get(IntTy, 2);
1152 auto *BVtable = llvm::ConstantExpr::getBitCast(
1153 llvm::ConstantExpr::getGetElementPtr(Vtable->getValueType(), Vtable, Two),
1156 llvm::Constant *typeName =
1157 ExportUniqueString(className, "__objc_eh_typename_");
1159 std::vector<llvm::Constant*> fields;
1160 fields.push_back(BVtable);
1161 fields.push_back(typeName);
1162 llvm::Constant *TI =
1163 MakeGlobal(llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty,
1164 nullptr), fields, "__objc_eh_typeinfo_" + className,
1165 llvm::GlobalValue::LinkOnceODRLinkage);
1166 return llvm::ConstantExpr::getBitCast(TI, PtrToInt8Ty);
1169 /// Generate an NSConstantString object.
1170 llvm::Constant *CGObjCGNU::GenerateConstantString(const StringLiteral *SL) {
1172 std::string Str = SL->getString().str();
1174 // Look for an existing one
1175 llvm::StringMap<llvm::Constant*>::iterator old = ObjCStrings.find(Str);
1176 if (old != ObjCStrings.end())
1177 return old->getValue();
1179 StringRef StringClass = CGM.getLangOpts().ObjCConstantStringClass;
1181 if (StringClass.empty()) StringClass = "NXConstantString";
1183 std::string Sym = "_OBJC_CLASS_";
1186 llvm::Constant *isa = TheModule.getNamedGlobal(Sym);
1189 isa = new llvm::GlobalVariable(TheModule, IdTy, /* isConstant */false,
1190 llvm::GlobalValue::ExternalWeakLinkage, nullptr, Sym);
1191 else if (isa->getType() != PtrToIdTy)
1192 isa = llvm::ConstantExpr::getBitCast(isa, PtrToIdTy);
1194 std::vector<llvm::Constant*> Ivars;
1195 Ivars.push_back(isa);
1196 Ivars.push_back(MakeConstantString(Str));
1197 Ivars.push_back(llvm::ConstantInt::get(IntTy, Str.size()));
1198 llvm::Constant *ObjCStr = MakeGlobal(
1199 llvm::StructType::get(PtrToIdTy, PtrToInt8Ty, IntTy, nullptr),
1200 Ivars, ".objc_str");
1201 ObjCStr = llvm::ConstantExpr::getBitCast(ObjCStr, PtrToInt8Ty);
1202 ObjCStrings[Str] = ObjCStr;
1203 ConstantStrings.push_back(ObjCStr);
1207 ///Generates a message send where the super is the receiver. This is a message
1208 ///send to self with special delivery semantics indicating which class's method
1209 ///should be called.
1211 CGObjCGNU::GenerateMessageSendSuper(CodeGenFunction &CGF,
1212 ReturnValueSlot Return,
1213 QualType ResultType,
1215 const ObjCInterfaceDecl *Class,
1216 bool isCategoryImpl,
1217 llvm::Value *Receiver,
1218 bool IsClassMessage,
1219 const CallArgList &CallArgs,
1220 const ObjCMethodDecl *Method) {
1221 CGBuilderTy &Builder = CGF.Builder;
1222 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
1223 if (Sel == RetainSel || Sel == AutoreleaseSel) {
1224 return RValue::get(EnforceType(Builder, Receiver,
1225 CGM.getTypes().ConvertType(ResultType)));
1227 if (Sel == ReleaseSel) {
1228 return RValue::get(nullptr);
1232 llvm::Value *cmd = GetSelector(CGF, Sel);
1235 CallArgList ActualArgs;
1237 ActualArgs.add(RValue::get(EnforceType(Builder, Receiver, IdTy)), ASTIdTy);
1238 ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType());
1239 ActualArgs.addFrom(CallArgs);
1241 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
1243 llvm::Value *ReceiverClass = nullptr;
1244 if (isCategoryImpl) {
1245 llvm::Constant *classLookupFunction = nullptr;
1246 if (IsClassMessage) {
1247 classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get(
1248 IdTy, PtrTy, true), "objc_get_meta_class");
1250 classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get(
1251 IdTy, PtrTy, true), "objc_get_class");
1253 ReceiverClass = Builder.CreateCall(classLookupFunction,
1254 MakeConstantString(Class->getNameAsString()));
1256 // Set up global aliases for the metaclass or class pointer if they do not
1257 // already exist. These will are forward-references which will be set to
1258 // pointers to the class and metaclass structure created for the runtime
1259 // load function. To send a message to super, we look up the value of the
1260 // super_class pointer from either the class or metaclass structure.
1261 if (IsClassMessage) {
1262 if (!MetaClassPtrAlias) {
1263 MetaClassPtrAlias = llvm::GlobalAlias::create(
1264 IdTy, llvm::GlobalValue::InternalLinkage,
1265 ".objc_metaclass_ref" + Class->getNameAsString(), &TheModule);
1267 ReceiverClass = MetaClassPtrAlias;
1269 if (!ClassPtrAlias) {
1270 ClassPtrAlias = llvm::GlobalAlias::create(
1271 IdTy, llvm::GlobalValue::InternalLinkage,
1272 ".objc_class_ref" + Class->getNameAsString(), &TheModule);
1274 ReceiverClass = ClassPtrAlias;
1277 // Cast the pointer to a simplified version of the class structure
1278 llvm::Type *CastTy = llvm::StructType::get(IdTy, IdTy, nullptr);
1279 ReceiverClass = Builder.CreateBitCast(ReceiverClass,
1280 llvm::PointerType::getUnqual(CastTy));
1281 // Get the superclass pointer
1282 ReceiverClass = Builder.CreateStructGEP(CastTy, ReceiverClass, 1);
1283 // Load the superclass pointer
1284 ReceiverClass = Builder.CreateLoad(ReceiverClass);
1285 // Construct the structure used to look up the IMP
1286 llvm::StructType *ObjCSuperTy = llvm::StructType::get(
1287 Receiver->getType(), IdTy, nullptr);
1288 llvm::Value *ObjCSuper = Builder.CreateAlloca(ObjCSuperTy);
1290 Builder.CreateStore(Receiver,
1291 Builder.CreateStructGEP(ObjCSuperTy, ObjCSuper, 0));
1292 Builder.CreateStore(ReceiverClass,
1293 Builder.CreateStructGEP(ObjCSuperTy, ObjCSuper, 1));
1295 ObjCSuper = EnforceType(Builder, ObjCSuper, PtrToObjCSuperTy);
1298 llvm::Value *imp = LookupIMPSuper(CGF, ObjCSuper, cmd, MSI);
1299 imp = EnforceType(Builder, imp, MSI.MessengerType);
1301 llvm::Metadata *impMD[] = {
1302 llvm::MDString::get(VMContext, Sel.getAsString()),
1303 llvm::MDString::get(VMContext, Class->getSuperClass()->getNameAsString()),
1304 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
1305 llvm::Type::getInt1Ty(VMContext), IsClassMessage))};
1306 llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD);
1308 llvm::Instruction *call;
1309 RValue msgRet = CGF.EmitCall(MSI.CallInfo, imp, Return, ActualArgs, nullptr,
1311 call->setMetadata(msgSendMDKind, node);
1315 /// Generate code for a message send expression.
1317 CGObjCGNU::GenerateMessageSend(CodeGenFunction &CGF,
1318 ReturnValueSlot Return,
1319 QualType ResultType,
1321 llvm::Value *Receiver,
1322 const CallArgList &CallArgs,
1323 const ObjCInterfaceDecl *Class,
1324 const ObjCMethodDecl *Method) {
1325 CGBuilderTy &Builder = CGF.Builder;
1327 // Strip out message sends to retain / release in GC mode
1328 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
1329 if (Sel == RetainSel || Sel == AutoreleaseSel) {
1330 return RValue::get(EnforceType(Builder, Receiver,
1331 CGM.getTypes().ConvertType(ResultType)));
1333 if (Sel == ReleaseSel) {
1334 return RValue::get(nullptr);
1338 // If the return type is something that goes in an integer register, the
1339 // runtime will handle 0 returns. For other cases, we fill in the 0 value
1342 // The language spec says the result of this kind of message send is
1343 // undefined, but lots of people seem to have forgotten to read that
1344 // paragraph and insist on sending messages to nil that have structure
1345 // returns. With GCC, this generates a random return value (whatever happens
1346 // to be on the stack / in those registers at the time) on most platforms,
1347 // and generates an illegal instruction trap on SPARC. With LLVM it corrupts
1349 bool isPointerSizedReturn = (ResultType->isAnyPointerType() ||
1350 ResultType->isIntegralOrEnumerationType() || ResultType->isVoidType());
1352 llvm::BasicBlock *startBB = nullptr;
1353 llvm::BasicBlock *messageBB = nullptr;
1354 llvm::BasicBlock *continueBB = nullptr;
1356 if (!isPointerSizedReturn) {
1357 startBB = Builder.GetInsertBlock();
1358 messageBB = CGF.createBasicBlock("msgSend");
1359 continueBB = CGF.createBasicBlock("continue");
1361 llvm::Value *isNil = Builder.CreateICmpEQ(Receiver,
1362 llvm::Constant::getNullValue(Receiver->getType()));
1363 Builder.CreateCondBr(isNil, continueBB, messageBB);
1364 CGF.EmitBlock(messageBB);
1367 IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy));
1370 cmd = GetSelector(CGF, Method);
1372 cmd = GetSelector(CGF, Sel);
1373 cmd = EnforceType(Builder, cmd, SelectorTy);
1374 Receiver = EnforceType(Builder, Receiver, IdTy);
1376 llvm::Metadata *impMD[] = {
1377 llvm::MDString::get(VMContext, Sel.getAsString()),
1378 llvm::MDString::get(VMContext, Class ? Class->getNameAsString() : ""),
1379 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
1380 llvm::Type::getInt1Ty(VMContext), Class != nullptr))};
1381 llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD);
1383 CallArgList ActualArgs;
1384 ActualArgs.add(RValue::get(Receiver), ASTIdTy);
1385 ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType());
1386 ActualArgs.addFrom(CallArgs);
1388 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
1390 // Get the IMP to call
1393 // If we have non-legacy dispatch specified, we try using the objc_msgSend()
1394 // functions. These are not supported on all platforms (or all runtimes on a
1395 // given platform), so we
1396 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
1397 case CodeGenOptions::Legacy:
1398 imp = LookupIMP(CGF, Receiver, cmd, node, MSI);
1400 case CodeGenOptions::Mixed:
1401 case CodeGenOptions::NonLegacy:
1402 if (CGM.ReturnTypeUsesFPRet(ResultType)) {
1403 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
1404 "objc_msgSend_fpret");
1405 } else if (CGM.ReturnTypeUsesSRet(MSI.CallInfo)) {
1406 // The actual types here don't matter - we're going to bitcast the
1408 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
1409 "objc_msgSend_stret");
1411 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
1416 // Reset the receiver in case the lookup modified it
1417 ActualArgs[0] = CallArg(RValue::get(Receiver), ASTIdTy, false);
1419 imp = EnforceType(Builder, imp, MSI.MessengerType);
1421 llvm::Instruction *call;
1422 RValue msgRet = CGF.EmitCall(MSI.CallInfo, imp, Return, ActualArgs, nullptr,
1424 call->setMetadata(msgSendMDKind, node);
1427 if (!isPointerSizedReturn) {
1428 messageBB = CGF.Builder.GetInsertBlock();
1429 CGF.Builder.CreateBr(continueBB);
1430 CGF.EmitBlock(continueBB);
1431 if (msgRet.isScalar()) {
1432 llvm::Value *v = msgRet.getScalarVal();
1433 llvm::PHINode *phi = Builder.CreatePHI(v->getType(), 2);
1434 phi->addIncoming(v, messageBB);
1435 phi->addIncoming(llvm::Constant::getNullValue(v->getType()), startBB);
1436 msgRet = RValue::get(phi);
1437 } else if (msgRet.isAggregate()) {
1438 llvm::Value *v = msgRet.getAggregateAddr();
1439 llvm::PHINode *phi = Builder.CreatePHI(v->getType(), 2);
1440 llvm::PointerType *RetTy = cast<llvm::PointerType>(v->getType());
1441 llvm::AllocaInst *NullVal =
1442 CGF.CreateTempAlloca(RetTy->getElementType(), "null");
1443 CGF.InitTempAlloca(NullVal,
1444 llvm::Constant::getNullValue(RetTy->getElementType()));
1445 phi->addIncoming(v, messageBB);
1446 phi->addIncoming(NullVal, startBB);
1447 msgRet = RValue::getAggregate(phi);
1448 } else /* isComplex() */ {
1449 std::pair<llvm::Value*,llvm::Value*> v = msgRet.getComplexVal();
1450 llvm::PHINode *phi = Builder.CreatePHI(v.first->getType(), 2);
1451 phi->addIncoming(v.first, messageBB);
1452 phi->addIncoming(llvm::Constant::getNullValue(v.first->getType()),
1454 llvm::PHINode *phi2 = Builder.CreatePHI(v.second->getType(), 2);
1455 phi2->addIncoming(v.second, messageBB);
1456 phi2->addIncoming(llvm::Constant::getNullValue(v.second->getType()),
1458 msgRet = RValue::getComplex(phi, phi2);
1464 /// Generates a MethodList. Used in construction of a objc_class and
1465 /// objc_category structures.
1466 llvm::Constant *CGObjCGNU::
1467 GenerateMethodList(StringRef ClassName,
1468 StringRef CategoryName,
1469 ArrayRef<Selector> MethodSels,
1470 ArrayRef<llvm::Constant *> MethodTypes,
1471 bool isClassMethodList) {
1472 if (MethodSels.empty())
1474 // Get the method structure type.
1475 llvm::StructType *ObjCMethodTy = llvm::StructType::get(
1476 PtrToInt8Ty, // Really a selector, but the runtime creates it us.
1477 PtrToInt8Ty, // Method types
1478 IMPTy, //Method pointer
1480 std::vector<llvm::Constant*> Methods;
1481 std::vector<llvm::Constant*> Elements;
1482 for (unsigned int i = 0, e = MethodTypes.size(); i < e; ++i) {
1484 llvm::Constant *Method =
1485 TheModule.getFunction(SymbolNameForMethod(ClassName, CategoryName,
1487 isClassMethodList));
1488 assert(Method && "Can't generate metadata for method that doesn't exist");
1489 llvm::Constant *C = MakeConstantString(MethodSels[i].getAsString());
1490 Elements.push_back(C);
1491 Elements.push_back(MethodTypes[i]);
1492 Method = llvm::ConstantExpr::getBitCast(Method,
1494 Elements.push_back(Method);
1495 Methods.push_back(llvm::ConstantStruct::get(ObjCMethodTy, Elements));
1498 // Array of method structures
1499 llvm::ArrayType *ObjCMethodArrayTy = llvm::ArrayType::get(ObjCMethodTy,
1501 llvm::Constant *MethodArray = llvm::ConstantArray::get(ObjCMethodArrayTy,
1504 // Structure containing list pointer, array and array count
1505 llvm::StructType *ObjCMethodListTy = llvm::StructType::create(VMContext);
1506 llvm::Type *NextPtrTy = llvm::PointerType::getUnqual(ObjCMethodListTy);
1507 ObjCMethodListTy->setBody(
1514 Methods.push_back(llvm::ConstantPointerNull::get(
1515 llvm::PointerType::getUnqual(ObjCMethodListTy)));
1516 Methods.push_back(llvm::ConstantInt::get(Int32Ty, MethodTypes.size()));
1517 Methods.push_back(MethodArray);
1519 // Create an instance of the structure
1520 return MakeGlobal(ObjCMethodListTy, Methods, ".objc_method_list");
1523 /// Generates an IvarList. Used in construction of a objc_class.
1524 llvm::Constant *CGObjCGNU::
1525 GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
1526 ArrayRef<llvm::Constant *> IvarTypes,
1527 ArrayRef<llvm::Constant *> IvarOffsets) {
1528 if (IvarNames.size() == 0)
1530 // Get the method structure type.
1531 llvm::StructType *ObjCIvarTy = llvm::StructType::get(
1536 std::vector<llvm::Constant*> Ivars;
1537 std::vector<llvm::Constant*> Elements;
1538 for (unsigned int i = 0, e = IvarNames.size() ; i < e ; i++) {
1540 Elements.push_back(IvarNames[i]);
1541 Elements.push_back(IvarTypes[i]);
1542 Elements.push_back(IvarOffsets[i]);
1543 Ivars.push_back(llvm::ConstantStruct::get(ObjCIvarTy, Elements));
1546 // Array of method structures
1547 llvm::ArrayType *ObjCIvarArrayTy = llvm::ArrayType::get(ObjCIvarTy,
1552 Elements.push_back(llvm::ConstantInt::get(IntTy, (int)IvarNames.size()));
1553 Elements.push_back(llvm::ConstantArray::get(ObjCIvarArrayTy, Ivars));
1554 // Structure containing array and array count
1555 llvm::StructType *ObjCIvarListTy = llvm::StructType::get(IntTy,
1559 // Create an instance of the structure
1560 return MakeGlobal(ObjCIvarListTy, Elements, ".objc_ivar_list");
1563 /// Generate a class structure
1564 llvm::Constant *CGObjCGNU::GenerateClassStructure(
1565 llvm::Constant *MetaClass,
1566 llvm::Constant *SuperClass,
1569 llvm::Constant *Version,
1570 llvm::Constant *InstanceSize,
1571 llvm::Constant *IVars,
1572 llvm::Constant *Methods,
1573 llvm::Constant *Protocols,
1574 llvm::Constant *IvarOffsets,
1575 llvm::Constant *Properties,
1576 llvm::Constant *StrongIvarBitmap,
1577 llvm::Constant *WeakIvarBitmap,
1579 // Set up the class structure
1580 // Note: Several of these are char*s when they should be ids. This is
1581 // because the runtime performs this translation on load.
1583 // Fields marked New ABI are part of the GNUstep runtime. We emit them
1584 // anyway; the classes will still work with the GNU runtime, they will just
1586 llvm::StructType *ClassTy = llvm::StructType::get(
1588 PtrToInt8Ty, // super_class
1589 PtrToInt8Ty, // name
1592 LongTy, // instance_size
1593 IVars->getType(), // ivars
1594 Methods->getType(), // methods
1595 // These are all filled in by the runtime, so we pretend
1597 PtrTy, // subclass_list
1598 PtrTy, // sibling_class
1600 PtrTy, // gc_object_type
1602 LongTy, // abi_version
1603 IvarOffsets->getType(), // ivar_offsets
1604 Properties->getType(), // properties
1605 IntPtrTy, // strong_pointers
1606 IntPtrTy, // weak_pointers
1608 llvm::Constant *Zero = llvm::ConstantInt::get(LongTy, 0);
1609 // Fill in the structure
1610 std::vector<llvm::Constant*> Elements;
1611 Elements.push_back(llvm::ConstantExpr::getBitCast(MetaClass, PtrToInt8Ty));
1612 Elements.push_back(SuperClass);
1613 Elements.push_back(MakeConstantString(Name, ".class_name"));
1614 Elements.push_back(Zero);
1615 Elements.push_back(llvm::ConstantInt::get(LongTy, info));
1617 llvm::DataLayout td(&TheModule);
1619 llvm::ConstantInt::get(LongTy,
1620 td.getTypeSizeInBits(ClassTy) /
1621 CGM.getContext().getCharWidth()));
1623 Elements.push_back(InstanceSize);
1624 Elements.push_back(IVars);
1625 Elements.push_back(Methods);
1626 Elements.push_back(NULLPtr);
1627 Elements.push_back(NULLPtr);
1628 Elements.push_back(NULLPtr);
1629 Elements.push_back(llvm::ConstantExpr::getBitCast(Protocols, PtrTy));
1630 Elements.push_back(NULLPtr);
1631 Elements.push_back(llvm::ConstantInt::get(LongTy, 1));
1632 Elements.push_back(IvarOffsets);
1633 Elements.push_back(Properties);
1634 Elements.push_back(StrongIvarBitmap);
1635 Elements.push_back(WeakIvarBitmap);
1636 // Create an instance of the structure
1637 // This is now an externally visible symbol, so that we can speed up class
1638 // messages in the next ABI. We may already have some weak references to
1639 // this, so check and fix them properly.
1640 std::string ClassSym((isMeta ? "_OBJC_METACLASS_": "_OBJC_CLASS_") +
1642 llvm::GlobalVariable *ClassRef = TheModule.getNamedGlobal(ClassSym);
1643 llvm::Constant *Class = MakeGlobal(ClassTy, Elements, ClassSym,
1644 llvm::GlobalValue::ExternalLinkage);
1646 ClassRef->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(Class,
1647 ClassRef->getType()));
1648 ClassRef->removeFromParent();
1649 Class->setName(ClassSym);
1654 llvm::Constant *CGObjCGNU::
1655 GenerateProtocolMethodList(ArrayRef<llvm::Constant *> MethodNames,
1656 ArrayRef<llvm::Constant *> MethodTypes) {
1657 // Get the method structure type.
1658 llvm::StructType *ObjCMethodDescTy = llvm::StructType::get(
1659 PtrToInt8Ty, // Really a selector, but the runtime does the casting for us.
1662 std::vector<llvm::Constant*> Methods;
1663 std::vector<llvm::Constant*> Elements;
1664 for (unsigned int i = 0, e = MethodTypes.size() ; i < e ; i++) {
1666 Elements.push_back(MethodNames[i]);
1667 Elements.push_back(MethodTypes[i]);
1668 Methods.push_back(llvm::ConstantStruct::get(ObjCMethodDescTy, Elements));
1670 llvm::ArrayType *ObjCMethodArrayTy = llvm::ArrayType::get(ObjCMethodDescTy,
1671 MethodNames.size());
1672 llvm::Constant *Array = llvm::ConstantArray::get(ObjCMethodArrayTy,
1674 llvm::StructType *ObjCMethodDescListTy = llvm::StructType::get(
1675 IntTy, ObjCMethodArrayTy, nullptr);
1677 Methods.push_back(llvm::ConstantInt::get(IntTy, MethodNames.size()));
1678 Methods.push_back(Array);
1679 return MakeGlobal(ObjCMethodDescListTy, Methods, ".objc_method_list");
1682 // Create the protocol list structure used in classes, categories and so on
1683 llvm::Constant *CGObjCGNU::GenerateProtocolList(ArrayRef<std::string>Protocols){
1684 llvm::ArrayType *ProtocolArrayTy = llvm::ArrayType::get(PtrToInt8Ty,
1686 llvm::StructType *ProtocolListTy = llvm::StructType::get(
1687 PtrTy, //Should be a recurisve pointer, but it's always NULL here.
1691 std::vector<llvm::Constant*> Elements;
1692 for (const std::string *iter = Protocols.begin(), *endIter = Protocols.end();
1693 iter != endIter ; iter++) {
1694 llvm::Constant *protocol = nullptr;
1695 llvm::StringMap<llvm::Constant*>::iterator value =
1696 ExistingProtocols.find(*iter);
1697 if (value == ExistingProtocols.end()) {
1698 protocol = GenerateEmptyProtocol(*iter);
1700 protocol = value->getValue();
1702 llvm::Constant *Ptr = llvm::ConstantExpr::getBitCast(protocol,
1704 Elements.push_back(Ptr);
1706 llvm::Constant * ProtocolArray = llvm::ConstantArray::get(ProtocolArrayTy,
1709 Elements.push_back(NULLPtr);
1710 Elements.push_back(llvm::ConstantInt::get(LongTy, Protocols.size()));
1711 Elements.push_back(ProtocolArray);
1712 return MakeGlobal(ProtocolListTy, Elements, ".objc_protocol_list");
1715 llvm::Value *CGObjCGNU::GenerateProtocolRef(CodeGenFunction &CGF,
1716 const ObjCProtocolDecl *PD) {
1717 llvm::Value *protocol = ExistingProtocols[PD->getNameAsString()];
1719 CGM.getTypes().ConvertType(CGM.getContext().getObjCProtoType());
1720 return CGF.Builder.CreateBitCast(protocol, llvm::PointerType::getUnqual(T));
1723 llvm::Constant *CGObjCGNU::GenerateEmptyProtocol(
1724 const std::string &ProtocolName) {
1725 SmallVector<std::string, 0> EmptyStringVector;
1726 SmallVector<llvm::Constant*, 0> EmptyConstantVector;
1728 llvm::Constant *ProtocolList = GenerateProtocolList(EmptyStringVector);
1729 llvm::Constant *MethodList =
1730 GenerateProtocolMethodList(EmptyConstantVector, EmptyConstantVector);
1731 // Protocols are objects containing lists of the methods implemented and
1732 // protocols adopted.
1733 llvm::StructType *ProtocolTy = llvm::StructType::get(IdTy,
1735 ProtocolList->getType(),
1736 MethodList->getType(),
1737 MethodList->getType(),
1738 MethodList->getType(),
1739 MethodList->getType(),
1741 std::vector<llvm::Constant*> Elements;
1742 // The isa pointer must be set to a magic number so the runtime knows it's
1743 // the correct layout.
1744 Elements.push_back(llvm::ConstantExpr::getIntToPtr(
1745 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
1746 Elements.push_back(MakeConstantString(ProtocolName, ".objc_protocol_name"));
1747 Elements.push_back(ProtocolList);
1748 Elements.push_back(MethodList);
1749 Elements.push_back(MethodList);
1750 Elements.push_back(MethodList);
1751 Elements.push_back(MethodList);
1752 return MakeGlobal(ProtocolTy, Elements, ".objc_protocol");
1755 void CGObjCGNU::GenerateProtocol(const ObjCProtocolDecl *PD) {
1756 ASTContext &Context = CGM.getContext();
1757 std::string ProtocolName = PD->getNameAsString();
1759 // Use the protocol definition, if there is one.
1760 if (const ObjCProtocolDecl *Def = PD->getDefinition())
1763 SmallVector<std::string, 16> Protocols;
1764 for (const auto *PI : PD->protocols())
1765 Protocols.push_back(PI->getNameAsString());
1766 SmallVector<llvm::Constant*, 16> InstanceMethodNames;
1767 SmallVector<llvm::Constant*, 16> InstanceMethodTypes;
1768 SmallVector<llvm::Constant*, 16> OptionalInstanceMethodNames;
1769 SmallVector<llvm::Constant*, 16> OptionalInstanceMethodTypes;
1770 for (const auto *I : PD->instance_methods()) {
1771 std::string TypeStr;
1772 Context.getObjCEncodingForMethodDecl(I, TypeStr);
1773 if (I->getImplementationControl() == ObjCMethodDecl::Optional) {
1774 OptionalInstanceMethodNames.push_back(
1775 MakeConstantString(I->getSelector().getAsString()));
1776 OptionalInstanceMethodTypes.push_back(MakeConstantString(TypeStr));
1778 InstanceMethodNames.push_back(
1779 MakeConstantString(I->getSelector().getAsString()));
1780 InstanceMethodTypes.push_back(MakeConstantString(TypeStr));
1783 // Collect information about class methods:
1784 SmallVector<llvm::Constant*, 16> ClassMethodNames;
1785 SmallVector<llvm::Constant*, 16> ClassMethodTypes;
1786 SmallVector<llvm::Constant*, 16> OptionalClassMethodNames;
1787 SmallVector<llvm::Constant*, 16> OptionalClassMethodTypes;
1788 for (const auto *I : PD->class_methods()) {
1789 std::string TypeStr;
1790 Context.getObjCEncodingForMethodDecl(I,TypeStr);
1791 if (I->getImplementationControl() == ObjCMethodDecl::Optional) {
1792 OptionalClassMethodNames.push_back(
1793 MakeConstantString(I->getSelector().getAsString()));
1794 OptionalClassMethodTypes.push_back(MakeConstantString(TypeStr));
1796 ClassMethodNames.push_back(
1797 MakeConstantString(I->getSelector().getAsString()));
1798 ClassMethodTypes.push_back(MakeConstantString(TypeStr));
1802 llvm::Constant *ProtocolList = GenerateProtocolList(Protocols);
1803 llvm::Constant *InstanceMethodList =
1804 GenerateProtocolMethodList(InstanceMethodNames, InstanceMethodTypes);
1805 llvm::Constant *ClassMethodList =
1806 GenerateProtocolMethodList(ClassMethodNames, ClassMethodTypes);
1807 llvm::Constant *OptionalInstanceMethodList =
1808 GenerateProtocolMethodList(OptionalInstanceMethodNames,
1809 OptionalInstanceMethodTypes);
1810 llvm::Constant *OptionalClassMethodList =
1811 GenerateProtocolMethodList(OptionalClassMethodNames,
1812 OptionalClassMethodTypes);
1814 // Property metadata: name, attributes, isSynthesized, setter name, setter
1815 // types, getter name, getter types.
1816 // The isSynthesized value is always set to 0 in a protocol. It exists to
1817 // simplify the runtime library by allowing it to use the same data
1818 // structures for protocol metadata everywhere.
1819 llvm::StructType *PropertyMetadataTy = llvm::StructType::get(
1820 PtrToInt8Ty, Int8Ty, Int8Ty, Int8Ty, Int8Ty, PtrToInt8Ty,
1821 PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty, nullptr);
1822 std::vector<llvm::Constant*> Properties;
1823 std::vector<llvm::Constant*> OptionalProperties;
1825 // Add all of the property methods need adding to the method list and to the
1826 // property metadata list.
1827 for (auto *property : PD->properties()) {
1828 std::vector<llvm::Constant*> Fields;
1830 Fields.push_back(MakePropertyEncodingString(property, nullptr));
1831 PushPropertyAttributes(Fields, property);
1833 if (ObjCMethodDecl *getter = property->getGetterMethodDecl()) {
1834 std::string TypeStr;
1835 Context.getObjCEncodingForMethodDecl(getter,TypeStr);
1836 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
1837 InstanceMethodTypes.push_back(TypeEncoding);
1838 Fields.push_back(MakeConstantString(getter->getSelector().getAsString()));
1839 Fields.push_back(TypeEncoding);
1841 Fields.push_back(NULLPtr);
1842 Fields.push_back(NULLPtr);
1844 if (ObjCMethodDecl *setter = property->getSetterMethodDecl()) {
1845 std::string TypeStr;
1846 Context.getObjCEncodingForMethodDecl(setter,TypeStr);
1847 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
1848 InstanceMethodTypes.push_back(TypeEncoding);
1849 Fields.push_back(MakeConstantString(setter->getSelector().getAsString()));
1850 Fields.push_back(TypeEncoding);
1852 Fields.push_back(NULLPtr);
1853 Fields.push_back(NULLPtr);
1855 if (property->getPropertyImplementation() == ObjCPropertyDecl::Optional) {
1856 OptionalProperties.push_back(llvm::ConstantStruct::get(PropertyMetadataTy, Fields));
1858 Properties.push_back(llvm::ConstantStruct::get(PropertyMetadataTy, Fields));
1861 llvm::Constant *PropertyArray = llvm::ConstantArray::get(
1862 llvm::ArrayType::get(PropertyMetadataTy, Properties.size()), Properties);
1863 llvm::Constant* PropertyListInitFields[] =
1864 {llvm::ConstantInt::get(IntTy, Properties.size()), NULLPtr, PropertyArray};
1866 llvm::Constant *PropertyListInit =
1867 llvm::ConstantStruct::getAnon(PropertyListInitFields);
1868 llvm::Constant *PropertyList = new llvm::GlobalVariable(TheModule,
1869 PropertyListInit->getType(), false, llvm::GlobalValue::InternalLinkage,
1870 PropertyListInit, ".objc_property_list");
1872 llvm::Constant *OptionalPropertyArray =
1873 llvm::ConstantArray::get(llvm::ArrayType::get(PropertyMetadataTy,
1874 OptionalProperties.size()) , OptionalProperties);
1875 llvm::Constant* OptionalPropertyListInitFields[] = {
1876 llvm::ConstantInt::get(IntTy, OptionalProperties.size()), NULLPtr,
1877 OptionalPropertyArray };
1879 llvm::Constant *OptionalPropertyListInit =
1880 llvm::ConstantStruct::getAnon(OptionalPropertyListInitFields);
1881 llvm::Constant *OptionalPropertyList = new llvm::GlobalVariable(TheModule,
1882 OptionalPropertyListInit->getType(), false,
1883 llvm::GlobalValue::InternalLinkage, OptionalPropertyListInit,
1884 ".objc_property_list");
1886 // Protocols are objects containing lists of the methods implemented and
1887 // protocols adopted.
1888 llvm::StructType *ProtocolTy = llvm::StructType::get(IdTy,
1890 ProtocolList->getType(),
1891 InstanceMethodList->getType(),
1892 ClassMethodList->getType(),
1893 OptionalInstanceMethodList->getType(),
1894 OptionalClassMethodList->getType(),
1895 PropertyList->getType(),
1896 OptionalPropertyList->getType(),
1898 std::vector<llvm::Constant*> Elements;
1899 // The isa pointer must be set to a magic number so the runtime knows it's
1900 // the correct layout.
1901 Elements.push_back(llvm::ConstantExpr::getIntToPtr(
1902 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
1903 Elements.push_back(MakeConstantString(ProtocolName, ".objc_protocol_name"));
1904 Elements.push_back(ProtocolList);
1905 Elements.push_back(InstanceMethodList);
1906 Elements.push_back(ClassMethodList);
1907 Elements.push_back(OptionalInstanceMethodList);
1908 Elements.push_back(OptionalClassMethodList);
1909 Elements.push_back(PropertyList);
1910 Elements.push_back(OptionalPropertyList);
1911 ExistingProtocols[ProtocolName] =
1912 llvm::ConstantExpr::getBitCast(MakeGlobal(ProtocolTy, Elements,
1913 ".objc_protocol"), IdTy);
1915 void CGObjCGNU::GenerateProtocolHolderCategory() {
1916 // Collect information about instance methods
1917 SmallVector<Selector, 1> MethodSels;
1918 SmallVector<llvm::Constant*, 1> MethodTypes;
1920 std::vector<llvm::Constant*> Elements;
1921 const std::string ClassName = "__ObjC_Protocol_Holder_Ugly_Hack";
1922 const std::string CategoryName = "AnotherHack";
1923 Elements.push_back(MakeConstantString(CategoryName));
1924 Elements.push_back(MakeConstantString(ClassName));
1925 // Instance method list
1926 Elements.push_back(llvm::ConstantExpr::getBitCast(GenerateMethodList(
1927 ClassName, CategoryName, MethodSels, MethodTypes, false), PtrTy));
1928 // Class method list
1929 Elements.push_back(llvm::ConstantExpr::getBitCast(GenerateMethodList(
1930 ClassName, CategoryName, MethodSels, MethodTypes, true), PtrTy));
1932 llvm::ArrayType *ProtocolArrayTy = llvm::ArrayType::get(PtrTy,
1933 ExistingProtocols.size());
1934 llvm::StructType *ProtocolListTy = llvm::StructType::get(
1935 PtrTy, //Should be a recurisve pointer, but it's always NULL here.
1939 std::vector<llvm::Constant*> ProtocolElements;
1940 for (llvm::StringMapIterator<llvm::Constant*> iter =
1941 ExistingProtocols.begin(), endIter = ExistingProtocols.end();
1942 iter != endIter ; iter++) {
1943 llvm::Constant *Ptr = llvm::ConstantExpr::getBitCast(iter->getValue(),
1945 ProtocolElements.push_back(Ptr);
1947 llvm::Constant * ProtocolArray = llvm::ConstantArray::get(ProtocolArrayTy,
1949 ProtocolElements.clear();
1950 ProtocolElements.push_back(NULLPtr);
1951 ProtocolElements.push_back(llvm::ConstantInt::get(LongTy,
1952 ExistingProtocols.size()));
1953 ProtocolElements.push_back(ProtocolArray);
1954 Elements.push_back(llvm::ConstantExpr::getBitCast(MakeGlobal(ProtocolListTy,
1955 ProtocolElements, ".objc_protocol_list"), PtrTy));
1956 Categories.push_back(llvm::ConstantExpr::getBitCast(
1957 MakeGlobal(llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty,
1958 PtrTy, PtrTy, PtrTy, nullptr), Elements), PtrTy));
1961 /// Libobjc2 uses a bitfield representation where small(ish) bitfields are
1962 /// stored in a 64-bit value with the low bit set to 1 and the remaining 63
1963 /// bits set to their values, LSB first, while larger ones are stored in a
1964 /// structure of this / form:
1966 /// struct { int32_t length; int32_t values[length]; };
1968 /// The values in the array are stored in host-endian format, with the least
1969 /// significant bit being assumed to come first in the bitfield. Therefore, a
1970 /// bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] }, while a
1971 /// bitfield / with the 63rd bit set will be 1<<64.
1972 llvm::Constant *CGObjCGNU::MakeBitField(ArrayRef<bool> bits) {
1973 int bitCount = bits.size();
1974 int ptrBits = CGM.getDataLayout().getPointerSizeInBits();
1975 if (bitCount < ptrBits) {
1977 for (int i=0 ; i<bitCount ; ++i) {
1978 if (bits[i]) val |= 1ULL<<(i+1);
1980 return llvm::ConstantInt::get(IntPtrTy, val);
1982 SmallVector<llvm::Constant *, 8> values;
1984 while (v < bitCount) {
1986 for (int i=0 ; (i<32) && (v<bitCount) ; ++i) {
1987 if (bits[v]) word |= 1<<i;
1990 values.push_back(llvm::ConstantInt::get(Int32Ty, word));
1992 llvm::ArrayType *arrayTy = llvm::ArrayType::get(Int32Ty, values.size());
1993 llvm::Constant *array = llvm::ConstantArray::get(arrayTy, values);
1994 llvm::Constant *fields[2] = {
1995 llvm::ConstantInt::get(Int32Ty, values.size()),
1997 llvm::Constant *GS = MakeGlobal(llvm::StructType::get(Int32Ty, arrayTy,
1999 llvm::Constant *ptr = llvm::ConstantExpr::getPtrToInt(GS, IntPtrTy);
2003 void CGObjCGNU::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
2004 std::string ClassName = OCD->getClassInterface()->getNameAsString();
2005 std::string CategoryName = OCD->getNameAsString();
2006 // Collect information about instance methods
2007 SmallVector<Selector, 16> InstanceMethodSels;
2008 SmallVector<llvm::Constant*, 16> InstanceMethodTypes;
2009 for (const auto *I : OCD->instance_methods()) {
2010 InstanceMethodSels.push_back(I->getSelector());
2011 std::string TypeStr;
2012 CGM.getContext().getObjCEncodingForMethodDecl(I,TypeStr);
2013 InstanceMethodTypes.push_back(MakeConstantString(TypeStr));
2016 // Collect information about class methods
2017 SmallVector<Selector, 16> ClassMethodSels;
2018 SmallVector<llvm::Constant*, 16> ClassMethodTypes;
2019 for (const auto *I : OCD->class_methods()) {
2020 ClassMethodSels.push_back(I->getSelector());
2021 std::string TypeStr;
2022 CGM.getContext().getObjCEncodingForMethodDecl(I,TypeStr);
2023 ClassMethodTypes.push_back(MakeConstantString(TypeStr));
2026 // Collect the names of referenced protocols
2027 SmallVector<std::string, 16> Protocols;
2028 const ObjCCategoryDecl *CatDecl = OCD->getCategoryDecl();
2029 const ObjCList<ObjCProtocolDecl> &Protos = CatDecl->getReferencedProtocols();
2030 for (ObjCList<ObjCProtocolDecl>::iterator I = Protos.begin(),
2031 E = Protos.end(); I != E; ++I)
2032 Protocols.push_back((*I)->getNameAsString());
2034 std::vector<llvm::Constant*> Elements;
2035 Elements.push_back(MakeConstantString(CategoryName));
2036 Elements.push_back(MakeConstantString(ClassName));
2037 // Instance method list
2038 Elements.push_back(llvm::ConstantExpr::getBitCast(GenerateMethodList(
2039 ClassName, CategoryName, InstanceMethodSels, InstanceMethodTypes,
2041 // Class method list
2042 Elements.push_back(llvm::ConstantExpr::getBitCast(GenerateMethodList(
2043 ClassName, CategoryName, ClassMethodSels, ClassMethodTypes, true),
2046 Elements.push_back(llvm::ConstantExpr::getBitCast(
2047 GenerateProtocolList(Protocols), PtrTy));
2048 Categories.push_back(llvm::ConstantExpr::getBitCast(
2049 MakeGlobal(llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty,
2050 PtrTy, PtrTy, PtrTy, nullptr), Elements), PtrTy));
2053 llvm::Constant *CGObjCGNU::GeneratePropertyList(const ObjCImplementationDecl *OID,
2054 SmallVectorImpl<Selector> &InstanceMethodSels,
2055 SmallVectorImpl<llvm::Constant*> &InstanceMethodTypes) {
2056 ASTContext &Context = CGM.getContext();
2057 // Property metadata: name, attributes, attributes2, padding1, padding2,
2058 // setter name, setter types, getter name, getter types.
2059 llvm::StructType *PropertyMetadataTy = llvm::StructType::get(
2060 PtrToInt8Ty, Int8Ty, Int8Ty, Int8Ty, Int8Ty, PtrToInt8Ty,
2061 PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty, nullptr);
2062 std::vector<llvm::Constant*> Properties;
2064 // Add all of the property methods need adding to the method list and to the
2065 // property metadata list.
2066 for (auto *propertyImpl : OID->property_impls()) {
2067 std::vector<llvm::Constant*> Fields;
2068 ObjCPropertyDecl *property = propertyImpl->getPropertyDecl();
2069 bool isSynthesized = (propertyImpl->getPropertyImplementation() ==
2070 ObjCPropertyImplDecl::Synthesize);
2071 bool isDynamic = (propertyImpl->getPropertyImplementation() ==
2072 ObjCPropertyImplDecl::Dynamic);
2074 Fields.push_back(MakePropertyEncodingString(property, OID));
2075 PushPropertyAttributes(Fields, property, isSynthesized, isDynamic);
2076 if (ObjCMethodDecl *getter = property->getGetterMethodDecl()) {
2077 std::string TypeStr;
2078 Context.getObjCEncodingForMethodDecl(getter,TypeStr);
2079 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
2080 if (isSynthesized) {
2081 InstanceMethodTypes.push_back(TypeEncoding);
2082 InstanceMethodSels.push_back(getter->getSelector());
2084 Fields.push_back(MakeConstantString(getter->getSelector().getAsString()));
2085 Fields.push_back(TypeEncoding);
2087 Fields.push_back(NULLPtr);
2088 Fields.push_back(NULLPtr);
2090 if (ObjCMethodDecl *setter = property->getSetterMethodDecl()) {
2091 std::string TypeStr;
2092 Context.getObjCEncodingForMethodDecl(setter,TypeStr);
2093 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
2094 if (isSynthesized) {
2095 InstanceMethodTypes.push_back(TypeEncoding);
2096 InstanceMethodSels.push_back(setter->getSelector());
2098 Fields.push_back(MakeConstantString(setter->getSelector().getAsString()));
2099 Fields.push_back(TypeEncoding);
2101 Fields.push_back(NULLPtr);
2102 Fields.push_back(NULLPtr);
2104 Properties.push_back(llvm::ConstantStruct::get(PropertyMetadataTy, Fields));
2106 llvm::ArrayType *PropertyArrayTy =
2107 llvm::ArrayType::get(PropertyMetadataTy, Properties.size());
2108 llvm::Constant *PropertyArray = llvm::ConstantArray::get(PropertyArrayTy,
2110 llvm::Constant* PropertyListInitFields[] =
2111 {llvm::ConstantInt::get(IntTy, Properties.size()), NULLPtr, PropertyArray};
2113 llvm::Constant *PropertyListInit =
2114 llvm::ConstantStruct::getAnon(PropertyListInitFields);
2115 return new llvm::GlobalVariable(TheModule, PropertyListInit->getType(), false,
2116 llvm::GlobalValue::InternalLinkage, PropertyListInit,
2117 ".objc_property_list");
2120 void CGObjCGNU::RegisterAlias(const ObjCCompatibleAliasDecl *OAD) {
2121 // Get the class declaration for which the alias is specified.
2122 ObjCInterfaceDecl *ClassDecl =
2123 const_cast<ObjCInterfaceDecl *>(OAD->getClassInterface());
2124 std::string ClassName = ClassDecl->getNameAsString();
2125 std::string AliasName = OAD->getNameAsString();
2126 ClassAliases.push_back(ClassAliasPair(ClassName,AliasName));
2129 void CGObjCGNU::GenerateClass(const ObjCImplementationDecl *OID) {
2130 ASTContext &Context = CGM.getContext();
2132 // Get the superclass name.
2133 const ObjCInterfaceDecl * SuperClassDecl =
2134 OID->getClassInterface()->getSuperClass();
2135 std::string SuperClassName;
2136 if (SuperClassDecl) {
2137 SuperClassName = SuperClassDecl->getNameAsString();
2138 EmitClassRef(SuperClassName);
2141 // Get the class name
2142 ObjCInterfaceDecl *ClassDecl =
2143 const_cast<ObjCInterfaceDecl *>(OID->getClassInterface());
2144 std::string ClassName = ClassDecl->getNameAsString();
2145 // Emit the symbol that is used to generate linker errors if this class is
2146 // referenced in other modules but not declared.
2147 std::string classSymbolName = "__objc_class_name_" + ClassName;
2148 if (llvm::GlobalVariable *symbol =
2149 TheModule.getGlobalVariable(classSymbolName)) {
2150 symbol->setInitializer(llvm::ConstantInt::get(LongTy, 0));
2152 new llvm::GlobalVariable(TheModule, LongTy, false,
2153 llvm::GlobalValue::ExternalLinkage, llvm::ConstantInt::get(LongTy, 0),
2157 // Get the size of instances.
2159 Context.getASTObjCImplementationLayout(OID).getSize().getQuantity();
2161 // Collect information about instance variables.
2162 SmallVector<llvm::Constant*, 16> IvarNames;
2163 SmallVector<llvm::Constant*, 16> IvarTypes;
2164 SmallVector<llvm::Constant*, 16> IvarOffsets;
2166 std::vector<llvm::Constant*> IvarOffsetValues;
2167 SmallVector<bool, 16> WeakIvars;
2168 SmallVector<bool, 16> StrongIvars;
2170 int superInstanceSize = !SuperClassDecl ? 0 :
2171 Context.getASTObjCInterfaceLayout(SuperClassDecl).getSize().getQuantity();
2172 // For non-fragile ivars, set the instance size to 0 - {the size of just this
2173 // class}. The runtime will then set this to the correct value on load.
2174 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2175 instanceSize = 0 - (instanceSize - superInstanceSize);
2178 for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD;
2179 IVD = IVD->getNextIvar()) {
2181 IvarNames.push_back(MakeConstantString(IVD->getNameAsString()));
2182 // Get the type encoding for this ivar
2183 std::string TypeStr;
2184 Context.getObjCEncodingForType(IVD->getType(), TypeStr);
2185 IvarTypes.push_back(MakeConstantString(TypeStr));
2187 uint64_t BaseOffset = ComputeIvarBaseOffset(CGM, OID, IVD);
2188 uint64_t Offset = BaseOffset;
2189 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2190 Offset = BaseOffset - superInstanceSize;
2192 llvm::Constant *OffsetValue = llvm::ConstantInt::get(IntTy, Offset);
2193 // Create the direct offset value
2194 std::string OffsetName = "__objc_ivar_offset_value_" + ClassName +"." +
2195 IVD->getNameAsString();
2196 llvm::GlobalVariable *OffsetVar = TheModule.getGlobalVariable(OffsetName);
2198 OffsetVar->setInitializer(OffsetValue);
2199 // If this is the real definition, change its linkage type so that
2200 // different modules will use this one, rather than their private
2202 OffsetVar->setLinkage(llvm::GlobalValue::ExternalLinkage);
2204 OffsetVar = new llvm::GlobalVariable(TheModule, IntTy,
2205 false, llvm::GlobalValue::ExternalLinkage,
2207 "__objc_ivar_offset_value_" + ClassName +"." +
2208 IVD->getNameAsString());
2209 IvarOffsets.push_back(OffsetValue);
2210 IvarOffsetValues.push_back(OffsetVar);
2211 Qualifiers::ObjCLifetime lt = IVD->getType().getQualifiers().getObjCLifetime();
2213 case Qualifiers::OCL_Strong:
2214 StrongIvars.push_back(true);
2215 WeakIvars.push_back(false);
2217 case Qualifiers::OCL_Weak:
2218 StrongIvars.push_back(false);
2219 WeakIvars.push_back(true);
2222 StrongIvars.push_back(false);
2223 WeakIvars.push_back(false);
2226 llvm::Constant *StrongIvarBitmap = MakeBitField(StrongIvars);
2227 llvm::Constant *WeakIvarBitmap = MakeBitField(WeakIvars);
2228 llvm::GlobalVariable *IvarOffsetArray =
2229 MakeGlobalArray(PtrToIntTy, IvarOffsetValues, ".ivar.offsets");
2232 // Collect information about instance methods
2233 SmallVector<Selector, 16> InstanceMethodSels;
2234 SmallVector<llvm::Constant*, 16> InstanceMethodTypes;
2235 for (const auto *I : OID->instance_methods()) {
2236 InstanceMethodSels.push_back(I->getSelector());
2237 std::string TypeStr;
2238 Context.getObjCEncodingForMethodDecl(I,TypeStr);
2239 InstanceMethodTypes.push_back(MakeConstantString(TypeStr));
2242 llvm::Constant *Properties = GeneratePropertyList(OID, InstanceMethodSels,
2243 InstanceMethodTypes);
2246 // Collect information about class methods
2247 SmallVector<Selector, 16> ClassMethodSels;
2248 SmallVector<llvm::Constant*, 16> ClassMethodTypes;
2249 for (const auto *I : OID->class_methods()) {
2250 ClassMethodSels.push_back(I->getSelector());
2251 std::string TypeStr;
2252 Context.getObjCEncodingForMethodDecl(I,TypeStr);
2253 ClassMethodTypes.push_back(MakeConstantString(TypeStr));
2255 // Collect the names of referenced protocols
2256 SmallVector<std::string, 16> Protocols;
2257 for (const auto *I : ClassDecl->protocols())
2258 Protocols.push_back(I->getNameAsString());
2260 // Get the superclass pointer.
2261 llvm::Constant *SuperClass;
2262 if (!SuperClassName.empty()) {
2263 SuperClass = MakeConstantString(SuperClassName, ".super_class_name");
2265 SuperClass = llvm::ConstantPointerNull::get(PtrToInt8Ty);
2267 // Empty vector used to construct empty method lists
2268 SmallVector<llvm::Constant*, 1> empty;
2269 // Generate the method and instance variable lists
2270 llvm::Constant *MethodList = GenerateMethodList(ClassName, "",
2271 InstanceMethodSels, InstanceMethodTypes, false);
2272 llvm::Constant *ClassMethodList = GenerateMethodList(ClassName, "",
2273 ClassMethodSels, ClassMethodTypes, true);
2274 llvm::Constant *IvarList = GenerateIvarList(IvarNames, IvarTypes,
2276 // Irrespective of whether we are compiling for a fragile or non-fragile ABI,
2277 // we emit a symbol containing the offset for each ivar in the class. This
2278 // allows code compiled for the non-Fragile ABI to inherit from code compiled
2279 // for the legacy ABI, without causing problems. The converse is also
2280 // possible, but causes all ivar accesses to be fragile.
2282 // Offset pointer for getting at the correct field in the ivar list when
2283 // setting up the alias. These are: The base address for the global, the
2284 // ivar array (second field), the ivar in this list (set for each ivar), and
2285 // the offset (third field in ivar structure)
2286 llvm::Type *IndexTy = Int32Ty;
2287 llvm::Constant *offsetPointerIndexes[] = {Zeros[0],
2288 llvm::ConstantInt::get(IndexTy, 1), nullptr,
2289 llvm::ConstantInt::get(IndexTy, 2) };
2291 unsigned ivarIndex = 0;
2292 for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD;
2293 IVD = IVD->getNextIvar()) {
2294 const std::string Name = "__objc_ivar_offset_" + ClassName + '.'
2295 + IVD->getNameAsString();
2296 offsetPointerIndexes[2] = llvm::ConstantInt::get(IndexTy, ivarIndex);
2297 // Get the correct ivar field
2298 llvm::Constant *offsetValue = llvm::ConstantExpr::getGetElementPtr(
2299 cast<llvm::GlobalVariable>(IvarList)->getValueType(), IvarList,
2300 offsetPointerIndexes);
2301 // Get the existing variable, if one exists.
2302 llvm::GlobalVariable *offset = TheModule.getNamedGlobal(Name);
2304 offset->setInitializer(offsetValue);
2305 // If this is the real definition, change its linkage type so that
2306 // different modules will use this one, rather than their private
2308 offset->setLinkage(llvm::GlobalValue::ExternalLinkage);
2310 // Add a new alias if there isn't one already.
2311 offset = new llvm::GlobalVariable(TheModule, offsetValue->getType(),
2312 false, llvm::GlobalValue::ExternalLinkage, offsetValue, Name);
2313 (void) offset; // Silence dead store warning.
2317 llvm::Constant *ZeroPtr = llvm::ConstantInt::get(IntPtrTy, 0);
2318 //Generate metaclass for class methods
2319 llvm::Constant *MetaClassStruct = GenerateClassStructure(NULLPtr,
2320 NULLPtr, 0x12L, ClassName.c_str(), nullptr, Zeros[0], GenerateIvarList(
2321 empty, empty, empty), ClassMethodList, NULLPtr,
2322 NULLPtr, NULLPtr, ZeroPtr, ZeroPtr, true);
2324 // Generate the class structure
2325 llvm::Constant *ClassStruct =
2326 GenerateClassStructure(MetaClassStruct, SuperClass, 0x11L,
2327 ClassName.c_str(), nullptr,
2328 llvm::ConstantInt::get(LongTy, instanceSize), IvarList,
2329 MethodList, GenerateProtocolList(Protocols), IvarOffsetArray,
2330 Properties, StrongIvarBitmap, WeakIvarBitmap);
2332 // Resolve the class aliases, if they exist.
2333 if (ClassPtrAlias) {
2334 ClassPtrAlias->replaceAllUsesWith(
2335 llvm::ConstantExpr::getBitCast(ClassStruct, IdTy));
2336 ClassPtrAlias->eraseFromParent();
2337 ClassPtrAlias = nullptr;
2339 if (MetaClassPtrAlias) {
2340 MetaClassPtrAlias->replaceAllUsesWith(
2341 llvm::ConstantExpr::getBitCast(MetaClassStruct, IdTy));
2342 MetaClassPtrAlias->eraseFromParent();
2343 MetaClassPtrAlias = nullptr;
2346 // Add class structure to list to be added to the symtab later
2347 ClassStruct = llvm::ConstantExpr::getBitCast(ClassStruct, PtrToInt8Ty);
2348 Classes.push_back(ClassStruct);
2352 llvm::Function *CGObjCGNU::ModuleInitFunction() {
2353 // Only emit an ObjC load function if no Objective-C stuff has been called
2354 if (Classes.empty() && Categories.empty() && ConstantStrings.empty() &&
2355 ExistingProtocols.empty() && SelectorTable.empty())
2358 // Add all referenced protocols to a category.
2359 GenerateProtocolHolderCategory();
2361 llvm::StructType *SelStructTy = dyn_cast<llvm::StructType>(
2362 SelectorTy->getElementType());
2363 llvm::Type *SelStructPtrTy = SelectorTy;
2365 SelStructTy = llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty, nullptr);
2366 SelStructPtrTy = llvm::PointerType::getUnqual(SelStructTy);
2369 std::vector<llvm::Constant*> Elements;
2370 llvm::Constant *Statics = NULLPtr;
2371 // Generate statics list:
2372 if (!ConstantStrings.empty()) {
2373 llvm::ArrayType *StaticsArrayTy = llvm::ArrayType::get(PtrToInt8Ty,
2374 ConstantStrings.size() + 1);
2375 ConstantStrings.push_back(NULLPtr);
2377 StringRef StringClass = CGM.getLangOpts().ObjCConstantStringClass;
2379 if (StringClass.empty()) StringClass = "NXConstantString";
2381 Elements.push_back(MakeConstantString(StringClass,
2382 ".objc_static_class_name"));
2383 Elements.push_back(llvm::ConstantArray::get(StaticsArrayTy,
2385 llvm::StructType *StaticsListTy =
2386 llvm::StructType::get(PtrToInt8Ty, StaticsArrayTy, nullptr);
2387 llvm::Type *StaticsListPtrTy =
2388 llvm::PointerType::getUnqual(StaticsListTy);
2389 Statics = MakeGlobal(StaticsListTy, Elements, ".objc_statics");
2390 llvm::ArrayType *StaticsListArrayTy =
2391 llvm::ArrayType::get(StaticsListPtrTy, 2);
2393 Elements.push_back(Statics);
2394 Elements.push_back(llvm::Constant::getNullValue(StaticsListPtrTy));
2395 Statics = MakeGlobal(StaticsListArrayTy, Elements, ".objc_statics_ptr");
2396 Statics = llvm::ConstantExpr::getBitCast(Statics, PtrTy);
2398 // Array of classes, categories, and constant objects
2399 llvm::ArrayType *ClassListTy = llvm::ArrayType::get(PtrToInt8Ty,
2400 Classes.size() + Categories.size() + 2);
2401 llvm::StructType *SymTabTy = llvm::StructType::get(LongTy, SelStructPtrTy,
2402 llvm::Type::getInt16Ty(VMContext),
2403 llvm::Type::getInt16Ty(VMContext),
2404 ClassListTy, nullptr);
2407 // Pointer to an array of selectors used in this module.
2408 std::vector<llvm::Constant*> Selectors;
2409 std::vector<llvm::GlobalAlias*> SelectorAliases;
2410 for (SelectorMap::iterator iter = SelectorTable.begin(),
2411 iterEnd = SelectorTable.end(); iter != iterEnd ; ++iter) {
2413 std::string SelNameStr = iter->first.getAsString();
2414 llvm::Constant *SelName = ExportUniqueString(SelNameStr, ".objc_sel_name");
2416 SmallVectorImpl<TypedSelector> &Types = iter->second;
2417 for (SmallVectorImpl<TypedSelector>::iterator i = Types.begin(),
2418 e = Types.end() ; i!=e ; i++) {
2420 llvm::Constant *SelectorTypeEncoding = NULLPtr;
2421 if (!i->first.empty())
2422 SelectorTypeEncoding = MakeConstantString(i->first, ".objc_sel_types");
2424 Elements.push_back(SelName);
2425 Elements.push_back(SelectorTypeEncoding);
2426 Selectors.push_back(llvm::ConstantStruct::get(SelStructTy, Elements));
2429 // Store the selector alias for later replacement
2430 SelectorAliases.push_back(i->second);
2433 unsigned SelectorCount = Selectors.size();
2434 // NULL-terminate the selector list. This should not actually be required,
2435 // because the selector list has a length field. Unfortunately, the GCC
2436 // runtime decides to ignore the length field and expects a NULL terminator,
2437 // and GCC cooperates with this by always setting the length to 0.
2438 Elements.push_back(NULLPtr);
2439 Elements.push_back(NULLPtr);
2440 Selectors.push_back(llvm::ConstantStruct::get(SelStructTy, Elements));
2443 // Number of static selectors
2444 Elements.push_back(llvm::ConstantInt::get(LongTy, SelectorCount));
2445 llvm::GlobalVariable *SelectorList =
2446 MakeGlobalArray(SelStructTy, Selectors, ".objc_selector_list");
2447 Elements.push_back(llvm::ConstantExpr::getBitCast(SelectorList,
2450 // Now that all of the static selectors exist, create pointers to them.
2451 for (unsigned int i=0 ; i<SelectorCount ; i++) {
2453 llvm::Constant *Idxs[] = {Zeros[0],
2454 llvm::ConstantInt::get(Int32Ty, i), Zeros[0]};
2455 // FIXME: We're generating redundant loads and stores here!
2456 llvm::Constant *SelPtr = llvm::ConstantExpr::getGetElementPtr(
2457 SelectorList->getValueType(), SelectorList, makeArrayRef(Idxs, 2));
2458 // If selectors are defined as an opaque type, cast the pointer to this
2460 SelPtr = llvm::ConstantExpr::getBitCast(SelPtr, SelectorTy);
2461 SelectorAliases[i]->replaceAllUsesWith(SelPtr);
2462 SelectorAliases[i]->eraseFromParent();
2465 // Number of classes defined.
2466 Elements.push_back(llvm::ConstantInt::get(llvm::Type::getInt16Ty(VMContext),
2468 // Number of categories defined
2469 Elements.push_back(llvm::ConstantInt::get(llvm::Type::getInt16Ty(VMContext),
2470 Categories.size()));
2471 // Create an array of classes, then categories, then static object instances
2472 Classes.insert(Classes.end(), Categories.begin(), Categories.end());
2473 // NULL-terminated list of static object instances (mainly constant strings)
2474 Classes.push_back(Statics);
2475 Classes.push_back(NULLPtr);
2476 llvm::Constant *ClassList = llvm::ConstantArray::get(ClassListTy, Classes);
2477 Elements.push_back(ClassList);
2478 // Construct the symbol table
2479 llvm::Constant *SymTab= MakeGlobal(SymTabTy, Elements);
2481 // The symbol table is contained in a module which has some version-checking
2483 llvm::StructType * ModuleTy = llvm::StructType::get(LongTy, LongTy,
2484 PtrToInt8Ty, llvm::PointerType::getUnqual(SymTabTy),
2485 (RuntimeVersion >= 10) ? IntTy : nullptr, nullptr);
2487 // Runtime version, used for ABI compatibility checking.
2488 Elements.push_back(llvm::ConstantInt::get(LongTy, RuntimeVersion));
2490 llvm::DataLayout td(&TheModule);
2492 llvm::ConstantInt::get(LongTy,
2493 td.getTypeSizeInBits(ModuleTy) /
2494 CGM.getContext().getCharWidth()));
2496 // The path to the source file where this module was declared
2497 SourceManager &SM = CGM.getContext().getSourceManager();
2498 const FileEntry *mainFile = SM.getFileEntryForID(SM.getMainFileID());
2500 std::string(mainFile->getDir()->getName()) + '/' + mainFile->getName();
2501 Elements.push_back(MakeConstantString(path, ".objc_source_file_name"));
2502 Elements.push_back(SymTab);
2504 if (RuntimeVersion >= 10)
2505 switch (CGM.getLangOpts().getGC()) {
2506 case LangOptions::GCOnly:
2507 Elements.push_back(llvm::ConstantInt::get(IntTy, 2));
2509 case LangOptions::NonGC:
2510 if (CGM.getLangOpts().ObjCAutoRefCount)
2511 Elements.push_back(llvm::ConstantInt::get(IntTy, 1));
2513 Elements.push_back(llvm::ConstantInt::get(IntTy, 0));
2515 case LangOptions::HybridGC:
2516 Elements.push_back(llvm::ConstantInt::get(IntTy, 1));
2520 llvm::Value *Module = MakeGlobal(ModuleTy, Elements);
2522 // Create the load function calling the runtime entry point with the module
2524 llvm::Function * LoadFunction = llvm::Function::Create(
2525 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext), false),
2526 llvm::GlobalValue::InternalLinkage, ".objc_load_function",
2528 llvm::BasicBlock *EntryBB =
2529 llvm::BasicBlock::Create(VMContext, "entry", LoadFunction);
2530 CGBuilderTy Builder(VMContext);
2531 Builder.SetInsertPoint(EntryBB);
2533 llvm::FunctionType *FT =
2534 llvm::FunctionType::get(Builder.getVoidTy(),
2535 llvm::PointerType::getUnqual(ModuleTy), true);
2536 llvm::Value *Register = CGM.CreateRuntimeFunction(FT, "__objc_exec_class");
2537 Builder.CreateCall(Register, Module);
2539 if (!ClassAliases.empty()) {
2540 llvm::Type *ArgTypes[2] = {PtrTy, PtrToInt8Ty};
2541 llvm::FunctionType *RegisterAliasTy =
2542 llvm::FunctionType::get(Builder.getVoidTy(),
2544 llvm::Function *RegisterAlias = llvm::Function::Create(
2546 llvm::GlobalValue::ExternalWeakLinkage, "class_registerAlias_np",
2548 llvm::BasicBlock *AliasBB =
2549 llvm::BasicBlock::Create(VMContext, "alias", LoadFunction);
2550 llvm::BasicBlock *NoAliasBB =
2551 llvm::BasicBlock::Create(VMContext, "no_alias", LoadFunction);
2553 // Branch based on whether the runtime provided class_registerAlias_np()
2554 llvm::Value *HasRegisterAlias = Builder.CreateICmpNE(RegisterAlias,
2555 llvm::Constant::getNullValue(RegisterAlias->getType()));
2556 Builder.CreateCondBr(HasRegisterAlias, AliasBB, NoAliasBB);
2558 // The true branch (has alias registration function):
2559 Builder.SetInsertPoint(AliasBB);
2560 // Emit alias registration calls:
2561 for (std::vector<ClassAliasPair>::iterator iter = ClassAliases.begin();
2562 iter != ClassAliases.end(); ++iter) {
2563 llvm::Constant *TheClass =
2564 TheModule.getGlobalVariable(("_OBJC_CLASS_" + iter->first).c_str(),
2567 TheClass = llvm::ConstantExpr::getBitCast(TheClass, PtrTy);
2568 Builder.CreateCall(RegisterAlias,
2569 {TheClass, MakeConstantString(iter->second)});
2573 Builder.CreateBr(NoAliasBB);
2575 // Missing alias registration function, just return from the function:
2576 Builder.SetInsertPoint(NoAliasBB);
2578 Builder.CreateRetVoid();
2580 return LoadFunction;
2583 llvm::Function *CGObjCGNU::GenerateMethod(const ObjCMethodDecl *OMD,
2584 const ObjCContainerDecl *CD) {
2585 const ObjCCategoryImplDecl *OCD =
2586 dyn_cast<ObjCCategoryImplDecl>(OMD->getDeclContext());
2587 StringRef CategoryName = OCD ? OCD->getName() : "";
2588 StringRef ClassName = CD->getName();
2589 Selector MethodName = OMD->getSelector();
2590 bool isClassMethod = !OMD->isInstanceMethod();
2592 CodeGenTypes &Types = CGM.getTypes();
2593 llvm::FunctionType *MethodTy =
2594 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
2595 std::string FunctionName = SymbolNameForMethod(ClassName, CategoryName,
2596 MethodName, isClassMethod);
2598 llvm::Function *Method
2599 = llvm::Function::Create(MethodTy,
2600 llvm::GlobalValue::InternalLinkage,
2606 llvm::Constant *CGObjCGNU::GetPropertyGetFunction() {
2607 return GetPropertyFn;
2610 llvm::Constant *CGObjCGNU::GetPropertySetFunction() {
2611 return SetPropertyFn;
2614 llvm::Constant *CGObjCGNU::GetOptimizedPropertySetFunction(bool atomic,
2619 llvm::Constant *CGObjCGNU::GetGetStructFunction() {
2620 return GetStructPropertyFn;
2622 llvm::Constant *CGObjCGNU::GetSetStructFunction() {
2623 return SetStructPropertyFn;
2625 llvm::Constant *CGObjCGNU::GetCppAtomicObjectGetFunction() {
2628 llvm::Constant *CGObjCGNU::GetCppAtomicObjectSetFunction() {
2632 llvm::Constant *CGObjCGNU::EnumerationMutationFunction() {
2633 return EnumerationMutationFn;
2636 void CGObjCGNU::EmitSynchronizedStmt(CodeGenFunction &CGF,
2637 const ObjCAtSynchronizedStmt &S) {
2638 EmitAtSynchronizedStmt(CGF, S, SyncEnterFn, SyncExitFn);
2642 void CGObjCGNU::EmitTryStmt(CodeGenFunction &CGF,
2643 const ObjCAtTryStmt &S) {
2644 // Unlike the Apple non-fragile runtimes, which also uses
2645 // unwind-based zero cost exceptions, the GNU Objective C runtime's
2646 // EH support isn't a veneer over C++ EH. Instead, exception
2647 // objects are created by objc_exception_throw and destroyed by
2648 // the personality function; this avoids the need for bracketing
2649 // catch handlers with calls to __blah_begin_catch/__blah_end_catch
2650 // (or even _Unwind_DeleteException), but probably doesn't
2651 // interoperate very well with foreign exceptions.
2653 // In Objective-C++ mode, we actually emit something equivalent to the C++
2654 // exception handler.
2655 EmitTryCatchStmt(CGF, S, EnterCatchFn, ExitCatchFn, ExceptionReThrowFn);
2659 void CGObjCGNU::EmitThrowStmt(CodeGenFunction &CGF,
2660 const ObjCAtThrowStmt &S,
2661 bool ClearInsertionPoint) {
2662 llvm::Value *ExceptionAsObject;
2664 if (const Expr *ThrowExpr = S.getThrowExpr()) {
2665 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
2666 ExceptionAsObject = Exception;
2668 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
2669 "Unexpected rethrow outside @catch block.");
2670 ExceptionAsObject = CGF.ObjCEHValueStack.back();
2672 ExceptionAsObject = CGF.Builder.CreateBitCast(ExceptionAsObject, IdTy);
2673 llvm::CallSite Throw =
2674 CGF.EmitRuntimeCallOrInvoke(ExceptionThrowFn, ExceptionAsObject);
2675 Throw.setDoesNotReturn();
2676 CGF.Builder.CreateUnreachable();
2677 if (ClearInsertionPoint)
2678 CGF.Builder.ClearInsertionPoint();
2681 llvm::Value * CGObjCGNU::EmitObjCWeakRead(CodeGenFunction &CGF,
2682 llvm::Value *AddrWeakObj) {
2683 CGBuilderTy &B = CGF.Builder;
2684 AddrWeakObj = EnforceType(B, AddrWeakObj, PtrToIdTy);
2685 return B.CreateCall(WeakReadFn.getType(), WeakReadFn, AddrWeakObj);
2688 void CGObjCGNU::EmitObjCWeakAssign(CodeGenFunction &CGF,
2689 llvm::Value *src, llvm::Value *dst) {
2690 CGBuilderTy &B = CGF.Builder;
2691 src = EnforceType(B, src, IdTy);
2692 dst = EnforceType(B, dst, PtrToIdTy);
2693 B.CreateCall(WeakAssignFn.getType(), WeakAssignFn, {src, dst});
2696 void CGObjCGNU::EmitObjCGlobalAssign(CodeGenFunction &CGF,
2697 llvm::Value *src, llvm::Value *dst,
2699 CGBuilderTy &B = CGF.Builder;
2700 src = EnforceType(B, src, IdTy);
2701 dst = EnforceType(B, dst, PtrToIdTy);
2702 // FIXME. Add threadloca assign API
2703 assert(!threadlocal && "EmitObjCGlobalAssign - Threal Local API NYI");
2704 B.CreateCall(GlobalAssignFn.getType(), GlobalAssignFn, {src, dst});
2707 void CGObjCGNU::EmitObjCIvarAssign(CodeGenFunction &CGF,
2708 llvm::Value *src, llvm::Value *dst,
2709 llvm::Value *ivarOffset) {
2710 CGBuilderTy &B = CGF.Builder;
2711 src = EnforceType(B, src, IdTy);
2712 dst = EnforceType(B, dst, IdTy);
2713 B.CreateCall(IvarAssignFn.getType(), IvarAssignFn, {src, dst, ivarOffset});
2716 void CGObjCGNU::EmitObjCStrongCastAssign(CodeGenFunction &CGF,
2717 llvm::Value *src, llvm::Value *dst) {
2718 CGBuilderTy &B = CGF.Builder;
2719 src = EnforceType(B, src, IdTy);
2720 dst = EnforceType(B, dst, PtrToIdTy);
2721 B.CreateCall(StrongCastAssignFn.getType(), StrongCastAssignFn, {src, dst});
2724 void CGObjCGNU::EmitGCMemmoveCollectable(CodeGenFunction &CGF,
2725 llvm::Value *DestPtr,
2726 llvm::Value *SrcPtr,
2727 llvm::Value *Size) {
2728 CGBuilderTy &B = CGF.Builder;
2729 DestPtr = EnforceType(B, DestPtr, PtrTy);
2730 SrcPtr = EnforceType(B, SrcPtr, PtrTy);
2732 B.CreateCall(MemMoveFn.getType(), MemMoveFn, {DestPtr, SrcPtr, Size});
2735 llvm::GlobalVariable *CGObjCGNU::ObjCIvarOffsetVariable(
2736 const ObjCInterfaceDecl *ID,
2737 const ObjCIvarDecl *Ivar) {
2738 const std::string Name = "__objc_ivar_offset_" + ID->getNameAsString()
2739 + '.' + Ivar->getNameAsString();
2740 // Emit the variable and initialize it with what we think the correct value
2741 // is. This allows code compiled with non-fragile ivars to work correctly
2742 // when linked against code which isn't (most of the time).
2743 llvm::GlobalVariable *IvarOffsetPointer = TheModule.getNamedGlobal(Name);
2744 if (!IvarOffsetPointer) {
2745 // This will cause a run-time crash if we accidentally use it. A value of
2746 // 0 would seem more sensible, but will silently overwrite the isa pointer
2747 // causing a great deal of confusion.
2748 uint64_t Offset = -1;
2749 // We can't call ComputeIvarBaseOffset() here if we have the
2750 // implementation, because it will create an invalid ASTRecordLayout object
2751 // that we are then stuck with forever, so we only initialize the ivar
2752 // offset variable with a guess if we only have the interface. The
2753 // initializer will be reset later anyway, when we are generating the class
2755 if (!CGM.getContext().getObjCImplementation(
2756 const_cast<ObjCInterfaceDecl *>(ID)))
2757 Offset = ComputeIvarBaseOffset(CGM, ID, Ivar);
2759 llvm::ConstantInt *OffsetGuess = llvm::ConstantInt::get(Int32Ty, Offset,
2761 // Don't emit the guess in non-PIC code because the linker will not be able
2762 // to replace it with the real version for a library. In non-PIC code you
2763 // must compile with the fragile ABI if you want to use ivars from a
2764 // GCC-compiled class.
2765 if (CGM.getLangOpts().PICLevel || CGM.getLangOpts().PIELevel) {
2766 llvm::GlobalVariable *IvarOffsetGV = new llvm::GlobalVariable(TheModule,
2768 llvm::GlobalValue::PrivateLinkage, OffsetGuess, Name+".guess");
2769 IvarOffsetPointer = new llvm::GlobalVariable(TheModule,
2770 IvarOffsetGV->getType(), false, llvm::GlobalValue::LinkOnceAnyLinkage,
2771 IvarOffsetGV, Name);
2773 IvarOffsetPointer = new llvm::GlobalVariable(TheModule,
2774 llvm::Type::getInt32PtrTy(VMContext), false,
2775 llvm::GlobalValue::ExternalLinkage, nullptr, Name);
2778 return IvarOffsetPointer;
2781 LValue CGObjCGNU::EmitObjCValueForIvar(CodeGenFunction &CGF,
2783 llvm::Value *BaseValue,
2784 const ObjCIvarDecl *Ivar,
2785 unsigned CVRQualifiers) {
2786 const ObjCInterfaceDecl *ID =
2787 ObjectTy->getAs<ObjCObjectType>()->getInterface();
2788 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
2789 EmitIvarOffset(CGF, ID, Ivar));
2792 static const ObjCInterfaceDecl *FindIvarInterface(ASTContext &Context,
2793 const ObjCInterfaceDecl *OID,
2794 const ObjCIvarDecl *OIVD) {
2795 for (const ObjCIvarDecl *next = OID->all_declared_ivar_begin(); next;
2796 next = next->getNextIvar()) {
2801 // Otherwise check in the super class.
2802 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
2803 return FindIvarInterface(Context, Super, OIVD);
2808 llvm::Value *CGObjCGNU::EmitIvarOffset(CodeGenFunction &CGF,
2809 const ObjCInterfaceDecl *Interface,
2810 const ObjCIvarDecl *Ivar) {
2811 if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2812 Interface = FindIvarInterface(CGM.getContext(), Interface, Ivar);
2813 if (RuntimeVersion < 10)
2814 return CGF.Builder.CreateZExtOrBitCast(
2815 CGF.Builder.CreateLoad(CGF.Builder.CreateLoad(
2816 ObjCIvarOffsetVariable(Interface, Ivar), false, "ivar")),
2818 std::string name = "__objc_ivar_offset_value_" +
2819 Interface->getNameAsString() +"." + Ivar->getNameAsString();
2820 llvm::Value *Offset = TheModule.getGlobalVariable(name);
2822 Offset = new llvm::GlobalVariable(TheModule, IntTy,
2823 false, llvm::GlobalValue::LinkOnceAnyLinkage,
2824 llvm::Constant::getNullValue(IntTy), name);
2825 Offset = CGF.Builder.CreateLoad(Offset);
2826 if (Offset->getType() != PtrDiffTy)
2827 Offset = CGF.Builder.CreateZExtOrBitCast(Offset, PtrDiffTy);
2830 uint64_t Offset = ComputeIvarBaseOffset(CGF.CGM, Interface, Ivar);
2831 return llvm::ConstantInt::get(PtrDiffTy, Offset, /*isSigned*/true);
2835 clang::CodeGen::CreateGNUObjCRuntime(CodeGenModule &CGM) {
2836 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
2837 case ObjCRuntime::GNUstep:
2838 return new CGObjCGNUstep(CGM);
2840 case ObjCRuntime::GCC:
2841 return new CGObjCGCC(CGM);
2843 case ObjCRuntime::ObjFW:
2844 return new CGObjCObjFW(CGM);
2846 case ObjCRuntime::FragileMacOSX:
2847 case ObjCRuntime::MacOSX:
2848 case ObjCRuntime::iOS:
2849 llvm_unreachable("these runtimes are not GNU runtimes");
2851 llvm_unreachable("bad runtime");