1 //===------- ItaniumCXXABI.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 C++ code generation targeting the Itanium C++ ABI. The class 11 // in this file generates structures that follow the Itanium C++ ABI, which is 12 // documented at: 13 // http://www.codesourcery.com/public/cxx-abi/abi.html 14 // http://www.codesourcery.com/public/cxx-abi/abi-eh.html 15 // 16 // It also supports the closely-related ARM ABI, documented at: 17 // http://infocenter.arm.com/help/topic/com.arm.doc.ihi0041c/IHI0041C_cppabi.pdf 18 // 19 //===----------------------------------------------------------------------===// 20 21 #include "CGCXXABI.h" 22 #include "CGRecordLayout.h" 23 #include "CGVTables.h" 24 #include "CodeGenFunction.h" 25 #include "CodeGenModule.h" 26 #include "clang/AST/Mangle.h" 27 #include "clang/AST/Type.h" 28 #include "llvm/IR/DataLayout.h" 29 #include "llvm/IR/Intrinsics.h" 30 #include "llvm/IR/Value.h" 31 32 using namespace clang; 33 using namespace CodeGen; 34 35 namespace { 36 class ItaniumCXXABI : public CodeGen::CGCXXABI { 37 /// VTables - All the vtables which have been defined. 38 llvm::DenseMap<const CXXRecordDecl *, llvm::GlobalVariable *> VTables; 39 40 protected: 41 bool UseARMMethodPtrABI; 42 bool UseARMGuardVarABI; 43 44 ItaniumMangleContext &getMangleContext() { 45 return cast<ItaniumMangleContext>(CodeGen::CGCXXABI::getMangleContext()); 46 } 47 48 public: 49 ItaniumCXXABI(CodeGen::CodeGenModule &CGM, 50 bool UseARMMethodPtrABI = false, 51 bool UseARMGuardVarABI = false) : 52 CGCXXABI(CGM), UseARMMethodPtrABI(UseARMMethodPtrABI), 53 UseARMGuardVarABI(UseARMGuardVarABI) { } 54 55 bool isReturnTypeIndirect(const CXXRecordDecl *RD) const override { 56 // Structures with either a non-trivial destructor or a non-trivial 57 // copy constructor are always indirect. 58 return !RD->hasTrivialDestructor() || RD->hasNonTrivialCopyConstructor(); 59 } 60 61 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override { 62 // Structures with either a non-trivial destructor or a non-trivial 63 // copy constructor are always indirect. 64 if (!RD->hasTrivialDestructor() || RD->hasNonTrivialCopyConstructor()) 65 return RAA_Indirect; 66 return RAA_Default; 67 } 68 69 bool isZeroInitializable(const MemberPointerType *MPT) override; 70 71 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override; 72 73 llvm::Value * 74 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, 75 const Expr *E, 76 llvm::Value *&This, 77 llvm::Value *MemFnPtr, 78 const MemberPointerType *MPT) override; 79 80 llvm::Value * 81 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E, 82 llvm::Value *Base, 83 llvm::Value *MemPtr, 84 const MemberPointerType *MPT) override; 85 86 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF, 87 const CastExpr *E, 88 llvm::Value *Src) override; 89 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E, 90 llvm::Constant *Src) override; 91 92 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override; 93 94 llvm::Constant *EmitMemberPointer(const CXXMethodDecl *MD) override; 95 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT, 96 CharUnits offset) override; 97 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override; 98 llvm::Constant *BuildMemberPointer(const CXXMethodDecl *MD, 99 CharUnits ThisAdjustment); 100 101 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF, 102 llvm::Value *L, llvm::Value *R, 103 const MemberPointerType *MPT, 104 bool Inequality) override; 105 106 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF, 107 llvm::Value *Addr, 108 const MemberPointerType *MPT) override; 109 110 llvm::Value *adjustToCompleteObject(CodeGenFunction &CGF, llvm::Value *ptr, 111 QualType type) override; 112 113 llvm::Value * 114 GetVirtualBaseClassOffset(CodeGenFunction &CGF, llvm::Value *This, 115 const CXXRecordDecl *ClassDecl, 116 const CXXRecordDecl *BaseClassDecl) override; 117 118 void BuildConstructorSignature(const CXXConstructorDecl *Ctor, 119 CXXCtorType T, CanQualType &ResTy, 120 SmallVectorImpl<CanQualType> &ArgTys) override; 121 122 void EmitCXXConstructors(const CXXConstructorDecl *D) override; 123 124 void BuildDestructorSignature(const CXXDestructorDecl *Dtor, 125 CXXDtorType T, CanQualType &ResTy, 126 SmallVectorImpl<CanQualType> &ArgTys) override; 127 128 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor, 129 CXXDtorType DT) const override { 130 // Itanium does not emit any destructor variant as an inline thunk. 131 // Delegating may occur as an optimization, but all variants are either 132 // emitted with external linkage or as linkonce if they are inline and used. 133 return false; 134 } 135 136 void EmitCXXDestructors(const CXXDestructorDecl *D) override; 137 138 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy, 139 FunctionArgList &Params) override; 140 141 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override; 142 143 unsigned addImplicitConstructorArgs(CodeGenFunction &CGF, 144 const CXXConstructorDecl *D, 145 CXXCtorType Type, bool ForVirtualBase, 146 bool Delegating, 147 CallArgList &Args) override; 148 149 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD, 150 CXXDtorType Type, bool ForVirtualBase, 151 bool Delegating, llvm::Value *This) override; 152 153 void emitVTableDefinitions(CodeGenVTables &CGVT, 154 const CXXRecordDecl *RD) override; 155 156 llvm::Value *getVTableAddressPointInStructor( 157 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, 158 BaseSubobject Base, const CXXRecordDecl *NearestVBase, 159 bool &NeedsVirtualOffset) override; 160 161 llvm::Constant * 162 getVTableAddressPointForConstExpr(BaseSubobject Base, 163 const CXXRecordDecl *VTableClass) override; 164 165 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD, 166 CharUnits VPtrOffset) override; 167 168 llvm::Value *getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD, 169 llvm::Value *This, 170 llvm::Type *Ty) override; 171 172 void EmitVirtualDestructorCall(CodeGenFunction &CGF, 173 const CXXDestructorDecl *Dtor, 174 CXXDtorType DtorType, SourceLocation CallLoc, 175 llvm::Value *This) override; 176 177 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override; 178 179 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable) override { 180 // Allow inlining of thunks by emitting them with available_externally 181 // linkage together with vtables when needed. 182 if (ForVTable) 183 Thunk->setLinkage(llvm::GlobalValue::AvailableExternallyLinkage); 184 } 185 186 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, llvm::Value *This, 187 const ThisAdjustment &TA) override; 188 189 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret, 190 const ReturnAdjustment &RA) override; 191 192 StringRef GetPureVirtualCallName() override { return "__cxa_pure_virtual"; } 193 StringRef GetDeletedVirtualCallName() override 194 { return "__cxa_deleted_virtual"; } 195 196 CharUnits getArrayCookieSizeImpl(QualType elementType) override; 197 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF, 198 llvm::Value *NewPtr, 199 llvm::Value *NumElements, 200 const CXXNewExpr *expr, 201 QualType ElementType) override; 202 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF, 203 llvm::Value *allocPtr, 204 CharUnits cookieSize) override; 205 206 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D, 207 llvm::GlobalVariable *DeclPtr, 208 bool PerformInit) override; 209 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D, 210 llvm::Constant *dtor, llvm::Constant *addr) override; 211 212 llvm::Function *getOrCreateThreadLocalWrapper(const VarDecl *VD, 213 llvm::GlobalVariable *Var); 214 void EmitThreadLocalInitFuncs( 215 llvm::ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *> > Decls, 216 llvm::Function *InitFunc) override; 217 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD, 218 QualType LValType) override; 219 220 bool NeedsVTTParameter(GlobalDecl GD) override; 221 }; 222 223 class ARMCXXABI : public ItaniumCXXABI { 224 public: 225 ARMCXXABI(CodeGen::CodeGenModule &CGM) : 226 ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true, 227 /* UseARMGuardVarABI = */ true) {} 228 229 bool HasThisReturn(GlobalDecl GD) const override { 230 return (isa<CXXConstructorDecl>(GD.getDecl()) || ( 231 isa<CXXDestructorDecl>(GD.getDecl()) && 232 GD.getDtorType() != Dtor_Deleting)); 233 } 234 235 void EmitReturnFromThunk(CodeGenFunction &CGF, RValue RV, 236 QualType ResTy) override; 237 238 CharUnits getArrayCookieSizeImpl(QualType elementType) override; 239 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF, 240 llvm::Value *NewPtr, 241 llvm::Value *NumElements, 242 const CXXNewExpr *expr, 243 QualType ElementType) override; 244 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF, llvm::Value *allocPtr, 245 CharUnits cookieSize) override; 246 }; 247 } 248 249 CodeGen::CGCXXABI *CodeGen::CreateItaniumCXXABI(CodeGenModule &CGM) { 250 switch (CGM.getTarget().getCXXABI().getKind()) { 251 // For IR-generation purposes, there's no significant difference 252 // between the ARM and iOS ABIs. 253 case TargetCXXABI::GenericARM: 254 case TargetCXXABI::iOS: 255 return new ARMCXXABI(CGM); 256 257 // Note that AArch64 uses the generic ItaniumCXXABI class since it doesn't 258 // include the other 32-bit ARM oddities: constructor/destructor return values 259 // and array cookies. 260 case TargetCXXABI::GenericAArch64: 261 return new ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true, 262 /* UseARMGuardVarABI = */ true); 263 264 case TargetCXXABI::GenericItanium: 265 if (CGM.getContext().getTargetInfo().getTriple().getArch() 266 == llvm::Triple::le32) { 267 // For PNaCl, use ARM-style method pointers so that PNaCl code 268 // does not assume anything about the alignment of function 269 // pointers. 270 return new ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true, 271 /* UseARMGuardVarABI = */ false); 272 } 273 return new ItaniumCXXABI(CGM); 274 275 case TargetCXXABI::Microsoft: 276 llvm_unreachable("Microsoft ABI is not Itanium-based"); 277 } 278 llvm_unreachable("bad ABI kind"); 279 } 280 281 llvm::Type * 282 ItaniumCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) { 283 if (MPT->isMemberDataPointer()) 284 return CGM.PtrDiffTy; 285 return llvm::StructType::get(CGM.PtrDiffTy, CGM.PtrDiffTy, NULL); 286 } 287 288 /// In the Itanium and ARM ABIs, method pointers have the form: 289 /// struct { ptrdiff_t ptr; ptrdiff_t adj; } memptr; 290 /// 291 /// In the Itanium ABI: 292 /// - method pointers are virtual if (memptr.ptr & 1) is nonzero 293 /// - the this-adjustment is (memptr.adj) 294 /// - the virtual offset is (memptr.ptr - 1) 295 /// 296 /// In the ARM ABI: 297 /// - method pointers are virtual if (memptr.adj & 1) is nonzero 298 /// - the this-adjustment is (memptr.adj >> 1) 299 /// - the virtual offset is (memptr.ptr) 300 /// ARM uses 'adj' for the virtual flag because Thumb functions 301 /// may be only single-byte aligned. 302 /// 303 /// If the member is virtual, the adjusted 'this' pointer points 304 /// to a vtable pointer from which the virtual offset is applied. 305 /// 306 /// If the member is non-virtual, memptr.ptr is the address of 307 /// the function to call. 308 llvm::Value *ItaniumCXXABI::EmitLoadOfMemberFunctionPointer( 309 CodeGenFunction &CGF, const Expr *E, llvm::Value *&This, 310 llvm::Value *MemFnPtr, const MemberPointerType *MPT) { 311 CGBuilderTy &Builder = CGF.Builder; 312 313 const FunctionProtoType *FPT = 314 MPT->getPointeeType()->getAs<FunctionProtoType>(); 315 const CXXRecordDecl *RD = 316 cast<CXXRecordDecl>(MPT->getClass()->getAs<RecordType>()->getDecl()); 317 318 llvm::FunctionType *FTy = 319 CGM.getTypes().GetFunctionType( 320 CGM.getTypes().arrangeCXXMethodType(RD, FPT)); 321 322 llvm::Constant *ptrdiff_1 = llvm::ConstantInt::get(CGM.PtrDiffTy, 1); 323 324 llvm::BasicBlock *FnVirtual = CGF.createBasicBlock("memptr.virtual"); 325 llvm::BasicBlock *FnNonVirtual = CGF.createBasicBlock("memptr.nonvirtual"); 326 llvm::BasicBlock *FnEnd = CGF.createBasicBlock("memptr.end"); 327 328 // Extract memptr.adj, which is in the second field. 329 llvm::Value *RawAdj = Builder.CreateExtractValue(MemFnPtr, 1, "memptr.adj"); 330 331 // Compute the true adjustment. 332 llvm::Value *Adj = RawAdj; 333 if (UseARMMethodPtrABI) 334 Adj = Builder.CreateAShr(Adj, ptrdiff_1, "memptr.adj.shifted"); 335 336 // Apply the adjustment and cast back to the original struct type 337 // for consistency. 338 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy()); 339 Ptr = Builder.CreateInBoundsGEP(Ptr, Adj); 340 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted"); 341 342 // Load the function pointer. 343 llvm::Value *FnAsInt = Builder.CreateExtractValue(MemFnPtr, 0, "memptr.ptr"); 344 345 // If the LSB in the function pointer is 1, the function pointer points to 346 // a virtual function. 347 llvm::Value *IsVirtual; 348 if (UseARMMethodPtrABI) 349 IsVirtual = Builder.CreateAnd(RawAdj, ptrdiff_1); 350 else 351 IsVirtual = Builder.CreateAnd(FnAsInt, ptrdiff_1); 352 IsVirtual = Builder.CreateIsNotNull(IsVirtual, "memptr.isvirtual"); 353 Builder.CreateCondBr(IsVirtual, FnVirtual, FnNonVirtual); 354 355 // In the virtual path, the adjustment left 'This' pointing to the 356 // vtable of the correct base subobject. The "function pointer" is an 357 // offset within the vtable (+1 for the virtual flag on non-ARM). 358 CGF.EmitBlock(FnVirtual); 359 360 // Cast the adjusted this to a pointer to vtable pointer and load. 361 llvm::Type *VTableTy = Builder.getInt8PtrTy(); 362 llvm::Value *VTable = CGF.GetVTablePtr(This, VTableTy); 363 364 // Apply the offset. 365 llvm::Value *VTableOffset = FnAsInt; 366 if (!UseARMMethodPtrABI) 367 VTableOffset = Builder.CreateSub(VTableOffset, ptrdiff_1); 368 VTable = Builder.CreateGEP(VTable, VTableOffset); 369 370 // Load the virtual function to call. 371 VTable = Builder.CreateBitCast(VTable, FTy->getPointerTo()->getPointerTo()); 372 llvm::Value *VirtualFn = Builder.CreateLoad(VTable, "memptr.virtualfn"); 373 CGF.EmitBranch(FnEnd); 374 375 // In the non-virtual path, the function pointer is actually a 376 // function pointer. 377 CGF.EmitBlock(FnNonVirtual); 378 llvm::Value *NonVirtualFn = 379 Builder.CreateIntToPtr(FnAsInt, FTy->getPointerTo(), "memptr.nonvirtualfn"); 380 381 // We're done. 382 CGF.EmitBlock(FnEnd); 383 llvm::PHINode *Callee = Builder.CreatePHI(FTy->getPointerTo(), 2); 384 Callee->addIncoming(VirtualFn, FnVirtual); 385 Callee->addIncoming(NonVirtualFn, FnNonVirtual); 386 return Callee; 387 } 388 389 /// Compute an l-value by applying the given pointer-to-member to a 390 /// base object. 391 llvm::Value *ItaniumCXXABI::EmitMemberDataPointerAddress( 392 CodeGenFunction &CGF, const Expr *E, llvm::Value *Base, llvm::Value *MemPtr, 393 const MemberPointerType *MPT) { 394 assert(MemPtr->getType() == CGM.PtrDiffTy); 395 396 CGBuilderTy &Builder = CGF.Builder; 397 398 unsigned AS = Base->getType()->getPointerAddressSpace(); 399 400 // Cast to char*. 401 Base = Builder.CreateBitCast(Base, Builder.getInt8Ty()->getPointerTo(AS)); 402 403 // Apply the offset, which we assume is non-null. 404 llvm::Value *Addr = Builder.CreateInBoundsGEP(Base, MemPtr, "memptr.offset"); 405 406 // Cast the address to the appropriate pointer type, adopting the 407 // address space of the base pointer. 408 llvm::Type *PType 409 = CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS); 410 return Builder.CreateBitCast(Addr, PType); 411 } 412 413 /// Perform a bitcast, derived-to-base, or base-to-derived member pointer 414 /// conversion. 415 /// 416 /// Bitcast conversions are always a no-op under Itanium. 417 /// 418 /// Obligatory offset/adjustment diagram: 419 /// <-- offset --> <-- adjustment --> 420 /// |--------------------------|----------------------|--------------------| 421 /// ^Derived address point ^Base address point ^Member address point 422 /// 423 /// So when converting a base member pointer to a derived member pointer, 424 /// we add the offset to the adjustment because the address point has 425 /// decreased; and conversely, when converting a derived MP to a base MP 426 /// we subtract the offset from the adjustment because the address point 427 /// has increased. 428 /// 429 /// The standard forbids (at compile time) conversion to and from 430 /// virtual bases, which is why we don't have to consider them here. 431 /// 432 /// The standard forbids (at run time) casting a derived MP to a base 433 /// MP when the derived MP does not point to a member of the base. 434 /// This is why -1 is a reasonable choice for null data member 435 /// pointers. 436 llvm::Value * 437 ItaniumCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF, 438 const CastExpr *E, 439 llvm::Value *src) { 440 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer || 441 E->getCastKind() == CK_BaseToDerivedMemberPointer || 442 E->getCastKind() == CK_ReinterpretMemberPointer); 443 444 // Under Itanium, reinterprets don't require any additional processing. 445 if (E->getCastKind() == CK_ReinterpretMemberPointer) return src; 446 447 // Use constant emission if we can. 448 if (isa<llvm::Constant>(src)) 449 return EmitMemberPointerConversion(E, cast<llvm::Constant>(src)); 450 451 llvm::Constant *adj = getMemberPointerAdjustment(E); 452 if (!adj) return src; 453 454 CGBuilderTy &Builder = CGF.Builder; 455 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer); 456 457 const MemberPointerType *destTy = 458 E->getType()->castAs<MemberPointerType>(); 459 460 // For member data pointers, this is just a matter of adding the 461 // offset if the source is non-null. 462 if (destTy->isMemberDataPointer()) { 463 llvm::Value *dst; 464 if (isDerivedToBase) 465 dst = Builder.CreateNSWSub(src, adj, "adj"); 466 else 467 dst = Builder.CreateNSWAdd(src, adj, "adj"); 468 469 // Null check. 470 llvm::Value *null = llvm::Constant::getAllOnesValue(src->getType()); 471 llvm::Value *isNull = Builder.CreateICmpEQ(src, null, "memptr.isnull"); 472 return Builder.CreateSelect(isNull, src, dst); 473 } 474 475 // The this-adjustment is left-shifted by 1 on ARM. 476 if (UseARMMethodPtrABI) { 477 uint64_t offset = cast<llvm::ConstantInt>(adj)->getZExtValue(); 478 offset <<= 1; 479 adj = llvm::ConstantInt::get(adj->getType(), offset); 480 } 481 482 llvm::Value *srcAdj = Builder.CreateExtractValue(src, 1, "src.adj"); 483 llvm::Value *dstAdj; 484 if (isDerivedToBase) 485 dstAdj = Builder.CreateNSWSub(srcAdj, adj, "adj"); 486 else 487 dstAdj = Builder.CreateNSWAdd(srcAdj, adj, "adj"); 488 489 return Builder.CreateInsertValue(src, dstAdj, 1); 490 } 491 492 llvm::Constant * 493 ItaniumCXXABI::EmitMemberPointerConversion(const CastExpr *E, 494 llvm::Constant *src) { 495 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer || 496 E->getCastKind() == CK_BaseToDerivedMemberPointer || 497 E->getCastKind() == CK_ReinterpretMemberPointer); 498 499 // Under Itanium, reinterprets don't require any additional processing. 500 if (E->getCastKind() == CK_ReinterpretMemberPointer) return src; 501 502 // If the adjustment is trivial, we don't need to do anything. 503 llvm::Constant *adj = getMemberPointerAdjustment(E); 504 if (!adj) return src; 505 506 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer); 507 508 const MemberPointerType *destTy = 509 E->getType()->castAs<MemberPointerType>(); 510 511 // For member data pointers, this is just a matter of adding the 512 // offset if the source is non-null. 513 if (destTy->isMemberDataPointer()) { 514 // null maps to null. 515 if (src->isAllOnesValue()) return src; 516 517 if (isDerivedToBase) 518 return llvm::ConstantExpr::getNSWSub(src, adj); 519 else 520 return llvm::ConstantExpr::getNSWAdd(src, adj); 521 } 522 523 // The this-adjustment is left-shifted by 1 on ARM. 524 if (UseARMMethodPtrABI) { 525 uint64_t offset = cast<llvm::ConstantInt>(adj)->getZExtValue(); 526 offset <<= 1; 527 adj = llvm::ConstantInt::get(adj->getType(), offset); 528 } 529 530 llvm::Constant *srcAdj = llvm::ConstantExpr::getExtractValue(src, 1); 531 llvm::Constant *dstAdj; 532 if (isDerivedToBase) 533 dstAdj = llvm::ConstantExpr::getNSWSub(srcAdj, adj); 534 else 535 dstAdj = llvm::ConstantExpr::getNSWAdd(srcAdj, adj); 536 537 return llvm::ConstantExpr::getInsertValue(src, dstAdj, 1); 538 } 539 540 llvm::Constant * 541 ItaniumCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) { 542 // Itanium C++ ABI 2.3: 543 // A NULL pointer is represented as -1. 544 if (MPT->isMemberDataPointer()) 545 return llvm::ConstantInt::get(CGM.PtrDiffTy, -1ULL, /*isSigned=*/true); 546 547 llvm::Constant *Zero = llvm::ConstantInt::get(CGM.PtrDiffTy, 0); 548 llvm::Constant *Values[2] = { Zero, Zero }; 549 return llvm::ConstantStruct::getAnon(Values); 550 } 551 552 llvm::Constant * 553 ItaniumCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT, 554 CharUnits offset) { 555 // Itanium C++ ABI 2.3: 556 // A pointer to data member is an offset from the base address of 557 // the class object containing it, represented as a ptrdiff_t 558 return llvm::ConstantInt::get(CGM.PtrDiffTy, offset.getQuantity()); 559 } 560 561 llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const CXXMethodDecl *MD) { 562 return BuildMemberPointer(MD, CharUnits::Zero()); 563 } 564 565 llvm::Constant *ItaniumCXXABI::BuildMemberPointer(const CXXMethodDecl *MD, 566 CharUnits ThisAdjustment) { 567 assert(MD->isInstance() && "Member function must not be static!"); 568 MD = MD->getCanonicalDecl(); 569 570 CodeGenTypes &Types = CGM.getTypes(); 571 572 // Get the function pointer (or index if this is a virtual function). 573 llvm::Constant *MemPtr[2]; 574 if (MD->isVirtual()) { 575 uint64_t Index = CGM.getItaniumVTableContext().getMethodVTableIndex(MD); 576 577 const ASTContext &Context = getContext(); 578 CharUnits PointerWidth = 579 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0)); 580 uint64_t VTableOffset = (Index * PointerWidth.getQuantity()); 581 582 if (UseARMMethodPtrABI) { 583 // ARM C++ ABI 3.2.1: 584 // This ABI specifies that adj contains twice the this 585 // adjustment, plus 1 if the member function is virtual. The 586 // least significant bit of adj then makes exactly the same 587 // discrimination as the least significant bit of ptr does for 588 // Itanium. 589 MemPtr[0] = llvm::ConstantInt::get(CGM.PtrDiffTy, VTableOffset); 590 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy, 591 2 * ThisAdjustment.getQuantity() + 1); 592 } else { 593 // Itanium C++ ABI 2.3: 594 // For a virtual function, [the pointer field] is 1 plus the 595 // virtual table offset (in bytes) of the function, 596 // represented as a ptrdiff_t. 597 MemPtr[0] = llvm::ConstantInt::get(CGM.PtrDiffTy, VTableOffset + 1); 598 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy, 599 ThisAdjustment.getQuantity()); 600 } 601 } else { 602 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>(); 603 llvm::Type *Ty; 604 // Check whether the function has a computable LLVM signature. 605 if (Types.isFuncTypeConvertible(FPT)) { 606 // The function has a computable LLVM signature; use the correct type. 607 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD)); 608 } else { 609 // Use an arbitrary non-function type to tell GetAddrOfFunction that the 610 // function type is incomplete. 611 Ty = CGM.PtrDiffTy; 612 } 613 llvm::Constant *addr = CGM.GetAddrOfFunction(MD, Ty); 614 615 MemPtr[0] = llvm::ConstantExpr::getPtrToInt(addr, CGM.PtrDiffTy); 616 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy, 617 (UseARMMethodPtrABI ? 2 : 1) * 618 ThisAdjustment.getQuantity()); 619 } 620 621 return llvm::ConstantStruct::getAnon(MemPtr); 622 } 623 624 llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const APValue &MP, 625 QualType MPType) { 626 const MemberPointerType *MPT = MPType->castAs<MemberPointerType>(); 627 const ValueDecl *MPD = MP.getMemberPointerDecl(); 628 if (!MPD) 629 return EmitNullMemberPointer(MPT); 630 631 CharUnits ThisAdjustment = getMemberPointerPathAdjustment(MP); 632 633 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) 634 return BuildMemberPointer(MD, ThisAdjustment); 635 636 CharUnits FieldOffset = 637 getContext().toCharUnitsFromBits(getContext().getFieldOffset(MPD)); 638 return EmitMemberDataPointer(MPT, ThisAdjustment + FieldOffset); 639 } 640 641 /// The comparison algorithm is pretty easy: the member pointers are 642 /// the same if they're either bitwise identical *or* both null. 643 /// 644 /// ARM is different here only because null-ness is more complicated. 645 llvm::Value * 646 ItaniumCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF, 647 llvm::Value *L, 648 llvm::Value *R, 649 const MemberPointerType *MPT, 650 bool Inequality) { 651 CGBuilderTy &Builder = CGF.Builder; 652 653 llvm::ICmpInst::Predicate Eq; 654 llvm::Instruction::BinaryOps And, Or; 655 if (Inequality) { 656 Eq = llvm::ICmpInst::ICMP_NE; 657 And = llvm::Instruction::Or; 658 Or = llvm::Instruction::And; 659 } else { 660 Eq = llvm::ICmpInst::ICMP_EQ; 661 And = llvm::Instruction::And; 662 Or = llvm::Instruction::Or; 663 } 664 665 // Member data pointers are easy because there's a unique null 666 // value, so it just comes down to bitwise equality. 667 if (MPT->isMemberDataPointer()) 668 return Builder.CreateICmp(Eq, L, R); 669 670 // For member function pointers, the tautologies are more complex. 671 // The Itanium tautology is: 672 // (L == R) <==> (L.ptr == R.ptr && (L.ptr == 0 || L.adj == R.adj)) 673 // The ARM tautology is: 674 // (L == R) <==> (L.ptr == R.ptr && 675 // (L.adj == R.adj || 676 // (L.ptr == 0 && ((L.adj|R.adj) & 1) == 0))) 677 // The inequality tautologies have exactly the same structure, except 678 // applying De Morgan's laws. 679 680 llvm::Value *LPtr = Builder.CreateExtractValue(L, 0, "lhs.memptr.ptr"); 681 llvm::Value *RPtr = Builder.CreateExtractValue(R, 0, "rhs.memptr.ptr"); 682 683 // This condition tests whether L.ptr == R.ptr. This must always be 684 // true for equality to hold. 685 llvm::Value *PtrEq = Builder.CreateICmp(Eq, LPtr, RPtr, "cmp.ptr"); 686 687 // This condition, together with the assumption that L.ptr == R.ptr, 688 // tests whether the pointers are both null. ARM imposes an extra 689 // condition. 690 llvm::Value *Zero = llvm::Constant::getNullValue(LPtr->getType()); 691 llvm::Value *EqZero = Builder.CreateICmp(Eq, LPtr, Zero, "cmp.ptr.null"); 692 693 // This condition tests whether L.adj == R.adj. If this isn't 694 // true, the pointers are unequal unless they're both null. 695 llvm::Value *LAdj = Builder.CreateExtractValue(L, 1, "lhs.memptr.adj"); 696 llvm::Value *RAdj = Builder.CreateExtractValue(R, 1, "rhs.memptr.adj"); 697 llvm::Value *AdjEq = Builder.CreateICmp(Eq, LAdj, RAdj, "cmp.adj"); 698 699 // Null member function pointers on ARM clear the low bit of Adj, 700 // so the zero condition has to check that neither low bit is set. 701 if (UseARMMethodPtrABI) { 702 llvm::Value *One = llvm::ConstantInt::get(LPtr->getType(), 1); 703 704 // Compute (l.adj | r.adj) & 1 and test it against zero. 705 llvm::Value *OrAdj = Builder.CreateOr(LAdj, RAdj, "or.adj"); 706 llvm::Value *OrAdjAnd1 = Builder.CreateAnd(OrAdj, One); 707 llvm::Value *OrAdjAnd1EqZero = Builder.CreateICmp(Eq, OrAdjAnd1, Zero, 708 "cmp.or.adj"); 709 EqZero = Builder.CreateBinOp(And, EqZero, OrAdjAnd1EqZero); 710 } 711 712 // Tie together all our conditions. 713 llvm::Value *Result = Builder.CreateBinOp(Or, EqZero, AdjEq); 714 Result = Builder.CreateBinOp(And, PtrEq, Result, 715 Inequality ? "memptr.ne" : "memptr.eq"); 716 return Result; 717 } 718 719 llvm::Value * 720 ItaniumCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF, 721 llvm::Value *MemPtr, 722 const MemberPointerType *MPT) { 723 CGBuilderTy &Builder = CGF.Builder; 724 725 /// For member data pointers, this is just a check against -1. 726 if (MPT->isMemberDataPointer()) { 727 assert(MemPtr->getType() == CGM.PtrDiffTy); 728 llvm::Value *NegativeOne = 729 llvm::Constant::getAllOnesValue(MemPtr->getType()); 730 return Builder.CreateICmpNE(MemPtr, NegativeOne, "memptr.tobool"); 731 } 732 733 // In Itanium, a member function pointer is not null if 'ptr' is not null. 734 llvm::Value *Ptr = Builder.CreateExtractValue(MemPtr, 0, "memptr.ptr"); 735 736 llvm::Constant *Zero = llvm::ConstantInt::get(Ptr->getType(), 0); 737 llvm::Value *Result = Builder.CreateICmpNE(Ptr, Zero, "memptr.tobool"); 738 739 // On ARM, a member function pointer is also non-null if the low bit of 'adj' 740 // (the virtual bit) is set. 741 if (UseARMMethodPtrABI) { 742 llvm::Constant *One = llvm::ConstantInt::get(Ptr->getType(), 1); 743 llvm::Value *Adj = Builder.CreateExtractValue(MemPtr, 1, "memptr.adj"); 744 llvm::Value *VirtualBit = Builder.CreateAnd(Adj, One, "memptr.virtualbit"); 745 llvm::Value *IsVirtual = Builder.CreateICmpNE(VirtualBit, Zero, 746 "memptr.isvirtual"); 747 Result = Builder.CreateOr(Result, IsVirtual); 748 } 749 750 return Result; 751 } 752 753 /// The Itanium ABI requires non-zero initialization only for data 754 /// member pointers, for which '0' is a valid offset. 755 bool ItaniumCXXABI::isZeroInitializable(const MemberPointerType *MPT) { 756 return MPT->getPointeeType()->isFunctionType(); 757 } 758 759 /// The Itanium ABI always places an offset to the complete object 760 /// at entry -2 in the vtable. 761 llvm::Value *ItaniumCXXABI::adjustToCompleteObject(CodeGenFunction &CGF, 762 llvm::Value *ptr, 763 QualType type) { 764 // Grab the vtable pointer as an intptr_t*. 765 llvm::Value *vtable = CGF.GetVTablePtr(ptr, CGF.IntPtrTy->getPointerTo()); 766 767 // Track back to entry -2 and pull out the offset there. 768 llvm::Value *offsetPtr = 769 CGF.Builder.CreateConstInBoundsGEP1_64(vtable, -2, "complete-offset.ptr"); 770 llvm::LoadInst *offset = CGF.Builder.CreateLoad(offsetPtr); 771 offset->setAlignment(CGF.PointerAlignInBytes); 772 773 // Apply the offset. 774 ptr = CGF.Builder.CreateBitCast(ptr, CGF.Int8PtrTy); 775 return CGF.Builder.CreateInBoundsGEP(ptr, offset); 776 } 777 778 llvm::Value * 779 ItaniumCXXABI::GetVirtualBaseClassOffset(CodeGenFunction &CGF, 780 llvm::Value *This, 781 const CXXRecordDecl *ClassDecl, 782 const CXXRecordDecl *BaseClassDecl) { 783 llvm::Value *VTablePtr = CGF.GetVTablePtr(This, CGM.Int8PtrTy); 784 CharUnits VBaseOffsetOffset = 785 CGM.getItaniumVTableContext().getVirtualBaseOffsetOffset(ClassDecl, 786 BaseClassDecl); 787 788 llvm::Value *VBaseOffsetPtr = 789 CGF.Builder.CreateConstGEP1_64(VTablePtr, VBaseOffsetOffset.getQuantity(), 790 "vbase.offset.ptr"); 791 VBaseOffsetPtr = CGF.Builder.CreateBitCast(VBaseOffsetPtr, 792 CGM.PtrDiffTy->getPointerTo()); 793 794 llvm::Value *VBaseOffset = 795 CGF.Builder.CreateLoad(VBaseOffsetPtr, "vbase.offset"); 796 797 return VBaseOffset; 798 } 799 800 /// The generic ABI passes 'this', plus a VTT if it's initializing a 801 /// base subobject. 802 void 803 ItaniumCXXABI::BuildConstructorSignature(const CXXConstructorDecl *Ctor, 804 CXXCtorType Type, CanQualType &ResTy, 805 SmallVectorImpl<CanQualType> &ArgTys) { 806 ASTContext &Context = getContext(); 807 808 // All parameters are already in place except VTT, which goes after 'this'. 809 // These are Clang types, so we don't need to worry about sret yet. 810 811 // Check if we need to add a VTT parameter (which has type void **). 812 if (Type == Ctor_Base && Ctor->getParent()->getNumVBases() != 0) 813 ArgTys.insert(ArgTys.begin() + 1, 814 Context.getPointerType(Context.VoidPtrTy)); 815 } 816 817 void ItaniumCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) { 818 // Just make sure we're in sync with TargetCXXABI. 819 assert(CGM.getTarget().getCXXABI().hasConstructorVariants()); 820 821 // The constructor used for constructing this as a base class; 822 // ignores virtual bases. 823 CGM.EmitGlobal(GlobalDecl(D, Ctor_Base)); 824 825 // The constructor used for constructing this as a complete class; 826 // constucts the virtual bases, then calls the base constructor. 827 if (!D->getParent()->isAbstract()) { 828 // We don't need to emit the complete ctor if the class is abstract. 829 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete)); 830 } 831 } 832 833 /// The generic ABI passes 'this', plus a VTT if it's destroying a 834 /// base subobject. 835 void ItaniumCXXABI::BuildDestructorSignature(const CXXDestructorDecl *Dtor, 836 CXXDtorType Type, 837 CanQualType &ResTy, 838 SmallVectorImpl<CanQualType> &ArgTys) { 839 ASTContext &Context = getContext(); 840 841 // 'this' parameter is already there, as well as 'this' return if 842 // HasThisReturn(GlobalDecl(Dtor, Type)) is true 843 844 // Check if we need to add a VTT parameter (which has type void **). 845 if (Type == Dtor_Base && Dtor->getParent()->getNumVBases() != 0) 846 ArgTys.push_back(Context.getPointerType(Context.VoidPtrTy)); 847 } 848 849 void ItaniumCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) { 850 // The destructor used for destructing this as a base class; ignores 851 // virtual bases. 852 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base)); 853 854 // The destructor used for destructing this as a most-derived class; 855 // call the base destructor and then destructs any virtual bases. 856 CGM.EmitGlobal(GlobalDecl(D, Dtor_Complete)); 857 858 // The destructor in a virtual table is always a 'deleting' 859 // destructor, which calls the complete destructor and then uses the 860 // appropriate operator delete. 861 if (D->isVirtual()) 862 CGM.EmitGlobal(GlobalDecl(D, Dtor_Deleting)); 863 } 864 865 void ItaniumCXXABI::addImplicitStructorParams(CodeGenFunction &CGF, 866 QualType &ResTy, 867 FunctionArgList &Params) { 868 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl()); 869 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)); 870 871 // Check if we need a VTT parameter as well. 872 if (NeedsVTTParameter(CGF.CurGD)) { 873 ASTContext &Context = getContext(); 874 875 // FIXME: avoid the fake decl 876 QualType T = Context.getPointerType(Context.VoidPtrTy); 877 ImplicitParamDecl *VTTDecl 878 = ImplicitParamDecl::Create(Context, 0, MD->getLocation(), 879 &Context.Idents.get("vtt"), T); 880 Params.insert(Params.begin() + 1, VTTDecl); 881 getStructorImplicitParamDecl(CGF) = VTTDecl; 882 } 883 } 884 885 void ItaniumCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) { 886 /// Initialize the 'this' slot. 887 EmitThisParam(CGF); 888 889 /// Initialize the 'vtt' slot if needed. 890 if (getStructorImplicitParamDecl(CGF)) { 891 getStructorImplicitParamValue(CGF) = CGF.Builder.CreateLoad( 892 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)), "vtt"); 893 } 894 895 /// If this is a function that the ABI specifies returns 'this', initialize 896 /// the return slot to 'this' at the start of the function. 897 /// 898 /// Unlike the setting of return types, this is done within the ABI 899 /// implementation instead of by clients of CGCXXABI because: 900 /// 1) getThisValue is currently protected 901 /// 2) in theory, an ABI could implement 'this' returns some other way; 902 /// HasThisReturn only specifies a contract, not the implementation 903 if (HasThisReturn(CGF.CurGD)) 904 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue); 905 } 906 907 unsigned ItaniumCXXABI::addImplicitConstructorArgs( 908 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type, 909 bool ForVirtualBase, bool Delegating, CallArgList &Args) { 910 if (!NeedsVTTParameter(GlobalDecl(D, Type))) 911 return 0; 912 913 // Insert the implicit 'vtt' argument as the second argument. 914 llvm::Value *VTT = 915 CGF.GetVTTParameter(GlobalDecl(D, Type), ForVirtualBase, Delegating); 916 QualType VTTTy = getContext().getPointerType(getContext().VoidPtrTy); 917 Args.insert(Args.begin() + 1, 918 CallArg(RValue::get(VTT), VTTTy, /*needscopy=*/false)); 919 return 1; // Added one arg. 920 } 921 922 void ItaniumCXXABI::EmitDestructorCall(CodeGenFunction &CGF, 923 const CXXDestructorDecl *DD, 924 CXXDtorType Type, bool ForVirtualBase, 925 bool Delegating, llvm::Value *This) { 926 GlobalDecl GD(DD, Type); 927 llvm::Value *VTT = CGF.GetVTTParameter(GD, ForVirtualBase, Delegating); 928 QualType VTTTy = getContext().getPointerType(getContext().VoidPtrTy); 929 930 llvm::Value *Callee = 0; 931 if (getContext().getLangOpts().AppleKext) 932 Callee = CGF.BuildAppleKextVirtualDestructorCall(DD, Type, DD->getParent()); 933 934 if (!Callee) 935 Callee = CGM.GetAddrOfCXXDestructor(DD, Type); 936 937 // FIXME: Provide a source location here. 938 CGF.EmitCXXMemberCall(DD, SourceLocation(), Callee, ReturnValueSlot(), This, 939 VTT, VTTTy, 0, 0); 940 } 941 942 void ItaniumCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT, 943 const CXXRecordDecl *RD) { 944 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, CharUnits()); 945 if (VTable->hasInitializer()) 946 return; 947 948 ItaniumVTableContext &VTContext = CGM.getItaniumVTableContext(); 949 const VTableLayout &VTLayout = VTContext.getVTableLayout(RD); 950 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD); 951 952 // Create and set the initializer. 953 llvm::Constant *Init = CGVT.CreateVTableInitializer( 954 RD, VTLayout.vtable_component_begin(), VTLayout.getNumVTableComponents(), 955 VTLayout.vtable_thunk_begin(), VTLayout.getNumVTableThunks()); 956 VTable->setInitializer(Init); 957 958 // Set the correct linkage. 959 VTable->setLinkage(Linkage); 960 961 // Set the right visibility. 962 CGM.setGlobalVisibility(VTable, RD); 963 964 // If this is the magic class __cxxabiv1::__fundamental_type_info, 965 // we will emit the typeinfo for the fundamental types. This is the 966 // same behaviour as GCC. 967 const DeclContext *DC = RD->getDeclContext(); 968 if (RD->getIdentifier() && 969 RD->getIdentifier()->isStr("__fundamental_type_info") && 970 isa<NamespaceDecl>(DC) && cast<NamespaceDecl>(DC)->getIdentifier() && 971 cast<NamespaceDecl>(DC)->getIdentifier()->isStr("__cxxabiv1") && 972 DC->getParent()->isTranslationUnit()) 973 CGM.EmitFundamentalRTTIDescriptors(); 974 } 975 976 llvm::Value *ItaniumCXXABI::getVTableAddressPointInStructor( 977 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base, 978 const CXXRecordDecl *NearestVBase, bool &NeedsVirtualOffset) { 979 bool NeedsVTTParam = CGM.getCXXABI().NeedsVTTParameter(CGF.CurGD); 980 NeedsVirtualOffset = (NeedsVTTParam && NearestVBase); 981 982 llvm::Value *VTableAddressPoint; 983 if (NeedsVTTParam && (Base.getBase()->getNumVBases() || NearestVBase)) { 984 // Get the secondary vpointer index. 985 uint64_t VirtualPointerIndex = 986 CGM.getVTables().getSecondaryVirtualPointerIndex(VTableClass, Base); 987 988 /// Load the VTT. 989 llvm::Value *VTT = CGF.LoadCXXVTT(); 990 if (VirtualPointerIndex) 991 VTT = CGF.Builder.CreateConstInBoundsGEP1_64(VTT, VirtualPointerIndex); 992 993 // And load the address point from the VTT. 994 VTableAddressPoint = CGF.Builder.CreateLoad(VTT); 995 } else { 996 llvm::Constant *VTable = 997 CGM.getCXXABI().getAddrOfVTable(VTableClass, CharUnits()); 998 uint64_t AddressPoint = CGM.getItaniumVTableContext() 999 .getVTableLayout(VTableClass) 1000 .getAddressPoint(Base); 1001 VTableAddressPoint = 1002 CGF.Builder.CreateConstInBoundsGEP2_64(VTable, 0, AddressPoint); 1003 } 1004 1005 return VTableAddressPoint; 1006 } 1007 1008 llvm::Constant *ItaniumCXXABI::getVTableAddressPointForConstExpr( 1009 BaseSubobject Base, const CXXRecordDecl *VTableClass) { 1010 llvm::Constant *VTable = getAddrOfVTable(VTableClass, CharUnits()); 1011 1012 // Find the appropriate vtable within the vtable group. 1013 uint64_t AddressPoint = CGM.getItaniumVTableContext() 1014 .getVTableLayout(VTableClass) 1015 .getAddressPoint(Base); 1016 llvm::Value *Indices[] = { 1017 llvm::ConstantInt::get(CGM.Int64Ty, 0), 1018 llvm::ConstantInt::get(CGM.Int64Ty, AddressPoint) 1019 }; 1020 1021 return llvm::ConstantExpr::getInBoundsGetElementPtr(VTable, Indices); 1022 } 1023 1024 llvm::GlobalVariable *ItaniumCXXABI::getAddrOfVTable(const CXXRecordDecl *RD, 1025 CharUnits VPtrOffset) { 1026 assert(VPtrOffset.isZero() && "Itanium ABI only supports zero vptr offsets"); 1027 1028 llvm::GlobalVariable *&VTable = VTables[RD]; 1029 if (VTable) 1030 return VTable; 1031 1032 // Queue up this v-table for possible deferred emission. 1033 CGM.addDeferredVTable(RD); 1034 1035 SmallString<256> OutName; 1036 llvm::raw_svector_ostream Out(OutName); 1037 getMangleContext().mangleCXXVTable(RD, Out); 1038 Out.flush(); 1039 StringRef Name = OutName.str(); 1040 1041 ItaniumVTableContext &VTContext = CGM.getItaniumVTableContext(); 1042 llvm::ArrayType *ArrayType = llvm::ArrayType::get( 1043 CGM.Int8PtrTy, VTContext.getVTableLayout(RD).getNumVTableComponents()); 1044 1045 VTable = CGM.CreateOrReplaceCXXRuntimeVariable( 1046 Name, ArrayType, llvm::GlobalValue::ExternalLinkage); 1047 VTable->setUnnamedAddr(true); 1048 return VTable; 1049 } 1050 1051 llvm::Value *ItaniumCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF, 1052 GlobalDecl GD, 1053 llvm::Value *This, 1054 llvm::Type *Ty) { 1055 GD = GD.getCanonicalDecl(); 1056 Ty = Ty->getPointerTo()->getPointerTo(); 1057 llvm::Value *VTable = CGF.GetVTablePtr(This, Ty); 1058 1059 uint64_t VTableIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(GD); 1060 llvm::Value *VFuncPtr = 1061 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, VTableIndex, "vfn"); 1062 return CGF.Builder.CreateLoad(VFuncPtr); 1063 } 1064 1065 void ItaniumCXXABI::EmitVirtualDestructorCall(CodeGenFunction &CGF, 1066 const CXXDestructorDecl *Dtor, 1067 CXXDtorType DtorType, 1068 SourceLocation CallLoc, 1069 llvm::Value *This) { 1070 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete); 1071 1072 const CGFunctionInfo *FInfo 1073 = &CGM.getTypes().arrangeCXXDestructor(Dtor, DtorType); 1074 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo); 1075 llvm::Value *Callee = 1076 getVirtualFunctionPointer(CGF, GlobalDecl(Dtor, DtorType), This, Ty); 1077 1078 CGF.EmitCXXMemberCall(Dtor, CallLoc, Callee, ReturnValueSlot(), This, 1079 /*ImplicitParam=*/0, QualType(), 0, 0); 1080 } 1081 1082 void ItaniumCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) { 1083 CodeGenVTables &VTables = CGM.getVTables(); 1084 llvm::GlobalVariable *VTT = VTables.GetAddrOfVTT(RD); 1085 VTables.EmitVTTDefinition(VTT, CGM.getVTableLinkage(RD), RD); 1086 } 1087 1088 static llvm::Value *performTypeAdjustment(CodeGenFunction &CGF, 1089 llvm::Value *Ptr, 1090 int64_t NonVirtualAdjustment, 1091 int64_t VirtualAdjustment, 1092 bool IsReturnAdjustment) { 1093 if (!NonVirtualAdjustment && !VirtualAdjustment) 1094 return Ptr; 1095 1096 llvm::Type *Int8PtrTy = CGF.Int8PtrTy; 1097 llvm::Value *V = CGF.Builder.CreateBitCast(Ptr, Int8PtrTy); 1098 1099 if (NonVirtualAdjustment && !IsReturnAdjustment) { 1100 // Perform the non-virtual adjustment for a base-to-derived cast. 1101 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment); 1102 } 1103 1104 if (VirtualAdjustment) { 1105 llvm::Type *PtrDiffTy = 1106 CGF.ConvertType(CGF.getContext().getPointerDiffType()); 1107 1108 // Perform the virtual adjustment. 1109 llvm::Value *VTablePtrPtr = 1110 CGF.Builder.CreateBitCast(V, Int8PtrTy->getPointerTo()); 1111 1112 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr); 1113 1114 llvm::Value *OffsetPtr = 1115 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment); 1116 1117 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo()); 1118 1119 // Load the adjustment offset from the vtable. 1120 llvm::Value *Offset = CGF.Builder.CreateLoad(OffsetPtr); 1121 1122 // Adjust our pointer. 1123 V = CGF.Builder.CreateInBoundsGEP(V, Offset); 1124 } 1125 1126 if (NonVirtualAdjustment && IsReturnAdjustment) { 1127 // Perform the non-virtual adjustment for a derived-to-base cast. 1128 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment); 1129 } 1130 1131 // Cast back to the original type. 1132 return CGF.Builder.CreateBitCast(V, Ptr->getType()); 1133 } 1134 1135 llvm::Value *ItaniumCXXABI::performThisAdjustment(CodeGenFunction &CGF, 1136 llvm::Value *This, 1137 const ThisAdjustment &TA) { 1138 return performTypeAdjustment(CGF, This, TA.NonVirtual, 1139 TA.Virtual.Itanium.VCallOffsetOffset, 1140 /*IsReturnAdjustment=*/false); 1141 } 1142 1143 llvm::Value * 1144 ItaniumCXXABI::performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret, 1145 const ReturnAdjustment &RA) { 1146 return performTypeAdjustment(CGF, Ret, RA.NonVirtual, 1147 RA.Virtual.Itanium.VBaseOffsetOffset, 1148 /*IsReturnAdjustment=*/true); 1149 } 1150 1151 void ARMCXXABI::EmitReturnFromThunk(CodeGenFunction &CGF, 1152 RValue RV, QualType ResultType) { 1153 if (!isa<CXXDestructorDecl>(CGF.CurGD.getDecl())) 1154 return ItaniumCXXABI::EmitReturnFromThunk(CGF, RV, ResultType); 1155 1156 // Destructor thunks in the ARM ABI have indeterminate results. 1157 llvm::Type *T = 1158 cast<llvm::PointerType>(CGF.ReturnValue->getType())->getElementType(); 1159 RValue Undef = RValue::get(llvm::UndefValue::get(T)); 1160 return ItaniumCXXABI::EmitReturnFromThunk(CGF, Undef, ResultType); 1161 } 1162 1163 /************************** Array allocation cookies **************************/ 1164 1165 CharUnits ItaniumCXXABI::getArrayCookieSizeImpl(QualType elementType) { 1166 // The array cookie is a size_t; pad that up to the element alignment. 1167 // The cookie is actually right-justified in that space. 1168 return std::max(CharUnits::fromQuantity(CGM.SizeSizeInBytes), 1169 CGM.getContext().getTypeAlignInChars(elementType)); 1170 } 1171 1172 llvm::Value *ItaniumCXXABI::InitializeArrayCookie(CodeGenFunction &CGF, 1173 llvm::Value *NewPtr, 1174 llvm::Value *NumElements, 1175 const CXXNewExpr *expr, 1176 QualType ElementType) { 1177 assert(requiresArrayCookie(expr)); 1178 1179 unsigned AS = NewPtr->getType()->getPointerAddressSpace(); 1180 1181 ASTContext &Ctx = getContext(); 1182 QualType SizeTy = Ctx.getSizeType(); 1183 CharUnits SizeSize = Ctx.getTypeSizeInChars(SizeTy); 1184 1185 // The size of the cookie. 1186 CharUnits CookieSize = 1187 std::max(SizeSize, Ctx.getTypeAlignInChars(ElementType)); 1188 assert(CookieSize == getArrayCookieSizeImpl(ElementType)); 1189 1190 // Compute an offset to the cookie. 1191 llvm::Value *CookiePtr = NewPtr; 1192 CharUnits CookieOffset = CookieSize - SizeSize; 1193 if (!CookieOffset.isZero()) 1194 CookiePtr = CGF.Builder.CreateConstInBoundsGEP1_64(CookiePtr, 1195 CookieOffset.getQuantity()); 1196 1197 // Write the number of elements into the appropriate slot. 1198 llvm::Value *NumElementsPtr 1199 = CGF.Builder.CreateBitCast(CookiePtr, 1200 CGF.ConvertType(SizeTy)->getPointerTo(AS)); 1201 CGF.Builder.CreateStore(NumElements, NumElementsPtr); 1202 1203 // Finally, compute a pointer to the actual data buffer by skipping 1204 // over the cookie completely. 1205 return CGF.Builder.CreateConstInBoundsGEP1_64(NewPtr, 1206 CookieSize.getQuantity()); 1207 } 1208 1209 llvm::Value *ItaniumCXXABI::readArrayCookieImpl(CodeGenFunction &CGF, 1210 llvm::Value *allocPtr, 1211 CharUnits cookieSize) { 1212 // The element size is right-justified in the cookie. 1213 llvm::Value *numElementsPtr = allocPtr; 1214 CharUnits numElementsOffset = 1215 cookieSize - CharUnits::fromQuantity(CGF.SizeSizeInBytes); 1216 if (!numElementsOffset.isZero()) 1217 numElementsPtr = 1218 CGF.Builder.CreateConstInBoundsGEP1_64(numElementsPtr, 1219 numElementsOffset.getQuantity()); 1220 1221 unsigned AS = allocPtr->getType()->getPointerAddressSpace(); 1222 numElementsPtr = 1223 CGF.Builder.CreateBitCast(numElementsPtr, CGF.SizeTy->getPointerTo(AS)); 1224 return CGF.Builder.CreateLoad(numElementsPtr); 1225 } 1226 1227 CharUnits ARMCXXABI::getArrayCookieSizeImpl(QualType elementType) { 1228 // ARM says that the cookie is always: 1229 // struct array_cookie { 1230 // std::size_t element_size; // element_size != 0 1231 // std::size_t element_count; 1232 // }; 1233 // But the base ABI doesn't give anything an alignment greater than 1234 // 8, so we can dismiss this as typical ABI-author blindness to 1235 // actual language complexity and round up to the element alignment. 1236 return std::max(CharUnits::fromQuantity(2 * CGM.SizeSizeInBytes), 1237 CGM.getContext().getTypeAlignInChars(elementType)); 1238 } 1239 1240 llvm::Value *ARMCXXABI::InitializeArrayCookie(CodeGenFunction &CGF, 1241 llvm::Value *newPtr, 1242 llvm::Value *numElements, 1243 const CXXNewExpr *expr, 1244 QualType elementType) { 1245 assert(requiresArrayCookie(expr)); 1246 1247 // NewPtr is a char*, but we generalize to arbitrary addrspaces. 1248 unsigned AS = newPtr->getType()->getPointerAddressSpace(); 1249 1250 // The cookie is always at the start of the buffer. 1251 llvm::Value *cookie = newPtr; 1252 1253 // The first element is the element size. 1254 cookie = CGF.Builder.CreateBitCast(cookie, CGF.SizeTy->getPointerTo(AS)); 1255 llvm::Value *elementSize = llvm::ConstantInt::get(CGF.SizeTy, 1256 getContext().getTypeSizeInChars(elementType).getQuantity()); 1257 CGF.Builder.CreateStore(elementSize, cookie); 1258 1259 // The second element is the element count. 1260 cookie = CGF.Builder.CreateConstInBoundsGEP1_32(cookie, 1); 1261 CGF.Builder.CreateStore(numElements, cookie); 1262 1263 // Finally, compute a pointer to the actual data buffer by skipping 1264 // over the cookie completely. 1265 CharUnits cookieSize = ARMCXXABI::getArrayCookieSizeImpl(elementType); 1266 return CGF.Builder.CreateConstInBoundsGEP1_64(newPtr, 1267 cookieSize.getQuantity()); 1268 } 1269 1270 llvm::Value *ARMCXXABI::readArrayCookieImpl(CodeGenFunction &CGF, 1271 llvm::Value *allocPtr, 1272 CharUnits cookieSize) { 1273 // The number of elements is at offset sizeof(size_t) relative to 1274 // the allocated pointer. 1275 llvm::Value *numElementsPtr 1276 = CGF.Builder.CreateConstInBoundsGEP1_64(allocPtr, CGF.SizeSizeInBytes); 1277 1278 unsigned AS = allocPtr->getType()->getPointerAddressSpace(); 1279 numElementsPtr = 1280 CGF.Builder.CreateBitCast(numElementsPtr, CGF.SizeTy->getPointerTo(AS)); 1281 return CGF.Builder.CreateLoad(numElementsPtr); 1282 } 1283 1284 /*********************** Static local initialization **************************/ 1285 1286 static llvm::Constant *getGuardAcquireFn(CodeGenModule &CGM, 1287 llvm::PointerType *GuardPtrTy) { 1288 // int __cxa_guard_acquire(__guard *guard_object); 1289 llvm::FunctionType *FTy = 1290 llvm::FunctionType::get(CGM.getTypes().ConvertType(CGM.getContext().IntTy), 1291 GuardPtrTy, /*isVarArg=*/false); 1292 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_acquire", 1293 llvm::AttributeSet::get(CGM.getLLVMContext(), 1294 llvm::AttributeSet::FunctionIndex, 1295 llvm::Attribute::NoUnwind)); 1296 } 1297 1298 static llvm::Constant *getGuardReleaseFn(CodeGenModule &CGM, 1299 llvm::PointerType *GuardPtrTy) { 1300 // void __cxa_guard_release(__guard *guard_object); 1301 llvm::FunctionType *FTy = 1302 llvm::FunctionType::get(CGM.VoidTy, GuardPtrTy, /*isVarArg=*/false); 1303 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_release", 1304 llvm::AttributeSet::get(CGM.getLLVMContext(), 1305 llvm::AttributeSet::FunctionIndex, 1306 llvm::Attribute::NoUnwind)); 1307 } 1308 1309 static llvm::Constant *getGuardAbortFn(CodeGenModule &CGM, 1310 llvm::PointerType *GuardPtrTy) { 1311 // void __cxa_guard_abort(__guard *guard_object); 1312 llvm::FunctionType *FTy = 1313 llvm::FunctionType::get(CGM.VoidTy, GuardPtrTy, /*isVarArg=*/false); 1314 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_abort", 1315 llvm::AttributeSet::get(CGM.getLLVMContext(), 1316 llvm::AttributeSet::FunctionIndex, 1317 llvm::Attribute::NoUnwind)); 1318 } 1319 1320 namespace { 1321 struct CallGuardAbort : EHScopeStack::Cleanup { 1322 llvm::GlobalVariable *Guard; 1323 CallGuardAbort(llvm::GlobalVariable *Guard) : Guard(Guard) {} 1324 1325 void Emit(CodeGenFunction &CGF, Flags flags) override { 1326 CGF.EmitNounwindRuntimeCall(getGuardAbortFn(CGF.CGM, Guard->getType()), 1327 Guard); 1328 } 1329 }; 1330 } 1331 1332 /// The ARM code here follows the Itanium code closely enough that we 1333 /// just special-case it at particular places. 1334 void ItaniumCXXABI::EmitGuardedInit(CodeGenFunction &CGF, 1335 const VarDecl &D, 1336 llvm::GlobalVariable *var, 1337 bool shouldPerformInit) { 1338 CGBuilderTy &Builder = CGF.Builder; 1339 1340 // We only need to use thread-safe statics for local non-TLS variables; 1341 // global initialization is always single-threaded. 1342 bool threadsafe = getContext().getLangOpts().ThreadsafeStatics && 1343 D.isLocalVarDecl() && !D.getTLSKind(); 1344 1345 // If we have a global variable with internal linkage and thread-safe statics 1346 // are disabled, we can just let the guard variable be of type i8. 1347 bool useInt8GuardVariable = !threadsafe && var->hasInternalLinkage(); 1348 1349 llvm::IntegerType *guardTy; 1350 if (useInt8GuardVariable) { 1351 guardTy = CGF.Int8Ty; 1352 } else { 1353 // Guard variables are 64 bits in the generic ABI and size width on ARM 1354 // (i.e. 32-bit on AArch32, 64-bit on AArch64). 1355 guardTy = (UseARMGuardVarABI ? CGF.SizeTy : CGF.Int64Ty); 1356 } 1357 llvm::PointerType *guardPtrTy = guardTy->getPointerTo(); 1358 1359 // Create the guard variable if we don't already have it (as we 1360 // might if we're double-emitting this function body). 1361 llvm::GlobalVariable *guard = CGM.getStaticLocalDeclGuardAddress(&D); 1362 if (!guard) { 1363 // Mangle the name for the guard. 1364 SmallString<256> guardName; 1365 { 1366 llvm::raw_svector_ostream out(guardName); 1367 getMangleContext().mangleStaticGuardVariable(&D, out); 1368 out.flush(); 1369 } 1370 1371 // Create the guard variable with a zero-initializer. 1372 // Just absorb linkage and visibility from the guarded variable. 1373 guard = new llvm::GlobalVariable(CGM.getModule(), guardTy, 1374 false, var->getLinkage(), 1375 llvm::ConstantInt::get(guardTy, 0), 1376 guardName.str()); 1377 guard->setVisibility(var->getVisibility()); 1378 // If the variable is thread-local, so is its guard variable. 1379 guard->setThreadLocalMode(var->getThreadLocalMode()); 1380 1381 CGM.setStaticLocalDeclGuardAddress(&D, guard); 1382 } 1383 1384 // Test whether the variable has completed initialization. 1385 llvm::Value *isInitialized; 1386 1387 // ARM C++ ABI 3.2.3.1: 1388 // To support the potential use of initialization guard variables 1389 // as semaphores that are the target of ARM SWP and LDREX/STREX 1390 // synchronizing instructions we define a static initialization 1391 // guard variable to be a 4-byte aligned, 4- byte word with the 1392 // following inline access protocol. 1393 // #define INITIALIZED 1 1394 // if ((obj_guard & INITIALIZED) != INITIALIZED) { 1395 // if (__cxa_guard_acquire(&obj_guard)) 1396 // ... 1397 // } 1398 if (UseARMGuardVarABI && !useInt8GuardVariable) { 1399 llvm::Value *V = Builder.CreateLoad(guard); 1400 llvm::Value *Test1 = llvm::ConstantInt::get(guardTy, 1); 1401 V = Builder.CreateAnd(V, Test1); 1402 isInitialized = Builder.CreateIsNull(V, "guard.uninitialized"); 1403 1404 // Itanium C++ ABI 3.3.2: 1405 // The following is pseudo-code showing how these functions can be used: 1406 // if (obj_guard.first_byte == 0) { 1407 // if ( __cxa_guard_acquire (&obj_guard) ) { 1408 // try { 1409 // ... initialize the object ...; 1410 // } catch (...) { 1411 // __cxa_guard_abort (&obj_guard); 1412 // throw; 1413 // } 1414 // ... queue object destructor with __cxa_atexit() ...; 1415 // __cxa_guard_release (&obj_guard); 1416 // } 1417 // } 1418 } else { 1419 // Load the first byte of the guard variable. 1420 llvm::LoadInst *LI = 1421 Builder.CreateLoad(Builder.CreateBitCast(guard, CGM.Int8PtrTy)); 1422 LI->setAlignment(1); 1423 1424 // Itanium ABI: 1425 // An implementation supporting thread-safety on multiprocessor 1426 // systems must also guarantee that references to the initialized 1427 // object do not occur before the load of the initialization flag. 1428 // 1429 // In LLVM, we do this by marking the load Acquire. 1430 if (threadsafe) 1431 LI->setAtomic(llvm::Acquire); 1432 1433 isInitialized = Builder.CreateIsNull(LI, "guard.uninitialized"); 1434 } 1435 1436 llvm::BasicBlock *InitCheckBlock = CGF.createBasicBlock("init.check"); 1437 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end"); 1438 1439 // Check if the first byte of the guard variable is zero. 1440 Builder.CreateCondBr(isInitialized, InitCheckBlock, EndBlock); 1441 1442 CGF.EmitBlock(InitCheckBlock); 1443 1444 // Variables used when coping with thread-safe statics and exceptions. 1445 if (threadsafe) { 1446 // Call __cxa_guard_acquire. 1447 llvm::Value *V 1448 = CGF.EmitNounwindRuntimeCall(getGuardAcquireFn(CGM, guardPtrTy), guard); 1449 1450 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init"); 1451 1452 Builder.CreateCondBr(Builder.CreateIsNotNull(V, "tobool"), 1453 InitBlock, EndBlock); 1454 1455 // Call __cxa_guard_abort along the exceptional edge. 1456 CGF.EHStack.pushCleanup<CallGuardAbort>(EHCleanup, guard); 1457 1458 CGF.EmitBlock(InitBlock); 1459 } 1460 1461 // Emit the initializer and add a global destructor if appropriate. 1462 CGF.EmitCXXGlobalVarDeclInit(D, var, shouldPerformInit); 1463 1464 if (threadsafe) { 1465 // Pop the guard-abort cleanup if we pushed one. 1466 CGF.PopCleanupBlock(); 1467 1468 // Call __cxa_guard_release. This cannot throw. 1469 CGF.EmitNounwindRuntimeCall(getGuardReleaseFn(CGM, guardPtrTy), guard); 1470 } else { 1471 Builder.CreateStore(llvm::ConstantInt::get(guardTy, 1), guard); 1472 } 1473 1474 CGF.EmitBlock(EndBlock); 1475 } 1476 1477 /// Register a global destructor using __cxa_atexit. 1478 static void emitGlobalDtorWithCXAAtExit(CodeGenFunction &CGF, 1479 llvm::Constant *dtor, 1480 llvm::Constant *addr, 1481 bool TLS) { 1482 const char *Name = "__cxa_atexit"; 1483 if (TLS) { 1484 const llvm::Triple &T = CGF.getTarget().getTriple(); 1485 Name = T.isMacOSX() ? "_tlv_atexit" : "__cxa_thread_atexit"; 1486 } 1487 1488 // We're assuming that the destructor function is something we can 1489 // reasonably call with the default CC. Go ahead and cast it to the 1490 // right prototype. 1491 llvm::Type *dtorTy = 1492 llvm::FunctionType::get(CGF.VoidTy, CGF.Int8PtrTy, false)->getPointerTo(); 1493 1494 // extern "C" int __cxa_atexit(void (*f)(void *), void *p, void *d); 1495 llvm::Type *paramTys[] = { dtorTy, CGF.Int8PtrTy, CGF.Int8PtrTy }; 1496 llvm::FunctionType *atexitTy = 1497 llvm::FunctionType::get(CGF.IntTy, paramTys, false); 1498 1499 // Fetch the actual function. 1500 llvm::Constant *atexit = CGF.CGM.CreateRuntimeFunction(atexitTy, Name); 1501 if (llvm::Function *fn = dyn_cast<llvm::Function>(atexit)) 1502 fn->setDoesNotThrow(); 1503 1504 // Create a variable that binds the atexit to this shared object. 1505 llvm::Constant *handle = 1506 CGF.CGM.CreateRuntimeVariable(CGF.Int8Ty, "__dso_handle"); 1507 1508 llvm::Value *args[] = { 1509 llvm::ConstantExpr::getBitCast(dtor, dtorTy), 1510 llvm::ConstantExpr::getBitCast(addr, CGF.Int8PtrTy), 1511 handle 1512 }; 1513 CGF.EmitNounwindRuntimeCall(atexit, args); 1514 } 1515 1516 /// Register a global destructor as best as we know how. 1517 void ItaniumCXXABI::registerGlobalDtor(CodeGenFunction &CGF, 1518 const VarDecl &D, 1519 llvm::Constant *dtor, 1520 llvm::Constant *addr) { 1521 // Use __cxa_atexit if available. 1522 if (CGM.getCodeGenOpts().CXAAtExit) 1523 return emitGlobalDtorWithCXAAtExit(CGF, dtor, addr, D.getTLSKind()); 1524 1525 if (D.getTLSKind()) 1526 CGM.ErrorUnsupported(&D, "non-trivial TLS destruction"); 1527 1528 // In Apple kexts, we want to add a global destructor entry. 1529 // FIXME: shouldn't this be guarded by some variable? 1530 if (CGM.getLangOpts().AppleKext) { 1531 // Generate a global destructor entry. 1532 return CGM.AddCXXDtorEntry(dtor, addr); 1533 } 1534 1535 CGF.registerGlobalDtorWithAtExit(D, dtor, addr); 1536 } 1537 1538 /// Get the appropriate linkage for the wrapper function. This is essentially 1539 /// the weak form of the variable's linkage; every translation unit which wneeds 1540 /// the wrapper emits a copy, and we want the linker to merge them. 1541 static llvm::GlobalValue::LinkageTypes getThreadLocalWrapperLinkage( 1542 llvm::GlobalValue::LinkageTypes VarLinkage) { 1543 // For internal linkage variables, we don't need an external or weak wrapper. 1544 if (llvm::GlobalValue::isLocalLinkage(VarLinkage)) 1545 return VarLinkage; 1546 return llvm::GlobalValue::WeakODRLinkage; 1547 } 1548 1549 llvm::Function * 1550 ItaniumCXXABI::getOrCreateThreadLocalWrapper(const VarDecl *VD, 1551 llvm::GlobalVariable *Var) { 1552 // Mangle the name for the thread_local wrapper function. 1553 SmallString<256> WrapperName; 1554 { 1555 llvm::raw_svector_ostream Out(WrapperName); 1556 getMangleContext().mangleItaniumThreadLocalWrapper(VD, Out); 1557 Out.flush(); 1558 } 1559 1560 if (llvm::Value *V = Var->getParent()->getNamedValue(WrapperName)) 1561 return cast<llvm::Function>(V); 1562 1563 llvm::Type *RetTy = Var->getType(); 1564 if (VD->getType()->isReferenceType()) 1565 RetTy = RetTy->getPointerElementType(); 1566 1567 llvm::FunctionType *FnTy = llvm::FunctionType::get(RetTy, false); 1568 llvm::Function *Wrapper = llvm::Function::Create( 1569 FnTy, getThreadLocalWrapperLinkage(Var->getLinkage()), WrapperName.str(), 1570 &CGM.getModule()); 1571 // Always resolve references to the wrapper at link time. 1572 Wrapper->setVisibility(llvm::GlobalValue::HiddenVisibility); 1573 return Wrapper; 1574 } 1575 1576 void ItaniumCXXABI::EmitThreadLocalInitFuncs( 1577 llvm::ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *> > Decls, 1578 llvm::Function *InitFunc) { 1579 for (unsigned I = 0, N = Decls.size(); I != N; ++I) { 1580 const VarDecl *VD = Decls[I].first; 1581 llvm::GlobalVariable *Var = Decls[I].second; 1582 1583 // Mangle the name for the thread_local initialization function. 1584 SmallString<256> InitFnName; 1585 { 1586 llvm::raw_svector_ostream Out(InitFnName); 1587 getMangleContext().mangleItaniumThreadLocalInit(VD, Out); 1588 Out.flush(); 1589 } 1590 1591 // If we have a definition for the variable, emit the initialization 1592 // function as an alias to the global Init function (if any). Otherwise, 1593 // produce a declaration of the initialization function. 1594 llvm::GlobalValue *Init = 0; 1595 bool InitIsInitFunc = false; 1596 if (VD->hasDefinition()) { 1597 InitIsInitFunc = true; 1598 if (InitFunc) 1599 Init = 1600 new llvm::GlobalAlias(InitFunc->getType(), Var->getLinkage(), 1601 InitFnName.str(), InitFunc, &CGM.getModule()); 1602 } else { 1603 // Emit a weak global function referring to the initialization function. 1604 // This function will not exist if the TU defining the thread_local 1605 // variable in question does not need any dynamic initialization for 1606 // its thread_local variables. 1607 llvm::FunctionType *FnTy = llvm::FunctionType::get(CGM.VoidTy, false); 1608 Init = llvm::Function::Create( 1609 FnTy, llvm::GlobalVariable::ExternalWeakLinkage, InitFnName.str(), 1610 &CGM.getModule()); 1611 } 1612 1613 if (Init) 1614 Init->setVisibility(Var->getVisibility()); 1615 1616 llvm::Function *Wrapper = getOrCreateThreadLocalWrapper(VD, Var); 1617 llvm::LLVMContext &Context = CGM.getModule().getContext(); 1618 llvm::BasicBlock *Entry = llvm::BasicBlock::Create(Context, "", Wrapper); 1619 CGBuilderTy Builder(Entry); 1620 if (InitIsInitFunc) { 1621 if (Init) 1622 Builder.CreateCall(Init); 1623 } else { 1624 // Don't know whether we have an init function. Call it if it exists. 1625 llvm::Value *Have = Builder.CreateIsNotNull(Init); 1626 llvm::BasicBlock *InitBB = llvm::BasicBlock::Create(Context, "", Wrapper); 1627 llvm::BasicBlock *ExitBB = llvm::BasicBlock::Create(Context, "", Wrapper); 1628 Builder.CreateCondBr(Have, InitBB, ExitBB); 1629 1630 Builder.SetInsertPoint(InitBB); 1631 Builder.CreateCall(Init); 1632 Builder.CreateBr(ExitBB); 1633 1634 Builder.SetInsertPoint(ExitBB); 1635 } 1636 1637 // For a reference, the result of the wrapper function is a pointer to 1638 // the referenced object. 1639 llvm::Value *Val = Var; 1640 if (VD->getType()->isReferenceType()) { 1641 llvm::LoadInst *LI = Builder.CreateLoad(Val); 1642 LI->setAlignment(CGM.getContext().getDeclAlign(VD).getQuantity()); 1643 Val = LI; 1644 } 1645 1646 Builder.CreateRet(Val); 1647 } 1648 } 1649 1650 LValue ItaniumCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, 1651 const VarDecl *VD, 1652 QualType LValType) { 1653 QualType T = VD->getType(); 1654 llvm::Type *Ty = CGF.getTypes().ConvertTypeForMem(T); 1655 llvm::Value *Val = CGF.CGM.GetAddrOfGlobalVar(VD, Ty); 1656 llvm::Function *Wrapper = 1657 getOrCreateThreadLocalWrapper(VD, cast<llvm::GlobalVariable>(Val)); 1658 1659 Val = CGF.Builder.CreateCall(Wrapper); 1660 1661 LValue LV; 1662 if (VD->getType()->isReferenceType()) 1663 LV = CGF.MakeNaturalAlignAddrLValue(Val, LValType); 1664 else 1665 LV = CGF.MakeAddrLValue(Val, LValType, CGF.getContext().getDeclAlign(VD)); 1666 // FIXME: need setObjCGCLValueClass? 1667 return LV; 1668 } 1669 1670 /// Return whether the given global decl needs a VTT parameter, which it does 1671 /// if it's a base constructor or destructor with virtual bases. 1672 bool ItaniumCXXABI::NeedsVTTParameter(GlobalDecl GD) { 1673 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl()); 1674 1675 // We don't have any virtual bases, just return early. 1676 if (!MD->getParent()->getNumVBases()) 1677 return false; 1678 1679 // Check if we have a base constructor. 1680 if (isa<CXXConstructorDecl>(MD) && GD.getCtorType() == Ctor_Base) 1681 return true; 1682 1683 // Check if we have a base destructor. 1684 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base) 1685 return true; 1686 1687 return false; 1688 } 1689