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