1 //===------- CGObjCGNU.cpp - Emit LLVM Code from ASTs for a Module --------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 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. 14 // 15 //===----------------------------------------------------------------------===// 16 17 #include "CGObjCRuntime.h" 18 #include "CodeGenModule.h" 19 #include "CodeGenFunction.h" 20 #include "CGCleanup.h" 21 22 #include "clang/AST/ASTContext.h" 23 #include "clang/AST/Decl.h" 24 #include "clang/AST/DeclObjC.h" 25 #include "clang/AST/RecordLayout.h" 26 #include "clang/AST/StmtObjC.h" 27 #include "clang/Basic/SourceManager.h" 28 #include "clang/Basic/FileManager.h" 29 30 #include "llvm/Intrinsics.h" 31 #include "llvm/Module.h" 32 #include "llvm/LLVMContext.h" 33 #include "llvm/ADT/SmallVector.h" 34 #include "llvm/ADT/StringMap.h" 35 #include "llvm/Support/CallSite.h" 36 #include "llvm/Support/Compiler.h" 37 #include "llvm/Target/TargetData.h" 38 39 #include <cstdarg> 40 41 42 using namespace clang; 43 using namespace CodeGen; 44 45 46 namespace { 47 /// Class that lazily initialises the runtime function. Avoids inserting the 48 /// types and the function declaration into a module if they're not used, and 49 /// avoids constructing the type more than once if it's used more than once. 50 class LazyRuntimeFunction { 51 CodeGenModule *CGM; 52 std::vector<llvm::Type*> ArgTys; 53 const char *FunctionName; 54 llvm::Constant *Function; 55 public: 56 /// Constructor leaves this class uninitialized, because it is intended to 57 /// be used as a field in another class and not all of the types that are 58 /// used as arguments will necessarily be available at construction time. 59 LazyRuntimeFunction() : CGM(0), FunctionName(0), Function(0) {} 60 61 /// Initialises the lazy function with the name, return type, and the types 62 /// of the arguments. 63 END_WITH_NULL 64 void init(CodeGenModule *Mod, const char *name, 65 llvm::Type *RetTy, ...) { 66 CGM =Mod; 67 FunctionName = name; 68 Function = 0; 69 ArgTys.clear(); 70 va_list Args; 71 va_start(Args, RetTy); 72 while (llvm::Type *ArgTy = va_arg(Args, llvm::Type*)) 73 ArgTys.push_back(ArgTy); 74 va_end(Args); 75 // Push the return type on at the end so we can pop it off easily 76 ArgTys.push_back(RetTy); 77 } 78 /// Overloaded cast operator, allows the class to be implicitly cast to an 79 /// LLVM constant. 80 operator llvm::Constant*() { 81 if (!Function) { 82 if (0 == FunctionName) return 0; 83 // We put the return type on the end of the vector, so pop it back off 84 llvm::Type *RetTy = ArgTys.back(); 85 ArgTys.pop_back(); 86 llvm::FunctionType *FTy = llvm::FunctionType::get(RetTy, ArgTys, false); 87 Function = 88 cast<llvm::Constant>(CGM->CreateRuntimeFunction(FTy, FunctionName)); 89 // We won't need to use the types again, so we may as well clean up the 90 // vector now 91 ArgTys.resize(0); 92 } 93 return Function; 94 } 95 operator llvm::Function*() { 96 return cast<llvm::Function>((llvm::Constant*)*this); 97 } 98 99 }; 100 101 102 /// GNU Objective-C runtime code generation. This class implements the parts of 103 /// Objective-C support that are specific to the GNU family of runtimes (GCC and 104 /// GNUstep). 105 class CGObjCGNU : public CGObjCRuntime { 106 protected: 107 /// The module that is using this class 108 CodeGenModule &CGM; 109 /// The LLVM module into which output is inserted 110 llvm::Module &TheModule; 111 /// strut objc_super. Used for sending messages to super. This structure 112 /// contains the receiver (object) and the expected class. 113 llvm::StructType *ObjCSuperTy; 114 /// struct objc_super*. The type of the argument to the superclass message 115 /// lookup functions. 116 llvm::PointerType *PtrToObjCSuperTy; 117 /// LLVM type for selectors. Opaque pointer (i8*) unless a header declaring 118 /// SEL is included in a header somewhere, in which case it will be whatever 119 /// type is declared in that header, most likely {i8*, i8*}. 120 llvm::PointerType *SelectorTy; 121 /// LLVM i8 type. Cached here to avoid repeatedly getting it in all of the 122 /// places where it's used 123 llvm::IntegerType *Int8Ty; 124 /// Pointer to i8 - LLVM type of char*, for all of the places where the 125 /// runtime needs to deal with C strings. 126 llvm::PointerType *PtrToInt8Ty; 127 /// Instance Method Pointer type. This is a pointer to a function that takes, 128 /// at a minimum, an object and a selector, and is the generic type for 129 /// Objective-C methods. Due to differences between variadic / non-variadic 130 /// calling conventions, it must always be cast to the correct type before 131 /// actually being used. 132 llvm::PointerType *IMPTy; 133 /// Type of an untyped Objective-C object. Clang treats id as a built-in type 134 /// when compiling Objective-C code, so this may be an opaque pointer (i8*), 135 /// but if the runtime header declaring it is included then it may be a 136 /// pointer to a structure. 137 llvm::PointerType *IdTy; 138 /// Pointer to a pointer to an Objective-C object. Used in the new ABI 139 /// message lookup function and some GC-related functions. 140 llvm::PointerType *PtrToIdTy; 141 /// The clang type of id. Used when using the clang CGCall infrastructure to 142 /// call Objective-C methods. 143 CanQualType ASTIdTy; 144 /// LLVM type for C int type. 145 llvm::IntegerType *IntTy; 146 /// LLVM type for an opaque pointer. This is identical to PtrToInt8Ty, but is 147 /// used in the code to document the difference between i8* meaning a pointer 148 /// to a C string and i8* meaning a pointer to some opaque type. 149 llvm::PointerType *PtrTy; 150 /// LLVM type for C long type. The runtime uses this in a lot of places where 151 /// it should be using intptr_t, but we can't fix this without breaking 152 /// compatibility with GCC... 153 llvm::IntegerType *LongTy; 154 /// LLVM type for C size_t. Used in various runtime data structures. 155 llvm::IntegerType *SizeTy; 156 /// LLVM type for C intptr_t. 157 llvm::IntegerType *IntPtrTy; 158 /// LLVM type for C ptrdiff_t. Mainly used in property accessor functions. 159 llvm::IntegerType *PtrDiffTy; 160 /// LLVM type for C int*. Used for GCC-ABI-compatible non-fragile instance 161 /// variables. 162 llvm::PointerType *PtrToIntTy; 163 /// LLVM type for Objective-C BOOL type. 164 llvm::Type *BoolTy; 165 /// 32-bit integer type, to save us needing to look it up every time it's used. 166 llvm::IntegerType *Int32Ty; 167 /// 64-bit integer type, to save us needing to look it up every time it's used. 168 llvm::IntegerType *Int64Ty; 169 /// Metadata kind used to tie method lookups to message sends. The GNUstep 170 /// runtime provides some LLVM passes that can use this to do things like 171 /// automatic IMP caching and speculative inlining. 172 unsigned msgSendMDKind; 173 /// Helper function that generates a constant string and returns a pointer to 174 /// the start of the string. The result of this function can be used anywhere 175 /// where the C code specifies const char*. 176 llvm::Constant *MakeConstantString(const std::string &Str, 177 const std::string &Name="") { 178 llvm::Constant *ConstStr = CGM.GetAddrOfConstantCString(Str, Name.c_str()); 179 return llvm::ConstantExpr::getGetElementPtr(ConstStr, Zeros); 180 } 181 /// Emits a linkonce_odr string, whose name is the prefix followed by the 182 /// string value. This allows the linker to combine the strings between 183 /// different modules. Used for EH typeinfo names, selector strings, and a 184 /// few other things. 185 llvm::Constant *ExportUniqueString(const std::string &Str, 186 const std::string prefix) { 187 std::string name = prefix + Str; 188 llvm::Constant *ConstStr = TheModule.getGlobalVariable(name); 189 if (!ConstStr) { 190 llvm::Constant *value = llvm::ConstantArray::get(VMContext, Str, true); 191 ConstStr = new llvm::GlobalVariable(TheModule, value->getType(), true, 192 llvm::GlobalValue::LinkOnceODRLinkage, value, prefix + Str); 193 } 194 return llvm::ConstantExpr::getGetElementPtr(ConstStr, Zeros); 195 } 196 /// Generates a global structure, initialized by the elements in the vector. 197 /// The element types must match the types of the structure elements in the 198 /// first argument. 199 llvm::GlobalVariable *MakeGlobal(llvm::StructType *Ty, 200 llvm::ArrayRef<llvm::Constant*> V, 201 StringRef Name="", 202 llvm::GlobalValue::LinkageTypes linkage 203 =llvm::GlobalValue::InternalLinkage) { 204 llvm::Constant *C = llvm::ConstantStruct::get(Ty, V); 205 return new llvm::GlobalVariable(TheModule, Ty, false, 206 linkage, C, Name); 207 } 208 /// Generates a global array. The vector must contain the same number of 209 /// elements that the array type declares, of the type specified as the array 210 /// element type. 211 llvm::GlobalVariable *MakeGlobal(llvm::ArrayType *Ty, 212 llvm::ArrayRef<llvm::Constant*> V, 213 StringRef Name="", 214 llvm::GlobalValue::LinkageTypes linkage 215 =llvm::GlobalValue::InternalLinkage) { 216 llvm::Constant *C = llvm::ConstantArray::get(Ty, V); 217 return new llvm::GlobalVariable(TheModule, Ty, false, 218 linkage, C, Name); 219 } 220 /// Generates a global array, inferring the array type from the specified 221 /// element type and the size of the initialiser. 222 llvm::GlobalVariable *MakeGlobalArray(llvm::Type *Ty, 223 llvm::ArrayRef<llvm::Constant*> V, 224 StringRef Name="", 225 llvm::GlobalValue::LinkageTypes linkage 226 =llvm::GlobalValue::InternalLinkage) { 227 llvm::ArrayType *ArrayTy = llvm::ArrayType::get(Ty, V.size()); 228 return MakeGlobal(ArrayTy, V, Name, linkage); 229 } 230 /// Ensures that the value has the required type, by inserting a bitcast if 231 /// required. This function lets us avoid inserting bitcasts that are 232 /// redundant. 233 llvm::Value* EnforceType(CGBuilderTy B, llvm::Value *V, llvm::Type *Ty){ 234 if (V->getType() == Ty) return V; 235 return B.CreateBitCast(V, Ty); 236 } 237 // Some zeros used for GEPs in lots of places. 238 llvm::Constant *Zeros[2]; 239 /// Null pointer value. Mainly used as a terminator in various arrays. 240 llvm::Constant *NULLPtr; 241 /// LLVM context. 242 llvm::LLVMContext &VMContext; 243 private: 244 /// Placeholder for the class. Lots of things refer to the class before we've 245 /// actually emitted it. We use this alias as a placeholder, and then replace 246 /// it with a pointer to the class structure before finally emitting the 247 /// module. 248 llvm::GlobalAlias *ClassPtrAlias; 249 /// Placeholder for the metaclass. Lots of things refer to the class before 250 /// we've / actually emitted it. We use this alias as a placeholder, and then 251 /// replace / it with a pointer to the metaclass structure before finally 252 /// emitting the / module. 253 llvm::GlobalAlias *MetaClassPtrAlias; 254 /// All of the classes that have been generated for this compilation units. 255 std::vector<llvm::Constant*> Classes; 256 /// All of the categories that have been generated for this compilation units. 257 std::vector<llvm::Constant*> Categories; 258 /// All of the Objective-C constant strings that have been generated for this 259 /// compilation units. 260 std::vector<llvm::Constant*> ConstantStrings; 261 /// Map from string values to Objective-C constant strings in the output. 262 /// Used to prevent emitting Objective-C strings more than once. This should 263 /// not be required at all - CodeGenModule should manage this list. 264 llvm::StringMap<llvm::Constant*> ObjCStrings; 265 /// All of the protocols that have been declared. 266 llvm::StringMap<llvm::Constant*> ExistingProtocols; 267 /// For each variant of a selector, we store the type encoding and a 268 /// placeholder value. For an untyped selector, the type will be the empty 269 /// string. Selector references are all done via the module's selector table, 270 /// so we create an alias as a placeholder and then replace it with the real 271 /// value later. 272 typedef std::pair<std::string, llvm::GlobalAlias*> TypedSelector; 273 /// Type of the selector map. This is roughly equivalent to the structure 274 /// used in the GNUstep runtime, which maintains a list of all of the valid 275 /// types for a selector in a table. 276 typedef llvm::DenseMap<Selector, SmallVector<TypedSelector, 2> > 277 SelectorMap; 278 /// A map from selectors to selector types. This allows us to emit all 279 /// selectors of the same name and type together. 280 SelectorMap SelectorTable; 281 282 /// Selectors related to memory management. When compiling in GC mode, we 283 /// omit these. 284 Selector RetainSel, ReleaseSel, AutoreleaseSel; 285 /// Runtime functions used for memory management in GC mode. Note that clang 286 /// supports code generation for calling these functions, but neither GNU 287 /// runtime actually supports this API properly yet. 288 LazyRuntimeFunction IvarAssignFn, StrongCastAssignFn, MemMoveFn, WeakReadFn, 289 WeakAssignFn, GlobalAssignFn; 290 291 protected: 292 /// Function used for throwing Objective-C exceptions. 293 LazyRuntimeFunction ExceptionThrowFn; 294 /// Function used for rethrowing exceptions, used at the end of @finally or 295 /// @synchronize blocks. 296 LazyRuntimeFunction ExceptionReThrowFn; 297 /// Function called when entering a catch function. This is required for 298 /// differentiating Objective-C exceptions and foreign exceptions. 299 LazyRuntimeFunction EnterCatchFn; 300 /// Function called when exiting from a catch block. Used to do exception 301 /// cleanup. 302 LazyRuntimeFunction ExitCatchFn; 303 /// Function called when entering an @synchronize block. Acquires the lock. 304 LazyRuntimeFunction SyncEnterFn; 305 /// Function called when exiting an @synchronize block. Releases the lock. 306 LazyRuntimeFunction SyncExitFn; 307 308 private: 309 310 /// Function called if fast enumeration detects that the collection is 311 /// modified during the update. 312 LazyRuntimeFunction EnumerationMutationFn; 313 /// Function for implementing synthesized property getters that return an 314 /// object. 315 LazyRuntimeFunction GetPropertyFn; 316 /// Function for implementing synthesized property setters that return an 317 /// object. 318 LazyRuntimeFunction SetPropertyFn; 319 /// Function used for non-object declared property getters. 320 LazyRuntimeFunction GetStructPropertyFn; 321 /// Function used for non-object declared property setters. 322 LazyRuntimeFunction SetStructPropertyFn; 323 324 /// The version of the runtime that this class targets. Must match the 325 /// version in the runtime. 326 int RuntimeVersion; 327 /// The version of the protocol class. Used to differentiate between ObjC1 328 /// and ObjC2 protocols. Objective-C 1 protocols can not contain optional 329 /// components and can not contain declared properties. We always emit 330 /// Objective-C 2 property structures, but we have to pretend that they're 331 /// Objective-C 1 property structures when targeting the GCC runtime or it 332 /// will abort. 333 const int ProtocolVersion; 334 private: 335 /// Generates an instance variable list structure. This is a structure 336 /// containing a size and an array of structures containing instance variable 337 /// metadata. This is used purely for introspection in the fragile ABI. In 338 /// the non-fragile ABI, it's used for instance variable fixup. 339 llvm::Constant *GenerateIvarList( 340 const SmallVectorImpl<llvm::Constant *> &IvarNames, 341 const SmallVectorImpl<llvm::Constant *> &IvarTypes, 342 const SmallVectorImpl<llvm::Constant *> &IvarOffsets); 343 /// Generates a method list structure. This is a structure containing a size 344 /// and an array of structures containing method metadata. 345 /// 346 /// This structure is used by both classes and categories, and contains a next 347 /// pointer allowing them to be chained together in a linked list. 348 llvm::Constant *GenerateMethodList(const StringRef &ClassName, 349 const StringRef &CategoryName, 350 const SmallVectorImpl<Selector> &MethodSels, 351 const SmallVectorImpl<llvm::Constant *> &MethodTypes, 352 bool isClassMethodList); 353 /// Emits an empty protocol. This is used for @protocol() where no protocol 354 /// is found. The runtime will (hopefully) fix up the pointer to refer to the 355 /// real protocol. 356 llvm::Constant *GenerateEmptyProtocol(const std::string &ProtocolName); 357 /// Generates a list of property metadata structures. This follows the same 358 /// pattern as method and instance variable metadata lists. 359 llvm::Constant *GeneratePropertyList(const ObjCImplementationDecl *OID, 360 SmallVectorImpl<Selector> &InstanceMethodSels, 361 SmallVectorImpl<llvm::Constant*> &InstanceMethodTypes); 362 /// Generates a list of referenced protocols. Classes, categories, and 363 /// protocols all use this structure. 364 llvm::Constant *GenerateProtocolList( 365 const SmallVectorImpl<std::string> &Protocols); 366 /// To ensure that all protocols are seen by the runtime, we add a category on 367 /// a class defined in the runtime, declaring no methods, but adopting the 368 /// protocols. This is a horribly ugly hack, but it allows us to collect all 369 /// of the protocols without changing the ABI. 370 void GenerateProtocolHolderCategory(void); 371 /// Generates a class structure. 372 llvm::Constant *GenerateClassStructure( 373 llvm::Constant *MetaClass, 374 llvm::Constant *SuperClass, 375 unsigned info, 376 const char *Name, 377 llvm::Constant *Version, 378 llvm::Constant *InstanceSize, 379 llvm::Constant *IVars, 380 llvm::Constant *Methods, 381 llvm::Constant *Protocols, 382 llvm::Constant *IvarOffsets, 383 llvm::Constant *Properties, 384 llvm::Constant *StrongIvarBitmap, 385 llvm::Constant *WeakIvarBitmap, 386 bool isMeta=false); 387 /// Generates a method list. This is used by protocols to define the required 388 /// and optional methods. 389 llvm::Constant *GenerateProtocolMethodList( 390 const SmallVectorImpl<llvm::Constant *> &MethodNames, 391 const SmallVectorImpl<llvm::Constant *> &MethodTypes); 392 /// Returns a selector with the specified type encoding. An empty string is 393 /// used to return an untyped selector (with the types field set to NULL). 394 llvm::Value *GetSelector(CGBuilderTy &Builder, Selector Sel, 395 const std::string &TypeEncoding, bool lval); 396 /// Returns the variable used to store the offset of an instance variable. 397 llvm::GlobalVariable *ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID, 398 const ObjCIvarDecl *Ivar); 399 /// Emits a reference to a class. This allows the linker to object if there 400 /// is no class of the matching name. 401 void EmitClassRef(const std::string &className); 402 /// Emits a pointer to the named class 403 llvm::Value *GetClassNamed(CGBuilderTy &Builder, const std::string &Name, 404 bool isWeak); 405 protected: 406 /// Looks up the method for sending a message to the specified object. This 407 /// mechanism differs between the GCC and GNU runtimes, so this method must be 408 /// overridden in subclasses. 409 virtual llvm::Value *LookupIMP(CodeGenFunction &CGF, 410 llvm::Value *&Receiver, 411 llvm::Value *cmd, 412 llvm::MDNode *node) = 0; 413 /// Looks up the method for sending a message to a superclass. This 414 /// mechanism differs between the GCC and GNU runtimes, so this method must 415 /// be overridden in subclasses. 416 virtual llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, 417 llvm::Value *ObjCSuper, 418 llvm::Value *cmd) = 0; 419 /// Libobjc2 uses a bitfield representation where small(ish) bitfields are 420 /// stored in a 64-bit value with the low bit set to 1 and the remaining 63 421 /// bits set to their values, LSB first, while larger ones are stored in a 422 /// structure of this / form: 423 /// 424 /// struct { int32_t length; int32_t values[length]; }; 425 /// 426 /// The values in the array are stored in host-endian format, with the least 427 /// significant bit being assumed to come first in the bitfield. Therefore, 428 /// a bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] }, 429 /// while a bitfield / with the 63rd bit set will be 1<<64. 430 llvm::Constant *MakeBitField(llvm::SmallVectorImpl<bool> &bits); 431 public: 432 CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion, 433 unsigned protocolClassVersion); 434 435 virtual llvm::Constant *GenerateConstantString(const StringLiteral *); 436 437 virtual RValue 438 GenerateMessageSend(CodeGenFunction &CGF, 439 ReturnValueSlot Return, 440 QualType ResultType, 441 Selector Sel, 442 llvm::Value *Receiver, 443 const CallArgList &CallArgs, 444 const ObjCInterfaceDecl *Class, 445 const ObjCMethodDecl *Method); 446 virtual RValue 447 GenerateMessageSendSuper(CodeGenFunction &CGF, 448 ReturnValueSlot Return, 449 QualType ResultType, 450 Selector Sel, 451 const ObjCInterfaceDecl *Class, 452 bool isCategoryImpl, 453 llvm::Value *Receiver, 454 bool IsClassMessage, 455 const CallArgList &CallArgs, 456 const ObjCMethodDecl *Method); 457 virtual llvm::Value *GetClass(CGBuilderTy &Builder, 458 const ObjCInterfaceDecl *OID); 459 virtual llvm::Value *GetSelector(CGBuilderTy &Builder, Selector Sel, 460 bool lval = false); 461 virtual llvm::Value *GetSelector(CGBuilderTy &Builder, const ObjCMethodDecl 462 *Method); 463 virtual llvm::Constant *GetEHType(QualType T); 464 465 virtual llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD, 466 const ObjCContainerDecl *CD); 467 virtual void GenerateCategory(const ObjCCategoryImplDecl *CMD); 468 virtual void GenerateClass(const ObjCImplementationDecl *ClassDecl); 469 virtual llvm::Value *GenerateProtocolRef(CGBuilderTy &Builder, 470 const ObjCProtocolDecl *PD); 471 virtual void GenerateProtocol(const ObjCProtocolDecl *PD); 472 virtual llvm::Function *ModuleInitFunction(); 473 virtual llvm::Constant *GetPropertyGetFunction(); 474 virtual llvm::Constant *GetPropertySetFunction(); 475 virtual llvm::Constant *GetSetStructFunction(); 476 virtual llvm::Constant *GetGetStructFunction(); 477 virtual llvm::Constant *EnumerationMutationFunction(); 478 479 virtual void EmitTryStmt(CodeGenFunction &CGF, 480 const ObjCAtTryStmt &S); 481 virtual void EmitSynchronizedStmt(CodeGenFunction &CGF, 482 const ObjCAtSynchronizedStmt &S); 483 virtual void EmitThrowStmt(CodeGenFunction &CGF, 484 const ObjCAtThrowStmt &S); 485 virtual llvm::Value * EmitObjCWeakRead(CodeGenFunction &CGF, 486 llvm::Value *AddrWeakObj); 487 virtual void EmitObjCWeakAssign(CodeGenFunction &CGF, 488 llvm::Value *src, llvm::Value *dst); 489 virtual void EmitObjCGlobalAssign(CodeGenFunction &CGF, 490 llvm::Value *src, llvm::Value *dest, 491 bool threadlocal=false); 492 virtual void EmitObjCIvarAssign(CodeGenFunction &CGF, 493 llvm::Value *src, llvm::Value *dest, 494 llvm::Value *ivarOffset); 495 virtual void EmitObjCStrongCastAssign(CodeGenFunction &CGF, 496 llvm::Value *src, llvm::Value *dest); 497 virtual void EmitGCMemmoveCollectable(CodeGenFunction &CGF, 498 llvm::Value *DestPtr, 499 llvm::Value *SrcPtr, 500 llvm::Value *Size); 501 virtual LValue EmitObjCValueForIvar(CodeGenFunction &CGF, 502 QualType ObjectTy, 503 llvm::Value *BaseValue, 504 const ObjCIvarDecl *Ivar, 505 unsigned CVRQualifiers); 506 virtual llvm::Value *EmitIvarOffset(CodeGenFunction &CGF, 507 const ObjCInterfaceDecl *Interface, 508 const ObjCIvarDecl *Ivar); 509 virtual llvm::Value *EmitNSAutoreleasePoolClassRef(CGBuilderTy &Builder); 510 virtual llvm::Constant *BuildGCBlockLayout(CodeGenModule &CGM, 511 const CGBlockInfo &blockInfo) { 512 return NULLPtr; 513 } 514 515 virtual llvm::GlobalVariable *GetClassGlobal(const std::string &Name) { 516 return 0; 517 } 518 }; 519 /// Class representing the legacy GCC Objective-C ABI. This is the default when 520 /// -fobjc-nonfragile-abi is not specified. 521 /// 522 /// The GCC ABI target actually generates code that is approximately compatible 523 /// with the new GNUstep runtime ABI, but refrains from using any features that 524 /// would not work with the GCC runtime. For example, clang always generates 525 /// the extended form of the class structure, and the extra fields are simply 526 /// ignored by GCC libobjc. 527 class CGObjCGCC : public CGObjCGNU { 528 /// The GCC ABI message lookup function. Returns an IMP pointing to the 529 /// method implementation for this message. 530 LazyRuntimeFunction MsgLookupFn; 531 /// The GCC ABI superclass message lookup function. Takes a pointer to a 532 /// structure describing the receiver and the class, and a selector as 533 /// arguments. Returns the IMP for the corresponding method. 534 LazyRuntimeFunction MsgLookupSuperFn; 535 protected: 536 virtual llvm::Value *LookupIMP(CodeGenFunction &CGF, 537 llvm::Value *&Receiver, 538 llvm::Value *cmd, 539 llvm::MDNode *node) { 540 CGBuilderTy &Builder = CGF.Builder; 541 llvm::Value *args[] = { 542 EnforceType(Builder, Receiver, IdTy), 543 EnforceType(Builder, cmd, SelectorTy) }; 544 llvm::CallSite imp = CGF.EmitCallOrInvoke(MsgLookupFn, args); 545 imp->setMetadata(msgSendMDKind, node); 546 return imp.getInstruction(); 547 } 548 virtual llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, 549 llvm::Value *ObjCSuper, 550 llvm::Value *cmd) { 551 CGBuilderTy &Builder = CGF.Builder; 552 llvm::Value *lookupArgs[] = {EnforceType(Builder, ObjCSuper, 553 PtrToObjCSuperTy), cmd}; 554 return Builder.CreateCall(MsgLookupSuperFn, lookupArgs); 555 } 556 public: 557 CGObjCGCC(CodeGenModule &Mod) : CGObjCGNU(Mod, 8, 2) { 558 // IMP objc_msg_lookup(id, SEL); 559 MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy, NULL); 560 // IMP objc_msg_lookup_super(struct objc_super*, SEL); 561 MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy, 562 PtrToObjCSuperTy, SelectorTy, NULL); 563 } 564 }; 565 /// Class used when targeting the new GNUstep runtime ABI. 566 class CGObjCGNUstep : public CGObjCGNU { 567 /// The slot lookup function. Returns a pointer to a cacheable structure 568 /// that contains (among other things) the IMP. 569 LazyRuntimeFunction SlotLookupFn; 570 /// The GNUstep ABI superclass message lookup function. Takes a pointer to 571 /// a structure describing the receiver and the class, and a selector as 572 /// arguments. Returns the slot for the corresponding method. Superclass 573 /// message lookup rarely changes, so this is a good caching opportunity. 574 LazyRuntimeFunction SlotLookupSuperFn; 575 /// Type of an slot structure pointer. This is returned by the various 576 /// lookup functions. 577 llvm::Type *SlotTy; 578 protected: 579 virtual llvm::Value *LookupIMP(CodeGenFunction &CGF, 580 llvm::Value *&Receiver, 581 llvm::Value *cmd, 582 llvm::MDNode *node) { 583 CGBuilderTy &Builder = CGF.Builder; 584 llvm::Function *LookupFn = SlotLookupFn; 585 586 // Store the receiver on the stack so that we can reload it later 587 llvm::Value *ReceiverPtr = CGF.CreateTempAlloca(Receiver->getType()); 588 Builder.CreateStore(Receiver, ReceiverPtr); 589 590 llvm::Value *self; 591 592 if (isa<ObjCMethodDecl>(CGF.CurCodeDecl)) { 593 self = CGF.LoadObjCSelf(); 594 } else { 595 self = llvm::ConstantPointerNull::get(IdTy); 596 } 597 598 // The lookup function is guaranteed not to capture the receiver pointer. 599 LookupFn->setDoesNotCapture(1); 600 601 llvm::Value *args[] = { 602 EnforceType(Builder, ReceiverPtr, PtrToIdTy), 603 EnforceType(Builder, cmd, SelectorTy), 604 EnforceType(Builder, self, IdTy) }; 605 llvm::CallSite slot = CGF.EmitCallOrInvoke(LookupFn, args); 606 slot.setOnlyReadsMemory(); 607 slot->setMetadata(msgSendMDKind, node); 608 609 // Load the imp from the slot 610 llvm::Value *imp = 611 Builder.CreateLoad(Builder.CreateStructGEP(slot.getInstruction(), 4)); 612 613 // The lookup function may have changed the receiver, so make sure we use 614 // the new one. 615 Receiver = Builder.CreateLoad(ReceiverPtr, true); 616 return imp; 617 } 618 virtual llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, 619 llvm::Value *ObjCSuper, 620 llvm::Value *cmd) { 621 CGBuilderTy &Builder = CGF.Builder; 622 llvm::Value *lookupArgs[] = {ObjCSuper, cmd}; 623 624 llvm::CallInst *slot = Builder.CreateCall(SlotLookupSuperFn, lookupArgs); 625 slot->setOnlyReadsMemory(); 626 627 return Builder.CreateLoad(Builder.CreateStructGEP(slot, 4)); 628 } 629 public: 630 CGObjCGNUstep(CodeGenModule &Mod) : CGObjCGNU(Mod, 9, 3) { 631 llvm::StructType *SlotStructTy = llvm::StructType::get(PtrTy, 632 PtrTy, PtrTy, IntTy, IMPTy, NULL); 633 SlotTy = llvm::PointerType::getUnqual(SlotStructTy); 634 // Slot_t objc_msg_lookup_sender(id *receiver, SEL selector, id sender); 635 SlotLookupFn.init(&CGM, "objc_msg_lookup_sender", SlotTy, PtrToIdTy, 636 SelectorTy, IdTy, NULL); 637 // Slot_t objc_msg_lookup_super(struct objc_super*, SEL); 638 SlotLookupSuperFn.init(&CGM, "objc_slot_lookup_super", SlotTy, 639 PtrToObjCSuperTy, SelectorTy, NULL); 640 // If we're in ObjC++ mode, then we want to make 641 if (CGM.getLangOptions().CPlusPlus) { 642 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext); 643 // void *__cxa_begin_catch(void *e) 644 EnterCatchFn.init(&CGM, "__cxa_begin_catch", PtrTy, PtrTy, NULL); 645 // void __cxa_end_catch(void) 646 ExitCatchFn.init(&CGM, "__cxa_end_catch", VoidTy, NULL); 647 // void _Unwind_Resume_or_Rethrow(void*) 648 ExceptionReThrowFn.init(&CGM, "_Unwind_Resume_or_Rethrow", VoidTy, PtrTy, NULL); 649 } 650 } 651 }; 652 653 } // end anonymous namespace 654 655 656 /// Emits a reference to a dummy variable which is emitted with each class. 657 /// This ensures that a linker error will be generated when trying to link 658 /// together modules where a referenced class is not defined. 659 void CGObjCGNU::EmitClassRef(const std::string &className) { 660 std::string symbolRef = "__objc_class_ref_" + className; 661 // Don't emit two copies of the same symbol 662 if (TheModule.getGlobalVariable(symbolRef)) 663 return; 664 std::string symbolName = "__objc_class_name_" + className; 665 llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(symbolName); 666 if (!ClassSymbol) { 667 ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false, 668 llvm::GlobalValue::ExternalLinkage, 0, symbolName); 669 } 670 new llvm::GlobalVariable(TheModule, ClassSymbol->getType(), true, 671 llvm::GlobalValue::WeakAnyLinkage, ClassSymbol, symbolRef); 672 } 673 674 static std::string SymbolNameForMethod(const StringRef &ClassName, 675 const StringRef &CategoryName, const Selector MethodName, 676 bool isClassMethod) { 677 std::string MethodNameColonStripped = MethodName.getAsString(); 678 std::replace(MethodNameColonStripped.begin(), MethodNameColonStripped.end(), 679 ':', '_'); 680 return (Twine(isClassMethod ? "_c_" : "_i_") + ClassName + "_" + 681 CategoryName + "_" + MethodNameColonStripped).str(); 682 } 683 684 CGObjCGNU::CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion, 685 unsigned protocolClassVersion) 686 : CGM(cgm), TheModule(CGM.getModule()), VMContext(cgm.getLLVMContext()), 687 ClassPtrAlias(0), MetaClassPtrAlias(0), RuntimeVersion(runtimeABIVersion), 688 ProtocolVersion(protocolClassVersion) { 689 690 msgSendMDKind = VMContext.getMDKindID("GNUObjCMessageSend"); 691 692 CodeGenTypes &Types = CGM.getTypes(); 693 IntTy = cast<llvm::IntegerType>( 694 Types.ConvertType(CGM.getContext().IntTy)); 695 LongTy = cast<llvm::IntegerType>( 696 Types.ConvertType(CGM.getContext().LongTy)); 697 SizeTy = cast<llvm::IntegerType>( 698 Types.ConvertType(CGM.getContext().getSizeType())); 699 PtrDiffTy = cast<llvm::IntegerType>( 700 Types.ConvertType(CGM.getContext().getPointerDiffType())); 701 BoolTy = CGM.getTypes().ConvertType(CGM.getContext().BoolTy); 702 703 Int8Ty = llvm::Type::getInt8Ty(VMContext); 704 // C string type. Used in lots of places. 705 PtrToInt8Ty = llvm::PointerType::getUnqual(Int8Ty); 706 707 Zeros[0] = llvm::ConstantInt::get(LongTy, 0); 708 Zeros[1] = Zeros[0]; 709 NULLPtr = llvm::ConstantPointerNull::get(PtrToInt8Ty); 710 // Get the selector Type. 711 QualType selTy = CGM.getContext().getObjCSelType(); 712 if (QualType() == selTy) { 713 SelectorTy = PtrToInt8Ty; 714 } else { 715 SelectorTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(selTy)); 716 } 717 718 PtrToIntTy = llvm::PointerType::getUnqual(IntTy); 719 PtrTy = PtrToInt8Ty; 720 721 Int32Ty = llvm::Type::getInt32Ty(VMContext); 722 Int64Ty = llvm::Type::getInt64Ty(VMContext); 723 724 IntPtrTy = 725 TheModule.getPointerSize() == llvm::Module::Pointer32 ? Int32Ty : Int64Ty; 726 727 // Object type 728 QualType UnqualIdTy = CGM.getContext().getObjCIdType(); 729 ASTIdTy = CanQualType(); 730 if (UnqualIdTy != QualType()) { 731 ASTIdTy = CGM.getContext().getCanonicalType(UnqualIdTy); 732 IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy)); 733 } else { 734 IdTy = PtrToInt8Ty; 735 } 736 PtrToIdTy = llvm::PointerType::getUnqual(IdTy); 737 738 ObjCSuperTy = llvm::StructType::get(IdTy, IdTy, NULL); 739 PtrToObjCSuperTy = llvm::PointerType::getUnqual(ObjCSuperTy); 740 741 llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext); 742 743 // void objc_exception_throw(id); 744 ExceptionThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy, NULL); 745 ExceptionReThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy, NULL); 746 // int objc_sync_enter(id); 747 SyncEnterFn.init(&CGM, "objc_sync_enter", IntTy, IdTy, NULL); 748 // int objc_sync_exit(id); 749 SyncExitFn.init(&CGM, "objc_sync_exit", IntTy, IdTy, NULL); 750 751 // void objc_enumerationMutation (id) 752 EnumerationMutationFn.init(&CGM, "objc_enumerationMutation", VoidTy, 753 IdTy, NULL); 754 755 // id objc_getProperty(id, SEL, ptrdiff_t, BOOL) 756 GetPropertyFn.init(&CGM, "objc_getProperty", IdTy, IdTy, SelectorTy, 757 PtrDiffTy, BoolTy, NULL); 758 // void objc_setProperty(id, SEL, ptrdiff_t, id, BOOL, BOOL) 759 SetPropertyFn.init(&CGM, "objc_setProperty", VoidTy, IdTy, SelectorTy, 760 PtrDiffTy, IdTy, BoolTy, BoolTy, NULL); 761 // void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL) 762 GetStructPropertyFn.init(&CGM, "objc_getPropertyStruct", VoidTy, PtrTy, PtrTy, 763 PtrDiffTy, BoolTy, BoolTy, NULL); 764 // void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL) 765 SetStructPropertyFn.init(&CGM, "objc_setPropertyStruct", VoidTy, PtrTy, PtrTy, 766 PtrDiffTy, BoolTy, BoolTy, NULL); 767 768 // IMP type 769 llvm::Type *IMPArgs[] = { IdTy, SelectorTy }; 770 IMPTy = llvm::PointerType::getUnqual(llvm::FunctionType::get(IdTy, IMPArgs, 771 true)); 772 773 const LangOptions &Opts = CGM.getLangOptions(); 774 if ((Opts.getGC() != LangOptions::NonGC) || Opts.ObjCAutoRefCount) 775 RuntimeVersion = 10; 776 777 // Don't bother initialising the GC stuff unless we're compiling in GC mode 778 if (Opts.getGC() != LangOptions::NonGC) { 779 // This is a bit of an hack. We should sort this out by having a proper 780 // CGObjCGNUstep subclass for GC, but we may want to really support the old 781 // ABI and GC added in ObjectiveC2.framework, so we fudge it a bit for now 782 // Get selectors needed in GC mode 783 RetainSel = GetNullarySelector("retain", CGM.getContext()); 784 ReleaseSel = GetNullarySelector("release", CGM.getContext()); 785 AutoreleaseSel = GetNullarySelector("autorelease", CGM.getContext()); 786 787 // Get functions needed in GC mode 788 789 // id objc_assign_ivar(id, id, ptrdiff_t); 790 IvarAssignFn.init(&CGM, "objc_assign_ivar", IdTy, IdTy, IdTy, PtrDiffTy, 791 NULL); 792 // id objc_assign_strongCast (id, id*) 793 StrongCastAssignFn.init(&CGM, "objc_assign_strongCast", IdTy, IdTy, 794 PtrToIdTy, NULL); 795 // id objc_assign_global(id, id*); 796 GlobalAssignFn.init(&CGM, "objc_assign_global", IdTy, IdTy, PtrToIdTy, 797 NULL); 798 // id objc_assign_weak(id, id*); 799 WeakAssignFn.init(&CGM, "objc_assign_weak", IdTy, IdTy, PtrToIdTy, NULL); 800 // id objc_read_weak(id*); 801 WeakReadFn.init(&CGM, "objc_read_weak", IdTy, PtrToIdTy, NULL); 802 // void *objc_memmove_collectable(void*, void *, size_t); 803 MemMoveFn.init(&CGM, "objc_memmove_collectable", PtrTy, PtrTy, PtrTy, 804 SizeTy, NULL); 805 } 806 } 807 808 llvm::Value *CGObjCGNU::GetClassNamed(CGBuilderTy &Builder, 809 const std::string &Name, 810 bool isWeak) { 811 llvm::Value *ClassName = CGM.GetAddrOfConstantCString(Name); 812 // With the incompatible ABI, this will need to be replaced with a direct 813 // reference to the class symbol. For the compatible nonfragile ABI we are 814 // still performing this lookup at run time but emitting the symbol for the 815 // class externally so that we can make the switch later. 816 // 817 // Libobjc2 contains an LLVM pass that replaces calls to objc_lookup_class 818 // with memoized versions or with static references if it's safe to do so. 819 if (!isWeak) 820 EmitClassRef(Name); 821 ClassName = Builder.CreateStructGEP(ClassName, 0); 822 823 llvm::Constant *ClassLookupFn = 824 CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, PtrToInt8Ty, true), 825 "objc_lookup_class"); 826 return Builder.CreateCall(ClassLookupFn, ClassName); 827 } 828 829 // This has to perform the lookup every time, since posing and related 830 // techniques can modify the name -> class mapping. 831 llvm::Value *CGObjCGNU::GetClass(CGBuilderTy &Builder, 832 const ObjCInterfaceDecl *OID) { 833 return GetClassNamed(Builder, OID->getNameAsString(), OID->isWeakImported()); 834 } 835 llvm::Value *CGObjCGNU::EmitNSAutoreleasePoolClassRef(CGBuilderTy &Builder) { 836 return GetClassNamed(Builder, "NSAutoreleasePool", false); 837 } 838 839 llvm::Value *CGObjCGNU::GetSelector(CGBuilderTy &Builder, Selector Sel, 840 const std::string &TypeEncoding, bool lval) { 841 842 SmallVector<TypedSelector, 2> &Types = SelectorTable[Sel]; 843 llvm::GlobalAlias *SelValue = 0; 844 845 846 for (SmallVectorImpl<TypedSelector>::iterator i = Types.begin(), 847 e = Types.end() ; i!=e ; i++) { 848 if (i->first == TypeEncoding) { 849 SelValue = i->second; 850 break; 851 } 852 } 853 if (0 == SelValue) { 854 SelValue = new llvm::GlobalAlias(SelectorTy, 855 llvm::GlobalValue::PrivateLinkage, 856 ".objc_selector_"+Sel.getAsString(), NULL, 857 &TheModule); 858 Types.push_back(TypedSelector(TypeEncoding, SelValue)); 859 } 860 861 if (lval) { 862 llvm::Value *tmp = Builder.CreateAlloca(SelValue->getType()); 863 Builder.CreateStore(SelValue, tmp); 864 return tmp; 865 } 866 return SelValue; 867 } 868 869 llvm::Value *CGObjCGNU::GetSelector(CGBuilderTy &Builder, Selector Sel, 870 bool lval) { 871 return GetSelector(Builder, Sel, std::string(), lval); 872 } 873 874 llvm::Value *CGObjCGNU::GetSelector(CGBuilderTy &Builder, const ObjCMethodDecl 875 *Method) { 876 std::string SelTypes; 877 CGM.getContext().getObjCEncodingForMethodDecl(Method, SelTypes); 878 return GetSelector(Builder, Method->getSelector(), SelTypes, false); 879 } 880 881 llvm::Constant *CGObjCGNU::GetEHType(QualType T) { 882 if (!CGM.getLangOptions().CPlusPlus) { 883 if (T->isObjCIdType() 884 || T->isObjCQualifiedIdType()) { 885 // With the old ABI, there was only one kind of catchall, which broke 886 // foreign exceptions. With the new ABI, we use __objc_id_typeinfo as 887 // a pointer indicating object catchalls, and NULL to indicate real 888 // catchalls 889 if (CGM.getLangOptions().ObjCNonFragileABI) { 890 return MakeConstantString("@id"); 891 } else { 892 return 0; 893 } 894 } 895 896 // All other types should be Objective-C interface pointer types. 897 const ObjCObjectPointerType *OPT = 898 T->getAs<ObjCObjectPointerType>(); 899 assert(OPT && "Invalid @catch type."); 900 const ObjCInterfaceDecl *IDecl = 901 OPT->getObjectType()->getInterface(); 902 assert(IDecl && "Invalid @catch type."); 903 return MakeConstantString(IDecl->getIdentifier()->getName()); 904 } 905 // For Objective-C++, we want to provide the ability to catch both C++ and 906 // Objective-C objects in the same function. 907 908 // There's a particular fixed type info for 'id'. 909 if (T->isObjCIdType() || 910 T->isObjCQualifiedIdType()) { 911 llvm::Constant *IDEHType = 912 CGM.getModule().getGlobalVariable("__objc_id_type_info"); 913 if (!IDEHType) 914 IDEHType = 915 new llvm::GlobalVariable(CGM.getModule(), PtrToInt8Ty, 916 false, 917 llvm::GlobalValue::ExternalLinkage, 918 0, "__objc_id_type_info"); 919 return llvm::ConstantExpr::getBitCast(IDEHType, PtrToInt8Ty); 920 } 921 922 const ObjCObjectPointerType *PT = 923 T->getAs<ObjCObjectPointerType>(); 924 assert(PT && "Invalid @catch type."); 925 const ObjCInterfaceType *IT = PT->getInterfaceType(); 926 assert(IT && "Invalid @catch type."); 927 std::string className = IT->getDecl()->getIdentifier()->getName(); 928 929 std::string typeinfoName = "__objc_eh_typeinfo_" + className; 930 931 // Return the existing typeinfo if it exists 932 llvm::Constant *typeinfo = TheModule.getGlobalVariable(typeinfoName); 933 if (typeinfo) return typeinfo; 934 935 // Otherwise create it. 936 937 // vtable for gnustep::libobjc::__objc_class_type_info 938 // It's quite ugly hard-coding this. Ideally we'd generate it using the host 939 // platform's name mangling. 940 const char *vtableName = "_ZTVN7gnustep7libobjc22__objc_class_type_infoE"; 941 llvm::Constant *Vtable = TheModule.getGlobalVariable(vtableName); 942 if (!Vtable) { 943 Vtable = new llvm::GlobalVariable(TheModule, PtrToInt8Ty, true, 944 llvm::GlobalValue::ExternalLinkage, 0, vtableName); 945 } 946 llvm::Constant *Two = llvm::ConstantInt::get(IntTy, 2); 947 Vtable = llvm::ConstantExpr::getGetElementPtr(Vtable, Two); 948 Vtable = llvm::ConstantExpr::getBitCast(Vtable, PtrToInt8Ty); 949 950 llvm::Constant *typeName = 951 ExportUniqueString(className, "__objc_eh_typename_"); 952 953 std::vector<llvm::Constant*> fields; 954 fields.push_back(Vtable); 955 fields.push_back(typeName); 956 llvm::Constant *TI = 957 MakeGlobal(llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty, 958 NULL), fields, "__objc_eh_typeinfo_" + className, 959 llvm::GlobalValue::LinkOnceODRLinkage); 960 return llvm::ConstantExpr::getBitCast(TI, PtrToInt8Ty); 961 } 962 963 /// Generate an NSConstantString object. 964 llvm::Constant *CGObjCGNU::GenerateConstantString(const StringLiteral *SL) { 965 966 std::string Str = SL->getString().str(); 967 968 // Look for an existing one 969 llvm::StringMap<llvm::Constant*>::iterator old = ObjCStrings.find(Str); 970 if (old != ObjCStrings.end()) 971 return old->getValue(); 972 973 std::vector<llvm::Constant*> Ivars; 974 Ivars.push_back(NULLPtr); 975 Ivars.push_back(MakeConstantString(Str)); 976 Ivars.push_back(llvm::ConstantInt::get(IntTy, Str.size())); 977 llvm::Constant *ObjCStr = MakeGlobal( 978 llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty, IntTy, NULL), 979 Ivars, ".objc_str"); 980 ObjCStr = llvm::ConstantExpr::getBitCast(ObjCStr, PtrToInt8Ty); 981 ObjCStrings[Str] = ObjCStr; 982 ConstantStrings.push_back(ObjCStr); 983 return ObjCStr; 984 } 985 986 ///Generates a message send where the super is the receiver. This is a message 987 ///send to self with special delivery semantics indicating which class's method 988 ///should be called. 989 RValue 990 CGObjCGNU::GenerateMessageSendSuper(CodeGenFunction &CGF, 991 ReturnValueSlot Return, 992 QualType ResultType, 993 Selector Sel, 994 const ObjCInterfaceDecl *Class, 995 bool isCategoryImpl, 996 llvm::Value *Receiver, 997 bool IsClassMessage, 998 const CallArgList &CallArgs, 999 const ObjCMethodDecl *Method) { 1000 CGBuilderTy &Builder = CGF.Builder; 1001 if (CGM.getLangOptions().getGC() == LangOptions::GCOnly) { 1002 if (Sel == RetainSel || Sel == AutoreleaseSel) { 1003 return RValue::get(EnforceType(Builder, Receiver, 1004 CGM.getTypes().ConvertType(ResultType))); 1005 } 1006 if (Sel == ReleaseSel) { 1007 return RValue::get(0); 1008 } 1009 } 1010 1011 llvm::Value *cmd = GetSelector(Builder, Sel); 1012 1013 1014 CallArgList ActualArgs; 1015 1016 ActualArgs.add(RValue::get(EnforceType(Builder, Receiver, IdTy)), ASTIdTy); 1017 ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType()); 1018 ActualArgs.addFrom(CallArgs); 1019 1020 CodeGenTypes &Types = CGM.getTypes(); 1021 const CGFunctionInfo &FnInfo = Types.getFunctionInfo(ResultType, ActualArgs, 1022 FunctionType::ExtInfo()); 1023 1024 llvm::Value *ReceiverClass = 0; 1025 if (isCategoryImpl) { 1026 llvm::Constant *classLookupFunction = 0; 1027 if (IsClassMessage) { 1028 classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get( 1029 IdTy, PtrTy, true), "objc_get_meta_class"); 1030 } else { 1031 classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get( 1032 IdTy, PtrTy, true), "objc_get_class"); 1033 } 1034 ReceiverClass = Builder.CreateCall(classLookupFunction, 1035 MakeConstantString(Class->getNameAsString())); 1036 } else { 1037 // Set up global aliases for the metaclass or class pointer if they do not 1038 // already exist. These will are forward-references which will be set to 1039 // pointers to the class and metaclass structure created for the runtime 1040 // load function. To send a message to super, we look up the value of the 1041 // super_class pointer from either the class or metaclass structure. 1042 if (IsClassMessage) { 1043 if (!MetaClassPtrAlias) { 1044 MetaClassPtrAlias = new llvm::GlobalAlias(IdTy, 1045 llvm::GlobalValue::InternalLinkage, ".objc_metaclass_ref" + 1046 Class->getNameAsString(), NULL, &TheModule); 1047 } 1048 ReceiverClass = MetaClassPtrAlias; 1049 } else { 1050 if (!ClassPtrAlias) { 1051 ClassPtrAlias = new llvm::GlobalAlias(IdTy, 1052 llvm::GlobalValue::InternalLinkage, ".objc_class_ref" + 1053 Class->getNameAsString(), NULL, &TheModule); 1054 } 1055 ReceiverClass = ClassPtrAlias; 1056 } 1057 } 1058 // Cast the pointer to a simplified version of the class structure 1059 ReceiverClass = Builder.CreateBitCast(ReceiverClass, 1060 llvm::PointerType::getUnqual( 1061 llvm::StructType::get(IdTy, IdTy, NULL))); 1062 // Get the superclass pointer 1063 ReceiverClass = Builder.CreateStructGEP(ReceiverClass, 1); 1064 // Load the superclass pointer 1065 ReceiverClass = Builder.CreateLoad(ReceiverClass); 1066 // Construct the structure used to look up the IMP 1067 llvm::StructType *ObjCSuperTy = llvm::StructType::get( 1068 Receiver->getType(), IdTy, NULL); 1069 llvm::Value *ObjCSuper = Builder.CreateAlloca(ObjCSuperTy); 1070 1071 Builder.CreateStore(Receiver, Builder.CreateStructGEP(ObjCSuper, 0)); 1072 Builder.CreateStore(ReceiverClass, Builder.CreateStructGEP(ObjCSuper, 1)); 1073 1074 ObjCSuper = EnforceType(Builder, ObjCSuper, PtrToObjCSuperTy); 1075 llvm::FunctionType *impType = 1076 Types.GetFunctionType(FnInfo, Method ? Method->isVariadic() : false); 1077 1078 // Get the IMP 1079 llvm::Value *imp = LookupIMPSuper(CGF, ObjCSuper, cmd); 1080 imp = EnforceType(Builder, imp, llvm::PointerType::getUnqual(impType)); 1081 1082 llvm::Value *impMD[] = { 1083 llvm::MDString::get(VMContext, Sel.getAsString()), 1084 llvm::MDString::get(VMContext, Class->getSuperClass()->getNameAsString()), 1085 llvm::ConstantInt::get(llvm::Type::getInt1Ty(VMContext), IsClassMessage) 1086 }; 1087 llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD); 1088 1089 llvm::Instruction *call; 1090 RValue msgRet = CGF.EmitCall(FnInfo, imp, Return, ActualArgs, 1091 0, &call); 1092 call->setMetadata(msgSendMDKind, node); 1093 return msgRet; 1094 } 1095 1096 /// Generate code for a message send expression. 1097 RValue 1098 CGObjCGNU::GenerateMessageSend(CodeGenFunction &CGF, 1099 ReturnValueSlot Return, 1100 QualType ResultType, 1101 Selector Sel, 1102 llvm::Value *Receiver, 1103 const CallArgList &CallArgs, 1104 const ObjCInterfaceDecl *Class, 1105 const ObjCMethodDecl *Method) { 1106 CGBuilderTy &Builder = CGF.Builder; 1107 1108 // Strip out message sends to retain / release in GC mode 1109 if (CGM.getLangOptions().getGC() == LangOptions::GCOnly) { 1110 if (Sel == RetainSel || Sel == AutoreleaseSel) { 1111 return RValue::get(EnforceType(Builder, Receiver, 1112 CGM.getTypes().ConvertType(ResultType))); 1113 } 1114 if (Sel == ReleaseSel) { 1115 return RValue::get(0); 1116 } 1117 } 1118 1119 // If the return type is something that goes in an integer register, the 1120 // runtime will handle 0 returns. For other cases, we fill in the 0 value 1121 // ourselves. 1122 // 1123 // The language spec says the result of this kind of message send is 1124 // undefined, but lots of people seem to have forgotten to read that 1125 // paragraph and insist on sending messages to nil that have structure 1126 // returns. With GCC, this generates a random return value (whatever happens 1127 // to be on the stack / in those registers at the time) on most platforms, 1128 // and generates an illegal instruction trap on SPARC. With LLVM it corrupts 1129 // the stack. 1130 bool isPointerSizedReturn = (ResultType->isAnyPointerType() || 1131 ResultType->isIntegralOrEnumerationType() || ResultType->isVoidType()); 1132 1133 llvm::BasicBlock *startBB = 0; 1134 llvm::BasicBlock *messageBB = 0; 1135 llvm::BasicBlock *continueBB = 0; 1136 1137 if (!isPointerSizedReturn) { 1138 startBB = Builder.GetInsertBlock(); 1139 messageBB = CGF.createBasicBlock("msgSend"); 1140 continueBB = CGF.createBasicBlock("continue"); 1141 1142 llvm::Value *isNil = Builder.CreateICmpEQ(Receiver, 1143 llvm::Constant::getNullValue(Receiver->getType())); 1144 Builder.CreateCondBr(isNil, continueBB, messageBB); 1145 CGF.EmitBlock(messageBB); 1146 } 1147 1148 IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy)); 1149 llvm::Value *cmd; 1150 if (Method) 1151 cmd = GetSelector(Builder, Method); 1152 else 1153 cmd = GetSelector(Builder, Sel); 1154 cmd = EnforceType(Builder, cmd, SelectorTy); 1155 Receiver = EnforceType(Builder, Receiver, IdTy); 1156 1157 llvm::Value *impMD[] = { 1158 llvm::MDString::get(VMContext, Sel.getAsString()), 1159 llvm::MDString::get(VMContext, Class ? Class->getNameAsString() :""), 1160 llvm::ConstantInt::get(llvm::Type::getInt1Ty(VMContext), Class!=0) 1161 }; 1162 llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD); 1163 1164 CodeGenTypes &Types = CGM.getTypes(); 1165 CallArgList ActualArgs; 1166 ActualArgs.add(RValue::get(Receiver), ASTIdTy); 1167 ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType()); 1168 ActualArgs.addFrom(CallArgs); 1169 const CGFunctionInfo &FnInfo = Types.getFunctionInfo(ResultType, ActualArgs, 1170 FunctionType::ExtInfo()); 1171 // Get the IMP to call 1172 llvm::Value *imp; 1173 1174 // If we have non-legacy dispatch specified, we try using the objc_msgSend() 1175 // functions. These are not supported on all platforms (or all runtimes on a 1176 // given platform), so we 1177 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) { 1178 default: 1179 llvm_unreachable("Invalid dispatch method!"); 1180 case CodeGenOptions::Legacy: 1181 imp = LookupIMP(CGF, Receiver, cmd, node); 1182 break; 1183 case CodeGenOptions::Mixed: 1184 case CodeGenOptions::NonLegacy: 1185 if (CGM.ReturnTypeUsesFPRet(ResultType)) { 1186 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true), 1187 "objc_msgSend_fpret"); 1188 } else if (CGM.ReturnTypeUsesSRet(FnInfo)) { 1189 // The actual types here don't matter - we're going to bitcast the 1190 // function anyway 1191 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true), 1192 "objc_msgSend_stret"); 1193 } else { 1194 imp = CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true), 1195 "objc_msgSend"); 1196 } 1197 } 1198 1199 1200 llvm::FunctionType *impType = 1201 Types.GetFunctionType(FnInfo, Method ? Method->isVariadic() : false); 1202 imp = EnforceType(Builder, imp, llvm::PointerType::getUnqual(impType)); 1203 1204 llvm::Instruction *call; 1205 RValue msgRet = CGF.EmitCall(FnInfo, imp, Return, ActualArgs, 1206 0, &call); 1207 call->setMetadata(msgSendMDKind, node); 1208 1209 1210 if (!isPointerSizedReturn) { 1211 messageBB = CGF.Builder.GetInsertBlock(); 1212 CGF.Builder.CreateBr(continueBB); 1213 CGF.EmitBlock(continueBB); 1214 if (msgRet.isScalar()) { 1215 llvm::Value *v = msgRet.getScalarVal(); 1216 llvm::PHINode *phi = Builder.CreatePHI(v->getType(), 2); 1217 phi->addIncoming(v, messageBB); 1218 phi->addIncoming(llvm::Constant::getNullValue(v->getType()), startBB); 1219 msgRet = RValue::get(phi); 1220 } else if (msgRet.isAggregate()) { 1221 llvm::Value *v = msgRet.getAggregateAddr(); 1222 llvm::PHINode *phi = Builder.CreatePHI(v->getType(), 2); 1223 llvm::PointerType *RetTy = cast<llvm::PointerType>(v->getType()); 1224 llvm::AllocaInst *NullVal = 1225 CGF.CreateTempAlloca(RetTy->getElementType(), "null"); 1226 CGF.InitTempAlloca(NullVal, 1227 llvm::Constant::getNullValue(RetTy->getElementType())); 1228 phi->addIncoming(v, messageBB); 1229 phi->addIncoming(NullVal, startBB); 1230 msgRet = RValue::getAggregate(phi); 1231 } else /* isComplex() */ { 1232 std::pair<llvm::Value*,llvm::Value*> v = msgRet.getComplexVal(); 1233 llvm::PHINode *phi = Builder.CreatePHI(v.first->getType(), 2); 1234 phi->addIncoming(v.first, messageBB); 1235 phi->addIncoming(llvm::Constant::getNullValue(v.first->getType()), 1236 startBB); 1237 llvm::PHINode *phi2 = Builder.CreatePHI(v.second->getType(), 2); 1238 phi2->addIncoming(v.second, messageBB); 1239 phi2->addIncoming(llvm::Constant::getNullValue(v.second->getType()), 1240 startBB); 1241 msgRet = RValue::getComplex(phi, phi2); 1242 } 1243 } 1244 return msgRet; 1245 } 1246 1247 /// Generates a MethodList. Used in construction of a objc_class and 1248 /// objc_category structures. 1249 llvm::Constant *CGObjCGNU::GenerateMethodList(const StringRef &ClassName, 1250 const StringRef &CategoryName, 1251 const SmallVectorImpl<Selector> &MethodSels, 1252 const SmallVectorImpl<llvm::Constant *> &MethodTypes, 1253 bool isClassMethodList) { 1254 if (MethodSels.empty()) 1255 return NULLPtr; 1256 // Get the method structure type. 1257 llvm::StructType *ObjCMethodTy = llvm::StructType::get( 1258 PtrToInt8Ty, // Really a selector, but the runtime creates it us. 1259 PtrToInt8Ty, // Method types 1260 IMPTy, //Method pointer 1261 NULL); 1262 std::vector<llvm::Constant*> Methods; 1263 std::vector<llvm::Constant*> Elements; 1264 for (unsigned int i = 0, e = MethodTypes.size(); i < e; ++i) { 1265 Elements.clear(); 1266 llvm::Constant *Method = 1267 TheModule.getFunction(SymbolNameForMethod(ClassName, CategoryName, 1268 MethodSels[i], 1269 isClassMethodList)); 1270 assert(Method && "Can't generate metadata for method that doesn't exist"); 1271 llvm::Constant *C = MakeConstantString(MethodSels[i].getAsString()); 1272 Elements.push_back(C); 1273 Elements.push_back(MethodTypes[i]); 1274 Method = llvm::ConstantExpr::getBitCast(Method, 1275 IMPTy); 1276 Elements.push_back(Method); 1277 Methods.push_back(llvm::ConstantStruct::get(ObjCMethodTy, Elements)); 1278 } 1279 1280 // Array of method structures 1281 llvm::ArrayType *ObjCMethodArrayTy = llvm::ArrayType::get(ObjCMethodTy, 1282 Methods.size()); 1283 llvm::Constant *MethodArray = llvm::ConstantArray::get(ObjCMethodArrayTy, 1284 Methods); 1285 1286 // Structure containing list pointer, array and array count 1287 llvm::StructType *ObjCMethodListTy = llvm::StructType::create(VMContext); 1288 llvm::Type *NextPtrTy = llvm::PointerType::getUnqual(ObjCMethodListTy); 1289 ObjCMethodListTy->setBody( 1290 NextPtrTy, 1291 IntTy, 1292 ObjCMethodArrayTy, 1293 NULL); 1294 1295 Methods.clear(); 1296 Methods.push_back(llvm::ConstantPointerNull::get( 1297 llvm::PointerType::getUnqual(ObjCMethodListTy))); 1298 Methods.push_back(llvm::ConstantInt::get(Int32Ty, MethodTypes.size())); 1299 Methods.push_back(MethodArray); 1300 1301 // Create an instance of the structure 1302 return MakeGlobal(ObjCMethodListTy, Methods, ".objc_method_list"); 1303 } 1304 1305 /// Generates an IvarList. Used in construction of a objc_class. 1306 llvm::Constant *CGObjCGNU::GenerateIvarList( 1307 const SmallVectorImpl<llvm::Constant *> &IvarNames, 1308 const SmallVectorImpl<llvm::Constant *> &IvarTypes, 1309 const SmallVectorImpl<llvm::Constant *> &IvarOffsets) { 1310 if (IvarNames.size() == 0) 1311 return NULLPtr; 1312 // Get the method structure type. 1313 llvm::StructType *ObjCIvarTy = llvm::StructType::get( 1314 PtrToInt8Ty, 1315 PtrToInt8Ty, 1316 IntTy, 1317 NULL); 1318 std::vector<llvm::Constant*> Ivars; 1319 std::vector<llvm::Constant*> Elements; 1320 for (unsigned int i = 0, e = IvarNames.size() ; i < e ; i++) { 1321 Elements.clear(); 1322 Elements.push_back(IvarNames[i]); 1323 Elements.push_back(IvarTypes[i]); 1324 Elements.push_back(IvarOffsets[i]); 1325 Ivars.push_back(llvm::ConstantStruct::get(ObjCIvarTy, Elements)); 1326 } 1327 1328 // Array of method structures 1329 llvm::ArrayType *ObjCIvarArrayTy = llvm::ArrayType::get(ObjCIvarTy, 1330 IvarNames.size()); 1331 1332 1333 Elements.clear(); 1334 Elements.push_back(llvm::ConstantInt::get(IntTy, (int)IvarNames.size())); 1335 Elements.push_back(llvm::ConstantArray::get(ObjCIvarArrayTy, Ivars)); 1336 // Structure containing array and array count 1337 llvm::StructType *ObjCIvarListTy = llvm::StructType::get(IntTy, 1338 ObjCIvarArrayTy, 1339 NULL); 1340 1341 // Create an instance of the structure 1342 return MakeGlobal(ObjCIvarListTy, Elements, ".objc_ivar_list"); 1343 } 1344 1345 /// Generate a class structure 1346 llvm::Constant *CGObjCGNU::GenerateClassStructure( 1347 llvm::Constant *MetaClass, 1348 llvm::Constant *SuperClass, 1349 unsigned info, 1350 const char *Name, 1351 llvm::Constant *Version, 1352 llvm::Constant *InstanceSize, 1353 llvm::Constant *IVars, 1354 llvm::Constant *Methods, 1355 llvm::Constant *Protocols, 1356 llvm::Constant *IvarOffsets, 1357 llvm::Constant *Properties, 1358 llvm::Constant *StrongIvarBitmap, 1359 llvm::Constant *WeakIvarBitmap, 1360 bool isMeta) { 1361 // Set up the class structure 1362 // Note: Several of these are char*s when they should be ids. This is 1363 // because the runtime performs this translation on load. 1364 // 1365 // Fields marked New ABI are part of the GNUstep runtime. We emit them 1366 // anyway; the classes will still work with the GNU runtime, they will just 1367 // be ignored. 1368 llvm::StructType *ClassTy = llvm::StructType::get( 1369 PtrToInt8Ty, // class_pointer 1370 PtrToInt8Ty, // super_class 1371 PtrToInt8Ty, // name 1372 LongTy, // version 1373 LongTy, // info 1374 LongTy, // instance_size 1375 IVars->getType(), // ivars 1376 Methods->getType(), // methods 1377 // These are all filled in by the runtime, so we pretend 1378 PtrTy, // dtable 1379 PtrTy, // subclass_list 1380 PtrTy, // sibling_class 1381 PtrTy, // protocols 1382 PtrTy, // gc_object_type 1383 // New ABI: 1384 LongTy, // abi_version 1385 IvarOffsets->getType(), // ivar_offsets 1386 Properties->getType(), // properties 1387 IntPtrTy, // strong_pointers 1388 IntPtrTy, // weak_pointers 1389 NULL); 1390 llvm::Constant *Zero = llvm::ConstantInt::get(LongTy, 0); 1391 // Fill in the structure 1392 std::vector<llvm::Constant*> Elements; 1393 Elements.push_back(llvm::ConstantExpr::getBitCast(MetaClass, PtrToInt8Ty)); 1394 Elements.push_back(SuperClass); 1395 Elements.push_back(MakeConstantString(Name, ".class_name")); 1396 Elements.push_back(Zero); 1397 Elements.push_back(llvm::ConstantInt::get(LongTy, info)); 1398 if (isMeta) { 1399 llvm::TargetData td(&TheModule); 1400 Elements.push_back( 1401 llvm::ConstantInt::get(LongTy, 1402 td.getTypeSizeInBits(ClassTy) / 1403 CGM.getContext().getCharWidth())); 1404 } else 1405 Elements.push_back(InstanceSize); 1406 Elements.push_back(IVars); 1407 Elements.push_back(Methods); 1408 Elements.push_back(NULLPtr); 1409 Elements.push_back(NULLPtr); 1410 Elements.push_back(NULLPtr); 1411 Elements.push_back(llvm::ConstantExpr::getBitCast(Protocols, PtrTy)); 1412 Elements.push_back(NULLPtr); 1413 Elements.push_back(llvm::ConstantInt::get(LongTy, 1)); 1414 Elements.push_back(IvarOffsets); 1415 Elements.push_back(Properties); 1416 Elements.push_back(StrongIvarBitmap); 1417 Elements.push_back(WeakIvarBitmap); 1418 // Create an instance of the structure 1419 // This is now an externally visible symbol, so that we can speed up class 1420 // messages in the next ABI. 1421 return MakeGlobal(ClassTy, Elements, (isMeta ? "_OBJC_METACLASS_": 1422 "_OBJC_CLASS_") + std::string(Name), llvm::GlobalValue::ExternalLinkage); 1423 } 1424 1425 llvm::Constant *CGObjCGNU::GenerateProtocolMethodList( 1426 const SmallVectorImpl<llvm::Constant *> &MethodNames, 1427 const SmallVectorImpl<llvm::Constant *> &MethodTypes) { 1428 // Get the method structure type. 1429 llvm::StructType *ObjCMethodDescTy = llvm::StructType::get( 1430 PtrToInt8Ty, // Really a selector, but the runtime does the casting for us. 1431 PtrToInt8Ty, 1432 NULL); 1433 std::vector<llvm::Constant*> Methods; 1434 std::vector<llvm::Constant*> Elements; 1435 for (unsigned int i = 0, e = MethodTypes.size() ; i < e ; i++) { 1436 Elements.clear(); 1437 Elements.push_back(MethodNames[i]); 1438 Elements.push_back(MethodTypes[i]); 1439 Methods.push_back(llvm::ConstantStruct::get(ObjCMethodDescTy, Elements)); 1440 } 1441 llvm::ArrayType *ObjCMethodArrayTy = llvm::ArrayType::get(ObjCMethodDescTy, 1442 MethodNames.size()); 1443 llvm::Constant *Array = llvm::ConstantArray::get(ObjCMethodArrayTy, 1444 Methods); 1445 llvm::StructType *ObjCMethodDescListTy = llvm::StructType::get( 1446 IntTy, ObjCMethodArrayTy, NULL); 1447 Methods.clear(); 1448 Methods.push_back(llvm::ConstantInt::get(IntTy, MethodNames.size())); 1449 Methods.push_back(Array); 1450 return MakeGlobal(ObjCMethodDescListTy, Methods, ".objc_method_list"); 1451 } 1452 1453 // Create the protocol list structure used in classes, categories and so on 1454 llvm::Constant *CGObjCGNU::GenerateProtocolList( 1455 const SmallVectorImpl<std::string> &Protocols) { 1456 llvm::ArrayType *ProtocolArrayTy = llvm::ArrayType::get(PtrToInt8Ty, 1457 Protocols.size()); 1458 llvm::StructType *ProtocolListTy = llvm::StructType::get( 1459 PtrTy, //Should be a recurisve pointer, but it's always NULL here. 1460 SizeTy, 1461 ProtocolArrayTy, 1462 NULL); 1463 std::vector<llvm::Constant*> Elements; 1464 for (const std::string *iter = Protocols.begin(), *endIter = Protocols.end(); 1465 iter != endIter ; iter++) { 1466 llvm::Constant *protocol = 0; 1467 llvm::StringMap<llvm::Constant*>::iterator value = 1468 ExistingProtocols.find(*iter); 1469 if (value == ExistingProtocols.end()) { 1470 protocol = GenerateEmptyProtocol(*iter); 1471 } else { 1472 protocol = value->getValue(); 1473 } 1474 llvm::Constant *Ptr = llvm::ConstantExpr::getBitCast(protocol, 1475 PtrToInt8Ty); 1476 Elements.push_back(Ptr); 1477 } 1478 llvm::Constant * ProtocolArray = llvm::ConstantArray::get(ProtocolArrayTy, 1479 Elements); 1480 Elements.clear(); 1481 Elements.push_back(NULLPtr); 1482 Elements.push_back(llvm::ConstantInt::get(LongTy, Protocols.size())); 1483 Elements.push_back(ProtocolArray); 1484 return MakeGlobal(ProtocolListTy, Elements, ".objc_protocol_list"); 1485 } 1486 1487 llvm::Value *CGObjCGNU::GenerateProtocolRef(CGBuilderTy &Builder, 1488 const ObjCProtocolDecl *PD) { 1489 llvm::Value *protocol = ExistingProtocols[PD->getNameAsString()]; 1490 llvm::Type *T = 1491 CGM.getTypes().ConvertType(CGM.getContext().getObjCProtoType()); 1492 return Builder.CreateBitCast(protocol, llvm::PointerType::getUnqual(T)); 1493 } 1494 1495 llvm::Constant *CGObjCGNU::GenerateEmptyProtocol( 1496 const std::string &ProtocolName) { 1497 SmallVector<std::string, 0> EmptyStringVector; 1498 SmallVector<llvm::Constant*, 0> EmptyConstantVector; 1499 1500 llvm::Constant *ProtocolList = GenerateProtocolList(EmptyStringVector); 1501 llvm::Constant *MethodList = 1502 GenerateProtocolMethodList(EmptyConstantVector, EmptyConstantVector); 1503 // Protocols are objects containing lists of the methods implemented and 1504 // protocols adopted. 1505 llvm::StructType *ProtocolTy = llvm::StructType::get(IdTy, 1506 PtrToInt8Ty, 1507 ProtocolList->getType(), 1508 MethodList->getType(), 1509 MethodList->getType(), 1510 MethodList->getType(), 1511 MethodList->getType(), 1512 NULL); 1513 std::vector<llvm::Constant*> Elements; 1514 // The isa pointer must be set to a magic number so the runtime knows it's 1515 // the correct layout. 1516 Elements.push_back(llvm::ConstantExpr::getIntToPtr( 1517 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy)); 1518 Elements.push_back(MakeConstantString(ProtocolName, ".objc_protocol_name")); 1519 Elements.push_back(ProtocolList); 1520 Elements.push_back(MethodList); 1521 Elements.push_back(MethodList); 1522 Elements.push_back(MethodList); 1523 Elements.push_back(MethodList); 1524 return MakeGlobal(ProtocolTy, Elements, ".objc_protocol"); 1525 } 1526 1527 void CGObjCGNU::GenerateProtocol(const ObjCProtocolDecl *PD) { 1528 ASTContext &Context = CGM.getContext(); 1529 std::string ProtocolName = PD->getNameAsString(); 1530 SmallVector<std::string, 16> Protocols; 1531 for (ObjCProtocolDecl::protocol_iterator PI = PD->protocol_begin(), 1532 E = PD->protocol_end(); PI != E; ++PI) 1533 Protocols.push_back((*PI)->getNameAsString()); 1534 SmallVector<llvm::Constant*, 16> InstanceMethodNames; 1535 SmallVector<llvm::Constant*, 16> InstanceMethodTypes; 1536 SmallVector<llvm::Constant*, 16> OptionalInstanceMethodNames; 1537 SmallVector<llvm::Constant*, 16> OptionalInstanceMethodTypes; 1538 for (ObjCProtocolDecl::instmeth_iterator iter = PD->instmeth_begin(), 1539 E = PD->instmeth_end(); iter != E; iter++) { 1540 std::string TypeStr; 1541 Context.getObjCEncodingForMethodDecl(*iter, TypeStr); 1542 if ((*iter)->getImplementationControl() == ObjCMethodDecl::Optional) { 1543 InstanceMethodNames.push_back( 1544 MakeConstantString((*iter)->getSelector().getAsString())); 1545 InstanceMethodTypes.push_back(MakeConstantString(TypeStr)); 1546 } else { 1547 OptionalInstanceMethodNames.push_back( 1548 MakeConstantString((*iter)->getSelector().getAsString())); 1549 OptionalInstanceMethodTypes.push_back(MakeConstantString(TypeStr)); 1550 } 1551 } 1552 // Collect information about class methods: 1553 SmallVector<llvm::Constant*, 16> ClassMethodNames; 1554 SmallVector<llvm::Constant*, 16> ClassMethodTypes; 1555 SmallVector<llvm::Constant*, 16> OptionalClassMethodNames; 1556 SmallVector<llvm::Constant*, 16> OptionalClassMethodTypes; 1557 for (ObjCProtocolDecl::classmeth_iterator 1558 iter = PD->classmeth_begin(), endIter = PD->classmeth_end(); 1559 iter != endIter ; iter++) { 1560 std::string TypeStr; 1561 Context.getObjCEncodingForMethodDecl((*iter),TypeStr); 1562 if ((*iter)->getImplementationControl() == ObjCMethodDecl::Optional) { 1563 ClassMethodNames.push_back( 1564 MakeConstantString((*iter)->getSelector().getAsString())); 1565 ClassMethodTypes.push_back(MakeConstantString(TypeStr)); 1566 } else { 1567 OptionalClassMethodNames.push_back( 1568 MakeConstantString((*iter)->getSelector().getAsString())); 1569 OptionalClassMethodTypes.push_back(MakeConstantString(TypeStr)); 1570 } 1571 } 1572 1573 llvm::Constant *ProtocolList = GenerateProtocolList(Protocols); 1574 llvm::Constant *InstanceMethodList = 1575 GenerateProtocolMethodList(InstanceMethodNames, InstanceMethodTypes); 1576 llvm::Constant *ClassMethodList = 1577 GenerateProtocolMethodList(ClassMethodNames, ClassMethodTypes); 1578 llvm::Constant *OptionalInstanceMethodList = 1579 GenerateProtocolMethodList(OptionalInstanceMethodNames, 1580 OptionalInstanceMethodTypes); 1581 llvm::Constant *OptionalClassMethodList = 1582 GenerateProtocolMethodList(OptionalClassMethodNames, 1583 OptionalClassMethodTypes); 1584 1585 // Property metadata: name, attributes, isSynthesized, setter name, setter 1586 // types, getter name, getter types. 1587 // The isSynthesized value is always set to 0 in a protocol. It exists to 1588 // simplify the runtime library by allowing it to use the same data 1589 // structures for protocol metadata everywhere. 1590 llvm::StructType *PropertyMetadataTy = llvm::StructType::get( 1591 PtrToInt8Ty, Int8Ty, Int8Ty, PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty, 1592 PtrToInt8Ty, NULL); 1593 std::vector<llvm::Constant*> Properties; 1594 std::vector<llvm::Constant*> OptionalProperties; 1595 1596 // Add all of the property methods need adding to the method list and to the 1597 // property metadata list. 1598 for (ObjCContainerDecl::prop_iterator 1599 iter = PD->prop_begin(), endIter = PD->prop_end(); 1600 iter != endIter ; iter++) { 1601 std::vector<llvm::Constant*> Fields; 1602 ObjCPropertyDecl *property = (*iter); 1603 1604 Fields.push_back(MakeConstantString(property->getNameAsString())); 1605 Fields.push_back(llvm::ConstantInt::get(Int8Ty, 1606 property->getPropertyAttributes())); 1607 Fields.push_back(llvm::ConstantInt::get(Int8Ty, 0)); 1608 if (ObjCMethodDecl *getter = property->getGetterMethodDecl()) { 1609 std::string TypeStr; 1610 Context.getObjCEncodingForMethodDecl(getter,TypeStr); 1611 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr); 1612 InstanceMethodTypes.push_back(TypeEncoding); 1613 Fields.push_back(MakeConstantString(getter->getSelector().getAsString())); 1614 Fields.push_back(TypeEncoding); 1615 } else { 1616 Fields.push_back(NULLPtr); 1617 Fields.push_back(NULLPtr); 1618 } 1619 if (ObjCMethodDecl *setter = property->getSetterMethodDecl()) { 1620 std::string TypeStr; 1621 Context.getObjCEncodingForMethodDecl(setter,TypeStr); 1622 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr); 1623 InstanceMethodTypes.push_back(TypeEncoding); 1624 Fields.push_back(MakeConstantString(setter->getSelector().getAsString())); 1625 Fields.push_back(TypeEncoding); 1626 } else { 1627 Fields.push_back(NULLPtr); 1628 Fields.push_back(NULLPtr); 1629 } 1630 if (property->getPropertyImplementation() == ObjCPropertyDecl::Optional) { 1631 OptionalProperties.push_back(llvm::ConstantStruct::get(PropertyMetadataTy, Fields)); 1632 } else { 1633 Properties.push_back(llvm::ConstantStruct::get(PropertyMetadataTy, Fields)); 1634 } 1635 } 1636 llvm::Constant *PropertyArray = llvm::ConstantArray::get( 1637 llvm::ArrayType::get(PropertyMetadataTy, Properties.size()), Properties); 1638 llvm::Constant* PropertyListInitFields[] = 1639 {llvm::ConstantInt::get(IntTy, Properties.size()), NULLPtr, PropertyArray}; 1640 1641 llvm::Constant *PropertyListInit = 1642 llvm::ConstantStruct::getAnon(PropertyListInitFields); 1643 llvm::Constant *PropertyList = new llvm::GlobalVariable(TheModule, 1644 PropertyListInit->getType(), false, llvm::GlobalValue::InternalLinkage, 1645 PropertyListInit, ".objc_property_list"); 1646 1647 llvm::Constant *OptionalPropertyArray = 1648 llvm::ConstantArray::get(llvm::ArrayType::get(PropertyMetadataTy, 1649 OptionalProperties.size()) , OptionalProperties); 1650 llvm::Constant* OptionalPropertyListInitFields[] = { 1651 llvm::ConstantInt::get(IntTy, OptionalProperties.size()), NULLPtr, 1652 OptionalPropertyArray }; 1653 1654 llvm::Constant *OptionalPropertyListInit = 1655 llvm::ConstantStruct::getAnon(OptionalPropertyListInitFields); 1656 llvm::Constant *OptionalPropertyList = new llvm::GlobalVariable(TheModule, 1657 OptionalPropertyListInit->getType(), false, 1658 llvm::GlobalValue::InternalLinkage, OptionalPropertyListInit, 1659 ".objc_property_list"); 1660 1661 // Protocols are objects containing lists of the methods implemented and 1662 // protocols adopted. 1663 llvm::StructType *ProtocolTy = llvm::StructType::get(IdTy, 1664 PtrToInt8Ty, 1665 ProtocolList->getType(), 1666 InstanceMethodList->getType(), 1667 ClassMethodList->getType(), 1668 OptionalInstanceMethodList->getType(), 1669 OptionalClassMethodList->getType(), 1670 PropertyList->getType(), 1671 OptionalPropertyList->getType(), 1672 NULL); 1673 std::vector<llvm::Constant*> Elements; 1674 // The isa pointer must be set to a magic number so the runtime knows it's 1675 // the correct layout. 1676 Elements.push_back(llvm::ConstantExpr::getIntToPtr( 1677 llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy)); 1678 Elements.push_back(MakeConstantString(ProtocolName, ".objc_protocol_name")); 1679 Elements.push_back(ProtocolList); 1680 Elements.push_back(InstanceMethodList); 1681 Elements.push_back(ClassMethodList); 1682 Elements.push_back(OptionalInstanceMethodList); 1683 Elements.push_back(OptionalClassMethodList); 1684 Elements.push_back(PropertyList); 1685 Elements.push_back(OptionalPropertyList); 1686 ExistingProtocols[ProtocolName] = 1687 llvm::ConstantExpr::getBitCast(MakeGlobal(ProtocolTy, Elements, 1688 ".objc_protocol"), IdTy); 1689 } 1690 void CGObjCGNU::GenerateProtocolHolderCategory(void) { 1691 // Collect information about instance methods 1692 SmallVector<Selector, 1> MethodSels; 1693 SmallVector<llvm::Constant*, 1> MethodTypes; 1694 1695 std::vector<llvm::Constant*> Elements; 1696 const std::string ClassName = "__ObjC_Protocol_Holder_Ugly_Hack"; 1697 const std::string CategoryName = "AnotherHack"; 1698 Elements.push_back(MakeConstantString(CategoryName)); 1699 Elements.push_back(MakeConstantString(ClassName)); 1700 // Instance method list 1701 Elements.push_back(llvm::ConstantExpr::getBitCast(GenerateMethodList( 1702 ClassName, CategoryName, MethodSels, MethodTypes, false), PtrTy)); 1703 // Class method list 1704 Elements.push_back(llvm::ConstantExpr::getBitCast(GenerateMethodList( 1705 ClassName, CategoryName, MethodSels, MethodTypes, true), PtrTy)); 1706 // Protocol list 1707 llvm::ArrayType *ProtocolArrayTy = llvm::ArrayType::get(PtrTy, 1708 ExistingProtocols.size()); 1709 llvm::StructType *ProtocolListTy = llvm::StructType::get( 1710 PtrTy, //Should be a recurisve pointer, but it's always NULL here. 1711 SizeTy, 1712 ProtocolArrayTy, 1713 NULL); 1714 std::vector<llvm::Constant*> ProtocolElements; 1715 for (llvm::StringMapIterator<llvm::Constant*> iter = 1716 ExistingProtocols.begin(), endIter = ExistingProtocols.end(); 1717 iter != endIter ; iter++) { 1718 llvm::Constant *Ptr = llvm::ConstantExpr::getBitCast(iter->getValue(), 1719 PtrTy); 1720 ProtocolElements.push_back(Ptr); 1721 } 1722 llvm::Constant * ProtocolArray = llvm::ConstantArray::get(ProtocolArrayTy, 1723 ProtocolElements); 1724 ProtocolElements.clear(); 1725 ProtocolElements.push_back(NULLPtr); 1726 ProtocolElements.push_back(llvm::ConstantInt::get(LongTy, 1727 ExistingProtocols.size())); 1728 ProtocolElements.push_back(ProtocolArray); 1729 Elements.push_back(llvm::ConstantExpr::getBitCast(MakeGlobal(ProtocolListTy, 1730 ProtocolElements, ".objc_protocol_list"), PtrTy)); 1731 Categories.push_back(llvm::ConstantExpr::getBitCast( 1732 MakeGlobal(llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty, 1733 PtrTy, PtrTy, PtrTy, NULL), Elements), PtrTy)); 1734 } 1735 1736 /// Libobjc2 uses a bitfield representation where small(ish) bitfields are 1737 /// stored in a 64-bit value with the low bit set to 1 and the remaining 63 1738 /// bits set to their values, LSB first, while larger ones are stored in a 1739 /// structure of this / form: 1740 /// 1741 /// struct { int32_t length; int32_t values[length]; }; 1742 /// 1743 /// The values in the array are stored in host-endian format, with the least 1744 /// significant bit being assumed to come first in the bitfield. Therefore, a 1745 /// bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] }, while a 1746 /// bitfield / with the 63rd bit set will be 1<<64. 1747 llvm::Constant *CGObjCGNU::MakeBitField(llvm::SmallVectorImpl<bool> &bits) { 1748 int bitCount = bits.size(); 1749 int ptrBits = 1750 (TheModule.getPointerSize() == llvm::Module::Pointer32) ? 32 : 64; 1751 if (bitCount < ptrBits) { 1752 uint64_t val = 1; 1753 for (int i=0 ; i<bitCount ; ++i) { 1754 if (bits[i]) val |= 1ULL<<(i+1); 1755 } 1756 return llvm::ConstantInt::get(IntPtrTy, val); 1757 } 1758 llvm::SmallVector<llvm::Constant*, 8> values; 1759 int v=0; 1760 while (v < bitCount) { 1761 int32_t word = 0; 1762 for (int i=0 ; (i<32) && (v<bitCount) ; ++i) { 1763 if (bits[v]) word |= 1<<i; 1764 v++; 1765 } 1766 values.push_back(llvm::ConstantInt::get(Int32Ty, word)); 1767 } 1768 llvm::ArrayType *arrayTy = llvm::ArrayType::get(Int32Ty, values.size()); 1769 llvm::Constant *array = llvm::ConstantArray::get(arrayTy, values); 1770 llvm::Constant *fields[2] = { 1771 llvm::ConstantInt::get(Int32Ty, values.size()), 1772 array }; 1773 llvm::Constant *GS = MakeGlobal(llvm::StructType::get(Int32Ty, arrayTy, 1774 NULL), fields); 1775 llvm::Constant *ptr = llvm::ConstantExpr::getPtrToInt(GS, IntPtrTy); 1776 return ptr; 1777 } 1778 1779 void CGObjCGNU::GenerateCategory(const ObjCCategoryImplDecl *OCD) { 1780 std::string ClassName = OCD->getClassInterface()->getNameAsString(); 1781 std::string CategoryName = OCD->getNameAsString(); 1782 // Collect information about instance methods 1783 SmallVector<Selector, 16> InstanceMethodSels; 1784 SmallVector<llvm::Constant*, 16> InstanceMethodTypes; 1785 for (ObjCCategoryImplDecl::instmeth_iterator 1786 iter = OCD->instmeth_begin(), endIter = OCD->instmeth_end(); 1787 iter != endIter ; iter++) { 1788 InstanceMethodSels.push_back((*iter)->getSelector()); 1789 std::string TypeStr; 1790 CGM.getContext().getObjCEncodingForMethodDecl(*iter,TypeStr); 1791 InstanceMethodTypes.push_back(MakeConstantString(TypeStr)); 1792 } 1793 1794 // Collect information about class methods 1795 SmallVector<Selector, 16> ClassMethodSels; 1796 SmallVector<llvm::Constant*, 16> ClassMethodTypes; 1797 for (ObjCCategoryImplDecl::classmeth_iterator 1798 iter = OCD->classmeth_begin(), endIter = OCD->classmeth_end(); 1799 iter != endIter ; iter++) { 1800 ClassMethodSels.push_back((*iter)->getSelector()); 1801 std::string TypeStr; 1802 CGM.getContext().getObjCEncodingForMethodDecl(*iter,TypeStr); 1803 ClassMethodTypes.push_back(MakeConstantString(TypeStr)); 1804 } 1805 1806 // Collect the names of referenced protocols 1807 SmallVector<std::string, 16> Protocols; 1808 const ObjCCategoryDecl *CatDecl = OCD->getCategoryDecl(); 1809 const ObjCList<ObjCProtocolDecl> &Protos = CatDecl->getReferencedProtocols(); 1810 for (ObjCList<ObjCProtocolDecl>::iterator I = Protos.begin(), 1811 E = Protos.end(); I != E; ++I) 1812 Protocols.push_back((*I)->getNameAsString()); 1813 1814 std::vector<llvm::Constant*> Elements; 1815 Elements.push_back(MakeConstantString(CategoryName)); 1816 Elements.push_back(MakeConstantString(ClassName)); 1817 // Instance method list 1818 Elements.push_back(llvm::ConstantExpr::getBitCast(GenerateMethodList( 1819 ClassName, CategoryName, InstanceMethodSels, InstanceMethodTypes, 1820 false), PtrTy)); 1821 // Class method list 1822 Elements.push_back(llvm::ConstantExpr::getBitCast(GenerateMethodList( 1823 ClassName, CategoryName, ClassMethodSels, ClassMethodTypes, true), 1824 PtrTy)); 1825 // Protocol list 1826 Elements.push_back(llvm::ConstantExpr::getBitCast( 1827 GenerateProtocolList(Protocols), PtrTy)); 1828 Categories.push_back(llvm::ConstantExpr::getBitCast( 1829 MakeGlobal(llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty, 1830 PtrTy, PtrTy, PtrTy, NULL), Elements), PtrTy)); 1831 } 1832 1833 llvm::Constant *CGObjCGNU::GeneratePropertyList(const ObjCImplementationDecl *OID, 1834 SmallVectorImpl<Selector> &InstanceMethodSels, 1835 SmallVectorImpl<llvm::Constant*> &InstanceMethodTypes) { 1836 ASTContext &Context = CGM.getContext(); 1837 // 1838 // Property metadata: name, attributes, isSynthesized, setter name, setter 1839 // types, getter name, getter types. 1840 llvm::StructType *PropertyMetadataTy = llvm::StructType::get( 1841 PtrToInt8Ty, Int8Ty, Int8Ty, PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty, 1842 PtrToInt8Ty, NULL); 1843 std::vector<llvm::Constant*> Properties; 1844 1845 1846 // Add all of the property methods need adding to the method list and to the 1847 // property metadata list. 1848 for (ObjCImplDecl::propimpl_iterator 1849 iter = OID->propimpl_begin(), endIter = OID->propimpl_end(); 1850 iter != endIter ; iter++) { 1851 std::vector<llvm::Constant*> Fields; 1852 ObjCPropertyDecl *property = (*iter)->getPropertyDecl(); 1853 ObjCPropertyImplDecl *propertyImpl = *iter; 1854 bool isSynthesized = (propertyImpl->getPropertyImplementation() == 1855 ObjCPropertyImplDecl::Synthesize); 1856 1857 Fields.push_back(MakeConstantString(property->getNameAsString())); 1858 Fields.push_back(llvm::ConstantInt::get(Int8Ty, 1859 property->getPropertyAttributes())); 1860 Fields.push_back(llvm::ConstantInt::get(Int8Ty, isSynthesized)); 1861 if (ObjCMethodDecl *getter = property->getGetterMethodDecl()) { 1862 std::string TypeStr; 1863 Context.getObjCEncodingForMethodDecl(getter,TypeStr); 1864 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr); 1865 if (isSynthesized) { 1866 InstanceMethodTypes.push_back(TypeEncoding); 1867 InstanceMethodSels.push_back(getter->getSelector()); 1868 } 1869 Fields.push_back(MakeConstantString(getter->getSelector().getAsString())); 1870 Fields.push_back(TypeEncoding); 1871 } else { 1872 Fields.push_back(NULLPtr); 1873 Fields.push_back(NULLPtr); 1874 } 1875 if (ObjCMethodDecl *setter = property->getSetterMethodDecl()) { 1876 std::string TypeStr; 1877 Context.getObjCEncodingForMethodDecl(setter,TypeStr); 1878 llvm::Constant *TypeEncoding = MakeConstantString(TypeStr); 1879 if (isSynthesized) { 1880 InstanceMethodTypes.push_back(TypeEncoding); 1881 InstanceMethodSels.push_back(setter->getSelector()); 1882 } 1883 Fields.push_back(MakeConstantString(setter->getSelector().getAsString())); 1884 Fields.push_back(TypeEncoding); 1885 } else { 1886 Fields.push_back(NULLPtr); 1887 Fields.push_back(NULLPtr); 1888 } 1889 Properties.push_back(llvm::ConstantStruct::get(PropertyMetadataTy, Fields)); 1890 } 1891 llvm::ArrayType *PropertyArrayTy = 1892 llvm::ArrayType::get(PropertyMetadataTy, Properties.size()); 1893 llvm::Constant *PropertyArray = llvm::ConstantArray::get(PropertyArrayTy, 1894 Properties); 1895 llvm::Constant* PropertyListInitFields[] = 1896 {llvm::ConstantInt::get(IntTy, Properties.size()), NULLPtr, PropertyArray}; 1897 1898 llvm::Constant *PropertyListInit = 1899 llvm::ConstantStruct::getAnon(PropertyListInitFields); 1900 return new llvm::GlobalVariable(TheModule, PropertyListInit->getType(), false, 1901 llvm::GlobalValue::InternalLinkage, PropertyListInit, 1902 ".objc_property_list"); 1903 } 1904 1905 void CGObjCGNU::GenerateClass(const ObjCImplementationDecl *OID) { 1906 ASTContext &Context = CGM.getContext(); 1907 1908 // Get the superclass name. 1909 const ObjCInterfaceDecl * SuperClassDecl = 1910 OID->getClassInterface()->getSuperClass(); 1911 std::string SuperClassName; 1912 if (SuperClassDecl) { 1913 SuperClassName = SuperClassDecl->getNameAsString(); 1914 EmitClassRef(SuperClassName); 1915 } 1916 1917 // Get the class name 1918 ObjCInterfaceDecl *ClassDecl = 1919 const_cast<ObjCInterfaceDecl *>(OID->getClassInterface()); 1920 std::string ClassName = ClassDecl->getNameAsString(); 1921 // Emit the symbol that is used to generate linker errors if this class is 1922 // referenced in other modules but not declared. 1923 std::string classSymbolName = "__objc_class_name_" + ClassName; 1924 if (llvm::GlobalVariable *symbol = 1925 TheModule.getGlobalVariable(classSymbolName)) { 1926 symbol->setInitializer(llvm::ConstantInt::get(LongTy, 0)); 1927 } else { 1928 new llvm::GlobalVariable(TheModule, LongTy, false, 1929 llvm::GlobalValue::ExternalLinkage, llvm::ConstantInt::get(LongTy, 0), 1930 classSymbolName); 1931 } 1932 1933 // Get the size of instances. 1934 int instanceSize = 1935 Context.getASTObjCImplementationLayout(OID).getSize().getQuantity(); 1936 1937 // Collect information about instance variables. 1938 SmallVector<llvm::Constant*, 16> IvarNames; 1939 SmallVector<llvm::Constant*, 16> IvarTypes; 1940 SmallVector<llvm::Constant*, 16> IvarOffsets; 1941 1942 std::vector<llvm::Constant*> IvarOffsetValues; 1943 SmallVector<bool, 16> WeakIvars; 1944 SmallVector<bool, 16> StrongIvars; 1945 1946 int superInstanceSize = !SuperClassDecl ? 0 : 1947 Context.getASTObjCInterfaceLayout(SuperClassDecl).getSize().getQuantity(); 1948 // For non-fragile ivars, set the instance size to 0 - {the size of just this 1949 // class}. The runtime will then set this to the correct value on load. 1950 if (CGM.getContext().getLangOptions().ObjCNonFragileABI) { 1951 instanceSize = 0 - (instanceSize - superInstanceSize); 1952 } 1953 1954 for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD; 1955 IVD = IVD->getNextIvar()) { 1956 // Store the name 1957 IvarNames.push_back(MakeConstantString(IVD->getNameAsString())); 1958 // Get the type encoding for this ivar 1959 std::string TypeStr; 1960 Context.getObjCEncodingForType(IVD->getType(), TypeStr); 1961 IvarTypes.push_back(MakeConstantString(TypeStr)); 1962 // Get the offset 1963 uint64_t BaseOffset = ComputeIvarBaseOffset(CGM, OID, IVD); 1964 uint64_t Offset = BaseOffset; 1965 if (CGM.getContext().getLangOptions().ObjCNonFragileABI) { 1966 Offset = BaseOffset - superInstanceSize; 1967 } 1968 llvm::Constant *OffsetValue = llvm::ConstantInt::get(IntTy, Offset); 1969 // Create the direct offset value 1970 std::string OffsetName = "__objc_ivar_offset_value_" + ClassName +"." + 1971 IVD->getNameAsString(); 1972 llvm::GlobalVariable *OffsetVar = TheModule.getGlobalVariable(OffsetName); 1973 if (OffsetVar) { 1974 OffsetVar->setInitializer(OffsetValue); 1975 // If this is the real definition, change its linkage type so that 1976 // different modules will use this one, rather than their private 1977 // copy. 1978 OffsetVar->setLinkage(llvm::GlobalValue::ExternalLinkage); 1979 } else 1980 OffsetVar = new llvm::GlobalVariable(TheModule, IntTy, 1981 false, llvm::GlobalValue::ExternalLinkage, 1982 OffsetValue, 1983 "__objc_ivar_offset_value_" + ClassName +"." + 1984 IVD->getNameAsString()); 1985 IvarOffsets.push_back(OffsetValue); 1986 IvarOffsetValues.push_back(OffsetVar); 1987 Qualifiers::ObjCLifetime lt = IVD->getType().getQualifiers().getObjCLifetime(); 1988 switch (lt) { 1989 case Qualifiers::OCL_Strong: 1990 StrongIvars.push_back(true); 1991 WeakIvars.push_back(false); 1992 break; 1993 case Qualifiers::OCL_Weak: 1994 StrongIvars.push_back(false); 1995 WeakIvars.push_back(true); 1996 break; 1997 default: 1998 StrongIvars.push_back(false); 1999 WeakIvars.push_back(false); 2000 } 2001 } 2002 llvm::Constant *StrongIvarBitmap = MakeBitField(StrongIvars); 2003 llvm::Constant *WeakIvarBitmap = MakeBitField(WeakIvars); 2004 llvm::GlobalVariable *IvarOffsetArray = 2005 MakeGlobalArray(PtrToIntTy, IvarOffsetValues, ".ivar.offsets"); 2006 2007 2008 // Collect information about instance methods 2009 SmallVector<Selector, 16> InstanceMethodSels; 2010 SmallVector<llvm::Constant*, 16> InstanceMethodTypes; 2011 for (ObjCImplementationDecl::instmeth_iterator 2012 iter = OID->instmeth_begin(), endIter = OID->instmeth_end(); 2013 iter != endIter ; iter++) { 2014 InstanceMethodSels.push_back((*iter)->getSelector()); 2015 std::string TypeStr; 2016 Context.getObjCEncodingForMethodDecl((*iter),TypeStr); 2017 InstanceMethodTypes.push_back(MakeConstantString(TypeStr)); 2018 } 2019 2020 llvm::Constant *Properties = GeneratePropertyList(OID, InstanceMethodSels, 2021 InstanceMethodTypes); 2022 2023 2024 // Collect information about class methods 2025 SmallVector<Selector, 16> ClassMethodSels; 2026 SmallVector<llvm::Constant*, 16> ClassMethodTypes; 2027 for (ObjCImplementationDecl::classmeth_iterator 2028 iter = OID->classmeth_begin(), endIter = OID->classmeth_end(); 2029 iter != endIter ; iter++) { 2030 ClassMethodSels.push_back((*iter)->getSelector()); 2031 std::string TypeStr; 2032 Context.getObjCEncodingForMethodDecl((*iter),TypeStr); 2033 ClassMethodTypes.push_back(MakeConstantString(TypeStr)); 2034 } 2035 // Collect the names of referenced protocols 2036 SmallVector<std::string, 16> Protocols; 2037 const ObjCList<ObjCProtocolDecl> &Protos =ClassDecl->getReferencedProtocols(); 2038 for (ObjCList<ObjCProtocolDecl>::iterator I = Protos.begin(), 2039 E = Protos.end(); I != E; ++I) 2040 Protocols.push_back((*I)->getNameAsString()); 2041 2042 2043 2044 // Get the superclass pointer. 2045 llvm::Constant *SuperClass; 2046 if (!SuperClassName.empty()) { 2047 SuperClass = MakeConstantString(SuperClassName, ".super_class_name"); 2048 } else { 2049 SuperClass = llvm::ConstantPointerNull::get(PtrToInt8Ty); 2050 } 2051 // Empty vector used to construct empty method lists 2052 SmallVector<llvm::Constant*, 1> empty; 2053 // Generate the method and instance variable lists 2054 llvm::Constant *MethodList = GenerateMethodList(ClassName, "", 2055 InstanceMethodSels, InstanceMethodTypes, false); 2056 llvm::Constant *ClassMethodList = GenerateMethodList(ClassName, "", 2057 ClassMethodSels, ClassMethodTypes, true); 2058 llvm::Constant *IvarList = GenerateIvarList(IvarNames, IvarTypes, 2059 IvarOffsets); 2060 // Irrespective of whether we are compiling for a fragile or non-fragile ABI, 2061 // we emit a symbol containing the offset for each ivar in the class. This 2062 // allows code compiled for the non-Fragile ABI to inherit from code compiled 2063 // for the legacy ABI, without causing problems. The converse is also 2064 // possible, but causes all ivar accesses to be fragile. 2065 2066 // Offset pointer for getting at the correct field in the ivar list when 2067 // setting up the alias. These are: The base address for the global, the 2068 // ivar array (second field), the ivar in this list (set for each ivar), and 2069 // the offset (third field in ivar structure) 2070 llvm::Type *IndexTy = Int32Ty; 2071 llvm::Constant *offsetPointerIndexes[] = {Zeros[0], 2072 llvm::ConstantInt::get(IndexTy, 1), 0, 2073 llvm::ConstantInt::get(IndexTy, 2) }; 2074 2075 unsigned ivarIndex = 0; 2076 for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD; 2077 IVD = IVD->getNextIvar()) { 2078 const std::string Name = "__objc_ivar_offset_" + ClassName + '.' 2079 + IVD->getNameAsString(); 2080 offsetPointerIndexes[2] = llvm::ConstantInt::get(IndexTy, ivarIndex); 2081 // Get the correct ivar field 2082 llvm::Constant *offsetValue = llvm::ConstantExpr::getGetElementPtr( 2083 IvarList, offsetPointerIndexes); 2084 // Get the existing variable, if one exists. 2085 llvm::GlobalVariable *offset = TheModule.getNamedGlobal(Name); 2086 if (offset) { 2087 offset->setInitializer(offsetValue); 2088 // If this is the real definition, change its linkage type so that 2089 // different modules will use this one, rather than their private 2090 // copy. 2091 offset->setLinkage(llvm::GlobalValue::ExternalLinkage); 2092 } else { 2093 // Add a new alias if there isn't one already. 2094 offset = new llvm::GlobalVariable(TheModule, offsetValue->getType(), 2095 false, llvm::GlobalValue::ExternalLinkage, offsetValue, Name); 2096 } 2097 ++ivarIndex; 2098 } 2099 llvm::Constant *ZeroPtr = llvm::ConstantInt::get(IntPtrTy, 0); 2100 //Generate metaclass for class methods 2101 llvm::Constant *MetaClassStruct = GenerateClassStructure(NULLPtr, 2102 NULLPtr, 0x12L, ClassName.c_str(), 0, Zeros[0], GenerateIvarList( 2103 empty, empty, empty), ClassMethodList, NULLPtr, 2104 NULLPtr, NULLPtr, ZeroPtr, ZeroPtr, true); 2105 2106 // Generate the class structure 2107 llvm::Constant *ClassStruct = 2108 GenerateClassStructure(MetaClassStruct, SuperClass, 0x11L, 2109 ClassName.c_str(), 0, 2110 llvm::ConstantInt::get(LongTy, instanceSize), IvarList, 2111 MethodList, GenerateProtocolList(Protocols), IvarOffsetArray, 2112 Properties, StrongIvarBitmap, WeakIvarBitmap); 2113 2114 // Resolve the class aliases, if they exist. 2115 if (ClassPtrAlias) { 2116 ClassPtrAlias->replaceAllUsesWith( 2117 llvm::ConstantExpr::getBitCast(ClassStruct, IdTy)); 2118 ClassPtrAlias->eraseFromParent(); 2119 ClassPtrAlias = 0; 2120 } 2121 if (MetaClassPtrAlias) { 2122 MetaClassPtrAlias->replaceAllUsesWith( 2123 llvm::ConstantExpr::getBitCast(MetaClassStruct, IdTy)); 2124 MetaClassPtrAlias->eraseFromParent(); 2125 MetaClassPtrAlias = 0; 2126 } 2127 2128 // Add class structure to list to be added to the symtab later 2129 ClassStruct = llvm::ConstantExpr::getBitCast(ClassStruct, PtrToInt8Ty); 2130 Classes.push_back(ClassStruct); 2131 } 2132 2133 2134 llvm::Function *CGObjCGNU::ModuleInitFunction() { 2135 // Only emit an ObjC load function if no Objective-C stuff has been called 2136 if (Classes.empty() && Categories.empty() && ConstantStrings.empty() && 2137 ExistingProtocols.empty() && SelectorTable.empty()) 2138 return NULL; 2139 2140 // Add all referenced protocols to a category. 2141 GenerateProtocolHolderCategory(); 2142 2143 llvm::StructType *SelStructTy = dyn_cast<llvm::StructType>( 2144 SelectorTy->getElementType()); 2145 llvm::Type *SelStructPtrTy = SelectorTy; 2146 if (SelStructTy == 0) { 2147 SelStructTy = llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty, NULL); 2148 SelStructPtrTy = llvm::PointerType::getUnqual(SelStructTy); 2149 } 2150 2151 std::vector<llvm::Constant*> Elements; 2152 llvm::Constant *Statics = NULLPtr; 2153 // Generate statics list: 2154 if (ConstantStrings.size()) { 2155 llvm::ArrayType *StaticsArrayTy = llvm::ArrayType::get(PtrToInt8Ty, 2156 ConstantStrings.size() + 1); 2157 ConstantStrings.push_back(NULLPtr); 2158 2159 StringRef StringClass = CGM.getLangOptions().ObjCConstantStringClass; 2160 2161 if (StringClass.empty()) StringClass = "NXConstantString"; 2162 2163 Elements.push_back(MakeConstantString(StringClass, 2164 ".objc_static_class_name")); 2165 Elements.push_back(llvm::ConstantArray::get(StaticsArrayTy, 2166 ConstantStrings)); 2167 llvm::StructType *StaticsListTy = 2168 llvm::StructType::get(PtrToInt8Ty, StaticsArrayTy, NULL); 2169 llvm::Type *StaticsListPtrTy = 2170 llvm::PointerType::getUnqual(StaticsListTy); 2171 Statics = MakeGlobal(StaticsListTy, Elements, ".objc_statics"); 2172 llvm::ArrayType *StaticsListArrayTy = 2173 llvm::ArrayType::get(StaticsListPtrTy, 2); 2174 Elements.clear(); 2175 Elements.push_back(Statics); 2176 Elements.push_back(llvm::Constant::getNullValue(StaticsListPtrTy)); 2177 Statics = MakeGlobal(StaticsListArrayTy, Elements, ".objc_statics_ptr"); 2178 Statics = llvm::ConstantExpr::getBitCast(Statics, PtrTy); 2179 } 2180 // Array of classes, categories, and constant objects 2181 llvm::ArrayType *ClassListTy = llvm::ArrayType::get(PtrToInt8Ty, 2182 Classes.size() + Categories.size() + 2); 2183 llvm::StructType *SymTabTy = llvm::StructType::get(LongTy, SelStructPtrTy, 2184 llvm::Type::getInt16Ty(VMContext), 2185 llvm::Type::getInt16Ty(VMContext), 2186 ClassListTy, NULL); 2187 2188 Elements.clear(); 2189 // Pointer to an array of selectors used in this module. 2190 std::vector<llvm::Constant*> Selectors; 2191 std::vector<llvm::GlobalAlias*> SelectorAliases; 2192 for (SelectorMap::iterator iter = SelectorTable.begin(), 2193 iterEnd = SelectorTable.end(); iter != iterEnd ; ++iter) { 2194 2195 std::string SelNameStr = iter->first.getAsString(); 2196 llvm::Constant *SelName = ExportUniqueString(SelNameStr, ".objc_sel_name"); 2197 2198 SmallVectorImpl<TypedSelector> &Types = iter->second; 2199 for (SmallVectorImpl<TypedSelector>::iterator i = Types.begin(), 2200 e = Types.end() ; i!=e ; i++) { 2201 2202 llvm::Constant *SelectorTypeEncoding = NULLPtr; 2203 if (!i->first.empty()) 2204 SelectorTypeEncoding = MakeConstantString(i->first, ".objc_sel_types"); 2205 2206 Elements.push_back(SelName); 2207 Elements.push_back(SelectorTypeEncoding); 2208 Selectors.push_back(llvm::ConstantStruct::get(SelStructTy, Elements)); 2209 Elements.clear(); 2210 2211 // Store the selector alias for later replacement 2212 SelectorAliases.push_back(i->second); 2213 } 2214 } 2215 unsigned SelectorCount = Selectors.size(); 2216 // NULL-terminate the selector list. This should not actually be required, 2217 // because the selector list has a length field. Unfortunately, the GCC 2218 // runtime decides to ignore the length field and expects a NULL terminator, 2219 // and GCC cooperates with this by always setting the length to 0. 2220 Elements.push_back(NULLPtr); 2221 Elements.push_back(NULLPtr); 2222 Selectors.push_back(llvm::ConstantStruct::get(SelStructTy, Elements)); 2223 Elements.clear(); 2224 2225 // Number of static selectors 2226 Elements.push_back(llvm::ConstantInt::get(LongTy, SelectorCount)); 2227 llvm::Constant *SelectorList = MakeGlobalArray(SelStructTy, Selectors, 2228 ".objc_selector_list"); 2229 Elements.push_back(llvm::ConstantExpr::getBitCast(SelectorList, 2230 SelStructPtrTy)); 2231 2232 // Now that all of the static selectors exist, create pointers to them. 2233 for (unsigned int i=0 ; i<SelectorCount ; i++) { 2234 2235 llvm::Constant *Idxs[] = {Zeros[0], 2236 llvm::ConstantInt::get(Int32Ty, i), Zeros[0]}; 2237 // FIXME: We're generating redundant loads and stores here! 2238 llvm::Constant *SelPtr = llvm::ConstantExpr::getGetElementPtr(SelectorList, 2239 makeArrayRef(Idxs, 2)); 2240 // If selectors are defined as an opaque type, cast the pointer to this 2241 // type. 2242 SelPtr = llvm::ConstantExpr::getBitCast(SelPtr, SelectorTy); 2243 SelectorAliases[i]->replaceAllUsesWith(SelPtr); 2244 SelectorAliases[i]->eraseFromParent(); 2245 } 2246 2247 // Number of classes defined. 2248 Elements.push_back(llvm::ConstantInt::get(llvm::Type::getInt16Ty(VMContext), 2249 Classes.size())); 2250 // Number of categories defined 2251 Elements.push_back(llvm::ConstantInt::get(llvm::Type::getInt16Ty(VMContext), 2252 Categories.size())); 2253 // Create an array of classes, then categories, then static object instances 2254 Classes.insert(Classes.end(), Categories.begin(), Categories.end()); 2255 // NULL-terminated list of static object instances (mainly constant strings) 2256 Classes.push_back(Statics); 2257 Classes.push_back(NULLPtr); 2258 llvm::Constant *ClassList = llvm::ConstantArray::get(ClassListTy, Classes); 2259 Elements.push_back(ClassList); 2260 // Construct the symbol table 2261 llvm::Constant *SymTab= MakeGlobal(SymTabTy, Elements); 2262 2263 // The symbol table is contained in a module which has some version-checking 2264 // constants 2265 llvm::StructType * ModuleTy = llvm::StructType::get(LongTy, LongTy, 2266 PtrToInt8Ty, llvm::PointerType::getUnqual(SymTabTy), 2267 (RuntimeVersion >= 10) ? IntTy : NULL, NULL); 2268 Elements.clear(); 2269 // Runtime version, used for ABI compatibility checking. 2270 Elements.push_back(llvm::ConstantInt::get(LongTy, RuntimeVersion)); 2271 // sizeof(ModuleTy) 2272 llvm::TargetData td(&TheModule); 2273 Elements.push_back( 2274 llvm::ConstantInt::get(LongTy, 2275 td.getTypeSizeInBits(ModuleTy) / 2276 CGM.getContext().getCharWidth())); 2277 2278 // The path to the source file where this module was declared 2279 SourceManager &SM = CGM.getContext().getSourceManager(); 2280 const FileEntry *mainFile = SM.getFileEntryForID(SM.getMainFileID()); 2281 std::string path = 2282 std::string(mainFile->getDir()->getName()) + '/' + mainFile->getName(); 2283 Elements.push_back(MakeConstantString(path, ".objc_source_file_name")); 2284 Elements.push_back(SymTab); 2285 2286 if (RuntimeVersion >= 10) 2287 switch (CGM.getLangOptions().getGC()) { 2288 case LangOptions::GCOnly: 2289 Elements.push_back(llvm::ConstantInt::get(IntTy, 2)); 2290 break; 2291 case LangOptions::NonGC: 2292 if (CGM.getLangOptions().ObjCAutoRefCount) 2293 Elements.push_back(llvm::ConstantInt::get(IntTy, 1)); 2294 else 2295 Elements.push_back(llvm::ConstantInt::get(IntTy, 0)); 2296 break; 2297 case LangOptions::HybridGC: 2298 Elements.push_back(llvm::ConstantInt::get(IntTy, 1)); 2299 break; 2300 } 2301 2302 llvm::Value *Module = MakeGlobal(ModuleTy, Elements); 2303 2304 // Create the load function calling the runtime entry point with the module 2305 // structure 2306 llvm::Function * LoadFunction = llvm::Function::Create( 2307 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext), false), 2308 llvm::GlobalValue::InternalLinkage, ".objc_load_function", 2309 &TheModule); 2310 llvm::BasicBlock *EntryBB = 2311 llvm::BasicBlock::Create(VMContext, "entry", LoadFunction); 2312 CGBuilderTy Builder(VMContext); 2313 Builder.SetInsertPoint(EntryBB); 2314 2315 llvm::FunctionType *FT = 2316 llvm::FunctionType::get(Builder.getVoidTy(), 2317 llvm::PointerType::getUnqual(ModuleTy), true); 2318 llvm::Value *Register = CGM.CreateRuntimeFunction(FT, "__objc_exec_class"); 2319 Builder.CreateCall(Register, Module); 2320 Builder.CreateRetVoid(); 2321 2322 return LoadFunction; 2323 } 2324 2325 llvm::Function *CGObjCGNU::GenerateMethod(const ObjCMethodDecl *OMD, 2326 const ObjCContainerDecl *CD) { 2327 const ObjCCategoryImplDecl *OCD = 2328 dyn_cast<ObjCCategoryImplDecl>(OMD->getDeclContext()); 2329 StringRef CategoryName = OCD ? OCD->getName() : ""; 2330 StringRef ClassName = CD->getName(); 2331 Selector MethodName = OMD->getSelector(); 2332 bool isClassMethod = !OMD->isInstanceMethod(); 2333 2334 CodeGenTypes &Types = CGM.getTypes(); 2335 llvm::FunctionType *MethodTy = 2336 Types.GetFunctionType(Types.getFunctionInfo(OMD), OMD->isVariadic()); 2337 std::string FunctionName = SymbolNameForMethod(ClassName, CategoryName, 2338 MethodName, isClassMethod); 2339 2340 llvm::Function *Method 2341 = llvm::Function::Create(MethodTy, 2342 llvm::GlobalValue::InternalLinkage, 2343 FunctionName, 2344 &TheModule); 2345 return Method; 2346 } 2347 2348 llvm::Constant *CGObjCGNU::GetPropertyGetFunction() { 2349 return GetPropertyFn; 2350 } 2351 2352 llvm::Constant *CGObjCGNU::GetPropertySetFunction() { 2353 return SetPropertyFn; 2354 } 2355 2356 llvm::Constant *CGObjCGNU::GetGetStructFunction() { 2357 return GetStructPropertyFn; 2358 } 2359 llvm::Constant *CGObjCGNU::GetSetStructFunction() { 2360 return SetStructPropertyFn; 2361 } 2362 2363 llvm::Constant *CGObjCGNU::EnumerationMutationFunction() { 2364 return EnumerationMutationFn; 2365 } 2366 2367 void CGObjCGNU::EmitSynchronizedStmt(CodeGenFunction &CGF, 2368 const ObjCAtSynchronizedStmt &S) { 2369 EmitAtSynchronizedStmt(CGF, S, SyncEnterFn, SyncExitFn); 2370 } 2371 2372 2373 void CGObjCGNU::EmitTryStmt(CodeGenFunction &CGF, 2374 const ObjCAtTryStmt &S) { 2375 // Unlike the Apple non-fragile runtimes, which also uses 2376 // unwind-based zero cost exceptions, the GNU Objective C runtime's 2377 // EH support isn't a veneer over C++ EH. Instead, exception 2378 // objects are created by __objc_exception_throw and destroyed by 2379 // the personality function; this avoids the need for bracketing 2380 // catch handlers with calls to __blah_begin_catch/__blah_end_catch 2381 // (or even _Unwind_DeleteException), but probably doesn't 2382 // interoperate very well with foreign exceptions. 2383 // 2384 // In Objective-C++ mode, we actually emit something equivalent to the C++ 2385 // exception handler. 2386 EmitTryCatchStmt(CGF, S, EnterCatchFn, ExitCatchFn, ExceptionReThrowFn); 2387 return ; 2388 } 2389 2390 void CGObjCGNU::EmitThrowStmt(CodeGenFunction &CGF, 2391 const ObjCAtThrowStmt &S) { 2392 llvm::Value *ExceptionAsObject; 2393 2394 if (const Expr *ThrowExpr = S.getThrowExpr()) { 2395 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr); 2396 ExceptionAsObject = Exception; 2397 } else { 2398 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) && 2399 "Unexpected rethrow outside @catch block."); 2400 ExceptionAsObject = CGF.ObjCEHValueStack.back(); 2401 } 2402 ExceptionAsObject = CGF.Builder.CreateBitCast(ExceptionAsObject, IdTy); 2403 2404 // Note: This may have to be an invoke, if we want to support constructs like: 2405 // @try { 2406 // @throw(obj); 2407 // } 2408 // @catch(id) ... 2409 // 2410 // This is effectively turning @throw into an incredibly-expensive goto, but 2411 // it may happen as a result of inlining followed by missed optimizations, or 2412 // as a result of stupidity. 2413 llvm::BasicBlock *UnwindBB = CGF.getInvokeDest(); 2414 if (!UnwindBB) { 2415 CGF.Builder.CreateCall(ExceptionThrowFn, ExceptionAsObject); 2416 CGF.Builder.CreateUnreachable(); 2417 } else { 2418 CGF.Builder.CreateInvoke(ExceptionThrowFn, UnwindBB, UnwindBB, 2419 ExceptionAsObject); 2420 } 2421 // Clear the insertion point to indicate we are in unreachable code. 2422 CGF.Builder.ClearInsertionPoint(); 2423 } 2424 2425 llvm::Value * CGObjCGNU::EmitObjCWeakRead(CodeGenFunction &CGF, 2426 llvm::Value *AddrWeakObj) { 2427 CGBuilderTy B = CGF.Builder; 2428 AddrWeakObj = EnforceType(B, AddrWeakObj, PtrToIdTy); 2429 return B.CreateCall(WeakReadFn, AddrWeakObj); 2430 } 2431 2432 void CGObjCGNU::EmitObjCWeakAssign(CodeGenFunction &CGF, 2433 llvm::Value *src, llvm::Value *dst) { 2434 CGBuilderTy B = CGF.Builder; 2435 src = EnforceType(B, src, IdTy); 2436 dst = EnforceType(B, dst, PtrToIdTy); 2437 B.CreateCall2(WeakAssignFn, src, dst); 2438 } 2439 2440 void CGObjCGNU::EmitObjCGlobalAssign(CodeGenFunction &CGF, 2441 llvm::Value *src, llvm::Value *dst, 2442 bool threadlocal) { 2443 CGBuilderTy B = CGF.Builder; 2444 src = EnforceType(B, src, IdTy); 2445 dst = EnforceType(B, dst, PtrToIdTy); 2446 if (!threadlocal) 2447 B.CreateCall2(GlobalAssignFn, src, dst); 2448 else 2449 // FIXME. Add threadloca assign API 2450 llvm_unreachable("EmitObjCGlobalAssign - Threal Local API NYI"); 2451 } 2452 2453 void CGObjCGNU::EmitObjCIvarAssign(CodeGenFunction &CGF, 2454 llvm::Value *src, llvm::Value *dst, 2455 llvm::Value *ivarOffset) { 2456 CGBuilderTy B = CGF.Builder; 2457 src = EnforceType(B, src, IdTy); 2458 dst = EnforceType(B, dst, IdTy); 2459 B.CreateCall3(IvarAssignFn, src, dst, ivarOffset); 2460 } 2461 2462 void CGObjCGNU::EmitObjCStrongCastAssign(CodeGenFunction &CGF, 2463 llvm::Value *src, llvm::Value *dst) { 2464 CGBuilderTy B = CGF.Builder; 2465 src = EnforceType(B, src, IdTy); 2466 dst = EnforceType(B, dst, PtrToIdTy); 2467 B.CreateCall2(StrongCastAssignFn, src, dst); 2468 } 2469 2470 void CGObjCGNU::EmitGCMemmoveCollectable(CodeGenFunction &CGF, 2471 llvm::Value *DestPtr, 2472 llvm::Value *SrcPtr, 2473 llvm::Value *Size) { 2474 CGBuilderTy B = CGF.Builder; 2475 DestPtr = EnforceType(B, DestPtr, PtrTy); 2476 SrcPtr = EnforceType(B, SrcPtr, PtrTy); 2477 2478 B.CreateCall3(MemMoveFn, DestPtr, SrcPtr, Size); 2479 } 2480 2481 llvm::GlobalVariable *CGObjCGNU::ObjCIvarOffsetVariable( 2482 const ObjCInterfaceDecl *ID, 2483 const ObjCIvarDecl *Ivar) { 2484 const std::string Name = "__objc_ivar_offset_" + ID->getNameAsString() 2485 + '.' + Ivar->getNameAsString(); 2486 // Emit the variable and initialize it with what we think the correct value 2487 // is. This allows code compiled with non-fragile ivars to work correctly 2488 // when linked against code which isn't (most of the time). 2489 llvm::GlobalVariable *IvarOffsetPointer = TheModule.getNamedGlobal(Name); 2490 if (!IvarOffsetPointer) { 2491 // This will cause a run-time crash if we accidentally use it. A value of 2492 // 0 would seem more sensible, but will silently overwrite the isa pointer 2493 // causing a great deal of confusion. 2494 uint64_t Offset = -1; 2495 // We can't call ComputeIvarBaseOffset() here if we have the 2496 // implementation, because it will create an invalid ASTRecordLayout object 2497 // that we are then stuck with forever, so we only initialize the ivar 2498 // offset variable with a guess if we only have the interface. The 2499 // initializer will be reset later anyway, when we are generating the class 2500 // description. 2501 if (!CGM.getContext().getObjCImplementation( 2502 const_cast<ObjCInterfaceDecl *>(ID))) 2503 Offset = ComputeIvarBaseOffset(CGM, ID, Ivar); 2504 2505 llvm::ConstantInt *OffsetGuess = llvm::ConstantInt::get(Int32Ty, Offset, 2506 /*isSigned*/true); 2507 // Don't emit the guess in non-PIC code because the linker will not be able 2508 // to replace it with the real version for a library. In non-PIC code you 2509 // must compile with the fragile ABI if you want to use ivars from a 2510 // GCC-compiled class. 2511 if (CGM.getLangOptions().PICLevel) { 2512 llvm::GlobalVariable *IvarOffsetGV = new llvm::GlobalVariable(TheModule, 2513 Int32Ty, false, 2514 llvm::GlobalValue::PrivateLinkage, OffsetGuess, Name+".guess"); 2515 IvarOffsetPointer = new llvm::GlobalVariable(TheModule, 2516 IvarOffsetGV->getType(), false, llvm::GlobalValue::LinkOnceAnyLinkage, 2517 IvarOffsetGV, Name); 2518 } else { 2519 IvarOffsetPointer = new llvm::GlobalVariable(TheModule, 2520 llvm::Type::getInt32PtrTy(VMContext), false, 2521 llvm::GlobalValue::ExternalLinkage, 0, Name); 2522 } 2523 } 2524 return IvarOffsetPointer; 2525 } 2526 2527 LValue CGObjCGNU::EmitObjCValueForIvar(CodeGenFunction &CGF, 2528 QualType ObjectTy, 2529 llvm::Value *BaseValue, 2530 const ObjCIvarDecl *Ivar, 2531 unsigned CVRQualifiers) { 2532 const ObjCInterfaceDecl *ID = 2533 ObjectTy->getAs<ObjCObjectType>()->getInterface(); 2534 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers, 2535 EmitIvarOffset(CGF, ID, Ivar)); 2536 } 2537 2538 static const ObjCInterfaceDecl *FindIvarInterface(ASTContext &Context, 2539 const ObjCInterfaceDecl *OID, 2540 const ObjCIvarDecl *OIVD) { 2541 for (const ObjCIvarDecl *next = OID->all_declared_ivar_begin(); next; 2542 next = next->getNextIvar()) { 2543 if (OIVD == next) 2544 return OID; 2545 } 2546 2547 // Otherwise check in the super class. 2548 if (const ObjCInterfaceDecl *Super = OID->getSuperClass()) 2549 return FindIvarInterface(Context, Super, OIVD); 2550 2551 return 0; 2552 } 2553 2554 llvm::Value *CGObjCGNU::EmitIvarOffset(CodeGenFunction &CGF, 2555 const ObjCInterfaceDecl *Interface, 2556 const ObjCIvarDecl *Ivar) { 2557 if (CGM.getLangOptions().ObjCNonFragileABI) { 2558 Interface = FindIvarInterface(CGM.getContext(), Interface, Ivar); 2559 if (RuntimeVersion < 10) 2560 return CGF.Builder.CreateZExtOrBitCast( 2561 CGF.Builder.CreateLoad(CGF.Builder.CreateLoad( 2562 ObjCIvarOffsetVariable(Interface, Ivar), false, "ivar")), 2563 PtrDiffTy); 2564 std::string name = "__objc_ivar_offset_value_" + 2565 Interface->getNameAsString() +"." + Ivar->getNameAsString(); 2566 llvm::Value *Offset = TheModule.getGlobalVariable(name); 2567 if (!Offset) 2568 Offset = new llvm::GlobalVariable(TheModule, IntTy, 2569 false, llvm::GlobalValue::LinkOnceAnyLinkage, 2570 llvm::Constant::getNullValue(IntTy), name); 2571 return CGF.Builder.CreateLoad(Offset); 2572 } 2573 uint64_t Offset = ComputeIvarBaseOffset(CGF.CGM, Interface, Ivar); 2574 return llvm::ConstantInt::get(PtrDiffTy, Offset, /*isSigned*/true); 2575 } 2576 2577 CGObjCRuntime * 2578 clang::CodeGen::CreateGNUObjCRuntime(CodeGenModule &CGM) { 2579 if (CGM.getLangOptions().ObjCNonFragileABI) 2580 return new CGObjCGNUstep(CGM); 2581 return new CGObjCGCC(CGM); 2582 } 2583