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