[MS] On x86_32, pass overaligned, non-copyable arguments indirectly
[lldb.git] / clang / lib / CodeGen / MicrosoftCXXABI.cpp
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   switch (CGM.getTarget().getTriple().getArch()) {
820   default:
821     // FIXME: Implement for other architectures.
822     return RAA_Default;
823
824   case llvm::Triple::thumb:
825     // Use the simple Itanium rules for now.
826     // FIXME: This is incompatible with MSVC for arguments with a dtor and no
827     // copy ctor.
828     return !RD->canPassInRegisters() ? RAA_Indirect : RAA_Default;
829
830   case llvm::Triple::x86: {
831     // If the argument has *required* alignment greater than four bytes, pass
832     // it indirectly. Prior to MSVC version 19.14, passing overaligned
833     // arguments was not supported and resulted in a compiler error. In 19.14
834     // and later versions, such arguments are now passed indirectly.
835     TypeInfo Info = getContext().getTypeInfo(RD->getTypeForDecl());
836     if (Info.AlignIsRequired && Info.Align > 4)
837       return RAA_Indirect;
838
839     // If C++ prohibits us from making a copy, construct the arguments directly
840     // into argument memory.
841     if (!RD->canPassInRegisters())
842       return RAA_DirectInMemory;
843
844     // Otherwise, construct the argument into a temporary and copy the bytes
845     // into the outgoing argument memory.
846     return RAA_Default;
847   }
848
849   case llvm::Triple::x86_64:
850   case llvm::Triple::aarch64:
851     return !RD->canPassInRegisters() ? RAA_Indirect : RAA_Default;
852   }
853
854   llvm_unreachable("invalid enum");
855 }
856
857 void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
858                                               const CXXDeleteExpr *DE,
859                                               Address Ptr,
860                                               QualType ElementType,
861                                               const CXXDestructorDecl *Dtor) {
862   // FIXME: Provide a source location here even though there's no
863   // CXXMemberCallExpr for dtor call.
864   bool UseGlobalDelete = DE->isGlobalDelete();
865   CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
866   llvm::Value *MDThis = EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, DE);
867   if (UseGlobalDelete)
868     CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType);
869 }
870
871 void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
872   llvm::Value *Args[] = {
873       llvm::ConstantPointerNull::get(CGM.Int8PtrTy),
874       llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())};
875   llvm::FunctionCallee Fn = getThrowFn();
876   if (isNoReturn)
877     CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args);
878   else
879     CGF.EmitRuntimeCallOrInvoke(Fn, Args);
880 }
881
882 void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF,
883                                      const CXXCatchStmt *S) {
884   // In the MS ABI, the runtime handles the copy, and the catch handler is
885   // responsible for destruction.
886   VarDecl *CatchParam = S->getExceptionDecl();
887   llvm::BasicBlock *CatchPadBB = CGF.Builder.GetInsertBlock();
888   llvm::CatchPadInst *CPI =
889       cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
890   CGF.CurrentFuncletPad = CPI;
891
892   // If this is a catch-all or the catch parameter is unnamed, we don't need to
893   // emit an alloca to the object.
894   if (!CatchParam || !CatchParam->getDeclName()) {
895     CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
896     return;
897   }
898
899   CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
900   CPI->setArgOperand(2, var.getObjectAddress(CGF).getPointer());
901   CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
902   CGF.EmitAutoVarCleanups(var);
903 }
904
905 /// We need to perform a generic polymorphic operation (like a typeid
906 /// or a cast), which requires an object with a vfptr.  Adjust the
907 /// address to point to an object with a vfptr.
908 std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
909 MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, Address Value,
910                                        QualType SrcRecordTy) {
911   Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
912   const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
913   const ASTContext &Context = getContext();
914
915   // If the class itself has a vfptr, great.  This check implicitly
916   // covers non-virtual base subobjects: a class with its own virtual
917   // functions would be a candidate to be a primary base.
918   if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
919     return std::make_tuple(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0),
920                            SrcDecl);
921
922   // Okay, one of the vbases must have a vfptr, or else this isn't
923   // actually a polymorphic class.
924   const CXXRecordDecl *PolymorphicBase = nullptr;
925   for (auto &Base : SrcDecl->vbases()) {
926     const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
927     if (Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr()) {
928       PolymorphicBase = BaseDecl;
929       break;
930     }
931   }
932   assert(PolymorphicBase && "polymorphic class has no apparent vfptr?");
933
934   llvm::Value *Offset =
935     GetVirtualBaseClassOffset(CGF, Value, SrcDecl, PolymorphicBase);
936   llvm::Value *Ptr = CGF.Builder.CreateInBoundsGEP(Value.getPointer(), Offset);
937   CharUnits VBaseAlign =
938     CGF.CGM.getVBaseAlignment(Value.getAlignment(), SrcDecl, PolymorphicBase);
939   return std::make_tuple(Address(Ptr, VBaseAlign), Offset, PolymorphicBase);
940 }
941
942 bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
943                                                 QualType SrcRecordTy) {
944   const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
945   return IsDeref &&
946          !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
947 }
948
949 static llvm::CallBase *emitRTtypeidCall(CodeGenFunction &CGF,
950                                         llvm::Value *Argument) {
951   llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
952   llvm::FunctionType *FTy =
953       llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
954   llvm::Value *Args[] = {Argument};
955   llvm::FunctionCallee Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
956   return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
957 }
958
959 void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
960   llvm::CallBase *Call =
961       emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
962   Call->setDoesNotReturn();
963   CGF.Builder.CreateUnreachable();
964 }
965
966 llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
967                                          QualType SrcRecordTy,
968                                          Address ThisPtr,
969                                          llvm::Type *StdTypeInfoPtrTy) {
970   std::tie(ThisPtr, std::ignore, std::ignore) =
971       performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
972   llvm::CallBase *Typeid = emitRTtypeidCall(CGF, ThisPtr.getPointer());
973   return CGF.Builder.CreateBitCast(Typeid, StdTypeInfoPtrTy);
974 }
975
976 bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
977                                                          QualType SrcRecordTy) {
978   const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
979   return SrcIsPtr &&
980          !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
981 }
982
983 llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
984     CodeGenFunction &CGF, Address This, QualType SrcRecordTy,
985     QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
986   llvm::Type *DestLTy = CGF.ConvertType(DestTy);
987
988   llvm::Value *SrcRTTI =
989       CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
990   llvm::Value *DestRTTI =
991       CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
992
993   llvm::Value *Offset;
994   std::tie(This, Offset, std::ignore) =
995       performBaseAdjustment(CGF, This, SrcRecordTy);
996   llvm::Value *ThisPtr = This.getPointer();
997   Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
998
999   // PVOID __RTDynamicCast(
1000   //   PVOID inptr,
1001   //   LONG VfDelta,
1002   //   PVOID SrcType,
1003   //   PVOID TargetType,
1004   //   BOOL isReference)
1005   llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
1006                             CGF.Int8PtrTy, CGF.Int32Ty};
1007   llvm::FunctionCallee Function = CGF.CGM.CreateRuntimeFunction(
1008       llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1009       "__RTDynamicCast");
1010   llvm::Value *Args[] = {
1011       ThisPtr, Offset, SrcRTTI, DestRTTI,
1012       llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
1013   ThisPtr = CGF.EmitRuntimeCallOrInvoke(Function, Args);
1014   return CGF.Builder.CreateBitCast(ThisPtr, DestLTy);
1015 }
1016
1017 llvm::Value *
1018 MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
1019                                        QualType SrcRecordTy,
1020                                        QualType DestTy) {
1021   std::tie(Value, std::ignore, std::ignore) =
1022       performBaseAdjustment(CGF, Value, SrcRecordTy);
1023
1024   // PVOID __RTCastToVoid(
1025   //   PVOID inptr)
1026   llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
1027   llvm::FunctionCallee Function = CGF.CGM.CreateRuntimeFunction(
1028       llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1029       "__RTCastToVoid");
1030   llvm::Value *Args[] = {Value.getPointer()};
1031   return CGF.EmitRuntimeCall(Function, Args);
1032 }
1033
1034 bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
1035   return false;
1036 }
1037
1038 llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
1039     CodeGenFunction &CGF, Address This, const CXXRecordDecl *ClassDecl,
1040     const CXXRecordDecl *BaseClassDecl) {
1041   const ASTContext &Context = getContext();
1042   int64_t VBPtrChars =
1043       Context.getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
1044   llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
1045   CharUnits IntSize = Context.getTypeSizeInChars(Context.IntTy);
1046   CharUnits VBTableChars =
1047       IntSize *
1048       CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
1049   llvm::Value *VBTableOffset =
1050       llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
1051
1052   llvm::Value *VBPtrToNewBase =
1053       GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
1054   VBPtrToNewBase =
1055       CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
1056   return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
1057 }
1058
1059 bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
1060   return isa<CXXConstructorDecl>(GD.getDecl());
1061 }
1062
1063 static bool isDeletingDtor(GlobalDecl GD) {
1064   return isa<CXXDestructorDecl>(GD.getDecl()) &&
1065          GD.getDtorType() == Dtor_Deleting;
1066 }
1067
1068 bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const {
1069   return isDeletingDtor(GD);
1070 }
1071
1072 static bool IsSizeGreaterThan128(const CXXRecordDecl *RD) {
1073   return RD->getASTContext().getTypeSize(RD->getTypeForDecl()) > 128;
1074 }
1075
1076 static bool hasMicrosoftABIRestrictions(const CXXRecordDecl *RD) {
1077   // For AArch64, we use the C++14 definition of an aggregate, so we also
1078   // check for:
1079   //   No private or protected non static data members.
1080   //   No base classes
1081   //   No virtual functions
1082   // Additionally, we need to ensure that there is a trivial copy assignment
1083   // operator, a trivial destructor and no user-provided constructors.
1084   if (RD->hasProtectedFields() || RD->hasPrivateFields())
1085     return true;
1086   if (RD->getNumBases() > 0)
1087     return true;
1088   if (RD->isPolymorphic())
1089     return true;
1090   if (RD->hasNonTrivialCopyAssignment())
1091     return true;
1092   for (const CXXConstructorDecl *Ctor : RD->ctors())
1093     if (Ctor->isUserProvided())
1094       return true;
1095   if (RD->hasNonTrivialDestructor())
1096     return true;
1097   return false;
1098 }
1099
1100 bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
1101   const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
1102   if (!RD)
1103     return false;
1104
1105   bool isAArch64 = CGM.getTarget().getTriple().isAArch64();
1106   bool isSimple = !isAArch64 || !hasMicrosoftABIRestrictions(RD);
1107   bool isIndirectReturn =
1108       isAArch64 ? (!RD->canPassInRegisters() ||
1109                    IsSizeGreaterThan128(RD))
1110                 : !RD->isPOD();
1111   bool isInstanceMethod = FI.isInstanceMethod();
1112
1113   if (isIndirectReturn || !isSimple || isInstanceMethod) {
1114     CharUnits Align = CGM.getContext().getTypeAlignInChars(FI.getReturnType());
1115     FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
1116     FI.getReturnInfo().setSRetAfterThis(isInstanceMethod);
1117
1118     FI.getReturnInfo().setInReg(isAArch64 &&
1119                                 !(isSimple && IsSizeGreaterThan128(RD)));
1120
1121     return true;
1122   }
1123
1124   // Otherwise, use the C ABI rules.
1125   return false;
1126 }
1127
1128 llvm::BasicBlock *
1129 MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
1130                                                const CXXRecordDecl *RD) {
1131   llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1132   assert(IsMostDerivedClass &&
1133          "ctor for a class with virtual bases must have an implicit parameter");
1134   llvm::Value *IsCompleteObject =
1135     CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
1136
1137   llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
1138   llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
1139   CGF.Builder.CreateCondBr(IsCompleteObject,
1140                            CallVbaseCtorsBB, SkipVbaseCtorsBB);
1141
1142   CGF.EmitBlock(CallVbaseCtorsBB);
1143
1144   // Fill in the vbtable pointers here.
1145   EmitVBPtrStores(CGF, RD);
1146
1147   // CGF will put the base ctor calls in this basic block for us later.
1148
1149   return SkipVbaseCtorsBB;
1150 }
1151
1152 llvm::BasicBlock *
1153 MicrosoftCXXABI::EmitDtorCompleteObjectHandler(CodeGenFunction &CGF) {
1154   llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1155   assert(IsMostDerivedClass &&
1156          "ctor for a class with virtual bases must have an implicit parameter");
1157   llvm::Value *IsCompleteObject =
1158       CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
1159
1160   llvm::BasicBlock *CallVbaseDtorsBB = CGF.createBasicBlock("Dtor.dtor_vbases");
1161   llvm::BasicBlock *SkipVbaseDtorsBB = CGF.createBasicBlock("Dtor.skip_vbases");
1162   CGF.Builder.CreateCondBr(IsCompleteObject,
1163                            CallVbaseDtorsBB, SkipVbaseDtorsBB);
1164
1165   CGF.EmitBlock(CallVbaseDtorsBB);
1166   // CGF will put the base dtor calls in this basic block for us later.
1167
1168   return SkipVbaseDtorsBB;
1169 }
1170
1171 void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
1172     CodeGenFunction &CGF, const CXXRecordDecl *RD) {
1173   // In most cases, an override for a vbase virtual method can adjust
1174   // the "this" parameter by applying a constant offset.
1175   // However, this is not enough while a constructor or a destructor of some
1176   // class X is being executed if all the following conditions are met:
1177   //  - X has virtual bases, (1)
1178   //  - X overrides a virtual method M of a vbase Y, (2)
1179   //  - X itself is a vbase of the most derived class.
1180   //
1181   // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
1182   // which holds the extra amount of "this" adjustment we must do when we use
1183   // the X vftables (i.e. during X ctor or dtor).
1184   // Outside the ctors and dtors, the values of vtorDisps are zero.
1185
1186   const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
1187   typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
1188   const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
1189   CGBuilderTy &Builder = CGF.Builder;
1190
1191   unsigned AS = getThisAddress(CGF).getAddressSpace();
1192   llvm::Value *Int8This = nullptr;  // Initialize lazily.
1193
1194   for (const CXXBaseSpecifier &S : RD->vbases()) {
1195     const CXXRecordDecl *VBase = S.getType()->getAsCXXRecordDecl();
1196     auto I = VBaseMap.find(VBase);
1197     assert(I != VBaseMap.end());
1198     if (!I->second.hasVtorDisp())
1199       continue;
1200
1201     llvm::Value *VBaseOffset =
1202         GetVirtualBaseClassOffset(CGF, getThisAddress(CGF), RD, VBase);
1203     uint64_t ConstantVBaseOffset = I->second.VBaseOffset.getQuantity();
1204
1205     // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
1206     llvm::Value *VtorDispValue = Builder.CreateSub(
1207         VBaseOffset, llvm::ConstantInt::get(CGM.PtrDiffTy, ConstantVBaseOffset),
1208         "vtordisp.value");
1209     VtorDispValue = Builder.CreateTruncOrBitCast(VtorDispValue, CGF.Int32Ty);
1210
1211     if (!Int8This)
1212       Int8This = Builder.CreateBitCast(getThisValue(CGF),
1213                                        CGF.Int8Ty->getPointerTo(AS));
1214     llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
1215     // vtorDisp is always the 32-bits before the vbase in the class layout.
1216     VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
1217     VtorDispPtr = Builder.CreateBitCast(
1218         VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
1219
1220     Builder.CreateAlignedStore(VtorDispValue, VtorDispPtr,
1221                                CharUnits::fromQuantity(4));
1222   }
1223 }
1224
1225 static bool hasDefaultCXXMethodCC(ASTContext &Context,
1226                                   const CXXMethodDecl *MD) {
1227   CallingConv ExpectedCallingConv = Context.getDefaultCallingConvention(
1228       /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1229   CallingConv ActualCallingConv =
1230       MD->getType()->castAs<FunctionProtoType>()->getCallConv();
1231   return ExpectedCallingConv == ActualCallingConv;
1232 }
1233
1234 void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1235   // There's only one constructor type in this ABI.
1236   CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
1237
1238   // Exported default constructors either have a simple call-site where they use
1239   // the typical calling convention and have a single 'this' pointer for an
1240   // argument -or- they get a wrapper function which appropriately thunks to the
1241   // real default constructor.  This thunk is the default constructor closure.
1242   if (D->hasAttr<DLLExportAttr>() && D->isDefaultConstructor())
1243     if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) {
1244       llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure);
1245       Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage);
1246       CGM.setGVProperties(Fn, D);
1247     }
1248 }
1249
1250 void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1251                                       const CXXRecordDecl *RD) {
1252   Address This = getThisAddress(CGF);
1253   This = CGF.Builder.CreateElementBitCast(This, CGM.Int8Ty, "this.int8");
1254   const ASTContext &Context = getContext();
1255   const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1256
1257   const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1258   for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
1259     const std::unique_ptr<VPtrInfo> &VBT = (*VBGlobals.VBTables)[I];
1260     llvm::GlobalVariable *GV = VBGlobals.Globals[I];
1261     const ASTRecordLayout &SubobjectLayout =
1262         Context.getASTRecordLayout(VBT->IntroducingObject);
1263     CharUnits Offs = VBT->NonVirtualOffset;
1264     Offs += SubobjectLayout.getVBPtrOffset();
1265     if (VBT->getVBaseWithVPtr())
1266       Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
1267     Address VBPtr = CGF.Builder.CreateConstInBoundsByteGEP(This, Offs);
1268     llvm::Value *GVPtr =
1269         CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0);
1270     VBPtr = CGF.Builder.CreateElementBitCast(VBPtr, GVPtr->getType(),
1271                                       "vbptr." + VBT->ObjectWithVPtr->getName());
1272     CGF.Builder.CreateStore(GVPtr, VBPtr);
1273   }
1274 }
1275
1276 CGCXXABI::AddedStructorArgCounts
1277 MicrosoftCXXABI::buildStructorSignature(GlobalDecl GD,
1278                                         SmallVectorImpl<CanQualType> &ArgTys) {
1279   AddedStructorArgCounts Added;
1280   // TODO: 'for base' flag
1281   if (isa<CXXDestructorDecl>(GD.getDecl()) &&
1282       GD.getDtorType() == Dtor_Deleting) {
1283     // The scalar deleting destructor takes an implicit int parameter.
1284     ArgTys.push_back(getContext().IntTy);
1285     ++Added.Suffix;
1286   }
1287   auto *CD = dyn_cast<CXXConstructorDecl>(GD.getDecl());
1288   if (!CD)
1289     return Added;
1290
1291   // All parameters are already in place except is_most_derived, which goes
1292   // after 'this' if it's variadic and last if it's not.
1293
1294   const CXXRecordDecl *Class = CD->getParent();
1295   const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1296   if (Class->getNumVBases()) {
1297     if (FPT->isVariadic()) {
1298       ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
1299       ++Added.Prefix;
1300     } else {
1301       ArgTys.push_back(getContext().IntTy);
1302       ++Added.Suffix;
1303     }
1304   }
1305
1306   return Added;
1307 }
1308
1309 void MicrosoftCXXABI::setCXXDestructorDLLStorage(llvm::GlobalValue *GV,
1310                                                  const CXXDestructorDecl *Dtor,
1311                                                  CXXDtorType DT) const {
1312   // Deleting destructor variants are never imported or exported. Give them the
1313   // default storage class.
1314   if (DT == Dtor_Deleting) {
1315     GV->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
1316   } else {
1317     const NamedDecl *ND = Dtor;
1318     CGM.setDLLImportDLLExport(GV, ND);
1319   }
1320 }
1321
1322 llvm::GlobalValue::LinkageTypes MicrosoftCXXABI::getCXXDestructorLinkage(
1323     GVALinkage Linkage, const CXXDestructorDecl *Dtor, CXXDtorType DT) const {
1324   // Internal things are always internal, regardless of attributes. After this,
1325   // we know the thunk is externally visible.
1326   if (Linkage == GVA_Internal)
1327     return llvm::GlobalValue::InternalLinkage;
1328
1329   switch (DT) {
1330   case Dtor_Base:
1331     // The base destructor most closely tracks the user-declared constructor, so
1332     // we delegate back to the normal declarator case.
1333     return CGM.getLLVMLinkageForDeclarator(Dtor, Linkage,
1334                                            /*IsConstantVariable=*/false);
1335   case Dtor_Complete:
1336     // The complete destructor is like an inline function, but it may be
1337     // imported and therefore must be exported as well. This requires changing
1338     // the linkage if a DLL attribute is present.
1339     if (Dtor->hasAttr<DLLExportAttr>())
1340       return llvm::GlobalValue::WeakODRLinkage;
1341     if (Dtor->hasAttr<DLLImportAttr>())
1342       return llvm::GlobalValue::AvailableExternallyLinkage;
1343     return llvm::GlobalValue::LinkOnceODRLinkage;
1344   case Dtor_Deleting:
1345     // Deleting destructors are like inline functions. They have vague linkage
1346     // and are emitted everywhere they are used. They are internal if the class
1347     // is internal.
1348     return llvm::GlobalValue::LinkOnceODRLinkage;
1349   case Dtor_Comdat:
1350     llvm_unreachable("MS C++ ABI does not support comdat dtors");
1351   }
1352   llvm_unreachable("invalid dtor type");
1353 }
1354
1355 void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1356   // The TU defining a dtor is only guaranteed to emit a base destructor.  All
1357   // other destructor variants are delegating thunks.
1358   CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1359
1360   // If the class is dllexported, emit the complete (vbase) destructor wherever
1361   // the base dtor is emitted.
1362   // FIXME: To match MSVC, this should only be done when the class is exported
1363   // with -fdllexport-inlines enabled.
1364   if (D->getParent()->getNumVBases() > 0 && D->hasAttr<DLLExportAttr>())
1365     CGM.EmitGlobal(GlobalDecl(D, Dtor_Complete));
1366 }
1367
1368 CharUnits
1369 MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
1370   const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
1371
1372   if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1373     // Complete destructors take a pointer to the complete object as a
1374     // parameter, thus don't need this adjustment.
1375     if (GD.getDtorType() == Dtor_Complete)
1376       return CharUnits();
1377
1378     // There's no Dtor_Base in vftable but it shares the this adjustment with
1379     // the deleting one, so look it up instead.
1380     GD = GlobalDecl(DD, Dtor_Deleting);
1381   }
1382
1383   MethodVFTableLocation ML =
1384       CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1385   CharUnits Adjustment = ML.VFPtrOffset;
1386
1387   // Normal virtual instance methods need to adjust from the vfptr that first
1388   // defined the virtual method to the virtual base subobject, but destructors
1389   // do not.  The vector deleting destructor thunk applies this adjustment for
1390   // us if necessary.
1391   if (isa<CXXDestructorDecl>(MD))
1392     Adjustment = CharUnits::Zero();
1393
1394   if (ML.VBase) {
1395     const ASTRecordLayout &DerivedLayout =
1396         getContext().getASTRecordLayout(MD->getParent());
1397     Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1398   }
1399
1400   return Adjustment;
1401 }
1402
1403 Address MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1404     CodeGenFunction &CGF, GlobalDecl GD, Address This,
1405     bool VirtualCall) {
1406   if (!VirtualCall) {
1407     // If the call of a virtual function is not virtual, we just have to
1408     // compensate for the adjustment the virtual function does in its prologue.
1409     CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1410     if (Adjustment.isZero())
1411       return This;
1412
1413     This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
1414     assert(Adjustment.isPositive());
1415     return CGF.Builder.CreateConstByteGEP(This, Adjustment);
1416   }
1417
1418   const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
1419
1420   GlobalDecl LookupGD = GD;
1421   if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1422     // Complete dtors take a pointer to the complete object,
1423     // thus don't need adjustment.
1424     if (GD.getDtorType() == Dtor_Complete)
1425       return This;
1426
1427     // There's only Dtor_Deleting in vftable but it shares the this adjustment
1428     // with the base one, so look up the deleting one instead.
1429     LookupGD = GlobalDecl(DD, Dtor_Deleting);
1430   }
1431   MethodVFTableLocation ML =
1432       CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
1433
1434   CharUnits StaticOffset = ML.VFPtrOffset;
1435
1436   // Base destructors expect 'this' to point to the beginning of the base
1437   // subobject, not the first vfptr that happens to contain the virtual dtor.
1438   // However, we still need to apply the virtual base adjustment.
1439   if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1440     StaticOffset = CharUnits::Zero();
1441
1442   Address Result = This;
1443   if (ML.VBase) {
1444     Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
1445
1446     const CXXRecordDecl *Derived = MD->getParent();
1447     const CXXRecordDecl *VBase = ML.VBase;
1448     llvm::Value *VBaseOffset =
1449       GetVirtualBaseClassOffset(CGF, Result, Derived, VBase);
1450     llvm::Value *VBasePtr =
1451       CGF.Builder.CreateInBoundsGEP(Result.getPointer(), VBaseOffset);
1452     CharUnits VBaseAlign =
1453       CGF.CGM.getVBaseAlignment(Result.getAlignment(), Derived, VBase);
1454     Result = Address(VBasePtr, VBaseAlign);
1455   }
1456   if (!StaticOffset.isZero()) {
1457     assert(StaticOffset.isPositive());
1458     Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
1459     if (ML.VBase) {
1460       // Non-virtual adjustment might result in a pointer outside the allocated
1461       // object, e.g. if the final overrider class is laid out after the virtual
1462       // base that declares a method in the most derived class.
1463       // FIXME: Update the code that emits this adjustment in thunks prologues.
1464       Result = CGF.Builder.CreateConstByteGEP(Result, StaticOffset);
1465     } else {
1466       Result = CGF.Builder.CreateConstInBoundsByteGEP(Result, StaticOffset);
1467     }
1468   }
1469   return Result;
1470 }
1471
1472 void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1473                                                 QualType &ResTy,
1474                                                 FunctionArgList &Params) {
1475   ASTContext &Context = getContext();
1476   const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1477   assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
1478   if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1479     auto *IsMostDerived = ImplicitParamDecl::Create(
1480         Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1481         &Context.Idents.get("is_most_derived"), Context.IntTy,
1482         ImplicitParamDecl::Other);
1483     // The 'most_derived' parameter goes second if the ctor is variadic and last
1484     // if it's not.  Dtors can't be variadic.
1485     const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1486     if (FPT->isVariadic())
1487       Params.insert(Params.begin() + 1, IsMostDerived);
1488     else
1489       Params.push_back(IsMostDerived);
1490     getStructorImplicitParamDecl(CGF) = IsMostDerived;
1491   } else if (isDeletingDtor(CGF.CurGD)) {
1492     auto *ShouldDelete = ImplicitParamDecl::Create(
1493         Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1494         &Context.Idents.get("should_call_delete"), Context.IntTy,
1495         ImplicitParamDecl::Other);
1496     Params.push_back(ShouldDelete);
1497     getStructorImplicitParamDecl(CGF) = ShouldDelete;
1498   }
1499 }
1500
1501 void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
1502   // Naked functions have no prolog.
1503   if (CGF.CurFuncDecl && CGF.CurFuncDecl->hasAttr<NakedAttr>())
1504     return;
1505
1506   // Overridden virtual methods of non-primary bases need to adjust the incoming
1507   // 'this' pointer in the prologue. In this hierarchy, C::b will subtract
1508   // sizeof(void*) to adjust from B* to C*:
1509   //   struct A { virtual void a(); };
1510   //   struct B { virtual void b(); };
1511   //   struct C : A, B { virtual void b(); };
1512   //
1513   // Leave the value stored in the 'this' alloca unadjusted, so that the
1514   // debugger sees the unadjusted value. Microsoft debuggers require this, and
1515   // will apply the ThisAdjustment in the method type information.
1516   // FIXME: Do something better for DWARF debuggers, which won't expect this,
1517   // without making our codegen depend on debug info settings.
1518   llvm::Value *This = loadIncomingCXXThis(CGF);
1519   const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1520   if (!CGF.CurFuncIsThunk && MD->isVirtual()) {
1521     CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(CGF.CurGD);
1522     if (!Adjustment.isZero()) {
1523       unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1524       llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1525                  *thisTy = This->getType();
1526       This = CGF.Builder.CreateBitCast(This, charPtrTy);
1527       assert(Adjustment.isPositive());
1528       This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
1529                                                     -Adjustment.getQuantity());
1530       This = CGF.Builder.CreateBitCast(This, thisTy, "this.adjusted");
1531     }
1532   }
1533   setCXXABIThisValue(CGF, This);
1534
1535   // If this is a function that the ABI specifies returns 'this', initialize
1536   // the return slot to 'this' at the start of the function.
1537   //
1538   // Unlike the setting of return types, this is done within the ABI
1539   // implementation instead of by clients of CGCXXABI because:
1540   // 1) getThisValue is currently protected
1541   // 2) in theory, an ABI could implement 'this' returns some other way;
1542   //    HasThisReturn only specifies a contract, not the implementation
1543   if (HasThisReturn(CGF.CurGD))
1544     CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
1545   else if (hasMostDerivedReturn(CGF.CurGD))
1546     CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1547                             CGF.ReturnValue);
1548
1549   if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1550     assert(getStructorImplicitParamDecl(CGF) &&
1551            "no implicit parameter for a constructor with virtual bases?");
1552     getStructorImplicitParamValue(CGF)
1553       = CGF.Builder.CreateLoad(
1554           CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1555           "is_most_derived");
1556   }
1557
1558   if (isDeletingDtor(CGF.CurGD)) {
1559     assert(getStructorImplicitParamDecl(CGF) &&
1560            "no implicit parameter for a deleting destructor?");
1561     getStructorImplicitParamValue(CGF)
1562       = CGF.Builder.CreateLoad(
1563           CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1564           "should_call_delete");
1565   }
1566 }
1567
1568 CGCXXABI::AddedStructorArgs MicrosoftCXXABI::getImplicitConstructorArgs(
1569     CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1570     bool ForVirtualBase, bool Delegating) {
1571   assert(Type == Ctor_Complete || Type == Ctor_Base);
1572
1573   // Check if we need a 'most_derived' parameter.
1574   if (!D->getParent()->getNumVBases())
1575     return AddedStructorArgs{};
1576
1577   // Add the 'most_derived' argument second if we are variadic or last if not.
1578   const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
1579   llvm::Value *MostDerivedArg;
1580   if (Delegating) {
1581     MostDerivedArg = getStructorImplicitParamValue(CGF);
1582   } else {
1583     MostDerivedArg = llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
1584   }
1585   if (FPT->isVariadic()) {
1586     return AddedStructorArgs::prefix({{MostDerivedArg, getContext().IntTy}});
1587   }
1588   return AddedStructorArgs::suffix({{MostDerivedArg, getContext().IntTy}});
1589 }
1590
1591 llvm::Value *MicrosoftCXXABI::getCXXDestructorImplicitParam(
1592     CodeGenFunction &CGF, const CXXDestructorDecl *DD, CXXDtorType Type,
1593     bool ForVirtualBase, bool Delegating) {
1594   return nullptr;
1595 }
1596
1597 void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1598                                          const CXXDestructorDecl *DD,
1599                                          CXXDtorType Type, bool ForVirtualBase,
1600                                          bool Delegating, Address This,
1601                                          QualType ThisTy) {
1602   // Use the base destructor variant in place of the complete destructor variant
1603   // if the class has no virtual bases. This effectively implements some of the
1604   // -mconstructor-aliases optimization, but as part of the MS C++ ABI.
1605   if (Type == Dtor_Complete && DD->getParent()->getNumVBases() == 0)
1606     Type = Dtor_Base;
1607
1608   GlobalDecl GD(DD, Type);
1609   CGCallee Callee = CGCallee::forDirect(CGM.getAddrOfCXXStructor(GD), GD);
1610
1611   if (DD->isVirtual()) {
1612     assert(Type != CXXDtorType::Dtor_Deleting &&
1613            "The deleting destructor should only be called via a virtual call");
1614     This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1615                                                     This, false);
1616   }
1617
1618   llvm::BasicBlock *BaseDtorEndBB = nullptr;
1619   if (ForVirtualBase && isa<CXXConstructorDecl>(CGF.CurCodeDecl)) {
1620     BaseDtorEndBB = EmitDtorCompleteObjectHandler(CGF);
1621   }
1622
1623   llvm::Value *Implicit =
1624       getCXXDestructorImplicitParam(CGF, DD, Type, ForVirtualBase,
1625                                     Delegating); // = nullptr
1626   CGF.EmitCXXDestructorCall(GD, Callee, This.getPointer(), ThisTy,
1627                             /*ImplicitParam=*/Implicit,
1628                             /*ImplicitParamTy=*/QualType(), nullptr);
1629   if (BaseDtorEndBB) {
1630     // Complete object handler should continue to be the remaining
1631     CGF.Builder.CreateBr(BaseDtorEndBB);
1632     CGF.EmitBlock(BaseDtorEndBB);
1633   }
1634 }
1635
1636 void MicrosoftCXXABI::emitVTableTypeMetadata(const VPtrInfo &Info,
1637                                              const CXXRecordDecl *RD,
1638                                              llvm::GlobalVariable *VTable) {
1639   if (!CGM.getCodeGenOpts().LTOUnit)
1640     return;
1641
1642   // TODO: Should VirtualFunctionElimination also be supported here?
1643   // See similar handling in CodeGenModule::EmitVTableTypeMetadata.
1644   if (CGM.getCodeGenOpts().WholeProgramVTables) {
1645     llvm::GlobalObject::VCallVisibility TypeVis =
1646         CGM.GetVCallVisibilityLevel(RD);
1647     if (TypeVis != llvm::GlobalObject::VCallVisibilityPublic)
1648       VTable->setVCallVisibilityMetadata(TypeVis);
1649   }
1650
1651   // The location of the first virtual function pointer in the virtual table,
1652   // aka the "address point" on Itanium. This is at offset 0 if RTTI is
1653   // disabled, or sizeof(void*) if RTTI is enabled.
1654   CharUnits AddressPoint =
1655       getContext().getLangOpts().RTTIData
1656           ? getContext().toCharUnitsFromBits(
1657                 getContext().getTargetInfo().getPointerWidth(0))
1658           : CharUnits::Zero();
1659
1660   if (Info.PathToIntroducingObject.empty()) {
1661     CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
1662     return;
1663   }
1664
1665   // Add a bitset entry for the least derived base belonging to this vftable.
1666   CGM.AddVTableTypeMetadata(VTable, AddressPoint,
1667                             Info.PathToIntroducingObject.back());
1668
1669   // Add a bitset entry for each derived class that is laid out at the same
1670   // offset as the least derived base.
1671   for (unsigned I = Info.PathToIntroducingObject.size() - 1; I != 0; --I) {
1672     const CXXRecordDecl *DerivedRD = Info.PathToIntroducingObject[I - 1];
1673     const CXXRecordDecl *BaseRD = Info.PathToIntroducingObject[I];
1674
1675     const ASTRecordLayout &Layout =
1676         getContext().getASTRecordLayout(DerivedRD);
1677     CharUnits Offset;
1678     auto VBI = Layout.getVBaseOffsetsMap().find(BaseRD);
1679     if (VBI == Layout.getVBaseOffsetsMap().end())
1680       Offset = Layout.getBaseClassOffset(BaseRD);
1681     else
1682       Offset = VBI->second.VBaseOffset;
1683     if (!Offset.isZero())
1684       return;
1685     CGM.AddVTableTypeMetadata(VTable, AddressPoint, DerivedRD);
1686   }
1687
1688   // Finally do the same for the most derived class.
1689   if (Info.FullOffsetInMDC.isZero())
1690     CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
1691 }
1692
1693 void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1694                                             const CXXRecordDecl *RD) {
1695   MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
1696   const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
1697
1698   for (const std::unique_ptr<VPtrInfo>& Info : VFPtrs) {
1699     llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
1700     if (VTable->hasInitializer())
1701       continue;
1702
1703     const VTableLayout &VTLayout =
1704       VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
1705
1706     llvm::Constant *RTTI = nullptr;
1707     if (any_of(VTLayout.vtable_components(),
1708                [](const VTableComponent &VTC) { return VTC.isRTTIKind(); }))
1709       RTTI = getMSCompleteObjectLocator(RD, *Info);
1710
1711     ConstantInitBuilder builder(CGM);
1712     auto components = builder.beginStruct();
1713     CGVT.createVTableInitializer(components, VTLayout, RTTI,
1714                                  VTable->hasLocalLinkage());
1715     components.finishAndSetAsInitializer(VTable);
1716
1717     emitVTableTypeMetadata(*Info, RD, VTable);
1718   }
1719 }
1720
1721 bool MicrosoftCXXABI::isVirtualOffsetNeededForVTableField(
1722     CodeGenFunction &CGF, CodeGenFunction::VPtr Vptr) {
1723   return Vptr.NearestVBase != nullptr;
1724 }
1725
1726 llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1727     CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
1728     const CXXRecordDecl *NearestVBase) {
1729   llvm::Constant *VTableAddressPoint = getVTableAddressPoint(Base, VTableClass);
1730   if (!VTableAddressPoint) {
1731     assert(Base.getBase()->getNumVBases() &&
1732            !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
1733   }
1734   return VTableAddressPoint;
1735 }
1736
1737 static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
1738                               const CXXRecordDecl *RD, const VPtrInfo &VFPtr,
1739                               SmallString<256> &Name) {
1740   llvm::raw_svector_ostream Out(Name);
1741   MangleContext.mangleCXXVFTable(RD, VFPtr.MangledPath, Out);
1742 }
1743
1744 llvm::Constant *
1745 MicrosoftCXXABI::getVTableAddressPoint(BaseSubobject Base,
1746                                        const CXXRecordDecl *VTableClass) {
1747   (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1748   VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1749   return VFTablesMap[ID];
1750 }
1751
1752 llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1753     BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1754   llvm::Constant *VFTable = getVTableAddressPoint(Base, VTableClass);
1755   assert(VFTable && "Couldn't find a vftable for the given base?");
1756   return VFTable;
1757 }
1758
1759 llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1760                                                        CharUnits VPtrOffset) {
1761   // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1762   // shouldn't be used in the given record type. We want to cache this result in
1763   // VFTablesMap, thus a simple zero check is not sufficient.
1764
1765   VFTableIdTy ID(RD, VPtrOffset);
1766   VTablesMapTy::iterator I;
1767   bool Inserted;
1768   std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
1769   if (!Inserted)
1770     return I->second;
1771
1772   llvm::GlobalVariable *&VTable = I->second;
1773
1774   MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
1775   const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
1776
1777   if (DeferredVFTables.insert(RD).second) {
1778     // We haven't processed this record type before.
1779     // Queue up this vtable for possible deferred emission.
1780     CGM.addDeferredVTable(RD);
1781
1782 #ifndef NDEBUG
1783     // Create all the vftables at once in order to make sure each vftable has
1784     // a unique mangled name.
1785     llvm::StringSet<> ObservedMangledNames;
1786     for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1787       SmallString<256> Name;
1788       mangleVFTableName(getMangleContext(), RD, *VFPtrs[J], Name);
1789       if (!ObservedMangledNames.insert(Name.str()).second)
1790         llvm_unreachable("Already saw this mangling before?");
1791     }
1792 #endif
1793   }
1794
1795   const std::unique_ptr<VPtrInfo> *VFPtrI = std::find_if(
1796       VFPtrs.begin(), VFPtrs.end(), [&](const std::unique_ptr<VPtrInfo>& VPI) {
1797         return VPI->FullOffsetInMDC == VPtrOffset;
1798       });
1799   if (VFPtrI == VFPtrs.end()) {
1800     VFTablesMap[ID] = nullptr;
1801     return nullptr;
1802   }
1803   const std::unique_ptr<VPtrInfo> &VFPtr = *VFPtrI;
1804
1805   SmallString<256> VFTableName;
1806   mangleVFTableName(getMangleContext(), RD, *VFPtr, VFTableName);
1807
1808   // Classes marked __declspec(dllimport) need vftables generated on the
1809   // import-side in order to support features like constexpr.  No other
1810   // translation unit relies on the emission of the local vftable, translation
1811   // units are expected to generate them as needed.
1812   //
1813   // Because of this unique behavior, we maintain this logic here instead of
1814   // getVTableLinkage.
1815   llvm::GlobalValue::LinkageTypes VFTableLinkage =
1816       RD->hasAttr<DLLImportAttr>() ? llvm::GlobalValue::LinkOnceODRLinkage
1817                                    : CGM.getVTableLinkage(RD);
1818   bool VFTableComesFromAnotherTU =
1819       llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) ||
1820       llvm::GlobalValue::isExternalLinkage(VFTableLinkage);
1821   bool VTableAliasIsRequred =
1822       !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData;
1823
1824   if (llvm::GlobalValue *VFTable =
1825           CGM.getModule().getNamedGlobal(VFTableName)) {
1826     VFTablesMap[ID] = VFTable;
1827     VTable = VTableAliasIsRequred
1828                  ? cast<llvm::GlobalVariable>(
1829                        cast<llvm::GlobalAlias>(VFTable)->getBaseObject())
1830                  : cast<llvm::GlobalVariable>(VFTable);
1831     return VTable;
1832   }
1833
1834   const VTableLayout &VTLayout =
1835       VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC);
1836   llvm::GlobalValue::LinkageTypes VTableLinkage =
1837       VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage;
1838
1839   StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str();
1840
1841   llvm::Type *VTableType = CGM.getVTables().getVTableType(VTLayout);
1842
1843   // Create a backing variable for the contents of VTable.  The VTable may
1844   // or may not include space for a pointer to RTTI data.
1845   llvm::GlobalValue *VFTable;
1846   VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType,
1847                                     /*isConstant=*/true, VTableLinkage,
1848                                     /*Initializer=*/nullptr, VTableName);
1849   VTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1850
1851   llvm::Comdat *C = nullptr;
1852   if (!VFTableComesFromAnotherTU &&
1853       (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) ||
1854        (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) &&
1855         VTableAliasIsRequred)))
1856     C = CGM.getModule().getOrInsertComdat(VFTableName.str());
1857
1858   // Only insert a pointer into the VFTable for RTTI data if we are not
1859   // importing it.  We never reference the RTTI data directly so there is no
1860   // need to make room for it.
1861   if (VTableAliasIsRequred) {
1862     llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.Int32Ty, 0),
1863                                  llvm::ConstantInt::get(CGM.Int32Ty, 0),
1864                                  llvm::ConstantInt::get(CGM.Int32Ty, 1)};
1865     // Create a GEP which points just after the first entry in the VFTable,
1866     // this should be the location of the first virtual method.
1867     llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr(
1868         VTable->getValueType(), VTable, GEPIndices);
1869     if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) {
1870       VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1871       if (C)
1872         C->setSelectionKind(llvm::Comdat::Largest);
1873     }
1874     VFTable = llvm::GlobalAlias::create(CGM.Int8PtrTy,
1875                                         /*AddressSpace=*/0, VFTableLinkage,
1876                                         VFTableName.str(), VTableGEP,
1877                                         &CGM.getModule());
1878     VFTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1879   } else {
1880     // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1881     // be referencing any RTTI data.
1882     // The GlobalVariable will end up being an appropriate definition of the
1883     // VFTable.
1884     VFTable = VTable;
1885   }
1886   if (C)
1887     VTable->setComdat(C);
1888
1889   if (RD->hasAttr<DLLExportAttr>())
1890     VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1891
1892   VFTablesMap[ID] = VFTable;
1893   return VTable;
1894 }
1895
1896 CGCallee MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1897                                                     GlobalDecl GD,
1898                                                     Address This,
1899                                                     llvm::Type *Ty,
1900                                                     SourceLocation Loc) {
1901   CGBuilderTy &Builder = CGF.Builder;
1902
1903   Ty = Ty->getPointerTo()->getPointerTo();
1904   Address VPtr =
1905       adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
1906
1907   auto *MethodDecl = cast<CXXMethodDecl>(GD.getDecl());
1908   llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty, MethodDecl->getParent());
1909
1910   MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
1911   MethodVFTableLocation ML = VFTContext.getMethodVFTableLocation(GD);
1912
1913   // Compute the identity of the most derived class whose virtual table is
1914   // located at the MethodVFTableLocation ML.
1915   auto getObjectWithVPtr = [&] {
1916     return llvm::find_if(VFTContext.getVFPtrOffsets(
1917                              ML.VBase ? ML.VBase : MethodDecl->getParent()),
1918                          [&](const std::unique_ptr<VPtrInfo> &Info) {
1919                            return Info->FullOffsetInMDC == ML.VFPtrOffset;
1920                          })
1921         ->get()
1922         ->ObjectWithVPtr;
1923   };
1924
1925   llvm::Value *VFunc;
1926   if (CGF.ShouldEmitVTableTypeCheckedLoad(MethodDecl->getParent())) {
1927     VFunc = CGF.EmitVTableTypeCheckedLoad(
1928         getObjectWithVPtr(), VTable,
1929         ML.Index * CGM.getContext().getTargetInfo().getPointerWidth(0) / 8);
1930   } else {
1931     if (CGM.getCodeGenOpts().PrepareForLTO)
1932       CGF.EmitTypeMetadataCodeForVCall(getObjectWithVPtr(), VTable, Loc);
1933
1934     llvm::Value *VFuncPtr =
1935         Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1936     VFunc = Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
1937   }
1938
1939   CGCallee Callee(GD, VFunc);
1940   return Callee;
1941 }
1942
1943 llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1944     CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
1945     Address This, DeleteOrMemberCallExpr E) {
1946   auto *CE = E.dyn_cast<const CXXMemberCallExpr *>();
1947   auto *D = E.dyn_cast<const CXXDeleteExpr *>();
1948   assert((CE != nullptr) ^ (D != nullptr));
1949   assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
1950   assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1951
1952   // We have only one destructor in the vftable but can get both behaviors
1953   // by passing an implicit int parameter.
1954   GlobalDecl GD(Dtor, Dtor_Deleting);
1955   const CGFunctionInfo *FInfo =
1956       &CGM.getTypes().arrangeCXXStructorDeclaration(GD);
1957   llvm::FunctionType *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
1958   CGCallee Callee = CGCallee::forVirtual(CE, GD, This, Ty);
1959
1960   ASTContext &Context = getContext();
1961   llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1962       llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1963       DtorType == Dtor_Deleting);
1964
1965   QualType ThisTy;
1966   if (CE) {
1967     ThisTy = CE->getObjectType();
1968   } else {
1969     ThisTy = D->getDestroyedType();
1970   }
1971
1972   This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
1973   RValue RV = CGF.EmitCXXDestructorCall(GD, Callee, This.getPointer(), ThisTy,
1974                                         ImplicitParam, Context.IntTy, CE);
1975   return RV.getScalarVal();
1976 }
1977
1978 const VBTableGlobals &
1979 MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
1980   // At this layer, we can key the cache off of a single class, which is much
1981   // easier than caching each vbtable individually.
1982   llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1983   bool Added;
1984   std::tie(Entry, Added) =
1985       VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
1986   VBTableGlobals &VBGlobals = Entry->second;
1987   if (!Added)
1988     return VBGlobals;
1989
1990   MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1991   VBGlobals.VBTables = &Context.enumerateVBTables(RD);
1992
1993   // Cache the globals for all vbtables so we don't have to recompute the
1994   // mangled names.
1995   llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
1996   for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1997                                       E = VBGlobals.VBTables->end();
1998        I != E; ++I) {
1999     VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
2000   }
2001
2002   return VBGlobals;
2003 }
2004
2005 llvm::Function *
2006 MicrosoftCXXABI::EmitVirtualMemPtrThunk(const CXXMethodDecl *MD,
2007                                         const MethodVFTableLocation &ML) {
2008   assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
2009          "can't form pointers to ctors or virtual dtors");
2010
2011   // Calculate the mangled name.
2012   SmallString<256> ThunkName;
2013   llvm::raw_svector_ostream Out(ThunkName);
2014   getMangleContext().mangleVirtualMemPtrThunk(MD, ML, Out);
2015
2016   // If the thunk has been generated previously, just return it.
2017   if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
2018     return cast<llvm::Function>(GV);
2019
2020   // Create the llvm::Function.
2021   const CGFunctionInfo &FnInfo =
2022       CGM.getTypes().arrangeUnprototypedMustTailThunk(MD);
2023   llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
2024   llvm::Function *ThunkFn =
2025       llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
2026                              ThunkName.str(), &CGM.getModule());
2027   assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
2028
2029   ThunkFn->setLinkage(MD->isExternallyVisible()
2030                           ? llvm::GlobalValue::LinkOnceODRLinkage
2031                           : llvm::GlobalValue::InternalLinkage);
2032   if (MD->isExternallyVisible())
2033     ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
2034
2035   CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
2036   CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
2037
2038   // Add the "thunk" attribute so that LLVM knows that the return type is
2039   // meaningless. These thunks can be used to call functions with differing
2040   // return types, and the caller is required to cast the prototype
2041   // appropriately to extract the correct value.
2042   ThunkFn->addFnAttr("thunk");
2043
2044   // These thunks can be compared, so they are not unnamed.
2045   ThunkFn->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::None);
2046
2047   // Start codegen.
2048   CodeGenFunction CGF(CGM);
2049   CGF.CurGD = GlobalDecl(MD);
2050   CGF.CurFuncIsThunk = true;
2051
2052   // Build FunctionArgs, but only include the implicit 'this' parameter
2053   // declaration.
2054   FunctionArgList FunctionArgs;
2055   buildThisParam(CGF, FunctionArgs);
2056
2057   // Start defining the function.
2058   CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
2059                     FunctionArgs, MD->getLocation(), SourceLocation());
2060   setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
2061
2062   // Load the vfptr and then callee from the vftable.  The callee should have
2063   // adjusted 'this' so that the vfptr is at offset zero.
2064   llvm::Value *VTable = CGF.GetVTablePtr(
2065       getThisAddress(CGF), ThunkTy->getPointerTo()->getPointerTo(), MD->getParent());
2066
2067   llvm::Value *VFuncPtr =
2068       CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
2069   llvm::Value *Callee =
2070     CGF.Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
2071
2072   CGF.EmitMustTailThunk(MD, getThisValue(CGF), {ThunkTy, Callee});
2073
2074   return ThunkFn;
2075 }
2076
2077 void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
2078   const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
2079   for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
2080     const std::unique_ptr<VPtrInfo>& VBT = (*VBGlobals.VBTables)[I];
2081     llvm::GlobalVariable *GV = VBGlobals.Globals[I];
2082     if (GV->isDeclaration())
2083       emitVBTableDefinition(*VBT, RD, GV);
2084   }
2085 }
2086
2087 llvm::GlobalVariable *
2088 MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
2089                                   llvm::GlobalVariable::LinkageTypes Linkage) {
2090   SmallString<256> OutName;
2091   llvm::raw_svector_ostream Out(OutName);
2092   getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
2093   StringRef Name = OutName.str();
2094
2095   llvm::ArrayType *VBTableType =
2096       llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ObjectWithVPtr->getNumVBases());
2097
2098   assert(!CGM.getModule().getNamedGlobal(Name) &&
2099          "vbtable with this name already exists: mangling bug?");
2100   CharUnits Alignment =
2101       CGM.getContext().getTypeAlignInChars(CGM.getContext().IntTy);
2102   llvm::GlobalVariable *GV = CGM.CreateOrReplaceCXXRuntimeVariable(
2103       Name, VBTableType, Linkage, Alignment.getQuantity());
2104   GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
2105
2106   if (RD->hasAttr<DLLImportAttr>())
2107     GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
2108   else if (RD->hasAttr<DLLExportAttr>())
2109     GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
2110
2111   if (!GV->hasExternalLinkage())
2112     emitVBTableDefinition(VBT, RD, GV);
2113
2114   return GV;
2115 }
2116
2117 void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
2118                                             const CXXRecordDecl *RD,
2119                                             llvm::GlobalVariable *GV) const {
2120   const CXXRecordDecl *ObjectWithVPtr = VBT.ObjectWithVPtr;
2121
2122   assert(RD->getNumVBases() && ObjectWithVPtr->getNumVBases() &&
2123          "should only emit vbtables for classes with vbtables");
2124
2125   const ASTRecordLayout &BaseLayout =
2126       getContext().getASTRecordLayout(VBT.IntroducingObject);
2127   const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
2128
2129   SmallVector<llvm::Constant *, 4> Offsets(1 + ObjectWithVPtr->getNumVBases(),
2130                                            nullptr);
2131
2132   // The offset from ObjectWithVPtr's vbptr to itself always leads.
2133   CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
2134   Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
2135
2136   MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
2137   for (const auto &I : ObjectWithVPtr->vbases()) {
2138     const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
2139     CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
2140     assert(!Offset.isNegative());
2141
2142     // Make it relative to the subobject vbptr.
2143     CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
2144     if (VBT.getVBaseWithVPtr())
2145       CompleteVBPtrOffset +=
2146           DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
2147     Offset -= CompleteVBPtrOffset;
2148
2149     unsigned VBIndex = Context.getVBTableIndex(ObjectWithVPtr, VBase);
2150     assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
2151     Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
2152   }
2153
2154   assert(Offsets.size() ==
2155          cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
2156                                ->getElementType())->getNumElements());
2157   llvm::ArrayType *VBTableType =
2158     llvm::ArrayType::get(CGM.IntTy, Offsets.size());
2159   llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
2160   GV->setInitializer(Init);
2161
2162   if (RD->hasAttr<DLLImportAttr>())
2163     GV->setLinkage(llvm::GlobalVariable::AvailableExternallyLinkage);
2164 }
2165
2166 llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
2167                                                     Address This,
2168                                                     const ThisAdjustment &TA) {
2169   if (TA.isEmpty())
2170     return This.getPointer();
2171
2172   This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
2173
2174   llvm::Value *V;
2175   if (TA.Virtual.isEmpty()) {
2176     V = This.getPointer();
2177   } else {
2178     assert(TA.Virtual.Microsoft.VtordispOffset < 0);
2179     // Adjust the this argument based on the vtordisp value.
2180     Address VtorDispPtr =
2181         CGF.Builder.CreateConstInBoundsByteGEP(This,
2182                  CharUnits::fromQuantity(TA.Virtual.Microsoft.VtordispOffset));
2183     VtorDispPtr = CGF.Builder.CreateElementBitCast(VtorDispPtr, CGF.Int32Ty);
2184     llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
2185     V = CGF.Builder.CreateGEP(This.getPointer(),
2186                               CGF.Builder.CreateNeg(VtorDisp));
2187
2188     // Unfortunately, having applied the vtordisp means that we no
2189     // longer really have a known alignment for the vbptr step.
2190     // We'll assume the vbptr is pointer-aligned.
2191
2192     if (TA.Virtual.Microsoft.VBPtrOffset) {
2193       // If the final overrider is defined in a virtual base other than the one
2194       // that holds the vfptr, we have to use a vtordispex thunk which looks up
2195       // the vbtable of the derived class.
2196       assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
2197       assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
2198       llvm::Value *VBPtr;
2199       llvm::Value *VBaseOffset =
2200           GetVBaseOffsetFromVBPtr(CGF, Address(V, CGF.getPointerAlign()),
2201                                   -TA.Virtual.Microsoft.VBPtrOffset,
2202                                   TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
2203       V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2204     }
2205   }
2206
2207   if (TA.NonVirtual) {
2208     // Non-virtual adjustment might result in a pointer outside the allocated
2209     // object, e.g. if the final overrider class is laid out after the virtual
2210     // base that declares a method in the most derived class.
2211     V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
2212   }
2213
2214   // Don't need to bitcast back, the call CodeGen will handle this.
2215   return V;
2216 }
2217
2218 llvm::Value *
2219 MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
2220                                          const ReturnAdjustment &RA) {
2221   if (RA.isEmpty())
2222     return Ret.getPointer();
2223
2224   auto OrigTy = Ret.getType();
2225   Ret = CGF.Builder.CreateElementBitCast(Ret, CGF.Int8Ty);
2226
2227   llvm::Value *V = Ret.getPointer();
2228   if (RA.Virtual.Microsoft.VBIndex) {
2229     assert(RA.Virtual.Microsoft.VBIndex > 0);
2230     int32_t IntSize = CGF.getIntSize().getQuantity();
2231     llvm::Value *VBPtr;
2232     llvm::Value *VBaseOffset =
2233         GetVBaseOffsetFromVBPtr(CGF, Ret, RA.Virtual.Microsoft.VBPtrOffset,
2234                                 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
2235     V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2236   }
2237
2238   if (RA.NonVirtual)
2239     V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual);
2240
2241   // Cast back to the original type.
2242   return CGF.Builder.CreateBitCast(V, OrigTy);
2243 }
2244
2245 bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
2246                                    QualType elementType) {
2247   // Microsoft seems to completely ignore the possibility of a
2248   // two-argument usual deallocation function.
2249   return elementType.isDestructedType();
2250 }
2251
2252 bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
2253   // Microsoft seems to completely ignore the possibility of a
2254   // two-argument usual deallocation function.
2255   return expr->getAllocatedType().isDestructedType();
2256 }
2257
2258 CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
2259   // The array cookie is always a size_t; we then pad that out to the
2260   // alignment of the element type.
2261   ASTContext &Ctx = getContext();
2262   return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
2263                   Ctx.getTypeAlignInChars(type));
2264 }
2265
2266 llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
2267                                                   Address allocPtr,
2268                                                   CharUnits cookieSize) {
2269   Address numElementsPtr =
2270     CGF.Builder.CreateElementBitCast(allocPtr, CGF.SizeTy);
2271   return CGF.Builder.CreateLoad(numElementsPtr);
2272 }
2273
2274 Address MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
2275                                                Address newPtr,
2276                                                llvm::Value *numElements,
2277                                                const CXXNewExpr *expr,
2278                                                QualType elementType) {
2279   assert(requiresArrayCookie(expr));
2280
2281   // The size of the cookie.
2282   CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
2283
2284   // Compute an offset to the cookie.
2285   Address cookiePtr = newPtr;
2286
2287   // Write the number of elements into the appropriate slot.
2288   Address numElementsPtr
2289     = CGF.Builder.CreateElementBitCast(cookiePtr, CGF.SizeTy);
2290   CGF.Builder.CreateStore(numElements, numElementsPtr);
2291
2292   // Finally, compute a pointer to the actual data buffer by skipping
2293   // over the cookie completely.
2294   return CGF.Builder.CreateConstInBoundsByteGEP(newPtr, cookieSize);
2295 }
2296
2297 static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
2298                                         llvm::FunctionCallee Dtor,
2299                                         llvm::Constant *Addr) {
2300   // Create a function which calls the destructor.
2301   llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
2302
2303   // extern "C" int __tlregdtor(void (*f)(void));
2304   llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
2305       CGF.IntTy, DtorStub->getType(), /*isVarArg=*/false);
2306
2307   llvm::FunctionCallee TLRegDtor = CGF.CGM.CreateRuntimeFunction(
2308       TLRegDtorTy, "__tlregdtor", llvm::AttributeList(), /*Local=*/true);
2309   if (llvm::Function *TLRegDtorFn =
2310           dyn_cast<llvm::Function>(TLRegDtor.getCallee()))
2311     TLRegDtorFn->setDoesNotThrow();
2312
2313   CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
2314 }
2315
2316 void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
2317                                          llvm::FunctionCallee Dtor,
2318                                          llvm::Constant *Addr) {
2319   if (D.isNoDestroy(CGM.getContext()))
2320     return;
2321
2322   if (D.getTLSKind())
2323     return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
2324
2325   // The default behavior is to use atexit.
2326   CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
2327 }
2328
2329 void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
2330     CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
2331     ArrayRef<llvm::Function *> CXXThreadLocalInits,
2332     ArrayRef<const VarDecl *> CXXThreadLocalInitVars) {
2333   if (CXXThreadLocalInits.empty())
2334     return;
2335
2336   CGM.AppendLinkerOptions(CGM.getTarget().getTriple().getArch() ==
2337                                   llvm::Triple::x86
2338                               ? "/include:___dyn_tls_init@12"
2339                               : "/include:__dyn_tls_init");
2340
2341   // This will create a GV in the .CRT$XDU section.  It will point to our
2342   // initialization function.  The CRT will call all of these function
2343   // pointers at start-up time and, eventually, at thread-creation time.
2344   auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
2345     llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
2346         CGM.getModule(), InitFunc->getType(), /*isConstant=*/true,
2347         llvm::GlobalVariable::InternalLinkage, InitFunc,
2348         Twine(InitFunc->getName(), "$initializer$"));
2349     InitFuncPtr->setSection(".CRT$XDU");
2350     // This variable has discardable linkage, we have to add it to @llvm.used to
2351     // ensure it won't get discarded.
2352     CGM.addUsedGlobal(InitFuncPtr);
2353     return InitFuncPtr;
2354   };
2355
2356   std::vector<llvm::Function *> NonComdatInits;
2357   for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
2358     llvm::GlobalVariable *GV = cast<llvm::GlobalVariable>(
2359         CGM.GetGlobalValue(CGM.getMangledName(CXXThreadLocalInitVars[I])));
2360     llvm::Function *F = CXXThreadLocalInits[I];
2361
2362     // If the GV is already in a comdat group, then we have to join it.
2363     if (llvm::Comdat *C = GV->getComdat())
2364       AddToXDU(F)->setComdat(C);
2365     else
2366       NonComdatInits.push_back(F);
2367   }
2368
2369   if (!NonComdatInits.empty()) {
2370     llvm::FunctionType *FTy =
2371         llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
2372     llvm::Function *InitFunc = CGM.CreateGlobalInitOrCleanUpFunction(
2373         FTy, "__tls_init", CGM.getTypes().arrangeNullaryFunction(),
2374         SourceLocation(), /*TLS=*/true);
2375     CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2376
2377     AddToXDU(InitFunc);
2378   }
2379 }
2380
2381 LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2382                                                      const VarDecl *VD,
2383                                                      QualType LValType) {
2384   CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2385   return LValue();
2386 }
2387
2388 static ConstantAddress getInitThreadEpochPtr(CodeGenModule &CGM) {
2389   StringRef VarName("_Init_thread_epoch");
2390   CharUnits Align = CGM.getIntAlign();
2391   if (auto *GV = CGM.getModule().getNamedGlobal(VarName))
2392     return ConstantAddress(GV, Align);
2393   auto *GV = new llvm::GlobalVariable(
2394       CGM.getModule(), CGM.IntTy,
2395       /*isConstant=*/false, llvm::GlobalVariable::ExternalLinkage,
2396       /*Initializer=*/nullptr, VarName,
2397       /*InsertBefore=*/nullptr, llvm::GlobalVariable::GeneralDynamicTLSModel);
2398   GV->setAlignment(Align.getAsAlign());
2399   return ConstantAddress(GV, Align);
2400 }
2401
2402 static llvm::FunctionCallee getInitThreadHeaderFn(CodeGenModule &CGM) {
2403   llvm::FunctionType *FTy =
2404       llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2405                               CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2406   return CGM.CreateRuntimeFunction(
2407       FTy, "_Init_thread_header",
2408       llvm::AttributeList::get(CGM.getLLVMContext(),
2409                                llvm::AttributeList::FunctionIndex,
2410                                llvm::Attribute::NoUnwind),
2411       /*Local=*/true);
2412 }
2413
2414 static llvm::FunctionCallee getInitThreadFooterFn(CodeGenModule &CGM) {
2415   llvm::FunctionType *FTy =
2416       llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2417                               CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2418   return CGM.CreateRuntimeFunction(
2419       FTy, "_Init_thread_footer",
2420       llvm::AttributeList::get(CGM.getLLVMContext(),
2421                                llvm::AttributeList::FunctionIndex,
2422                                llvm::Attribute::NoUnwind),
2423       /*Local=*/true);
2424 }
2425
2426 static llvm::FunctionCallee getInitThreadAbortFn(CodeGenModule &CGM) {
2427   llvm::FunctionType *FTy =
2428       llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2429                               CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2430   return CGM.CreateRuntimeFunction(
2431       FTy, "_Init_thread_abort",
2432       llvm::AttributeList::get(CGM.getLLVMContext(),
2433                                llvm::AttributeList::FunctionIndex,
2434                                llvm::Attribute::NoUnwind),
2435       /*Local=*/true);
2436 }
2437
2438 namespace {
2439 struct ResetGuardBit final : EHScopeStack::Cleanup {
2440   Address Guard;
2441   unsigned GuardNum;
2442   ResetGuardBit(Address Guard, unsigned GuardNum)
2443       : Guard(Guard), GuardNum(GuardNum) {}
2444
2445   void Emit(CodeGenFunction &CGF, Flags flags) override {
2446     // Reset the bit in the mask so that the static variable may be
2447     // reinitialized.
2448     CGBuilderTy &Builder = CGF.Builder;
2449     llvm::LoadInst *LI = Builder.CreateLoad(Guard);
2450     llvm::ConstantInt *Mask =
2451         llvm::ConstantInt::get(CGF.IntTy, ~(1ULL << GuardNum));
2452     Builder.CreateStore(Builder.CreateAnd(LI, Mask), Guard);
2453   }
2454 };
2455
2456 struct CallInitThreadAbort final : EHScopeStack::Cleanup {
2457   llvm::Value *Guard;
2458   CallInitThreadAbort(Address Guard) : Guard(Guard.getPointer()) {}
2459
2460   void Emit(CodeGenFunction &CGF, Flags flags) override {
2461     // Calling _Init_thread_abort will reset the guard's state.
2462     CGF.EmitNounwindRuntimeCall(getInitThreadAbortFn(CGF.CGM), Guard);
2463   }
2464 };
2465 }
2466
2467 void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
2468                                       llvm::GlobalVariable *GV,
2469                                       bool PerformInit) {
2470   // MSVC only uses guards for static locals.
2471   if (!D.isStaticLocal()) {
2472     assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2473     // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
2474     llvm::Function *F = CGF.CurFn;
2475     F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2476     F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
2477     CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2478     return;
2479   }
2480
2481   bool ThreadlocalStatic = D.getTLSKind();
2482   bool ThreadsafeStatic = getContext().getLangOpts().ThreadsafeStatics;
2483
2484   // Thread-safe static variables which aren't thread-specific have a
2485   // per-variable guard.
2486   bool HasPerVariableGuard = ThreadsafeStatic && !ThreadlocalStatic;
2487
2488   CGBuilderTy &Builder = CGF.Builder;
2489   llvm::IntegerType *GuardTy = CGF.Int32Ty;
2490   llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
2491   CharUnits GuardAlign = CharUnits::fromQuantity(4);
2492
2493   // Get the guard variable for this function if we have one already.
2494   GuardInfo *GI = nullptr;
2495   if (ThreadlocalStatic)
2496     GI = &ThreadLocalGuardVariableMap[D.getDeclContext()];
2497   else if (!ThreadsafeStatic)
2498     GI = &GuardVariableMap[D.getDeclContext()];
2499
2500   llvm::GlobalVariable *GuardVar = GI ? GI->Guard : nullptr;
2501   unsigned GuardNum;
2502   if (D.isExternallyVisible()) {
2503     // Externally visible variables have to be numbered in Sema to properly
2504     // handle unreachable VarDecls.
2505     GuardNum = getContext().getStaticLocalNumber(&D);
2506     assert(GuardNum > 0);
2507     GuardNum--;
2508   } else if (HasPerVariableGuard) {
2509     GuardNum = ThreadSafeGuardNumMap[D.getDeclContext()]++;
2510   } else {
2511     // Non-externally visible variables are numbered here in CodeGen.
2512     GuardNum = GI->BitIndex++;
2513   }
2514
2515   if (!HasPerVariableGuard && GuardNum >= 32) {
2516     if (D.isExternallyVisible())
2517       ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
2518     GuardNum %= 32;
2519     GuardVar = nullptr;
2520   }
2521
2522   if (!GuardVar) {
2523     // Mangle the name for the guard.
2524     SmallString<256> GuardName;
2525     {
2526       llvm::raw_svector_ostream Out(GuardName);
2527       if (HasPerVariableGuard)
2528         getMangleContext().mangleThreadSafeStaticGuardVariable(&D, GuardNum,
2529                                                                Out);
2530       else
2531         getMangleContext().mangleStaticGuardVariable(&D, Out);
2532     }
2533
2534     // Create the guard variable with a zero-initializer. Just absorb linkage,
2535     // visibility and dll storage class from the guarded variable.
2536     GuardVar =
2537         new llvm::GlobalVariable(CGM.getModule(), GuardTy, /*isConstant=*/false,
2538                                  GV->getLinkage(), Zero, GuardName.str());
2539     GuardVar->setVisibility(GV->getVisibility());
2540     GuardVar->setDLLStorageClass(GV->getDLLStorageClass());
2541     GuardVar->setAlignment(GuardAlign.getAsAlign());
2542     if (GuardVar->isWeakForLinker())
2543       GuardVar->setComdat(
2544           CGM.getModule().getOrInsertComdat(GuardVar->getName()));
2545     if (D.getTLSKind())
2546       CGM.setTLSMode(GuardVar, D);
2547     if (GI && !HasPerVariableGuard)
2548       GI->Guard = GuardVar;
2549   }
2550
2551   ConstantAddress GuardAddr(GuardVar, GuardAlign);
2552
2553   assert(GuardVar->getLinkage() == GV->getLinkage() &&
2554          "static local from the same function had different linkage");
2555
2556   if (!HasPerVariableGuard) {
2557     // Pseudo code for the test:
2558     // if (!(GuardVar & MyGuardBit)) {
2559     //   GuardVar |= MyGuardBit;
2560     //   ... initialize the object ...;
2561     // }
2562
2563     // Test our bit from the guard variable.
2564     llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1ULL << GuardNum);
2565     llvm::LoadInst *LI = Builder.CreateLoad(GuardAddr);
2566     llvm::Value *NeedsInit =
2567         Builder.CreateICmpEQ(Builder.CreateAnd(LI, Bit), Zero);
2568     llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2569     llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
2570     CGF.EmitCXXGuardedInitBranch(NeedsInit, InitBlock, EndBlock,
2571                                  CodeGenFunction::GuardKind::VariableGuard, &D);
2572
2573     // Set our bit in the guard variable and emit the initializer and add a global
2574     // destructor if appropriate.
2575     CGF.EmitBlock(InitBlock);
2576     Builder.CreateStore(Builder.CreateOr(LI, Bit), GuardAddr);
2577     CGF.EHStack.pushCleanup<ResetGuardBit>(EHCleanup, GuardAddr, GuardNum);
2578     CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2579     CGF.PopCleanupBlock();
2580     Builder.CreateBr(EndBlock);
2581
2582     // Continue.
2583     CGF.EmitBlock(EndBlock);
2584   } else {
2585     // Pseudo code for the test:
2586     // if (TSS > _Init_thread_epoch) {
2587     //   _Init_thread_header(&TSS);
2588     //   if (TSS == -1) {
2589     //     ... initialize the object ...;
2590     //     _Init_thread_footer(&TSS);
2591     //   }
2592     // }
2593     //
2594     // The algorithm is almost identical to what can be found in the appendix
2595     // found in N2325.
2596
2597     // This BasicBLock determines whether or not we have any work to do.
2598     llvm::LoadInst *FirstGuardLoad = Builder.CreateLoad(GuardAddr);
2599     FirstGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2600     llvm::LoadInst *InitThreadEpoch =
2601         Builder.CreateLoad(getInitThreadEpochPtr(CGM));
2602     llvm::Value *IsUninitialized =
2603         Builder.CreateICmpSGT(FirstGuardLoad, InitThreadEpoch);
2604     llvm::BasicBlock *AttemptInitBlock = CGF.createBasicBlock("init.attempt");
2605     llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
2606     CGF.EmitCXXGuardedInitBranch(IsUninitialized, AttemptInitBlock, EndBlock,
2607                                  CodeGenFunction::GuardKind::VariableGuard, &D);
2608
2609     // This BasicBlock attempts to determine whether or not this thread is
2610     // responsible for doing the initialization.
2611     CGF.EmitBlock(AttemptInitBlock);
2612     CGF.EmitNounwindRuntimeCall(getInitThreadHeaderFn(CGM),
2613                                 GuardAddr.getPointer());
2614     llvm::LoadInst *SecondGuardLoad = Builder.CreateLoad(GuardAddr);
2615     SecondGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2616     llvm::Value *ShouldDoInit =
2617         Builder.CreateICmpEQ(SecondGuardLoad, getAllOnesInt());
2618     llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2619     Builder.CreateCondBr(ShouldDoInit, InitBlock, EndBlock);
2620
2621     // Ok, we ended up getting selected as the initializing thread.
2622     CGF.EmitBlock(InitBlock);
2623     CGF.EHStack.pushCleanup<CallInitThreadAbort>(EHCleanup, GuardAddr);
2624     CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2625     CGF.PopCleanupBlock();
2626     CGF.EmitNounwindRuntimeCall(getInitThreadFooterFn(CGM),
2627                                 GuardAddr.getPointer());
2628     Builder.CreateBr(EndBlock);
2629
2630     CGF.EmitBlock(EndBlock);
2631   }
2632 }
2633
2634 bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2635   // Null-ness for function memptrs only depends on the first field, which is
2636   // the function pointer.  The rest don't matter, so we can zero initialize.
2637   if (MPT->isMemberFunctionPointer())
2638     return true;
2639
2640   // The virtual base adjustment field is always -1 for null, so if we have one
2641   // we can't zero initialize.  The field offset is sometimes also -1 if 0 is a
2642   // valid field offset.
2643   const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2644   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
2645   return (!inheritanceModelHasVBTableOffsetField(Inheritance) &&
2646           RD->nullFieldOffsetIsZero());
2647 }
2648
2649 llvm::Type *
2650 MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
2651   const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2652   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
2653   llvm::SmallVector<llvm::Type *, 4> fields;
2654   if (MPT->isMemberFunctionPointer())
2655     fields.push_back(CGM.VoidPtrTy);  // FunctionPointerOrVirtualThunk
2656   else
2657     fields.push_back(CGM.IntTy);  // FieldOffset
2658
2659   if (inheritanceModelHasNVOffsetField(MPT->isMemberFunctionPointer(),
2660                                        Inheritance))
2661     fields.push_back(CGM.IntTy);
2662   if (inheritanceModelHasVBPtrOffsetField(Inheritance))
2663     fields.push_back(CGM.IntTy);
2664   if (inheritanceModelHasVBTableOffsetField(Inheritance))
2665     fields.push_back(CGM.IntTy);  // VirtualBaseAdjustmentOffset
2666
2667   if (fields.size() == 1)
2668     return fields[0];
2669   return llvm::StructType::get(CGM.getLLVMContext(), fields);
2670 }
2671
2672 void MicrosoftCXXABI::
2673 GetNullMemberPointerFields(const MemberPointerType *MPT,
2674                            llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2675   assert(fields.empty());
2676   const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2677   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
2678   if (MPT->isMemberFunctionPointer()) {
2679     // FunctionPointerOrVirtualThunk
2680     fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2681   } else {
2682     if (RD->nullFieldOffsetIsZero())
2683       fields.push_back(getZeroInt());  // FieldOffset
2684     else
2685       fields.push_back(getAllOnesInt());  // FieldOffset
2686   }
2687
2688   if (inheritanceModelHasNVOffsetField(MPT->isMemberFunctionPointer(),
2689                                        Inheritance))
2690     fields.push_back(getZeroInt());
2691   if (inheritanceModelHasVBPtrOffsetField(Inheritance))
2692     fields.push_back(getZeroInt());
2693   if (inheritanceModelHasVBTableOffsetField(Inheritance))
2694     fields.push_back(getAllOnesInt());
2695 }
2696
2697 llvm::Constant *
2698 MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
2699   llvm::SmallVector<llvm::Constant *, 4> fields;
2700   GetNullMemberPointerFields(MPT, fields);
2701   if (fields.size() == 1)
2702     return fields[0];
2703   llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2704   assert(Res->getType() == ConvertMemberPointerType(MPT));
2705   return Res;
2706 }
2707
2708 llvm::Constant *
2709 MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2710                                        bool IsMemberFunction,
2711                                        const CXXRecordDecl *RD,
2712                                        CharUnits NonVirtualBaseAdjustment,
2713                                        unsigned VBTableIndex) {
2714   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
2715
2716   // Single inheritance class member pointer are represented as scalars instead
2717   // of aggregates.
2718   if (inheritanceModelHasOnlyOneField(IsMemberFunction, Inheritance))
2719     return FirstField;
2720
2721   llvm::SmallVector<llvm::Constant *, 4> fields;
2722   fields.push_back(FirstField);
2723
2724   if (inheritanceModelHasNVOffsetField(IsMemberFunction, Inheritance))
2725     fields.push_back(llvm::ConstantInt::get(
2726       CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
2727
2728   if (inheritanceModelHasVBPtrOffsetField(Inheritance)) {
2729     CharUnits Offs = CharUnits::Zero();
2730     if (VBTableIndex)
2731       Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
2732     fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
2733   }
2734
2735   // The rest of the fields are adjusted by conversions to a more derived class.
2736   if (inheritanceModelHasVBTableOffsetField(Inheritance))
2737     fields.push_back(llvm::ConstantInt::get(CGM.IntTy, VBTableIndex));
2738
2739   return llvm::ConstantStruct::getAnon(fields);
2740 }
2741
2742 llvm::Constant *
2743 MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2744                                        CharUnits offset) {
2745   return EmitMemberDataPointer(MPT->getMostRecentCXXRecordDecl(), offset);
2746 }
2747
2748 llvm::Constant *MicrosoftCXXABI::EmitMemberDataPointer(const CXXRecordDecl *RD,
2749                                                        CharUnits offset) {
2750   if (RD->getMSInheritanceModel() ==
2751       MSInheritanceModel::Virtual)
2752     offset -= getContext().getOffsetOfBaseWithVBPtr(RD);
2753   llvm::Constant *FirstField =
2754     llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
2755   return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
2756                                CharUnits::Zero(), /*VBTableIndex=*/0);
2757 }
2758
2759 llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2760                                                    QualType MPType) {
2761   const MemberPointerType *DstTy = MPType->castAs<MemberPointerType>();
2762   const ValueDecl *MPD = MP.getMemberPointerDecl();
2763   if (!MPD)
2764     return EmitNullMemberPointer(DstTy);
2765
2766   ASTContext &Ctx = getContext();
2767   ArrayRef<const CXXRecordDecl *> MemberPointerPath = MP.getMemberPointerPath();
2768
2769   llvm::Constant *C;
2770   if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) {
2771     C = EmitMemberFunctionPointer(MD);
2772   } else {
2773     // For a pointer to data member, start off with the offset of the field in
2774     // the class in which it was declared, and convert from there if necessary.
2775     // For indirect field decls, get the outermost anonymous field and use the
2776     // parent class.
2777     CharUnits FieldOffset = Ctx.toCharUnitsFromBits(Ctx.getFieldOffset(MPD));
2778     const FieldDecl *FD = dyn_cast<FieldDecl>(MPD);
2779     if (!FD)
2780       FD = cast<FieldDecl>(*cast<IndirectFieldDecl>(MPD)->chain_begin());
2781     const CXXRecordDecl *RD = cast<CXXRecordDecl>(FD->getParent());
2782     RD = RD->getMostRecentNonInjectedDecl();
2783     C = EmitMemberDataPointer(RD, FieldOffset);
2784   }
2785
2786   if (!MemberPointerPath.empty()) {
2787     const CXXRecordDecl *SrcRD = cast<CXXRecordDecl>(MPD->getDeclContext());
2788     const Type *SrcRecTy = Ctx.getTypeDeclType(SrcRD).getTypePtr();
2789     const MemberPointerType *SrcTy =
2790         Ctx.getMemberPointerType(DstTy->getPointeeType(), SrcRecTy)
2791             ->castAs<MemberPointerType>();
2792
2793     bool DerivedMember = MP.isMemberPointerToDerivedMember();
2794     SmallVector<const CXXBaseSpecifier *, 4> DerivedToBasePath;
2795     const CXXRecordDecl *PrevRD = SrcRD;
2796     for (const CXXRecordDecl *PathElem : MemberPointerPath) {
2797       const CXXRecordDecl *Base = nullptr;
2798       const CXXRecordDecl *Derived = nullptr;
2799       if (DerivedMember) {
2800         Base = PathElem;
2801         Derived = PrevRD;
2802       } else {
2803         Base = PrevRD;
2804         Derived = PathElem;
2805       }
2806       for (const CXXBaseSpecifier &BS : Derived->bases())
2807         if (BS.getType()->getAsCXXRecordDecl()->getCanonicalDecl() ==
2808             Base->getCanonicalDecl())
2809           DerivedToBasePath.push_back(&BS);
2810       PrevRD = PathElem;
2811     }
2812     assert(DerivedToBasePath.size() == MemberPointerPath.size());
2813
2814     CastKind CK = DerivedMember ? CK_DerivedToBaseMemberPointer
2815                                 : CK_BaseToDerivedMemberPointer;
2816     C = EmitMemberPointerConversion(SrcTy, DstTy, CK, DerivedToBasePath.begin(),
2817                                     DerivedToBasePath.end(), C);
2818   }
2819   return C;
2820 }
2821
2822 llvm::Constant *
2823 MicrosoftCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) {
2824   assert(MD->isInstance() && "Member function must not be static!");
2825
2826   CharUnits NonVirtualBaseAdjustment = CharUnits::Zero();
2827   const CXXRecordDecl *RD = MD->getParent()->getMostRecentNonInjectedDecl();
2828   CodeGenTypes &Types = CGM.getTypes();
2829
2830   unsigned VBTableIndex = 0;
2831   llvm::Constant *FirstField;
2832   const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
2833   if (!MD->isVirtual()) {
2834     llvm::Type *Ty;
2835     // Check whether the function has a computable LLVM signature.
2836     if (Types.isFuncTypeConvertible(FPT)) {
2837       // The function has a computable LLVM signature; use the correct type.
2838       Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2839     } else {
2840       // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2841       // function type is incomplete.
2842       Ty = CGM.PtrDiffTy;
2843     }
2844     FirstField = CGM.GetAddrOfFunction(MD, Ty);
2845   } else {
2846     auto &VTableContext = CGM.getMicrosoftVTableContext();
2847     MethodVFTableLocation ML = VTableContext.getMethodVFTableLocation(MD);
2848     FirstField = EmitVirtualMemPtrThunk(MD, ML);
2849     // Include the vfptr adjustment if the method is in a non-primary vftable.
2850     NonVirtualBaseAdjustment += ML.VFPtrOffset;
2851     if (ML.VBase)
2852       VBTableIndex = VTableContext.getVBTableIndex(RD, ML.VBase) * 4;
2853   }
2854
2855   if (VBTableIndex == 0 &&
2856       RD->getMSInheritanceModel() ==
2857           MSInheritanceModel::Virtual)
2858     NonVirtualBaseAdjustment -= getContext().getOffsetOfBaseWithVBPtr(RD);
2859
2860   // The rest of the fields are common with data member pointers.
2861   FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
2862   return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
2863                                NonVirtualBaseAdjustment, VBTableIndex);
2864 }
2865
2866 /// Member pointers are the same if they're either bitwise identical *or* both
2867 /// null.  Null-ness for function members is determined by the first field,
2868 /// while for data member pointers we must compare all fields.
2869 llvm::Value *
2870 MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2871                                              llvm::Value *L,
2872                                              llvm::Value *R,
2873                                              const MemberPointerType *MPT,
2874                                              bool Inequality) {
2875   CGBuilderTy &Builder = CGF.Builder;
2876
2877   // Handle != comparisons by switching the sense of all boolean operations.
2878   llvm::ICmpInst::Predicate Eq;
2879   llvm::Instruction::BinaryOps And, Or;
2880   if (Inequality) {
2881     Eq = llvm::ICmpInst::ICMP_NE;
2882     And = llvm::Instruction::Or;
2883     Or = llvm::Instruction::And;
2884   } else {
2885     Eq = llvm::ICmpInst::ICMP_EQ;
2886     And = llvm::Instruction::And;
2887     Or = llvm::Instruction::Or;
2888   }
2889
2890   // If this is a single field member pointer (single inheritance), this is a
2891   // single icmp.
2892   const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2893   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
2894   if (inheritanceModelHasOnlyOneField(MPT->isMemberFunctionPointer(),
2895                                       Inheritance))
2896     return Builder.CreateICmp(Eq, L, R);
2897
2898   // Compare the first field.
2899   llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2900   llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2901   llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2902
2903   // Compare everything other than the first field.
2904   llvm::Value *Res = nullptr;
2905   llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2906   for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2907     llvm::Value *LF = Builder.CreateExtractValue(L, I);
2908     llvm::Value *RF = Builder.CreateExtractValue(R, I);
2909     llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2910     if (Res)
2911       Res = Builder.CreateBinOp(And, Res, Cmp);
2912     else
2913       Res = Cmp;
2914   }
2915
2916   // Check if the first field is 0 if this is a function pointer.
2917   if (MPT->isMemberFunctionPointer()) {
2918     // (l1 == r1 && ...) || l0 == 0
2919     llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2920     llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2921     Res = Builder.CreateBinOp(Or, Res, IsZero);
2922   }
2923
2924   // Combine the comparison of the first field, which must always be true for
2925   // this comparison to succeeed.
2926   return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2927 }
2928
2929 llvm::Value *
2930 MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2931                                             llvm::Value *MemPtr,
2932                                             const MemberPointerType *MPT) {
2933   CGBuilderTy &Builder = CGF.Builder;
2934   llvm::SmallVector<llvm::Constant *, 4> fields;
2935   // We only need one field for member functions.
2936   if (MPT->isMemberFunctionPointer())
2937     fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2938   else
2939     GetNullMemberPointerFields(MPT, fields);
2940   assert(!fields.empty());
2941   llvm::Value *FirstField = MemPtr;
2942   if (MemPtr->getType()->isStructTy())
2943     FirstField = Builder.CreateExtractValue(MemPtr, 0);
2944   llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
2945
2946   // For function member pointers, we only need to test the function pointer
2947   // field.  The other fields if any can be garbage.
2948   if (MPT->isMemberFunctionPointer())
2949     return Res;
2950
2951   // Otherwise, emit a series of compares and combine the results.
2952   for (int I = 1, E = fields.size(); I < E; ++I) {
2953     llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2954     llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
2955     Res = Builder.CreateOr(Res, Next, "memptr.tobool");
2956   }
2957   return Res;
2958 }
2959
2960 bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2961                                                   llvm::Constant *Val) {
2962   // Function pointers are null if the pointer in the first field is null.
2963   if (MPT->isMemberFunctionPointer()) {
2964     llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2965       Val->getAggregateElement(0U) : Val;
2966     return FirstField->isNullValue();
2967   }
2968
2969   // If it's not a function pointer and it's zero initializable, we can easily
2970   // check zero.
2971   if (isZeroInitializable(MPT) && Val->isNullValue())
2972     return true;
2973
2974   // Otherwise, break down all the fields for comparison.  Hopefully these
2975   // little Constants are reused, while a big null struct might not be.
2976   llvm::SmallVector<llvm::Constant *, 4> Fields;
2977   GetNullMemberPointerFields(MPT, Fields);
2978   if (Fields.size() == 1) {
2979     assert(Val->getType()->isIntegerTy());
2980     return Val == Fields[0];
2981   }
2982
2983   unsigned I, E;
2984   for (I = 0, E = Fields.size(); I != E; ++I) {
2985     if (Val->getAggregateElement(I) != Fields[I])
2986       break;
2987   }
2988   return I == E;
2989 }
2990
2991 llvm::Value *
2992 MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
2993                                          Address This,
2994                                          llvm::Value *VBPtrOffset,
2995                                          llvm::Value *VBTableOffset,
2996                                          llvm::Value **VBPtrOut) {
2997   CGBuilderTy &Builder = CGF.Builder;
2998   // Load the vbtable pointer from the vbptr in the instance.
2999   This = Builder.CreateElementBitCast(This, CGM.Int8Ty);
3000   llvm::Value *VBPtr =
3001     Builder.CreateInBoundsGEP(This.getPointer(), VBPtrOffset, "vbptr");
3002   if (VBPtrOut) *VBPtrOut = VBPtr;
3003   VBPtr = Builder.CreateBitCast(VBPtr,
3004             CGM.Int32Ty->getPointerTo(0)->getPointerTo(This.getAddressSpace()));
3005
3006   CharUnits VBPtrAlign;
3007   if (auto CI = dyn_cast<llvm::ConstantInt>(VBPtrOffset)) {
3008     VBPtrAlign = This.getAlignment().alignmentAtOffset(
3009                                    CharUnits::fromQuantity(CI->getSExtValue()));
3010   } else {
3011     VBPtrAlign = CGF.getPointerAlign();
3012   }
3013
3014   llvm::Value *VBTable = Builder.CreateAlignedLoad(VBPtr, VBPtrAlign, "vbtable");
3015
3016   // Translate from byte offset to table index. It improves analyzability.
3017   llvm::Value *VBTableIndex = Builder.CreateAShr(
3018       VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
3019       "vbtindex", /*isExact=*/true);
3020
3021   // Load an i32 offset from the vb-table.
3022   llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
3023   VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
3024   return Builder.CreateAlignedLoad(VBaseOffs, CharUnits::fromQuantity(4),
3025                                    "vbase_offs");
3026 }
3027
3028 // Returns an adjusted base cast to i8*, since we do more address arithmetic on
3029 // it.
3030 llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
3031     CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
3032     Address Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
3033   CGBuilderTy &Builder = CGF.Builder;
3034   Base = Builder.CreateElementBitCast(Base, CGM.Int8Ty);
3035   llvm::BasicBlock *OriginalBB = nullptr;
3036   llvm::BasicBlock *SkipAdjustBB = nullptr;
3037   llvm::BasicBlock *VBaseAdjustBB = nullptr;
3038
3039   // In the unspecified inheritance model, there might not be a vbtable at all,
3040   // in which case we need to skip the virtual base lookup.  If there is a
3041   // vbtable, the first entry is a no-op entry that gives back the original
3042   // base, so look for a virtual base adjustment offset of zero.
3043   if (VBPtrOffset) {
3044     OriginalBB = Builder.GetInsertBlock();
3045     VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
3046     SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
3047     llvm::Value *IsVirtual =
3048       Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
3049                            "memptr.is_vbase");
3050     Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
3051     CGF.EmitBlock(VBaseAdjustBB);
3052   }
3053
3054   // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
3055   // know the vbptr offset.
3056   if (!VBPtrOffset) {
3057     CharUnits offs = CharUnits::Zero();
3058     if (!RD->hasDefinition()) {
3059       DiagnosticsEngine &Diags = CGF.CGM.getDiags();
3060       unsigned DiagID = Diags.getCustomDiagID(
3061           DiagnosticsEngine::Error,
3062           "member pointer representation requires a "
3063           "complete class type for %0 to perform this expression");
3064       Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
3065     } else if (RD->getNumVBases())
3066       offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
3067     VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
3068   }
3069   llvm::Value *VBPtr = nullptr;
3070   llvm::Value *VBaseOffs =
3071     GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
3072   llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
3073
3074   // Merge control flow with the case where we didn't have to adjust.
3075   if (VBaseAdjustBB) {
3076     Builder.CreateBr(SkipAdjustBB);
3077     CGF.EmitBlock(SkipAdjustBB);
3078     llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
3079     Phi->addIncoming(Base.getPointer(), OriginalBB);
3080     Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
3081     return Phi;
3082   }
3083   return AdjustedBase;
3084 }
3085
3086 llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
3087     CodeGenFunction &CGF, const Expr *E, Address Base, llvm::Value *MemPtr,
3088     const MemberPointerType *MPT) {
3089   assert(MPT->isMemberDataPointer());
3090   unsigned AS = Base.getAddressSpace();
3091   llvm::Type *PType =
3092       CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
3093   CGBuilderTy &Builder = CGF.Builder;
3094   const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
3095   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
3096
3097   // Extract the fields we need, regardless of model.  We'll apply them if we
3098   // have them.
3099   llvm::Value *FieldOffset = MemPtr;
3100   llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3101   llvm::Value *VBPtrOffset = nullptr;
3102   if (MemPtr->getType()->isStructTy()) {
3103     // We need to extract values.
3104     unsigned I = 0;
3105     FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
3106     if (inheritanceModelHasVBPtrOffsetField(Inheritance))
3107       VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
3108     if (inheritanceModelHasVBTableOffsetField(Inheritance))
3109       VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3110   }
3111
3112   llvm::Value *Addr;
3113   if (VirtualBaseAdjustmentOffset) {
3114     Addr = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
3115                              VBPtrOffset);
3116   } else {
3117     Addr = Base.getPointer();
3118   }
3119
3120   // Cast to char*.
3121   Addr = Builder.CreateBitCast(Addr, CGF.Int8Ty->getPointerTo(AS));
3122
3123   // Apply the offset, which we assume is non-null.
3124   Addr = Builder.CreateInBoundsGEP(Addr, FieldOffset, "memptr.offset");
3125
3126   // Cast the address to the appropriate pointer type, adopting the address
3127   // space of the base pointer.
3128   return Builder.CreateBitCast(Addr, PType);
3129 }
3130
3131 llvm::Value *
3132 MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
3133                                              const CastExpr *E,
3134                                              llvm::Value *Src) {
3135   assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
3136          E->getCastKind() == CK_BaseToDerivedMemberPointer ||
3137          E->getCastKind() == CK_ReinterpretMemberPointer);
3138
3139   // Use constant emission if we can.
3140   if (isa<llvm::Constant>(Src))
3141     return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
3142
3143   // We may be adding or dropping fields from the member pointer, so we need
3144   // both types and the inheritance models of both records.
3145   const MemberPointerType *SrcTy =
3146     E->getSubExpr()->getType()->castAs<MemberPointerType>();
3147   const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3148   bool IsFunc = SrcTy->isMemberFunctionPointer();
3149
3150   // If the classes use the same null representation, reinterpret_cast is a nop.
3151   bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
3152   if (IsReinterpret && IsFunc)
3153     return Src;
3154
3155   CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3156   CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3157   if (IsReinterpret &&
3158       SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
3159     return Src;
3160
3161   CGBuilderTy &Builder = CGF.Builder;
3162
3163   // Branch past the conversion if Src is null.
3164   llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
3165   llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
3166
3167   // C++ 5.2.10p9: The null member pointer value is converted to the null member
3168   //   pointer value of the destination type.
3169   if (IsReinterpret) {
3170     // For reinterpret casts, sema ensures that src and dst are both functions
3171     // or data and have the same size, which means the LLVM types should match.
3172     assert(Src->getType() == DstNull->getType());
3173     return Builder.CreateSelect(IsNotNull, Src, DstNull);
3174   }
3175
3176   llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
3177   llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
3178   llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
3179   Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
3180   CGF.EmitBlock(ConvertBB);
3181
3182   llvm::Value *Dst = EmitNonNullMemberPointerConversion(
3183       SrcTy, DstTy, E->getCastKind(), E->path_begin(), E->path_end(), Src,
3184       Builder);
3185
3186   Builder.CreateBr(ContinueBB);
3187
3188   // In the continuation, choose between DstNull and Dst.
3189   CGF.EmitBlock(ContinueBB);
3190   llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
3191   Phi->addIncoming(DstNull, OriginalBB);
3192   Phi->addIncoming(Dst, ConvertBB);
3193   return Phi;
3194 }
3195
3196 llvm::Value *MicrosoftCXXABI::EmitNonNullMemberPointerConversion(
3197     const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3198     CastExpr::path_const_iterator PathBegin,
3199     CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
3200     CGBuilderTy &Builder) {
3201   const CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3202   const CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3203   MSInheritanceModel SrcInheritance = SrcRD->getMSInheritanceModel();
3204   MSInheritanceModel DstInheritance = DstRD->getMSInheritanceModel();
3205   bool IsFunc = SrcTy->isMemberFunctionPointer();
3206   bool IsConstant = isa<llvm::Constant>(Src);
3207
3208   // Decompose src.
3209   llvm::Value *FirstField = Src;
3210   llvm::Value *NonVirtualBaseAdjustment = getZeroInt();
3211   llvm::Value *VirtualBaseAdjustmentOffset = getZeroInt();
3212   llvm::Value *VBPtrOffset = getZeroInt();
3213   if (!inheritanceModelHasOnlyOneField(IsFunc, SrcInheritance)) {
3214     // We need to extract values.
3215     unsigned I = 0;
3216     FirstField = Builder.CreateExtractValue(Src, I++);
3217     if (inheritanceModelHasNVOffsetField(IsFunc, SrcInheritance))
3218       NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
3219     if (inheritanceModelHasVBPtrOffsetField(SrcInheritance))
3220       VBPtrOffset = Builder.CreateExtractValue(Src, I++);
3221     if (inheritanceModelHasVBTableOffsetField(SrcInheritance))
3222       VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
3223   }
3224
3225   bool IsDerivedToBase = (CK == CK_DerivedToBaseMemberPointer);
3226   const MemberPointerType *DerivedTy = IsDerivedToBase ? SrcTy : DstTy;
3227   const CXXRecordDecl *DerivedClass = DerivedTy->getMostRecentCXXRecordDecl();
3228
3229   // For data pointers, we adjust the field offset directly.  For functions, we
3230   // have a separate field.
3231   llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
3232
3233   // The virtual inheritance model has a quirk: the virtual base table is always
3234   // referenced when dereferencing a member pointer even if the member pointer
3235   // is non-virtual.  This is accounted for by adjusting the non-virtual offset
3236   // to point backwards to the top of the MDC from the first VBase.  Undo this
3237   // adjustment to normalize the member pointer.
3238   llvm::Value *SrcVBIndexEqZero =
3239       Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3240   if (SrcInheritance == MSInheritanceModel::Virtual) {
3241     if (int64_t SrcOffsetToFirstVBase =
3242             getContext().getOffsetOfBaseWithVBPtr(SrcRD).getQuantity()) {
3243       llvm::Value *UndoSrcAdjustment = Builder.CreateSelect(
3244           SrcVBIndexEqZero,
3245           llvm::ConstantInt::get(CGM.IntTy, SrcOffsetToFirstVBase),
3246           getZeroInt());
3247       NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, UndoSrcAdjustment);
3248     }
3249   }
3250
3251   // A non-zero vbindex implies that we are dealing with a source member in a
3252   // floating virtual base in addition to some non-virtual offset.  If the
3253   // vbindex is zero, we are dealing with a source that exists in a non-virtual,
3254   // fixed, base.  The difference between these two cases is that the vbindex +
3255   // nvoffset *always* point to the member regardless of what context they are
3256   // evaluated in so long as the vbindex is adjusted.  A member inside a fixed
3257   // base requires explicit nv adjustment.
3258   llvm::Constant *BaseClassOffset = llvm::ConstantInt::get(
3259       CGM.IntTy,
3260       CGM.computeNonVirtualBaseClassOffset(DerivedClass, PathBegin, PathEnd)
3261           .getQuantity());
3262
3263   llvm::Value *NVDisp;
3264   if (IsDerivedToBase)
3265     NVDisp = Builder.CreateNSWSub(NVAdjustField, BaseClassOffset, "adj");
3266   else
3267     NVDisp = Builder.CreateNSWAdd(NVAdjustField, BaseClassOffset, "adj");
3268
3269   NVAdjustField = Builder.CreateSelect(SrcVBIndexEqZero, NVDisp, getZeroInt());
3270
3271   // Update the vbindex to an appropriate value in the destination because
3272   // SrcRD's vbtable might not be a strict prefix of the one in DstRD.
3273   llvm::Value *DstVBIndexEqZero = SrcVBIndexEqZero;
3274   if (inheritanceModelHasVBTableOffsetField(DstInheritance) &&
3275       inheritanceModelHasVBTableOffsetField(SrcInheritance)) {
3276     if (llvm::GlobalVariable *VDispMap =
3277             getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) {
3278       llvm::Value *VBIndex = Builder.CreateExactUDiv(
3279           VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4));
3280       if (IsConstant) {
3281         llvm::Constant *Mapping = VDispMap->getInitializer();
3282         VirtualBaseAdjustmentOffset =
3283             Mapping->getAggregateElement(cast<llvm::Constant>(VBIndex));
3284       } else {
3285         llvm::Value *Idxs[] = {getZeroInt(), VBIndex};
3286         VirtualBaseAdjustmentOffset =
3287             Builder.CreateAlignedLoad(Builder.CreateInBoundsGEP(VDispMap, Idxs),
3288                                       CharUnits::fromQuantity(4));
3289       }
3290
3291       DstVBIndexEqZero =
3292           Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3293     }
3294   }
3295
3296   // Set the VBPtrOffset to zero if the vbindex is zero.  Otherwise, initialize
3297   // it to the offset of the vbptr.
3298   if (inheritanceModelHasVBPtrOffsetField(DstInheritance)) {
3299     llvm::Value *DstVBPtrOffset = llvm::ConstantInt::get(
3300         CGM.IntTy,
3301         getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity());
3302     VBPtrOffset =
3303         Builder.CreateSelect(DstVBIndexEqZero, getZeroInt(), DstVBPtrOffset);
3304   }
3305
3306   // Likewise, apply a similar adjustment so that dereferencing the member
3307   // pointer correctly accounts for the distance between the start of the first
3308   // virtual base and the top of the MDC.
3309   if (DstInheritance == MSInheritanceModel::Virtual) {
3310     if (int64_t DstOffsetToFirstVBase =
3311             getContext().getOffsetOfBaseWithVBPtr(DstRD).getQuantity()) {
3312       llvm::Value *DoDstAdjustment = Builder.CreateSelect(
3313           DstVBIndexEqZero,
3314           llvm::ConstantInt::get(CGM.IntTy, DstOffsetToFirstVBase),
3315           getZeroInt());
3316       NVAdjustField = Builder.CreateNSWSub(NVAdjustField, DoDstAdjustment);
3317     }
3318   }
3319
3320   // Recompose dst from the null struct and the adjusted fields from src.
3321   llvm::Value *Dst;
3322   if (inheritanceModelHasOnlyOneField(IsFunc, DstInheritance)) {
3323     Dst = FirstField;
3324   } else {
3325     Dst = llvm::UndefValue::get(ConvertMemberPointerType(DstTy));
3326     unsigned Idx = 0;
3327     Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
3328     if (inheritanceModelHasNVOffsetField(IsFunc, DstInheritance))
3329       Dst = Builder.CreateInsertValue(Dst, NonVirtualBaseAdjustment, Idx++);
3330     if (inheritanceModelHasVBPtrOffsetField(DstInheritance))
3331       Dst = Builder.CreateInsertValue(Dst, VBPtrOffset, Idx++);
3332     if (inheritanceModelHasVBTableOffsetField(DstInheritance))
3333       Dst = Builder.CreateInsertValue(Dst, VirtualBaseAdjustmentOffset, Idx++);
3334   }
3335   return Dst;
3336 }
3337
3338 llvm::Constant *
3339 MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
3340                                              llvm::Constant *Src) {
3341   const MemberPointerType *SrcTy =
3342       E->getSubExpr()->getType()->castAs<MemberPointerType>();
3343   const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3344
3345   CastKind CK = E->getCastKind();
3346
3347   return EmitMemberPointerConversion(SrcTy, DstTy, CK, E->path_begin(),
3348                                      E->path_end(), Src);
3349 }
3350
3351 llvm::Constant *MicrosoftCXXABI::EmitMemberPointerConversion(
3352     const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3353     CastExpr::path_const_iterator PathBegin,
3354     CastExpr::path_const_iterator PathEnd, llvm::Constant *Src) {
3355   assert(CK == CK_DerivedToBaseMemberPointer ||
3356          CK == CK_BaseToDerivedMemberPointer ||
3357          CK == CK_ReinterpretMemberPointer);
3358   // If src is null, emit a new null for dst.  We can't return src because dst
3359   // might have a new representation.
3360   if (MemberPointerConstantIsNull(SrcTy, Src))
3361     return EmitNullMemberPointer(DstTy);
3362
3363   // We don't need to do anything for reinterpret_casts of non-null member
3364   // pointers.  We should only get here when the two type representations have
3365   // the same size.
3366   if (CK == CK_ReinterpretMemberPointer)
3367     return Src;
3368
3369   CGBuilderTy Builder(CGM, CGM.getLLVMContext());
3370   auto *Dst = cast<llvm::Constant>(EmitNonNullMemberPointerConversion(
3371       SrcTy, DstTy, CK, PathBegin, PathEnd, Src, Builder));
3372
3373   return Dst;
3374 }
3375
3376 CGCallee MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
3377     CodeGenFunction &CGF, const Expr *E, Address This,
3378     llvm::Value *&ThisPtrForCall, llvm::Value *MemPtr,
3379     const MemberPointerType *MPT) {
3380   assert(MPT->isMemberFunctionPointer());
3381   const FunctionProtoType *FPT =
3382     MPT->getPointeeType()->castAs<FunctionProtoType>();
3383   const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
3384   llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(
3385       CGM.getTypes().arrangeCXXMethodType(RD, FPT, /*FD=*/nullptr));
3386   CGBuilderTy &Builder = CGF.Builder;
3387
3388   MSInheritanceModel Inheritance = RD->getMSInheritanceModel();
3389
3390   // Extract the fields we need, regardless of model.  We'll apply them if we
3391   // have them.
3392   llvm::Value *FunctionPointer = MemPtr;
3393   llvm::Value *NonVirtualBaseAdjustment = nullptr;
3394   llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3395   llvm::Value *VBPtrOffset = nullptr;
3396   if (MemPtr->getType()->isStructTy()) {
3397     // We need to extract values.
3398     unsigned I = 0;
3399     FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
3400     if (inheritanceModelHasNVOffsetField(MPT, Inheritance))
3401       NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
3402     if (inheritanceModelHasVBPtrOffsetField(Inheritance))
3403       VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
3404     if (inheritanceModelHasVBTableOffsetField(Inheritance))
3405       VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3406   }
3407
3408   if (VirtualBaseAdjustmentOffset) {
3409     ThisPtrForCall = AdjustVirtualBase(CGF, E, RD, This,
3410                                    VirtualBaseAdjustmentOffset, VBPtrOffset);
3411   } else {
3412     ThisPtrForCall = This.getPointer();
3413   }
3414
3415   if (NonVirtualBaseAdjustment) {
3416     // Apply the adjustment and cast back to the original struct type.
3417     llvm::Value *Ptr = Builder.CreateBitCast(ThisPtrForCall, CGF.Int8PtrTy);
3418     Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
3419     ThisPtrForCall = Builder.CreateBitCast(Ptr, ThisPtrForCall->getType(),
3420                                            "this.adjusted");
3421   }
3422
3423   FunctionPointer =
3424     Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
3425   CGCallee Callee(FPT, FunctionPointer);
3426   return Callee;
3427 }
3428
3429 CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
3430   return new MicrosoftCXXABI(CGM);
3431 }
3432
3433 // MS RTTI Overview:
3434 // The run time type information emitted by cl.exe contains 5 distinct types of
3435 // structures.  Many of them reference each other.
3436 //