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     if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) {
1249       llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure);
1250       Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage);
1251       CGM.setGVProperties(Fn, D);
1252     }
1253 }
1254 
1255 void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1256                                       const CXXRecordDecl *RD) {
1257   Address This = getThisAddress(CGF);
1258   This = CGF.Builder.CreateElementBitCast(This, CGM.Int8Ty, "this.int8");
1259   const ASTContext &Context = getContext();
1260   const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1261 
1262   const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1263   for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
1264     const std::unique_ptr<VPtrInfo> &VBT = (*VBGlobals.VBTables)[I];
1265     llvm::GlobalVariable *GV = VBGlobals.Globals[I];
1266     const ASTRecordLayout &SubobjectLayout =
1267         Context.getASTRecordLayout(VBT->IntroducingObject);
1268     CharUnits Offs = VBT->NonVirtualOffset;
1269     Offs += SubobjectLayout.getVBPtrOffset();
1270     if (VBT->getVBaseWithVPtr())
1271       Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
1272     Address VBPtr = CGF.Builder.CreateConstInBoundsByteGEP(This, Offs);
1273     llvm::Value *GVPtr =
1274         CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0);
1275     VBPtr = CGF.Builder.CreateElementBitCast(VBPtr, GVPtr->getType(),
1276                                       "vbptr." + VBT->ObjectWithVPtr->getName());
1277     CGF.Builder.CreateStore(GVPtr, VBPtr);
1278   }
1279 }
1280 
1281 CGCXXABI::AddedStructorArgCounts
1282 MicrosoftCXXABI::buildStructorSignature(GlobalDecl GD,
1283                                         SmallVectorImpl<CanQualType> &ArgTys) {
1284   AddedStructorArgCounts Added;
1285   // TODO: 'for base' flag
1286   if (isa<CXXDestructorDecl>(GD.getDecl()) &&
1287       GD.getDtorType() == Dtor_Deleting) {
1288     // The scalar deleting destructor takes an implicit int parameter.
1289     ArgTys.push_back(getContext().IntTy);
1290     ++Added.Suffix;
1291   }
1292   auto *CD = dyn_cast<CXXConstructorDecl>(GD.getDecl());
1293   if (!CD)
1294     return Added;
1295 
1296   // All parameters are already in place except is_most_derived, which goes
1297   // after 'this' if it's variadic and last if it's not.
1298 
1299   const CXXRecordDecl *Class = CD->getParent();
1300   const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1301   if (Class->getNumVBases()) {
1302     if (FPT->isVariadic()) {
1303       ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
1304       ++Added.Prefix;
1305     } else {
1306       ArgTys.push_back(getContext().IntTy);
1307       ++Added.Suffix;
1308     }
1309   }
1310 
1311   return Added;
1312 }
1313 
1314 void MicrosoftCXXABI::setCXXDestructorDLLStorage(llvm::GlobalValue *GV,
1315                                                  const CXXDestructorDecl *Dtor,
1316                                                  CXXDtorType DT) const {
1317   // Deleting destructor variants are never imported or exported. Give them the
1318   // default storage class.
1319   if (DT == Dtor_Deleting) {
1320     GV->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
1321   } else {
1322     const NamedDecl *ND = Dtor;
1323     CGM.setDLLImportDLLExport(GV, ND);
1324   }
1325 }
1326 
1327 llvm::GlobalValue::LinkageTypes MicrosoftCXXABI::getCXXDestructorLinkage(
1328     GVALinkage Linkage, const CXXDestructorDecl *Dtor, CXXDtorType DT) const {
1329   // Internal things are always internal, regardless of attributes. After this,
1330   // we know the thunk is externally visible.
1331   if (Linkage == GVA_Internal)
1332     return llvm::GlobalValue::InternalLinkage;
1333 
1334   switch (DT) {
1335   case Dtor_Base:
1336     // The base destructor most closely tracks the user-declared constructor, so
1337     // we delegate back to the normal declarator case.
1338     return CGM.getLLVMLinkageForDeclarator(Dtor, Linkage,
1339                                            /*IsConstantVariable=*/false);
1340   case Dtor_Complete:
1341     // The complete destructor is like an inline function, but it may be
1342     // imported and therefore must be exported as well. This requires changing
1343     // the linkage if a DLL attribute is present.
1344     if (Dtor->hasAttr<DLLExportAttr>())
1345       return llvm::GlobalValue::WeakODRLinkage;
1346     if (Dtor->hasAttr<DLLImportAttr>())
1347       return llvm::GlobalValue::AvailableExternallyLinkage;
1348     return llvm::GlobalValue::LinkOnceODRLinkage;
1349   case Dtor_Deleting:
1350     // Deleting destructors are like inline functions. They have vague linkage
1351     // and are emitted everywhere they are used. They are internal if the class
1352     // is internal.
1353     return llvm::GlobalValue::LinkOnceODRLinkage;
1354   case Dtor_Comdat:
1355     llvm_unreachable("MS C++ ABI does not support comdat dtors");
1356   }
1357   llvm_unreachable("invalid dtor type");
1358 }
1359 
1360 void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1361   // The TU defining a dtor is only guaranteed to emit a base destructor.  All
1362   // other destructor variants are delegating thunks.
1363   CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1364 
1365   // If the class is dllexported, emit the complete (vbase) destructor wherever
1366   // the base dtor is emitted.
1367   // FIXME: To match MSVC, this should only be done when the class is exported
1368   // with -fdllexport-inlines enabled.
1369   if (D->getParent()->getNumVBases() > 0 && D->hasAttr<DLLExportAttr>())
1370     CGM.EmitGlobal(GlobalDecl(D, Dtor_Complete));
1371 }
1372 
1373 CharUnits
1374 MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
1375   const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
1376 
1377   if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1378     // Complete destructors take a pointer to the complete object as a
1379     // parameter, thus don't need this adjustment.
1380     if (GD.getDtorType() == Dtor_Complete)
1381       return CharUnits();
1382 
1383     // There's no Dtor_Base in vftable but it shares the this adjustment with
1384     // the deleting one, so look it up instead.
1385     GD = GlobalDecl(DD, Dtor_Deleting);
1386   }
1387 
1388   MethodVFTableLocation ML =
1389       CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1390   CharUnits Adjustment = ML.VFPtrOffset;
1391 
1392   // Normal virtual instance methods need to adjust from the vfptr that first
1393   // defined the virtual method to the virtual base subobject, but destructors
1394   // do not.  The vector deleting destructor thunk applies this adjustment for
1395   // us if necessary.
1396   if (isa<CXXDestructorDecl>(MD))
1397     Adjustment = CharUnits::Zero();
1398 
1399   if (ML.VBase) {
1400     const ASTRecordLayout &DerivedLayout =
1401         getContext().getASTRecordLayout(MD->getParent());
1402     Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1403   }
1404 
1405   return Adjustment;
1406 }
1407 
1408 Address MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1409     CodeGenFunction &CGF, GlobalDecl GD, Address This,
1410     bool VirtualCall) {
1411   if (!VirtualCall) {
1412     // If the call of a virtual function is not virtual, we just have to
1413     // compensate for the adjustment the virtual function does in its prologue.
1414     CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1415     if (Adjustment.isZero())
1416       return This;
1417 
1418     This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
1419     assert(Adjustment.isPositive());
1420     return CGF.Builder.CreateConstByteGEP(This, Adjustment);
1421   }
1422 
1423   const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
1424 
1425   GlobalDecl LookupGD = GD;
1426   if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1427     // Complete dtors take a pointer to the complete object,
1428     // thus don't need adjustment.
1429     if (GD.getDtorType() == Dtor_Complete)
1430       return This;
1431 
1432     // There's only Dtor_Deleting in vftable but it shares the this adjustment
1433     // with the base one, so look up the deleting one instead.
1434     LookupGD = GlobalDecl(DD, Dtor_Deleting);
1435   }
1436   MethodVFTableLocation ML =
1437       CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
1438 
1439   CharUnits StaticOffset = ML.VFPtrOffset;
1440 
1441   // Base destructors expect 'this' to point to the beginning of the base
1442   // subobject, not the first vfptr that happens to contain the virtual dtor.
1443   // However, we still need to apply the virtual base adjustment.
1444   if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1445     StaticOffset = CharUnits::Zero();
1446 
1447   Address Result = This;
1448   if (ML.VBase) {
1449     Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
1450 
1451     const CXXRecordDecl *Derived = MD->getParent();
1452     const CXXRecordDecl *VBase = ML.VBase;
1453     llvm::Value *VBaseOffset =
1454       GetVirtualBaseClassOffset(CGF, Result, Derived, VBase);
1455     llvm::Value *VBasePtr =
1456       CGF.Builder.CreateInBoundsGEP(Result.getPointer(), VBaseOffset);
1457     CharUnits VBaseAlign =
1458       CGF.CGM.getVBaseAlignment(Result.getAlignment(), Derived, VBase);
1459     Result = Address(VBasePtr, VBaseAlign);
1460   }
1461   if (!StaticOffset.isZero()) {
1462     assert(StaticOffset.isPositive());
1463     Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
1464     if (ML.VBase) {
1465       // Non-virtual adjustment might result in a pointer outside the allocated
1466       // object, e.g. if the final overrider class is laid out after the virtual
1467       // base that declares a method in the most derived class.
1468       // FIXME: Update the code that emits this adjustment in thunks prologues.
1469       Result = CGF.Builder.CreateConstByteGEP(Result, StaticOffset);
1470     } else {
1471       Result = CGF.Builder.CreateConstInBoundsByteGEP(Result, StaticOffset);
1472     }
1473   }
1474   return Result;
1475 }
1476 
1477 void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1478                                                 QualType &ResTy,
1479                                                 FunctionArgList &Params) {
1480   ASTContext &Context = getContext();
1481   const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1482   assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
1483   if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1484     auto *IsMostDerived = ImplicitParamDecl::Create(
1485         Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1486         &Context.Idents.get("is_most_derived"), Context.IntTy,
1487         ImplicitParamDecl::Other);
1488     // The 'most_derived' parameter goes second if the ctor is variadic and last
1489     // if it's not.  Dtors can't be variadic.
1490     const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1491     if (FPT->isVariadic())
1492       Params.insert(Params.begin() + 1, IsMostDerived);
1493     else
1494       Params.push_back(IsMostDerived);
1495     getStructorImplicitParamDecl(CGF) = IsMostDerived;
1496   } else if (isDeletingDtor(CGF.CurGD)) {
1497     auto *ShouldDelete = ImplicitParamDecl::Create(
1498         Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1499         &Context.Idents.get("should_call_delete"), Context.IntTy,
1500         ImplicitParamDecl::Other);
1501     Params.push_back(ShouldDelete);
1502     getStructorImplicitParamDecl(CGF) = ShouldDelete;
1503   }
1504 }
1505 
1506 void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
1507   // Naked functions have no prolog.
1508   if (CGF.CurFuncDecl && CGF.CurFuncDecl->hasAttr<NakedAttr>())
1509     return;
1510 
1511   // Overridden virtual methods of non-primary bases need to adjust the incoming
1512   // 'this' pointer in the prologue. In this hierarchy, C::b will subtract
1513   // sizeof(void*) to adjust from B* to C*:
1514   //   struct A { virtual void a(); };
1515   //   struct B { virtual void b(); };
1516   //   struct C : A, B { virtual void b(); };
1517   //
1518   // Leave the value stored in the 'this' alloca unadjusted, so that the
1519   // debugger sees the unadjusted value. Microsoft debuggers require this, and
1520   // will apply the ThisAdjustment in the method type information.
1521   // FIXME: Do something better for DWARF debuggers, which won't expect this,
1522   // without making our codegen depend on debug info settings.
1523   llvm::Value *This = loadIncomingCXXThis(CGF);
1524   const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1525   if (!CGF.CurFuncIsThunk && MD->isVirtual()) {
1526     CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(CGF.CurGD);
1527     if (!Adjustment.isZero()) {
1528       unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1529       llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1530                  *thisTy = This->getType();
1531       This = CGF.Builder.CreateBitCast(This, charPtrTy);
1532       assert(Adjustment.isPositive());
1533       This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
1534                                                     -Adjustment.getQuantity());
1535       This = CGF.Builder.CreateBitCast(This, thisTy, "this.adjusted");
1536     }
1537   }
1538   setCXXABIThisValue(CGF, This);
1539 
1540   // If this is a function that the ABI specifies returns 'this', initialize
1541   // the return slot to 'this' at the start of the function.
1542   //
1543   // Unlike the setting of return types, this is done within the ABI
1544   // implementation instead of by clients of CGCXXABI because:
1545   // 1) getThisValue is currently protected
1546   // 2) in theory, an ABI could implement 'this' returns some other way;
1547   //    HasThisReturn only specifies a contract, not the implementation
1548   if (HasThisReturn(CGF.CurGD))
1549     CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
1550   else if (hasMostDerivedReturn(CGF.CurGD))
1551     CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1552                             CGF.ReturnValue);
1553 
1554   if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1555     assert(getStructorImplicitParamDecl(CGF) &&
1556            "no implicit parameter for a constructor with virtual bases?");
1557     getStructorImplicitParamValue(CGF)
1558       = CGF.Builder.CreateLoad(
1559           CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1560           "is_most_derived");
1561   }
1562 
1563   if (isDeletingDtor(CGF.CurGD)) {
1564     assert(getStructorImplicitParamDecl(CGF) &&
1565            "no implicit parameter for a deleting destructor?");
1566     getStructorImplicitParamValue(CGF)
1567       = CGF.Builder.CreateLoad(
1568           CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1569           "should_call_delete");
1570   }
1571 }
1572 
1573 CGCXXABI::AddedStructorArgs MicrosoftCXXABI::getImplicitConstructorArgs(
1574     CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1575     bool ForVirtualBase, bool Delegating) {
1576   assert(Type == Ctor_Complete || Type == Ctor_Base);
1577 
1578   // Check if we need a 'most_derived' parameter.
1579   if (!D->getParent()->getNumVBases())
1580     return AddedStructorArgs{};
1581 
1582   // Add the 'most_derived' argument second if we are variadic or last if not.
1583   const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
1584   llvm::Value *MostDerivedArg;
1585   if (Delegating) {
1586     MostDerivedArg = getStructorImplicitParamValue(CGF);
1587   } else {
1588     MostDerivedArg = llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
1589   }
1590   if (FPT->isVariadic()) {
1591     return AddedStructorArgs::prefix({{MostDerivedArg, getContext().IntTy}});
1592   }
1593   return AddedStructorArgs::suffix({{MostDerivedArg, getContext().IntTy}});
1594 }
1595 
1596 llvm::Value *MicrosoftCXXABI::getCXXDestructorImplicitParam(
1597     CodeGenFunction &CGF, const CXXDestructorDecl *DD, CXXDtorType Type,
1598     bool ForVirtualBase, bool Delegating) {
1599   return nullptr;
1600 }
1601 
1602 void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1603                                          const CXXDestructorDecl *DD,
1604                                          CXXDtorType Type, bool ForVirtualBase,
1605                                          bool Delegating, Address This,
1606                                          QualType ThisTy) {
1607   // Use the base destructor variant in place of the complete destructor variant
1608   // if the class has no virtual bases. This effectively implements some of the
1609   // -mconstructor-aliases optimization, but as part of the MS C++ ABI.
1610   if (Type == Dtor_Complete && DD->getParent()->getNumVBases() == 0)
1611     Type = Dtor_Base;
1612 
1613   GlobalDecl GD(DD, Type);
1614   CGCallee Callee = CGCallee::forDirect(CGM.getAddrOfCXXStructor(GD), GD);
1615 
1616   if (DD->isVirtual()) {
1617     assert(Type != CXXDtorType::Dtor_Deleting &&
1618            "The deleting destructor should only be called via a virtual call");
1619     This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1620                                                     This, false);
1621   }
1622 
1623   llvm::BasicBlock *BaseDtorEndBB = nullptr;
1624   if (ForVirtualBase && isa<CXXConstructorDecl>(CGF.CurCodeDecl)) {
1625     BaseDtorEndBB = EmitDtorCompleteObjectHandler(CGF);
1626   }
1627 
1628   llvm::Value *Implicit =
1629       getCXXDestructorImplicitParam(CGF, DD, Type, ForVirtualBase,
1630                                     Delegating); // = nullptr
1631   CGF.EmitCXXDestructorCall(GD, Callee, This.getPointer(), ThisTy,
1632                             /*ImplicitParam=*/Implicit,
1633                             /*ImplicitParamTy=*/QualType(), nullptr);
1634   if (BaseDtorEndBB) {
1635     // Complete object handler should continue to be the remaining
1636     CGF.Builder.CreateBr(BaseDtorEndBB);
1637     CGF.EmitBlock(BaseDtorEndBB);
1638   }
1639 }
1640 
1641 void MicrosoftCXXABI::emitVTableTypeMetadata(const VPtrInfo &Info,
1642                                              const CXXRecordDecl *RD,
1643                                              llvm::GlobalVariable *VTable) {
1644   if (!CGM.getCodeGenOpts().LTOUnit)
1645     return;
1646 
1647   // TODO: Should VirtualFunctionElimination also be supported here?
1648   // See similar handling in CodeGenModule::EmitVTableTypeMetadata.
1649   if (CGM.getCodeGenOpts().WholeProgramVTables) {
1650     llvm::GlobalObject::VCallVisibility TypeVis =
1651         CGM.GetVCallVisibilityLevel(RD);
1652     if (TypeVis != llvm::GlobalObject::VCallVisibilityPublic)
1653       VTable->setVCallVisibilityMetadata(TypeVis);
1654   }
1655 
1656   // The location of the first virtual function pointer in the virtual table,
1657   // aka the "address point" on Itanium. This is at offset 0 if RTTI is
1658   // disabled, or sizeof(void*) if RTTI is enabled.
1659   CharUnits AddressPoint =
1660       getContext().getLangOpts().RTTIData
1661           ? getContext().toCharUnitsFromBits(
1662                 getContext().getTargetInfo().getPointerWidth(0))
1663           : CharUnits::Zero();
1664 
1665   if (Info.PathToIntroducingObject.empty()) {
1666     CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
1667     return;
1668   }
1669 
1670   // Add a bitset entry for the least derived base belonging to this vftable.
1671   CGM.AddVTableTypeMetadata(VTable, AddressPoint,
1672                             Info.PathToIntroducingObject.back());
1673 
1674   // Add a bitset entry for each derived class that is laid out at the same
1675   // offset as the least derived base.
1676   for (unsigned I = Info.PathToIntroducingObject.size() - 1; I != 0; --I) {
1677     const CXXRecordDecl *DerivedRD = Info.PathToIntroducingObject[I - 1];
1678     const CXXRecordDecl *BaseRD = Info.PathToIntroducingObject[I];
1679 
1680     const ASTRecordLayout &Layout =
1681         getContext().getASTRecordLayout(DerivedRD);
1682     CharUnits Offset;
1683     auto VBI = Layout.getVBaseOffsetsMap().find(BaseRD);
1684     if (VBI == Layout.getVBaseOffsetsMap().end())
1685       Offset = Layout.getBaseClassOffset(BaseRD);
1686     else
1687       Offset = VBI->second.VBaseOffset;
1688     if (!Offset.isZero())
1689       return;
1690     CGM.AddVTableTypeMetadata(VTable, AddressPoint, DerivedRD);
1691   }
1692 
1693   // Finally do the same for the most derived class.
1694   if (Info.FullOffsetInMDC.isZero())
1695     CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
1696 }
1697 
1698 void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1699                                             const CXXRecordDecl *RD) {
1700   MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
1701   const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
1702 
1703   for (const std::unique_ptr<VPtrInfo>& Info : VFPtrs) {
1704     llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
1705     if (VTable->hasInitializer())
1706       continue;
1707 
1708     const VTableLayout &VTLayout =
1709       VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
1710 
1711     llvm::Constant *RTTI = nullptr;
1712     if (any_of(VTLayout.vtable_components(),
1713                [](const VTableComponent &VTC) { return VTC.isRTTIKind(); }))
1714       RTTI = getMSCompleteObjectLocator(RD, *Info);
1715 
1716     ConstantInitBuilder builder(CGM);
1717     auto components = builder.beginStruct();
1718     CGVT.createVTableInitializer(components, VTLayout, RTTI,
1719                                  VTable->hasLocalLinkage());
1720     components.finishAndSetAsInitializer(VTable);
1721 
1722     emitVTableTypeMetadata(*Info, RD, VTable);
1723   }
1724 }
1725 
1726 bool MicrosoftCXXABI::isVirtualOffsetNeededForVTableField(
1727     CodeGenFunction &CGF, CodeGenFunction::VPtr Vptr) {
1728   return Vptr.NearestVBase != nullptr;
1729 }
1730 
1731 llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1732     CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
1733     const CXXRecordDecl *NearestVBase) {
1734   llvm::Constant *VTableAddressPoint = getVTableAddressPoint(Base, VTableClass);
1735   if (!VTableAddressPoint) {
1736     assert(Base.getBase()->getNumVBases() &&
1737            !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
1738   }
1739   return VTableAddressPoint;
1740 }
1741 
1742 static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
1743                               const CXXRecordDecl *RD, const VPtrInfo &VFPtr,
1744                               SmallString<256> &Name) {
1745   llvm::raw_svector_ostream Out(Name);
1746   MangleContext.mangleCXXVFTable(RD, VFPtr.MangledPath, Out);
1747 }
1748 
1749 llvm::Constant *
1750 MicrosoftCXXABI::getVTableAddressPoint(BaseSubobject Base,
1751                                        const CXXRecordDecl *VTableClass) {
1752   (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1753   VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1754   return VFTablesMap[ID];
1755 }
1756 
1757 llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1758     BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1759   llvm::Constant *VFTable = getVTableAddressPoint(Base, VTableClass);
1760   assert(VFTable && "Couldn't find a vftable for the given base?");
1761   return VFTable;
1762 }
1763 
1764 llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1765                                                        CharUnits VPtrOffset) {
1766   // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1767   // shouldn't be used in the given record type. We want to cache this result in
1768   // VFTablesMap, thus a simple zero check is not sufficient.
1769 
1770   VFTableIdTy ID(RD, VPtrOffset);
1771   VTablesMapTy::iterator I;
1772   bool Inserted;
1773   std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
1774   if (!Inserted)
1775     return I->second;
1776 
1777   llvm::GlobalVariable *&VTable = I->second;
1778 
1779   MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
1780   const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
1781 
1782   if (DeferredVFTables.insert(RD).second) {
1783     // We haven't processed this record type before.
1784     // Queue up this vtable for possible deferred emission.
1785     CGM.addDeferredVTable(RD);
1786 
1787 #ifndef NDEBUG
1788     // Create all the vftables at once in order to make sure each vftable has
1789     // a unique mangled name.
1790     llvm::StringSet<> ObservedMangledNames;
1791     for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1792       SmallString<256> Name;
1793       mangleVFTableName(getMangleContext(), RD, *VFPtrs[J], Name);
1794       if (!ObservedMangledNames.insert(Name.str()).second)
1795         llvm_unreachable("Already saw this mangling before?");
1796     }
1797 #endif
1798   }
1799 
1800   const std::unique_ptr<VPtrInfo> *VFPtrI = std::find_if(
1801       VFPtrs.begin(), VFPtrs.end(), [&](const std::unique_ptr<VPtrInfo>& VPI) {
1802         return VPI->FullOffsetInMDC == VPtrOffset;
1803       });
1804   if (VFPtrI == VFPtrs.end()) {
1805     VFTablesMap[ID] = nullptr;
1806     return nullptr;
1807   }
1808   const std::unique_ptr<VPtrInfo> &VFPtr = *VFPtrI;
1809 
1810   SmallString<256> VFTableName;
1811   mangleVFTableName(getMangleContext(), RD, *VFPtr, VFTableName);
1812 
1813   // Classes marked __declspec(dllimport) need vftables generated on the
1814   // import-side in order to support features like constexpr.  No other
1815   // translation unit relies on the emission of the local vftable, translation
1816   // units are expected to generate them as needed.
1817   //
1818   // Because of this unique behavior, we maintain this logic here instead of
1819   // getVTableLinkage.
1820   llvm::GlobalValue::LinkageTypes VFTableLinkage =
1821       RD->hasAttr<DLLImportAttr>() ? llvm::GlobalValue::LinkOnceODRLinkage
1822                                    : CGM.getVTableLinkage(RD);
1823   bool VFTableComesFromAnotherTU =
1824       llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) ||
1825       llvm::GlobalValue::isExternalLinkage(VFTableLinkage);
1826   bool VTableAliasIsRequred =
1827       !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData;
1828 
1829   if (llvm::GlobalValue *VFTable =
1830           CGM.getModule().getNamedGlobal(VFTableName)) {
1831     VFTablesMap[ID] = VFTable;
1832     VTable = VTableAliasIsRequred
1833                  ? cast<llvm::GlobalVariable>(
1834                        cast<llvm::GlobalAlias>(VFTable)->getBaseObject())
1835                  : cast<llvm::GlobalVariable>(VFTable);
1836     return VTable;
1837   }
1838 
1839   const VTableLayout &VTLayout =
1840       VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC);
1841   llvm::GlobalValue::LinkageTypes VTableLinkage =
1842       VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage;
1843 
1844   StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str();
1845 
1846   llvm::Type *VTableType = CGM.getVTables().getVTableType(VTLayout);
1847 
1848   // Create a backing variable for the contents of VTable.  The VTable may
1849   // or may not include space for a pointer to RTTI data.
1850   llvm::GlobalValue *VFTable;
1851   VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType,
1852                                     /*isConstant=*/true, VTableLinkage,
1853                                     /*Initializer=*/nullptr, VTableName);
1854   VTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1855 
1856   llvm::Comdat *C = nullptr;
1857   if (!VFTableComesFromAnotherTU &&
1858       (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) ||
1859        (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) &&
1860         VTableAliasIsRequred)))
1861     C = CGM.getModule().getOrInsertComdat(VFTableName.str());
1862 
1863   // Only insert a pointer into the VFTable for RTTI data if we are not
1864   // importing it.  We never reference the RTTI data directly so there is no
1865   // need to make room for it.
1866   if (VTableAliasIsRequred) {
1867     llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.Int32Ty, 0),
1868                                  llvm::ConstantInt::get(CGM.Int32Ty, 0),
1869                                  llvm::ConstantInt::get(CGM.Int32Ty, 1)};
1870     // Create a GEP which points just after the first entry in the VFTable,
1871     // this should be the location of the first virtual method.
1872     llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr(
1873         VTable->getValueType(), VTable, GEPIndices);
1874     if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) {
1875       VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1876       if (C)
1877         C->setSelectionKind(llvm::Comdat::Largest);
1878     }
1879     VFTable = llvm::GlobalAlias::create(CGM.Int8PtrTy,
1880                                         /*AddressSpace=*/0, VFTableLinkage,
1881                                         VFTableName.str(), VTableGEP,
1882                                         &CGM.getModule());
1883     VFTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1884   } else {
1885     // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1886     // be referencing any RTTI data.
1887     // The GlobalVariable will end up being an appropriate definition of the
1888     // VFTable.
1889     VFTable = VTable;
1890   }
1891   if (C)
1892     VTable->setComdat(C);
1893 
1894   if (RD->hasAttr<DLLExportAttr>())
1895     VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1896 
1897   VFTablesMap[ID] = VFTable;
1898   return VTable;
1899 }
1900 
1901 CGCallee MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1902                                                     GlobalDecl GD,
1903                                                     Address This,
1904                                                     llvm::Type *Ty,
1905                                                     SourceLocation Loc) {
1906   CGBuilderTy &Builder = CGF.Builder;
1907 
1908   Ty = Ty->getPointerTo()->getPointerTo();
1909   Address VPtr =
1910       adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
1911 
1912   auto *MethodDecl = cast<CXXMethodDecl>(GD.getDecl());
1913   llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty, MethodDecl->getParent());
1914 
1915   MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
1916   MethodVFTableLocation ML = VFTContext.getMethodVFTableLocation(GD);
1917 
1918   // Compute the identity of the most derived class whose virtual table is
1919   // located at the MethodVFTableLocation ML.
1920   auto getObjectWithVPtr = [&] {
1921     return llvm::find_if(VFTContext.getVFPtrOffsets(
1922                              ML.VBase ? ML.VBase : MethodDecl->getParent()),
1923                          [&](const std::unique_ptr<VPtrInfo> &Info) {
1924                            return Info->FullOffsetInMDC == ML.VFPtrOffset;
1925                          })
1926         ->get()
1927         ->ObjectWithVPtr;
1928   };
1929 
1930   llvm::Value *VFunc;
1931   if (CGF.ShouldEmitVTableTypeCheckedLoad(MethodDecl->getParent())) {
1932     VFunc = CGF.EmitVTableTypeCheckedLoad(
1933         getObjectWithVPtr(), VTable,
1934         ML.Index * CGM.getContext().getTargetInfo().getPointerWidth(0) / 8);
1935   } else {
1936     if (CGM.getCodeGenOpts().PrepareForLTO)
1937       CGF.EmitTypeMetadataCodeForVCall(getObjectWithVPtr(), VTable, Loc);
1938 
1939     llvm::Value *VFuncPtr =
1940         Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1941     VFunc = Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
1942   }
1943 
1944   CGCallee Callee(GD, VFunc);
1945   return Callee;
1946 }
1947 
1948 llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1949     CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
1950     Address This, DeleteOrMemberCallExpr E) {
1951   auto *CE = E.dyn_cast<const CXXMemberCallExpr *>();
1952   auto *D = E.dyn_cast<const CXXDeleteExpr *>();
1953   assert((CE != nullptr) ^ (D != nullptr));
1954   assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
1955   assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1956 
1957   // We have only one destructor in the vftable but can get both behaviors
1958   // by passing an implicit int parameter.
1959   GlobalDecl GD(Dtor, Dtor_Deleting);
1960   const CGFunctionInfo *FInfo =
1961       &CGM.getTypes().arrangeCXXStructorDeclaration(GD);
1962   llvm::FunctionType *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
1963   CGCallee Callee = CGCallee::forVirtual(CE, GD, This, Ty);
1964 
1965   ASTContext &Context = getContext();
1966   llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1967       llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1968       DtorType == Dtor_Deleting);
1969 
1970   QualType ThisTy;
1971   if (CE) {
1972     ThisTy = CE->getObjectType();
1973   } else {
1974     ThisTy = D->getDestroyedType();
1975   }
1976 
1977   This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
1978   RValue RV = CGF.EmitCXXDestructorCall(GD, Callee, This.getPointer(), ThisTy,
1979                                         ImplicitParam, Context.IntTy, CE);
1980   return RV.getScalarVal();
1981 }
1982 
1983 const VBTableGlobals &
1984 MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
1985   // At this layer, we can key the cache off of a single class, which is much
1986   // easier than caching each vbtable individually.
1987   llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1988   bool Added;
1989   std::tie(Entry, Added) =
1990       VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
1991   VBTableGlobals &VBGlobals = Entry->second;
1992   if (!Added)
1993     return VBGlobals;
1994 
1995   MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1996   VBGlobals.VBTables = &Context.enumerateVBTables(RD);
1997 
1998   // Cache the globals for all vbtables so we don't have to recompute the
1999   // mangled names.
2000   llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
2001   for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
2002                                       E = VBGlobals.VBTables->end();
2003        I != E; ++I) {
2004     VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
2005   }
2006 
2007   return VBGlobals;
2008 }
2009 
2010 llvm::Function *
2011 MicrosoftCXXABI::EmitVirtualMemPtrThunk(const CXXMethodDecl *MD,
2012                                         const MethodVFTableLocation &ML) {
2013   assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
2014          "can't form pointers to ctors or virtual dtors");
2015 
2016   // Calculate the mangled name.
2017   SmallString<256> ThunkName;
2018   llvm::raw_svector_ostream Out(ThunkName);
2019   getMangleContext().mangleVirtualMemPtrThunk(MD, ML, Out);
2020 
2021   // If the thunk has been generated previously, just return it.
2022   if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
2023     return cast<llvm::Function>(GV);
2024 
2025   // Create the llvm::Function.
2026   const CGFunctionInfo &FnInfo =
2027       CGM.getTypes().arrangeUnprototypedMustTailThunk(MD);
2028   llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
2029   llvm::Function *ThunkFn =
2030       llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
2031                              ThunkName.str(), &CGM.getModule());
2032   assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
2033 
2034   ThunkFn->setLinkage(MD->isExternallyVisible()
2035                           ? llvm::GlobalValue::LinkOnceODRLinkage
2036                           : llvm::GlobalValue::InternalLinkage);
2037   if (MD->isExternallyVisible())
2038     ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
2039 
2040   CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
2041   CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
2042 
2043   // Add the "thunk" attribute so that LLVM knows that the return type is
2044   // meaningless. These thunks can be used to call functions with differing
2045   // return types, and the caller is required to cast the prototype
2046   // appropriately to extract the correct value.
2047   ThunkFn->addFnAttr("thunk");
2048 
2049   // These thunks can be compared, so they are not unnamed.
2050   ThunkFn->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::None);
2051 
2052   // Start codegen.
2053   CodeGenFunction CGF(CGM);
2054   CGF.CurGD = GlobalDecl(MD);
2055   CGF.CurFuncIsThunk = true;
2056 
2057   // Build FunctionArgs, but only include the implicit 'this' parameter
2058   // declaration.
2059   FunctionArgList FunctionArgs;
2060   buildThisParam(CGF, FunctionArgs);
2061 
2062   // Start defining the function.
2063   CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
2064                     FunctionArgs, MD->getLocation(), SourceLocation());
2065   setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
2066 
2067   // Load the vfptr and then callee from the vftable.  The callee should have
2068   // adjusted 'this' so that the vfptr is at offset zero.
2069   llvm::Value *VTable = CGF.GetVTablePtr(
2070       getThisAddress(CGF), ThunkTy->getPointerTo()->getPointerTo(), MD->getParent());
2071 
2072   llvm::Value *VFuncPtr =
2073       CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
2074   llvm::Value *Callee =
2075     CGF.Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
2076 
2077   CGF.EmitMustTailThunk(MD, getThisValue(CGF), {ThunkTy, Callee});
2078 
2079   return ThunkFn;
2080 }
2081 
2082 void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
2083   const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
2084   for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
2085     const std::unique_ptr<VPtrInfo>& VBT = (*VBGlobals.VBTables)[I];
2086     llvm::GlobalVariable *GV = VBGlobals.Globals[I];
2087     if (GV->isDeclaration())
2088       emitVBTableDefinition(*VBT, RD, GV);
2089   }
2090 }
2091 
2092 llvm::GlobalVariable *
2093 MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
2094                                   llvm::GlobalVariable::LinkageTypes Linkage) {
2095   SmallString<256> OutName;
2096   llvm::raw_svector_ostream Out(OutName);
2097   getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
2098   StringRef Name = OutName.str();
2099 
2100   llvm::ArrayType *VBTableType =
2101       llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ObjectWithVPtr->getNumVBases());
2102 
2103   assert(!CGM.getModule().getNamedGlobal(Name) &&
2104          "vbtable with this name already exists: mangling bug?");
2105   CharUnits Alignment =
2106       CGM.getContext().getTypeAlignInChars(CGM.getContext().IntTy);
2107   llvm::GlobalVariable *GV = CGM.CreateOrReplaceCXXRuntimeVariable(
2108       Name, VBTableType, Linkage, Alignment.getQuantity());
2109   GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
2110 
2111   if (RD->hasAttr<DLLImportAttr>())
2112     GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
2113   else if (RD->hasAttr<DLLExportAttr>())
2114     GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
2115 
2116   if (!GV->hasExternalLinkage())
2117     emitVBTableDefinition(VBT, RD, GV);
2118 
2119   return GV;
2120 }
2121 
2122 void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
2123                                             const CXXRecordDecl *RD,
2124                                             llvm::GlobalVariable *GV) const {
2125   const CXXRecordDecl *ObjectWithVPtr = VBT.ObjectWithVPtr;
2126 
2127   assert(RD->getNumVBases() && ObjectWithVPtr->getNumVBases() &&
2128          "should only emit vbtables for classes with vbtables");
2129 
2130   const ASTRecordLayout &BaseLayout =
2131       getContext().getASTRecordLayout(VBT.IntroducingObject);
2132   const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
2133 
2134   SmallVector<llvm::Constant *, 4> Offsets(1 + ObjectWithVPtr->getNumVBases(),
2135                                            nullptr);
2136 
2137   // The offset from ObjectWithVPtr's vbptr to itself always leads.
2138   CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
2139   Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
2140 
2141   MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
2142   for (const auto &I : ObjectWithVPtr->vbases()) {
2143     const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
2144     CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
2145     assert(!Offset.isNegative());
2146 
2147     // Make it relative to the subobject vbptr.
2148     CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
2149     if (VBT.getVBaseWithVPtr())
2150       CompleteVBPtrOffset +=
2151           DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
2152     Offset -= CompleteVBPtrOffset;
2153 
2154     unsigned VBIndex = Context.getVBTableIndex(ObjectWithVPtr, VBase);
2155     assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
2156     Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
2157   }
2158 
2159   assert(Offsets.size() ==
2160          cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
2161                                ->getElementType())->getNumElements());
2162   llvm::ArrayType *VBTableType =
2163     llvm::ArrayType::get(CGM.IntTy, Offsets.size());
2164   llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
2165   GV->setInitializer(Init);
2166 
2167   if (RD->hasAttr<DLLImportAttr>())
2168     GV->setLinkage(llvm::GlobalVariable::AvailableExternallyLinkage);
2169 }
2170 
2171 llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
2172                                                     Address This,
2173                                                     const ThisAdjustment &TA) {
2174   if (TA.isEmpty())
2175     return This.getPointer();
2176 
2177   This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
2178 
2179   llvm::Value *V;
2180   if (TA.Virtual.isEmpty()) {
2181     V = This.getPointer();
2182   } else {
2183     assert(TA.Virtual.Microsoft.VtordispOffset < 0);
2184     // Adjust the this argument based on the vtordisp value.
2185     Address VtorDispPtr =
2186         CGF.Builder.CreateConstInBoundsByteGEP(This,
2187                  CharUnits::fromQuantity(TA.Virtual.Microsoft.VtordispOffset));
2188     VtorDispPtr = CGF.Builder.CreateElementBitCast(VtorDispPtr, CGF.Int32Ty);
2189     llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
2190     V = CGF.Builder.CreateGEP(This.getPointer(),
2191                               CGF.Builder.CreateNeg(VtorDisp));
2192 
2193     // Unfortunately, having applied the vtordisp means that we no
2194     // longer really have a known alignment for the vbptr step.
2195     // We'll assume the vbptr is pointer-aligned.
2196 
2197     if (TA.Virtual.Microsoft.VBPtrOffset) {
2198       // If the final overrider is defined in a virtual base other than the one
2199       // that holds the vfptr, we have to use a vtordispex thunk which looks up
2200       // the vbtable of the derived class.
2201       assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
2202       assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
2203       llvm::Value *VBPtr;
2204       llvm::Value *VBaseOffset =
2205           GetVBaseOffsetFromVBPtr(CGF, Address(V, CGF.getPointerAlign()),
2206                                   -TA.Virtual.Microsoft.VBPtrOffset,
2207                                   TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
2208       V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2209     }
2210   }
2211 
2212   if (TA.NonVirtual) {
2213     // Non-virtual adjustment might result in a pointer outside the allocated
2214     // object, e.g. if the final overrider class is laid out after the virtual
2215     // base that declares a method in the most derived class.
2216     V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
2217   }
2218 
2219   // Don't need to bitcast back, the call CodeGen will handle this.
2220   return V;
2221 }
2222 
2223 llvm::Value *
2224 MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
2225                                          const ReturnAdjustment &RA) {
2226   if (RA.isEmpty())
2227     return Ret.getPointer();
2228 
2229   auto OrigTy = Ret.getType();
2230   Ret = CGF.Builder.CreateElementBitCast(Ret, CGF.Int8Ty);
2231 
2232   llvm::Value *V = Ret.getPointer();
2233   if (RA.Virtual.Microsoft.VBIndex) {
2234     assert(RA.Virtual.Microsoft.VBIndex > 0);
2235     int32_t IntSize = CGF.getIntSize().getQuantity();
2236     llvm::Value *VBPtr;
2237     llvm::Value *VBaseOffset =
2238         GetVBaseOffsetFromVBPtr(CGF, Ret, RA.Virtual.Microsoft.VBPtrOffset,
2239                                 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
2240     V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2241   }
2242 
2243   if (RA.NonVirtual)
2244     V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual);
2245 
2246   // Cast back to the original type.
2247   return CGF.Builder.CreateBitCast(V, OrigTy);
2248 }
2249 
2250 bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
2251                                    QualType elementType) {
2252   // Microsoft seems to completely ignore the possibility of a
2253   // two-argument usual deallocation function.
2254   return elementType.isDestructedType();
2255 }
2256 
2257 bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
2258   // Microsoft seems to completely ignore the possibility of a
2259   // two-argument usual deallocation function.
2260   return expr->getAllocatedType().isDestructedType();
2261 }
2262 
2263 CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
2264   // The array cookie is always a size_t; we then pad that out to the
2265   // alignment of the element type.
2266   ASTContext &Ctx = getContext();
2267   return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
2268                   Ctx.getTypeAlignInChars(type));
2269 }
2270 
2271 llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
2272                                                   Address allocPtr,
2273                                                   CharUnits cookieSize) {
2274   Address numElementsPtr =
2275     CGF.Builder.CreateElementBitCast(allocPtr, CGF.SizeTy);
2276   return CGF.Builder.CreateLoad(numElementsPtr);
2277 }
2278 
2279 Address MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
2280                                                Address newPtr,
2281                                                llvm::Value *numElements,
2282                                                const CXXNewExpr *expr,
2283                                                QualType elementType) {
2284   assert(requiresArrayCookie(expr));
2285 
2286   // The size of the cookie.
2287   CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
2288 
2289   // Compute an offset to the cookie.
2290   Address cookiePtr = newPtr;
2291 
2292   // Write the number of elements into the appropriate slot.
2293   Address numElementsPtr
2294     = CGF.Builder.CreateElementBitCast(cookiePtr, CGF.SizeTy);
2295   CGF.Builder.CreateStore(numElements, numElementsPtr);
2296 
2297   // Finally, compute a pointer to the actual data buffer by skipping
2298   // over the cookie completely.
2299   return CGF.Builder.CreateConstInBoundsByteGEP(newPtr, cookieSize);
2300 }
2301 
2302 static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
2303                                         llvm::FunctionCallee Dtor,
2304                                         llvm::Constant *Addr) {
2305   // Create a function which calls the destructor.
2306   llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
2307 
2308   // extern "C" int __tlregdtor(void (*f)(void));
2309   llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
2310       CGF.IntTy, DtorStub->getType(), /*isVarArg=*/false);
2311 
2312   llvm::FunctionCallee TLRegDtor = CGF.CGM.CreateRuntimeFunction(
2313       TLRegDtorTy, "__tlregdtor", llvm::AttributeList(), /*Local=*/true);
2314   if (llvm::Function *TLRegDtorFn =
2315           dyn_cast<llvm::Function>(TLRegDtor.getCallee()))
2316     TLRegDtorFn->setDoesNotThrow();
2317 
2318   CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
2319 }
2320 
2321 void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
2322                                          llvm::FunctionCallee Dtor,
2323                                          llvm::Constant *Addr) {
2324   if (D.isNoDestroy(CGM.getContext()))
2325     return;
2326 
2327   if (D.getTLSKind())
2328     return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
2329 
2330   // The default behavior is to use atexit.
2331   CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
2332 }
2333 
2334 void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
2335     CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
2336     ArrayRef<llvm::Function *> CXXThreadLocalInits,
2337     ArrayRef<const VarDecl *> CXXThreadLocalInitVars) {
2338   if (CXXThreadLocalInits.empty())
2339     return;
2340 
2341   CGM.AppendLinkerOptions(CGM.getTarget().getTriple().getArch() ==
2342                                   llvm::Triple::x86
2343                               ? "/include:___dyn_tls_init@12"
2344                               : "/include:__dyn_tls_init");
2345 
2346   // This will create a GV in the .CRT$XDU section.  It will point to our
2347   // initialization function.  The CRT will call all of these function
2348   // pointers at start-up time and, eventually, at thread-creation time.
2349   auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
2350     llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
2351         CGM.getModule(), InitFunc->getType(), /*isConstant=*/true,
2352         llvm::GlobalVariable::InternalLinkage, InitFunc,
2353         Twine(InitFunc->getName(), "$initializer$"));
2354     InitFuncPtr->setSection(".CRT$XDU");
2355     // This variable has discardable linkage, we have to add it to @llvm.used to
2356     // ensure it won't get discarded.
2357     CGM.addUsedGlobal(InitFuncPtr);
2358     return InitFuncPtr;
2359   };
2360 
2361   std::vector<llvm::Function *> NonComdatInits;
2362   for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
2363     llvm::GlobalVariable *GV = cast<llvm::GlobalVariable>(
2364         CGM.GetGlobalValue(CGM.getMangledName(CXXThreadLocalInitVars[I])));
2365     llvm::Function *F = CXXThreadLocalInits[I];
2366 
2367     // If the GV is already in a comdat group, then we have to join it.
2368     if (llvm::Comdat *C = GV->getComdat())
2369       AddToXDU(F)->setComdat(C);
2370     else
2371       NonComdatInits.push_back(F);
2372   }
2373 
2374   if (!NonComdatInits.empty()) {
2375     llvm::FunctionType *FTy =
2376         llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
2377     llvm::Function *InitFunc = CGM.CreateGlobalInitOrCleanUpFunction(
2378         FTy, "__tls_init", CGM.getTypes().arrangeNullaryFunction(),
2379         SourceLocation(), /*TLS=*/true);
2380     CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2381 
2382     AddToXDU(InitFunc);
2383   }
2384 }
2385 
2386 LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2387                                                      const VarDecl *VD,
2388                                                      QualType LValType) {
2389   CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2390   return LValue();
2391 }
2392 
2393 static ConstantAddress getInitThreadEpochPtr(CodeGenModule &CGM) {
2394   StringRef VarName("_Init_thread_epoch");
2395   CharUnits Align = CGM.getIntAlign();
2396   if (auto *GV = CGM.getModule().getNamedGlobal(VarName))
2397     return ConstantAddress(GV, Align);
2398   auto *GV = new llvm::GlobalVariable(
2399       CGM.getModule(), CGM.IntTy,
2400       /*isConstant=*/false, llvm::GlobalVariable::ExternalLinkage,
2401       /*Initializer=*/nullptr, VarName,
2402       /*InsertBefore=*/nullptr, llvm::GlobalVariable::GeneralDynamicTLSModel);
2403   GV->setAlignment(Align.getAsAlign());
2404   return ConstantAddress(GV, Align);
2405 }
2406 
2407 static llvm::FunctionCallee getInitThreadHeaderFn(CodeGenModule &CGM) {
2408   llvm::FunctionType *FTy =
2409       llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2410                               CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2411   return CGM.CreateRuntimeFunction(
2412       FTy, "_Init_thread_header",
2413       llvm::AttributeList::get(CGM.getLLVMContext(),
2414                                llvm::AttributeList::FunctionIndex,
2415                                llvm::Attribute::NoUnwind),
2416       /*Local=*/true);
2417 }
2418 
2419 static llvm::FunctionCallee getInitThreadFooterFn(CodeGenModule &CGM) {
2420   llvm::FunctionType *FTy =
2421       llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2422                               CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2423   return CGM.CreateRuntimeFunction(
2424       FTy, "_Init_thread_footer",
2425       llvm::AttributeList::get(CGM.getLLVMContext(),
2426                                llvm::AttributeList::FunctionIndex,
2427                                llvm::Attribute::NoUnwind),
2428       /*Local=*/true);
2429 }
2430 
2431 static llvm::FunctionCallee getInitThreadAbortFn(CodeGenModule &CGM) {
2432   llvm::FunctionType *FTy =
2433       llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2434                               CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2435   return CGM.CreateRuntimeFunction(
2436       FTy, "_Init_thread_abort",
2437       llvm::AttributeList::get(CGM.getLLVMContext(),
2438                                llvm::AttributeList::FunctionIndex,
2439                                llvm::Attribute::NoUnwind),
2440       /*Local=*/true);
2441 }
2442 
2443 namespace {
2444 struct ResetGuardBit final : EHScopeStack::Cleanup {
2445   Address Guard;
2446   unsigned GuardNum;
2447   ResetGuardBit(Address Guard, unsigned GuardNum)
2448       : Guard(Guard), GuardNum(GuardNum) {}
2449 
2450   void Emit(CodeGenFunction &CGF, Flags flags) override {
2451     // Reset the bit in the mask so that the static variable may be
2452     // reinitialized.
2453     CGBuilderTy &Builder = CGF.Builder;
2454     llvm::LoadInst *LI = Builder.CreateLoad(Guard);
2455     llvm::ConstantInt *Mask =
2456         llvm::ConstantInt::get(CGF.IntTy, ~(1ULL << GuardNum));
2457     Builder.CreateStore(Builder.CreateAnd(LI, Mask), Guard);
2458   }
2459 };
2460 
2461 struct CallInitThreadAbort final : EHScopeStack::Cleanup {
2462   llvm::Value *Guard;
2463   CallInitThreadAbort(Address Guard) : Guard(Guard.getPointer()) {}
2464 
2465   void Emit(CodeGenFunction &CGF, Flags flags) override {
2466     // Calling _Init_thread_abort will reset the guard's state.
2467     CGF.EmitNounwindRuntimeCall(getInitThreadAbortFn(CGF.CGM), Guard);
2468   }
2469 };
2470 }
2471 
2472 void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
2473                                       llvm::GlobalVariable *GV,
2474                                       bool PerformInit) {
2475   // MSVC only uses guards for static locals.
2476   if (!D.isStaticLocal()) {
2477     assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2478     // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
2479     llvm::Function *F = CGF.CurFn;
2480     F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2481     F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
2482     CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2483     return;
2484   }
2485 
2486   bool ThreadlocalStatic = D.getTLSKind();
2487   bool ThreadsafeStatic = getContext().getLangOpts().ThreadsafeStatics;
2488 
2489   // Thread-safe static variables which aren't thread-specific have a
2490   // per-variable guard.
2491   bool HasPerVariableGuard = ThreadsafeStatic && !ThreadlocalStatic;
2492 
2493   CGBuilderTy &Builder = CGF.Builder;
2494   llvm::IntegerType *GuardTy = CGF.Int32Ty;
2495   llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
2496   CharUnits GuardAlign = CharUnits::fromQuantity(4);
2497 
2498   // Get the guard variable for this function if we have one already.
2499   GuardInfo *GI = nullptr;
2500   if (ThreadlocalStatic)
2501     GI = &ThreadLocalGuardVariableMap[D.getDeclContext()];
2502   else if (!ThreadsafeStatic)
2503     GI = &GuardVariableMap[D.getDeclContext()];
2504 
2505   llvm::GlobalVariable *GuardVar = GI ? GI->Guard : nullptr;
2506   unsigned GuardNum;
2507   if (D.isExternallyVisible()) {
2508     // Externally visible variables have to be numbered in Sema to properly
2509     // handle unreachable VarDecls.
2510     GuardNum = getContext().getStaticLocalNumber(&D);
2511     assert(GuardNum > 0);
2512     GuardNum--;
2513   } else if (HasPerVariableGuard) {
2514     GuardNum = ThreadSafeGuardNumMap[D.getDeclContext()]++;
2515   } else {
2516     // Non-externally visible variables are numbered here in CodeGen.
2517     GuardNum = GI->BitIndex++;
2518   }
2519 
2520   if (!HasPerVariableGuard && GuardNum >= 32) {
2521     if (D.isExternallyVisible())
2522       ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
2523     GuardNum %= 32;
2524     GuardVar = nullptr;
2525   }
2526 
2527   if (!GuardVar) {
2528     // Mangle the name for the guard.
2529     SmallString<256> GuardName;
2530     {
2531       llvm::raw_svector_ostream Out(GuardName);
2532       if (HasPerVariableGuard)
2533         getMangleContext().mangleThreadSafeStaticGuardVariable(&D, GuardNum,
2534                                                                Out);
2535       else
2536         getMangleContext().mangleStaticGuardVariable(&D, Out);
2537     }
2538 
2539     // Create the guard variable with a zero-initializer. Just absorb linkage,
2540     // visibility and dll storage class from the guarded variable.
2541     GuardVar =
2542         new llvm::GlobalVariable(CGM.getModule(), GuardTy, /*isConstant=*/false,
2543                                  GV->getLinkage(), Zero, GuardName.str());
2544     GuardVar->setVisibility(GV->getVisibility());
2545     GuardVar->setDLLStorageClass(GV->getDLLStorageClass());
2546     GuardVar->setAlignment(GuardAlign.getAsAlign());
2547     if (GuardVar->isWeakForLinker())
2548       GuardVar->setComdat(
2549           CGM.getModule().getOrInsertComdat(GuardVar->getName()));
2550     if (D.getTLSKind())
2551       CGM.setTLSMode(GuardVar, D);
2552     if (GI && !HasPerVariableGuard)
2553       GI->Guard = GuardVar;
2554   }
2555 
2556   ConstantAddress GuardAddr(GuardVar, GuardAlign);
2557 
2558   assert(GuardVar->getLinkage() == GV->getLinkage() &&
2559          "static local from the same function had different linkage");
2560 
2561   if (!HasPerVariableGuard) {
2562     // Pseudo code for the test:
2563     // if (!(GuardVar & MyGuardBit)) {
2564     //   GuardVar |= MyGuardBit;
2565     //   ... initialize the object ...;
2566     // }
2567 
2568     // Test our bit from the guard variable.
2569     llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1ULL << GuardNum);
2570     llvm::LoadInst *LI = Builder.CreateLoad(GuardAddr);
2571     llvm::Value *NeedsInit =
2572         Builder.CreateICmpEQ(Builder.CreateAnd(LI, Bit), Zero);
2573     llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2574     llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
2575     CGF.EmitCXXGuardedInitBranch(NeedsInit, InitBlock, EndBlock,
2576                                  CodeGenFunction::GuardKind::VariableGuard, &D);
2577 
2578     // Set our bit in the guard variable and emit the initializer and add a global
2579     // destructor if appropriate.
2580     CGF.EmitBlock(InitBlock);
2581     Builder.CreateStore(Builder.CreateOr(LI, Bit), GuardAddr);
2582     CGF.EHStack.pushCleanup<ResetGuardBit>(EHCleanup, GuardAddr, GuardNum);
2583     CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2584     CGF.PopCleanupBlock();
2585     Builder.CreateBr(EndBlock);
2586 
2587     // Continue.
2588     CGF.EmitBlock(EndBlock);
2589   } else {
2590     // Pseudo code for the test:
2591     // if (TSS > _Init_thread_epoch) {
2592     //   _Init_thread_header(&TSS);
2593     //   if (TSS == -1) {
2594     //     ... initialize the object ...;
2595     //     _Init_thread_footer(&TSS);
2596     //   }
2597     // }
2598     //
2599     // The algorithm is almost identical to what can be found in the appendix
2600     // found in N2325.
2601 
2602     // This BasicBLock determines whether or not we have any work to do.
2603     llvm::LoadInst *FirstGuardLoad = Builder.CreateLoad(GuardAddr);
2604     FirstGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2605     llvm::LoadInst *InitThreadEpoch =
2606         Builder.CreateLoad(getInitThreadEpochPtr(CGM));
2607     llvm::Value *IsUninitialized =
2608         Builder.CreateICmpSGT(FirstGuardLoad, InitThreadEpoch);
2609     llvm::BasicBlock *AttemptInitBlock = CGF.createBasicBlock("init.attempt");
2610     llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
2611     CGF.EmitCXXGuardedInitBranch(IsUninitialized, AttemptInitBlock, EndBlock,
2612                                  CodeGenFunction::GuardKind::VariableGuard, &D);
2613 
2614     // This BasicBlock attempts to determine whether or not this thread is
2615     // responsible for doing the initialization.
2616     CGF.EmitBlock(AttemptInitBlock);
2617     CGF.EmitNounwindRuntimeCall(getInitThreadHeaderFn(CGM),
2618                                 GuardAddr.getPointer());
2619     llvm::LoadInst *SecondGuardLoad = Builder.CreateLoad(GuardAddr);
2620     SecondGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2621     llvm::Value *ShouldDoInit =
2622         Builder.CreateICmpEQ(SecondGuardLoad, getAllOnesInt());
2623     llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2624     Builder.CreateCondBr(ShouldDoInit, InitBlock, EndBlock);
2625 
2626     // Ok, we ended up getting selected as the initializing thread.
2627     CGF.EmitBlock(InitBlock);
2628     CGF.EHStack.pushCleanup<CallInitThreadAbort>(EHCleanup, GuardAddr);
2629     CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2630     CGF.PopCleanupBlock();
2631     CGF.EmitNounwindRuntimeCall(getInitThreadFooterFn(CGM),
2632                                 GuardAddr.getPointer());
2633     Builder.CreateBr(EndBlock);
2634 
2635     CGF.EmitBlock(EndBlock);
2636   }
2637 }
2638 
2639 bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2640   // Null-ness for function memptrs only depends on the first field, which is
2641   // the function pointer.  The rest don't matter, so we can zero initialize.
2642   if (MPT->isMemberFunctionPointer())
2643     return true;
2644 
2645   // The virtual base adjustment field is always -1 for null, so if we have one
2646   // we can't zero initialize.  The field offset is sometimes also -1 if 0 is a
2647   // valid field offset.
2648   const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2649   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
2650   return (!inheritanceModelHasVBTableOffsetField(Inheritance) &&
2651           RD->nullFieldOffsetIsZero());
2652 }
2653 
2654 llvm::Type *
2655 MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
2656   const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2657   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
2658   llvm::SmallVector<llvm::Type *, 4> fields;
2659   if (MPT->isMemberFunctionPointer())
2660     fields.push_back(CGM.VoidPtrTy);  // FunctionPointerOrVirtualThunk
2661   else
2662     fields.push_back(CGM.IntTy);  // FieldOffset
2663 
2664   if (inheritanceModelHasNVOffsetField(MPT->isMemberFunctionPointer(),
2665                                        Inheritance))
2666     fields.push_back(CGM.IntTy);
2667   if (inheritanceModelHasVBPtrOffsetField(Inheritance))
2668     fields.push_back(CGM.IntTy);
2669   if (inheritanceModelHasVBTableOffsetField(Inheritance))
2670     fields.push_back(CGM.IntTy);  // VirtualBaseAdjustmentOffset
2671 
2672   if (fields.size() == 1)
2673     return fields[0];
2674   return llvm::StructType::get(CGM.getLLVMContext(), fields);
2675 }
2676 
2677 void MicrosoftCXXABI::
2678 GetNullMemberPointerFields(const MemberPointerType *MPT,
2679                            llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2680   assert(fields.empty());
2681   const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2682   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
2683   if (MPT->isMemberFunctionPointer()) {
2684     // FunctionPointerOrVirtualThunk
2685     fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2686   } else {
2687     if (RD->nullFieldOffsetIsZero())
2688       fields.push_back(getZeroInt());  // FieldOffset
2689     else
2690       fields.push_back(getAllOnesInt());  // FieldOffset
2691   }
2692 
2693   if (inheritanceModelHasNVOffsetField(MPT->isMemberFunctionPointer(),
2694                                        Inheritance))
2695     fields.push_back(getZeroInt());
2696   if (inheritanceModelHasVBPtrOffsetField(Inheritance))
2697     fields.push_back(getZeroInt());
2698   if (inheritanceModelHasVBTableOffsetField(Inheritance))
2699     fields.push_back(getAllOnesInt());
2700 }
2701 
2702 llvm::Constant *
2703 MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
2704   llvm::SmallVector<llvm::Constant *, 4> fields;
2705   GetNullMemberPointerFields(MPT, fields);
2706   if (fields.size() == 1)
2707     return fields[0];
2708   llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2709   assert(Res->getType() == ConvertMemberPointerType(MPT));
2710   return Res;
2711 }
2712 
2713 llvm::Constant *
2714 MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2715                                        bool IsMemberFunction,
2716                                        const CXXRecordDecl *RD,
2717                                        CharUnits NonVirtualBaseAdjustment,
2718                                        unsigned VBTableIndex) {
2719   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
2720 
2721   // Single inheritance class member pointer are represented as scalars instead
2722   // of aggregates.
2723   if (inheritanceModelHasOnlyOneField(IsMemberFunction, Inheritance))
2724     return FirstField;
2725 
2726   llvm::SmallVector<llvm::Constant *, 4> fields;
2727   fields.push_back(FirstField);
2728 
2729   if (inheritanceModelHasNVOffsetField(IsMemberFunction, Inheritance))
2730     fields.push_back(llvm::ConstantInt::get(
2731       CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
2732 
2733   if (inheritanceModelHasVBPtrOffsetField(Inheritance)) {
2734     CharUnits Offs = CharUnits::Zero();
2735     if (VBTableIndex)
2736       Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
2737     fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
2738   }
2739 
2740   // The rest of the fields are adjusted by conversions to a more derived class.
2741   if (inheritanceModelHasVBTableOffsetField(Inheritance))
2742     fields.push_back(llvm::ConstantInt::get(CGM.IntTy, VBTableIndex));
2743 
2744   return llvm::ConstantStruct::getAnon(fields);
2745 }
2746 
2747 llvm::Constant *
2748 MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2749                                        CharUnits offset) {
2750   return EmitMemberDataPointer(MPT->getMostRecentCXXRecordDecl(), offset);
2751 }
2752 
2753 llvm::Constant *MicrosoftCXXABI::EmitMemberDataPointer(const CXXRecordDecl *RD,
2754                                                        CharUnits offset) {
2755   if (RD->getMSInheritanceModel() ==
2756       MSInheritanceModel::Virtual)
2757     offset -= getContext().getOffsetOfBaseWithVBPtr(RD);
2758   llvm::Constant *FirstField =
2759     llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
2760   return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
2761                                CharUnits::Zero(), /*VBTableIndex=*/0);
2762 }
2763 
2764 llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2765                                                    QualType MPType) {
2766   const MemberPointerType *DstTy = MPType->castAs<MemberPointerType>();
2767   const ValueDecl *MPD = MP.getMemberPointerDecl();
2768   if (!MPD)
2769     return EmitNullMemberPointer(DstTy);
2770 
2771   ASTContext &Ctx = getContext();
2772   ArrayRef<const CXXRecordDecl *> MemberPointerPath = MP.getMemberPointerPath();
2773 
2774   llvm::Constant *C;
2775   if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) {
2776     C = EmitMemberFunctionPointer(MD);
2777   } else {
2778     // For a pointer to data member, start off with the offset of the field in
2779     // the class in which it was declared, and convert from there if necessary.
2780     // For indirect field decls, get the outermost anonymous field and use the
2781     // parent class.
2782     CharUnits FieldOffset = Ctx.toCharUnitsFromBits(Ctx.getFieldOffset(MPD));
2783     const FieldDecl *FD = dyn_cast<FieldDecl>(MPD);
2784     if (!FD)
2785       FD = cast<FieldDecl>(*cast<IndirectFieldDecl>(MPD)->chain_begin());
2786     const CXXRecordDecl *RD = cast<CXXRecordDecl>(FD->getParent());
2787     RD = RD->getMostRecentNonInjectedDecl();
2788     C = EmitMemberDataPointer(RD, FieldOffset);
2789   }
2790 
2791   if (!MemberPointerPath.empty()) {
2792     const CXXRecordDecl *SrcRD = cast<CXXRecordDecl>(MPD->getDeclContext());
2793     const Type *SrcRecTy = Ctx.getTypeDeclType(SrcRD).getTypePtr();
2794     const MemberPointerType *SrcTy =
2795         Ctx.getMemberPointerType(DstTy->getPointeeType(), SrcRecTy)
2796             ->castAs<MemberPointerType>();
2797 
2798     bool DerivedMember = MP.isMemberPointerToDerivedMember();
2799     SmallVector<const CXXBaseSpecifier *, 4> DerivedToBasePath;
2800     const CXXRecordDecl *PrevRD = SrcRD;
2801     for (const CXXRecordDecl *PathElem : MemberPointerPath) {
2802       const CXXRecordDecl *Base = nullptr;
2803       const CXXRecordDecl *Derived = nullptr;
2804       if (DerivedMember) {
2805         Base = PathElem;
2806         Derived = PrevRD;
2807       } else {
2808         Base = PrevRD;
2809         Derived = PathElem;
2810       }
2811       for (const CXXBaseSpecifier &BS : Derived->bases())
2812         if (BS.getType()->getAsCXXRecordDecl()->getCanonicalDecl() ==
2813             Base->getCanonicalDecl())
2814           DerivedToBasePath.push_back(&BS);
2815       PrevRD = PathElem;
2816     }
2817     assert(DerivedToBasePath.size() == MemberPointerPath.size());
2818 
2819     CastKind CK = DerivedMember ? CK_DerivedToBaseMemberPointer
2820                                 : CK_BaseToDerivedMemberPointer;
2821     C = EmitMemberPointerConversion(SrcTy, DstTy, CK, DerivedToBasePath.begin(),
2822                                     DerivedToBasePath.end(), C);
2823   }
2824   return C;
2825 }
2826 
2827 llvm::Constant *
2828 MicrosoftCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) {
2829   assert(MD->isInstance() && "Member function must not be static!");
2830 
2831   CharUnits NonVirtualBaseAdjustment = CharUnits::Zero();
2832   const CXXRecordDecl *RD = MD->getParent()->getMostRecentNonInjectedDecl();
2833   CodeGenTypes &Types = CGM.getTypes();
2834 
2835   unsigned VBTableIndex = 0;
2836   llvm::Constant *FirstField;
2837   const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
2838   if (!MD->isVirtual()) {
2839     llvm::Type *Ty;
2840     // Check whether the function has a computable LLVM signature.
2841     if (Types.isFuncTypeConvertible(FPT)) {
2842       // The function has a computable LLVM signature; use the correct type.
2843       Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2844     } else {
2845       // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2846       // function type is incomplete.
2847       Ty = CGM.PtrDiffTy;
2848     }
2849     FirstField = CGM.GetAddrOfFunction(MD, Ty);
2850   } else {
2851     auto &VTableContext = CGM.getMicrosoftVTableContext();
2852     MethodVFTableLocation ML = VTableContext.getMethodVFTableLocation(MD);
2853     FirstField = EmitVirtualMemPtrThunk(MD, ML);
2854     // Include the vfptr adjustment if the method is in a non-primary vftable.
2855     NonVirtualBaseAdjustment += ML.VFPtrOffset;
2856     if (ML.VBase)
2857       VBTableIndex = VTableContext.getVBTableIndex(RD, ML.VBase) * 4;
2858   }
2859 
2860   if (VBTableIndex == 0 &&
2861       RD->getMSInheritanceModel() ==
2862           MSInheritanceModel::Virtual)
2863     NonVirtualBaseAdjustment -= getContext().getOffsetOfBaseWithVBPtr(RD);
2864 
2865   // The rest of the fields are common with data member pointers.
2866   FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
2867   return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
2868                                NonVirtualBaseAdjustment, VBTableIndex);
2869 }
2870 
2871 /// Member pointers are the same if they're either bitwise identical *or* both
2872 /// null.  Null-ness for function members is determined by the first field,
2873 /// while for data member pointers we must compare all fields.
2874 llvm::Value *
2875 MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2876                                              llvm::Value *L,
2877                                              llvm::Value *R,
2878                                              const MemberPointerType *MPT,
2879                                              bool Inequality) {
2880   CGBuilderTy &Builder = CGF.Builder;
2881 
2882   // Handle != comparisons by switching the sense of all boolean operations.
2883   llvm::ICmpInst::Predicate Eq;
2884   llvm::Instruction::BinaryOps And, Or;
2885   if (Inequality) {
2886     Eq = llvm::ICmpInst::ICMP_NE;
2887     And = llvm::Instruction::Or;
2888     Or = llvm::Instruction::And;
2889   } else {
2890     Eq = llvm::ICmpInst::ICMP_EQ;
2891     And = llvm::Instruction::And;
2892     Or = llvm::Instruction::Or;
2893   }
2894 
2895   // If this is a single field member pointer (single inheritance), this is a
2896   // single icmp.
2897   const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2898   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
2899   if (inheritanceModelHasOnlyOneField(MPT->isMemberFunctionPointer(),
2900                                       Inheritance))
2901     return Builder.CreateICmp(Eq, L, R);
2902 
2903   // Compare the first field.
2904   llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2905   llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2906   llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2907 
2908   // Compare everything other than the first field.
2909   llvm::Value *Res = nullptr;
2910   llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2911   for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2912     llvm::Value *LF = Builder.CreateExtractValue(L, I);
2913     llvm::Value *RF = Builder.CreateExtractValue(R, I);
2914     llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2915     if (Res)
2916       Res = Builder.CreateBinOp(And, Res, Cmp);
2917     else
2918       Res = Cmp;
2919   }
2920 
2921   // Check if the first field is 0 if this is a function pointer.
2922   if (MPT->isMemberFunctionPointer()) {
2923     // (l1 == r1 && ...) || l0 == 0
2924     llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2925     llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2926     Res = Builder.CreateBinOp(Or, Res, IsZero);
2927   }
2928 
2929   // Combine the comparison of the first field, which must always be true for
2930   // this comparison to succeeed.
2931   return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2932 }
2933 
2934 llvm::Value *
2935 MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2936                                             llvm::Value *MemPtr,
2937                                             const MemberPointerType *MPT) {
2938   CGBuilderTy &Builder = CGF.Builder;
2939   llvm::SmallVector<llvm::Constant *, 4> fields;
2940   // We only need one field for member functions.
2941   if (MPT->isMemberFunctionPointer())
2942     fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2943   else
2944     GetNullMemberPointerFields(MPT, fields);
2945   assert(!fields.empty());
2946   llvm::Value *FirstField = MemPtr;
2947   if (MemPtr->getType()->isStructTy())
2948     FirstField = Builder.CreateExtractValue(MemPtr, 0);
2949   llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
2950 
2951   // For function member pointers, we only need to test the function pointer
2952   // field.  The other fields if any can be garbage.
2953   if (MPT->isMemberFunctionPointer())
2954     return Res;
2955 
2956   // Otherwise, emit a series of compares and combine the results.
2957   for (int I = 1, E = fields.size(); I < E; ++I) {
2958     llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2959     llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
2960     Res = Builder.CreateOr(Res, Next, "memptr.tobool");
2961   }
2962   return Res;
2963 }
2964 
2965 bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2966                                                   llvm::Constant *Val) {
2967   // Function pointers are null if the pointer in the first field is null.
2968   if (MPT->isMemberFunctionPointer()) {
2969     llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2970       Val->getAggregateElement(0U) : Val;
2971     return FirstField->isNullValue();
2972   }
2973 
2974   // If it's not a function pointer and it's zero initializable, we can easily
2975   // check zero.
2976   if (isZeroInitializable(MPT) && Val->isNullValue())
2977     return true;
2978 
2979   // Otherwise, break down all the fields for comparison.  Hopefully these
2980   // little Constants are reused, while a big null struct might not be.
2981   llvm::SmallVector<llvm::Constant *, 4> Fields;
2982   GetNullMemberPointerFields(MPT, Fields);
2983   if (Fields.size() == 1) {
2984     assert(Val->getType()->isIntegerTy());
2985     return Val == Fields[0];
2986   }
2987 
2988   unsigned I, E;
2989   for (I = 0, E = Fields.size(); I != E; ++I) {
2990     if (Val->getAggregateElement(I) != Fields[I])
2991       break;
2992   }
2993   return I == E;
2994 }
2995 
2996 llvm::Value *
2997 MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
2998                                          Address This,
2999                                          llvm::Value *VBPtrOffset,
3000                                          llvm::Value *VBTableOffset,
3001                                          llvm::Value **VBPtrOut) {
3002   CGBuilderTy &Builder = CGF.Builder;
3003   // Load the vbtable pointer from the vbptr in the instance.
3004   This = Builder.CreateElementBitCast(This, CGM.Int8Ty);
3005   llvm::Value *VBPtr =
3006     Builder.CreateInBoundsGEP(This.getPointer(), VBPtrOffset, "vbptr");
3007   if (VBPtrOut) *VBPtrOut = VBPtr;
3008   VBPtr = Builder.CreateBitCast(VBPtr,
3009             CGM.Int32Ty->getPointerTo(0)->getPointerTo(This.getAddressSpace()));
3010 
3011   CharUnits VBPtrAlign;
3012   if (auto CI = dyn_cast<llvm::ConstantInt>(VBPtrOffset)) {
3013     VBPtrAlign = This.getAlignment().alignmentAtOffset(
3014                                    CharUnits::fromQuantity(CI->getSExtValue()));
3015   } else {
3016     VBPtrAlign = CGF.getPointerAlign();
3017   }
3018 
3019   llvm::Value *VBTable = Builder.CreateAlignedLoad(VBPtr, VBPtrAlign, "vbtable");
3020 
3021   // Translate from byte offset to table index. It improves analyzability.
3022   llvm::Value *VBTableIndex = Builder.CreateAShr(
3023       VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
3024       "vbtindex", /*isExact=*/true);
3025 
3026   // Load an i32 offset from the vb-table.
3027   llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
3028   VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
3029   return Builder.CreateAlignedLoad(VBaseOffs, CharUnits::fromQuantity(4),
3030                                    "vbase_offs");
3031 }
3032 
3033 // Returns an adjusted base cast to i8*, since we do more address arithmetic on
3034 // it.
3035 llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
3036     CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
3037     Address Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
3038   CGBuilderTy &Builder = CGF.Builder;
3039   Base = Builder.CreateElementBitCast(Base, CGM.Int8Ty);
3040   llvm::BasicBlock *OriginalBB = nullptr;
3041   llvm::BasicBlock *SkipAdjustBB = nullptr;
3042   llvm::BasicBlock *VBaseAdjustBB = nullptr;
3043 
3044   // In the unspecified inheritance model, there might not be a vbtable at all,
3045   // in which case we need to skip the virtual base lookup.  If there is a
3046   // vbtable, the first entry is a no-op entry that gives back the original
3047   // base, so look for a virtual base adjustment offset of zero.
3048   if (VBPtrOffset) {
3049     OriginalBB = Builder.GetInsertBlock();
3050     VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
3051     SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
3052     llvm::Value *IsVirtual =
3053       Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
3054                            "memptr.is_vbase");
3055     Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
3056     CGF.EmitBlock(VBaseAdjustBB);
3057   }
3058 
3059   // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
3060   // know the vbptr offset.
3061   if (!VBPtrOffset) {
3062     CharUnits offs = CharUnits::Zero();
3063     if (!RD->hasDefinition()) {
3064       DiagnosticsEngine &Diags = CGF.CGM.getDiags();
3065       unsigned DiagID = Diags.getCustomDiagID(
3066           DiagnosticsEngine::Error,
3067           "member pointer representation requires a "
3068           "complete class type for %0 to perform this expression");
3069       Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
3070     } else if (RD->getNumVBases())
3071       offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
3072     VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
3073   }
3074   llvm::Value *VBPtr = nullptr;
3075   llvm::Value *VBaseOffs =
3076     GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
3077   llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
3078 
3079   // Merge control flow with the case where we didn't have to adjust.
3080   if (VBaseAdjustBB) {
3081     Builder.CreateBr(SkipAdjustBB);
3082     CGF.EmitBlock(SkipAdjustBB);
3083     llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
3084     Phi->addIncoming(Base.getPointer(), OriginalBB);
3085     Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
3086     return Phi;
3087   }
3088   return AdjustedBase;
3089 }
3090 
3091 llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
3092     CodeGenFunction &CGF, const Expr *E, Address Base, llvm::Value *MemPtr,
3093     const MemberPointerType *MPT) {
3094   assert(MPT->isMemberDataPointer());
3095   unsigned AS = Base.getAddressSpace();
3096   llvm::Type *PType =
3097       CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
3098   CGBuilderTy &Builder = CGF.Builder;
3099   const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
3100   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
3101 
3102   // Extract the fields we need, regardless of model.  We'll apply them if we
3103   // have them.
3104   llvm::Value *FieldOffset = MemPtr;
3105   llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3106   llvm::Value *VBPtrOffset = nullptr;
3107   if (MemPtr->getType()->isStructTy()) {
3108     // We need to extract values.
3109     unsigned I = 0;
3110     FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
3111     if (inheritanceModelHasVBPtrOffsetField(Inheritance))
3112       VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
3113     if (inheritanceModelHasVBTableOffsetField(Inheritance))
3114       VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3115   }
3116 
3117   llvm::Value *Addr;
3118   if (VirtualBaseAdjustmentOffset) {
3119     Addr = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
3120                              VBPtrOffset);
3121   } else {
3122     Addr = Base.getPointer();
3123   }
3124 
3125   // Cast to char*.
3126   Addr = Builder.CreateBitCast(Addr, CGF.Int8Ty->getPointerTo(AS));
3127 
3128   // Apply the offset, which we assume is non-null.
3129   Addr = Builder.CreateInBoundsGEP(Addr, FieldOffset, "memptr.offset");
3130 
3131   // Cast the address to the appropriate pointer type, adopting the address
3132   // space of the base pointer.
3133   return Builder.CreateBitCast(Addr, PType);
3134 }
3135 
3136 llvm::Value *
3137 MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
3138                                              const CastExpr *E,
3139                                              llvm::Value *Src) {
3140   assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
3141          E->getCastKind() == CK_BaseToDerivedMemberPointer ||
3142          E->getCastKind() == CK_ReinterpretMemberPointer);
3143 
3144   // Use constant emission if we can.
3145   if (isa<llvm::Constant>(Src))
3146     return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
3147 
3148   // We may be adding or dropping fields from the member pointer, so we need
3149   // both types and the inheritance models of both records.
3150   const MemberPointerType *SrcTy =
3151     E->getSubExpr()->getType()->castAs<MemberPointerType>();
3152   const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3153   bool IsFunc = SrcTy->isMemberFunctionPointer();
3154 
3155   // If the classes use the same null representation, reinterpret_cast is a nop.
3156   bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
3157   if (IsReinterpret && IsFunc)
3158     return Src;
3159 
3160   CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3161   CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3162   if (IsReinterpret &&
3163       SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
3164     return Src;
3165 
3166   CGBuilderTy &Builder = CGF.Builder;
3167 
3168   // Branch past the conversion if Src is null.
3169   llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
3170   llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
3171 
3172   // C++ 5.2.10p9: The null member pointer value is converted to the null member
3173   //   pointer value of the destination type.
3174   if (IsReinterpret) {
3175     // For reinterpret casts, sema ensures that src and dst are both functions
3176     // or data and have the same size, which means the LLVM types should match.
3177     assert(Src->getType() == DstNull->getType());
3178     return Builder.CreateSelect(IsNotNull, Src, DstNull);
3179   }
3180 
3181   llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
3182   llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
3183   llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
3184   Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
3185   CGF.EmitBlock(ConvertBB);
3186 
3187   llvm::Value *Dst = EmitNonNullMemberPointerConversion(
3188       SrcTy, DstTy, E->getCastKind(), E->path_begin(), E->path_end(), Src,
3189       Builder);
3190 
3191   Builder.CreateBr(ContinueBB);
3192 
3193   // In the continuation, choose between DstNull and Dst.
3194   CGF.EmitBlock(ContinueBB);
3195   llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
3196   Phi->addIncoming(DstNull, OriginalBB);
3197   Phi->addIncoming(Dst, ConvertBB);
3198   return Phi;
3199 }
3200 
3201 llvm::Value *MicrosoftCXXABI::EmitNonNullMemberPointerConversion(
3202     const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3203     CastExpr::path_const_iterator PathBegin,
3204     CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
3205     CGBuilderTy &Builder) {
3206   const CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3207   const CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3208   MSInheritanceModel SrcInheritance = SrcRD->getMSInheritanceModel();
3209   MSInheritanceModel DstInheritance = DstRD->getMSInheritanceModel();
3210   bool IsFunc = SrcTy->isMemberFunctionPointer();
3211   bool IsConstant = isa<llvm::Constant>(Src);
3212 
3213   // Decompose src.
3214   llvm::Value *FirstField = Src;
3215   llvm::Value *NonVirtualBaseAdjustment = getZeroInt();
3216   llvm::Value *VirtualBaseAdjustmentOffset = getZeroInt();
3217   llvm::Value *VBPtrOffset = getZeroInt();
3218   if (!inheritanceModelHasOnlyOneField(IsFunc, SrcInheritance)) {
3219     // We need to extract values.
3220     unsigned I = 0;
3221     FirstField = Builder.CreateExtractValue(Src, I++);
3222     if (inheritanceModelHasNVOffsetField(IsFunc, SrcInheritance))
3223       NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
3224     if (inheritanceModelHasVBPtrOffsetField(SrcInheritance))
3225       VBPtrOffset = Builder.CreateExtractValue(Src, I++);
3226     if (inheritanceModelHasVBTableOffsetField(SrcInheritance))
3227       VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
3228   }
3229 
3230   bool IsDerivedToBase = (CK == CK_DerivedToBaseMemberPointer);
3231   const MemberPointerType *DerivedTy = IsDerivedToBase ? SrcTy : DstTy;
3232   const CXXRecordDecl *DerivedClass = DerivedTy->getMostRecentCXXRecordDecl();
3233 
3234   // For data pointers, we adjust the field offset directly.  For functions, we
3235   // have a separate field.
3236   llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
3237 
3238   // The virtual inheritance model has a quirk: the virtual base table is always
3239   // referenced when dereferencing a member pointer even if the member pointer
3240   // is non-virtual.  This is accounted for by adjusting the non-virtual offset
3241   // to point backwards to the top of the MDC from the first VBase.  Undo this
3242   // adjustment to normalize the member pointer.
3243   llvm::Value *SrcVBIndexEqZero =
3244       Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3245   if (SrcInheritance == MSInheritanceModel::Virtual) {
3246     if (int64_t SrcOffsetToFirstVBase =
3247             getContext().getOffsetOfBaseWithVBPtr(SrcRD).getQuantity()) {
3248       llvm::Value *UndoSrcAdjustment = Builder.CreateSelect(
3249           SrcVBIndexEqZero,
3250           llvm::ConstantInt::get(CGM.IntTy, SrcOffsetToFirstVBase),
3251           getZeroInt());
3252       NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, UndoSrcAdjustment);
3253     }
3254   }
3255 
3256   // A non-zero vbindex implies that we are dealing with a source member in a
3257   // floating virtual base in addition to some non-virtual offset.  If the
3258   // vbindex is zero, we are dealing with a source that exists in a non-virtual,
3259   // fixed, base.  The difference between these two cases is that the vbindex +
3260   // nvoffset *always* point to the member regardless of what context they are
3261   // evaluated in so long as the vbindex is adjusted.  A member inside a fixed
3262   // base requires explicit nv adjustment.
3263   llvm::Constant *BaseClassOffset = llvm::ConstantInt::get(
3264       CGM.IntTy,
3265       CGM.computeNonVirtualBaseClassOffset(DerivedClass, PathBegin, PathEnd)
3266           .getQuantity());
3267 
3268   llvm::Value *NVDisp;
3269   if (IsDerivedToBase)
3270     NVDisp = Builder.CreateNSWSub(NVAdjustField, BaseClassOffset, "adj");
3271   else
3272     NVDisp = Builder.CreateNSWAdd(NVAdjustField, BaseClassOffset, "adj");
3273 
3274   NVAdjustField = Builder.CreateSelect(SrcVBIndexEqZero, NVDisp, getZeroInt());
3275 
3276   // Update the vbindex to an appropriate value in the destination because
3277   // SrcRD's vbtable might not be a strict prefix of the one in DstRD.
3278   llvm::Value *DstVBIndexEqZero = SrcVBIndexEqZero;
3279   if (inheritanceModelHasVBTableOffsetField(DstInheritance) &&
3280       inheritanceModelHasVBTableOffsetField(SrcInheritance)) {
3281     if (llvm::GlobalVariable *VDispMap =
3282             getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) {
3283       llvm::Value *VBIndex = Builder.CreateExactUDiv(
3284           VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4));
3285       if (IsConstant) {
3286         llvm::Constant *Mapping = VDispMap->getInitializer();
3287         VirtualBaseAdjustmentOffset =
3288             Mapping->getAggregateElement(cast<llvm::Constant>(VBIndex));
3289       } else {
3290         llvm::Value *Idxs[] = {getZeroInt(), VBIndex};
3291         VirtualBaseAdjustmentOffset =
3292             Builder.CreateAlignedLoad(Builder.CreateInBoundsGEP(VDispMap, Idxs),
3293                                       CharUnits::fromQuantity(4));
3294       }
3295 
3296       DstVBIndexEqZero =
3297           Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3298     }
3299   }
3300 
3301   // Set the VBPtrOffset to zero if the vbindex is zero.  Otherwise, initialize
3302   // it to the offset of the vbptr.
3303   if (inheritanceModelHasVBPtrOffsetField(DstInheritance)) {
3304     llvm::Value *DstVBPtrOffset = llvm::ConstantInt::get(
3305         CGM.IntTy,
3306         getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity());
3307     VBPtrOffset =
3308         Builder.CreateSelect(DstVBIndexEqZero, getZeroInt(), DstVBPtrOffset);
3309   }
3310 
3311   // Likewise, apply a similar adjustment so that dereferencing the member
3312   // pointer correctly accounts for the distance between the start of the first
3313   // virtual base and the top of the MDC.
3314   if (DstInheritance == MSInheritanceModel::Virtual) {
3315     if (int64_t DstOffsetToFirstVBase =
3316             getContext().getOffsetOfBaseWithVBPtr(DstRD).getQuantity()) {
3317       llvm::Value *DoDstAdjustment = Builder.CreateSelect(
3318           DstVBIndexEqZero,
3319           llvm::ConstantInt::get(CGM.IntTy, DstOffsetToFirstVBase),
3320           getZeroInt());
3321       NVAdjustField = Builder.CreateNSWSub(NVAdjustField, DoDstAdjustment);
3322     }
3323   }
3324 
3325   // Recompose dst from the null struct and the adjusted fields from src.
3326   llvm::Value *Dst;
3327   if (inheritanceModelHasOnlyOneField(IsFunc, DstInheritance)) {
3328     Dst = FirstField;
3329   } else {
3330     Dst = llvm::UndefValue::get(ConvertMemberPointerType(DstTy));
3331     unsigned Idx = 0;
3332     Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
3333     if (inheritanceModelHasNVOffsetField(IsFunc, DstInheritance))
3334       Dst = Builder.CreateInsertValue(Dst, NonVirtualBaseAdjustment, Idx++);
3335     if (inheritanceModelHasVBPtrOffsetField(DstInheritance))
3336       Dst = Builder.CreateInsertValue(Dst, VBPtrOffset, Idx++);
3337     if (inheritanceModelHasVBTableOffsetField(DstInheritance))
3338       Dst = Builder.CreateInsertValue(Dst, VirtualBaseAdjustmentOffset, Idx++);
3339   }
3340   return Dst;
3341 }
3342 
3343 llvm::Constant *
3344 MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
3345                                              llvm::Constant *Src) {
3346   const MemberPointerType *SrcTy =
3347       E->getSubExpr()->getType()->castAs<MemberPointerType>();
3348   const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3349 
3350   CastKind CK = E->getCastKind();
3351 
3352   return EmitMemberPointerConversion(SrcTy, DstTy, CK, E->path_begin(),
3353                                      E->path_end(), Src);
3354 }
3355 
3356 llvm::Constant *MicrosoftCXXABI::EmitMemberPointerConversion(
3357     const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3358     CastExpr::path_const_iterator PathBegin,
3359     CastExpr::path_const_iterator PathEnd, llvm::Constant *Src) {
3360   assert(CK == CK_DerivedToBaseMemberPointer ||
3361          CK == CK_BaseToDerivedMemberPointer ||
3362          CK == CK_ReinterpretMemberPointer);
3363   // If src is null, emit a new null for dst.  We can't return src because dst
3364   // might have a new representation.
3365   if (MemberPointerConstantIsNull(SrcTy, Src))
3366     return EmitNullMemberPointer(DstTy);
3367 
3368   // We don't need to do anything for reinterpret_casts of non-null member
3369   // pointers.  We should only get here when the two type representations have
3370   // the same size.
3371   if (CK == CK_ReinterpretMemberPointer)
3372     return Src;
3373 
3374   CGBuilderTy Builder(CGM, CGM.getLLVMContext());
3375   auto *Dst = cast<llvm::Constant>(EmitNonNullMemberPointerConversion(
3376       SrcTy, DstTy, CK, PathBegin, PathEnd, Src, Builder));
3377 
3378   return Dst;
3379 }
3380 
3381 CGCallee MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
3382     CodeGenFunction &CGF, const Expr *E, Address This,
3383     llvm::Value *&ThisPtrForCall, llvm::Value *MemPtr,
3384     const MemberPointerType *MPT) {
3385   assert(MPT->isMemberFunctionPointer());
3386   const FunctionProtoType *FPT =
3387     MPT->getPointeeType()->castAs<FunctionProtoType>();
3388   const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
3389   llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(
3390       CGM.getTypes().arrangeCXXMethodType(RD, FPT, /*FD=*/nullptr));
3391   CGBuilderTy &Builder = CGF.Builder;
3392 
3393   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
3394 
3395   // Extract the fields we need, regardless of model.  We'll apply them if we
3396   // have them.
3397   llvm::Value *FunctionPointer = MemPtr;
3398   llvm::Value *NonVirtualBaseAdjustment = nullptr;
3399   llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3400   llvm::Value *VBPtrOffset = nullptr;
3401   if (MemPtr->getType()->isStructTy()) {
3402     // We need to extract values.
3403     unsigned I = 0;
3404     FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
3405     if (inheritanceModelHasNVOffsetField(MPT, Inheritance))
3406       NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
3407     if (inheritanceModelHasVBPtrOffsetField(Inheritance))
3408       VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
3409     if (inheritanceModelHasVBTableOffsetField(Inheritance))
3410       VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3411   }
3412 
3413   if (VirtualBaseAdjustmentOffset) {
3414     ThisPtrForCall = AdjustVirtualBase(CGF, E, RD, This,
3415                                    VirtualBaseAdjustmentOffset, VBPtrOffset);
3416   } else {
3417     ThisPtrForCall = This.getPointer();
3418   }
3419 
3420   if (NonVirtualBaseAdjustment) {
3421     // Apply the adjustment and cast back to the original struct type.
3422     llvm::Value *Ptr = Builder.CreateBitCast(ThisPtrForCall, CGF.Int8PtrTy);
3423     Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
3424     ThisPtrForCall = Builder.CreateBitCast(Ptr, ThisPtrForCall->getType(),
3425                                            "this.adjusted");
3426   }
3427 
3428   FunctionPointer =
3429     Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
3430   CGCallee Callee(FPT, FunctionPointer);
3431   return Callee;
3432 }
3433 
3434 CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
3435   return new MicrosoftCXXABI(CGM);
3436 }
3437 
3438 // MS RTTI Overview:
3439 // The run time type information emitted by cl.exe contains 5 distinct types of
3440 // structures.  Many of them reference each other.
3441 //
3442 // TypeInfo:  Static classes that are returned by typeid.
3443 //
3444 // CompleteObjectLocator:  Referenced by vftables.  They contain information
3445 //   required for dynamic casting, including OffsetFromTop.  They also contain
3446 //   a reference to the TypeInfo for the type and a reference to the
3447 //   CompleteHierarchyDescriptor for the type.
3448 //
3449 // ClassHierarchyDescriptor: Contains information about a class hierarchy.
3450 //   Used during dynamic_cast to walk a class hierarchy.  References a base
3451 //   class array and the size of said array.
3452 //
3453 // BaseClassArray: Contains a list of classes in a hierarchy.  BaseClassArray is
3454 //   somewhat of a misnomer because the most derived class is also in the list
3455 //   as well as multiple copies of virtual bases (if they occur multiple times
3456 //   in the hierarchy.)  The BaseClassArray contains one BaseClassDescriptor for
3457 //   every path in the hierarchy, in pre-order depth first order.  Note, we do
3458 //   not declare a specific llvm type for BaseClassArray, it's merely an array
3459 //   of BaseClassDescriptor pointers.
3460 //
3461 // BaseClassDescriptor: Contains information about a class in a class hierarchy.
3462 //   BaseClassDescriptor is also somewhat of a misnomer for the same reason that
3463 //   BaseClassArray is.  It contains information about a class within a
3464 //   hierarchy such as: is this base is ambiguous and what is its offset in the
3465 //   vbtable.  The names of the BaseClassDescriptors have all of their fields
3466 //   mangled into them so they can be aggressively deduplicated by the linker.
3467 
3468 static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
3469   StringRef MangledName("??_7type_info@@6B@");
3470   if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
3471     return VTable;
3472   return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
3473                                   /*isConstant=*/true,
3474                                   llvm::GlobalVariable::ExternalLinkage,
3475                                   /*Initializer=*/nullptr, MangledName);
3476 }
3477 
3478 namespace {
3479 
3480 /// A Helper struct that stores information about a class in a class
3481 /// hierarchy.  The information stored in these structs struct is used during
3482 /// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
3483 // During RTTI creation, MSRTTIClasses are stored in a contiguous array with
3484 // implicit depth first pre-order tree connectivity.  getFirstChild and
3485 // getNextSibling allow us to walk the tree efficiently.
3486 struct MSRTTIClass {
3487   enum {
3488     IsPrivateOnPath = 1 | 8,
3489     IsAmbiguous = 2,
3490     IsPrivate = 4,
3491     IsVirtual = 16,
3492     HasHierarchyDescriptor = 64
3493   };
3494   MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
3495   uint32_t initialize(const MSRTTIClass *Parent,
3496                       const CXXBaseSpecifier *Specifier);
3497 
3498   MSRTTIClass *getFirstChild() { return this + 1; }
3499   static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
3500     return Child + 1 + Child->NumBases;
3501   }
3502 
3503   const CXXRecordDecl *RD, *VirtualRoot;
3504   uint32_t Flags, NumBases, OffsetInVBase;
3505 };
3506 
3507 /// Recursively initialize the base class array.
3508 uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
3509                                  const CXXBaseSpecifier *Specifier) {
3510   Flags = HasHierarchyDescriptor;
3511   if (!Parent) {
3512     VirtualRoot = nullptr;
3513     OffsetInVBase = 0;
3514   } else {
3515     if (Specifier->getAccessSpecifier() != AS_public)
3516       Flags |= IsPrivate | IsPrivateOnPath;
3517     if (Specifier->isVirtual()) {
3518       Flags |= IsVirtual;
3519       VirtualRoot = RD;
3520       OffsetInVBase = 0;
3521     } else {
3522       if (Parent->Flags & IsPrivateOnPath)
3523         Flags |= IsPrivateOnPath;
3524       VirtualRoot = Parent->VirtualRoot;
3525       OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
3526           .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
3527     }
3528   }
3529   NumBases = 0;
3530   MSRTTIClass *Child = getFirstChild();
3531   for (const CXXBaseSpecifier &Base : RD->bases()) {
3532     NumBases += Child->initialize(this, &Base) + 1;
3533     Child = getNextChild(Child);
3534   }
3535   return NumBases;
3536 }
3537 
3538 static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
3539   switch (Ty->getLinkage()) {
3540   case NoLinkage:
3541   case InternalLinkage:
3542   case UniqueExternalLinkage:
3543     return llvm::GlobalValue::InternalLinkage;
3544 
3545   case VisibleNoLinkage:
3546   case ModuleInternalLinkage:
3547   case ModuleLinkage:
3548   case ExternalLinkage:
3549     return llvm::GlobalValue::LinkOnceODRLinkage;
3550   }
3551   llvm_unreachable("Invalid linkage!");
3552 }
3553 
3554 /// An ephemeral helper class for building MS RTTI types.  It caches some
3555 /// calls to the module and information about the most derived class in a
3556 /// hierarchy.
3557 struct MSRTTIBuilder {
3558   enum {
3559     HasBranchingHierarchy = 1,
3560     HasVirtualBranchingHierarchy = 2,
3561     HasAmbiguousBases = 4
3562   };
3563 
3564   MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
3565       : CGM(ABI.CGM), Context(CGM.getContext()),
3566         VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
3567         Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
3568         ABI(ABI) {}
3569 
3570   llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
3571   llvm::GlobalVariable *
3572   getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
3573   llvm::GlobalVariable *getClassHierarchyDescriptor();
3574   llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo &Info);
3575 
3576   CodeGenModule &CGM;
3577   ASTContext &Context;
3578   llvm::LLVMContext &VMContext;
3579   llvm::Module &Module;
3580   const CXXRecordDecl *RD;
3581   llvm::GlobalVariable::LinkageTypes Linkage;
3582   MicrosoftCXXABI &ABI;
3583 };
3584 
3585 } // namespace
3586 
3587 /// Recursively serializes a class hierarchy in pre-order depth first
3588 /// order.
3589 static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
3590                                     const CXXRecordDecl *RD) {
3591   Classes.push_back(MSRTTIClass(RD));
3592   for (const CXXBaseSpecifier &Base : RD->bases())
3593     serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
3594 }
3595 
3596 /// Find ambiguity among base classes.
3597 static void
3598 detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
3599   llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
3600   llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
3601   llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
3602   for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
3603     if ((Class->Flags & MSRTTIClass::IsVirtual) &&
3604         !VirtualBases.insert(Class->RD).second) {
3605       Class = MSRTTIClass::getNextChild(Class);
3606       continue;
3607     }
3608     if (!UniqueBases.insert(Class->RD).second)
3609       AmbiguousBases.insert(Class->RD);
3610     Class++;
3611   }
3612   if (AmbiguousBases.empty())
3613     return;
3614   for (MSRTTIClass &Class : Classes)
3615     if (AmbiguousBases.count(Class.RD))
3616       Class.Flags |= MSRTTIClass::IsAmbiguous;
3617 }
3618 
3619 llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
3620   SmallString<256> MangledName;
3621   {
3622     llvm::raw_svector_ostream Out(MangledName);
3623     ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
3624   }
3625 
3626   // Check to see if we've already declared this ClassHierarchyDescriptor.
3627   if (auto CHD = Module.getNamedGlobal(MangledName))
3628     return CHD;
3629 
3630   // Serialize the class hierarchy and initialize the CHD Fields.
3631   SmallVector<MSRTTIClass, 8> Classes;
3632   serializeClassHierarchy(Classes, RD);
3633   Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3634   detectAmbiguousBases(Classes);
3635   int Flags = 0;
3636   for (auto Class : Classes) {
3637     if (Class.RD->getNumBases() > 1)
3638       Flags |= HasBranchingHierarchy;
3639     // Note: cl.exe does not calculate "HasAmbiguousBases" correctly.  We
3640     // believe the field isn't actually used.
3641     if (Class.Flags & MSRTTIClass::IsAmbiguous)
3642       Flags |= HasAmbiguousBases;
3643   }
3644   if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
3645     Flags |= HasVirtualBranchingHierarchy;
3646   // These gep indices are used to get the address of the first element of the
3647   // base class array.
3648   llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
3649                                llvm::ConstantInt::get(CGM.IntTy, 0)};
3650 
3651   // Forward-declare the class hierarchy descriptor
3652   auto Type = ABI.getClassHierarchyDescriptorType();
3653   auto CHD = new llvm::GlobalVariable(Module, Type, /*isConstant=*/true, Linkage,
3654                                       /*Initializer=*/nullptr,
3655                                       MangledName);
3656   if (CHD->isWeakForLinker())
3657     CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
3658 
3659   auto *Bases = getBaseClassArray(Classes);
3660 
3661   // Initialize the base class ClassHierarchyDescriptor.
3662   llvm::Constant *Fields[] = {
3663       llvm::ConstantInt::get(CGM.IntTy, 0), // reserved by the runtime
3664       llvm::ConstantInt::get(CGM.IntTy, Flags),
3665       llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
3666       ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
3667           Bases->getValueType(), Bases,
3668           llvm::ArrayRef<llvm::Value *>(GEPIndices))),
3669   };
3670   CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3671   return CHD;
3672 }
3673 
3674 llvm::GlobalVariable *
3675 MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3676   SmallString<256> MangledName;
3677   {
3678     llvm::raw_svector_ostream Out(MangledName);
3679     ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
3680   }
3681 
3682   // Forward-declare the base class array.
3683   // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3684   // mode) bytes of padding.  We provide a pointer sized amount of padding by
3685   // adding +1 to Classes.size().  The sections have pointer alignment and are
3686   // marked pick-any so it shouldn't matter.
3687   llvm::Type *PtrType = ABI.getImageRelativeType(
3688       ABI.getBaseClassDescriptorType()->getPointerTo());
3689   auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
3690   auto *BCA =
3691       new llvm::GlobalVariable(Module, ArrType,
3692                                /*isConstant=*/true, Linkage,
3693                                /*Initializer=*/nullptr, MangledName);
3694   if (BCA->isWeakForLinker())
3695     BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
3696 
3697   // Initialize the BaseClassArray.
3698   SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3699   for (MSRTTIClass &Class : Classes)
3700     BaseClassArrayData.push_back(
3701         ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
3702   BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
3703   BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
3704   return BCA;
3705 }
3706 
3707 llvm::GlobalVariable *
3708 MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3709   // Compute the fields for the BaseClassDescriptor.  They are computed up front
3710   // because they are mangled into the name of the object.
3711   uint32_t OffsetInVBTable = 0;
3712   int32_t VBPtrOffset = -1;
3713   if (Class.VirtualRoot) {
3714     auto &VTableContext = CGM.getMicrosoftVTableContext();
3715     OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3716     VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3717   }
3718 
3719   SmallString<256> MangledName;
3720   {
3721     llvm::raw_svector_ostream Out(MangledName);
3722     ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3723         Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3724         Class.Flags, Out);
3725   }
3726 
3727   // Check to see if we've already declared this object.
3728   if (auto BCD = Module.getNamedGlobal(MangledName))
3729     return BCD;
3730 
3731   // Forward-declare the base class descriptor.
3732   auto Type = ABI.getBaseClassDescriptorType();
3733   auto BCD =
3734       new llvm::GlobalVariable(Module, Type, /*isConstant=*/true, Linkage,
3735                                /*Initializer=*/nullptr, MangledName);
3736   if (BCD->isWeakForLinker())
3737     BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
3738 
3739   // Initialize the BaseClassDescriptor.
3740   llvm::Constant *Fields[] = {
3741       ABI.getImageRelativeConstant(
3742           ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
3743       llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3744       llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3745       llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3746       llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3747       llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3748       ABI.getImageRelativeConstant(
3749           MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
3750   };
3751   BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3752   return BCD;
3753 }
3754 
3755 llvm::GlobalVariable *
3756 MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo &Info) {
3757   SmallString<256> MangledName;
3758   {
3759     llvm::raw_svector_ostream Out(MangledName);
3760     ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info.MangledPath, Out);
3761   }
3762 
3763   // Check to see if we've already computed this complete object locator.
3764   if (auto COL = Module.getNamedGlobal(MangledName))
3765     return COL;
3766 
3767   // Compute the fields of the complete object locator.
3768   int OffsetToTop = Info.FullOffsetInMDC.getQuantity();
3769   int VFPtrOffset = 0;
3770   // The offset includes the vtordisp if one exists.
3771   if (const CXXRecordDecl *VBase = Info.getVBaseWithVPtr())
3772     if (Context.getASTRecordLayout(RD)
3773       .getVBaseOffsetsMap()
3774       .find(VBase)
3775       ->second.hasVtorDisp())
3776       VFPtrOffset = Info.NonVirtualOffset.getQuantity() + 4;
3777 
3778   // Forward-declare the complete object locator.
3779   llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
3780   auto COL = new llvm::GlobalVariable(Module, Type, /*isConstant=*/true, Linkage,
3781     /*Initializer=*/nullptr, MangledName);
3782 
3783   // Initialize the CompleteObjectLocator.
3784   llvm::Constant *Fields[] = {
3785       llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3786       llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3787       llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3788       ABI.getImageRelativeConstant(
3789           CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3790       ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3791       ABI.getImageRelativeConstant(COL),
3792   };
3793   llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
3794   if (!ABI.isImageRelative())
3795     FieldsRef = FieldsRef.drop_back();
3796   COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
3797   if (COL->isWeakForLinker())
3798     COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
3799   return COL;
3800 }
3801 
3802 static QualType decomposeTypeForEH(ASTContext &Context, QualType T,
3803                                    bool &IsConst, bool &IsVolatile,
3804                                    bool &IsUnaligned) {
3805   T = Context.getExceptionObjectType(T);
3806 
3807   // C++14 [except.handle]p3:
3808   //   A handler is a match for an exception object of type E if [...]
3809   //     - the handler is of type cv T or const T& where T is a pointer type and
3810   //       E is a pointer type that can be converted to T by [...]
3811   //         - a qualification conversion
3812   IsConst = false;
3813   IsVolatile = false;
3814   IsUnaligned = false;
3815   QualType PointeeType = T->getPointeeType();
3816   if (!PointeeType.isNull()) {
3817     IsConst = PointeeType.isConstQualified();
3818     IsVolatile = PointeeType.isVolatileQualified();
3819     IsUnaligned = PointeeType.getQualifiers().hasUnaligned();
3820   }
3821 
3822   // Member pointer types like "const int A::*" are represented by having RTTI
3823   // for "int A::*" and separately storing the const qualifier.
3824   if (const auto *MPTy = T->getAs<MemberPointerType>())
3825     T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(),
3826                                      MPTy->getClass());
3827 
3828   // Pointer types like "const int * const *" are represented by having RTTI
3829   // for "const int **" and separately storing the const qualifier.
3830   if (T->isPointerType())
3831     T = Context.getPointerType(PointeeType.getUnqualifiedType());
3832 
3833   return T;
3834 }
3835 
3836 CatchTypeInfo
3837 MicrosoftCXXABI::getAddrOfCXXCatchHandlerType(QualType Type,
3838                                               QualType CatchHandlerType) {
3839   // TypeDescriptors for exceptions never have qualified pointer types,
3840   // qualifiers are stored separately in order to support qualification
3841   // conversions.
3842   bool IsConst, IsVolatile, IsUnaligned;
3843   Type =
3844       decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile, IsUnaligned);
3845 
3846   bool IsReference = CatchHandlerType->isReferenceType();
3847 
3848   uint32_t Flags = 0;
3849   if (IsConst)
3850     Flags |= 1;
3851   if (IsVolatile)
3852     Flags |= 2;
3853   if (IsUnaligned)
3854     Flags |= 4;
3855   if (IsReference)
3856     Flags |= 8;
3857 
3858   return CatchTypeInfo{getAddrOfRTTIDescriptor(Type)->stripPointerCasts(),
3859                        Flags};
3860 }
3861 
3862 /// Gets a TypeDescriptor.  Returns a llvm::Constant * rather than a
3863 /// llvm::GlobalVariable * because different type descriptors have different
3864 /// types, and need to be abstracted.  They are abstracting by casting the
3865 /// address to an Int8PtrTy.
3866 llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
3867   SmallString<256> MangledName;
3868   {
3869     llvm::raw_svector_ostream Out(MangledName);
3870     getMangleContext().mangleCXXRTTI(Type, Out);
3871   }
3872 
3873   // Check to see if we've already declared this TypeDescriptor.
3874   if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3875     return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3876 
3877   // Note for the future: If we would ever like to do deferred emission of
3878   // RTTI, check if emitting vtables opportunistically need any adjustment.
3879 
3880   // Compute the fields for the TypeDescriptor.
3881   SmallString<256> TypeInfoString;
3882   {
3883     llvm::raw_svector_ostream Out(TypeInfoString);
3884     getMangleContext().mangleCXXRTTIName(Type, Out);
3885   }
3886 
3887   // Declare and initialize the TypeDescriptor.
3888   llvm::Constant *Fields[] = {
3889     getTypeInfoVTable(CGM),                        // VFPtr
3890     llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3891     llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3892   llvm::StructType *TypeDescriptorType =
3893       getTypeDescriptorType(TypeInfoString);
3894   auto *Var = new llvm::GlobalVariable(
3895       CGM.getModule(), TypeDescriptorType, /*isConstant=*/false,
3896       getLinkageForRTTI(Type),
3897       llvm::ConstantStruct::get(TypeDescriptorType, Fields),
3898       MangledName);
3899   if (Var->isWeakForLinker())
3900     Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3901   return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
3902 }
3903 
3904 /// Gets or a creates a Microsoft CompleteObjectLocator.
3905 llvm::GlobalVariable *
3906 MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
3907                                             const VPtrInfo &Info) {
3908   return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
3909 }
3910 
3911 void MicrosoftCXXABI::emitCXXStructor(GlobalDecl GD) {
3912   if (auto *ctor = dyn_cast<CXXConstructorDecl>(GD.getDecl())) {
3913     // There are no constructor variants, always emit the complete destructor.
3914     llvm::Function *Fn =
3915         CGM.codegenCXXStructor(GD.getWithCtorType(Ctor_Complete));
3916     CGM.maybeSetTrivialComdat(*ctor, *Fn);
3917     return;
3918   }
3919 
3920   auto *dtor = cast<CXXDestructorDecl>(GD.getDecl());
3921 
3922   // Emit the base destructor if the base and complete (vbase) destructors are
3923   // equivalent. This effectively implements -mconstructor-aliases as part of
3924   // the ABI.
3925   if (GD.getDtorType() == Dtor_Complete &&
3926       dtor->getParent()->getNumVBases() == 0)
3927     GD = GD.getWithDtorType(Dtor_Base);
3928 
3929   // The base destructor is equivalent to the base destructor of its
3930   // base class if there is exactly one non-virtual base class with a
3931   // non-trivial destructor, there are no fields with a non-trivial
3932   // destructor, and the body of the destructor is trivial.
3933   if (GD.getDtorType() == Dtor_Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
3934     return;
3935 
3936   llvm::Function *Fn = CGM.codegenCXXStructor(GD);
3937   if (Fn->isWeakForLinker())
3938     Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
3939 }
3940 
3941 llvm::Function *
3942 MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
3943                                          CXXCtorType CT) {
3944   assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
3945 
3946   // Calculate the mangled name.
3947   SmallString<256> ThunkName;
3948   llvm::raw_svector_ostream Out(ThunkName);
3949   getMangleContext().mangleName(GlobalDecl(CD, CT), Out);
3950 
3951   // If the thunk has been generated previously, just return it.
3952   if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
3953     return cast<llvm::Function>(GV);
3954 
3955   // Create the llvm::Function.
3956   const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT);
3957   llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
3958   const CXXRecordDecl *RD = CD->getParent();
3959   QualType RecordTy = getContext().getRecordType(RD);
3960   llvm::Function *ThunkFn = llvm::Function::Create(
3961       ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule());
3962   ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>(
3963       FnInfo.getEffectiveCallingConvention()));
3964   if (ThunkFn->isWeakForLinker())
3965     ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
3966   bool IsCopy = CT == Ctor_CopyingClosure;
3967 
3968   // Start codegen.
3969   CodeGenFunction CGF(CGM);
3970   CGF.CurGD = GlobalDecl(CD, Ctor_Complete);
3971 
3972   // Build FunctionArgs.
3973   FunctionArgList FunctionArgs;
3974 
3975   // A constructor always starts with a 'this' pointer as its first argument.
3976   buildThisParam(CGF, FunctionArgs);
3977 
3978   // Following the 'this' pointer is a reference to the source object that we
3979   // are copying from.
3980   ImplicitParamDecl SrcParam(
3981       getContext(), /*DC=*/nullptr, SourceLocation(),
3982       &getContext().Idents.get("src"),
3983       getContext().getLValueReferenceType(RecordTy,
3984                                           /*SpelledAsLValue=*/true),
3985       ImplicitParamDecl::Other);
3986   if (IsCopy)
3987     FunctionArgs.push_back(&SrcParam);
3988 
3989   // Constructors for classes which utilize virtual bases have an additional
3990   // parameter which indicates whether or not it is being delegated to by a more
3991   // derived constructor.
3992   ImplicitParamDecl IsMostDerived(getContext(), /*DC=*/nullptr,
3993                                   SourceLocation(),
3994                                   &getContext().Idents.get("is_most_derived"),
3995                                   getContext().IntTy, ImplicitParamDecl::Other);
3996   // Only add the parameter to the list if the class has virtual bases.
3997   if (RD->getNumVBases() > 0)
3998     FunctionArgs.push_back(&IsMostDerived);
3999 
4000   // Start defining the function.
4001   auto NL = ApplyDebugLocation::CreateEmpty(CGF);
4002   CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
4003                     FunctionArgs, CD->getLocation(), SourceLocation());
4004   // Create a scope with an artificial location for the body of this function.
4005   auto AL = ApplyDebugLocation::CreateArtificial(CGF);
4006   setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
4007   llvm::Value *This = getThisValue(CGF);
4008 
4009   llvm::Value *SrcVal =
4010       IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src")
4011              : nullptr;
4012 
4013   CallArgList Args;
4014 
4015   // Push the this ptr.
4016   Args.add(RValue::get(This), CD->getThisType());
4017 
4018   // Push the src ptr.
4019   if (SrcVal)
4020     Args.add(RValue::get(SrcVal), SrcParam.getType());
4021 
4022   // Add the rest of the default arguments.
4023   SmallVector<const Stmt *, 4> ArgVec;
4024   ArrayRef<ParmVarDecl *> params = CD->parameters().drop_front(IsCopy ? 1 : 0);
4025   for (const ParmVarDecl *PD : params) {
4026     assert(PD->hasDefaultArg() && "ctor closure lacks default args");
4027     ArgVec.push_back(PD->getDefaultArg());
4028   }
4029 
4030   CodeGenFunction::RunCleanupsScope Cleanups(CGF);
4031 
4032   const auto *FPT = CD->getType()->castAs<FunctionProtoType>();
4033   CGF.EmitCallArgs(Args, FPT, llvm::makeArrayRef(ArgVec), CD, IsCopy ? 1 : 0);
4034 
4035   // Insert any ABI-specific implicit constructor arguments.
4036   AddedStructorArgCounts ExtraArgs =
4037       addImplicitConstructorArgs(CGF, CD, Ctor_Complete,
4038                                  /*ForVirtualBase=*/false,
4039                                  /*Delegating=*/false, Args);
4040   // Call the destructor with our arguments.
4041   llvm::Constant *CalleePtr =
4042       CGM.getAddrOfCXXStructor(GlobalDecl(CD, Ctor_Complete));
4043   CGCallee Callee =
4044       CGCallee::forDirect(CalleePtr, GlobalDecl(CD, Ctor_Complete));
4045   const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall(
4046       Args, CD, Ctor_Complete, ExtraArgs.Prefix, ExtraArgs.Suffix);
4047   CGF.EmitCall(CalleeInfo, Callee, ReturnValueSlot(), Args);
4048 
4049   Cleanups.ForceCleanup();
4050 
4051   // Emit the ret instruction, remove any temporary instructions created for the
4052   // aid of CodeGen.
4053   CGF.FinishFunction(SourceLocation());
4054 
4055   return ThunkFn;
4056 }
4057 
4058 llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
4059                                                   uint32_t NVOffset,
4060                                                   int32_t VBPtrOffset,
4061                                                   uint32_t VBIndex) {
4062   assert(!T->isReferenceType());
4063 
4064   CXXRecordDecl *RD = T->getAsCXXRecordDecl();
4065   const CXXConstructorDecl *CD =
4066       RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
4067   CXXCtorType CT = Ctor_Complete;
4068   if (CD)
4069     if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1)
4070       CT = Ctor_CopyingClosure;
4071 
4072   uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
4073   SmallString<256> MangledName;
4074   {
4075     llvm::raw_svector_ostream Out(MangledName);
4076     getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset,
4077                                               VBPtrOffset, VBIndex, Out);
4078   }
4079   if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4080     return getImageRelativeConstant(GV);
4081 
4082   // The TypeDescriptor is used by the runtime to determine if a catch handler
4083   // is appropriate for the exception object.
4084   llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
4085 
4086   // The runtime is responsible for calling the copy constructor if the
4087   // exception is caught by value.
4088   llvm::Constant *CopyCtor;
4089   if (CD) {
4090     if (CT == Ctor_CopyingClosure)
4091       CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure);
4092     else
4093       CopyCtor = CGM.getAddrOfCXXStructor(GlobalDecl(CD, Ctor_Complete));
4094 
4095     CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy);
4096   } else {
4097     CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4098   }
4099   CopyCtor = getImageRelativeConstant(CopyCtor);
4100 
4101   bool IsScalar = !RD;
4102   bool HasVirtualBases = false;
4103   bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
4104   QualType PointeeType = T;
4105   if (T->isPointerType())
4106     PointeeType = T->getPointeeType();
4107   if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
4108     HasVirtualBases = RD->getNumVBases() > 0;
4109     if (IdentifierInfo *II = RD->getIdentifier())
4110       IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
4111   }
4112 
4113   // Encode the relevant CatchableType properties into the Flags bitfield.
4114   // FIXME: Figure out how bits 2 or 8 can get set.
4115   uint32_t Flags = 0;
4116   if (IsScalar)
4117     Flags |= 1;
4118   if (HasVirtualBases)
4119     Flags |= 4;
4120   if (IsStdBadAlloc)
4121     Flags |= 16;
4122 
4123   llvm::Constant *Fields[] = {
4124       llvm::ConstantInt::get(CGM.IntTy, Flags),       // Flags
4125       TD,                                             // TypeDescriptor
4126       llvm::ConstantInt::get(CGM.IntTy, NVOffset),    // NonVirtualAdjustment
4127       llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
4128       llvm::ConstantInt::get(CGM.IntTy, VBIndex),     // VBTableIndex
4129       llvm::ConstantInt::get(CGM.IntTy, Size),        // Size
4130       CopyCtor                                        // CopyCtor
4131   };
4132   llvm::StructType *CTType = getCatchableTypeType();
4133   auto *GV = new llvm::GlobalVariable(
4134       CGM.getModule(), CTType, /*isConstant=*/true, getLinkageForRTTI(T),
4135       llvm::ConstantStruct::get(CTType, Fields), MangledName);
4136   GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
4137   GV->setSection(".xdata");
4138   if (GV->isWeakForLinker())
4139     GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
4140   return getImageRelativeConstant(GV);
4141 }
4142 
4143 llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
4144   assert(!T->isReferenceType());
4145 
4146   // See if we've already generated a CatchableTypeArray for this type before.
4147   llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
4148   if (CTA)
4149     return CTA;
4150 
4151   // Ensure that we don't have duplicate entries in our CatchableTypeArray by
4152   // using a SmallSetVector.  Duplicates may arise due to virtual bases
4153   // occurring more than once in the hierarchy.
4154   llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
4155 
4156   // C++14 [except.handle]p3:
4157   //   A handler is a match for an exception object of type E if [...]
4158   //     - the handler is of type cv T or cv T& and T is an unambiguous public
4159   //       base class of E, or
4160   //     - the handler is of type cv T or const T& where T is a pointer type and
4161   //       E is a pointer type that can be converted to T by [...]
4162   //         - a standard pointer conversion (4.10) not involving conversions to
4163   //           pointers to private or protected or ambiguous classes
4164   const CXXRecordDecl *MostDerivedClass = nullptr;
4165   bool IsPointer = T->isPointerType();
4166   if (IsPointer)
4167     MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
4168   else
4169     MostDerivedClass = T->getAsCXXRecordDecl();
4170 
4171   // Collect all the unambiguous public bases of the MostDerivedClass.
4172   if (MostDerivedClass) {
4173     const ASTContext &Context = getContext();
4174     const ASTRecordLayout &MostDerivedLayout =
4175         Context.getASTRecordLayout(MostDerivedClass);
4176     MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
4177     SmallVector<MSRTTIClass, 8> Classes;
4178     serializeClassHierarchy(Classes, MostDerivedClass);
4179     Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
4180     detectAmbiguousBases(Classes);
4181     for (const MSRTTIClass &Class : Classes) {
4182       // Skip any ambiguous or private bases.
4183       if (Class.Flags &
4184           (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
4185         continue;
4186       // Write down how to convert from a derived pointer to a base pointer.
4187       uint32_t OffsetInVBTable = 0;
4188       int32_t VBPtrOffset = -1;
4189       if (Class.VirtualRoot) {
4190         OffsetInVBTable =
4191           VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
4192         VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
4193       }
4194 
4195       // Turn our record back into a pointer if the exception object is a
4196       // pointer.
4197       QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
4198       if (IsPointer)
4199         RTTITy = Context.getPointerType(RTTITy);
4200       CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
4201                                              VBPtrOffset, OffsetInVBTable));
4202     }
4203   }
4204 
4205   // C++14 [except.handle]p3:
4206   //   A handler is a match for an exception object of type E if
4207   //     - The handler is of type cv T or cv T& and E and T are the same type
4208   //       (ignoring the top-level cv-qualifiers)
4209   CatchableTypes.insert(getCatchableType(T));
4210 
4211   // C++14 [except.handle]p3:
4212   //   A handler is a match for an exception object of type E if
4213   //     - the handler is of type cv T or const T& where T is a pointer type and
4214   //       E is a pointer type that can be converted to T by [...]
4215   //         - a standard pointer conversion (4.10) not involving conversions to
4216   //           pointers to private or protected or ambiguous classes
4217   //
4218   // C++14 [conv.ptr]p2:
4219   //   A prvalue of type "pointer to cv T," where T is an object type, can be
4220   //   converted to a prvalue of type "pointer to cv void".
4221   if (IsPointer && T->getPointeeType()->isObjectType())
4222     CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4223 
4224   // C++14 [except.handle]p3:
4225   //   A handler is a match for an exception object of type E if [...]
4226   //     - the handler is of type cv T or const T& where T is a pointer or
4227   //       pointer to member type and E is std::nullptr_t.
4228   //
4229   // We cannot possibly list all possible pointer types here, making this
4230   // implementation incompatible with the standard.  However, MSVC includes an
4231   // entry for pointer-to-void in this case.  Let's do the same.
4232   if (T->isNullPtrType())
4233     CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4234 
4235   uint32_t NumEntries = CatchableTypes.size();
4236   llvm::Type *CTType =
4237       getImageRelativeType(getCatchableTypeType()->getPointerTo());
4238   llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
4239   llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
4240   llvm::Constant *Fields[] = {
4241       llvm::ConstantInt::get(CGM.IntTy, NumEntries),    // NumEntries
4242       llvm::ConstantArray::get(
4243           AT, llvm::makeArrayRef(CatchableTypes.begin(),
4244                                  CatchableTypes.end())) // CatchableTypes
4245   };
4246   SmallString<256> MangledName;
4247   {
4248     llvm::raw_svector_ostream Out(MangledName);
4249     getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
4250   }
4251   CTA = new llvm::GlobalVariable(
4252       CGM.getModule(), CTAType, /*isConstant=*/true, getLinkageForRTTI(T),
4253       llvm::ConstantStruct::get(CTAType, Fields), MangledName);
4254   CTA->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
4255   CTA->setSection(".xdata");
4256   if (CTA->isWeakForLinker())
4257     CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
4258   return CTA;
4259 }
4260 
4261 llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
4262   bool IsConst, IsVolatile, IsUnaligned;
4263   T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile, IsUnaligned);
4264 
4265   // The CatchableTypeArray enumerates the various (CV-unqualified) types that
4266   // the exception object may be caught as.
4267   llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
4268   // The first field in a CatchableTypeArray is the number of CatchableTypes.
4269   // This is used as a component of the mangled name which means that we need to
4270   // know what it is in order to see if we have previously generated the
4271   // ThrowInfo.
4272   uint32_t NumEntries =
4273       cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
4274           ->getLimitedValue();
4275 
4276   SmallString<256> MangledName;
4277   {
4278     llvm::raw_svector_ostream Out(MangledName);
4279     getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, IsUnaligned,
4280                                           NumEntries, Out);
4281   }
4282 
4283   // Reuse a previously generated ThrowInfo if we have generated an appropriate
4284   // one before.
4285   if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4286     return GV;
4287 
4288   // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
4289   // be at least as CV qualified.  Encode this requirement into the Flags
4290   // bitfield.
4291   uint32_t Flags = 0;
4292   if (IsConst)
4293     Flags |= 1;
4294   if (IsVolatile)
4295     Flags |= 2;
4296   if (IsUnaligned)
4297     Flags |= 4;
4298 
4299   // The cleanup-function (a destructor) must be called when the exception
4300   // object's lifetime ends.
4301   llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4302   if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
4303     if (CXXDestructorDecl *DtorD = RD->getDestructor())
4304       if (!DtorD->isTrivial())
4305         CleanupFn = llvm::ConstantExpr::getBitCast(
4306             CGM.getAddrOfCXXStructor(GlobalDecl(DtorD, Dtor_Complete)),
4307             CGM.Int8PtrTy);
4308   // This is unused as far as we can tell, initialize it to null.
4309   llvm::Constant *ForwardCompat =
4310       getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
4311   llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
4312       llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
4313   llvm::StructType *TIType = getThrowInfoType();
4314   llvm::Constant *Fields[] = {
4315       llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4316       getImageRelativeConstant(CleanupFn),      // CleanupFn
4317       ForwardCompat,                            // ForwardCompat
4318       PointerToCatchableTypes                   // CatchableTypeArray
4319   };
4320   auto *GV = new llvm::GlobalVariable(
4321       CGM.getModule(), TIType, /*isConstant=*/true, getLinkageForRTTI(T),
4322       llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
4323   GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
4324   GV->setSection(".xdata");
4325   if (GV->isWeakForLinker())
4326     GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
4327   return GV;
4328 }
4329 
4330 void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
4331   const Expr *SubExpr = E->getSubExpr();
4332   QualType ThrowType = SubExpr->getType();
4333   // The exception object lives on the stack and it's address is passed to the
4334   // runtime function.
4335   Address AI = CGF.CreateMemTemp(ThrowType);
4336   CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
4337                        /*IsInit=*/true);
4338 
4339   // The so-called ThrowInfo is used to describe how the exception object may be
4340   // caught.
4341   llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
4342 
4343   // Call into the runtime to throw the exception.
4344   llvm::Value *Args[] = {
4345     CGF.Builder.CreateBitCast(AI.getPointer(), CGM.Int8PtrTy),
4346     TI
4347   };
4348   CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
4349 }
4350 
4351 std::pair<llvm::Value *, const CXXRecordDecl *>
4352 MicrosoftCXXABI::LoadVTablePtr(CodeGenFunction &CGF, Address This,
4353                                const CXXRecordDecl *RD) {
4354   std::tie(This, std::ignore, RD) =
4355       performBaseAdjustment(CGF, This, QualType(RD->getTypeForDecl(), 0));
4356   return {CGF.GetVTablePtr(This, CGM.Int8PtrTy, RD), RD};
4357 }
4358