1 //===--- MicrosoftCXXABI.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 Microsoft Visual C++ ABI. 11 // The class in this file generates structures that follow the Microsoft 12 // Visual C++ ABI, which is actually not very well documented at all outside 13 // of Microsoft. 14 // 15 //===----------------------------------------------------------------------===// 16 17 #include "CGCXXABI.h" 18 #include "CGCleanup.h" 19 #include "CGVTables.h" 20 #include "CodeGenModule.h" 21 #include "CodeGenTypes.h" 22 #include "TargetInfo.h" 23 #include "clang/CodeGen/ConstantInitBuilder.h" 24 #include "clang/AST/Decl.h" 25 #include "clang/AST/DeclCXX.h" 26 #include "clang/AST/StmtCXX.h" 27 #include "clang/AST/VTableBuilder.h" 28 #include "llvm/ADT/StringExtras.h" 29 #include "llvm/ADT/StringSet.h" 30 #include "llvm/IR/CallSite.h" 31 #include "llvm/IR/Intrinsics.h" 32 33 using namespace clang; 34 using namespace CodeGen; 35 36 namespace { 37 38 /// Holds all the vbtable globals for a given class. 39 struct VBTableGlobals { 40 const VPtrInfoVector *VBTables; 41 SmallVector<llvm::GlobalVariable *, 2> Globals; 42 }; 43 44 class MicrosoftCXXABI : public CGCXXABI { 45 public: 46 MicrosoftCXXABI(CodeGenModule &CGM) 47 : CGCXXABI(CGM), BaseClassDescriptorType(nullptr), 48 ClassHierarchyDescriptorType(nullptr), 49 CompleteObjectLocatorType(nullptr), CatchableTypeType(nullptr), 50 ThrowInfoType(nullptr) {} 51 52 bool HasThisReturn(GlobalDecl GD) const override; 53 bool hasMostDerivedReturn(GlobalDecl GD) const override; 54 55 bool classifyReturnType(CGFunctionInfo &FI) const override; 56 57 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override; 58 59 bool isSRetParameterAfterThis() const override { return true; } 60 61 bool isThisCompleteObject(GlobalDecl GD) const override { 62 // The Microsoft ABI doesn't use separate complete-object vs. 63 // base-object variants of constructors, but it does of destructors. 64 if (isa<CXXDestructorDecl>(GD.getDecl())) { 65 switch (GD.getDtorType()) { 66 case Dtor_Complete: 67 case Dtor_Deleting: 68 return true; 69 70 case Dtor_Base: 71 return false; 72 73 case Dtor_Comdat: llvm_unreachable("emitting dtor comdat as function?"); 74 } 75 llvm_unreachable("bad dtor kind"); 76 } 77 78 // No other kinds. 79 return false; 80 } 81 82 size_t getSrcArgforCopyCtor(const CXXConstructorDecl *CD, 83 FunctionArgList &Args) const override { 84 assert(Args.size() >= 2 && 85 "expected the arglist to have at least two args!"); 86 // The 'most_derived' parameter goes second if the ctor is variadic and 87 // has v-bases. 88 if (CD->getParent()->getNumVBases() > 0 && 89 CD->getType()->castAs<FunctionProtoType>()->isVariadic()) 90 return 2; 91 return 1; 92 } 93 94 std::vector<CharUnits> getVBPtrOffsets(const CXXRecordDecl *RD) override { 95 std::vector<CharUnits> VBPtrOffsets; 96 const ASTContext &Context = getContext(); 97 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD); 98 99 const VBTableGlobals &VBGlobals = enumerateVBTables(RD); 100 for (const std::unique_ptr<VPtrInfo> &VBT : *VBGlobals.VBTables) { 101 const ASTRecordLayout &SubobjectLayout = 102 Context.getASTRecordLayout(VBT->IntroducingObject); 103 CharUnits Offs = VBT->NonVirtualOffset; 104 Offs += SubobjectLayout.getVBPtrOffset(); 105 if (VBT->getVBaseWithVPtr()) 106 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr()); 107 VBPtrOffsets.push_back(Offs); 108 } 109 llvm::array_pod_sort(VBPtrOffsets.begin(), VBPtrOffsets.end()); 110 return VBPtrOffsets; 111 } 112 113 StringRef GetPureVirtualCallName() override { return "_purecall"; } 114 StringRef GetDeletedVirtualCallName() override { return "_purecall"; } 115 116 void emitVirtualObjectDelete(CodeGenFunction &CGF, const CXXDeleteExpr *DE, 117 Address Ptr, QualType ElementType, 118 const CXXDestructorDecl *Dtor) override; 119 120 void emitRethrow(CodeGenFunction &CGF, bool isNoReturn) override; 121 void emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) override; 122 123 void emitBeginCatch(CodeGenFunction &CGF, const CXXCatchStmt *C) override; 124 125 llvm::GlobalVariable *getMSCompleteObjectLocator(const CXXRecordDecl *RD, 126 const VPtrInfo &Info); 127 128 llvm::Constant *getAddrOfRTTIDescriptor(QualType Ty) override; 129 CatchTypeInfo 130 getAddrOfCXXCatchHandlerType(QualType Ty, QualType CatchHandlerType) override; 131 132 /// MSVC needs an extra flag to indicate a catchall. 133 CatchTypeInfo getCatchAllTypeInfo() override { 134 return CatchTypeInfo{nullptr, 0x40}; 135 } 136 137 bool shouldTypeidBeNullChecked(bool IsDeref, QualType SrcRecordTy) override; 138 void EmitBadTypeidCall(CodeGenFunction &CGF) override; 139 llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy, 140 Address ThisPtr, 141 llvm::Type *StdTypeInfoPtrTy) override; 142 143 bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr, 144 QualType SrcRecordTy) override; 145 146 llvm::Value *EmitDynamicCastCall(CodeGenFunction &CGF, Address Value, 147 QualType SrcRecordTy, QualType DestTy, 148 QualType DestRecordTy, 149 llvm::BasicBlock *CastEnd) override; 150 151 llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value, 152 QualType SrcRecordTy, 153 QualType DestTy) override; 154 155 bool EmitBadCastCall(CodeGenFunction &CGF) override; 156 bool canSpeculativelyEmitVTable(const CXXRecordDecl *RD) const override { 157 return false; 158 } 159 160 llvm::Value * 161 GetVirtualBaseClassOffset(CodeGenFunction &CGF, Address This, 162 const CXXRecordDecl *ClassDecl, 163 const CXXRecordDecl *BaseClassDecl) override; 164 165 llvm::BasicBlock * 166 EmitCtorCompleteObjectHandler(CodeGenFunction &CGF, 167 const CXXRecordDecl *RD) override; 168 169 llvm::BasicBlock * 170 EmitDtorCompleteObjectHandler(CodeGenFunction &CGF); 171 172 void initializeHiddenVirtualInheritanceMembers(CodeGenFunction &CGF, 173 const CXXRecordDecl *RD) override; 174 175 void EmitCXXConstructors(const CXXConstructorDecl *D) override; 176 177 // Background on MSVC destructors 178 // ============================== 179 // 180 // Both Itanium and MSVC ABIs have destructor variants. The variant names 181 // roughly correspond in the following way: 182 // Itanium Microsoft 183 // Base -> no name, just ~Class 184 // Complete -> vbase destructor 185 // Deleting -> scalar deleting destructor 186 // vector deleting destructor 187 // 188 // The base and complete destructors are the same as in Itanium, although the 189 // complete destructor does not accept a VTT parameter when there are virtual 190 // bases. A separate mechanism involving vtordisps is used to ensure that 191 // virtual methods of destroyed subobjects are not called. 192 // 193 // The deleting destructors accept an i32 bitfield as a second parameter. Bit 194 // 1 indicates if the memory should be deleted. Bit 2 indicates if the this 195 // pointer points to an array. The scalar deleting destructor assumes that 196 // bit 2 is zero, and therefore does not contain a loop. 197 // 198 // For virtual destructors, only one entry is reserved in the vftable, and it 199 // always points to the vector deleting destructor. The vector deleting 200 // destructor is the most general, so it can be used to destroy objects in 201 // place, delete single heap objects, or delete arrays. 202 // 203 // A TU defining a non-inline destructor is only guaranteed to emit a base 204 // destructor, and all of the other variants are emitted on an as-needed basis 205 // in COMDATs. Because a non-base destructor can be emitted in a TU that 206 // lacks a definition for the destructor, non-base destructors must always 207 // delegate to or alias the base destructor. 208 209 AddedStructorArgs 210 buildStructorSignature(const CXXMethodDecl *MD, StructorType T, 211 SmallVectorImpl<CanQualType> &ArgTys) override; 212 213 /// Non-base dtors should be emitted as delegating thunks in this ABI. 214 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor, 215 CXXDtorType DT) const override { 216 return DT != Dtor_Base; 217 } 218 219 void EmitCXXDestructors(const CXXDestructorDecl *D) override; 220 221 const CXXRecordDecl * 222 getThisArgumentTypeForMethod(const CXXMethodDecl *MD) override { 223 MD = MD->getCanonicalDecl(); 224 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD)) { 225 MicrosoftVTableContext::MethodVFTableLocation ML = 226 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD); 227 // The vbases might be ordered differently in the final overrider object 228 // and the complete object, so the "this" argument may sometimes point to 229 // memory that has no particular type (e.g. past the complete object). 230 // In this case, we just use a generic pointer type. 231 // FIXME: might want to have a more precise type in the non-virtual 232 // multiple inheritance case. 233 if (ML.VBase || !ML.VFPtrOffset.isZero()) 234 return nullptr; 235 } 236 return MD->getParent(); 237 } 238 239 Address 240 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD, 241 Address This, 242 bool VirtualCall) override; 243 244 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy, 245 FunctionArgList &Params) override; 246 247 llvm::Value *adjustThisParameterInVirtualFunctionPrologue( 248 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) override; 249 250 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override; 251 252 AddedStructorArgs 253 addImplicitConstructorArgs(CodeGenFunction &CGF, const CXXConstructorDecl *D, 254 CXXCtorType Type, bool ForVirtualBase, 255 bool Delegating, CallArgList &Args) override; 256 257 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD, 258 CXXDtorType Type, bool ForVirtualBase, 259 bool Delegating, Address This) override; 260 261 void emitVTableTypeMetadata(const VPtrInfo &Info, const CXXRecordDecl *RD, 262 llvm::GlobalVariable *VTable); 263 264 void emitVTableDefinitions(CodeGenVTables &CGVT, 265 const CXXRecordDecl *RD) override; 266 267 bool isVirtualOffsetNeededForVTableField(CodeGenFunction &CGF, 268 CodeGenFunction::VPtr Vptr) override; 269 270 /// Don't initialize vptrs if dynamic class 271 /// is marked with with the 'novtable' attribute. 272 bool doStructorsInitializeVPtrs(const CXXRecordDecl *VTableClass) override { 273 return !VTableClass->hasAttr<MSNoVTableAttr>(); 274 } 275 276 llvm::Constant * 277 getVTableAddressPoint(BaseSubobject Base, 278 const CXXRecordDecl *VTableClass) override; 279 280 llvm::Value *getVTableAddressPointInStructor( 281 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, 282 BaseSubobject Base, const CXXRecordDecl *NearestVBase) override; 283 284 llvm::Constant * 285 getVTableAddressPointForConstExpr(BaseSubobject Base, 286 const CXXRecordDecl *VTableClass) override; 287 288 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD, 289 CharUnits VPtrOffset) override; 290 291 CGCallee getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD, 292 Address This, llvm::Type *Ty, 293 SourceLocation Loc) override; 294 295 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF, 296 const CXXDestructorDecl *Dtor, 297 CXXDtorType DtorType, 298 Address This, 299 const CXXMemberCallExpr *CE) override; 300 301 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD, 302 CallArgList &CallArgs) override { 303 assert(GD.getDtorType() == Dtor_Deleting && 304 "Only deleting destructor thunks are available in this ABI"); 305 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)), 306 getContext().IntTy); 307 } 308 309 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override; 310 311 llvm::GlobalVariable * 312 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD, 313 llvm::GlobalVariable::LinkageTypes Linkage); 314 315 llvm::GlobalVariable * 316 getAddrOfVirtualDisplacementMap(const CXXRecordDecl *SrcRD, 317 const CXXRecordDecl *DstRD) { 318 SmallString<256> OutName; 319 llvm::raw_svector_ostream Out(OutName); 320 getMangleContext().mangleCXXVirtualDisplacementMap(SrcRD, DstRD, Out); 321 StringRef MangledName = OutName.str(); 322 323 if (auto *VDispMap = CGM.getModule().getNamedGlobal(MangledName)) 324 return VDispMap; 325 326 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext(); 327 unsigned NumEntries = 1 + SrcRD->getNumVBases(); 328 SmallVector<llvm::Constant *, 4> Map(NumEntries, 329 llvm::UndefValue::get(CGM.IntTy)); 330 Map[0] = llvm::ConstantInt::get(CGM.IntTy, 0); 331 bool AnyDifferent = false; 332 for (const auto &I : SrcRD->vbases()) { 333 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl(); 334 if (!DstRD->isVirtuallyDerivedFrom(VBase)) 335 continue; 336 337 unsigned SrcVBIndex = VTContext.getVBTableIndex(SrcRD, VBase); 338 unsigned DstVBIndex = VTContext.getVBTableIndex(DstRD, VBase); 339 Map[SrcVBIndex] = llvm::ConstantInt::get(CGM.IntTy, DstVBIndex * 4); 340 AnyDifferent |= SrcVBIndex != DstVBIndex; 341 } 342 // This map would be useless, don't use it. 343 if (!AnyDifferent) 344 return nullptr; 345 346 llvm::ArrayType *VDispMapTy = llvm::ArrayType::get(CGM.IntTy, Map.size()); 347 llvm::Constant *Init = llvm::ConstantArray::get(VDispMapTy, Map); 348 llvm::GlobalValue::LinkageTypes Linkage = 349 SrcRD->isExternallyVisible() && DstRD->isExternallyVisible() 350 ? llvm::GlobalValue::LinkOnceODRLinkage 351 : llvm::GlobalValue::InternalLinkage; 352 auto *VDispMap = new llvm::GlobalVariable( 353 CGM.getModule(), VDispMapTy, /*Constant=*/true, Linkage, 354 /*Initializer=*/Init, MangledName); 355 return VDispMap; 356 } 357 358 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD, 359 llvm::GlobalVariable *GV) const; 360 361 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable, 362 GlobalDecl GD, bool ReturnAdjustment) override { 363 // Never dllimport/dllexport thunks. 364 Thunk->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass); 365 366 GVALinkage Linkage = 367 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl())); 368 369 if (Linkage == GVA_Internal) 370 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage); 371 else if (ReturnAdjustment) 372 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage); 373 else 374 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage); 375 } 376 377 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, Address This, 378 const ThisAdjustment &TA) override; 379 380 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, Address Ret, 381 const ReturnAdjustment &RA) override; 382 383 void EmitThreadLocalInitFuncs( 384 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals, 385 ArrayRef<llvm::Function *> CXXThreadLocalInits, 386 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) override; 387 388 bool usesThreadWrapperFunction() const override { return false; } 389 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD, 390 QualType LValType) override; 391 392 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D, 393 llvm::GlobalVariable *DeclPtr, 394 bool PerformInit) override; 395 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D, 396 llvm::Constant *Dtor, llvm::Constant *Addr) override; 397 398 // ==== Notes on array cookies ========= 399 // 400 // MSVC seems to only use cookies when the class has a destructor; a 401 // two-argument usual array deallocation function isn't sufficient. 402 // 403 // For example, this code prints "100" and "1": 404 // struct A { 405 // char x; 406 // void *operator new[](size_t sz) { 407 // printf("%u\n", sz); 408 // return malloc(sz); 409 // } 410 // void operator delete[](void *p, size_t sz) { 411 // printf("%u\n", sz); 412 // free(p); 413 // } 414 // }; 415 // int main() { 416 // A *p = new A[100]; 417 // delete[] p; 418 // } 419 // Whereas it prints "104" and "104" if you give A a destructor. 420 421 bool requiresArrayCookie(const CXXDeleteExpr *expr, 422 QualType elementType) override; 423 bool requiresArrayCookie(const CXXNewExpr *expr) override; 424 CharUnits getArrayCookieSizeImpl(QualType type) override; 425 Address InitializeArrayCookie(CodeGenFunction &CGF, 426 Address NewPtr, 427 llvm::Value *NumElements, 428 const CXXNewExpr *expr, 429 QualType ElementType) override; 430 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF, 431 Address allocPtr, 432 CharUnits cookieSize) override; 433 434 friend struct MSRTTIBuilder; 435 436 bool isImageRelative() const { 437 return CGM.getTarget().getPointerWidth(/*AddressSpace=*/0) == 64; 438 } 439 440 // 5 routines for constructing the llvm types for MS RTTI structs. 441 llvm::StructType *getTypeDescriptorType(StringRef TypeInfoString) { 442 llvm::SmallString<32> TDTypeName("rtti.TypeDescriptor"); 443 TDTypeName += llvm::utostr(TypeInfoString.size()); 444 llvm::StructType *&TypeDescriptorType = 445 TypeDescriptorTypeMap[TypeInfoString.size()]; 446 if (TypeDescriptorType) 447 return TypeDescriptorType; 448 llvm::Type *FieldTypes[] = { 449 CGM.Int8PtrPtrTy, 450 CGM.Int8PtrTy, 451 llvm::ArrayType::get(CGM.Int8Ty, TypeInfoString.size() + 1)}; 452 TypeDescriptorType = 453 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, TDTypeName); 454 return TypeDescriptorType; 455 } 456 457 llvm::Type *getImageRelativeType(llvm::Type *PtrType) { 458 if (!isImageRelative()) 459 return PtrType; 460 return CGM.IntTy; 461 } 462 463 llvm::StructType *getBaseClassDescriptorType() { 464 if (BaseClassDescriptorType) 465 return BaseClassDescriptorType; 466 llvm::Type *FieldTypes[] = { 467 getImageRelativeType(CGM.Int8PtrTy), 468 CGM.IntTy, 469 CGM.IntTy, 470 CGM.IntTy, 471 CGM.IntTy, 472 CGM.IntTy, 473 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()), 474 }; 475 BaseClassDescriptorType = llvm::StructType::create( 476 CGM.getLLVMContext(), FieldTypes, "rtti.BaseClassDescriptor"); 477 return BaseClassDescriptorType; 478 } 479 480 llvm::StructType *getClassHierarchyDescriptorType() { 481 if (ClassHierarchyDescriptorType) 482 return ClassHierarchyDescriptorType; 483 // Forward-declare RTTIClassHierarchyDescriptor to break a cycle. 484 ClassHierarchyDescriptorType = llvm::StructType::create( 485 CGM.getLLVMContext(), "rtti.ClassHierarchyDescriptor"); 486 llvm::Type *FieldTypes[] = { 487 CGM.IntTy, 488 CGM.IntTy, 489 CGM.IntTy, 490 getImageRelativeType( 491 getBaseClassDescriptorType()->getPointerTo()->getPointerTo()), 492 }; 493 ClassHierarchyDescriptorType->setBody(FieldTypes); 494 return ClassHierarchyDescriptorType; 495 } 496 497 llvm::StructType *getCompleteObjectLocatorType() { 498 if (CompleteObjectLocatorType) 499 return CompleteObjectLocatorType; 500 CompleteObjectLocatorType = llvm::StructType::create( 501 CGM.getLLVMContext(), "rtti.CompleteObjectLocator"); 502 llvm::Type *FieldTypes[] = { 503 CGM.IntTy, 504 CGM.IntTy, 505 CGM.IntTy, 506 getImageRelativeType(CGM.Int8PtrTy), 507 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()), 508 getImageRelativeType(CompleteObjectLocatorType), 509 }; 510 llvm::ArrayRef<llvm::Type *> FieldTypesRef(FieldTypes); 511 if (!isImageRelative()) 512 FieldTypesRef = FieldTypesRef.drop_back(); 513 CompleteObjectLocatorType->setBody(FieldTypesRef); 514 return CompleteObjectLocatorType; 515 } 516 517 llvm::GlobalVariable *getImageBase() { 518 StringRef Name = "__ImageBase"; 519 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name)) 520 return GV; 521 522 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8Ty, 523 /*isConstant=*/true, 524 llvm::GlobalValue::ExternalLinkage, 525 /*Initializer=*/nullptr, Name); 526 } 527 528 llvm::Constant *getImageRelativeConstant(llvm::Constant *PtrVal) { 529 if (!isImageRelative()) 530 return PtrVal; 531 532 if (PtrVal->isNullValue()) 533 return llvm::Constant::getNullValue(CGM.IntTy); 534 535 llvm::Constant *ImageBaseAsInt = 536 llvm::ConstantExpr::getPtrToInt(getImageBase(), CGM.IntPtrTy); 537 llvm::Constant *PtrValAsInt = 538 llvm::ConstantExpr::getPtrToInt(PtrVal, CGM.IntPtrTy); 539 llvm::Constant *Diff = 540 llvm::ConstantExpr::getSub(PtrValAsInt, ImageBaseAsInt, 541 /*HasNUW=*/true, /*HasNSW=*/true); 542 return llvm::ConstantExpr::getTrunc(Diff, CGM.IntTy); 543 } 544 545 private: 546 MicrosoftMangleContext &getMangleContext() { 547 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext()); 548 } 549 550 llvm::Constant *getZeroInt() { 551 return llvm::ConstantInt::get(CGM.IntTy, 0); 552 } 553 554 llvm::Constant *getAllOnesInt() { 555 return llvm::Constant::getAllOnesValue(CGM.IntTy); 556 } 557 558 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) override; 559 560 void 561 GetNullMemberPointerFields(const MemberPointerType *MPT, 562 llvm::SmallVectorImpl<llvm::Constant *> &fields); 563 564 /// \brief Shared code for virtual base adjustment. Returns the offset from 565 /// the vbptr to the virtual base. Optionally returns the address of the 566 /// vbptr itself. 567 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF, 568 Address Base, 569 llvm::Value *VBPtrOffset, 570 llvm::Value *VBTableOffset, 571 llvm::Value **VBPtr = nullptr); 572 573 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF, 574 Address Base, 575 int32_t VBPtrOffset, 576 int32_t VBTableOffset, 577 llvm::Value **VBPtr = nullptr) { 578 assert(VBTableOffset % 4 == 0 && "should be byte offset into table of i32s"); 579 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), 580 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset); 581 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr); 582 } 583 584 std::pair<Address, llvm::Value *> 585 performBaseAdjustment(CodeGenFunction &CGF, Address Value, 586 QualType SrcRecordTy); 587 588 /// \brief Performs a full virtual base adjustment. Used to dereference 589 /// pointers to members of virtual bases. 590 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E, 591 const CXXRecordDecl *RD, Address Base, 592 llvm::Value *VirtualBaseAdjustmentOffset, 593 llvm::Value *VBPtrOffset /* optional */); 594 595 /// \brief Emits a full member pointer with the fields common to data and 596 /// function member pointers. 597 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField, 598 bool IsMemberFunction, 599 const CXXRecordDecl *RD, 600 CharUnits NonVirtualBaseAdjustment, 601 unsigned VBTableIndex); 602 603 bool MemberPointerConstantIsNull(const MemberPointerType *MPT, 604 llvm::Constant *MP); 605 606 /// \brief - Initialize all vbptrs of 'this' with RD as the complete type. 607 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD); 608 609 /// \brief Caching wrapper around VBTableBuilder::enumerateVBTables(). 610 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD); 611 612 /// \brief Generate a thunk for calling a virtual member function MD. 613 llvm::Function *EmitVirtualMemPtrThunk( 614 const CXXMethodDecl *MD, 615 const MicrosoftVTableContext::MethodVFTableLocation &ML); 616 617 public: 618 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override; 619 620 bool isZeroInitializable(const MemberPointerType *MPT) override; 621 622 bool isMemberPointerConvertible(const MemberPointerType *MPT) const override { 623 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl(); 624 return RD->hasAttr<MSInheritanceAttr>(); 625 } 626 627 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override; 628 629 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT, 630 CharUnits offset) override; 631 llvm::Constant *EmitMemberFunctionPointer(const CXXMethodDecl *MD) override; 632 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override; 633 634 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF, 635 llvm::Value *L, 636 llvm::Value *R, 637 const MemberPointerType *MPT, 638 bool Inequality) override; 639 640 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF, 641 llvm::Value *MemPtr, 642 const MemberPointerType *MPT) override; 643 644 llvm::Value * 645 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E, 646 Address Base, llvm::Value *MemPtr, 647 const MemberPointerType *MPT) override; 648 649 llvm::Value *EmitNonNullMemberPointerConversion( 650 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, 651 CastKind CK, CastExpr::path_const_iterator PathBegin, 652 CastExpr::path_const_iterator PathEnd, llvm::Value *Src, 653 CGBuilderTy &Builder); 654 655 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF, 656 const CastExpr *E, 657 llvm::Value *Src) override; 658 659 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E, 660 llvm::Constant *Src) override; 661 662 llvm::Constant *EmitMemberPointerConversion( 663 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, 664 CastKind CK, CastExpr::path_const_iterator PathBegin, 665 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src); 666 667 CGCallee 668 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E, 669 Address This, llvm::Value *&ThisPtrForCall, 670 llvm::Value *MemPtr, 671 const MemberPointerType *MPT) override; 672 673 void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) override; 674 675 llvm::StructType *getCatchableTypeType() { 676 if (CatchableTypeType) 677 return CatchableTypeType; 678 llvm::Type *FieldTypes[] = { 679 CGM.IntTy, // Flags 680 getImageRelativeType(CGM.Int8PtrTy), // TypeDescriptor 681 CGM.IntTy, // NonVirtualAdjustment 682 CGM.IntTy, // OffsetToVBPtr 683 CGM.IntTy, // VBTableIndex 684 CGM.IntTy, // Size 685 getImageRelativeType(CGM.Int8PtrTy) // CopyCtor 686 }; 687 CatchableTypeType = llvm::StructType::create( 688 CGM.getLLVMContext(), FieldTypes, "eh.CatchableType"); 689 return CatchableTypeType; 690 } 691 692 llvm::StructType *getCatchableTypeArrayType(uint32_t NumEntries) { 693 llvm::StructType *&CatchableTypeArrayType = 694 CatchableTypeArrayTypeMap[NumEntries]; 695 if (CatchableTypeArrayType) 696 return CatchableTypeArrayType; 697 698 llvm::SmallString<23> CTATypeName("eh.CatchableTypeArray."); 699 CTATypeName += llvm::utostr(NumEntries); 700 llvm::Type *CTType = 701 getImageRelativeType(getCatchableTypeType()->getPointerTo()); 702 llvm::Type *FieldTypes[] = { 703 CGM.IntTy, // NumEntries 704 llvm::ArrayType::get(CTType, NumEntries) // CatchableTypes 705 }; 706 CatchableTypeArrayType = 707 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, CTATypeName); 708 return CatchableTypeArrayType; 709 } 710 711 llvm::StructType *getThrowInfoType() { 712 if (ThrowInfoType) 713 return ThrowInfoType; 714 llvm::Type *FieldTypes[] = { 715 CGM.IntTy, // Flags 716 getImageRelativeType(CGM.Int8PtrTy), // CleanupFn 717 getImageRelativeType(CGM.Int8PtrTy), // ForwardCompat 718 getImageRelativeType(CGM.Int8PtrTy) // CatchableTypeArray 719 }; 720 ThrowInfoType = llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, 721 "eh.ThrowInfo"); 722 return ThrowInfoType; 723 } 724 725 llvm::Constant *getThrowFn() { 726 // _CxxThrowException is passed an exception object and a ThrowInfo object 727 // which describes the exception. 728 llvm::Type *Args[] = {CGM.Int8PtrTy, getThrowInfoType()->getPointerTo()}; 729 llvm::FunctionType *FTy = 730 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false); 731 auto *Fn = cast<llvm::Function>( 732 CGM.CreateRuntimeFunction(FTy, "_CxxThrowException")); 733 // _CxxThrowException is stdcall on 32-bit x86 platforms. 734 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::x86) 735 Fn->setCallingConv(llvm::CallingConv::X86_StdCall); 736 return Fn; 737 } 738 739 llvm::Function *getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD, 740 CXXCtorType CT); 741 742 llvm::Constant *getCatchableType(QualType T, 743 uint32_t NVOffset = 0, 744 int32_t VBPtrOffset = -1, 745 uint32_t VBIndex = 0); 746 747 llvm::GlobalVariable *getCatchableTypeArray(QualType T); 748 749 llvm::GlobalVariable *getThrowInfo(QualType T) override; 750 751 private: 752 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy; 753 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy; 754 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy; 755 /// \brief All the vftables that have been referenced. 756 VFTablesMapTy VFTablesMap; 757 VTablesMapTy VTablesMap; 758 759 /// \brief This set holds the record decls we've deferred vtable emission for. 760 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables; 761 762 763 /// \brief All the vbtables which have been referenced. 764 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap; 765 766 /// Info on the global variable used to guard initialization of static locals. 767 /// The BitIndex field is only used for externally invisible declarations. 768 struct GuardInfo { 769 GuardInfo() : Guard(nullptr), BitIndex(0) {} 770 llvm::GlobalVariable *Guard; 771 unsigned BitIndex; 772 }; 773 774 /// Map from DeclContext to the current guard variable. We assume that the 775 /// AST is visited in source code order. 776 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap; 777 llvm::DenseMap<const DeclContext *, GuardInfo> ThreadLocalGuardVariableMap; 778 llvm::DenseMap<const DeclContext *, unsigned> ThreadSafeGuardNumMap; 779 780 llvm::DenseMap<size_t, llvm::StructType *> TypeDescriptorTypeMap; 781 llvm::StructType *BaseClassDescriptorType; 782 llvm::StructType *ClassHierarchyDescriptorType; 783 llvm::StructType *CompleteObjectLocatorType; 784 785 llvm::DenseMap<QualType, llvm::GlobalVariable *> CatchableTypeArrays; 786 787 llvm::StructType *CatchableTypeType; 788 llvm::DenseMap<uint32_t, llvm::StructType *> CatchableTypeArrayTypeMap; 789 llvm::StructType *ThrowInfoType; 790 }; 791 792 } 793 794 CGCXXABI::RecordArgABI 795 MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const { 796 switch (CGM.getTarget().getTriple().getArch()) { 797 default: 798 // FIXME: Implement for other architectures. 799 return RAA_Default; 800 801 case llvm::Triple::thumb: 802 // Use the simple Itanium rules for now. 803 // FIXME: This is incompatible with MSVC for arguments with a dtor and no 804 // copy ctor. 805 return !canCopyArgument(RD) ? RAA_Indirect : RAA_Default; 806 807 case llvm::Triple::x86: 808 // All record arguments are passed in memory on x86. Decide whether to 809 // construct the object directly in argument memory, or to construct the 810 // argument elsewhere and copy the bytes during the call. 811 812 // If C++ prohibits us from making a copy, construct the arguments directly 813 // into argument memory. 814 if (!canCopyArgument(RD)) 815 return RAA_DirectInMemory; 816 817 // Otherwise, construct the argument into a temporary and copy the bytes 818 // into the outgoing argument memory. 819 return RAA_Default; 820 821 case llvm::Triple::x86_64: 822 // Win64 passes objects with non-trivial copy ctors indirectly. 823 if (RD->hasNonTrivialCopyConstructor()) 824 return RAA_Indirect; 825 826 // If an object has a destructor, we'd really like to pass it indirectly 827 // because it allows us to elide copies. Unfortunately, MSVC makes that 828 // impossible for small types, which it will pass in a single register or 829 // stack slot. Most objects with dtors are large-ish, so handle that early. 830 // We can't call out all large objects as being indirect because there are 831 // multiple x64 calling conventions and the C++ ABI code shouldn't dictate 832 // how we pass large POD types. 833 if (RD->hasNonTrivialDestructor() && 834 getContext().getTypeSize(RD->getTypeForDecl()) > 64) 835 return RAA_Indirect; 836 837 // If this is true, the implicit copy constructor that Sema would have 838 // created would not be deleted. FIXME: We should provide a more direct way 839 // for CodeGen to ask whether the constructor was deleted. 840 if (!RD->hasUserDeclaredCopyConstructor() && 841 !RD->hasUserDeclaredMoveConstructor() && 842 !RD->needsOverloadResolutionForMoveConstructor() && 843 !RD->hasUserDeclaredMoveAssignment() && 844 !RD->needsOverloadResolutionForMoveAssignment()) 845 return RAA_Default; 846 847 // Otherwise, Sema should have created an implicit copy constructor if 848 // needed. 849 assert(!RD->needsImplicitCopyConstructor()); 850 851 // We have to make sure the trivial copy constructor isn't deleted. 852 for (const CXXConstructorDecl *CD : RD->ctors()) { 853 if (CD->isCopyConstructor()) { 854 assert(CD->isTrivial()); 855 // We had at least one undeleted trivial copy ctor. Return directly. 856 if (!CD->isDeleted()) 857 return RAA_Default; 858 } 859 } 860 861 // The trivial copy constructor was deleted. Return indirectly. 862 return RAA_Indirect; 863 } 864 865 llvm_unreachable("invalid enum"); 866 } 867 868 void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF, 869 const CXXDeleteExpr *DE, 870 Address Ptr, 871 QualType ElementType, 872 const CXXDestructorDecl *Dtor) { 873 // FIXME: Provide a source location here even though there's no 874 // CXXMemberCallExpr for dtor call. 875 bool UseGlobalDelete = DE->isGlobalDelete(); 876 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting; 877 llvm::Value *MDThis = 878 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr); 879 if (UseGlobalDelete) 880 CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType); 881 } 882 883 void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) { 884 llvm::Value *Args[] = { 885 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), 886 llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())}; 887 auto *Fn = getThrowFn(); 888 if (isNoReturn) 889 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args); 890 else 891 CGF.EmitRuntimeCallOrInvoke(Fn, Args); 892 } 893 894 namespace { 895 struct CatchRetScope final : EHScopeStack::Cleanup { 896 llvm::CatchPadInst *CPI; 897 898 CatchRetScope(llvm::CatchPadInst *CPI) : CPI(CPI) {} 899 900 void Emit(CodeGenFunction &CGF, Flags flags) override { 901 llvm::BasicBlock *BB = CGF.createBasicBlock("catchret.dest"); 902 CGF.Builder.CreateCatchRet(CPI, BB); 903 CGF.EmitBlock(BB); 904 } 905 }; 906 } 907 908 void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF, 909 const CXXCatchStmt *S) { 910 // In the MS ABI, the runtime handles the copy, and the catch handler is 911 // responsible for destruction. 912 VarDecl *CatchParam = S->getExceptionDecl(); 913 llvm::BasicBlock *CatchPadBB = CGF.Builder.GetInsertBlock(); 914 llvm::CatchPadInst *CPI = 915 cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI()); 916 CGF.CurrentFuncletPad = CPI; 917 918 // If this is a catch-all or the catch parameter is unnamed, we don't need to 919 // emit an alloca to the object. 920 if (!CatchParam || !CatchParam->getDeclName()) { 921 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI); 922 return; 923 } 924 925 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam); 926 CPI->setArgOperand(2, var.getObjectAddress(CGF).getPointer()); 927 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI); 928 CGF.EmitAutoVarCleanups(var); 929 } 930 931 /// We need to perform a generic polymorphic operation (like a typeid 932 /// or a cast), which requires an object with a vfptr. Adjust the 933 /// address to point to an object with a vfptr. 934 std::pair<Address, llvm::Value *> 935 MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, Address Value, 936 QualType SrcRecordTy) { 937 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy); 938 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl(); 939 const ASTContext &Context = getContext(); 940 941 // If the class itself has a vfptr, great. This check implicitly 942 // covers non-virtual base subobjects: a class with its own virtual 943 // functions would be a candidate to be a primary base. 944 if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr()) 945 return std::make_pair(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0)); 946 947 // Okay, one of the vbases must have a vfptr, or else this isn't 948 // actually a polymorphic class. 949 const CXXRecordDecl *PolymorphicBase = nullptr; 950 for (auto &Base : SrcDecl->vbases()) { 951 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl(); 952 if (Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr()) { 953 PolymorphicBase = BaseDecl; 954 break; 955 } 956 } 957 assert(PolymorphicBase && "polymorphic class has no apparent vfptr?"); 958 959 llvm::Value *Offset = 960 GetVirtualBaseClassOffset(CGF, Value, SrcDecl, PolymorphicBase); 961 llvm::Value *Ptr = CGF.Builder.CreateInBoundsGEP(Value.getPointer(), Offset); 962 CharUnits VBaseAlign = 963 CGF.CGM.getVBaseAlignment(Value.getAlignment(), SrcDecl, PolymorphicBase); 964 return std::make_pair(Address(Ptr, VBaseAlign), Offset); 965 } 966 967 bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref, 968 QualType SrcRecordTy) { 969 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl(); 970 return IsDeref && 971 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr(); 972 } 973 974 static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF, 975 llvm::Value *Argument) { 976 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy}; 977 llvm::FunctionType *FTy = 978 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false); 979 llvm::Value *Args[] = {Argument}; 980 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid"); 981 return CGF.EmitRuntimeCallOrInvoke(Fn, Args); 982 } 983 984 void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) { 985 llvm::CallSite Call = 986 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy)); 987 Call.setDoesNotReturn(); 988 CGF.Builder.CreateUnreachable(); 989 } 990 991 llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF, 992 QualType SrcRecordTy, 993 Address ThisPtr, 994 llvm::Type *StdTypeInfoPtrTy) { 995 std::tie(ThisPtr, std::ignore) = 996 performBaseAdjustment(CGF, ThisPtr, SrcRecordTy); 997 auto Typeid = emitRTtypeidCall(CGF, ThisPtr.getPointer()).getInstruction(); 998 return CGF.Builder.CreateBitCast(Typeid, StdTypeInfoPtrTy); 999 } 1000 1001 bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr, 1002 QualType SrcRecordTy) { 1003 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl(); 1004 return SrcIsPtr && 1005 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr(); 1006 } 1007 1008 llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall( 1009 CodeGenFunction &CGF, Address This, QualType SrcRecordTy, 1010 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) { 1011 llvm::Type *DestLTy = CGF.ConvertType(DestTy); 1012 1013 llvm::Value *SrcRTTI = 1014 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType()); 1015 llvm::Value *DestRTTI = 1016 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType()); 1017 1018 llvm::Value *Offset; 1019 std::tie(This, Offset) = performBaseAdjustment(CGF, This, SrcRecordTy); 1020 llvm::Value *ThisPtr = This.getPointer(); 1021 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty); 1022 1023 // PVOID __RTDynamicCast( 1024 // PVOID inptr, 1025 // LONG VfDelta, 1026 // PVOID SrcType, 1027 // PVOID TargetType, 1028 // BOOL isReference) 1029 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy, 1030 CGF.Int8PtrTy, CGF.Int32Ty}; 1031 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction( 1032 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false), 1033 "__RTDynamicCast"); 1034 llvm::Value *Args[] = { 1035 ThisPtr, Offset, SrcRTTI, DestRTTI, 1036 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())}; 1037 ThisPtr = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction(); 1038 return CGF.Builder.CreateBitCast(ThisPtr, DestLTy); 1039 } 1040 1041 llvm::Value * 1042 MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value, 1043 QualType SrcRecordTy, 1044 QualType DestTy) { 1045 std::tie(Value, std::ignore) = performBaseAdjustment(CGF, Value, SrcRecordTy); 1046 1047 // PVOID __RTCastToVoid( 1048 // PVOID inptr) 1049 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy}; 1050 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction( 1051 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false), 1052 "__RTCastToVoid"); 1053 llvm::Value *Args[] = {Value.getPointer()}; 1054 return CGF.EmitRuntimeCall(Function, Args); 1055 } 1056 1057 bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) { 1058 return false; 1059 } 1060 1061 llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset( 1062 CodeGenFunction &CGF, Address This, const CXXRecordDecl *ClassDecl, 1063 const CXXRecordDecl *BaseClassDecl) { 1064 const ASTContext &Context = getContext(); 1065 int64_t VBPtrChars = 1066 Context.getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity(); 1067 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars); 1068 CharUnits IntSize = Context.getTypeSizeInChars(Context.IntTy); 1069 CharUnits VBTableChars = 1070 IntSize * 1071 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl); 1072 llvm::Value *VBTableOffset = 1073 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity()); 1074 1075 llvm::Value *VBPtrToNewBase = 1076 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset); 1077 VBPtrToNewBase = 1078 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy); 1079 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase); 1080 } 1081 1082 bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const { 1083 return isa<CXXConstructorDecl>(GD.getDecl()); 1084 } 1085 1086 static bool isDeletingDtor(GlobalDecl GD) { 1087 return isa<CXXDestructorDecl>(GD.getDecl()) && 1088 GD.getDtorType() == Dtor_Deleting; 1089 } 1090 1091 bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const { 1092 return isDeletingDtor(GD); 1093 } 1094 1095 bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const { 1096 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl(); 1097 if (!RD) 1098 return false; 1099 1100 CharUnits Align = CGM.getContext().getTypeAlignInChars(FI.getReturnType()); 1101 if (FI.isInstanceMethod()) { 1102 // If it's an instance method, aggregates are always returned indirectly via 1103 // the second parameter. 1104 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false); 1105 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod()); 1106 return true; 1107 } else if (!RD->isPOD()) { 1108 // If it's a free function, non-POD types are returned indirectly. 1109 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false); 1110 return true; 1111 } 1112 1113 // Otherwise, use the C ABI rules. 1114 return false; 1115 } 1116 1117 llvm::BasicBlock * 1118 MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF, 1119 const CXXRecordDecl *RD) { 1120 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF); 1121 assert(IsMostDerivedClass && 1122 "ctor for a class with virtual bases must have an implicit parameter"); 1123 llvm::Value *IsCompleteObject = 1124 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object"); 1125 1126 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases"); 1127 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases"); 1128 CGF.Builder.CreateCondBr(IsCompleteObject, 1129 CallVbaseCtorsBB, SkipVbaseCtorsBB); 1130 1131 CGF.EmitBlock(CallVbaseCtorsBB); 1132 1133 // Fill in the vbtable pointers here. 1134 EmitVBPtrStores(CGF, RD); 1135 1136 // CGF will put the base ctor calls in this basic block for us later. 1137 1138 return SkipVbaseCtorsBB; 1139 } 1140 1141 llvm::BasicBlock * 1142 MicrosoftCXXABI::EmitDtorCompleteObjectHandler(CodeGenFunction &CGF) { 1143 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF); 1144 assert(IsMostDerivedClass && 1145 "ctor for a class with virtual bases must have an implicit parameter"); 1146 llvm::Value *IsCompleteObject = 1147 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object"); 1148 1149 llvm::BasicBlock *CallVbaseDtorsBB = CGF.createBasicBlock("Dtor.dtor_vbases"); 1150 llvm::BasicBlock *SkipVbaseDtorsBB = CGF.createBasicBlock("Dtor.skip_vbases"); 1151 CGF.Builder.CreateCondBr(IsCompleteObject, 1152 CallVbaseDtorsBB, SkipVbaseDtorsBB); 1153 1154 CGF.EmitBlock(CallVbaseDtorsBB); 1155 // CGF will put the base dtor calls in this basic block for us later. 1156 1157 return SkipVbaseDtorsBB; 1158 } 1159 1160 void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers( 1161 CodeGenFunction &CGF, const CXXRecordDecl *RD) { 1162 // In most cases, an override for a vbase virtual method can adjust 1163 // the "this" parameter by applying a constant offset. 1164 // However, this is not enough while a constructor or a destructor of some 1165 // class X is being executed if all the following conditions are met: 1166 // - X has virtual bases, (1) 1167 // - X overrides a virtual method M of a vbase Y, (2) 1168 // - X itself is a vbase of the most derived class. 1169 // 1170 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X 1171 // which holds the extra amount of "this" adjustment we must do when we use 1172 // the X vftables (i.e. during X ctor or dtor). 1173 // Outside the ctors and dtors, the values of vtorDisps are zero. 1174 1175 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD); 1176 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets; 1177 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap(); 1178 CGBuilderTy &Builder = CGF.Builder; 1179 1180 unsigned AS = getThisAddress(CGF).getAddressSpace(); 1181 llvm::Value *Int8This = nullptr; // Initialize lazily. 1182 1183 for (VBOffsets::const_iterator I = VBaseMap.begin(), E = VBaseMap.end(); 1184 I != E; ++I) { 1185 if (!I->second.hasVtorDisp()) 1186 continue; 1187 1188 llvm::Value *VBaseOffset = 1189 GetVirtualBaseClassOffset(CGF, getThisAddress(CGF), RD, I->first); 1190 uint64_t ConstantVBaseOffset = 1191 Layout.getVBaseClassOffset(I->first).getQuantity(); 1192 1193 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase). 1194 llvm::Value *VtorDispValue = Builder.CreateSub( 1195 VBaseOffset, llvm::ConstantInt::get(CGM.PtrDiffTy, ConstantVBaseOffset), 1196 "vtordisp.value"); 1197 VtorDispValue = Builder.CreateTruncOrBitCast(VtorDispValue, CGF.Int32Ty); 1198 1199 if (!Int8This) 1200 Int8This = Builder.CreateBitCast(getThisValue(CGF), 1201 CGF.Int8Ty->getPointerTo(AS)); 1202 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset); 1203 // vtorDisp is always the 32-bits before the vbase in the class layout. 1204 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4); 1205 VtorDispPtr = Builder.CreateBitCast( 1206 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr"); 1207 1208 Builder.CreateAlignedStore(VtorDispValue, VtorDispPtr, 1209 CharUnits::fromQuantity(4)); 1210 } 1211 } 1212 1213 static bool hasDefaultCXXMethodCC(ASTContext &Context, 1214 const CXXMethodDecl *MD) { 1215 CallingConv ExpectedCallingConv = Context.getDefaultCallingConvention( 1216 /*IsVariadic=*/false, /*IsCXXMethod=*/true); 1217 CallingConv ActualCallingConv = 1218 MD->getType()->getAs<FunctionProtoType>()->getCallConv(); 1219 return ExpectedCallingConv == ActualCallingConv; 1220 } 1221 1222 void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) { 1223 // There's only one constructor type in this ABI. 1224 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete)); 1225 1226 // Exported default constructors either have a simple call-site where they use 1227 // the typical calling convention and have a single 'this' pointer for an 1228 // argument -or- they get a wrapper function which appropriately thunks to the 1229 // real default constructor. This thunk is the default constructor closure. 1230 if (D->hasAttr<DLLExportAttr>() && D->isDefaultConstructor()) 1231 if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) { 1232 llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure); 1233 Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage); 1234 Fn->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass); 1235 } 1236 } 1237 1238 void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF, 1239 const CXXRecordDecl *RD) { 1240 Address This = getThisAddress(CGF); 1241 This = CGF.Builder.CreateElementBitCast(This, CGM.Int8Ty, "this.int8"); 1242 const ASTContext &Context = getContext(); 1243 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD); 1244 1245 const VBTableGlobals &VBGlobals = enumerateVBTables(RD); 1246 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) { 1247 const std::unique_ptr<VPtrInfo> &VBT = (*VBGlobals.VBTables)[I]; 1248 llvm::GlobalVariable *GV = VBGlobals.Globals[I]; 1249 const ASTRecordLayout &SubobjectLayout = 1250 Context.getASTRecordLayout(VBT->IntroducingObject); 1251 CharUnits Offs = VBT->NonVirtualOffset; 1252 Offs += SubobjectLayout.getVBPtrOffset(); 1253 if (VBT->getVBaseWithVPtr()) 1254 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr()); 1255 Address VBPtr = CGF.Builder.CreateConstInBoundsByteGEP(This, Offs); 1256 llvm::Value *GVPtr = 1257 CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0); 1258 VBPtr = CGF.Builder.CreateElementBitCast(VBPtr, GVPtr->getType(), 1259 "vbptr." + VBT->ObjectWithVPtr->getName()); 1260 CGF.Builder.CreateStore(GVPtr, VBPtr); 1261 } 1262 } 1263 1264 CGCXXABI::AddedStructorArgs 1265 MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T, 1266 SmallVectorImpl<CanQualType> &ArgTys) { 1267 AddedStructorArgs Added; 1268 // TODO: 'for base' flag 1269 if (T == StructorType::Deleting) { 1270 // The scalar deleting destructor takes an implicit int parameter. 1271 ArgTys.push_back(getContext().IntTy); 1272 ++Added.Suffix; 1273 } 1274 auto *CD = dyn_cast<CXXConstructorDecl>(MD); 1275 if (!CD) 1276 return Added; 1277 1278 // All parameters are already in place except is_most_derived, which goes 1279 // after 'this' if it's variadic and last if it's not. 1280 1281 const CXXRecordDecl *Class = CD->getParent(); 1282 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>(); 1283 if (Class->getNumVBases()) { 1284 if (FPT->isVariadic()) { 1285 ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy); 1286 ++Added.Prefix; 1287 } else { 1288 ArgTys.push_back(getContext().IntTy); 1289 ++Added.Suffix; 1290 } 1291 } 1292 1293 return Added; 1294 } 1295 1296 void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) { 1297 // The TU defining a dtor is only guaranteed to emit a base destructor. All 1298 // other destructor variants are delegating thunks. 1299 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base)); 1300 } 1301 1302 CharUnits 1303 MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) { 1304 GD = GD.getCanonicalDecl(); 1305 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl()); 1306 1307 GlobalDecl LookupGD = GD; 1308 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) { 1309 // Complete destructors take a pointer to the complete object as a 1310 // parameter, thus don't need this adjustment. 1311 if (GD.getDtorType() == Dtor_Complete) 1312 return CharUnits(); 1313 1314 // There's no Dtor_Base in vftable but it shares the this adjustment with 1315 // the deleting one, so look it up instead. 1316 LookupGD = GlobalDecl(DD, Dtor_Deleting); 1317 } 1318 1319 MicrosoftVTableContext::MethodVFTableLocation ML = 1320 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD); 1321 CharUnits Adjustment = ML.VFPtrOffset; 1322 1323 // Normal virtual instance methods need to adjust from the vfptr that first 1324 // defined the virtual method to the virtual base subobject, but destructors 1325 // do not. The vector deleting destructor thunk applies this adjustment for 1326 // us if necessary. 1327 if (isa<CXXDestructorDecl>(MD)) 1328 Adjustment = CharUnits::Zero(); 1329 1330 if (ML.VBase) { 1331 const ASTRecordLayout &DerivedLayout = 1332 getContext().getASTRecordLayout(MD->getParent()); 1333 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase); 1334 } 1335 1336 return Adjustment; 1337 } 1338 1339 Address MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall( 1340 CodeGenFunction &CGF, GlobalDecl GD, Address This, 1341 bool VirtualCall) { 1342 if (!VirtualCall) { 1343 // If the call of a virtual function is not virtual, we just have to 1344 // compensate for the adjustment the virtual function does in its prologue. 1345 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD); 1346 if (Adjustment.isZero()) 1347 return This; 1348 1349 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty); 1350 assert(Adjustment.isPositive()); 1351 return CGF.Builder.CreateConstByteGEP(This, Adjustment); 1352 } 1353 1354 GD = GD.getCanonicalDecl(); 1355 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl()); 1356 1357 GlobalDecl LookupGD = GD; 1358 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) { 1359 // Complete dtors take a pointer to the complete object, 1360 // thus don't need adjustment. 1361 if (GD.getDtorType() == Dtor_Complete) 1362 return This; 1363 1364 // There's only Dtor_Deleting in vftable but it shares the this adjustment 1365 // with the base one, so look up the deleting one instead. 1366 LookupGD = GlobalDecl(DD, Dtor_Deleting); 1367 } 1368 MicrosoftVTableContext::MethodVFTableLocation ML = 1369 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD); 1370 1371 CharUnits StaticOffset = ML.VFPtrOffset; 1372 1373 // Base destructors expect 'this' to point to the beginning of the base 1374 // subobject, not the first vfptr that happens to contain the virtual dtor. 1375 // However, we still need to apply the virtual base adjustment. 1376 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base) 1377 StaticOffset = CharUnits::Zero(); 1378 1379 Address Result = This; 1380 if (ML.VBase) { 1381 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty); 1382 1383 const CXXRecordDecl *Derived = MD->getParent(); 1384 const CXXRecordDecl *VBase = ML.VBase; 1385 llvm::Value *VBaseOffset = 1386 GetVirtualBaseClassOffset(CGF, Result, Derived, VBase); 1387 llvm::Value *VBasePtr = 1388 CGF.Builder.CreateInBoundsGEP(Result.getPointer(), VBaseOffset); 1389 CharUnits VBaseAlign = 1390 CGF.CGM.getVBaseAlignment(Result.getAlignment(), Derived, VBase); 1391 Result = Address(VBasePtr, VBaseAlign); 1392 } 1393 if (!StaticOffset.isZero()) { 1394 assert(StaticOffset.isPositive()); 1395 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty); 1396 if (ML.VBase) { 1397 // Non-virtual adjustment might result in a pointer outside the allocated 1398 // object, e.g. if the final overrider class is laid out after the virtual 1399 // base that declares a method in the most derived class. 1400 // FIXME: Update the code that emits this adjustment in thunks prologues. 1401 Result = CGF.Builder.CreateConstByteGEP(Result, StaticOffset); 1402 } else { 1403 Result = CGF.Builder.CreateConstInBoundsByteGEP(Result, StaticOffset); 1404 } 1405 } 1406 return Result; 1407 } 1408 1409 void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF, 1410 QualType &ResTy, 1411 FunctionArgList &Params) { 1412 ASTContext &Context = getContext(); 1413 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl()); 1414 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)); 1415 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) { 1416 ImplicitParamDecl *IsMostDerived 1417 = ImplicitParamDecl::Create(Context, nullptr, 1418 CGF.CurGD.getDecl()->getLocation(), 1419 &Context.Idents.get("is_most_derived"), 1420 Context.IntTy); 1421 // The 'most_derived' parameter goes second if the ctor is variadic and last 1422 // if it's not. Dtors can't be variadic. 1423 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>(); 1424 if (FPT->isVariadic()) 1425 Params.insert(Params.begin() + 1, IsMostDerived); 1426 else 1427 Params.push_back(IsMostDerived); 1428 getStructorImplicitParamDecl(CGF) = IsMostDerived; 1429 } else if (isDeletingDtor(CGF.CurGD)) { 1430 ImplicitParamDecl *ShouldDelete 1431 = ImplicitParamDecl::Create(Context, nullptr, 1432 CGF.CurGD.getDecl()->getLocation(), 1433 &Context.Idents.get("should_call_delete"), 1434 Context.IntTy); 1435 Params.push_back(ShouldDelete); 1436 getStructorImplicitParamDecl(CGF) = ShouldDelete; 1437 } 1438 } 1439 1440 llvm::Value *MicrosoftCXXABI::adjustThisParameterInVirtualFunctionPrologue( 1441 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) { 1442 // In this ABI, every virtual function takes a pointer to one of the 1443 // subobjects that first defines it as the 'this' parameter, rather than a 1444 // pointer to the final overrider subobject. Thus, we need to adjust it back 1445 // to the final overrider subobject before use. 1446 // See comments in the MicrosoftVFTableContext implementation for the details. 1447 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD); 1448 if (Adjustment.isZero()) 1449 return This; 1450 1451 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace(); 1452 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS), 1453 *thisTy = This->getType(); 1454 1455 This = CGF.Builder.CreateBitCast(This, charPtrTy); 1456 assert(Adjustment.isPositive()); 1457 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This, 1458 -Adjustment.getQuantity()); 1459 return CGF.Builder.CreateBitCast(This, thisTy); 1460 } 1461 1462 void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) { 1463 // Naked functions have no prolog. 1464 if (CGF.CurFuncDecl && CGF.CurFuncDecl->hasAttr<NakedAttr>()) 1465 return; 1466 1467 EmitThisParam(CGF); 1468 1469 /// If this is a function that the ABI specifies returns 'this', initialize 1470 /// the return slot to 'this' at the start of the function. 1471 /// 1472 /// Unlike the setting of return types, this is done within the ABI 1473 /// implementation instead of by clients of CGCXXABI because: 1474 /// 1) getThisValue is currently protected 1475 /// 2) in theory, an ABI could implement 'this' returns some other way; 1476 /// HasThisReturn only specifies a contract, not the implementation 1477 if (HasThisReturn(CGF.CurGD)) 1478 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue); 1479 else if (hasMostDerivedReturn(CGF.CurGD)) 1480 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)), 1481 CGF.ReturnValue); 1482 1483 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl()); 1484 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) { 1485 assert(getStructorImplicitParamDecl(CGF) && 1486 "no implicit parameter for a constructor with virtual bases?"); 1487 getStructorImplicitParamValue(CGF) 1488 = CGF.Builder.CreateLoad( 1489 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)), 1490 "is_most_derived"); 1491 } 1492 1493 if (isDeletingDtor(CGF.CurGD)) { 1494 assert(getStructorImplicitParamDecl(CGF) && 1495 "no implicit parameter for a deleting destructor?"); 1496 getStructorImplicitParamValue(CGF) 1497 = CGF.Builder.CreateLoad( 1498 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)), 1499 "should_call_delete"); 1500 } 1501 } 1502 1503 CGCXXABI::AddedStructorArgs MicrosoftCXXABI::addImplicitConstructorArgs( 1504 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type, 1505 bool ForVirtualBase, bool Delegating, CallArgList &Args) { 1506 assert(Type == Ctor_Complete || Type == Ctor_Base); 1507 1508 // Check if we need a 'most_derived' parameter. 1509 if (!D->getParent()->getNumVBases()) 1510 return AddedStructorArgs{}; 1511 1512 // Add the 'most_derived' argument second if we are variadic or last if not. 1513 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>(); 1514 llvm::Value *MostDerivedArg; 1515 if (Delegating) { 1516 MostDerivedArg = getStructorImplicitParamValue(CGF); 1517 } else { 1518 MostDerivedArg = llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete); 1519 } 1520 RValue RV = RValue::get(MostDerivedArg); 1521 if (FPT->isVariadic()) { 1522 Args.insert(Args.begin() + 1, 1523 CallArg(RV, getContext().IntTy, /*needscopy=*/false)); 1524 return AddedStructorArgs::prefix(1); 1525 } 1526 Args.add(RV, getContext().IntTy); 1527 return AddedStructorArgs::suffix(1); 1528 } 1529 1530 void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF, 1531 const CXXDestructorDecl *DD, 1532 CXXDtorType Type, bool ForVirtualBase, 1533 bool Delegating, Address This) { 1534 CGCallee Callee = CGCallee::forDirect( 1535 CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type)), 1536 DD); 1537 1538 if (DD->isVirtual()) { 1539 assert(Type != CXXDtorType::Dtor_Deleting && 1540 "The deleting destructor should only be called via a virtual call"); 1541 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type), 1542 This, false); 1543 } 1544 1545 llvm::BasicBlock *BaseDtorEndBB = nullptr; 1546 if (ForVirtualBase && isa<CXXConstructorDecl>(CGF.CurCodeDecl)) { 1547 BaseDtorEndBB = EmitDtorCompleteObjectHandler(CGF); 1548 } 1549 1550 CGF.EmitCXXDestructorCall(DD, Callee, This.getPointer(), 1551 /*ImplicitParam=*/nullptr, 1552 /*ImplicitParamTy=*/QualType(), nullptr, 1553 getFromDtorType(Type)); 1554 if (BaseDtorEndBB) { 1555 // Complete object handler should continue to be the remaining 1556 CGF.Builder.CreateBr(BaseDtorEndBB); 1557 CGF.EmitBlock(BaseDtorEndBB); 1558 } 1559 } 1560 1561 void MicrosoftCXXABI::emitVTableTypeMetadata(const VPtrInfo &Info, 1562 const CXXRecordDecl *RD, 1563 llvm::GlobalVariable *VTable) { 1564 if (!CGM.getCodeGenOpts().LTOUnit) 1565 return; 1566 1567 // The location of the first virtual function pointer in the virtual table, 1568 // aka the "address point" on Itanium. This is at offset 0 if RTTI is 1569 // disabled, or sizeof(void*) if RTTI is enabled. 1570 CharUnits AddressPoint = 1571 getContext().getLangOpts().RTTIData 1572 ? getContext().toCharUnitsFromBits( 1573 getContext().getTargetInfo().getPointerWidth(0)) 1574 : CharUnits::Zero(); 1575 1576 if (Info.PathToIntroducingObject.empty()) { 1577 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD); 1578 return; 1579 } 1580 1581 // Add a bitset entry for the least derived base belonging to this vftable. 1582 CGM.AddVTableTypeMetadata(VTable, AddressPoint, 1583 Info.PathToIntroducingObject.back()); 1584 1585 // Add a bitset entry for each derived class that is laid out at the same 1586 // offset as the least derived base. 1587 for (unsigned I = Info.PathToIntroducingObject.size() - 1; I != 0; --I) { 1588 const CXXRecordDecl *DerivedRD = Info.PathToIntroducingObject[I - 1]; 1589 const CXXRecordDecl *BaseRD = Info.PathToIntroducingObject[I]; 1590 1591 const ASTRecordLayout &Layout = 1592 getContext().getASTRecordLayout(DerivedRD); 1593 CharUnits Offset; 1594 auto VBI = Layout.getVBaseOffsetsMap().find(BaseRD); 1595 if (VBI == Layout.getVBaseOffsetsMap().end()) 1596 Offset = Layout.getBaseClassOffset(BaseRD); 1597 else 1598 Offset = VBI->second.VBaseOffset; 1599 if (!Offset.isZero()) 1600 return; 1601 CGM.AddVTableTypeMetadata(VTable, AddressPoint, DerivedRD); 1602 } 1603 1604 // Finally do the same for the most derived class. 1605 if (Info.FullOffsetInMDC.isZero()) 1606 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD); 1607 } 1608 1609 void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT, 1610 const CXXRecordDecl *RD) { 1611 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext(); 1612 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD); 1613 1614 for (const std::unique_ptr<VPtrInfo>& Info : VFPtrs) { 1615 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC); 1616 if (VTable->hasInitializer()) 1617 continue; 1618 1619 const VTableLayout &VTLayout = 1620 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC); 1621 1622 llvm::Constant *RTTI = nullptr; 1623 if (any_of(VTLayout.vtable_components(), 1624 [](const VTableComponent &VTC) { return VTC.isRTTIKind(); })) 1625 RTTI = getMSCompleteObjectLocator(RD, *Info); 1626 1627 ConstantInitBuilder Builder(CGM); 1628 auto Components = Builder.beginStruct(); 1629 CGVT.createVTableInitializer(Components, VTLayout, RTTI); 1630 Components.finishAndSetAsInitializer(VTable); 1631 1632 emitVTableTypeMetadata(*Info, RD, VTable); 1633 } 1634 } 1635 1636 bool MicrosoftCXXABI::isVirtualOffsetNeededForVTableField( 1637 CodeGenFunction &CGF, CodeGenFunction::VPtr Vptr) { 1638 return Vptr.NearestVBase != nullptr; 1639 } 1640 1641 llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor( 1642 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base, 1643 const CXXRecordDecl *NearestVBase) { 1644 llvm::Constant *VTableAddressPoint = getVTableAddressPoint(Base, VTableClass); 1645 if (!VTableAddressPoint) { 1646 assert(Base.getBase()->getNumVBases() && 1647 !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr()); 1648 } 1649 return VTableAddressPoint; 1650 } 1651 1652 static void mangleVFTableName(MicrosoftMangleContext &MangleContext, 1653 const CXXRecordDecl *RD, const VPtrInfo &VFPtr, 1654 SmallString<256> &Name) { 1655 llvm::raw_svector_ostream Out(Name); 1656 MangleContext.mangleCXXVFTable(RD, VFPtr.MangledPath, Out); 1657 } 1658 1659 llvm::Constant * 1660 MicrosoftCXXABI::getVTableAddressPoint(BaseSubobject Base, 1661 const CXXRecordDecl *VTableClass) { 1662 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset()); 1663 VFTableIdTy ID(VTableClass, Base.getBaseOffset()); 1664 return VFTablesMap[ID]; 1665 } 1666 1667 llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr( 1668 BaseSubobject Base, const CXXRecordDecl *VTableClass) { 1669 llvm::Constant *VFTable = getVTableAddressPoint(Base, VTableClass); 1670 assert(VFTable && "Couldn't find a vftable for the given base?"); 1671 return VFTable; 1672 } 1673 1674 llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD, 1675 CharUnits VPtrOffset) { 1676 // getAddrOfVTable may return 0 if asked to get an address of a vtable which 1677 // shouldn't be used in the given record type. We want to cache this result in 1678 // VFTablesMap, thus a simple zero check is not sufficient. 1679 1680 VFTableIdTy ID(RD, VPtrOffset); 1681 VTablesMapTy::iterator I; 1682 bool Inserted; 1683 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr)); 1684 if (!Inserted) 1685 return I->second; 1686 1687 llvm::GlobalVariable *&VTable = I->second; 1688 1689 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext(); 1690 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD); 1691 1692 if (DeferredVFTables.insert(RD).second) { 1693 // We haven't processed this record type before. 1694 // Queue up this vtable for possible deferred emission. 1695 CGM.addDeferredVTable(RD); 1696 1697 #ifndef NDEBUG 1698 // Create all the vftables at once in order to make sure each vftable has 1699 // a unique mangled name. 1700 llvm::StringSet<> ObservedMangledNames; 1701 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) { 1702 SmallString<256> Name; 1703 mangleVFTableName(getMangleContext(), RD, *VFPtrs[J], Name); 1704 if (!ObservedMangledNames.insert(Name.str()).second) 1705 llvm_unreachable("Already saw this mangling before?"); 1706 } 1707 #endif 1708 } 1709 1710 const std::unique_ptr<VPtrInfo> *VFPtrI = std::find_if( 1711 VFPtrs.begin(), VFPtrs.end(), [&](const std::unique_ptr<VPtrInfo>& VPI) { 1712 return VPI->FullOffsetInMDC == VPtrOffset; 1713 }); 1714 if (VFPtrI == VFPtrs.end()) { 1715 VFTablesMap[ID] = nullptr; 1716 return nullptr; 1717 } 1718 const std::unique_ptr<VPtrInfo> &VFPtr = *VFPtrI; 1719 1720 SmallString<256> VFTableName; 1721 mangleVFTableName(getMangleContext(), RD, *VFPtr, VFTableName); 1722 1723 // Classes marked __declspec(dllimport) need vftables generated on the 1724 // import-side in order to support features like constexpr. No other 1725 // translation unit relies on the emission of the local vftable, translation 1726 // units are expected to generate them as needed. 1727 // 1728 // Because of this unique behavior, we maintain this logic here instead of 1729 // getVTableLinkage. 1730 llvm::GlobalValue::LinkageTypes VFTableLinkage = 1731 RD->hasAttr<DLLImportAttr>() ? llvm::GlobalValue::LinkOnceODRLinkage 1732 : CGM.getVTableLinkage(RD); 1733 bool VFTableComesFromAnotherTU = 1734 llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) || 1735 llvm::GlobalValue::isExternalLinkage(VFTableLinkage); 1736 bool VTableAliasIsRequred = 1737 !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData; 1738 1739 if (llvm::GlobalValue *VFTable = 1740 CGM.getModule().getNamedGlobal(VFTableName)) { 1741 VFTablesMap[ID] = VFTable; 1742 VTable = VTableAliasIsRequred 1743 ? cast<llvm::GlobalVariable>( 1744 cast<llvm::GlobalAlias>(VFTable)->getBaseObject()) 1745 : cast<llvm::GlobalVariable>(VFTable); 1746 return VTable; 1747 } 1748 1749 const VTableLayout &VTLayout = 1750 VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC); 1751 llvm::GlobalValue::LinkageTypes VTableLinkage = 1752 VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage; 1753 1754 StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str(); 1755 1756 llvm::Type *VTableType = CGM.getVTables().getVTableType(VTLayout); 1757 1758 // Create a backing variable for the contents of VTable. The VTable may 1759 // or may not include space for a pointer to RTTI data. 1760 llvm::GlobalValue *VFTable; 1761 VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType, 1762 /*isConstant=*/true, VTableLinkage, 1763 /*Initializer=*/nullptr, VTableName); 1764 VTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global); 1765 1766 llvm::Comdat *C = nullptr; 1767 if (!VFTableComesFromAnotherTU && 1768 (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) || 1769 (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) && 1770 VTableAliasIsRequred))) 1771 C = CGM.getModule().getOrInsertComdat(VFTableName.str()); 1772 1773 // Only insert a pointer into the VFTable for RTTI data if we are not 1774 // importing it. We never reference the RTTI data directly so there is no 1775 // need to make room for it. 1776 if (VTableAliasIsRequred) { 1777 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.Int32Ty, 0), 1778 llvm::ConstantInt::get(CGM.Int32Ty, 0), 1779 llvm::ConstantInt::get(CGM.Int32Ty, 1)}; 1780 // Create a GEP which points just after the first entry in the VFTable, 1781 // this should be the location of the first virtual method. 1782 llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr( 1783 VTable->getValueType(), VTable, GEPIndices); 1784 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) { 1785 VFTableLinkage = llvm::GlobalValue::ExternalLinkage; 1786 if (C) 1787 C->setSelectionKind(llvm::Comdat::Largest); 1788 } 1789 VFTable = llvm::GlobalAlias::create(CGM.Int8PtrTy, 1790 /*AddressSpace=*/0, VFTableLinkage, 1791 VFTableName.str(), VTableGEP, 1792 &CGM.getModule()); 1793 VFTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global); 1794 } else { 1795 // We don't need a GlobalAlias to be a symbol for the VTable if we won't 1796 // be referencing any RTTI data. 1797 // The GlobalVariable will end up being an appropriate definition of the 1798 // VFTable. 1799 VFTable = VTable; 1800 } 1801 if (C) 1802 VTable->setComdat(C); 1803 1804 if (RD->hasAttr<DLLExportAttr>()) 1805 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass); 1806 1807 VFTablesMap[ID] = VFTable; 1808 return VTable; 1809 } 1810 1811 CGCallee MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF, 1812 GlobalDecl GD, 1813 Address This, 1814 llvm::Type *Ty, 1815 SourceLocation Loc) { 1816 GD = GD.getCanonicalDecl(); 1817 CGBuilderTy &Builder = CGF.Builder; 1818 1819 Ty = Ty->getPointerTo()->getPointerTo(); 1820 Address VPtr = 1821 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true); 1822 1823 auto *MethodDecl = cast<CXXMethodDecl>(GD.getDecl()); 1824 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty, MethodDecl->getParent()); 1825 1826 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext(); 1827 MicrosoftVTableContext::MethodVFTableLocation ML = 1828 VFTContext.getMethodVFTableLocation(GD); 1829 1830 // Compute the identity of the most derived class whose virtual table is 1831 // located at the MethodVFTableLocation ML. 1832 auto getObjectWithVPtr = [&] { 1833 return llvm::find_if(VFTContext.getVFPtrOffsets( 1834 ML.VBase ? ML.VBase : MethodDecl->getParent()), 1835 [&](const std::unique_ptr<VPtrInfo> &Info) { 1836 return Info->FullOffsetInMDC == ML.VFPtrOffset; 1837 }) 1838 ->get() 1839 ->ObjectWithVPtr; 1840 }; 1841 1842 llvm::Value *VFunc; 1843 if (CGF.ShouldEmitVTableTypeCheckedLoad(MethodDecl->getParent())) { 1844 VFunc = CGF.EmitVTableTypeCheckedLoad( 1845 getObjectWithVPtr(), VTable, 1846 ML.Index * CGM.getContext().getTargetInfo().getPointerWidth(0) / 8); 1847 } else { 1848 if (CGM.getCodeGenOpts().PrepareForLTO) 1849 CGF.EmitTypeMetadataCodeForVCall(getObjectWithVPtr(), VTable, Loc); 1850 1851 llvm::Value *VFuncPtr = 1852 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn"); 1853 VFunc = Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign()); 1854 } 1855 1856 CGCallee Callee(MethodDecl, VFunc); 1857 return Callee; 1858 } 1859 1860 llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall( 1861 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType, 1862 Address This, const CXXMemberCallExpr *CE) { 1863 assert(CE == nullptr || CE->arg_begin() == CE->arg_end()); 1864 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete); 1865 1866 // We have only one destructor in the vftable but can get both behaviors 1867 // by passing an implicit int parameter. 1868 GlobalDecl GD(Dtor, Dtor_Deleting); 1869 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration( 1870 Dtor, StructorType::Deleting); 1871 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo); 1872 CGCallee Callee = getVirtualFunctionPointer( 1873 CGF, GD, This, Ty, CE ? CE->getLocStart() : SourceLocation()); 1874 1875 ASTContext &Context = getContext(); 1876 llvm::Value *ImplicitParam = llvm::ConstantInt::get( 1877 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()), 1878 DtorType == Dtor_Deleting); 1879 1880 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true); 1881 RValue RV = 1882 CGF.EmitCXXDestructorCall(Dtor, Callee, This.getPointer(), ImplicitParam, 1883 Context.IntTy, CE, StructorType::Deleting); 1884 return RV.getScalarVal(); 1885 } 1886 1887 const VBTableGlobals & 1888 MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) { 1889 // At this layer, we can key the cache off of a single class, which is much 1890 // easier than caching each vbtable individually. 1891 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry; 1892 bool Added; 1893 std::tie(Entry, Added) = 1894 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals())); 1895 VBTableGlobals &VBGlobals = Entry->second; 1896 if (!Added) 1897 return VBGlobals; 1898 1899 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext(); 1900 VBGlobals.VBTables = &Context.enumerateVBTables(RD); 1901 1902 // Cache the globals for all vbtables so we don't have to recompute the 1903 // mangled names. 1904 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD); 1905 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(), 1906 E = VBGlobals.VBTables->end(); 1907 I != E; ++I) { 1908 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage)); 1909 } 1910 1911 return VBGlobals; 1912 } 1913 1914 llvm::Function *MicrosoftCXXABI::EmitVirtualMemPtrThunk( 1915 const CXXMethodDecl *MD, 1916 const MicrosoftVTableContext::MethodVFTableLocation &ML) { 1917 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) && 1918 "can't form pointers to ctors or virtual dtors"); 1919 1920 // Calculate the mangled name. 1921 SmallString<256> ThunkName; 1922 llvm::raw_svector_ostream Out(ThunkName); 1923 getMangleContext().mangleVirtualMemPtrThunk(MD, Out); 1924 1925 // If the thunk has been generated previously, just return it. 1926 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName)) 1927 return cast<llvm::Function>(GV); 1928 1929 // Create the llvm::Function. 1930 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSMemberPointerThunk(MD); 1931 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo); 1932 llvm::Function *ThunkFn = 1933 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage, 1934 ThunkName.str(), &CGM.getModule()); 1935 assert(ThunkFn->getName() == ThunkName && "name was uniqued!"); 1936 1937 ThunkFn->setLinkage(MD->isExternallyVisible() 1938 ? llvm::GlobalValue::LinkOnceODRLinkage 1939 : llvm::GlobalValue::InternalLinkage); 1940 if (MD->isExternallyVisible()) 1941 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName())); 1942 1943 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn); 1944 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn); 1945 1946 // Add the "thunk" attribute so that LLVM knows that the return type is 1947 // meaningless. These thunks can be used to call functions with differing 1948 // return types, and the caller is required to cast the prototype 1949 // appropriately to extract the correct value. 1950 ThunkFn->addFnAttr("thunk"); 1951 1952 // These thunks can be compared, so they are not unnamed. 1953 ThunkFn->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::None); 1954 1955 // Start codegen. 1956 CodeGenFunction CGF(CGM); 1957 CGF.CurGD = GlobalDecl(MD); 1958 CGF.CurFuncIsThunk = true; 1959 1960 // Build FunctionArgs, but only include the implicit 'this' parameter 1961 // declaration. 1962 FunctionArgList FunctionArgs; 1963 buildThisParam(CGF, FunctionArgs); 1964 1965 // Start defining the function. 1966 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo, 1967 FunctionArgs, MD->getLocation(), SourceLocation()); 1968 EmitThisParam(CGF); 1969 1970 // Load the vfptr and then callee from the vftable. The callee should have 1971 // adjusted 'this' so that the vfptr is at offset zero. 1972 llvm::Value *VTable = CGF.GetVTablePtr( 1973 getThisAddress(CGF), ThunkTy->getPointerTo()->getPointerTo(), MD->getParent()); 1974 1975 llvm::Value *VFuncPtr = 1976 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn"); 1977 llvm::Value *Callee = 1978 CGF.Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign()); 1979 1980 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee); 1981 1982 return ThunkFn; 1983 } 1984 1985 void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) { 1986 const VBTableGlobals &VBGlobals = enumerateVBTables(RD); 1987 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) { 1988 const std::unique_ptr<VPtrInfo>& VBT = (*VBGlobals.VBTables)[I]; 1989 llvm::GlobalVariable *GV = VBGlobals.Globals[I]; 1990 if (GV->isDeclaration()) 1991 emitVBTableDefinition(*VBT, RD, GV); 1992 } 1993 } 1994 1995 llvm::GlobalVariable * 1996 MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD, 1997 llvm::GlobalVariable::LinkageTypes Linkage) { 1998 SmallString<256> OutName; 1999 llvm::raw_svector_ostream Out(OutName); 2000 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out); 2001 StringRef Name = OutName.str(); 2002 2003 llvm::ArrayType *VBTableType = 2004 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ObjectWithVPtr->getNumVBases()); 2005 2006 assert(!CGM.getModule().getNamedGlobal(Name) && 2007 "vbtable with this name already exists: mangling bug?"); 2008 llvm::GlobalVariable *GV = 2009 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage); 2010 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global); 2011 2012 if (RD->hasAttr<DLLImportAttr>()) 2013 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass); 2014 else if (RD->hasAttr<DLLExportAttr>()) 2015 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass); 2016 2017 if (!GV->hasExternalLinkage()) 2018 emitVBTableDefinition(VBT, RD, GV); 2019 2020 return GV; 2021 } 2022 2023 void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT, 2024 const CXXRecordDecl *RD, 2025 llvm::GlobalVariable *GV) const { 2026 const CXXRecordDecl *ObjectWithVPtr = VBT.ObjectWithVPtr; 2027 2028 assert(RD->getNumVBases() && ObjectWithVPtr->getNumVBases() && 2029 "should only emit vbtables for classes with vbtables"); 2030 2031 const ASTRecordLayout &BaseLayout = 2032 getContext().getASTRecordLayout(VBT.IntroducingObject); 2033 const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD); 2034 2035 SmallVector<llvm::Constant *, 4> Offsets(1 + ObjectWithVPtr->getNumVBases(), 2036 nullptr); 2037 2038 // The offset from ObjectWithVPtr's vbptr to itself always leads. 2039 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset(); 2040 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity()); 2041 2042 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext(); 2043 for (const auto &I : ObjectWithVPtr->vbases()) { 2044 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl(); 2045 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase); 2046 assert(!Offset.isNegative()); 2047 2048 // Make it relative to the subobject vbptr. 2049 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset; 2050 if (VBT.getVBaseWithVPtr()) 2051 CompleteVBPtrOffset += 2052 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr()); 2053 Offset -= CompleteVBPtrOffset; 2054 2055 unsigned VBIndex = Context.getVBTableIndex(ObjectWithVPtr, VBase); 2056 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?"); 2057 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity()); 2058 } 2059 2060 assert(Offsets.size() == 2061 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType()) 2062 ->getElementType())->getNumElements()); 2063 llvm::ArrayType *VBTableType = 2064 llvm::ArrayType::get(CGM.IntTy, Offsets.size()); 2065 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets); 2066 GV->setInitializer(Init); 2067 2068 if (RD->hasAttr<DLLImportAttr>()) 2069 GV->setLinkage(llvm::GlobalVariable::AvailableExternallyLinkage); 2070 } 2071 2072 llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF, 2073 Address This, 2074 const ThisAdjustment &TA) { 2075 if (TA.isEmpty()) 2076 return This.getPointer(); 2077 2078 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty); 2079 2080 llvm::Value *V; 2081 if (TA.Virtual.isEmpty()) { 2082 V = This.getPointer(); 2083 } else { 2084 assert(TA.Virtual.Microsoft.VtordispOffset < 0); 2085 // Adjust the this argument based on the vtordisp value. 2086 Address VtorDispPtr = 2087 CGF.Builder.CreateConstInBoundsByteGEP(This, 2088 CharUnits::fromQuantity(TA.Virtual.Microsoft.VtordispOffset)); 2089 VtorDispPtr = CGF.Builder.CreateElementBitCast(VtorDispPtr, CGF.Int32Ty); 2090 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp"); 2091 V = CGF.Builder.CreateGEP(This.getPointer(), 2092 CGF.Builder.CreateNeg(VtorDisp)); 2093 2094 // Unfortunately, having applied the vtordisp means that we no 2095 // longer really have a known alignment for the vbptr step. 2096 // We'll assume the vbptr is pointer-aligned. 2097 2098 if (TA.Virtual.Microsoft.VBPtrOffset) { 2099 // If the final overrider is defined in a virtual base other than the one 2100 // that holds the vfptr, we have to use a vtordispex thunk which looks up 2101 // the vbtable of the derived class. 2102 assert(TA.Virtual.Microsoft.VBPtrOffset > 0); 2103 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0); 2104 llvm::Value *VBPtr; 2105 llvm::Value *VBaseOffset = 2106 GetVBaseOffsetFromVBPtr(CGF, Address(V, CGF.getPointerAlign()), 2107 -TA.Virtual.Microsoft.VBPtrOffset, 2108 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr); 2109 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset); 2110 } 2111 } 2112 2113 if (TA.NonVirtual) { 2114 // Non-virtual adjustment might result in a pointer outside the allocated 2115 // object, e.g. if the final overrider class is laid out after the virtual 2116 // base that declares a method in the most derived class. 2117 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual); 2118 } 2119 2120 // Don't need to bitcast back, the call CodeGen will handle this. 2121 return V; 2122 } 2123 2124 llvm::Value * 2125 MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, Address Ret, 2126 const ReturnAdjustment &RA) { 2127 if (RA.isEmpty()) 2128 return Ret.getPointer(); 2129 2130 auto OrigTy = Ret.getType(); 2131 Ret = CGF.Builder.CreateElementBitCast(Ret, CGF.Int8Ty); 2132 2133 llvm::Value *V = Ret.getPointer(); 2134 if (RA.Virtual.Microsoft.VBIndex) { 2135 assert(RA.Virtual.Microsoft.VBIndex > 0); 2136 int32_t IntSize = CGF.getIntSize().getQuantity(); 2137 llvm::Value *VBPtr; 2138 llvm::Value *VBaseOffset = 2139 GetVBaseOffsetFromVBPtr(CGF, Ret, RA.Virtual.Microsoft.VBPtrOffset, 2140 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr); 2141 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset); 2142 } 2143 2144 if (RA.NonVirtual) 2145 V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual); 2146 2147 // Cast back to the original type. 2148 return CGF.Builder.CreateBitCast(V, OrigTy); 2149 } 2150 2151 bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr, 2152 QualType elementType) { 2153 // Microsoft seems to completely ignore the possibility of a 2154 // two-argument usual deallocation function. 2155 return elementType.isDestructedType(); 2156 } 2157 2158 bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) { 2159 // Microsoft seems to completely ignore the possibility of a 2160 // two-argument usual deallocation function. 2161 return expr->getAllocatedType().isDestructedType(); 2162 } 2163 2164 CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) { 2165 // The array cookie is always a size_t; we then pad that out to the 2166 // alignment of the element type. 2167 ASTContext &Ctx = getContext(); 2168 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()), 2169 Ctx.getTypeAlignInChars(type)); 2170 } 2171 2172 llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF, 2173 Address allocPtr, 2174 CharUnits cookieSize) { 2175 Address numElementsPtr = 2176 CGF.Builder.CreateElementBitCast(allocPtr, CGF.SizeTy); 2177 return CGF.Builder.CreateLoad(numElementsPtr); 2178 } 2179 2180 Address MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF, 2181 Address newPtr, 2182 llvm::Value *numElements, 2183 const CXXNewExpr *expr, 2184 QualType elementType) { 2185 assert(requiresArrayCookie(expr)); 2186 2187 // The size of the cookie. 2188 CharUnits cookieSize = getArrayCookieSizeImpl(elementType); 2189 2190 // Compute an offset to the cookie. 2191 Address cookiePtr = newPtr; 2192 2193 // Write the number of elements into the appropriate slot. 2194 Address numElementsPtr 2195 = CGF.Builder.CreateElementBitCast(cookiePtr, CGF.SizeTy); 2196 CGF.Builder.CreateStore(numElements, numElementsPtr); 2197 2198 // Finally, compute a pointer to the actual data buffer by skipping 2199 // over the cookie completely. 2200 return CGF.Builder.CreateConstInBoundsByteGEP(newPtr, cookieSize); 2201 } 2202 2203 static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD, 2204 llvm::Constant *Dtor, 2205 llvm::Constant *Addr) { 2206 // Create a function which calls the destructor. 2207 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr); 2208 2209 // extern "C" int __tlregdtor(void (*f)(void)); 2210 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get( 2211 CGF.IntTy, DtorStub->getType(), /*IsVarArg=*/false); 2212 2213 llvm::Constant *TLRegDtor = CGF.CGM.CreateRuntimeFunction( 2214 TLRegDtorTy, "__tlregdtor", llvm::AttributeList(), /*Local=*/true); 2215 if (llvm::Function *TLRegDtorFn = dyn_cast<llvm::Function>(TLRegDtor)) 2216 TLRegDtorFn->setDoesNotThrow(); 2217 2218 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub); 2219 } 2220 2221 void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D, 2222 llvm::Constant *Dtor, 2223 llvm::Constant *Addr) { 2224 if (D.getTLSKind()) 2225 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr); 2226 2227 // The default behavior is to use atexit. 2228 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr); 2229 } 2230 2231 void MicrosoftCXXABI::EmitThreadLocalInitFuncs( 2232 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals, 2233 ArrayRef<llvm::Function *> CXXThreadLocalInits, 2234 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) { 2235 if (CXXThreadLocalInits.empty()) 2236 return; 2237 2238 CGM.AppendLinkerOptions(CGM.getTarget().getTriple().getArch() == 2239 llvm::Triple::x86 2240 ? "/include:___dyn_tls_init@12" 2241 : "/include:__dyn_tls_init"); 2242 2243 // This will create a GV in the .CRT$XDU section. It will point to our 2244 // initialization function. The CRT will call all of these function 2245 // pointers at start-up time and, eventually, at thread-creation time. 2246 auto AddToXDU = [&CGM](llvm::Function *InitFunc) { 2247 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable( 2248 CGM.getModule(), InitFunc->getType(), /*IsConstant=*/true, 2249 llvm::GlobalVariable::InternalLinkage, InitFunc, 2250 Twine(InitFunc->getName(), "$initializer$")); 2251 InitFuncPtr->setSection(".CRT$XDU"); 2252 // This variable has discardable linkage, we have to add it to @llvm.used to 2253 // ensure it won't get discarded. 2254 CGM.addUsedGlobal(InitFuncPtr); 2255 return InitFuncPtr; 2256 }; 2257 2258 std::vector<llvm::Function *> NonComdatInits; 2259 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) { 2260 llvm::GlobalVariable *GV = cast<llvm::GlobalVariable>( 2261 CGM.GetGlobalValue(CGM.getMangledName(CXXThreadLocalInitVars[I]))); 2262 llvm::Function *F = CXXThreadLocalInits[I]; 2263 2264 // If the GV is already in a comdat group, then we have to join it. 2265 if (llvm::Comdat *C = GV->getComdat()) 2266 AddToXDU(F)->setComdat(C); 2267 else 2268 NonComdatInits.push_back(F); 2269 } 2270 2271 if (!NonComdatInits.empty()) { 2272 llvm::FunctionType *FTy = 2273 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false); 2274 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction( 2275 FTy, "__tls_init", CGM.getTypes().arrangeNullaryFunction(), 2276 SourceLocation(), /*TLS=*/true); 2277 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits); 2278 2279 AddToXDU(InitFunc); 2280 } 2281 } 2282 2283 LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, 2284 const VarDecl *VD, 2285 QualType LValType) { 2286 CGF.CGM.ErrorUnsupported(VD, "thread wrappers"); 2287 return LValue(); 2288 } 2289 2290 static ConstantAddress getInitThreadEpochPtr(CodeGenModule &CGM) { 2291 StringRef VarName("_Init_thread_epoch"); 2292 CharUnits Align = CGM.getIntAlign(); 2293 if (auto *GV = CGM.getModule().getNamedGlobal(VarName)) 2294 return ConstantAddress(GV, Align); 2295 auto *GV = new llvm::GlobalVariable( 2296 CGM.getModule(), CGM.IntTy, 2297 /*Constant=*/false, llvm::GlobalVariable::ExternalLinkage, 2298 /*Initializer=*/nullptr, VarName, 2299 /*InsertBefore=*/nullptr, llvm::GlobalVariable::GeneralDynamicTLSModel); 2300 GV->setAlignment(Align.getQuantity()); 2301 return ConstantAddress(GV, Align); 2302 } 2303 2304 static llvm::Constant *getInitThreadHeaderFn(CodeGenModule &CGM) { 2305 llvm::FunctionType *FTy = 2306 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()), 2307 CGM.IntTy->getPointerTo(), /*isVarArg=*/false); 2308 return CGM.CreateRuntimeFunction( 2309 FTy, "_Init_thread_header", 2310 llvm::AttributeList::get(CGM.getLLVMContext(), 2311 llvm::AttributeList::FunctionIndex, 2312 llvm::Attribute::NoUnwind), 2313 /*Local=*/true); 2314 } 2315 2316 static llvm::Constant *getInitThreadFooterFn(CodeGenModule &CGM) { 2317 llvm::FunctionType *FTy = 2318 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()), 2319 CGM.IntTy->getPointerTo(), /*isVarArg=*/false); 2320 return CGM.CreateRuntimeFunction( 2321 FTy, "_Init_thread_footer", 2322 llvm::AttributeList::get(CGM.getLLVMContext(), 2323 llvm::AttributeList::FunctionIndex, 2324 llvm::Attribute::NoUnwind), 2325 /*Local=*/true); 2326 } 2327 2328 static llvm::Constant *getInitThreadAbortFn(CodeGenModule &CGM) { 2329 llvm::FunctionType *FTy = 2330 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()), 2331 CGM.IntTy->getPointerTo(), /*isVarArg=*/false); 2332 return CGM.CreateRuntimeFunction( 2333 FTy, "_Init_thread_abort", 2334 llvm::AttributeList::get(CGM.getLLVMContext(), 2335 llvm::AttributeList::FunctionIndex, 2336 llvm::Attribute::NoUnwind), 2337 /*Local=*/true); 2338 } 2339 2340 namespace { 2341 struct ResetGuardBit final : EHScopeStack::Cleanup { 2342 Address Guard; 2343 unsigned GuardNum; 2344 ResetGuardBit(Address Guard, unsigned GuardNum) 2345 : Guard(Guard), GuardNum(GuardNum) {} 2346 2347 void Emit(CodeGenFunction &CGF, Flags flags) override { 2348 // Reset the bit in the mask so that the static variable may be 2349 // reinitialized. 2350 CGBuilderTy &Builder = CGF.Builder; 2351 llvm::LoadInst *LI = Builder.CreateLoad(Guard); 2352 llvm::ConstantInt *Mask = 2353 llvm::ConstantInt::get(CGF.IntTy, ~(1ULL << GuardNum)); 2354 Builder.CreateStore(Builder.CreateAnd(LI, Mask), Guard); 2355 } 2356 }; 2357 2358 struct CallInitThreadAbort final : EHScopeStack::Cleanup { 2359 llvm::Value *Guard; 2360 CallInitThreadAbort(Address Guard) : Guard(Guard.getPointer()) {} 2361 2362 void Emit(CodeGenFunction &CGF, Flags flags) override { 2363 // Calling _Init_thread_abort will reset the guard's state. 2364 CGF.EmitNounwindRuntimeCall(getInitThreadAbortFn(CGF.CGM), Guard); 2365 } 2366 }; 2367 } 2368 2369 void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D, 2370 llvm::GlobalVariable *GV, 2371 bool PerformInit) { 2372 // MSVC only uses guards for static locals. 2373 if (!D.isStaticLocal()) { 2374 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage()); 2375 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr. 2376 llvm::Function *F = CGF.CurFn; 2377 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage); 2378 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName())); 2379 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit); 2380 return; 2381 } 2382 2383 bool ThreadlocalStatic = D.getTLSKind(); 2384 bool ThreadsafeStatic = getContext().getLangOpts().ThreadsafeStatics; 2385 2386 // Thread-safe static variables which aren't thread-specific have a 2387 // per-variable guard. 2388 bool HasPerVariableGuard = ThreadsafeStatic && !ThreadlocalStatic; 2389 2390 CGBuilderTy &Builder = CGF.Builder; 2391 llvm::IntegerType *GuardTy = CGF.Int32Ty; 2392 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0); 2393 CharUnits GuardAlign = CharUnits::fromQuantity(4); 2394 2395 // Get the guard variable for this function if we have one already. 2396 GuardInfo *GI = nullptr; 2397 if (ThreadlocalStatic) 2398 GI = &ThreadLocalGuardVariableMap[D.getDeclContext()]; 2399 else if (!ThreadsafeStatic) 2400 GI = &GuardVariableMap[D.getDeclContext()]; 2401 2402 llvm::GlobalVariable *GuardVar = GI ? GI->Guard : nullptr; 2403 unsigned GuardNum; 2404 if (D.isExternallyVisible()) { 2405 // Externally visible variables have to be numbered in Sema to properly 2406 // handle unreachable VarDecls. 2407 GuardNum = getContext().getStaticLocalNumber(&D); 2408 assert(GuardNum > 0); 2409 GuardNum--; 2410 } else if (HasPerVariableGuard) { 2411 GuardNum = ThreadSafeGuardNumMap[D.getDeclContext()]++; 2412 } else { 2413 // Non-externally visible variables are numbered here in CodeGen. 2414 GuardNum = GI->BitIndex++; 2415 } 2416 2417 if (!HasPerVariableGuard && GuardNum >= 32) { 2418 if (D.isExternallyVisible()) 2419 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations"); 2420 GuardNum %= 32; 2421 GuardVar = nullptr; 2422 } 2423 2424 if (!GuardVar) { 2425 // Mangle the name for the guard. 2426 SmallString<256> GuardName; 2427 { 2428 llvm::raw_svector_ostream Out(GuardName); 2429 if (HasPerVariableGuard) 2430 getMangleContext().mangleThreadSafeStaticGuardVariable(&D, GuardNum, 2431 Out); 2432 else 2433 getMangleContext().mangleStaticGuardVariable(&D, Out); 2434 } 2435 2436 // Create the guard variable with a zero-initializer. Just absorb linkage, 2437 // visibility and dll storage class from the guarded variable. 2438 GuardVar = 2439 new llvm::GlobalVariable(CGM.getModule(), GuardTy, /*isConstant=*/false, 2440 GV->getLinkage(), Zero, GuardName.str()); 2441 GuardVar->setVisibility(GV->getVisibility()); 2442 GuardVar->setDLLStorageClass(GV->getDLLStorageClass()); 2443 GuardVar->setAlignment(GuardAlign.getQuantity()); 2444 if (GuardVar->isWeakForLinker()) 2445 GuardVar->setComdat( 2446 CGM.getModule().getOrInsertComdat(GuardVar->getName())); 2447 if (D.getTLSKind()) 2448 GuardVar->setThreadLocal(true); 2449 if (GI && !HasPerVariableGuard) 2450 GI->Guard = GuardVar; 2451 } 2452 2453 ConstantAddress GuardAddr(GuardVar, GuardAlign); 2454 2455 assert(GuardVar->getLinkage() == GV->getLinkage() && 2456 "static local from the same function had different linkage"); 2457 2458 if (!HasPerVariableGuard) { 2459 // Pseudo code for the test: 2460 // if (!(GuardVar & MyGuardBit)) { 2461 // GuardVar |= MyGuardBit; 2462 // ... initialize the object ...; 2463 // } 2464 2465 // Test our bit from the guard variable. 2466 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1ULL << GuardNum); 2467 llvm::LoadInst *LI = Builder.CreateLoad(GuardAddr); 2468 llvm::Value *IsInitialized = 2469 Builder.CreateICmpNE(Builder.CreateAnd(LI, Bit), Zero); 2470 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init"); 2471 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end"); 2472 Builder.CreateCondBr(IsInitialized, EndBlock, InitBlock); 2473 2474 // Set our bit in the guard variable and emit the initializer and add a global 2475 // destructor if appropriate. 2476 CGF.EmitBlock(InitBlock); 2477 Builder.CreateStore(Builder.CreateOr(LI, Bit), GuardAddr); 2478 CGF.EHStack.pushCleanup<ResetGuardBit>(EHCleanup, GuardAddr, GuardNum); 2479 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit); 2480 CGF.PopCleanupBlock(); 2481 Builder.CreateBr(EndBlock); 2482 2483 // Continue. 2484 CGF.EmitBlock(EndBlock); 2485 } else { 2486 // Pseudo code for the test: 2487 // if (TSS > _Init_thread_epoch) { 2488 // _Init_thread_header(&TSS); 2489 // if (TSS == -1) { 2490 // ... initialize the object ...; 2491 // _Init_thread_footer(&TSS); 2492 // } 2493 // } 2494 // 2495 // The algorithm is almost identical to what can be found in the appendix 2496 // found in N2325. 2497 2498 // This BasicBLock determines whether or not we have any work to do. 2499 llvm::LoadInst *FirstGuardLoad = Builder.CreateLoad(GuardAddr); 2500 FirstGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered); 2501 llvm::LoadInst *InitThreadEpoch = 2502 Builder.CreateLoad(getInitThreadEpochPtr(CGM)); 2503 llvm::Value *IsUninitialized = 2504 Builder.CreateICmpSGT(FirstGuardLoad, InitThreadEpoch); 2505 llvm::BasicBlock *AttemptInitBlock = CGF.createBasicBlock("init.attempt"); 2506 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end"); 2507 Builder.CreateCondBr(IsUninitialized, AttemptInitBlock, EndBlock); 2508 2509 // This BasicBlock attempts to determine whether or not this thread is 2510 // responsible for doing the initialization. 2511 CGF.EmitBlock(AttemptInitBlock); 2512 CGF.EmitNounwindRuntimeCall(getInitThreadHeaderFn(CGM), 2513 GuardAddr.getPointer()); 2514 llvm::LoadInst *SecondGuardLoad = Builder.CreateLoad(GuardAddr); 2515 SecondGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered); 2516 llvm::Value *ShouldDoInit = 2517 Builder.CreateICmpEQ(SecondGuardLoad, getAllOnesInt()); 2518 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init"); 2519 Builder.CreateCondBr(ShouldDoInit, InitBlock, EndBlock); 2520 2521 // Ok, we ended up getting selected as the initializing thread. 2522 CGF.EmitBlock(InitBlock); 2523 CGF.EHStack.pushCleanup<CallInitThreadAbort>(EHCleanup, GuardAddr); 2524 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit); 2525 CGF.PopCleanupBlock(); 2526 CGF.EmitNounwindRuntimeCall(getInitThreadFooterFn(CGM), 2527 GuardAddr.getPointer()); 2528 Builder.CreateBr(EndBlock); 2529 2530 CGF.EmitBlock(EndBlock); 2531 } 2532 } 2533 2534 bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) { 2535 // Null-ness for function memptrs only depends on the first field, which is 2536 // the function pointer. The rest don't matter, so we can zero initialize. 2537 if (MPT->isMemberFunctionPointer()) 2538 return true; 2539 2540 // The virtual base adjustment field is always -1 for null, so if we have one 2541 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a 2542 // valid field offset. 2543 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl(); 2544 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel(); 2545 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) && 2546 RD->nullFieldOffsetIsZero()); 2547 } 2548 2549 llvm::Type * 2550 MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) { 2551 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl(); 2552 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel(); 2553 llvm::SmallVector<llvm::Type *, 4> fields; 2554 if (MPT->isMemberFunctionPointer()) 2555 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk 2556 else 2557 fields.push_back(CGM.IntTy); // FieldOffset 2558 2559 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(), 2560 Inheritance)) 2561 fields.push_back(CGM.IntTy); 2562 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) 2563 fields.push_back(CGM.IntTy); 2564 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance)) 2565 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset 2566 2567 if (fields.size() == 1) 2568 return fields[0]; 2569 return llvm::StructType::get(CGM.getLLVMContext(), fields); 2570 } 2571 2572 void MicrosoftCXXABI:: 2573 GetNullMemberPointerFields(const MemberPointerType *MPT, 2574 llvm::SmallVectorImpl<llvm::Constant *> &fields) { 2575 assert(fields.empty()); 2576 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl(); 2577 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel(); 2578 if (MPT->isMemberFunctionPointer()) { 2579 // FunctionPointerOrVirtualThunk 2580 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy)); 2581 } else { 2582 if (RD->nullFieldOffsetIsZero()) 2583 fields.push_back(getZeroInt()); // FieldOffset 2584 else 2585 fields.push_back(getAllOnesInt()); // FieldOffset 2586 } 2587 2588 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(), 2589 Inheritance)) 2590 fields.push_back(getZeroInt()); 2591 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) 2592 fields.push_back(getZeroInt()); 2593 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance)) 2594 fields.push_back(getAllOnesInt()); 2595 } 2596 2597 llvm::Constant * 2598 MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) { 2599 llvm::SmallVector<llvm::Constant *, 4> fields; 2600 GetNullMemberPointerFields(MPT, fields); 2601 if (fields.size() == 1) 2602 return fields[0]; 2603 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields); 2604 assert(Res->getType() == ConvertMemberPointerType(MPT)); 2605 return Res; 2606 } 2607 2608 llvm::Constant * 2609 MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField, 2610 bool IsMemberFunction, 2611 const CXXRecordDecl *RD, 2612 CharUnits NonVirtualBaseAdjustment, 2613 unsigned VBTableIndex) { 2614 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel(); 2615 2616 // Single inheritance class member pointer are represented as scalars instead 2617 // of aggregates. 2618 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance)) 2619 return FirstField; 2620 2621 llvm::SmallVector<llvm::Constant *, 4> fields; 2622 fields.push_back(FirstField); 2623 2624 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance)) 2625 fields.push_back(llvm::ConstantInt::get( 2626 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity())); 2627 2628 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) { 2629 CharUnits Offs = CharUnits::Zero(); 2630 if (VBTableIndex) 2631 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset(); 2632 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity())); 2633 } 2634 2635 // The rest of the fields are adjusted by conversions to a more derived class. 2636 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance)) 2637 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, VBTableIndex)); 2638 2639 return llvm::ConstantStruct::getAnon(fields); 2640 } 2641 2642 llvm::Constant * 2643 MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT, 2644 CharUnits offset) { 2645 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl(); 2646 if (RD->getMSInheritanceModel() == 2647 MSInheritanceAttr::Keyword_virtual_inheritance) 2648 offset -= getContext().getOffsetOfBaseWithVBPtr(RD); 2649 llvm::Constant *FirstField = 2650 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity()); 2651 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD, 2652 CharUnits::Zero(), /*VBTableIndex=*/0); 2653 } 2654 2655 llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP, 2656 QualType MPType) { 2657 const MemberPointerType *DstTy = MPType->castAs<MemberPointerType>(); 2658 const ValueDecl *MPD = MP.getMemberPointerDecl(); 2659 if (!MPD) 2660 return EmitNullMemberPointer(DstTy); 2661 2662 ASTContext &Ctx = getContext(); 2663 ArrayRef<const CXXRecordDecl *> MemberPointerPath = MP.getMemberPointerPath(); 2664 2665 llvm::Constant *C; 2666 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) { 2667 C = EmitMemberFunctionPointer(MD); 2668 } else { 2669 CharUnits FieldOffset = Ctx.toCharUnitsFromBits(Ctx.getFieldOffset(MPD)); 2670 C = EmitMemberDataPointer(DstTy, FieldOffset); 2671 } 2672 2673 if (!MemberPointerPath.empty()) { 2674 const CXXRecordDecl *SrcRD = cast<CXXRecordDecl>(MPD->getDeclContext()); 2675 const Type *SrcRecTy = Ctx.getTypeDeclType(SrcRD).getTypePtr(); 2676 const MemberPointerType *SrcTy = 2677 Ctx.getMemberPointerType(DstTy->getPointeeType(), SrcRecTy) 2678 ->castAs<MemberPointerType>(); 2679 2680 bool DerivedMember = MP.isMemberPointerToDerivedMember(); 2681 SmallVector<const CXXBaseSpecifier *, 4> DerivedToBasePath; 2682 const CXXRecordDecl *PrevRD = SrcRD; 2683 for (const CXXRecordDecl *PathElem : MemberPointerPath) { 2684 const CXXRecordDecl *Base = nullptr; 2685 const CXXRecordDecl *Derived = nullptr; 2686 if (DerivedMember) { 2687 Base = PathElem; 2688 Derived = PrevRD; 2689 } else { 2690 Base = PrevRD; 2691 Derived = PathElem; 2692 } 2693 for (const CXXBaseSpecifier &BS : Derived->bases()) 2694 if (BS.getType()->getAsCXXRecordDecl()->getCanonicalDecl() == 2695 Base->getCanonicalDecl()) 2696 DerivedToBasePath.push_back(&BS); 2697 PrevRD = PathElem; 2698 } 2699 assert(DerivedToBasePath.size() == MemberPointerPath.size()); 2700 2701 CastKind CK = DerivedMember ? CK_DerivedToBaseMemberPointer 2702 : CK_BaseToDerivedMemberPointer; 2703 C = EmitMemberPointerConversion(SrcTy, DstTy, CK, DerivedToBasePath.begin(), 2704 DerivedToBasePath.end(), C); 2705 } 2706 return C; 2707 } 2708 2709 llvm::Constant * 2710 MicrosoftCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) { 2711 assert(MD->isInstance() && "Member function must not be static!"); 2712 2713 MD = MD->getCanonicalDecl(); 2714 CharUnits NonVirtualBaseAdjustment = CharUnits::Zero(); 2715 const CXXRecordDecl *RD = MD->getParent()->getMostRecentDecl(); 2716 CodeGenTypes &Types = CGM.getTypes(); 2717 2718 unsigned VBTableIndex = 0; 2719 llvm::Constant *FirstField; 2720 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>(); 2721 if (!MD->isVirtual()) { 2722 llvm::Type *Ty; 2723 // Check whether the function has a computable LLVM signature. 2724 if (Types.isFuncTypeConvertible(FPT)) { 2725 // The function has a computable LLVM signature; use the correct type. 2726 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD)); 2727 } else { 2728 // Use an arbitrary non-function type to tell GetAddrOfFunction that the 2729 // function type is incomplete. 2730 Ty = CGM.PtrDiffTy; 2731 } 2732 FirstField = CGM.GetAddrOfFunction(MD, Ty); 2733 } else { 2734 auto &VTableContext = CGM.getMicrosoftVTableContext(); 2735 MicrosoftVTableContext::MethodVFTableLocation ML = 2736 VTableContext.getMethodVFTableLocation(MD); 2737 FirstField = EmitVirtualMemPtrThunk(MD, ML); 2738 // Include the vfptr adjustment if the method is in a non-primary vftable. 2739 NonVirtualBaseAdjustment += ML.VFPtrOffset; 2740 if (ML.VBase) 2741 VBTableIndex = VTableContext.getVBTableIndex(RD, ML.VBase) * 4; 2742 } 2743 2744 if (VBTableIndex == 0 && 2745 RD->getMSInheritanceModel() == 2746 MSInheritanceAttr::Keyword_virtual_inheritance) 2747 NonVirtualBaseAdjustment -= getContext().getOffsetOfBaseWithVBPtr(RD); 2748 2749 // The rest of the fields are common with data member pointers. 2750 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy); 2751 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD, 2752 NonVirtualBaseAdjustment, VBTableIndex); 2753 } 2754 2755 /// Member pointers are the same if they're either bitwise identical *or* both 2756 /// null. Null-ness for function members is determined by the first field, 2757 /// while for data member pointers we must compare all fields. 2758 llvm::Value * 2759 MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF, 2760 llvm::Value *L, 2761 llvm::Value *R, 2762 const MemberPointerType *MPT, 2763 bool Inequality) { 2764 CGBuilderTy &Builder = CGF.Builder; 2765 2766 // Handle != comparisons by switching the sense of all boolean operations. 2767 llvm::ICmpInst::Predicate Eq; 2768 llvm::Instruction::BinaryOps And, Or; 2769 if (Inequality) { 2770 Eq = llvm::ICmpInst::ICMP_NE; 2771 And = llvm::Instruction::Or; 2772 Or = llvm::Instruction::And; 2773 } else { 2774 Eq = llvm::ICmpInst::ICMP_EQ; 2775 And = llvm::Instruction::And; 2776 Or = llvm::Instruction::Or; 2777 } 2778 2779 // If this is a single field member pointer (single inheritance), this is a 2780 // single icmp. 2781 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl(); 2782 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel(); 2783 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(), 2784 Inheritance)) 2785 return Builder.CreateICmp(Eq, L, R); 2786 2787 // Compare the first field. 2788 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0"); 2789 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0"); 2790 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first"); 2791 2792 // Compare everything other than the first field. 2793 llvm::Value *Res = nullptr; 2794 llvm::StructType *LType = cast<llvm::StructType>(L->getType()); 2795 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) { 2796 llvm::Value *LF = Builder.CreateExtractValue(L, I); 2797 llvm::Value *RF = Builder.CreateExtractValue(R, I); 2798 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest"); 2799 if (Res) 2800 Res = Builder.CreateBinOp(And, Res, Cmp); 2801 else 2802 Res = Cmp; 2803 } 2804 2805 // Check if the first field is 0 if this is a function pointer. 2806 if (MPT->isMemberFunctionPointer()) { 2807 // (l1 == r1 && ...) || l0 == 0 2808 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType()); 2809 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero"); 2810 Res = Builder.CreateBinOp(Or, Res, IsZero); 2811 } 2812 2813 // Combine the comparison of the first field, which must always be true for 2814 // this comparison to succeeed. 2815 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp"); 2816 } 2817 2818 llvm::Value * 2819 MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF, 2820 llvm::Value *MemPtr, 2821 const MemberPointerType *MPT) { 2822 CGBuilderTy &Builder = CGF.Builder; 2823 llvm::SmallVector<llvm::Constant *, 4> fields; 2824 // We only need one field for member functions. 2825 if (MPT->isMemberFunctionPointer()) 2826 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy)); 2827 else 2828 GetNullMemberPointerFields(MPT, fields); 2829 assert(!fields.empty()); 2830 llvm::Value *FirstField = MemPtr; 2831 if (MemPtr->getType()->isStructTy()) 2832 FirstField = Builder.CreateExtractValue(MemPtr, 0); 2833 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0"); 2834 2835 // For function member pointers, we only need to test the function pointer 2836 // field. The other fields if any can be garbage. 2837 if (MPT->isMemberFunctionPointer()) 2838 return Res; 2839 2840 // Otherwise, emit a series of compares and combine the results. 2841 for (int I = 1, E = fields.size(); I < E; ++I) { 2842 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I); 2843 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp"); 2844 Res = Builder.CreateOr(Res, Next, "memptr.tobool"); 2845 } 2846 return Res; 2847 } 2848 2849 bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT, 2850 llvm::Constant *Val) { 2851 // Function pointers are null if the pointer in the first field is null. 2852 if (MPT->isMemberFunctionPointer()) { 2853 llvm::Constant *FirstField = Val->getType()->isStructTy() ? 2854 Val->getAggregateElement(0U) : Val; 2855 return FirstField->isNullValue(); 2856 } 2857 2858 // If it's not a function pointer and it's zero initializable, we can easily 2859 // check zero. 2860 if (isZeroInitializable(MPT) && Val->isNullValue()) 2861 return true; 2862 2863 // Otherwise, break down all the fields for comparison. Hopefully these 2864 // little Constants are reused, while a big null struct might not be. 2865 llvm::SmallVector<llvm::Constant *, 4> Fields; 2866 GetNullMemberPointerFields(MPT, Fields); 2867 if (Fields.size() == 1) { 2868 assert(Val->getType()->isIntegerTy()); 2869 return Val == Fields[0]; 2870 } 2871 2872 unsigned I, E; 2873 for (I = 0, E = Fields.size(); I != E; ++I) { 2874 if (Val->getAggregateElement(I) != Fields[I]) 2875 break; 2876 } 2877 return I == E; 2878 } 2879 2880 llvm::Value * 2881 MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF, 2882 Address This, 2883 llvm::Value *VBPtrOffset, 2884 llvm::Value *VBTableOffset, 2885 llvm::Value **VBPtrOut) { 2886 CGBuilderTy &Builder = CGF.Builder; 2887 // Load the vbtable pointer from the vbptr in the instance. 2888 This = Builder.CreateElementBitCast(This, CGM.Int8Ty); 2889 llvm::Value *VBPtr = 2890 Builder.CreateInBoundsGEP(This.getPointer(), VBPtrOffset, "vbptr"); 2891 if (VBPtrOut) *VBPtrOut = VBPtr; 2892 VBPtr = Builder.CreateBitCast(VBPtr, 2893 CGM.Int32Ty->getPointerTo(0)->getPointerTo(This.getAddressSpace())); 2894 2895 CharUnits VBPtrAlign; 2896 if (auto CI = dyn_cast<llvm::ConstantInt>(VBPtrOffset)) { 2897 VBPtrAlign = This.getAlignment().alignmentAtOffset( 2898 CharUnits::fromQuantity(CI->getSExtValue())); 2899 } else { 2900 VBPtrAlign = CGF.getPointerAlign(); 2901 } 2902 2903 llvm::Value *VBTable = Builder.CreateAlignedLoad(VBPtr, VBPtrAlign, "vbtable"); 2904 2905 // Translate from byte offset to table index. It improves analyzability. 2906 llvm::Value *VBTableIndex = Builder.CreateAShr( 2907 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2), 2908 "vbtindex", /*isExact=*/true); 2909 2910 // Load an i32 offset from the vb-table. 2911 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex); 2912 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0)); 2913 return Builder.CreateAlignedLoad(VBaseOffs, CharUnits::fromQuantity(4), 2914 "vbase_offs"); 2915 } 2916 2917 // Returns an adjusted base cast to i8*, since we do more address arithmetic on 2918 // it. 2919 llvm::Value *MicrosoftCXXABI::AdjustVirtualBase( 2920 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD, 2921 Address Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) { 2922 CGBuilderTy &Builder = CGF.Builder; 2923 Base = Builder.CreateElementBitCast(Base, CGM.Int8Ty); 2924 llvm::BasicBlock *OriginalBB = nullptr; 2925 llvm::BasicBlock *SkipAdjustBB = nullptr; 2926 llvm::BasicBlock *VBaseAdjustBB = nullptr; 2927 2928 // In the unspecified inheritance model, there might not be a vbtable at all, 2929 // in which case we need to skip the virtual base lookup. If there is a 2930 // vbtable, the first entry is a no-op entry that gives back the original 2931 // base, so look for a virtual base adjustment offset of zero. 2932 if (VBPtrOffset) { 2933 OriginalBB = Builder.GetInsertBlock(); 2934 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust"); 2935 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust"); 2936 llvm::Value *IsVirtual = 2937 Builder.CreateICmpNE(VBTableOffset, getZeroInt(), 2938 "memptr.is_vbase"); 2939 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB); 2940 CGF.EmitBlock(VBaseAdjustBB); 2941 } 2942 2943 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll 2944 // know the vbptr offset. 2945 if (!VBPtrOffset) { 2946 CharUnits offs = CharUnits::Zero(); 2947 if (!RD->hasDefinition()) { 2948 DiagnosticsEngine &Diags = CGF.CGM.getDiags(); 2949 unsigned DiagID = Diags.getCustomDiagID( 2950 DiagnosticsEngine::Error, 2951 "member pointer representation requires a " 2952 "complete class type for %0 to perform this expression"); 2953 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange(); 2954 } else if (RD->getNumVBases()) 2955 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset(); 2956 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity()); 2957 } 2958 llvm::Value *VBPtr = nullptr; 2959 llvm::Value *VBaseOffs = 2960 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr); 2961 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs); 2962 2963 // Merge control flow with the case where we didn't have to adjust. 2964 if (VBaseAdjustBB) { 2965 Builder.CreateBr(SkipAdjustBB); 2966 CGF.EmitBlock(SkipAdjustBB); 2967 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base"); 2968 Phi->addIncoming(Base.getPointer(), OriginalBB); 2969 Phi->addIncoming(AdjustedBase, VBaseAdjustBB); 2970 return Phi; 2971 } 2972 return AdjustedBase; 2973 } 2974 2975 llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress( 2976 CodeGenFunction &CGF, const Expr *E, Address Base, llvm::Value *MemPtr, 2977 const MemberPointerType *MPT) { 2978 assert(MPT->isMemberDataPointer()); 2979 unsigned AS = Base.getAddressSpace(); 2980 llvm::Type *PType = 2981 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS); 2982 CGBuilderTy &Builder = CGF.Builder; 2983 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl(); 2984 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel(); 2985 2986 // Extract the fields we need, regardless of model. We'll apply them if we 2987 // have them. 2988 llvm::Value *FieldOffset = MemPtr; 2989 llvm::Value *VirtualBaseAdjustmentOffset = nullptr; 2990 llvm::Value *VBPtrOffset = nullptr; 2991 if (MemPtr->getType()->isStructTy()) { 2992 // We need to extract values. 2993 unsigned I = 0; 2994 FieldOffset = Builder.CreateExtractValue(MemPtr, I++); 2995 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) 2996 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++); 2997 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance)) 2998 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++); 2999 } 3000 3001 llvm::Value *Addr; 3002 if (VirtualBaseAdjustmentOffset) { 3003 Addr = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset, 3004 VBPtrOffset); 3005 } else { 3006 Addr = Base.getPointer(); 3007 } 3008 3009 // Cast to char*. 3010 Addr = Builder.CreateBitCast(Addr, CGF.Int8Ty->getPointerTo(AS)); 3011 3012 // Apply the offset, which we assume is non-null. 3013 Addr = Builder.CreateInBoundsGEP(Addr, FieldOffset, "memptr.offset"); 3014 3015 // Cast the address to the appropriate pointer type, adopting the address 3016 // space of the base pointer. 3017 return Builder.CreateBitCast(Addr, PType); 3018 } 3019 3020 llvm::Value * 3021 MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF, 3022 const CastExpr *E, 3023 llvm::Value *Src) { 3024 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer || 3025 E->getCastKind() == CK_BaseToDerivedMemberPointer || 3026 E->getCastKind() == CK_ReinterpretMemberPointer); 3027 3028 // Use constant emission if we can. 3029 if (isa<llvm::Constant>(Src)) 3030 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src)); 3031 3032 // We may be adding or dropping fields from the member pointer, so we need 3033 // both types and the inheritance models of both records. 3034 const MemberPointerType *SrcTy = 3035 E->getSubExpr()->getType()->castAs<MemberPointerType>(); 3036 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>(); 3037 bool IsFunc = SrcTy->isMemberFunctionPointer(); 3038 3039 // If the classes use the same null representation, reinterpret_cast is a nop. 3040 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer; 3041 if (IsReinterpret && IsFunc) 3042 return Src; 3043 3044 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl(); 3045 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl(); 3046 if (IsReinterpret && 3047 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero()) 3048 return Src; 3049 3050 CGBuilderTy &Builder = CGF.Builder; 3051 3052 // Branch past the conversion if Src is null. 3053 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy); 3054 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy); 3055 3056 // C++ 5.2.10p9: The null member pointer value is converted to the null member 3057 // pointer value of the destination type. 3058 if (IsReinterpret) { 3059 // For reinterpret casts, sema ensures that src and dst are both functions 3060 // or data and have the same size, which means the LLVM types should match. 3061 assert(Src->getType() == DstNull->getType()); 3062 return Builder.CreateSelect(IsNotNull, Src, DstNull); 3063 } 3064 3065 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock(); 3066 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert"); 3067 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted"); 3068 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB); 3069 CGF.EmitBlock(ConvertBB); 3070 3071 llvm::Value *Dst = EmitNonNullMemberPointerConversion( 3072 SrcTy, DstTy, E->getCastKind(), E->path_begin(), E->path_end(), Src, 3073 Builder); 3074 3075 Builder.CreateBr(ContinueBB); 3076 3077 // In the continuation, choose between DstNull and Dst. 3078 CGF.EmitBlock(ContinueBB); 3079 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted"); 3080 Phi->addIncoming(DstNull, OriginalBB); 3081 Phi->addIncoming(Dst, ConvertBB); 3082 return Phi; 3083 } 3084 3085 llvm::Value *MicrosoftCXXABI::EmitNonNullMemberPointerConversion( 3086 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK, 3087 CastExpr::path_const_iterator PathBegin, 3088 CastExpr::path_const_iterator PathEnd, llvm::Value *Src, 3089 CGBuilderTy &Builder) { 3090 const CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl(); 3091 const CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl(); 3092 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel(); 3093 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel(); 3094 bool IsFunc = SrcTy->isMemberFunctionPointer(); 3095 bool IsConstant = isa<llvm::Constant>(Src); 3096 3097 // Decompose src. 3098 llvm::Value *FirstField = Src; 3099 llvm::Value *NonVirtualBaseAdjustment = getZeroInt(); 3100 llvm::Value *VirtualBaseAdjustmentOffset = getZeroInt(); 3101 llvm::Value *VBPtrOffset = getZeroInt(); 3102 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) { 3103 // We need to extract values. 3104 unsigned I = 0; 3105 FirstField = Builder.CreateExtractValue(Src, I++); 3106 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance)) 3107 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++); 3108 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance)) 3109 VBPtrOffset = Builder.CreateExtractValue(Src, I++); 3110 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance)) 3111 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++); 3112 } 3113 3114 bool IsDerivedToBase = (CK == CK_DerivedToBaseMemberPointer); 3115 const MemberPointerType *DerivedTy = IsDerivedToBase ? SrcTy : DstTy; 3116 const CXXRecordDecl *DerivedClass = DerivedTy->getMostRecentCXXRecordDecl(); 3117 3118 // For data pointers, we adjust the field offset directly. For functions, we 3119 // have a separate field. 3120 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField; 3121 3122 // The virtual inheritance model has a quirk: the virtual base table is always 3123 // referenced when dereferencing a member pointer even if the member pointer 3124 // is non-virtual. This is accounted for by adjusting the non-virtual offset 3125 // to point backwards to the top of the MDC from the first VBase. Undo this 3126 // adjustment to normalize the member pointer. 3127 llvm::Value *SrcVBIndexEqZero = 3128 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt()); 3129 if (SrcInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) { 3130 if (int64_t SrcOffsetToFirstVBase = 3131 getContext().getOffsetOfBaseWithVBPtr(SrcRD).getQuantity()) { 3132 llvm::Value *UndoSrcAdjustment = Builder.CreateSelect( 3133 SrcVBIndexEqZero, 3134 llvm::ConstantInt::get(CGM.IntTy, SrcOffsetToFirstVBase), 3135 getZeroInt()); 3136 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, UndoSrcAdjustment); 3137 } 3138 } 3139 3140 // A non-zero vbindex implies that we are dealing with a source member in a 3141 // floating virtual base in addition to some non-virtual offset. If the 3142 // vbindex is zero, we are dealing with a source that exists in a non-virtual, 3143 // fixed, base. The difference between these two cases is that the vbindex + 3144 // nvoffset *always* point to the member regardless of what context they are 3145 // evaluated in so long as the vbindex is adjusted. A member inside a fixed 3146 // base requires explicit nv adjustment. 3147 llvm::Constant *BaseClassOffset = llvm::ConstantInt::get( 3148 CGM.IntTy, 3149 CGM.computeNonVirtualBaseClassOffset(DerivedClass, PathBegin, PathEnd) 3150 .getQuantity()); 3151 3152 llvm::Value *NVDisp; 3153 if (IsDerivedToBase) 3154 NVDisp = Builder.CreateNSWSub(NVAdjustField, BaseClassOffset, "adj"); 3155 else 3156 NVDisp = Builder.CreateNSWAdd(NVAdjustField, BaseClassOffset, "adj"); 3157 3158 NVAdjustField = Builder.CreateSelect(SrcVBIndexEqZero, NVDisp, getZeroInt()); 3159 3160 // Update the vbindex to an appropriate value in the destination because 3161 // SrcRD's vbtable might not be a strict prefix of the one in DstRD. 3162 llvm::Value *DstVBIndexEqZero = SrcVBIndexEqZero; 3163 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance) && 3164 MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance)) { 3165 if (llvm::GlobalVariable *VDispMap = 3166 getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) { 3167 llvm::Value *VBIndex = Builder.CreateExactUDiv( 3168 VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4)); 3169 if (IsConstant) { 3170 llvm::Constant *Mapping = VDispMap->getInitializer(); 3171 VirtualBaseAdjustmentOffset = 3172 Mapping->getAggregateElement(cast<llvm::Constant>(VBIndex)); 3173 } else { 3174 llvm::Value *Idxs[] = {getZeroInt(), VBIndex}; 3175 VirtualBaseAdjustmentOffset = 3176 Builder.CreateAlignedLoad(Builder.CreateInBoundsGEP(VDispMap, Idxs), 3177 CharUnits::fromQuantity(4)); 3178 } 3179 3180 DstVBIndexEqZero = 3181 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt()); 3182 } 3183 } 3184 3185 // Set the VBPtrOffset to zero if the vbindex is zero. Otherwise, initialize 3186 // it to the offset of the vbptr. 3187 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance)) { 3188 llvm::Value *DstVBPtrOffset = llvm::ConstantInt::get( 3189 CGM.IntTy, 3190 getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity()); 3191 VBPtrOffset = 3192 Builder.CreateSelect(DstVBIndexEqZero, getZeroInt(), DstVBPtrOffset); 3193 } 3194 3195 // Likewise, apply a similar adjustment so that dereferencing the member 3196 // pointer correctly accounts for the distance between the start of the first 3197 // virtual base and the top of the MDC. 3198 if (DstInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) { 3199 if (int64_t DstOffsetToFirstVBase = 3200 getContext().getOffsetOfBaseWithVBPtr(DstRD).getQuantity()) { 3201 llvm::Value *DoDstAdjustment = Builder.CreateSelect( 3202 DstVBIndexEqZero, 3203 llvm::ConstantInt::get(CGM.IntTy, DstOffsetToFirstVBase), 3204 getZeroInt()); 3205 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, DoDstAdjustment); 3206 } 3207 } 3208 3209 // Recompose dst from the null struct and the adjusted fields from src. 3210 llvm::Value *Dst; 3211 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) { 3212 Dst = FirstField; 3213 } else { 3214 Dst = llvm::UndefValue::get(ConvertMemberPointerType(DstTy)); 3215 unsigned Idx = 0; 3216 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++); 3217 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance)) 3218 Dst = Builder.CreateInsertValue(Dst, NonVirtualBaseAdjustment, Idx++); 3219 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance)) 3220 Dst = Builder.CreateInsertValue(Dst, VBPtrOffset, Idx++); 3221 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance)) 3222 Dst = Builder.CreateInsertValue(Dst, VirtualBaseAdjustmentOffset, Idx++); 3223 } 3224 return Dst; 3225 } 3226 3227 llvm::Constant * 3228 MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E, 3229 llvm::Constant *Src) { 3230 const MemberPointerType *SrcTy = 3231 E->getSubExpr()->getType()->castAs<MemberPointerType>(); 3232 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>(); 3233 3234 CastKind CK = E->getCastKind(); 3235 3236 return EmitMemberPointerConversion(SrcTy, DstTy, CK, E->path_begin(), 3237 E->path_end(), Src); 3238 } 3239 3240 llvm::Constant *MicrosoftCXXABI::EmitMemberPointerConversion( 3241 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK, 3242 CastExpr::path_const_iterator PathBegin, 3243 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src) { 3244 assert(CK == CK_DerivedToBaseMemberPointer || 3245 CK == CK_BaseToDerivedMemberPointer || 3246 CK == CK_ReinterpretMemberPointer); 3247 // If src is null, emit a new null for dst. We can't return src because dst 3248 // might have a new representation. 3249 if (MemberPointerConstantIsNull(SrcTy, Src)) 3250 return EmitNullMemberPointer(DstTy); 3251 3252 // We don't need to do anything for reinterpret_casts of non-null member 3253 // pointers. We should only get here when the two type representations have 3254 // the same size. 3255 if (CK == CK_ReinterpretMemberPointer) 3256 return Src; 3257 3258 CGBuilderTy Builder(CGM, CGM.getLLVMContext()); 3259 auto *Dst = cast<llvm::Constant>(EmitNonNullMemberPointerConversion( 3260 SrcTy, DstTy, CK, PathBegin, PathEnd, Src, Builder)); 3261 3262 return Dst; 3263 } 3264 3265 CGCallee MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer( 3266 CodeGenFunction &CGF, const Expr *E, Address This, 3267 llvm::Value *&ThisPtrForCall, llvm::Value *MemPtr, 3268 const MemberPointerType *MPT) { 3269 assert(MPT->isMemberFunctionPointer()); 3270 const FunctionProtoType *FPT = 3271 MPT->getPointeeType()->castAs<FunctionProtoType>(); 3272 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl(); 3273 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType( 3274 CGM.getTypes().arrangeCXXMethodType(RD, FPT, /*FD=*/nullptr)); 3275 CGBuilderTy &Builder = CGF.Builder; 3276 3277 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel(); 3278 3279 // Extract the fields we need, regardless of model. We'll apply them if we 3280 // have them. 3281 llvm::Value *FunctionPointer = MemPtr; 3282 llvm::Value *NonVirtualBaseAdjustment = nullptr; 3283 llvm::Value *VirtualBaseAdjustmentOffset = nullptr; 3284 llvm::Value *VBPtrOffset = nullptr; 3285 if (MemPtr->getType()->isStructTy()) { 3286 // We need to extract values. 3287 unsigned I = 0; 3288 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++); 3289 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance)) 3290 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++); 3291 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) 3292 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++); 3293 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance)) 3294 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++); 3295 } 3296 3297 if (VirtualBaseAdjustmentOffset) { 3298 ThisPtrForCall = AdjustVirtualBase(CGF, E, RD, This, 3299 VirtualBaseAdjustmentOffset, VBPtrOffset); 3300 } else { 3301 ThisPtrForCall = This.getPointer(); 3302 } 3303 3304 if (NonVirtualBaseAdjustment) { 3305 // Apply the adjustment and cast back to the original struct type. 3306 llvm::Value *Ptr = Builder.CreateBitCast(ThisPtrForCall, CGF.Int8PtrTy); 3307 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment); 3308 ThisPtrForCall = Builder.CreateBitCast(Ptr, ThisPtrForCall->getType(), 3309 "this.adjusted"); 3310 } 3311 3312 FunctionPointer = 3313 Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo()); 3314 CGCallee Callee(FPT, FunctionPointer); 3315 return Callee; 3316 } 3317 3318 CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) { 3319 return new MicrosoftCXXABI(CGM); 3320 } 3321 3322 // MS RTTI Overview: 3323 // The run time type information emitted by cl.exe contains 5 distinct types of 3324 // structures. Many of them reference each other. 3325 // 3326 // TypeInfo: Static classes that are returned by typeid. 3327 // 3328 // CompleteObjectLocator: Referenced by vftables. They contain information 3329 // required for dynamic casting, including OffsetFromTop. They also contain 3330 // a reference to the TypeInfo for the type and a reference to the 3331 // CompleteHierarchyDescriptor for the type. 3332 // 3333 // ClassHieararchyDescriptor: Contains information about a class hierarchy. 3334 // Used during dynamic_cast to walk a class hierarchy. References a base 3335 // class array and the size of said array. 3336 // 3337 // BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is 3338 // somewhat of a misnomer because the most derived class is also in the list 3339 // as well as multiple copies of virtual bases (if they occur multiple times 3340 // in the hiearchy.) The BaseClassArray contains one BaseClassDescriptor for 3341 // every path in the hierarchy, in pre-order depth first order. Note, we do 3342 // not declare a specific llvm type for BaseClassArray, it's merely an array 3343 // of BaseClassDescriptor pointers. 3344 // 3345 // BaseClassDescriptor: Contains information about a class in a class hierarchy. 3346 // BaseClassDescriptor is also somewhat of a misnomer for the same reason that 3347 // BaseClassArray is. It contains information about a class within a 3348 // hierarchy such as: is this base is ambiguous and what is its offset in the 3349 // vbtable. The names of the BaseClassDescriptors have all of their fields 3350 // mangled into them so they can be aggressively deduplicated by the linker. 3351 3352 static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) { 3353 StringRef MangledName("\01??_7type_info@@6B@"); 3354 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName)) 3355 return VTable; 3356 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy, 3357 /*Constant=*/true, 3358 llvm::GlobalVariable::ExternalLinkage, 3359 /*Initializer=*/nullptr, MangledName); 3360 } 3361 3362 namespace { 3363 3364 /// \brief A Helper struct that stores information about a class in a class 3365 /// hierarchy. The information stored in these structs struct is used during 3366 /// the generation of ClassHierarchyDescriptors and BaseClassDescriptors. 3367 // During RTTI creation, MSRTTIClasses are stored in a contiguous array with 3368 // implicit depth first pre-order tree connectivity. getFirstChild and 3369 // getNextSibling allow us to walk the tree efficiently. 3370 struct MSRTTIClass { 3371 enum { 3372 IsPrivateOnPath = 1 | 8, 3373 IsAmbiguous = 2, 3374 IsPrivate = 4, 3375 IsVirtual = 16, 3376 HasHierarchyDescriptor = 64 3377 }; 3378 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {} 3379 uint32_t initialize(const MSRTTIClass *Parent, 3380 const CXXBaseSpecifier *Specifier); 3381 3382 MSRTTIClass *getFirstChild() { return this + 1; } 3383 static MSRTTIClass *getNextChild(MSRTTIClass *Child) { 3384 return Child + 1 + Child->NumBases; 3385 } 3386 3387 const CXXRecordDecl *RD, *VirtualRoot; 3388 uint32_t Flags, NumBases, OffsetInVBase; 3389 }; 3390 3391 /// \brief Recursively initialize the base class array. 3392 uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent, 3393 const CXXBaseSpecifier *Specifier) { 3394 Flags = HasHierarchyDescriptor; 3395 if (!Parent) { 3396 VirtualRoot = nullptr; 3397 OffsetInVBase = 0; 3398 } else { 3399 if (Specifier->getAccessSpecifier() != AS_public) 3400 Flags |= IsPrivate | IsPrivateOnPath; 3401 if (Specifier->isVirtual()) { 3402 Flags |= IsVirtual; 3403 VirtualRoot = RD; 3404 OffsetInVBase = 0; 3405 } else { 3406 if (Parent->Flags & IsPrivateOnPath) 3407 Flags |= IsPrivateOnPath; 3408 VirtualRoot = Parent->VirtualRoot; 3409 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext() 3410 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity(); 3411 } 3412 } 3413 NumBases = 0; 3414 MSRTTIClass *Child = getFirstChild(); 3415 for (const CXXBaseSpecifier &Base : RD->bases()) { 3416 NumBases += Child->initialize(this, &Base) + 1; 3417 Child = getNextChild(Child); 3418 } 3419 return NumBases; 3420 } 3421 3422 static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) { 3423 switch (Ty->getLinkage()) { 3424 case NoLinkage: 3425 case InternalLinkage: 3426 case UniqueExternalLinkage: 3427 return llvm::GlobalValue::InternalLinkage; 3428 3429 case VisibleNoLinkage: 3430 case ExternalLinkage: 3431 return llvm::GlobalValue::LinkOnceODRLinkage; 3432 } 3433 llvm_unreachable("Invalid linkage!"); 3434 } 3435 3436 /// \brief An ephemeral helper class for building MS RTTI types. It caches some 3437 /// calls to the module and information about the most derived class in a 3438 /// hierarchy. 3439 struct MSRTTIBuilder { 3440 enum { 3441 HasBranchingHierarchy = 1, 3442 HasVirtualBranchingHierarchy = 2, 3443 HasAmbiguousBases = 4 3444 }; 3445 3446 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD) 3447 : CGM(ABI.CGM), Context(CGM.getContext()), 3448 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD), 3449 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))), 3450 ABI(ABI) {} 3451 3452 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes); 3453 llvm::GlobalVariable * 3454 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes); 3455 llvm::GlobalVariable *getClassHierarchyDescriptor(); 3456 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo &Info); 3457 3458 CodeGenModule &CGM; 3459 ASTContext &Context; 3460 llvm::LLVMContext &VMContext; 3461 llvm::Module &Module; 3462 const CXXRecordDecl *RD; 3463 llvm::GlobalVariable::LinkageTypes Linkage; 3464 MicrosoftCXXABI &ABI; 3465 }; 3466 3467 } // namespace 3468 3469 /// \brief Recursively serializes a class hierarchy in pre-order depth first 3470 /// order. 3471 static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes, 3472 const CXXRecordDecl *RD) { 3473 Classes.push_back(MSRTTIClass(RD)); 3474 for (const CXXBaseSpecifier &Base : RD->bases()) 3475 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl()); 3476 } 3477 3478 /// \brief Find ambiguity among base classes. 3479 static void 3480 detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) { 3481 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases; 3482 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases; 3483 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases; 3484 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) { 3485 if ((Class->Flags & MSRTTIClass::IsVirtual) && 3486 !VirtualBases.insert(Class->RD).second) { 3487 Class = MSRTTIClass::getNextChild(Class); 3488 continue; 3489 } 3490 if (!UniqueBases.insert(Class->RD).second) 3491 AmbiguousBases.insert(Class->RD); 3492 Class++; 3493 } 3494 if (AmbiguousBases.empty()) 3495 return; 3496 for (MSRTTIClass &Class : Classes) 3497 if (AmbiguousBases.count(Class.RD)) 3498 Class.Flags |= MSRTTIClass::IsAmbiguous; 3499 } 3500 3501 llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() { 3502 SmallString<256> MangledName; 3503 { 3504 llvm::raw_svector_ostream Out(MangledName); 3505 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out); 3506 } 3507 3508 // Check to see if we've already declared this ClassHierarchyDescriptor. 3509 if (auto CHD = Module.getNamedGlobal(MangledName)) 3510 return CHD; 3511 3512 // Serialize the class hierarchy and initialize the CHD Fields. 3513 SmallVector<MSRTTIClass, 8> Classes; 3514 serializeClassHierarchy(Classes, RD); 3515 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr); 3516 detectAmbiguousBases(Classes); 3517 int Flags = 0; 3518 for (auto Class : Classes) { 3519 if (Class.RD->getNumBases() > 1) 3520 Flags |= HasBranchingHierarchy; 3521 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We 3522 // believe the field isn't actually used. 3523 if (Class.Flags & MSRTTIClass::IsAmbiguous) 3524 Flags |= HasAmbiguousBases; 3525 } 3526 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0) 3527 Flags |= HasVirtualBranchingHierarchy; 3528 // These gep indices are used to get the address of the first element of the 3529 // base class array. 3530 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0), 3531 llvm::ConstantInt::get(CGM.IntTy, 0)}; 3532 3533 // Forward-declare the class hierarchy descriptor 3534 auto Type = ABI.getClassHierarchyDescriptorType(); 3535 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage, 3536 /*Initializer=*/nullptr, 3537 MangledName); 3538 if (CHD->isWeakForLinker()) 3539 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName())); 3540 3541 auto *Bases = getBaseClassArray(Classes); 3542 3543 // Initialize the base class ClassHierarchyDescriptor. 3544 llvm::Constant *Fields[] = { 3545 llvm::ConstantInt::get(CGM.IntTy, 0), // reserved by the runtime 3546 llvm::ConstantInt::get(CGM.IntTy, Flags), 3547 llvm::ConstantInt::get(CGM.IntTy, Classes.size()), 3548 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr( 3549 Bases->getValueType(), Bases, 3550 llvm::ArrayRef<llvm::Value *>(GEPIndices))), 3551 }; 3552 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields)); 3553 return CHD; 3554 } 3555 3556 llvm::GlobalVariable * 3557 MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) { 3558 SmallString<256> MangledName; 3559 { 3560 llvm::raw_svector_ostream Out(MangledName); 3561 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out); 3562 } 3563 3564 // Forward-declare the base class array. 3565 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit 3566 // mode) bytes of padding. We provide a pointer sized amount of padding by 3567 // adding +1 to Classes.size(). The sections have pointer alignment and are 3568 // marked pick-any so it shouldn't matter. 3569 llvm::Type *PtrType = ABI.getImageRelativeType( 3570 ABI.getBaseClassDescriptorType()->getPointerTo()); 3571 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1); 3572 auto *BCA = 3573 new llvm::GlobalVariable(Module, ArrType, 3574 /*Constant=*/true, Linkage, 3575 /*Initializer=*/nullptr, MangledName); 3576 if (BCA->isWeakForLinker()) 3577 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName())); 3578 3579 // Initialize the BaseClassArray. 3580 SmallVector<llvm::Constant *, 8> BaseClassArrayData; 3581 for (MSRTTIClass &Class : Classes) 3582 BaseClassArrayData.push_back( 3583 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class))); 3584 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType)); 3585 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData)); 3586 return BCA; 3587 } 3588 3589 llvm::GlobalVariable * 3590 MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) { 3591 // Compute the fields for the BaseClassDescriptor. They are computed up front 3592 // because they are mangled into the name of the object. 3593 uint32_t OffsetInVBTable = 0; 3594 int32_t VBPtrOffset = -1; 3595 if (Class.VirtualRoot) { 3596 auto &VTableContext = CGM.getMicrosoftVTableContext(); 3597 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4; 3598 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity(); 3599 } 3600 3601 SmallString<256> MangledName; 3602 { 3603 llvm::raw_svector_ostream Out(MangledName); 3604 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor( 3605 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable, 3606 Class.Flags, Out); 3607 } 3608 3609 // Check to see if we've already declared this object. 3610 if (auto BCD = Module.getNamedGlobal(MangledName)) 3611 return BCD; 3612 3613 // Forward-declare the base class descriptor. 3614 auto Type = ABI.getBaseClassDescriptorType(); 3615 auto BCD = 3616 new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage, 3617 /*Initializer=*/nullptr, MangledName); 3618 if (BCD->isWeakForLinker()) 3619 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName())); 3620 3621 // Initialize the BaseClassDescriptor. 3622 llvm::Constant *Fields[] = { 3623 ABI.getImageRelativeConstant( 3624 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))), 3625 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases), 3626 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase), 3627 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), 3628 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable), 3629 llvm::ConstantInt::get(CGM.IntTy, Class.Flags), 3630 ABI.getImageRelativeConstant( 3631 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()), 3632 }; 3633 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields)); 3634 return BCD; 3635 } 3636 3637 llvm::GlobalVariable * 3638 MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo &Info) { 3639 SmallString<256> MangledName; 3640 { 3641 llvm::raw_svector_ostream Out(MangledName); 3642 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info.MangledPath, Out); 3643 } 3644 3645 // Check to see if we've already computed this complete object locator. 3646 if (auto COL = Module.getNamedGlobal(MangledName)) 3647 return COL; 3648 3649 // Compute the fields of the complete object locator. 3650 int OffsetToTop = Info.FullOffsetInMDC.getQuantity(); 3651 int VFPtrOffset = 0; 3652 // The offset includes the vtordisp if one exists. 3653 if (const CXXRecordDecl *VBase = Info.getVBaseWithVPtr()) 3654 if (Context.getASTRecordLayout(RD) 3655 .getVBaseOffsetsMap() 3656 .find(VBase) 3657 ->second.hasVtorDisp()) 3658 VFPtrOffset = Info.NonVirtualOffset.getQuantity() + 4; 3659 3660 // Forward-declare the complete object locator. 3661 llvm::StructType *Type = ABI.getCompleteObjectLocatorType(); 3662 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage, 3663 /*Initializer=*/nullptr, MangledName); 3664 3665 // Initialize the CompleteObjectLocator. 3666 llvm::Constant *Fields[] = { 3667 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()), 3668 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop), 3669 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset), 3670 ABI.getImageRelativeConstant( 3671 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))), 3672 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()), 3673 ABI.getImageRelativeConstant(COL), 3674 }; 3675 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields); 3676 if (!ABI.isImageRelative()) 3677 FieldsRef = FieldsRef.drop_back(); 3678 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef)); 3679 if (COL->isWeakForLinker()) 3680 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName())); 3681 return COL; 3682 } 3683 3684 static QualType decomposeTypeForEH(ASTContext &Context, QualType T, 3685 bool &IsConst, bool &IsVolatile, 3686 bool &IsUnaligned) { 3687 T = Context.getExceptionObjectType(T); 3688 3689 // C++14 [except.handle]p3: 3690 // A handler is a match for an exception object of type E if [...] 3691 // - the handler is of type cv T or const T& where T is a pointer type and 3692 // E is a pointer type that can be converted to T by [...] 3693 // - a qualification conversion 3694 IsConst = false; 3695 IsVolatile = false; 3696 IsUnaligned = false; 3697 QualType PointeeType = T->getPointeeType(); 3698 if (!PointeeType.isNull()) { 3699 IsConst = PointeeType.isConstQualified(); 3700 IsVolatile = PointeeType.isVolatileQualified(); 3701 IsUnaligned = PointeeType.getQualifiers().hasUnaligned(); 3702 } 3703 3704 // Member pointer types like "const int A::*" are represented by having RTTI 3705 // for "int A::*" and separately storing the const qualifier. 3706 if (const auto *MPTy = T->getAs<MemberPointerType>()) 3707 T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(), 3708 MPTy->getClass()); 3709 3710 // Pointer types like "const int * const *" are represented by having RTTI 3711 // for "const int **" and separately storing the const qualifier. 3712 if (T->isPointerType()) 3713 T = Context.getPointerType(PointeeType.getUnqualifiedType()); 3714 3715 return T; 3716 } 3717 3718 CatchTypeInfo 3719 MicrosoftCXXABI::getAddrOfCXXCatchHandlerType(QualType Type, 3720 QualType CatchHandlerType) { 3721 // TypeDescriptors for exceptions never have qualified pointer types, 3722 // qualifiers are stored separately in order to support qualification 3723 // conversions. 3724 bool IsConst, IsVolatile, IsUnaligned; 3725 Type = 3726 decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile, IsUnaligned); 3727 3728 bool IsReference = CatchHandlerType->isReferenceType(); 3729 3730 uint32_t Flags = 0; 3731 if (IsConst) 3732 Flags |= 1; 3733 if (IsVolatile) 3734 Flags |= 2; 3735 if (IsUnaligned) 3736 Flags |= 4; 3737 if (IsReference) 3738 Flags |= 8; 3739 3740 return CatchTypeInfo{getAddrOfRTTIDescriptor(Type)->stripPointerCasts(), 3741 Flags}; 3742 } 3743 3744 /// \brief Gets a TypeDescriptor. Returns a llvm::Constant * rather than a 3745 /// llvm::GlobalVariable * because different type descriptors have different 3746 /// types, and need to be abstracted. They are abstracting by casting the 3747 /// address to an Int8PtrTy. 3748 llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) { 3749 SmallString<256> MangledName; 3750 { 3751 llvm::raw_svector_ostream Out(MangledName); 3752 getMangleContext().mangleCXXRTTI(Type, Out); 3753 } 3754 3755 // Check to see if we've already declared this TypeDescriptor. 3756 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName)) 3757 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy); 3758 3759 // Compute the fields for the TypeDescriptor. 3760 SmallString<256> TypeInfoString; 3761 { 3762 llvm::raw_svector_ostream Out(TypeInfoString); 3763 getMangleContext().mangleCXXRTTIName(Type, Out); 3764 } 3765 3766 // Declare and initialize the TypeDescriptor. 3767 llvm::Constant *Fields[] = { 3768 getTypeInfoVTable(CGM), // VFPtr 3769 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data 3770 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)}; 3771 llvm::StructType *TypeDescriptorType = 3772 getTypeDescriptorType(TypeInfoString); 3773 auto *Var = new llvm::GlobalVariable( 3774 CGM.getModule(), TypeDescriptorType, /*Constant=*/false, 3775 getLinkageForRTTI(Type), 3776 llvm::ConstantStruct::get(TypeDescriptorType, Fields), 3777 MangledName); 3778 if (Var->isWeakForLinker()) 3779 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName())); 3780 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy); 3781 } 3782 3783 /// \brief Gets or a creates a Microsoft CompleteObjectLocator. 3784 llvm::GlobalVariable * 3785 MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD, 3786 const VPtrInfo &Info) { 3787 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info); 3788 } 3789 3790 static void emitCXXConstructor(CodeGenModule &CGM, 3791 const CXXConstructorDecl *ctor, 3792 StructorType ctorType) { 3793 // There are no constructor variants, always emit the complete destructor. 3794 llvm::Function *Fn = CGM.codegenCXXStructor(ctor, StructorType::Complete); 3795 CGM.maybeSetTrivialComdat(*ctor, *Fn); 3796 } 3797 3798 static void emitCXXDestructor(CodeGenModule &CGM, const CXXDestructorDecl *dtor, 3799 StructorType dtorType) { 3800 // The complete destructor is equivalent to the base destructor for 3801 // classes with no virtual bases, so try to emit it as an alias. 3802 if (!dtor->getParent()->getNumVBases() && 3803 (dtorType == StructorType::Complete || dtorType == StructorType::Base)) { 3804 bool ProducedAlias = !CGM.TryEmitDefinitionAsAlias( 3805 GlobalDecl(dtor, Dtor_Complete), GlobalDecl(dtor, Dtor_Base), true); 3806 if (ProducedAlias) { 3807 if (dtorType == StructorType::Complete) 3808 return; 3809 if (dtor->isVirtual()) 3810 CGM.getVTables().EmitThunks(GlobalDecl(dtor, Dtor_Complete)); 3811 } 3812 } 3813 3814 // The base destructor is equivalent to the base destructor of its 3815 // base class if there is exactly one non-virtual base class with a 3816 // non-trivial destructor, there are no fields with a non-trivial 3817 // destructor, and the body of the destructor is trivial. 3818 if (dtorType == StructorType::Base && !CGM.TryEmitBaseDestructorAsAlias(dtor)) 3819 return; 3820 3821 llvm::Function *Fn = CGM.codegenCXXStructor(dtor, dtorType); 3822 if (Fn->isWeakForLinker()) 3823 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName())); 3824 } 3825 3826 void MicrosoftCXXABI::emitCXXStructor(const CXXMethodDecl *MD, 3827 StructorType Type) { 3828 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) { 3829 emitCXXConstructor(CGM, CD, Type); 3830 return; 3831 } 3832 emitCXXDestructor(CGM, cast<CXXDestructorDecl>(MD), Type); 3833 } 3834 3835 llvm::Function * 3836 MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD, 3837 CXXCtorType CT) { 3838 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure); 3839 3840 // Calculate the mangled name. 3841 SmallString<256> ThunkName; 3842 llvm::raw_svector_ostream Out(ThunkName); 3843 getMangleContext().mangleCXXCtor(CD, CT, Out); 3844 3845 // If the thunk has been generated previously, just return it. 3846 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName)) 3847 return cast<llvm::Function>(GV); 3848 3849 // Create the llvm::Function. 3850 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT); 3851 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo); 3852 const CXXRecordDecl *RD = CD->getParent(); 3853 QualType RecordTy = getContext().getRecordType(RD); 3854 llvm::Function *ThunkFn = llvm::Function::Create( 3855 ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule()); 3856 ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>( 3857 FnInfo.getEffectiveCallingConvention())); 3858 if (ThunkFn->isWeakForLinker()) 3859 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName())); 3860 bool IsCopy = CT == Ctor_CopyingClosure; 3861 3862 // Start codegen. 3863 CodeGenFunction CGF(CGM); 3864 CGF.CurGD = GlobalDecl(CD, Ctor_Complete); 3865 3866 // Build FunctionArgs. 3867 FunctionArgList FunctionArgs; 3868 3869 // A constructor always starts with a 'this' pointer as its first argument. 3870 buildThisParam(CGF, FunctionArgs); 3871 3872 // Following the 'this' pointer is a reference to the source object that we 3873 // are copying from. 3874 ImplicitParamDecl SrcParam( 3875 getContext(), nullptr, SourceLocation(), &getContext().Idents.get("src"), 3876 getContext().getLValueReferenceType(RecordTy, 3877 /*SpelledAsLValue=*/true)); 3878 if (IsCopy) 3879 FunctionArgs.push_back(&SrcParam); 3880 3881 // Constructors for classes which utilize virtual bases have an additional 3882 // parameter which indicates whether or not it is being delegated to by a more 3883 // derived constructor. 3884 ImplicitParamDecl IsMostDerived(getContext(), nullptr, SourceLocation(), 3885 &getContext().Idents.get("is_most_derived"), 3886 getContext().IntTy); 3887 // Only add the parameter to the list if thie class has virtual bases. 3888 if (RD->getNumVBases() > 0) 3889 FunctionArgs.push_back(&IsMostDerived); 3890 3891 // Start defining the function. 3892 auto NL = ApplyDebugLocation::CreateEmpty(CGF); 3893 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo, 3894 FunctionArgs, CD->getLocation(), SourceLocation()); 3895 // Create a scope with an artificial location for the body of this function. 3896 auto AL = ApplyDebugLocation::CreateArtificial(CGF); 3897 EmitThisParam(CGF); 3898 llvm::Value *This = getThisValue(CGF); 3899 3900 llvm::Value *SrcVal = 3901 IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src") 3902 : nullptr; 3903 3904 CallArgList Args; 3905 3906 // Push the this ptr. 3907 Args.add(RValue::get(This), CD->getThisType(getContext())); 3908 3909 // Push the src ptr. 3910 if (SrcVal) 3911 Args.add(RValue::get(SrcVal), SrcParam.getType()); 3912 3913 // Add the rest of the default arguments. 3914 SmallVector<const Stmt *, 4> ArgVec; 3915 ArrayRef<ParmVarDecl *> params = CD->parameters().drop_front(IsCopy ? 1 : 0); 3916 for (const ParmVarDecl *PD : params) { 3917 assert(PD->hasDefaultArg() && "ctor closure lacks default args"); 3918 ArgVec.push_back(PD->getDefaultArg()); 3919 } 3920 3921 CodeGenFunction::RunCleanupsScope Cleanups(CGF); 3922 3923 const auto *FPT = CD->getType()->castAs<FunctionProtoType>(); 3924 CGF.EmitCallArgs(Args, FPT, llvm::makeArrayRef(ArgVec), CD, IsCopy ? 1 : 0); 3925 3926 // Insert any ABI-specific implicit constructor arguments. 3927 AddedStructorArgs ExtraArgs = 3928 addImplicitConstructorArgs(CGF, CD, Ctor_Complete, 3929 /*ForVirtualBase=*/false, 3930 /*Delegating=*/false, Args); 3931 // Call the destructor with our arguments. 3932 llvm::Constant *CalleePtr = 3933 CGM.getAddrOfCXXStructor(CD, StructorType::Complete); 3934 CGCallee Callee = CGCallee::forDirect(CalleePtr, CD); 3935 const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall( 3936 Args, CD, Ctor_Complete, ExtraArgs.Prefix, ExtraArgs.Suffix); 3937 CGF.EmitCall(CalleeInfo, Callee, ReturnValueSlot(), Args); 3938 3939 Cleanups.ForceCleanup(); 3940 3941 // Emit the ret instruction, remove any temporary instructions created for the 3942 // aid of CodeGen. 3943 CGF.FinishFunction(SourceLocation()); 3944 3945 return ThunkFn; 3946 } 3947 3948 llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T, 3949 uint32_t NVOffset, 3950 int32_t VBPtrOffset, 3951 uint32_t VBIndex) { 3952 assert(!T->isReferenceType()); 3953 3954 CXXRecordDecl *RD = T->getAsCXXRecordDecl(); 3955 const CXXConstructorDecl *CD = 3956 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr; 3957 CXXCtorType CT = Ctor_Complete; 3958 if (CD) 3959 if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1) 3960 CT = Ctor_CopyingClosure; 3961 3962 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity(); 3963 SmallString<256> MangledName; 3964 { 3965 llvm::raw_svector_ostream Out(MangledName); 3966 getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset, 3967 VBPtrOffset, VBIndex, Out); 3968 } 3969 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName)) 3970 return getImageRelativeConstant(GV); 3971 3972 // The TypeDescriptor is used by the runtime to determine if a catch handler 3973 // is appropriate for the exception object. 3974 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T)); 3975 3976 // The runtime is responsible for calling the copy constructor if the 3977 // exception is caught by value. 3978 llvm::Constant *CopyCtor; 3979 if (CD) { 3980 if (CT == Ctor_CopyingClosure) 3981 CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure); 3982 else 3983 CopyCtor = CGM.getAddrOfCXXStructor(CD, StructorType::Complete); 3984 3985 CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy); 3986 } else { 3987 CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy); 3988 } 3989 CopyCtor = getImageRelativeConstant(CopyCtor); 3990 3991 bool IsScalar = !RD; 3992 bool HasVirtualBases = false; 3993 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason. 3994 QualType PointeeType = T; 3995 if (T->isPointerType()) 3996 PointeeType = T->getPointeeType(); 3997 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) { 3998 HasVirtualBases = RD->getNumVBases() > 0; 3999 if (IdentifierInfo *II = RD->getIdentifier()) 4000 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace(); 4001 } 4002 4003 // Encode the relevant CatchableType properties into the Flags bitfield. 4004 // FIXME: Figure out how bits 2 or 8 can get set. 4005 uint32_t Flags = 0; 4006 if (IsScalar) 4007 Flags |= 1; 4008 if (HasVirtualBases) 4009 Flags |= 4; 4010 if (IsStdBadAlloc) 4011 Flags |= 16; 4012 4013 llvm::Constant *Fields[] = { 4014 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags 4015 TD, // TypeDescriptor 4016 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment 4017 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr 4018 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex 4019 llvm::ConstantInt::get(CGM.IntTy, Size), // Size 4020 CopyCtor // CopyCtor 4021 }; 4022 llvm::StructType *CTType = getCatchableTypeType(); 4023 auto *GV = new llvm::GlobalVariable( 4024 CGM.getModule(), CTType, /*Constant=*/true, getLinkageForRTTI(T), 4025 llvm::ConstantStruct::get(CTType, Fields), MangledName); 4026 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global); 4027 GV->setSection(".xdata"); 4028 if (GV->isWeakForLinker()) 4029 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName())); 4030 return getImageRelativeConstant(GV); 4031 } 4032 4033 llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) { 4034 assert(!T->isReferenceType()); 4035 4036 // See if we've already generated a CatchableTypeArray for this type before. 4037 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T]; 4038 if (CTA) 4039 return CTA; 4040 4041 // Ensure that we don't have duplicate entries in our CatchableTypeArray by 4042 // using a SmallSetVector. Duplicates may arise due to virtual bases 4043 // occurring more than once in the hierarchy. 4044 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes; 4045 4046 // C++14 [except.handle]p3: 4047 // A handler is a match for an exception object of type E if [...] 4048 // - the handler is of type cv T or cv T& and T is an unambiguous public 4049 // base class of E, or 4050 // - the handler is of type cv T or const T& where T is a pointer type and 4051 // E is a pointer type that can be converted to T by [...] 4052 // - a standard pointer conversion (4.10) not involving conversions to 4053 // pointers to private or protected or ambiguous classes 4054 const CXXRecordDecl *MostDerivedClass = nullptr; 4055 bool IsPointer = T->isPointerType(); 4056 if (IsPointer) 4057 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl(); 4058 else 4059 MostDerivedClass = T->getAsCXXRecordDecl(); 4060 4061 // Collect all the unambiguous public bases of the MostDerivedClass. 4062 if (MostDerivedClass) { 4063 const ASTContext &Context = getContext(); 4064 const ASTRecordLayout &MostDerivedLayout = 4065 Context.getASTRecordLayout(MostDerivedClass); 4066 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext(); 4067 SmallVector<MSRTTIClass, 8> Classes; 4068 serializeClassHierarchy(Classes, MostDerivedClass); 4069 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr); 4070 detectAmbiguousBases(Classes); 4071 for (const MSRTTIClass &Class : Classes) { 4072 // Skip any ambiguous or private bases. 4073 if (Class.Flags & 4074 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous)) 4075 continue; 4076 // Write down how to convert from a derived pointer to a base pointer. 4077 uint32_t OffsetInVBTable = 0; 4078 int32_t VBPtrOffset = -1; 4079 if (Class.VirtualRoot) { 4080 OffsetInVBTable = 4081 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4; 4082 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity(); 4083 } 4084 4085 // Turn our record back into a pointer if the exception object is a 4086 // pointer. 4087 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0); 4088 if (IsPointer) 4089 RTTITy = Context.getPointerType(RTTITy); 4090 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase, 4091 VBPtrOffset, OffsetInVBTable)); 4092 } 4093 } 4094 4095 // C++14 [except.handle]p3: 4096 // A handler is a match for an exception object of type E if 4097 // - The handler is of type cv T or cv T& and E and T are the same type 4098 // (ignoring the top-level cv-qualifiers) 4099 CatchableTypes.insert(getCatchableType(T)); 4100 4101 // C++14 [except.handle]p3: 4102 // A handler is a match for an exception object of type E if 4103 // - the handler is of type cv T or const T& where T is a pointer type and 4104 // E is a pointer type that can be converted to T by [...] 4105 // - a standard pointer conversion (4.10) not involving conversions to 4106 // pointers to private or protected or ambiguous classes 4107 // 4108 // C++14 [conv.ptr]p2: 4109 // A prvalue of type "pointer to cv T," where T is an object type, can be 4110 // converted to a prvalue of type "pointer to cv void". 4111 if (IsPointer && T->getPointeeType()->isObjectType()) 4112 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy)); 4113 4114 // C++14 [except.handle]p3: 4115 // A handler is a match for an exception object of type E if [...] 4116 // - the handler is of type cv T or const T& where T is a pointer or 4117 // pointer to member type and E is std::nullptr_t. 4118 // 4119 // We cannot possibly list all possible pointer types here, making this 4120 // implementation incompatible with the standard. However, MSVC includes an 4121 // entry for pointer-to-void in this case. Let's do the same. 4122 if (T->isNullPtrType()) 4123 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy)); 4124 4125 uint32_t NumEntries = CatchableTypes.size(); 4126 llvm::Type *CTType = 4127 getImageRelativeType(getCatchableTypeType()->getPointerTo()); 4128 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries); 4129 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries); 4130 llvm::Constant *Fields[] = { 4131 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries 4132 llvm::ConstantArray::get( 4133 AT, llvm::makeArrayRef(CatchableTypes.begin(), 4134 CatchableTypes.end())) // CatchableTypes 4135 }; 4136 SmallString<256> MangledName; 4137 { 4138 llvm::raw_svector_ostream Out(MangledName); 4139 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out); 4140 } 4141 CTA = new llvm::GlobalVariable( 4142 CGM.getModule(), CTAType, /*Constant=*/true, getLinkageForRTTI(T), 4143 llvm::ConstantStruct::get(CTAType, Fields), MangledName); 4144 CTA->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global); 4145 CTA->setSection(".xdata"); 4146 if (CTA->isWeakForLinker()) 4147 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName())); 4148 return CTA; 4149 } 4150 4151 llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) { 4152 bool IsConst, IsVolatile, IsUnaligned; 4153 T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile, IsUnaligned); 4154 4155 // The CatchableTypeArray enumerates the various (CV-unqualified) types that 4156 // the exception object may be caught as. 4157 llvm::GlobalVariable *CTA = getCatchableTypeArray(T); 4158 // The first field in a CatchableTypeArray is the number of CatchableTypes. 4159 // This is used as a component of the mangled name which means that we need to 4160 // know what it is in order to see if we have previously generated the 4161 // ThrowInfo. 4162 uint32_t NumEntries = 4163 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U)) 4164 ->getLimitedValue(); 4165 4166 SmallString<256> MangledName; 4167 { 4168 llvm::raw_svector_ostream Out(MangledName); 4169 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, IsUnaligned, 4170 NumEntries, Out); 4171 } 4172 4173 // Reuse a previously generated ThrowInfo if we have generated an appropriate 4174 // one before. 4175 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName)) 4176 return GV; 4177 4178 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must 4179 // be at least as CV qualified. Encode this requirement into the Flags 4180 // bitfield. 4181 uint32_t Flags = 0; 4182 if (IsConst) 4183 Flags |= 1; 4184 if (IsVolatile) 4185 Flags |= 2; 4186 if (IsUnaligned) 4187 Flags |= 4; 4188 4189 // The cleanup-function (a destructor) must be called when the exception 4190 // object's lifetime ends. 4191 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy); 4192 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl()) 4193 if (CXXDestructorDecl *DtorD = RD->getDestructor()) 4194 if (!DtorD->isTrivial()) 4195 CleanupFn = llvm::ConstantExpr::getBitCast( 4196 CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete), 4197 CGM.Int8PtrTy); 4198 // This is unused as far as we can tell, initialize it to null. 4199 llvm::Constant *ForwardCompat = 4200 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy)); 4201 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant( 4202 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy)); 4203 llvm::StructType *TIType = getThrowInfoType(); 4204 llvm::Constant *Fields[] = { 4205 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags 4206 getImageRelativeConstant(CleanupFn), // CleanupFn 4207 ForwardCompat, // ForwardCompat 4208 PointerToCatchableTypes // CatchableTypeArray 4209 }; 4210 auto *GV = new llvm::GlobalVariable( 4211 CGM.getModule(), TIType, /*Constant=*/true, getLinkageForRTTI(T), 4212 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName)); 4213 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global); 4214 GV->setSection(".xdata"); 4215 if (GV->isWeakForLinker()) 4216 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName())); 4217 return GV; 4218 } 4219 4220 void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) { 4221 const Expr *SubExpr = E->getSubExpr(); 4222 QualType ThrowType = SubExpr->getType(); 4223 // The exception object lives on the stack and it's address is passed to the 4224 // runtime function. 4225 Address AI = CGF.CreateMemTemp(ThrowType); 4226 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(), 4227 /*IsInit=*/true); 4228 4229 // The so-called ThrowInfo is used to describe how the exception object may be 4230 // caught. 4231 llvm::GlobalVariable *TI = getThrowInfo(ThrowType); 4232 4233 // Call into the runtime to throw the exception. 4234 llvm::Value *Args[] = { 4235 CGF.Builder.CreateBitCast(AI.getPointer(), CGM.Int8PtrTy), 4236 TI 4237 }; 4238 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args); 4239 } 4240