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