blob: 4cd4f8533b7f725ddba4721ef5be188f723ecdae [file] [log] [blame]
Charles Davis74ce8592010-06-09 23:25:41 +00001//===--- MicrosoftCXXABI.cpp - Emit LLVM Code from ASTs for a Module ------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
Chris Lattner57540c52011-04-15 05:22:18 +000010// This provides C++ code generation targeting the Microsoft Visual C++ ABI.
Charles Davis74ce8592010-06-09 23:25:41 +000011// The class in this file generates structures that follow the Microsoft
12// Visual C++ ABI, which is actually not very well documented at all outside
13// of Microsoft.
14//
15//===----------------------------------------------------------------------===//
16
17#include "CGCXXABI.h"
Reid Kleckner10aa7702015-09-16 20:15:55 +000018#include "CGCleanup.h"
Reid Kleckner7810af02013-06-19 15:20:38 +000019#include "CGVTables.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000020#include "CodeGenModule.h"
David Majnemere7a818f2015-03-06 18:53:55 +000021#include "CodeGenTypes.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000022#include "TargetInfo.h"
Charles Davis74ce8592010-06-09 23:25:41 +000023#include "clang/AST/Decl.h"
24#include "clang/AST/DeclCXX.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000025#include "clang/AST/StmtCXX.h"
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +000026#include "clang/AST/VTableBuilder.h"
David Majnemer611cdb92014-07-07 08:09:15 +000027#include "llvm/ADT/StringExtras.h"
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +000028#include "llvm/ADT/StringSet.h"
David Majnemer1162d252014-06-22 19:05:33 +000029#include "llvm/IR/CallSite.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000030#include "llvm/IR/Intrinsics.h"
Charles Davis74ce8592010-06-09 23:25:41 +000031
32using namespace clang;
33using namespace CodeGen;
34
35namespace {
36
Reid Klecknerb40a27d2014-01-03 00:14:35 +000037/// Holds all the vbtable globals for a given class.
38struct VBTableGlobals {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +000039 const VPtrInfoVector *VBTables;
Reid Klecknerb40a27d2014-01-03 00:14:35 +000040 SmallVector<llvm::GlobalVariable *, 2> Globals;
41};
42
Charles Davis53c59df2010-08-16 03:33:14 +000043class MicrosoftCXXABI : public CGCXXABI {
Charles Davis74ce8592010-06-09 23:25:41 +000044public:
David Majnemer611cdb92014-07-07 08:09:15 +000045 MicrosoftCXXABI(CodeGenModule &CGM)
46 : CGCXXABI(CGM), BaseClassDescriptorType(nullptr),
47 ClassHierarchyDescriptorType(nullptr),
David Majnemer7c237072015-03-05 00:46:22 +000048 CompleteObjectLocatorType(nullptr), CatchableTypeType(nullptr),
Benjamin Kramerc2d2b422015-10-15 15:29:40 +000049 ThrowInfoType(nullptr) {}
John McCall5d865c322010-08-31 07:33:07 +000050
Craig Topper4f12f102014-03-12 06:41:41 +000051 bool HasThisReturn(GlobalDecl GD) const override;
David Majnemer0c0b6d92014-10-31 20:09:12 +000052 bool hasMostDerivedReturn(GlobalDecl GD) const override;
Stephen Lin9dc6eef2013-06-30 20:40:16 +000053
Reid Kleckner40ca9132014-05-13 22:05:45 +000054 bool classifyReturnType(CGFunctionInfo &FI) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000055
Reid Klecknere39ee212014-05-03 00:33:28 +000056 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000057
Reid Kleckner37abaca2014-05-09 22:46:15 +000058 bool isSRetParameterAfterThis() const override { return true; }
59
John McCall7f416cc2015-09-08 08:05:57 +000060 bool isThisCompleteObject(GlobalDecl GD) const override {
61 // The Microsoft ABI doesn't use separate complete-object vs.
62 // base-object variants of constructors, but it does of destructors.
63 if (isa<CXXDestructorDecl>(GD.getDecl())) {
64 switch (GD.getDtorType()) {
65 case Dtor_Complete:
66 case Dtor_Deleting:
67 return true;
68
69 case Dtor_Base:
70 return false;
71
72 case Dtor_Comdat: llvm_unreachable("emitting dtor comdat as function?");
73 }
74 llvm_unreachable("bad dtor kind");
75 }
76
77 // No other kinds.
78 return false;
79 }
80
David Majnemer196ac332014-09-11 23:05:02 +000081 size_t getSrcArgforCopyCtor(const CXXConstructorDecl *CD,
82 FunctionArgList &Args) const override {
83 assert(Args.size() >= 2 &&
84 "expected the arglist to have at least two args!");
85 // The 'most_derived' parameter goes second if the ctor is variadic and
86 // has v-bases.
87 if (CD->getParent()->getNumVBases() > 0 &&
88 CD->getType()->castAs<FunctionProtoType>()->isVariadic())
89 return 2;
90 return 1;
91 }
92
David Majnemer8671c6e2015-11-02 09:01:44 +000093 std::vector<CharUnits> getVBPtrOffsets(const CXXRecordDecl *RD) override {
94 std::vector<CharUnits> VBPtrOffsets;
95 const ASTContext &Context = getContext();
96 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
97
98 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
99 for (const VPtrInfo *VBT : *VBGlobals.VBTables) {
100 const ASTRecordLayout &SubobjectLayout =
101 Context.getASTRecordLayout(VBT->BaseWithVPtr);
102 CharUnits Offs = VBT->NonVirtualOffset;
103 Offs += SubobjectLayout.getVBPtrOffset();
104 if (VBT->getVBaseWithVPtr())
105 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
106 VBPtrOffsets.push_back(Offs);
107 }
108 llvm::array_pod_sort(VBPtrOffsets.begin(), VBPtrOffsets.end());
109 return VBPtrOffsets;
110 }
111
Craig Topper4f12f102014-03-12 06:41:41 +0000112 StringRef GetPureVirtualCallName() override { return "_purecall"; }
Craig Topper4f12f102014-03-12 06:41:41 +0000113 StringRef GetDeletedVirtualCallName() override { return "_purecall"; }
Joao Matos2ce88ef2012-07-17 17:10:11 +0000114
David Majnemer08681372014-11-01 07:37:17 +0000115 void emitVirtualObjectDelete(CodeGenFunction &CGF, const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000116 Address Ptr, QualType ElementType,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000117 const CXXDestructorDecl *Dtor) override;
John McCall82fb8922012-09-25 10:10:39 +0000118
Chandler Carruth4b9e8572014-11-25 08:59:34 +0000119 void emitRethrow(CodeGenFunction &CGF, bool isNoReturn) override;
David Majnemer7c237072015-03-05 00:46:22 +0000120 void emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) override;
David Majnemer442d0a22014-11-25 07:20:20 +0000121
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000122 void emitBeginCatch(CodeGenFunction &CGF, const CXXCatchStmt *C) override;
123
David Majnemere2cb8d12014-07-07 06:20:47 +0000124 llvm::GlobalVariable *getMSCompleteObjectLocator(const CXXRecordDecl *RD,
125 const VPtrInfo *Info);
126
David Majnemer443250f2015-03-17 20:35:00 +0000127 llvm::Constant *getAddrOfRTTIDescriptor(QualType Ty) override;
Reid Kleckner10aa7702015-09-16 20:15:55 +0000128 CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +0000129 getAddrOfCXXCatchHandlerType(QualType Ty, QualType CatchHandlerType) override;
David Majnemere2cb8d12014-07-07 06:20:47 +0000130
Reid Kleckner10aa7702015-09-16 20:15:55 +0000131 /// MSVC needs an extra flag to indicate a catchall.
132 CatchTypeInfo getCatchAllTypeInfo() override {
133 return CatchTypeInfo{nullptr, 0x40};
134 }
135
David Majnemer1162d252014-06-22 19:05:33 +0000136 bool shouldTypeidBeNullChecked(bool IsDeref, QualType SrcRecordTy) override;
137 void EmitBadTypeidCall(CodeGenFunction &CGF) override;
138 llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000139 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000140 llvm::Type *StdTypeInfoPtrTy) override;
141
142 bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
143 QualType SrcRecordTy) override;
144
John McCall7f416cc2015-09-08 08:05:57 +0000145 llvm::Value *EmitDynamicCastCall(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000146 QualType SrcRecordTy, QualType DestTy,
147 QualType DestRecordTy,
148 llvm::BasicBlock *CastEnd) override;
149
John McCall7f416cc2015-09-08 08:05:57 +0000150 llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000151 QualType SrcRecordTy,
152 QualType DestTy) override;
153
154 bool EmitBadCastCall(CodeGenFunction &CGF) override;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000155 bool canSpeculativelyEmitVTable(const CXXRecordDecl *RD) const override {
Piotr Padlewskia68a7872015-07-24 04:04:49 +0000156 return false;
157 }
David Majnemer1162d252014-06-22 19:05:33 +0000158
Craig Topper4f12f102014-03-12 06:41:41 +0000159 llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +0000160 GetVirtualBaseClassOffset(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000161 const CXXRecordDecl *ClassDecl,
162 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000163
Craig Topper4f12f102014-03-12 06:41:41 +0000164 llvm::BasicBlock *
165 EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
166 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000167
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000168 void initializeHiddenVirtualInheritanceMembers(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000169 const CXXRecordDecl *RD) override;
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000170
Craig Topper4f12f102014-03-12 06:41:41 +0000171 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000172
Reid Klecknere7de47e2013-07-22 13:51:44 +0000173 // Background on MSVC destructors
174 // ==============================
175 //
176 // Both Itanium and MSVC ABIs have destructor variants. The variant names
177 // roughly correspond in the following way:
178 // Itanium Microsoft
179 // Base -> no name, just ~Class
180 // Complete -> vbase destructor
181 // Deleting -> scalar deleting destructor
182 // vector deleting destructor
183 //
184 // The base and complete destructors are the same as in Itanium, although the
185 // complete destructor does not accept a VTT parameter when there are virtual
186 // bases. A separate mechanism involving vtordisps is used to ensure that
187 // virtual methods of destroyed subobjects are not called.
188 //
189 // The deleting destructors accept an i32 bitfield as a second parameter. Bit
190 // 1 indicates if the memory should be deleted. Bit 2 indicates if the this
191 // pointer points to an array. The scalar deleting destructor assumes that
192 // bit 2 is zero, and therefore does not contain a loop.
193 //
194 // For virtual destructors, only one entry is reserved in the vftable, and it
195 // always points to the vector deleting destructor. The vector deleting
196 // destructor is the most general, so it can be used to destroy objects in
197 // place, delete single heap objects, or delete arrays.
198 //
199 // A TU defining a non-inline destructor is only guaranteed to emit a base
200 // destructor, and all of the other variants are emitted on an as-needed basis
201 // in COMDATs. Because a non-base destructor can be emitted in a TU that
202 // lacks a definition for the destructor, non-base destructors must always
203 // delegate to or alias the base destructor.
204
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000205 void buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
206 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000207
Reid Klecknere7de47e2013-07-22 13:51:44 +0000208 /// Non-base dtors should be emitted as delegating thunks in this ABI.
209 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000210 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000211 return DT != Dtor_Base;
212 }
213
Craig Topper4f12f102014-03-12 06:41:41 +0000214 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000215
Craig Topper4f12f102014-03-12 06:41:41 +0000216 const CXXRecordDecl *
217 getThisArgumentTypeForMethod(const CXXMethodDecl *MD) override {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000218 MD = MD->getCanonicalDecl();
219 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD)) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000220 MicrosoftVTableContext::MethodVFTableLocation ML =
221 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000222 // The vbases might be ordered differently in the final overrider object
223 // and the complete object, so the "this" argument may sometimes point to
224 // memory that has no particular type (e.g. past the complete object).
225 // In this case, we just use a generic pointer type.
226 // FIXME: might want to have a more precise type in the non-virtual
227 // multiple inheritance case.
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +0000228 if (ML.VBase || !ML.VFPtrOffset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000229 return nullptr;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000230 }
231 return MD->getParent();
232 }
233
John McCall7f416cc2015-09-08 08:05:57 +0000234 Address
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000235 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD,
John McCall7f416cc2015-09-08 08:05:57 +0000236 Address This,
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000237 bool VirtualCall) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000238
Reid Kleckner89077a12013-12-17 19:46:40 +0000239 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000240 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000241
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000242 llvm::Value *adjustThisParameterInVirtualFunctionPrologue(
Craig Topper4f12f102014-03-12 06:41:41 +0000243 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000244
Craig Topper4f12f102014-03-12 06:41:41 +0000245 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall29036752011-01-27 02:46:02 +0000246
Reid Kleckner89077a12013-12-17 19:46:40 +0000247 unsigned addImplicitConstructorArgs(CodeGenFunction &CGF,
248 const CXXConstructorDecl *D,
249 CXXCtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000250 bool Delegating,
251 CallArgList &Args) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000252
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000253 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
254 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +0000255 bool Delegating, Address This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000256
Peter Collingbourned9546012015-06-19 02:30:43 +0000257 void emitVTableBitSetEntries(VPtrInfo *Info, const CXXRecordDecl *RD,
258 llvm::GlobalVariable *VTable);
259
Craig Topper4f12f102014-03-12 06:41:41 +0000260 void emitVTableDefinitions(CodeGenVTables &CGVT,
261 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000262
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000263 bool isVirtualOffsetNeededForVTableField(CodeGenFunction &CGF,
264 CodeGenFunction::VPtr Vptr) override;
265
266 /// Don't initialize vptrs if dynamic class
267 /// is marked with with the 'novtable' attribute.
268 bool doStructorsInitializeVPtrs(const CXXRecordDecl *VTableClass) override {
269 return !VTableClass->hasAttr<MSNoVTableAttr>();
270 }
271
272 llvm::Constant *
273 getVTableAddressPoint(BaseSubobject Base,
274 const CXXRecordDecl *VTableClass) override;
275
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000276 llvm::Value *getVTableAddressPointInStructor(
277 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000278 BaseSubobject Base, const CXXRecordDecl *NearestVBase) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000279
280 llvm::Constant *
281 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000282 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000283
284 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000285 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000286
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000287 llvm::Value *getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
John McCall7f416cc2015-09-08 08:05:57 +0000288 Address This, llvm::Type *Ty,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +0000289 SourceLocation Loc) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000290
David Majnemer0c0b6d92014-10-31 20:09:12 +0000291 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF,
292 const CXXDestructorDecl *Dtor,
293 CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +0000294 Address This,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000295 const CXXMemberCallExpr *CE) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000296
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000297 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000298 CallArgList &CallArgs) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000299 assert(GD.getDtorType() == Dtor_Deleting &&
300 "Only deleting destructor thunks are available in this ABI");
301 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)),
David Majnemer9ced3dd2015-03-14 23:44:48 +0000302 getContext().IntTy);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000303 }
304
Craig Topper4f12f102014-03-12 06:41:41 +0000305 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000306
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000307 llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000308 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000309 llvm::GlobalVariable::LinkageTypes Linkage);
310
David Majnemerc1709d32015-06-23 07:31:11 +0000311 llvm::GlobalVariable *
312 getAddrOfVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
313 const CXXRecordDecl *DstRD) {
314 SmallString<256> OutName;
315 llvm::raw_svector_ostream Out(OutName);
316 getMangleContext().mangleCXXVirtualDisplacementMap(SrcRD, DstRD, Out);
David Majnemerc1709d32015-06-23 07:31:11 +0000317 StringRef MangledName = OutName.str();
318
319 if (auto *VDispMap = CGM.getModule().getNamedGlobal(MangledName))
320 return VDispMap;
321
322 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
323 unsigned NumEntries = 1 + SrcRD->getNumVBases();
324 SmallVector<llvm::Constant *, 4> Map(NumEntries,
325 llvm::UndefValue::get(CGM.IntTy));
326 Map[0] = llvm::ConstantInt::get(CGM.IntTy, 0);
327 bool AnyDifferent = false;
328 for (const auto &I : SrcRD->vbases()) {
329 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
330 if (!DstRD->isVirtuallyDerivedFrom(VBase))
331 continue;
332
333 unsigned SrcVBIndex = VTContext.getVBTableIndex(SrcRD, VBase);
334 unsigned DstVBIndex = VTContext.getVBTableIndex(DstRD, VBase);
335 Map[SrcVBIndex] = llvm::ConstantInt::get(CGM.IntTy, DstVBIndex * 4);
336 AnyDifferent |= SrcVBIndex != DstVBIndex;
337 }
338 // This map would be useless, don't use it.
339 if (!AnyDifferent)
340 return nullptr;
341
342 llvm::ArrayType *VDispMapTy = llvm::ArrayType::get(CGM.IntTy, Map.size());
343 llvm::Constant *Init = llvm::ConstantArray::get(VDispMapTy, Map);
344 llvm::GlobalValue::LinkageTypes Linkage =
345 SrcRD->isExternallyVisible() && DstRD->isExternallyVisible()
346 ? llvm::GlobalValue::LinkOnceODRLinkage
347 : llvm::GlobalValue::InternalLinkage;
348 auto *VDispMap = new llvm::GlobalVariable(
349 CGM.getModule(), VDispMapTy, /*Constant=*/true, Linkage,
350 /*Initializer=*/Init, MangledName);
351 return VDispMap;
352 }
353
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000354 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000355 llvm::GlobalVariable *GV) const;
356
Hans Wennborgc94391d2014-06-06 20:04:01 +0000357 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
358 GlobalDecl GD, bool ReturnAdjustment) override {
Hans Wennborg853ae942014-05-30 16:59:42 +0000359 // Never dllimport/dllexport thunks.
360 Thunk->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
Hans Wennborgc94391d2014-06-06 20:04:01 +0000361
362 GVALinkage Linkage =
363 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
364
365 if (Linkage == GVA_Internal)
366 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
367 else if (ReturnAdjustment)
368 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
369 else
370 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000371 }
372
John McCall7f416cc2015-09-08 08:05:57 +0000373 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000374 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000375
John McCall7f416cc2015-09-08 08:05:57 +0000376 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000377 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000378
David Majnemerb3341ea2014-10-05 05:05:40 +0000379 void EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +0000380 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +0000381 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +0000382 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000383
384 bool usesThreadWrapperFunction() const override { return false; }
385 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
386 QualType LValType) override;
387
John McCallc84ed6a2012-05-01 06:13:13 +0000388 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
389 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000390 bool PerformInit) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000391 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
392 llvm::Constant *Dtor, llvm::Constant *Addr) override;
John McCallc84ed6a2012-05-01 06:13:13 +0000393
John McCall29036752011-01-27 02:46:02 +0000394 // ==== Notes on array cookies =========
395 //
396 // MSVC seems to only use cookies when the class has a destructor; a
397 // two-argument usual array deallocation function isn't sufficient.
398 //
399 // For example, this code prints "100" and "1":
400 // struct A {
401 // char x;
402 // void *operator new[](size_t sz) {
403 // printf("%u\n", sz);
404 // return malloc(sz);
405 // }
406 // void operator delete[](void *p, size_t sz) {
407 // printf("%u\n", sz);
408 // free(p);
409 // }
410 // };
411 // int main() {
412 // A *p = new A[100];
413 // delete[] p;
414 // }
415 // Whereas it prints "104" and "104" if you give A a destructor.
John McCallb91cd662012-05-01 05:23:51 +0000416
Craig Topper4f12f102014-03-12 06:41:41 +0000417 bool requiresArrayCookie(const CXXDeleteExpr *expr,
418 QualType elementType) override;
419 bool requiresArrayCookie(const CXXNewExpr *expr) override;
420 CharUnits getArrayCookieSizeImpl(QualType type) override;
John McCall7f416cc2015-09-08 08:05:57 +0000421 Address InitializeArrayCookie(CodeGenFunction &CGF,
422 Address NewPtr,
423 llvm::Value *NumElements,
424 const CXXNewExpr *expr,
425 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000426 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000427 Address allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000428 CharUnits cookieSize) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000429
David Majnemer611cdb92014-07-07 08:09:15 +0000430 friend struct MSRTTIBuilder;
431
432 bool isImageRelative() const {
433 return CGM.getTarget().getPointerWidth(/*AddressSpace=*/0) == 64;
434 }
435
436 // 5 routines for constructing the llvm types for MS RTTI structs.
437 llvm::StructType *getTypeDescriptorType(StringRef TypeInfoString) {
438 llvm::SmallString<32> TDTypeName("rtti.TypeDescriptor");
439 TDTypeName += llvm::utostr(TypeInfoString.size());
440 llvm::StructType *&TypeDescriptorType =
441 TypeDescriptorTypeMap[TypeInfoString.size()];
442 if (TypeDescriptorType)
443 return TypeDescriptorType;
444 llvm::Type *FieldTypes[] = {
445 CGM.Int8PtrPtrTy,
446 CGM.Int8PtrTy,
447 llvm::ArrayType::get(CGM.Int8Ty, TypeInfoString.size() + 1)};
448 TypeDescriptorType =
449 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, TDTypeName);
450 return TypeDescriptorType;
451 }
452
453 llvm::Type *getImageRelativeType(llvm::Type *PtrType) {
454 if (!isImageRelative())
455 return PtrType;
456 return CGM.IntTy;
457 }
458
459 llvm::StructType *getBaseClassDescriptorType() {
460 if (BaseClassDescriptorType)
461 return BaseClassDescriptorType;
462 llvm::Type *FieldTypes[] = {
463 getImageRelativeType(CGM.Int8PtrTy),
464 CGM.IntTy,
465 CGM.IntTy,
466 CGM.IntTy,
467 CGM.IntTy,
468 CGM.IntTy,
469 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
470 };
471 BaseClassDescriptorType = llvm::StructType::create(
472 CGM.getLLVMContext(), FieldTypes, "rtti.BaseClassDescriptor");
473 return BaseClassDescriptorType;
474 }
475
476 llvm::StructType *getClassHierarchyDescriptorType() {
477 if (ClassHierarchyDescriptorType)
478 return ClassHierarchyDescriptorType;
479 // Forward-declare RTTIClassHierarchyDescriptor to break a cycle.
480 ClassHierarchyDescriptorType = llvm::StructType::create(
481 CGM.getLLVMContext(), "rtti.ClassHierarchyDescriptor");
482 llvm::Type *FieldTypes[] = {
483 CGM.IntTy,
484 CGM.IntTy,
485 CGM.IntTy,
486 getImageRelativeType(
487 getBaseClassDescriptorType()->getPointerTo()->getPointerTo()),
488 };
489 ClassHierarchyDescriptorType->setBody(FieldTypes);
490 return ClassHierarchyDescriptorType;
491 }
492
493 llvm::StructType *getCompleteObjectLocatorType() {
494 if (CompleteObjectLocatorType)
495 return CompleteObjectLocatorType;
496 CompleteObjectLocatorType = llvm::StructType::create(
497 CGM.getLLVMContext(), "rtti.CompleteObjectLocator");
498 llvm::Type *FieldTypes[] = {
499 CGM.IntTy,
500 CGM.IntTy,
501 CGM.IntTy,
502 getImageRelativeType(CGM.Int8PtrTy),
503 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
504 getImageRelativeType(CompleteObjectLocatorType),
505 };
506 llvm::ArrayRef<llvm::Type *> FieldTypesRef(FieldTypes);
507 if (!isImageRelative())
508 FieldTypesRef = FieldTypesRef.drop_back();
509 CompleteObjectLocatorType->setBody(FieldTypesRef);
510 return CompleteObjectLocatorType;
511 }
512
513 llvm::GlobalVariable *getImageBase() {
514 StringRef Name = "__ImageBase";
515 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name))
516 return GV;
517
518 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8Ty,
519 /*isConstant=*/true,
520 llvm::GlobalValue::ExternalLinkage,
521 /*Initializer=*/nullptr, Name);
522 }
523
524 llvm::Constant *getImageRelativeConstant(llvm::Constant *PtrVal) {
525 if (!isImageRelative())
526 return PtrVal;
527
David Majnemer7c237072015-03-05 00:46:22 +0000528 if (PtrVal->isNullValue())
529 return llvm::Constant::getNullValue(CGM.IntTy);
530
David Majnemer611cdb92014-07-07 08:09:15 +0000531 llvm::Constant *ImageBaseAsInt =
532 llvm::ConstantExpr::getPtrToInt(getImageBase(), CGM.IntPtrTy);
533 llvm::Constant *PtrValAsInt =
534 llvm::ConstantExpr::getPtrToInt(PtrVal, CGM.IntPtrTy);
535 llvm::Constant *Diff =
536 llvm::ConstantExpr::getSub(PtrValAsInt, ImageBaseAsInt,
537 /*HasNUW=*/true, /*HasNSW=*/true);
538 return llvm::ConstantExpr::getTrunc(Diff, CGM.IntTy);
539 }
540
Reid Kleckner407e8b62013-03-22 19:02:54 +0000541private:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000542 MicrosoftMangleContext &getMangleContext() {
543 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext());
544 }
545
Reid Kleckner2341ae32013-04-11 18:13:19 +0000546 llvm::Constant *getZeroInt() {
547 return llvm::ConstantInt::get(CGM.IntTy, 0);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000548 }
549
Reid Kleckner2341ae32013-04-11 18:13:19 +0000550 llvm::Constant *getAllOnesInt() {
551 return llvm::Constant::getAllOnesValue(CGM.IntTy);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000552 }
553
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000554 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD);
555
Reid Kleckner2341ae32013-04-11 18:13:19 +0000556 void
557 GetNullMemberPointerFields(const MemberPointerType *MPT,
558 llvm::SmallVectorImpl<llvm::Constant *> &fields);
559
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000560 /// \brief Shared code for virtual base adjustment. Returns the offset from
561 /// the vbptr to the virtual base. Optionally returns the address of the
562 /// vbptr itself.
563 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000564 Address Base,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000565 llvm::Value *VBPtrOffset,
566 llvm::Value *VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000567 llvm::Value **VBPtr = nullptr);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000568
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000569 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000570 Address Base,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000571 int32_t VBPtrOffset,
572 int32_t VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000573 llvm::Value **VBPtr = nullptr) {
Reid Kleckner0ba8ba42014-10-22 17:26:00 +0000574 assert(VBTableOffset % 4 == 0 && "should be byte offset into table of i32s");
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000575 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
576 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset);
577 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr);
578 }
579
John McCall7f416cc2015-09-08 08:05:57 +0000580 std::pair<Address, llvm::Value *>
581 performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000582 QualType SrcRecordTy);
583
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000584 /// \brief Performs a full virtual base adjustment. Used to dereference
585 /// pointers to members of virtual bases.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000586 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000587 const CXXRecordDecl *RD, Address Base,
Reid Kleckner2341ae32013-04-11 18:13:19 +0000588 llvm::Value *VirtualBaseAdjustmentOffset,
589 llvm::Value *VBPtrOffset /* optional */);
590
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000591 /// \brief Emits a full member pointer with the fields common to data and
592 /// function member pointers.
593 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField,
594 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +0000595 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +0000596 CharUnits NonVirtualBaseAdjustment,
597 unsigned VBTableIndex);
Reid Kleckner452abac2013-05-09 21:01:17 +0000598
Reid Kleckner452abac2013-05-09 21:01:17 +0000599 bool MemberPointerConstantIsNull(const MemberPointerType *MPT,
600 llvm::Constant *MP);
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000601
Reid Kleckner7810af02013-06-19 15:20:38 +0000602 /// \brief - Initialize all vbptrs of 'this' with RD as the complete type.
603 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
604
605 /// \brief Caching wrapper around VBTableBuilder::enumerateVBTables().
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000606 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000607
Hans Wennborg88497d62013-11-15 17:24:45 +0000608 /// \brief Generate a thunk for calling a virtual member function MD.
Reid Klecknere4a52202014-02-21 02:27:32 +0000609 llvm::Function *EmitVirtualMemPtrThunk(
610 const CXXMethodDecl *MD,
611 const MicrosoftVTableContext::MethodVFTableLocation &ML);
Hans Wennborg88497d62013-11-15 17:24:45 +0000612
Reid Kleckner407e8b62013-03-22 19:02:54 +0000613public:
Craig Topper4f12f102014-03-12 06:41:41 +0000614 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000615
Craig Topper4f12f102014-03-12 06:41:41 +0000616 bool isZeroInitializable(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000617
David Majnemerb3e56542014-08-07 22:56:13 +0000618 bool isMemberPointerConvertible(const MemberPointerType *MPT) const override {
619 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemer99281062014-09-18 22:05:54 +0000620 return RD->hasAttr<MSInheritanceAttr>();
621 }
622
Craig Topper4f12f102014-03-12 06:41:41 +0000623 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000624
Craig Topper4f12f102014-03-12 06:41:41 +0000625 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
626 CharUnits offset) override;
David Majnemere2be95b2015-06-23 07:31:01 +0000627 llvm::Constant *EmitMemberFunctionPointer(const CXXMethodDecl *MD) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000628 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000629
Craig Topper4f12f102014-03-12 06:41:41 +0000630 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
631 llvm::Value *L,
632 llvm::Value *R,
633 const MemberPointerType *MPT,
634 bool Inequality) override;
Reid Kleckner700c3ee2013-04-30 20:15:14 +0000635
Craig Topper4f12f102014-03-12 06:41:41 +0000636 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
637 llvm::Value *MemPtr,
638 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000639
Craig Topper4f12f102014-03-12 06:41:41 +0000640 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000641 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000642 Address Base, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000643 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000644
David Majnemer0d9ad682015-06-29 00:06:50 +0000645 llvm::Value *EmitNonNullMemberPointerConversion(
646 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
647 CastKind CK, CastExpr::path_const_iterator PathBegin,
648 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
649 CGBuilderTy &Builder);
650
Craig Topper4f12f102014-03-12 06:41:41 +0000651 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
652 const CastExpr *E,
653 llvm::Value *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000654
Craig Topper4f12f102014-03-12 06:41:41 +0000655 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
656 llvm::Constant *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000657
David Majnemer5ca193c2015-06-23 07:31:07 +0000658 llvm::Constant *EmitMemberPointerConversion(
659 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
660 CastKind CK, CastExpr::path_const_iterator PathBegin,
661 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src);
662
Craig Topper4f12f102014-03-12 06:41:41 +0000663 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000664 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000665 Address This, llvm::Value *&ThisPtrForCall,
666 llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000667 const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000668
Rafael Espindola91f68b42014-09-15 19:20:10 +0000669 void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) override;
670
David Majnemer7c237072015-03-05 00:46:22 +0000671 llvm::StructType *getCatchableTypeType() {
672 if (CatchableTypeType)
673 return CatchableTypeType;
674 llvm::Type *FieldTypes[] = {
675 CGM.IntTy, // Flags
676 getImageRelativeType(CGM.Int8PtrTy), // TypeDescriptor
677 CGM.IntTy, // NonVirtualAdjustment
678 CGM.IntTy, // OffsetToVBPtr
679 CGM.IntTy, // VBTableIndex
680 CGM.IntTy, // Size
681 getImageRelativeType(CGM.Int8PtrTy) // CopyCtor
682 };
683 CatchableTypeType = llvm::StructType::create(
684 CGM.getLLVMContext(), FieldTypes, "eh.CatchableType");
685 return CatchableTypeType;
686 }
687
688 llvm::StructType *getCatchableTypeArrayType(uint32_t NumEntries) {
689 llvm::StructType *&CatchableTypeArrayType =
690 CatchableTypeArrayTypeMap[NumEntries];
691 if (CatchableTypeArrayType)
692 return CatchableTypeArrayType;
693
694 llvm::SmallString<23> CTATypeName("eh.CatchableTypeArray.");
695 CTATypeName += llvm::utostr(NumEntries);
696 llvm::Type *CTType =
697 getImageRelativeType(getCatchableTypeType()->getPointerTo());
698 llvm::Type *FieldTypes[] = {
699 CGM.IntTy, // NumEntries
700 llvm::ArrayType::get(CTType, NumEntries) // CatchableTypes
701 };
702 CatchableTypeArrayType =
703 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, CTATypeName);
704 return CatchableTypeArrayType;
705 }
706
707 llvm::StructType *getThrowInfoType() {
708 if (ThrowInfoType)
709 return ThrowInfoType;
710 llvm::Type *FieldTypes[] = {
711 CGM.IntTy, // Flags
712 getImageRelativeType(CGM.Int8PtrTy), // CleanupFn
713 getImageRelativeType(CGM.Int8PtrTy), // ForwardCompat
714 getImageRelativeType(CGM.Int8PtrTy) // CatchableTypeArray
715 };
716 ThrowInfoType = llvm::StructType::create(CGM.getLLVMContext(), FieldTypes,
717 "eh.ThrowInfo");
718 return ThrowInfoType;
719 }
720
721 llvm::Constant *getThrowFn() {
722 // _CxxThrowException is passed an exception object and a ThrowInfo object
723 // which describes the exception.
724 llvm::Type *Args[] = {CGM.Int8PtrTy, getThrowInfoType()->getPointerTo()};
725 llvm::FunctionType *FTy =
726 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
727 auto *Fn = cast<llvm::Function>(
728 CGM.CreateRuntimeFunction(FTy, "_CxxThrowException"));
729 // _CxxThrowException is stdcall on 32-bit x86 platforms.
730 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::x86)
731 Fn->setCallingConv(llvm::CallingConv::X86_StdCall);
732 return Fn;
733 }
734
David Majnemer37fd66e2015-03-13 22:36:55 +0000735 llvm::Function *getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
736 CXXCtorType CT);
David Majnemerdfa6d202015-03-11 18:36:39 +0000737
David Majnemer7c237072015-03-05 00:46:22 +0000738 llvm::Constant *getCatchableType(QualType T,
739 uint32_t NVOffset = 0,
740 int32_t VBPtrOffset = -1,
741 uint32_t VBIndex = 0);
742
743 llvm::GlobalVariable *getCatchableTypeArray(QualType T);
744
David Majnemerba3e5ec2015-03-13 18:26:17 +0000745 llvm::GlobalVariable *getThrowInfo(QualType T) override;
David Majnemer7c237072015-03-05 00:46:22 +0000746
Reid Kleckner7810af02013-06-19 15:20:38 +0000747private:
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000748 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy;
David Majnemerd905da42014-07-01 20:30:31 +0000749 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy;
750 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000751 /// \brief All the vftables that have been referenced.
752 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000753 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000754
755 /// \brief This set holds the record decls we've deferred vtable emission for.
756 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
757
758
759 /// \brief All the vbtables which have been referenced.
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000760 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap;
Reid Klecknerd8110b62013-09-10 20:14:30 +0000761
762 /// Info on the global variable used to guard initialization of static locals.
763 /// The BitIndex field is only used for externally invisible declarations.
764 struct GuardInfo {
Craig Topper8a13c412014-05-21 05:09:00 +0000765 GuardInfo() : Guard(nullptr), BitIndex(0) {}
Reid Klecknerd8110b62013-09-10 20:14:30 +0000766 llvm::GlobalVariable *Guard;
767 unsigned BitIndex;
768 };
769
770 /// Map from DeclContext to the current guard variable. We assume that the
771 /// AST is visited in source code order.
772 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap;
David Majnemerec8e54b2015-05-07 21:19:06 +0000773 llvm::DenseMap<const DeclContext *, GuardInfo> ThreadLocalGuardVariableMap;
David Majnemer8354eee2015-05-07 06:15:46 +0000774 llvm::DenseMap<const DeclContext *, unsigned> ThreadSafeGuardNumMap;
David Majnemer611cdb92014-07-07 08:09:15 +0000775
776 llvm::DenseMap<size_t, llvm::StructType *> TypeDescriptorTypeMap;
777 llvm::StructType *BaseClassDescriptorType;
778 llvm::StructType *ClassHierarchyDescriptorType;
779 llvm::StructType *CompleteObjectLocatorType;
David Majnemer7c237072015-03-05 00:46:22 +0000780
781 llvm::DenseMap<QualType, llvm::GlobalVariable *> CatchableTypeArrays;
782
783 llvm::StructType *CatchableTypeType;
784 llvm::DenseMap<uint32_t, llvm::StructType *> CatchableTypeArrayTypeMap;
785 llvm::StructType *ThrowInfoType;
Charles Davis74ce8592010-06-09 23:25:41 +0000786};
787
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000788}
Charles Davis74ce8592010-06-09 23:25:41 +0000789
Reid Klecknere39ee212014-05-03 00:33:28 +0000790CGCXXABI::RecordArgABI
791MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const {
792 switch (CGM.getTarget().getTriple().getArch()) {
793 default:
794 // FIXME: Implement for other architectures.
795 return RAA_Default;
796
797 case llvm::Triple::x86:
Reid Klecknercf87e102014-05-14 16:02:09 +0000798 // All record arguments are passed in memory on x86. Decide whether to
799 // construct the object directly in argument memory, or to construct the
800 // argument elsewhere and copy the bytes during the call.
801
802 // If C++ prohibits us from making a copy, construct the arguments directly
803 // into argument memory.
804 if (!canCopyArgument(RD))
Reid Klecknere39ee212014-05-03 00:33:28 +0000805 return RAA_DirectInMemory;
Reid Klecknercf87e102014-05-14 16:02:09 +0000806
807 // Otherwise, construct the argument into a temporary and copy the bytes
808 // into the outgoing argument memory.
Reid Klecknere39ee212014-05-03 00:33:28 +0000809 return RAA_Default;
810
811 case llvm::Triple::x86_64:
812 // Win64 passes objects with non-trivial copy ctors indirectly.
813 if (RD->hasNonTrivialCopyConstructor())
814 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000815
Reid Kleckner80944df2014-10-31 22:00:51 +0000816 // If an object has a destructor, we'd really like to pass it indirectly
817 // because it allows us to elide copies. Unfortunately, MSVC makes that
818 // impossible for small types, which it will pass in a single register or
819 // stack slot. Most objects with dtors are large-ish, so handle that early.
820 // We can't call out all large objects as being indirect because there are
821 // multiple x64 calling conventions and the C++ ABI code shouldn't dictate
822 // how we pass large POD types.
823 if (RD->hasNonTrivialDestructor() &&
824 getContext().getTypeSize(RD->getTypeForDecl()) > 64)
Reid Klecknere39ee212014-05-03 00:33:28 +0000825 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000826
827 // We have a trivial copy constructor or no copy constructors, but we have
828 // to make sure it isn't deleted.
829 bool CopyDeleted = false;
830 for (const CXXConstructorDecl *CD : RD->ctors()) {
831 if (CD->isCopyConstructor()) {
832 assert(CD->isTrivial());
833 // We had at least one undeleted trivial copy ctor. Return directly.
834 if (!CD->isDeleted())
835 return RAA_Default;
836 CopyDeleted = true;
837 }
838 }
839
840 // The trivial copy constructor was deleted. Return indirectly.
841 if (CopyDeleted)
842 return RAA_Indirect;
843
844 // There were no copy ctors. Return in RAX.
Reid Klecknere39ee212014-05-03 00:33:28 +0000845 return RAA_Default;
846 }
847
848 llvm_unreachable("invalid enum");
849}
850
David Majnemer08681372014-11-01 07:37:17 +0000851void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
852 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000853 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +0000854 QualType ElementType,
855 const CXXDestructorDecl *Dtor) {
David Majnemer0c0b6d92014-10-31 20:09:12 +0000856 // FIXME: Provide a source location here even though there's no
857 // CXXMemberCallExpr for dtor call.
David Majnemer08681372014-11-01 07:37:17 +0000858 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000859 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
860 llvm::Value *MDThis =
861 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr);
862 if (UseGlobalDelete)
David Majnemer08681372014-11-01 07:37:17 +0000863 CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType);
John McCall82fb8922012-09-25 10:10:39 +0000864}
865
David Majnemer442d0a22014-11-25 07:20:20 +0000866void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
David Majnemer7c237072015-03-05 00:46:22 +0000867 llvm::Value *Args[] = {
868 llvm::ConstantPointerNull::get(CGM.Int8PtrTy),
869 llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())};
870 auto *Fn = getThrowFn();
David Majnemer442d0a22014-11-25 07:20:20 +0000871 if (isNoReturn)
872 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args);
873 else
874 CGF.EmitRuntimeCallOrInvoke(Fn, Args);
875}
876
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000877namespace {
Reid Kleckner129552b2015-10-08 01:13:52 +0000878struct CatchRetScope final : EHScopeStack::Cleanup {
David Majnemere888a2f2015-08-15 03:21:08 +0000879 llvm::CatchPadInst *CPI;
880
Reid Kleckner129552b2015-10-08 01:13:52 +0000881 CatchRetScope(llvm::CatchPadInst *CPI) : CPI(CPI) {}
David Majnemere888a2f2015-08-15 03:21:08 +0000882
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000883 void Emit(CodeGenFunction &CGF, Flags flags) override {
Reid Kleckner129552b2015-10-08 01:13:52 +0000884 llvm::BasicBlock *BB = CGF.createBasicBlock("catchret.dest");
885 CGF.Builder.CreateCatchRet(CPI, BB);
886 CGF.EmitBlock(BB);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000887 }
888};
889}
890
891void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF,
892 const CXXCatchStmt *S) {
893 // In the MS ABI, the runtime handles the copy, and the catch handler is
894 // responsible for destruction.
895 VarDecl *CatchParam = S->getExceptionDecl();
David Majnemer4e52d6f2015-12-12 05:39:21 +0000896 llvm::BasicBlock *CatchPadBB = CGF.Builder.GetInsertBlock();
Reid Kleckner129552b2015-10-08 01:13:52 +0000897 llvm::CatchPadInst *CPI =
898 cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
David Majnemer4e52d6f2015-12-12 05:39:21 +0000899 CGF.CurrentFuncletPad = CPI;
Reid Kleckner129552b2015-10-08 01:13:52 +0000900
Reid Kleckner67cf0352015-04-07 00:09:59 +0000901 // If this is a catch-all or the catch parameter is unnamed, we don't need to
902 // emit an alloca to the object.
903 if (!CatchParam || !CatchParam->getDeclName()) {
Reid Kleckner129552b2015-10-08 01:13:52 +0000904 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000905 return;
906 }
907
908 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
Reid Kleckner129552b2015-10-08 01:13:52 +0000909 CPI->setArgOperand(2, var.getObjectAddress(CGF).getPointer());
910 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000911 CGF.EmitAutoVarCleanups(var);
912}
913
John McCall7f416cc2015-09-08 08:05:57 +0000914/// We need to perform a generic polymorphic operation (like a typeid
915/// or a cast), which requires an object with a vfptr. Adjust the
916/// address to point to an object with a vfptr.
917std::pair<Address, llvm::Value *>
918MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000919 QualType SrcRecordTy) {
David Majnemer1162d252014-06-22 19:05:33 +0000920 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
921 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
David Majnemer9ced3dd2015-03-14 23:44:48 +0000922 const ASTContext &Context = getContext();
David Majnemer1162d252014-06-22 19:05:33 +0000923
John McCall7f416cc2015-09-08 08:05:57 +0000924 // If the class itself has a vfptr, great. This check implicitly
925 // covers non-virtual base subobjects: a class with its own virtual
926 // functions would be a candidate to be a primary base.
David Majnemer5bc883f2015-02-27 02:38:02 +0000927 if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
David Majnemer1162d252014-06-22 19:05:33 +0000928 return std::make_pair(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0));
929
John McCall7f416cc2015-09-08 08:05:57 +0000930 // Okay, one of the vbases must have a vfptr, or else this isn't
931 // actually a polymorphic class.
932 const CXXRecordDecl *PolymorphicBase = nullptr;
933 for (auto &Base : SrcDecl->vbases()) {
934 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
935 if (Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr()) {
936 PolymorphicBase = BaseDecl;
937 break;
938 }
939 }
940 assert(PolymorphicBase && "polymorphic class has no apparent vfptr?");
941
942 llvm::Value *Offset =
943 GetVirtualBaseClassOffset(CGF, Value, SrcDecl, PolymorphicBase);
944 llvm::Value *Ptr = CGF.Builder.CreateInBoundsGEP(Value.getPointer(), Offset);
David Majnemer1162d252014-06-22 19:05:33 +0000945 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
John McCall7f416cc2015-09-08 08:05:57 +0000946 CharUnits VBaseAlign =
947 CGF.CGM.getVBaseAlignment(Value.getAlignment(), SrcDecl, PolymorphicBase);
948 return std::make_pair(Address(Ptr, VBaseAlign), Offset);
David Majnemer1162d252014-06-22 19:05:33 +0000949}
950
951bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
952 QualType SrcRecordTy) {
953 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
954 return IsDeref &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000955 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000956}
957
958static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF,
959 llvm::Value *Argument) {
960 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
961 llvm::FunctionType *FTy =
962 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
963 llvm::Value *Args[] = {Argument};
964 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
965 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
966}
967
968void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
969 llvm::CallSite Call =
970 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
971 Call.setDoesNotReturn();
972 CGF.Builder.CreateUnreachable();
973}
974
975llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
976 QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000977 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000978 llvm::Type *StdTypeInfoPtrTy) {
979 llvm::Value *Offset;
980 std::tie(ThisPtr, Offset) = performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +0000981 auto Typeid = emitRTtypeidCall(CGF, ThisPtr.getPointer()).getInstruction();
982 return CGF.Builder.CreateBitCast(Typeid, StdTypeInfoPtrTy);
David Majnemer1162d252014-06-22 19:05:33 +0000983}
984
985bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
986 QualType SrcRecordTy) {
987 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
988 return SrcIsPtr &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000989 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000990}
991
992llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
John McCall7f416cc2015-09-08 08:05:57 +0000993 CodeGenFunction &CGF, Address This, QualType SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +0000994 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
995 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
996
997 llvm::Value *SrcRTTI =
998 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
999 llvm::Value *DestRTTI =
1000 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
1001
1002 llvm::Value *Offset;
John McCall7f416cc2015-09-08 08:05:57 +00001003 std::tie(This, Offset) = performBaseAdjustment(CGF, This, SrcRecordTy);
1004 llvm::Value *ThisPtr = This.getPointer();
David Majnemer1162d252014-06-22 19:05:33 +00001005
1006 // PVOID __RTDynamicCast(
1007 // PVOID inptr,
1008 // LONG VfDelta,
1009 // PVOID SrcType,
1010 // PVOID TargetType,
1011 // BOOL isReference)
1012 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
1013 CGF.Int8PtrTy, CGF.Int32Ty};
1014 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1015 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1016 "__RTDynamicCast");
1017 llvm::Value *Args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001018 ThisPtr, Offset, SrcRTTI, DestRTTI,
David Majnemer1162d252014-06-22 19:05:33 +00001019 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
John McCall7f416cc2015-09-08 08:05:57 +00001020 ThisPtr = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction();
1021 return CGF.Builder.CreateBitCast(ThisPtr, DestLTy);
David Majnemer1162d252014-06-22 19:05:33 +00001022}
1023
1024llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00001025MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +00001026 QualType SrcRecordTy,
1027 QualType DestTy) {
1028 llvm::Value *Offset;
1029 std::tie(Value, Offset) = performBaseAdjustment(CGF, Value, SrcRecordTy);
1030
1031 // PVOID __RTCastToVoid(
1032 // PVOID inptr)
1033 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
1034 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1035 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1036 "__RTCastToVoid");
John McCall7f416cc2015-09-08 08:05:57 +00001037 llvm::Value *Args[] = {Value.getPointer()};
David Majnemer1162d252014-06-22 19:05:33 +00001038 return CGF.EmitRuntimeCall(Function, Args);
1039}
1040
1041bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
1042 return false;
1043}
1044
David Majnemerca32f932014-09-01 18:50:02 +00001045llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
John McCall7f416cc2015-09-08 08:05:57 +00001046 CodeGenFunction &CGF, Address This, const CXXRecordDecl *ClassDecl,
David Majnemerca32f932014-09-01 18:50:02 +00001047 const CXXRecordDecl *BaseClassDecl) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001048 const ASTContext &Context = getContext();
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00001049 int64_t VBPtrChars =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001050 Context.getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001051 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
David Majnemer9ced3dd2015-03-14 23:44:48 +00001052 CharUnits IntSize = Context.getTypeSizeInChars(Context.IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001053 CharUnits VBTableChars =
1054 IntSize *
1055 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001056 llvm::Value *VBTableOffset =
David Majnemerca32f932014-09-01 18:50:02 +00001057 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001058
1059 llvm::Value *VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001060 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001061 VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001062 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001063 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
1064}
1065
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001066bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
1067 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +00001068}
1069
David Majnemer0c0b6d92014-10-31 20:09:12 +00001070static bool isDeletingDtor(GlobalDecl GD) {
1071 return isa<CXXDestructorDecl>(GD.getDecl()) &&
1072 GD.getDtorType() == Dtor_Deleting;
1073}
1074
1075bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const {
1076 return isDeletingDtor(GD);
1077}
1078
Reid Kleckner40ca9132014-05-13 22:05:45 +00001079bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
1080 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
1081 if (!RD)
1082 return false;
1083
John McCall7f416cc2015-09-08 08:05:57 +00001084 CharUnits Align = CGM.getContext().getTypeAlignInChars(FI.getReturnType());
Reid Kleckner40ca9132014-05-13 22:05:45 +00001085 if (FI.isInstanceMethod()) {
1086 // If it's an instance method, aggregates are always returned indirectly via
1087 // the second parameter.
John McCall7f416cc2015-09-08 08:05:57 +00001088 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001089 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod());
1090 return true;
1091 } else if (!RD->isPOD()) {
1092 // If it's a free function, non-POD types are returned indirectly.
John McCall7f416cc2015-09-08 08:05:57 +00001093 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001094 return true;
1095 }
1096
1097 // Otherwise, use the C ABI rules.
1098 return false;
1099}
1100
Reid Kleckner7810af02013-06-19 15:20:38 +00001101llvm::BasicBlock *
1102MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
1103 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001104 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1105 assert(IsMostDerivedClass &&
1106 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +00001107 llvm::Value *IsCompleteObject =
1108 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001109
1110 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
1111 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
1112 CGF.Builder.CreateCondBr(IsCompleteObject,
1113 CallVbaseCtorsBB, SkipVbaseCtorsBB);
1114
1115 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +00001116
1117 // Fill in the vbtable pointers here.
1118 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001119
1120 // CGF will put the base ctor calls in this basic block for us later.
1121
1122 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +00001123}
1124
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001125void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
1126 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
1127 // In most cases, an override for a vbase virtual method can adjust
1128 // the "this" parameter by applying a constant offset.
1129 // However, this is not enough while a constructor or a destructor of some
1130 // class X is being executed if all the following conditions are met:
1131 // - X has virtual bases, (1)
1132 // - X overrides a virtual method M of a vbase Y, (2)
1133 // - X itself is a vbase of the most derived class.
1134 //
1135 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
1136 // which holds the extra amount of "this" adjustment we must do when we use
1137 // the X vftables (i.e. during X ctor or dtor).
1138 // Outside the ctors and dtors, the values of vtorDisps are zero.
1139
1140 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
1141 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
1142 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
1143 CGBuilderTy &Builder = CGF.Builder;
1144
John McCall7f416cc2015-09-08 08:05:57 +00001145 unsigned AS = getThisAddress(CGF).getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +00001146 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001147
1148 for (VBOffsets::const_iterator I = VBaseMap.begin(), E = VBaseMap.end();
1149 I != E; ++I) {
1150 if (!I->second.hasVtorDisp())
1151 continue;
1152
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +00001153 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00001154 GetVirtualBaseClassOffset(CGF, getThisAddress(CGF), RD, I->first);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001155 // FIXME: it doesn't look right that we SExt in GetVirtualBaseClassOffset()
1156 // just to Trunc back immediately.
1157 VBaseOffset = Builder.CreateTruncOrBitCast(VBaseOffset, CGF.Int32Ty);
1158 uint64_t ConstantVBaseOffset =
1159 Layout.getVBaseClassOffset(I->first).getQuantity();
1160
1161 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
1162 llvm::Value *VtorDispValue = Builder.CreateSub(
1163 VBaseOffset, llvm::ConstantInt::get(CGM.Int32Ty, ConstantVBaseOffset),
1164 "vtordisp.value");
1165
1166 if (!Int8This)
1167 Int8This = Builder.CreateBitCast(getThisValue(CGF),
1168 CGF.Int8Ty->getPointerTo(AS));
1169 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
1170 // vtorDisp is always the 32-bits before the vbase in the class layout.
1171 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
1172 VtorDispPtr = Builder.CreateBitCast(
1173 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
1174
John McCall7f416cc2015-09-08 08:05:57 +00001175 Builder.CreateAlignedStore(VtorDispValue, VtorDispPtr,
1176 CharUnits::fromQuantity(4));
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001177 }
1178}
1179
David Majnemer37fd66e2015-03-13 22:36:55 +00001180static bool hasDefaultCXXMethodCC(ASTContext &Context,
1181 const CXXMethodDecl *MD) {
1182 CallingConv ExpectedCallingConv = Context.getDefaultCallingConvention(
1183 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1184 CallingConv ActualCallingConv =
1185 MD->getType()->getAs<FunctionProtoType>()->getCallConv();
1186 return ExpectedCallingConv == ActualCallingConv;
1187}
1188
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001189void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1190 // There's only one constructor type in this ABI.
1191 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
David Majnemer37fd66e2015-03-13 22:36:55 +00001192
1193 // Exported default constructors either have a simple call-site where they use
1194 // the typical calling convention and have a single 'this' pointer for an
1195 // argument -or- they get a wrapper function which appropriately thunks to the
1196 // real default constructor. This thunk is the default constructor closure.
1197 if (D->hasAttr<DLLExportAttr>() && D->isDefaultConstructor())
1198 if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) {
1199 llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure);
1200 Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage);
1201 Fn->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1202 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001203}
1204
Reid Kleckner7810af02013-06-19 15:20:38 +00001205void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1206 const CXXRecordDecl *RD) {
John McCall7f416cc2015-09-08 08:05:57 +00001207 Address This = getThisAddress(CGF);
1208 This = CGF.Builder.CreateElementBitCast(This, CGM.Int8Ty, "this.int8");
David Majnemer9ced3dd2015-03-14 23:44:48 +00001209 const ASTContext &Context = getContext();
1210 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001211
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001212 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1213 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001214 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001215 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +00001216 const ASTRecordLayout &SubobjectLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001217 Context.getASTRecordLayout(VBT->BaseWithVPtr);
Reid Kleckner5f080942014-01-03 23:42:00 +00001218 CharUnits Offs = VBT->NonVirtualOffset;
1219 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001220 if (VBT->getVBaseWithVPtr())
1221 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
John McCall7f416cc2015-09-08 08:05:57 +00001222 Address VBPtr = CGF.Builder.CreateConstInBoundsByteGEP(This, Offs);
David Blaikie1ed728c2015-04-05 22:45:47 +00001223 llvm::Value *GVPtr =
1224 CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001225 VBPtr = CGF.Builder.CreateElementBitCast(VBPtr, GVPtr->getType(),
Reid Kleckner5f080942014-01-03 23:42:00 +00001226 "vbptr." + VBT->ReusingBase->getName());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001227 CGF.Builder.CreateStore(GVPtr, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +00001228 }
1229}
1230
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001231void
1232MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001233 SmallVectorImpl<CanQualType> &ArgTys) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001234 // TODO: 'for base' flag
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001235 if (T == StructorType::Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001236 // The scalar deleting destructor takes an implicit int parameter.
David Majnemer9ced3dd2015-03-14 23:44:48 +00001237 ArgTys.push_back(getContext().IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001238 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001239 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
1240 if (!CD)
1241 return;
1242
1243 // All parameters are already in place except is_most_derived, which goes
1244 // after 'this' if it's variadic and last if it's not.
1245
1246 const CXXRecordDecl *Class = CD->getParent();
1247 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1248 if (Class->getNumVBases()) {
1249 if (FPT->isVariadic())
David Majnemer9ced3dd2015-03-14 23:44:48 +00001250 ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001251 else
David Majnemer9ced3dd2015-03-14 23:44:48 +00001252 ArgTys.push_back(getContext().IntTy);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001253 }
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001254}
1255
Reid Klecknere7de47e2013-07-22 13:51:44 +00001256void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1257 // The TU defining a dtor is only guaranteed to emit a base destructor. All
1258 // other destructor variants are delegating thunks.
1259 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1260}
1261
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001262CharUnits
1263MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001264 GD = GD.getCanonicalDecl();
1265 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001266
1267 GlobalDecl LookupGD = GD;
1268 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1269 // Complete destructors take a pointer to the complete object as a
1270 // parameter, thus don't need this adjustment.
1271 if (GD.getDtorType() == Dtor_Complete)
1272 return CharUnits();
1273
1274 // There's no Dtor_Base in vftable but it shares the this adjustment with
1275 // the deleting one, so look it up instead.
1276 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1277 }
1278
1279 MicrosoftVTableContext::MethodVFTableLocation ML =
1280 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
1281 CharUnits Adjustment = ML.VFPtrOffset;
1282
1283 // Normal virtual instance methods need to adjust from the vfptr that first
1284 // defined the virtual method to the virtual base subobject, but destructors
1285 // do not. The vector deleting destructor thunk applies this adjustment for
1286 // us if necessary.
1287 if (isa<CXXDestructorDecl>(MD))
1288 Adjustment = CharUnits::Zero();
1289
1290 if (ML.VBase) {
1291 const ASTRecordLayout &DerivedLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001292 getContext().getASTRecordLayout(MD->getParent());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001293 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1294 }
1295
1296 return Adjustment;
1297}
1298
John McCall7f416cc2015-09-08 08:05:57 +00001299Address MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1300 CodeGenFunction &CGF, GlobalDecl GD, Address This,
1301 bool VirtualCall) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001302 if (!VirtualCall) {
1303 // If the call of a virtual function is not virtual, we just have to
1304 // compensate for the adjustment the virtual function does in its prologue.
1305 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1306 if (Adjustment.isZero())
1307 return This;
1308
John McCall7f416cc2015-09-08 08:05:57 +00001309 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001310 assert(Adjustment.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001311 return CGF.Builder.CreateConstByteGEP(This, Adjustment);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001312 }
1313
1314 GD = GD.getCanonicalDecl();
1315 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001316
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001317 GlobalDecl LookupGD = GD;
1318 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1319 // Complete dtors take a pointer to the complete object,
1320 // thus don't need adjustment.
1321 if (GD.getDtorType() == Dtor_Complete)
1322 return This;
1323
1324 // There's only Dtor_Deleting in vftable but it shares the this adjustment
1325 // with the base one, so look up the deleting one instead.
1326 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1327 }
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001328 MicrosoftVTableContext::MethodVFTableLocation ML =
1329 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001330
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001331 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001332
1333 // Base destructors expect 'this' to point to the beginning of the base
1334 // subobject, not the first vfptr that happens to contain the virtual dtor.
1335 // However, we still need to apply the virtual base adjustment.
1336 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1337 StaticOffset = CharUnits::Zero();
1338
John McCall7f416cc2015-09-08 08:05:57 +00001339 Address Result = This;
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001340 if (ML.VBase) {
John McCall7f416cc2015-09-08 08:05:57 +00001341 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
1342
1343 const CXXRecordDecl *Derived = MD->getParent();
1344 const CXXRecordDecl *VBase = ML.VBase;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001345 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00001346 GetVirtualBaseClassOffset(CGF, Result, Derived, VBase);
1347 llvm::Value *VBasePtr =
1348 CGF.Builder.CreateInBoundsGEP(Result.getPointer(), VBaseOffset);
1349 CharUnits VBaseAlign =
1350 CGF.CGM.getVBaseAlignment(Result.getAlignment(), Derived, VBase);
1351 Result = Address(VBasePtr, VBaseAlign);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001352 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001353 if (!StaticOffset.isZero()) {
1354 assert(StaticOffset.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001355 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001356 if (ML.VBase) {
1357 // Non-virtual adjustment might result in a pointer outside the allocated
1358 // object, e.g. if the final overrider class is laid out after the virtual
1359 // base that declares a method in the most derived class.
1360 // FIXME: Update the code that emits this adjustment in thunks prologues.
John McCall7f416cc2015-09-08 08:05:57 +00001361 Result = CGF.Builder.CreateConstByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001362 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001363 Result = CGF.Builder.CreateConstInBoundsByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001364 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001365 }
John McCall7f416cc2015-09-08 08:05:57 +00001366 return Result;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001367}
1368
Reid Kleckner89077a12013-12-17 19:46:40 +00001369void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1370 QualType &ResTy,
1371 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001372 ASTContext &Context = getContext();
1373 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001374 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001375 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1376 ImplicitParamDecl *IsMostDerived
Craig Topper8a13c412014-05-21 05:09:00 +00001377 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001378 CGF.CurGD.getDecl()->getLocation(),
1379 &Context.Idents.get("is_most_derived"),
1380 Context.IntTy);
Reid Kleckner89077a12013-12-17 19:46:40 +00001381 // The 'most_derived' parameter goes second if the ctor is variadic and last
1382 // if it's not. Dtors can't be variadic.
1383 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1384 if (FPT->isVariadic())
1385 Params.insert(Params.begin() + 1, IsMostDerived);
1386 else
1387 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001388 getStructorImplicitParamDecl(CGF) = IsMostDerived;
David Majnemer0c0b6d92014-10-31 20:09:12 +00001389 } else if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001390 ImplicitParamDecl *ShouldDelete
Craig Topper8a13c412014-05-21 05:09:00 +00001391 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001392 CGF.CurGD.getDecl()->getLocation(),
1393 &Context.Idents.get("should_call_delete"),
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001394 Context.IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001395 Params.push_back(ShouldDelete);
1396 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1397 }
John McCall0f999f32012-09-25 08:00:39 +00001398}
1399
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001400llvm::Value *MicrosoftCXXABI::adjustThisParameterInVirtualFunctionPrologue(
1401 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001402 // In this ABI, every virtual function takes a pointer to one of the
1403 // subobjects that first defines it as the 'this' parameter, rather than a
Alp Tokerf6a24ce2013-12-05 16:25:25 +00001404 // pointer to the final overrider subobject. Thus, we need to adjust it back
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001405 // to the final overrider subobject before use.
1406 // See comments in the MicrosoftVFTableContext implementation for the details.
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001407 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001408 if (Adjustment.isZero())
1409 return This;
1410
1411 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1412 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1413 *thisTy = This->getType();
1414
1415 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1416 assert(Adjustment.isPositive());
David Blaikiefb901c7a2015-04-04 15:12:29 +00001417 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
1418 -Adjustment.getQuantity());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001419 return CGF.Builder.CreateBitCast(This, thisTy);
1420}
1421
John McCall0f999f32012-09-25 08:00:39 +00001422void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
1423 EmitThisParam(CGF);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001424
1425 /// If this is a function that the ABI specifies returns 'this', initialize
1426 /// the return slot to 'this' at the start of the function.
1427 ///
1428 /// Unlike the setting of return types, this is done within the ABI
1429 /// implementation instead of by clients of CGCXXABI because:
1430 /// 1) getThisValue is currently protected
1431 /// 2) in theory, an ABI could implement 'this' returns some other way;
1432 /// HasThisReturn only specifies a contract, not the implementation
1433 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001434 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001435 else if (hasMostDerivedReturn(CGF.CurGD))
1436 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1437 CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001438
1439 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1440 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1441 assert(getStructorImplicitParamDecl(CGF) &&
1442 "no implicit parameter for a constructor with virtual bases?");
1443 getStructorImplicitParamValue(CGF)
1444 = CGF.Builder.CreateLoad(
1445 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1446 "is_most_derived");
1447 }
1448
David Majnemer0c0b6d92014-10-31 20:09:12 +00001449 if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001450 assert(getStructorImplicitParamDecl(CGF) &&
1451 "no implicit parameter for a deleting destructor?");
1452 getStructorImplicitParamValue(CGF)
1453 = CGF.Builder.CreateLoad(
1454 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1455 "should_call_delete");
1456 }
John McCall0f999f32012-09-25 08:00:39 +00001457}
1458
Reid Kleckner89077a12013-12-17 19:46:40 +00001459unsigned MicrosoftCXXABI::addImplicitConstructorArgs(
1460 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1461 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001462 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001463
Reid Kleckner89077a12013-12-17 19:46:40 +00001464 // Check if we need a 'most_derived' parameter.
1465 if (!D->getParent()->getNumVBases())
1466 return 0;
1467
1468 // Add the 'most_derived' argument second if we are variadic or last if not.
1469 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
1470 llvm::Value *MostDerivedArg =
1471 llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
1472 RValue RV = RValue::get(MostDerivedArg);
1473 if (MostDerivedArg) {
1474 if (FPT->isVariadic())
1475 Args.insert(Args.begin() + 1,
1476 CallArg(RV, getContext().IntTy, /*needscopy=*/false));
1477 else
1478 Args.add(RV, getContext().IntTy);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001479 }
1480
Reid Kleckner89077a12013-12-17 19:46:40 +00001481 return 1; // Added one arg.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001482}
1483
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001484void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1485 const CXXDestructorDecl *DD,
1486 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +00001487 bool Delegating, Address This) {
Rafael Espindola1ac0ec82014-09-11 15:42:06 +00001488 llvm::Value *Callee = CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type));
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001489
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001490 if (DD->isVirtual()) {
1491 assert(Type != CXXDtorType::Dtor_Deleting &&
1492 "The deleting destructor should only be called via a virtual call");
1493 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1494 This, false);
1495 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001496
John McCall7f416cc2015-09-08 08:05:57 +00001497 CGF.EmitCXXStructorCall(DD, Callee, ReturnValueSlot(), This.getPointer(),
David Majnemer0c0b6d92014-10-31 20:09:12 +00001498 /*ImplicitParam=*/nullptr,
1499 /*ImplicitParamTy=*/QualType(), nullptr,
1500 getFromDtorType(Type));
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001501}
1502
Peter Collingbourned9546012015-06-19 02:30:43 +00001503void MicrosoftCXXABI::emitVTableBitSetEntries(VPtrInfo *Info,
1504 const CXXRecordDecl *RD,
1505 llvm::GlobalVariable *VTable) {
1506 if (!getContext().getLangOpts().Sanitize.has(SanitizerKind::CFIVCall) &&
1507 !getContext().getLangOpts().Sanitize.has(SanitizerKind::CFINVCall) &&
1508 !getContext().getLangOpts().Sanitize.has(SanitizerKind::CFIDerivedCast) &&
1509 !getContext().getLangOpts().Sanitize.has(SanitizerKind::CFIUnrelatedCast))
1510 return;
1511
1512 llvm::NamedMDNode *BitsetsMD =
1513 CGM.getModule().getOrInsertNamedMetadata("llvm.bitsets");
Peter Collingbourned9546012015-06-19 02:30:43 +00001514
Peter Collingbournee5706442015-07-09 19:56:14 +00001515 // The location of the first virtual function pointer in the virtual table,
1516 // aka the "address point" on Itanium. This is at offset 0 if RTTI is
1517 // disabled, or sizeof(void*) if RTTI is enabled.
1518 CharUnits AddressPoint =
1519 getContext().getLangOpts().RTTIData
1520 ? getContext().toCharUnitsFromBits(
1521 getContext().getTargetInfo().getPointerWidth(0))
1522 : CharUnits::Zero();
Peter Collingbourned9546012015-06-19 02:30:43 +00001523
1524 if (Info->PathToBaseWithVPtr.empty()) {
Peter Collingbournee5706442015-07-09 19:56:14 +00001525 if (!CGM.IsCFIBlacklistedRecord(RD))
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00001526 CGM.CreateVTableBitSetEntry(BitsetsMD, VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001527 return;
1528 }
1529
1530 // Add a bitset entry for the least derived base belonging to this vftable.
Peter Collingbournee5706442015-07-09 19:56:14 +00001531 if (!CGM.IsCFIBlacklistedRecord(Info->PathToBaseWithVPtr.back()))
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00001532 CGM.CreateVTableBitSetEntry(BitsetsMD, VTable, AddressPoint,
1533 Info->PathToBaseWithVPtr.back());
Peter Collingbourned9546012015-06-19 02:30:43 +00001534
1535 // Add a bitset entry for each derived class that is laid out at the same
1536 // offset as the least derived base.
1537 for (unsigned I = Info->PathToBaseWithVPtr.size() - 1; I != 0; --I) {
1538 const CXXRecordDecl *DerivedRD = Info->PathToBaseWithVPtr[I - 1];
1539 const CXXRecordDecl *BaseRD = Info->PathToBaseWithVPtr[I];
1540
1541 const ASTRecordLayout &Layout =
1542 getContext().getASTRecordLayout(DerivedRD);
1543 CharUnits Offset;
1544 auto VBI = Layout.getVBaseOffsetsMap().find(BaseRD);
1545 if (VBI == Layout.getVBaseOffsetsMap().end())
1546 Offset = Layout.getBaseClassOffset(BaseRD);
1547 else
1548 Offset = VBI->second.VBaseOffset;
1549 if (!Offset.isZero())
1550 return;
Peter Collingbournee5706442015-07-09 19:56:14 +00001551 if (!CGM.IsCFIBlacklistedRecord(DerivedRD))
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00001552 CGM.CreateVTableBitSetEntry(BitsetsMD, VTable, AddressPoint, DerivedRD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001553 }
1554
1555 // Finally do the same for the most derived class.
Peter Collingbournee5706442015-07-09 19:56:14 +00001556 if (Info->FullOffsetInMDC.isZero() && !CGM.IsCFIBlacklistedRecord(RD))
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00001557 CGM.CreateVTableBitSetEntry(BitsetsMD, VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001558}
1559
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001560void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1561 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001562 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001563 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001564
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001565 for (VPtrInfo *Info : VFPtrs) {
1566 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001567 if (VTable->hasInitializer())
1568 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001569
David Majnemerbd173ba2016-02-07 22:42:05 +00001570 llvm::Constant *RTTI = getContext().getLangOpts().RTTIData &&
1571 VTable->getDLLStorageClass() !=
1572 llvm::GlobalValue::DLLImportStorageClass
David Majnemer65f87322014-07-24 06:09:19 +00001573 ? getMSCompleteObjectLocator(RD, Info)
1574 : nullptr;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001575
1576 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001577 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001578 llvm::Constant *Init = CGVT.CreateVTableInitializer(
1579 RD, VTLayout.vtable_component_begin(),
1580 VTLayout.getNumVTableComponents(), VTLayout.vtable_thunk_begin(),
David Majnemerd905da42014-07-01 20:30:31 +00001581 VTLayout.getNumVTableThunks(), RTTI);
1582
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001583 VTable->setInitializer(Init);
Peter Collingbourned9546012015-06-19 02:30:43 +00001584
1585 emitVTableBitSetEntries(Info, RD, VTable);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001586 }
1587}
1588
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001589bool MicrosoftCXXABI::isVirtualOffsetNeededForVTableField(
1590 CodeGenFunction &CGF, CodeGenFunction::VPtr Vptr) {
1591 return Vptr.NearestVBase != nullptr;
1592}
1593
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001594llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1595 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001596 const CXXRecordDecl *NearestVBase) {
1597 llvm::Constant *VTableAddressPoint = getVTableAddressPoint(Base, VTableClass);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001598 if (!VTableAddressPoint) {
1599 assert(Base.getBase()->getNumVBases() &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001600 !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001601 }
1602 return VTableAddressPoint;
1603}
1604
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001605static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001606 const CXXRecordDecl *RD, const VPtrInfo *VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001607 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001608 llvm::raw_svector_ostream Out(Name);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001609 MangleContext.mangleCXXVFTable(RD, VFPtr->MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001610}
1611
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001612llvm::Constant *
1613MicrosoftCXXABI::getVTableAddressPoint(BaseSubobject Base,
1614 const CXXRecordDecl *VTableClass) {
Piotr Padlewski4bed31b2015-09-10 20:18:30 +00001615 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1616 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001617 return VFTablesMap[ID];
1618}
1619
1620llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1621 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1622 llvm::Constant *VFTable = getVTableAddressPoint(Base, VTableClass);
David Majnemerd905da42014-07-01 20:30:31 +00001623 assert(VFTable && "Couldn't find a vftable for the given base?");
1624 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001625}
1626
1627llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1628 CharUnits VPtrOffset) {
1629 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1630 // shouldn't be used in the given record type. We want to cache this result in
1631 // VFTablesMap, thus a simple zero check is not sufficient.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001632
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001633 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001634 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001635 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001636 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001637 if (!Inserted)
1638 return I->second;
1639
1640 llvm::GlobalVariable *&VTable = I->second;
1641
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001642 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001643 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001644
David Blaikie82e95a32014-11-19 07:49:47 +00001645 if (DeferredVFTables.insert(RD).second) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001646 // We haven't processed this record type before.
Eric Christopherd160c502016-01-29 01:35:53 +00001647 // Queue up this vtable for possible deferred emission.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001648 CGM.addDeferredVTable(RD);
1649
1650#ifndef NDEBUG
1651 // Create all the vftables at once in order to make sure each vftable has
1652 // a unique mangled name.
1653 llvm::StringSet<> ObservedMangledNames;
1654 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1655 SmallString<256> Name;
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001656 mangleVFTableName(getMangleContext(), RD, VFPtrs[J], Name);
David Blaikie61b86d42014-11-19 02:56:13 +00001657 if (!ObservedMangledNames.insert(Name.str()).second)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001658 llvm_unreachable("Already saw this mangling before?");
1659 }
1660#endif
1661 }
1662
David Majnemera03849b2015-03-18 22:04:43 +00001663 VPtrInfo *const *VFPtrI =
1664 std::find_if(VFPtrs.begin(), VFPtrs.end(), [&](VPtrInfo *VPI) {
1665 return VPI->FullOffsetInMDC == VPtrOffset;
1666 });
1667 if (VFPtrI == VFPtrs.end()) {
1668 VFTablesMap[ID] = nullptr;
1669 return nullptr;
1670 }
1671 VPtrInfo *VFPtr = *VFPtrI;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001672
David Majnemera03849b2015-03-18 22:04:43 +00001673 SmallString<256> VFTableName;
1674 mangleVFTableName(getMangleContext(), RD, VFPtr, VFTableName);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001675
David Majnemera03849b2015-03-18 22:04:43 +00001676 llvm::GlobalValue::LinkageTypes VFTableLinkage = CGM.getVTableLinkage(RD);
1677 bool VFTableComesFromAnotherTU =
1678 llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) ||
1679 llvm::GlobalValue::isExternalLinkage(VFTableLinkage);
1680 bool VTableAliasIsRequred =
1681 !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData;
David Majnemerbb848712014-07-01 22:37:08 +00001682
David Majnemera03849b2015-03-18 22:04:43 +00001683 if (llvm::GlobalValue *VFTable =
1684 CGM.getModule().getNamedGlobal(VFTableName)) {
1685 VFTablesMap[ID] = VFTable;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001686 VTable = VTableAliasIsRequred
1687 ? cast<llvm::GlobalVariable>(
1688 cast<llvm::GlobalAlias>(VFTable)->getBaseObject())
1689 : cast<llvm::GlobalVariable>(VFTable);
1690 return VTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001691 }
1692
David Majnemera03849b2015-03-18 22:04:43 +00001693 uint64_t NumVTableSlots =
1694 VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC)
1695 .getNumVTableComponents();
1696 llvm::GlobalValue::LinkageTypes VTableLinkage =
1697 VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage;
1698
1699 StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str();
1700
1701 llvm::ArrayType *VTableType =
1702 llvm::ArrayType::get(CGM.Int8PtrTy, NumVTableSlots);
1703
1704 // Create a backing variable for the contents of VTable. The VTable may
1705 // or may not include space for a pointer to RTTI data.
1706 llvm::GlobalValue *VFTable;
1707 VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType,
1708 /*isConstant=*/true, VTableLinkage,
1709 /*Initializer=*/nullptr, VTableName);
1710 VTable->setUnnamedAddr(true);
1711
1712 llvm::Comdat *C = nullptr;
1713 if (!VFTableComesFromAnotherTU &&
1714 (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) ||
1715 (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) &&
1716 VTableAliasIsRequred)))
1717 C = CGM.getModule().getOrInsertComdat(VFTableName.str());
1718
1719 // Only insert a pointer into the VFTable for RTTI data if we are not
1720 // importing it. We never reference the RTTI data directly so there is no
1721 // need to make room for it.
1722 if (VTableAliasIsRequred) {
1723 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
1724 llvm::ConstantInt::get(CGM.IntTy, 1)};
1725 // Create a GEP which points just after the first entry in the VFTable,
1726 // this should be the location of the first virtual method.
David Blaikiee3b172a2015-04-02 18:55:21 +00001727 llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr(
1728 VTable->getValueType(), VTable, GEPIndices);
David Majnemera03849b2015-03-18 22:04:43 +00001729 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) {
1730 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1731 if (C)
1732 C->setSelectionKind(llvm::Comdat::Largest);
1733 }
David Blaikie2a791d72015-09-14 18:38:22 +00001734 VFTable = llvm::GlobalAlias::create(CGM.Int8PtrTy,
1735 /*AddressSpace=*/0, VFTableLinkage,
1736 VFTableName.str(), VTableGEP,
1737 &CGM.getModule());
David Majnemera03849b2015-03-18 22:04:43 +00001738 VFTable->setUnnamedAddr(true);
1739 } else {
1740 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1741 // be referencing any RTTI data.
1742 // The GlobalVariable will end up being an appropriate definition of the
1743 // VFTable.
1744 VFTable = VTable;
1745 }
1746 if (C)
1747 VTable->setComdat(C);
1748
1749 if (RD->hasAttr<DLLImportAttr>())
1750 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1751 else if (RD->hasAttr<DLLExportAttr>())
1752 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1753
1754 VFTablesMap[ID] = VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001755 return VTable;
1756}
1757
Peter Collingbourned9546012015-06-19 02:30:43 +00001758// Compute the identity of the most derived class whose virtual table is located
1759// at the given offset into RD.
1760static const CXXRecordDecl *getClassAtVTableLocation(ASTContext &Ctx,
1761 const CXXRecordDecl *RD,
1762 CharUnits Offset) {
1763 if (Offset.isZero())
1764 return RD;
1765
1766 const ASTRecordLayout &Layout = Ctx.getASTRecordLayout(RD);
1767 const CXXRecordDecl *MaxBase = nullptr;
1768 CharUnits MaxBaseOffset;
1769 for (auto &&B : RD->bases()) {
1770 const CXXRecordDecl *Base = B.getType()->getAsCXXRecordDecl();
1771 CharUnits BaseOffset = Layout.getBaseClassOffset(Base);
Peter Collingbourne3d4114b2015-07-08 21:08:08 +00001772 if (BaseOffset <= Offset && BaseOffset >= MaxBaseOffset) {
Peter Collingbourned9546012015-06-19 02:30:43 +00001773 MaxBase = Base;
1774 MaxBaseOffset = BaseOffset;
1775 }
1776 }
1777 for (auto &&B : RD->vbases()) {
1778 const CXXRecordDecl *Base = B.getType()->getAsCXXRecordDecl();
1779 CharUnits BaseOffset = Layout.getVBaseClassOffset(Base);
Peter Collingbourne3d4114b2015-07-08 21:08:08 +00001780 if (BaseOffset <= Offset && BaseOffset >= MaxBaseOffset) {
Peter Collingbourned9546012015-06-19 02:30:43 +00001781 MaxBase = Base;
1782 MaxBaseOffset = BaseOffset;
1783 }
1784 }
1785 assert(MaxBase);
1786 return getClassAtVTableLocation(Ctx, MaxBase, Offset - MaxBaseOffset);
1787}
1788
1789// Compute the identity of the most derived class whose virtual table is located
1790// at the MethodVFTableLocation ML.
1791static const CXXRecordDecl *
1792getClassAtVTableLocation(ASTContext &Ctx, GlobalDecl GD,
1793 MicrosoftVTableContext::MethodVFTableLocation &ML) {
1794 const CXXRecordDecl *RD = ML.VBase;
1795 if (!RD)
1796 RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
1797
1798 return getClassAtVTableLocation(Ctx, RD, ML.VFPtrOffset);
1799}
1800
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001801llvm::Value *MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1802 GlobalDecl GD,
John McCall7f416cc2015-09-08 08:05:57 +00001803 Address This,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001804 llvm::Type *Ty,
1805 SourceLocation Loc) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001806 GD = GD.getCanonicalDecl();
1807 CGBuilderTy &Builder = CGF.Builder;
1808
1809 Ty = Ty->getPointerTo()->getPointerTo();
John McCall7f416cc2015-09-08 08:05:57 +00001810 Address VPtr =
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001811 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001812
1813 auto *MethodDecl = cast<CXXMethodDecl>(GD.getDecl());
1814 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty, MethodDecl->getParent());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001815
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001816 MicrosoftVTableContext::MethodVFTableLocation ML =
1817 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001818 if (CGF.SanOpts.has(SanitizerKind::CFIVCall))
1819 CGF.EmitVTablePtrCheck(getClassAtVTableLocation(getContext(), GD, ML),
1820 VTable, CodeGenFunction::CFITCK_VCall, Loc);
1821
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001822 llvm::Value *VFuncPtr =
1823 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
John McCall7f416cc2015-09-08 08:05:57 +00001824 return Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001825}
1826
David Majnemer0c0b6d92014-10-31 20:09:12 +00001827llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1828 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +00001829 Address This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001830 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001831 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1832
1833 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001834 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001835 GlobalDecl GD(Dtor, Dtor_Deleting);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001836 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1837 Dtor, StructorType::Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001838 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001839 llvm::Value *Callee = getVirtualFunctionPointer(
1840 CGF, GD, This, Ty, CE ? CE->getLocStart() : SourceLocation());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001841
David Majnemer9ced3dd2015-03-14 23:44:48 +00001842 ASTContext &Context = getContext();
Nico Weber0a029922015-01-12 21:24:10 +00001843 llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1844 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1845 DtorType == Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001846
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001847 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
John McCall7f416cc2015-09-08 08:05:57 +00001848 RValue RV = CGF.EmitCXXStructorCall(Dtor, Callee, ReturnValueSlot(),
1849 This.getPointer(),
David Majnemer0c0b6d92014-10-31 20:09:12 +00001850 ImplicitParam, Context.IntTy, CE,
1851 StructorType::Deleting);
1852 return RV.getScalarVal();
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001853}
1854
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001855const VBTableGlobals &
1856MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001857 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001858 // easier than caching each vbtable individually.
1859 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1860 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001861 std::tie(Entry, Added) =
1862 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001863 VBTableGlobals &VBGlobals = Entry->second;
1864 if (!Added)
1865 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001866
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001867 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1868 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001869
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001870 // Cache the globals for all vbtables so we don't have to recompute the
1871 // mangled names.
1872 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001873 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1874 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001875 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001876 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001877 }
1878
1879 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001880}
1881
Reid Klecknere4a52202014-02-21 02:27:32 +00001882llvm::Function *MicrosoftCXXABI::EmitVirtualMemPtrThunk(
1883 const CXXMethodDecl *MD,
1884 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001885 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1886 "can't form pointers to ctors or virtual dtors");
1887
Reid Klecknere4a52202014-02-21 02:27:32 +00001888 // Calculate the mangled name.
1889 SmallString<256> ThunkName;
1890 llvm::raw_svector_ostream Out(ThunkName);
1891 getMangleContext().mangleVirtualMemPtrThunk(MD, Out);
Reid Klecknere4a52202014-02-21 02:27:32 +00001892
Hans Wennborg88497d62013-11-15 17:24:45 +00001893 // If the thunk has been generated previously, just return it.
1894 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1895 return cast<llvm::Function>(GV);
1896
1897 // Create the llvm::Function.
Reid Klecknerc3473512014-08-29 21:43:29 +00001898 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSMemberPointerThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00001899 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1900 llvm::Function *ThunkFn =
1901 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1902 ThunkName.str(), &CGM.getModule());
1903 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1904
Hans Wennborg88497d62013-11-15 17:24:45 +00001905 ThunkFn->setLinkage(MD->isExternallyVisible()
1906 ? llvm::GlobalValue::LinkOnceODRLinkage
1907 : llvm::GlobalValue::InternalLinkage);
David Majnemer8c9cdb62015-01-21 01:21:31 +00001908 if (MD->isExternallyVisible())
1909 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
Hans Wennborg88497d62013-11-15 17:24:45 +00001910
1911 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1912 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1913
Reid Kleckner9da94482015-01-21 22:18:17 +00001914 // Add the "thunk" attribute so that LLVM knows that the return type is
1915 // meaningless. These thunks can be used to call functions with differing
1916 // return types, and the caller is required to cast the prototype
1917 // appropriately to extract the correct value.
1918 ThunkFn->addFnAttr("thunk");
1919
Reid Klecknerb9538a62014-08-15 18:12:40 +00001920 // These thunks can be compared, so they are not unnamed.
1921 ThunkFn->setUnnamedAddr(false);
1922
Hans Wennborg88497d62013-11-15 17:24:45 +00001923 // Start codegen.
1924 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00001925 CGF.CurGD = GlobalDecl(MD);
1926 CGF.CurFuncIsThunk = true;
1927
1928 // Build FunctionArgs, but only include the implicit 'this' parameter
1929 // declaration.
1930 FunctionArgList FunctionArgs;
1931 buildThisParam(CGF, FunctionArgs);
1932
1933 // Start defining the function.
1934 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
1935 FunctionArgs, MD->getLocation(), SourceLocation());
1936 EmitThisParam(CGF);
Hans Wennborg88497d62013-11-15 17:24:45 +00001937
Reid Klecknere4a52202014-02-21 02:27:32 +00001938 // Load the vfptr and then callee from the vftable. The callee should have
1939 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00001940 llvm::Value *VTable = CGF.GetVTablePtr(
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001941 getThisAddress(CGF), ThunkTy->getPointerTo()->getPointerTo(), MD->getParent());
1942
Reid Klecknere4a52202014-02-21 02:27:32 +00001943 llvm::Value *VFuncPtr =
1944 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
John McCall7f416cc2015-09-08 08:05:57 +00001945 llvm::Value *Callee =
1946 CGF.Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
Hans Wennborg88497d62013-11-15 17:24:45 +00001947
Reid Klecknerc3473512014-08-29 21:43:29 +00001948 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee);
Hans Wennborg88497d62013-11-15 17:24:45 +00001949
1950 return ThunkFn;
1951}
1952
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001953void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001954 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1955 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001956 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001957 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
David Majnemer129f4172015-02-02 10:22:20 +00001958 if (GV->isDeclaration())
1959 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00001960 }
1961}
1962
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001963llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001964MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001965 llvm::GlobalVariable::LinkageTypes Linkage) {
1966 SmallString<256> OutName;
1967 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00001968 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001969 StringRef Name = OutName.str();
1970
1971 llvm::ArrayType *VBTableType =
1972 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ReusingBase->getNumVBases());
1973
1974 assert(!CGM.getModule().getNamedGlobal(Name) &&
1975 "vbtable with this name already exists: mangling bug?");
1976 llvm::GlobalVariable *GV =
1977 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
1978 GV->setUnnamedAddr(true);
Hans Wennborg853ae942014-05-30 16:59:42 +00001979
1980 if (RD->hasAttr<DLLImportAttr>())
1981 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1982 else if (RD->hasAttr<DLLExportAttr>())
1983 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1984
David Majnemer129f4172015-02-02 10:22:20 +00001985 if (!GV->hasExternalLinkage())
1986 emitVBTableDefinition(VBT, RD, GV);
1987
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001988 return GV;
1989}
1990
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001991void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001992 const CXXRecordDecl *RD,
1993 llvm::GlobalVariable *GV) const {
1994 const CXXRecordDecl *ReusingBase = VBT.ReusingBase;
1995
1996 assert(RD->getNumVBases() && ReusingBase->getNumVBases() &&
1997 "should only emit vbtables for classes with vbtables");
1998
1999 const ASTRecordLayout &BaseLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00002000 getContext().getASTRecordLayout(VBT.BaseWithVPtr);
2001 const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002002
Craig Topper8a13c412014-05-21 05:09:00 +00002003 SmallVector<llvm::Constant *, 4> Offsets(1 + ReusingBase->getNumVBases(),
2004 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002005
2006 // The offset from ReusingBase's vbptr to itself always leads.
2007 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
2008 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
2009
2010 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Aaron Ballman445a9392014-03-13 16:15:17 +00002011 for (const auto &I : ReusingBase->vbases()) {
2012 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002013 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
2014 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00002015
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002016 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00002017 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002018 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00002019 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002020 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00002021 Offset -= CompleteVBPtrOffset;
2022
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002023 unsigned VBIndex = Context.getVBTableIndex(ReusingBase, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00002024 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002025 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
2026 }
2027
2028 assert(Offsets.size() ==
2029 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
2030 ->getElementType())->getNumElements());
2031 llvm::ArrayType *VBTableType =
2032 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
2033 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
2034 GV->setInitializer(Init);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002035}
2036
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002037llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002038 Address This,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002039 const ThisAdjustment &TA) {
2040 if (TA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002041 return This.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002042
John McCall7f416cc2015-09-08 08:05:57 +00002043 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002044
John McCall7f416cc2015-09-08 08:05:57 +00002045 llvm::Value *V;
2046 if (TA.Virtual.isEmpty()) {
2047 V = This.getPointer();
2048 } else {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002049 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
2050 // Adjust the this argument based on the vtordisp value.
John McCall7f416cc2015-09-08 08:05:57 +00002051 Address VtorDispPtr =
2052 CGF.Builder.CreateConstInBoundsByteGEP(This,
2053 CharUnits::fromQuantity(TA.Virtual.Microsoft.VtordispOffset));
2054 VtorDispPtr = CGF.Builder.CreateElementBitCast(VtorDispPtr, CGF.Int32Ty);
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002055 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
John McCall7f416cc2015-09-08 08:05:57 +00002056 V = CGF.Builder.CreateGEP(This.getPointer(),
2057 CGF.Builder.CreateNeg(VtorDisp));
2058
2059 // Unfortunately, having applied the vtordisp means that we no
2060 // longer really have a known alignment for the vbptr step.
2061 // We'll assume the vbptr is pointer-aligned.
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002062
2063 if (TA.Virtual.Microsoft.VBPtrOffset) {
2064 // If the final overrider is defined in a virtual base other than the one
2065 // that holds the vfptr, we have to use a vtordispex thunk which looks up
2066 // the vbtable of the derived class.
2067 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
2068 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
2069 llvm::Value *VBPtr;
2070 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002071 GetVBaseOffsetFromVBPtr(CGF, Address(V, CGF.getPointerAlign()),
2072 -TA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002073 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
2074 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2075 }
2076 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002077
2078 if (TA.NonVirtual) {
2079 // Non-virtual adjustment might result in a pointer outside the allocated
2080 // object, e.g. if the final overrider class is laid out after the virtual
2081 // base that declares a method in the most derived class.
2082 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
2083 }
2084
2085 // Don't need to bitcast back, the call CodeGen will handle this.
2086 return V;
2087}
2088
2089llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00002090MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002091 const ReturnAdjustment &RA) {
2092 if (RA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002093 return Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002094
John McCall7f416cc2015-09-08 08:05:57 +00002095 auto OrigTy = Ret.getType();
2096 Ret = CGF.Builder.CreateElementBitCast(Ret, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002097
John McCall7f416cc2015-09-08 08:05:57 +00002098 llvm::Value *V = Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002099 if (RA.Virtual.Microsoft.VBIndex) {
2100 assert(RA.Virtual.Microsoft.VBIndex > 0);
John McCall7f416cc2015-09-08 08:05:57 +00002101 int32_t IntSize = CGF.getIntSize().getQuantity();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002102 llvm::Value *VBPtr;
2103 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002104 GetVBaseOffsetFromVBPtr(CGF, Ret, RA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002105 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
2106 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2107 }
2108
2109 if (RA.NonVirtual)
David Blaikiefb901c7a2015-04-04 15:12:29 +00002110 V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002111
2112 // Cast back to the original type.
John McCall7f416cc2015-09-08 08:05:57 +00002113 return CGF.Builder.CreateBitCast(V, OrigTy);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002114}
2115
John McCallb91cd662012-05-01 05:23:51 +00002116bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
2117 QualType elementType) {
2118 // Microsoft seems to completely ignore the possibility of a
2119 // two-argument usual deallocation function.
2120 return elementType.isDestructedType();
2121}
2122
2123bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
2124 // Microsoft seems to completely ignore the possibility of a
2125 // two-argument usual deallocation function.
2126 return expr->getAllocatedType().isDestructedType();
2127}
2128
2129CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
2130 // The array cookie is always a size_t; we then pad that out to the
2131 // alignment of the element type.
2132 ASTContext &Ctx = getContext();
2133 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
2134 Ctx.getTypeAlignInChars(type));
2135}
2136
2137llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002138 Address allocPtr,
John McCallb91cd662012-05-01 05:23:51 +00002139 CharUnits cookieSize) {
John McCall7f416cc2015-09-08 08:05:57 +00002140 Address numElementsPtr =
2141 CGF.Builder.CreateElementBitCast(allocPtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002142 return CGF.Builder.CreateLoad(numElementsPtr);
2143}
2144
John McCall7f416cc2015-09-08 08:05:57 +00002145Address MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
2146 Address newPtr,
2147 llvm::Value *numElements,
2148 const CXXNewExpr *expr,
2149 QualType elementType) {
John McCallb91cd662012-05-01 05:23:51 +00002150 assert(requiresArrayCookie(expr));
2151
2152 // The size of the cookie.
2153 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
2154
2155 // Compute an offset to the cookie.
John McCall7f416cc2015-09-08 08:05:57 +00002156 Address cookiePtr = newPtr;
John McCallb91cd662012-05-01 05:23:51 +00002157
2158 // Write the number of elements into the appropriate slot.
John McCall7f416cc2015-09-08 08:05:57 +00002159 Address numElementsPtr
2160 = CGF.Builder.CreateElementBitCast(cookiePtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002161 CGF.Builder.CreateStore(numElements, numElementsPtr);
2162
2163 // Finally, compute a pointer to the actual data buffer by skipping
2164 // over the cookie completely.
John McCall7f416cc2015-09-08 08:05:57 +00002165 return CGF.Builder.CreateConstInBoundsByteGEP(newPtr, cookieSize);
John McCallb91cd662012-05-01 05:23:51 +00002166}
2167
David Majnemerb3341ea2014-10-05 05:05:40 +00002168static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
2169 llvm::Constant *Dtor,
2170 llvm::Constant *Addr) {
2171 // Create a function which calls the destructor.
2172 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
2173
2174 // extern "C" int __tlregdtor(void (*f)(void));
2175 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
2176 CGF.IntTy, DtorStub->getType(), /*IsVarArg=*/false);
2177
2178 llvm::Constant *TLRegDtor =
2179 CGF.CGM.CreateRuntimeFunction(TLRegDtorTy, "__tlregdtor");
2180 if (llvm::Function *TLRegDtorFn = dyn_cast<llvm::Function>(TLRegDtor))
2181 TLRegDtorFn->setDoesNotThrow();
2182
2183 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
2184}
2185
2186void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
2187 llvm::Constant *Dtor,
2188 llvm::Constant *Addr) {
2189 if (D.getTLSKind())
2190 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
2191
2192 // The default behavior is to use atexit.
2193 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
2194}
2195
2196void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +00002197 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +00002198 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +00002199 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) {
David Majnemerb3341ea2014-10-05 05:05:40 +00002200 // This will create a GV in the .CRT$XDU section. It will point to our
2201 // initialization function. The CRT will call all of these function
2202 // pointers at start-up time and, eventually, at thread-creation time.
2203 auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
2204 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
2205 CGM.getModule(), InitFunc->getType(), /*IsConstant=*/true,
2206 llvm::GlobalVariable::InternalLinkage, InitFunc,
2207 Twine(InitFunc->getName(), "$initializer$"));
2208 InitFuncPtr->setSection(".CRT$XDU");
2209 // This variable has discardable linkage, we have to add it to @llvm.used to
2210 // ensure it won't get discarded.
2211 CGM.addUsedGlobal(InitFuncPtr);
2212 return InitFuncPtr;
2213 };
2214
2215 std::vector<llvm::Function *> NonComdatInits;
2216 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
Richard Smith5a99c492015-12-01 01:10:48 +00002217 llvm::GlobalVariable *GV = cast<llvm::GlobalVariable>(
2218 CGM.GetGlobalValue(CGM.getMangledName(CXXThreadLocalInitVars[I])));
David Majnemerb3341ea2014-10-05 05:05:40 +00002219 llvm::Function *F = CXXThreadLocalInits[I];
2220
2221 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002222 if (llvm::Comdat *C = GV->getComdat())
David Majnemerb3341ea2014-10-05 05:05:40 +00002223 AddToXDU(F)->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002224 else
David Majnemerb3341ea2014-10-05 05:05:40 +00002225 NonComdatInits.push_back(F);
David Majnemerb3341ea2014-10-05 05:05:40 +00002226 }
2227
2228 if (!NonComdatInits.empty()) {
2229 llvm::FunctionType *FTy =
2230 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002231 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +00002232 FTy, "__tls_init", CGM.getTypes().arrangeNullaryFunction(),
2233 SourceLocation(), /*TLS=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002234 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2235
2236 AddToXDU(InitFunc);
2237 }
2238}
2239
2240LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2241 const VarDecl *VD,
2242 QualType LValType) {
2243 CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2244 return LValue();
2245}
2246
John McCall7f416cc2015-09-08 08:05:57 +00002247static ConstantAddress getInitThreadEpochPtr(CodeGenModule &CGM) {
David Majnemer8354eee2015-05-07 06:15:46 +00002248 StringRef VarName("_Init_thread_epoch");
John McCall7f416cc2015-09-08 08:05:57 +00002249 CharUnits Align = CGM.getIntAlign();
David Majnemer8354eee2015-05-07 06:15:46 +00002250 if (auto *GV = CGM.getModule().getNamedGlobal(VarName))
John McCall7f416cc2015-09-08 08:05:57 +00002251 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002252 auto *GV = new llvm::GlobalVariable(
2253 CGM.getModule(), CGM.IntTy,
2254 /*Constant=*/false, llvm::GlobalVariable::ExternalLinkage,
2255 /*Initializer=*/nullptr, VarName,
2256 /*InsertBefore=*/nullptr, llvm::GlobalVariable::GeneralDynamicTLSModel);
John McCall7f416cc2015-09-08 08:05:57 +00002257 GV->setAlignment(Align.getQuantity());
2258 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002259}
2260
2261static llvm::Constant *getInitThreadHeaderFn(CodeGenModule &CGM) {
2262 llvm::FunctionType *FTy =
2263 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2264 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2265 return CGM.CreateRuntimeFunction(
2266 FTy, "_Init_thread_header",
2267 llvm::AttributeSet::get(CGM.getLLVMContext(),
2268 llvm::AttributeSet::FunctionIndex,
2269 llvm::Attribute::NoUnwind));
2270}
2271
2272static llvm::Constant *getInitThreadFooterFn(CodeGenModule &CGM) {
2273 llvm::FunctionType *FTy =
2274 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2275 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2276 return CGM.CreateRuntimeFunction(
2277 FTy, "_Init_thread_footer",
2278 llvm::AttributeSet::get(CGM.getLLVMContext(),
2279 llvm::AttributeSet::FunctionIndex,
2280 llvm::Attribute::NoUnwind));
2281}
2282
2283static llvm::Constant *getInitThreadAbortFn(CodeGenModule &CGM) {
2284 llvm::FunctionType *FTy =
2285 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2286 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2287 return CGM.CreateRuntimeFunction(
2288 FTy, "_Init_thread_abort",
2289 llvm::AttributeSet::get(CGM.getLLVMContext(),
2290 llvm::AttributeSet::FunctionIndex,
2291 llvm::Attribute::NoUnwind));
2292}
2293
2294namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002295struct ResetGuardBit final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002296 Address Guard;
David Majnemer8354eee2015-05-07 06:15:46 +00002297 unsigned GuardNum;
John McCall7f416cc2015-09-08 08:05:57 +00002298 ResetGuardBit(Address Guard, unsigned GuardNum)
David Majnemer8354eee2015-05-07 06:15:46 +00002299 : Guard(Guard), GuardNum(GuardNum) {}
2300
2301 void Emit(CodeGenFunction &CGF, Flags flags) override {
2302 // Reset the bit in the mask so that the static variable may be
2303 // reinitialized.
2304 CGBuilderTy &Builder = CGF.Builder;
2305 llvm::LoadInst *LI = Builder.CreateLoad(Guard);
2306 llvm::ConstantInt *Mask =
2307 llvm::ConstantInt::get(CGF.IntTy, ~(1U << GuardNum));
2308 Builder.CreateStore(Builder.CreateAnd(LI, Mask), Guard);
2309 }
2310};
2311
David Blaikie7e70d682015-08-18 22:40:54 +00002312struct CallInitThreadAbort final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002313 llvm::Value *Guard;
2314 CallInitThreadAbort(Address Guard) : Guard(Guard.getPointer()) {}
David Majnemer8354eee2015-05-07 06:15:46 +00002315
2316 void Emit(CodeGenFunction &CGF, Flags flags) override {
2317 // Calling _Init_thread_abort will reset the guard's state.
2318 CGF.EmitNounwindRuntimeCall(getInitThreadAbortFn(CGF.CGM), Guard);
2319 }
2320};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002321}
David Majnemer8354eee2015-05-07 06:15:46 +00002322
John McCallc84ed6a2012-05-01 06:13:13 +00002323void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00002324 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00002325 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00002326 // MSVC only uses guards for static locals.
2327 if (!D.isStaticLocal()) {
2328 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2329 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
Rafael Espindola77abc3a2015-01-16 16:04:45 +00002330 llvm::Function *F = CGF.CurFn;
2331 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2332 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
Reid Kleckner563f0e82014-05-23 21:13:45 +00002333 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2334 return;
2335 }
2336
David Majnemerec8e54b2015-05-07 21:19:06 +00002337 bool ThreadlocalStatic = D.getTLSKind();
2338 bool ThreadsafeStatic = getContext().getLangOpts().ThreadsafeStatics;
2339
2340 // Thread-safe static variables which aren't thread-specific have a
2341 // per-variable guard.
2342 bool HasPerVariableGuard = ThreadsafeStatic && !ThreadlocalStatic;
Richard Smithdbf74ba2013-04-14 23:01:42 +00002343
Reid Klecknerd8110b62013-09-10 20:14:30 +00002344 CGBuilderTy &Builder = CGF.Builder;
2345 llvm::IntegerType *GuardTy = CGF.Int32Ty;
2346 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
John McCall7f416cc2015-09-08 08:05:57 +00002347 CharUnits GuardAlign = CharUnits::fromQuantity(4);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002348
2349 // Get the guard variable for this function if we have one already.
David Majnemerec8e54b2015-05-07 21:19:06 +00002350 GuardInfo *GI = nullptr;
2351 if (ThreadlocalStatic)
2352 GI = &ThreadLocalGuardVariableMap[D.getDeclContext()];
2353 else if (!ThreadsafeStatic)
2354 GI = &GuardVariableMap[D.getDeclContext()];
2355
2356 llvm::GlobalVariable *GuardVar = GI ? GI->Guard : nullptr;
David Majnemer8354eee2015-05-07 06:15:46 +00002357 unsigned GuardNum;
David Majnemerec8e54b2015-05-07 21:19:06 +00002358 if (D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002359 // Externally visible variables have to be numbered in Sema to properly
2360 // handle unreachable VarDecls.
David Majnemer8354eee2015-05-07 06:15:46 +00002361 GuardNum = getContext().getStaticLocalNumber(&D);
2362 assert(GuardNum > 0);
2363 GuardNum--;
2364 } else if (HasPerVariableGuard) {
2365 GuardNum = ThreadSafeGuardNumMap[D.getDeclContext()]++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002366 } else {
2367 // Non-externally visible variables are numbered here in CodeGen.
David Majnemer8354eee2015-05-07 06:15:46 +00002368 GuardNum = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002369 }
2370
David Majnemer8354eee2015-05-07 06:15:46 +00002371 if (!HasPerVariableGuard && GuardNum >= 32) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002372 if (D.isExternallyVisible())
2373 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
David Majnemer8354eee2015-05-07 06:15:46 +00002374 GuardNum %= 32;
2375 GuardVar = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002376 }
2377
David Majnemer8354eee2015-05-07 06:15:46 +00002378 if (!GuardVar) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002379 // Mangle the name for the guard.
2380 SmallString<256> GuardName;
2381 {
2382 llvm::raw_svector_ostream Out(GuardName);
David Majnemer8354eee2015-05-07 06:15:46 +00002383 if (HasPerVariableGuard)
2384 getMangleContext().mangleThreadSafeStaticGuardVariable(&D, GuardNum,
2385 Out);
2386 else
2387 getMangleContext().mangleStaticGuardVariable(&D, Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002388 }
2389
Hans Wennborgef2272c2014-06-18 15:55:13 +00002390 // Create the guard variable with a zero-initializer. Just absorb linkage,
2391 // visibility and dll storage class from the guarded variable.
David Majnemer8354eee2015-05-07 06:15:46 +00002392 GuardVar =
2393 new llvm::GlobalVariable(CGM.getModule(), GuardTy, /*isConstant=*/false,
Reid Klecknere9591b32014-04-23 18:22:11 +00002394 GV->getLinkage(), Zero, GuardName.str());
David Majnemer8354eee2015-05-07 06:15:46 +00002395 GuardVar->setVisibility(GV->getVisibility());
2396 GuardVar->setDLLStorageClass(GV->getDLLStorageClass());
John McCall7f416cc2015-09-08 08:05:57 +00002397 GuardVar->setAlignment(GuardAlign.getQuantity());
David Majnemer8354eee2015-05-07 06:15:46 +00002398 if (GuardVar->isWeakForLinker())
2399 GuardVar->setComdat(
2400 CGM.getModule().getOrInsertComdat(GuardVar->getName()));
2401 if (D.getTLSKind())
2402 GuardVar->setThreadLocal(true);
2403 if (GI && !HasPerVariableGuard)
2404 GI->Guard = GuardVar;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002405 }
2406
John McCall7f416cc2015-09-08 08:05:57 +00002407 ConstantAddress GuardAddr(GuardVar, GuardAlign);
2408
David Majnemer8354eee2015-05-07 06:15:46 +00002409 assert(GuardVar->getLinkage() == GV->getLinkage() &&
2410 "static local from the same function had different linkage");
Reid Klecknerd8110b62013-09-10 20:14:30 +00002411
David Majnemer8354eee2015-05-07 06:15:46 +00002412 if (!HasPerVariableGuard) {
2413 // Pseudo code for the test:
2414 // if (!(GuardVar & MyGuardBit)) {
2415 // GuardVar |= MyGuardBit;
2416 // ... initialize the object ...;
2417 // }
Reid Klecknerd8110b62013-09-10 20:14:30 +00002418
David Majnemer8354eee2015-05-07 06:15:46 +00002419 // Test our bit from the guard variable.
2420 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1U << GuardNum);
John McCall7f416cc2015-09-08 08:05:57 +00002421 llvm::LoadInst *LI = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002422 llvm::Value *IsInitialized =
2423 Builder.CreateICmpNE(Builder.CreateAnd(LI, Bit), Zero);
2424 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2425 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
2426 Builder.CreateCondBr(IsInitialized, EndBlock, InitBlock);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002427
David Majnemer8354eee2015-05-07 06:15:46 +00002428 // Set our bit in the guard variable and emit the initializer and add a global
2429 // destructor if appropriate.
2430 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002431 Builder.CreateStore(Builder.CreateOr(LI, Bit), GuardAddr);
2432 CGF.EHStack.pushCleanup<ResetGuardBit>(EHCleanup, GuardAddr, GuardNum);
David Majnemer8354eee2015-05-07 06:15:46 +00002433 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2434 CGF.PopCleanupBlock();
2435 Builder.CreateBr(EndBlock);
2436
2437 // Continue.
2438 CGF.EmitBlock(EndBlock);
2439 } else {
2440 // Pseudo code for the test:
2441 // if (TSS > _Init_thread_epoch) {
2442 // _Init_thread_header(&TSS);
2443 // if (TSS == -1) {
2444 // ... initialize the object ...;
2445 // _Init_thread_footer(&TSS);
2446 // }
2447 // }
2448 //
2449 // The algorithm is almost identical to what can be found in the appendix
2450 // found in N2325.
2451
David Majnemer8354eee2015-05-07 06:15:46 +00002452 // This BasicBLock determines whether or not we have any work to do.
John McCall7f416cc2015-09-08 08:05:57 +00002453 llvm::LoadInst *FirstGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002454 FirstGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2455 llvm::LoadInst *InitThreadEpoch =
2456 Builder.CreateLoad(getInitThreadEpochPtr(CGM));
2457 llvm::Value *IsUninitialized =
2458 Builder.CreateICmpSGT(FirstGuardLoad, InitThreadEpoch);
2459 llvm::BasicBlock *AttemptInitBlock = CGF.createBasicBlock("init.attempt");
2460 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
2461 Builder.CreateCondBr(IsUninitialized, AttemptInitBlock, EndBlock);
2462
2463 // This BasicBlock attempts to determine whether or not this thread is
2464 // responsible for doing the initialization.
2465 CGF.EmitBlock(AttemptInitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002466 CGF.EmitNounwindRuntimeCall(getInitThreadHeaderFn(CGM),
2467 GuardAddr.getPointer());
2468 llvm::LoadInst *SecondGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002469 SecondGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2470 llvm::Value *ShouldDoInit =
2471 Builder.CreateICmpEQ(SecondGuardLoad, getAllOnesInt());
2472 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2473 Builder.CreateCondBr(ShouldDoInit, InitBlock, EndBlock);
2474
2475 // Ok, we ended up getting selected as the initializing thread.
2476 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002477 CGF.EHStack.pushCleanup<CallInitThreadAbort>(EHCleanup, GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002478 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2479 CGF.PopCleanupBlock();
John McCall7f416cc2015-09-08 08:05:57 +00002480 CGF.EmitNounwindRuntimeCall(getInitThreadFooterFn(CGM),
2481 GuardAddr.getPointer());
David Majnemer8354eee2015-05-07 06:15:46 +00002482 Builder.CreateBr(EndBlock);
2483
2484 CGF.EmitBlock(EndBlock);
2485 }
John McCallc84ed6a2012-05-01 06:13:13 +00002486}
2487
Reid Kleckner2341ae32013-04-11 18:13:19 +00002488bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2489 // Null-ness for function memptrs only depends on the first field, which is
2490 // the function pointer. The rest don't matter, so we can zero initialize.
2491 if (MPT->isMemberFunctionPointer())
2492 return true;
2493
2494 // The virtual base adjustment field is always -1 for null, so if we have one
2495 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
2496 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002497 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2498 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002499 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
2500 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00002501}
2502
2503llvm::Type *
2504MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002505 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2506 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002507 llvm::SmallVector<llvm::Type *, 4> fields;
2508 if (MPT->isMemberFunctionPointer())
2509 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
2510 else
2511 fields.push_back(CGM.IntTy); // FieldOffset
2512
Reid Kleckner96f8f932014-02-05 17:27:08 +00002513 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2514 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002515 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002516 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002517 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002518 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002519 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
2520
2521 if (fields.size() == 1)
2522 return fields[0];
2523 return llvm::StructType::get(CGM.getLLVMContext(), fields);
2524}
2525
2526void MicrosoftCXXABI::
2527GetNullMemberPointerFields(const MemberPointerType *MPT,
2528 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2529 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00002530 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2531 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002532 if (MPT->isMemberFunctionPointer()) {
2533 // FunctionPointerOrVirtualThunk
2534 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2535 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00002536 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00002537 fields.push_back(getZeroInt()); // FieldOffset
2538 else
2539 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00002540 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00002541
Reid Kleckner96f8f932014-02-05 17:27:08 +00002542 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2543 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002544 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002545 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002546 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002547 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002548 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002549}
2550
2551llvm::Constant *
2552MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002553 llvm::SmallVector<llvm::Constant *, 4> fields;
2554 GetNullMemberPointerFields(MPT, fields);
2555 if (fields.size() == 1)
2556 return fields[0];
2557 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2558 assert(Res->getType() == ConvertMemberPointerType(MPT));
2559 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002560}
2561
2562llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002563MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2564 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00002565 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +00002566 CharUnits NonVirtualBaseAdjustment,
2567 unsigned VBTableIndex) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002568 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002569
2570 // Single inheritance class member pointer are represented as scalars instead
2571 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002572 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002573 return FirstField;
2574
Reid Kleckner2341ae32013-04-11 18:13:19 +00002575 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002576 fields.push_back(FirstField);
2577
Reid Kleckner96f8f932014-02-05 17:27:08 +00002578 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002579 fields.push_back(llvm::ConstantInt::get(
2580 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002581
Reid Kleckner96f8f932014-02-05 17:27:08 +00002582 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00002583 CharUnits Offs = CharUnits::Zero();
David Majnemerc1709d32015-06-23 07:31:11 +00002584 if (VBTableIndex)
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002585 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00002586 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00002587 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002588
2589 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002590 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
David Majnemere60813f2015-05-10 21:48:08 +00002591 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, VBTableIndex));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002592
Reid Kleckner2341ae32013-04-11 18:13:19 +00002593 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002594}
2595
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002596llvm::Constant *
2597MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2598 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002599 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerc1709d32015-06-23 07:31:11 +00002600 if (RD->getMSInheritanceModel() ==
2601 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002602 offset -= getContext().getOffsetOfBaseWithVBPtr(RD);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002603 llvm::Constant *FirstField =
2604 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00002605 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002606 CharUnits::Zero(), /*VBTableIndex=*/0);
Reid Kleckner452abac2013-05-09 21:01:17 +00002607}
2608
Reid Kleckner452abac2013-05-09 21:01:17 +00002609llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2610 QualType MPType) {
David Majnemer5ca193c2015-06-23 07:31:07 +00002611 const MemberPointerType *DstTy = MPType->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002612 const ValueDecl *MPD = MP.getMemberPointerDecl();
2613 if (!MPD)
David Majnemer5ca193c2015-06-23 07:31:07 +00002614 return EmitNullMemberPointer(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002615
David Majnemer5ca193c2015-06-23 07:31:07 +00002616 ASTContext &Ctx = getContext();
2617 ArrayRef<const CXXRecordDecl *> MemberPointerPath = MP.getMemberPointerPath();
Reid Kleckner452abac2013-05-09 21:01:17 +00002618
David Majnemer5ca193c2015-06-23 07:31:07 +00002619 llvm::Constant *C;
2620 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) {
2621 C = EmitMemberFunctionPointer(MD);
2622 } else {
2623 CharUnits FieldOffset = Ctx.toCharUnitsFromBits(Ctx.getFieldOffset(MPD));
2624 C = EmitMemberDataPointer(DstTy, FieldOffset);
2625 }
Reid Kleckner452abac2013-05-09 21:01:17 +00002626
David Majnemer5ca193c2015-06-23 07:31:07 +00002627 if (!MemberPointerPath.empty()) {
2628 const CXXRecordDecl *SrcRD = cast<CXXRecordDecl>(MPD->getDeclContext());
2629 const Type *SrcRecTy = Ctx.getTypeDeclType(SrcRD).getTypePtr();
2630 const MemberPointerType *SrcTy =
2631 Ctx.getMemberPointerType(DstTy->getPointeeType(), SrcRecTy)
2632 ->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002633
David Majnemer5ca193c2015-06-23 07:31:07 +00002634 bool DerivedMember = MP.isMemberPointerToDerivedMember();
2635 SmallVector<const CXXBaseSpecifier *, 4> DerivedToBasePath;
2636 const CXXRecordDecl *PrevRD = SrcRD;
2637 for (const CXXRecordDecl *PathElem : MemberPointerPath) {
2638 const CXXRecordDecl *Base = nullptr;
2639 const CXXRecordDecl *Derived = nullptr;
2640 if (DerivedMember) {
2641 Base = PathElem;
2642 Derived = PrevRD;
2643 } else {
2644 Base = PrevRD;
2645 Derived = PathElem;
2646 }
2647 for (const CXXBaseSpecifier &BS : Derived->bases())
2648 if (BS.getType()->getAsCXXRecordDecl()->getCanonicalDecl() ==
2649 Base->getCanonicalDecl())
2650 DerivedToBasePath.push_back(&BS);
2651 PrevRD = PathElem;
2652 }
2653 assert(DerivedToBasePath.size() == MemberPointerPath.size());
2654
2655 CastKind CK = DerivedMember ? CK_DerivedToBaseMemberPointer
2656 : CK_BaseToDerivedMemberPointer;
2657 C = EmitMemberPointerConversion(SrcTy, DstTy, CK, DerivedToBasePath.begin(),
2658 DerivedToBasePath.end(), C);
2659 }
2660 return C;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002661}
2662
2663llvm::Constant *
David Majnemer5ca193c2015-06-23 07:31:07 +00002664MicrosoftCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002665 assert(MD->isInstance() && "Member function must not be static!");
David Majnemer5ca193c2015-06-23 07:31:07 +00002666
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002667 MD = MD->getCanonicalDecl();
David Majnemer5ca193c2015-06-23 07:31:07 +00002668 CharUnits NonVirtualBaseAdjustment = CharUnits::Zero();
2669 const CXXRecordDecl *RD = MD->getParent()->getMostRecentDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002670 CodeGenTypes &Types = CGM.getTypes();
2671
David Majnemere60813f2015-05-10 21:48:08 +00002672 unsigned VBTableIndex = 0;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002673 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00002674 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00002675 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002676 llvm::Type *Ty;
2677 // Check whether the function has a computable LLVM signature.
2678 if (Types.isFuncTypeConvertible(FPT)) {
2679 // The function has a computable LLVM signature; use the correct type.
2680 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2681 } else {
2682 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2683 // function type is incomplete.
2684 Ty = CGM.PtrDiffTy;
2685 }
2686 FirstField = CGM.GetAddrOfFunction(MD, Ty);
Hans Wennborg88497d62013-11-15 17:24:45 +00002687 } else {
David Majnemere0e228a2015-06-11 08:12:44 +00002688 auto &VTableContext = CGM.getMicrosoftVTableContext();
2689 MicrosoftVTableContext::MethodVFTableLocation ML =
2690 VTableContext.getMethodVFTableLocation(MD);
David Majnemerc1709d32015-06-23 07:31:11 +00002691 FirstField = EmitVirtualMemPtrThunk(MD, ML);
David Majnemere0e228a2015-06-11 08:12:44 +00002692 // Include the vfptr adjustment if the method is in a non-primary vftable.
2693 NonVirtualBaseAdjustment += ML.VFPtrOffset;
2694 if (ML.VBase)
2695 VBTableIndex = VTableContext.getVBTableIndex(RD, ML.VBase) * 4;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002696 }
2697
David Majnemerc1709d32015-06-23 07:31:11 +00002698 if (VBTableIndex == 0 &&
2699 RD->getMSInheritanceModel() ==
2700 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002701 NonVirtualBaseAdjustment -= getContext().getOffsetOfBaseWithVBPtr(RD);
David Majnemerc1709d32015-06-23 07:31:11 +00002702
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002703 // The rest of the fields are common with data member pointers.
David Majnemerc1709d32015-06-23 07:31:11 +00002704 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002705 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002706 NonVirtualBaseAdjustment, VBTableIndex);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002707}
2708
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002709/// Member pointers are the same if they're either bitwise identical *or* both
2710/// null. Null-ness for function members is determined by the first field,
2711/// while for data member pointers we must compare all fields.
2712llvm::Value *
2713MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2714 llvm::Value *L,
2715 llvm::Value *R,
2716 const MemberPointerType *MPT,
2717 bool Inequality) {
2718 CGBuilderTy &Builder = CGF.Builder;
2719
2720 // Handle != comparisons by switching the sense of all boolean operations.
2721 llvm::ICmpInst::Predicate Eq;
2722 llvm::Instruction::BinaryOps And, Or;
2723 if (Inequality) {
2724 Eq = llvm::ICmpInst::ICMP_NE;
2725 And = llvm::Instruction::Or;
2726 Or = llvm::Instruction::And;
2727 } else {
2728 Eq = llvm::ICmpInst::ICMP_EQ;
2729 And = llvm::Instruction::And;
2730 Or = llvm::Instruction::Or;
2731 }
2732
2733 // If this is a single field member pointer (single inheritance), this is a
2734 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002735 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2736 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002737 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2738 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002739 return Builder.CreateICmp(Eq, L, R);
2740
2741 // Compare the first field.
2742 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2743 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2744 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2745
2746 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002747 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002748 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2749 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2750 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2751 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2752 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2753 if (Res)
2754 Res = Builder.CreateBinOp(And, Res, Cmp);
2755 else
2756 Res = Cmp;
2757 }
2758
2759 // Check if the first field is 0 if this is a function pointer.
2760 if (MPT->isMemberFunctionPointer()) {
2761 // (l1 == r1 && ...) || l0 == 0
2762 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2763 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2764 Res = Builder.CreateBinOp(Or, Res, IsZero);
2765 }
2766
2767 // Combine the comparison of the first field, which must always be true for
2768 // this comparison to succeeed.
2769 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2770}
2771
Reid Kleckner407e8b62013-03-22 19:02:54 +00002772llvm::Value *
2773MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2774 llvm::Value *MemPtr,
2775 const MemberPointerType *MPT) {
2776 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002777 llvm::SmallVector<llvm::Constant *, 4> fields;
2778 // We only need one field for member functions.
2779 if (MPT->isMemberFunctionPointer())
2780 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2781 else
2782 GetNullMemberPointerFields(MPT, fields);
2783 assert(!fields.empty());
2784 llvm::Value *FirstField = MemPtr;
2785 if (MemPtr->getType()->isStructTy())
2786 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2787 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002788
Reid Kleckner2341ae32013-04-11 18:13:19 +00002789 // For function member pointers, we only need to test the function pointer
2790 // field. The other fields if any can be garbage.
2791 if (MPT->isMemberFunctionPointer())
2792 return Res;
2793
2794 // Otherwise, emit a series of compares and combine the results.
2795 for (int I = 1, E = fields.size(); I < E; ++I) {
2796 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2797 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002798 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002799 }
2800 return Res;
2801}
2802
Reid Kleckner452abac2013-05-09 21:01:17 +00002803bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2804 llvm::Constant *Val) {
2805 // Function pointers are null if the pointer in the first field is null.
2806 if (MPT->isMemberFunctionPointer()) {
2807 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2808 Val->getAggregateElement(0U) : Val;
2809 return FirstField->isNullValue();
2810 }
2811
2812 // If it's not a function pointer and it's zero initializable, we can easily
2813 // check zero.
2814 if (isZeroInitializable(MPT) && Val->isNullValue())
2815 return true;
2816
2817 // Otherwise, break down all the fields for comparison. Hopefully these
2818 // little Constants are reused, while a big null struct might not be.
2819 llvm::SmallVector<llvm::Constant *, 4> Fields;
2820 GetNullMemberPointerFields(MPT, Fields);
2821 if (Fields.size() == 1) {
2822 assert(Val->getType()->isIntegerTy());
2823 return Val == Fields[0];
2824 }
2825
2826 unsigned I, E;
2827 for (I = 0, E = Fields.size(); I != E; ++I) {
2828 if (Val->getAggregateElement(I) != Fields[I])
2829 break;
2830 }
2831 return I == E;
2832}
2833
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002834llvm::Value *
2835MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002836 Address This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002837 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002838 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002839 llvm::Value **VBPtrOut) {
2840 CGBuilderTy &Builder = CGF.Builder;
2841 // Load the vbtable pointer from the vbptr in the instance.
John McCall7f416cc2015-09-08 08:05:57 +00002842 This = Builder.CreateElementBitCast(This, CGM.Int8Ty);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002843 llvm::Value *VBPtr =
John McCall7f416cc2015-09-08 08:05:57 +00002844 Builder.CreateInBoundsGEP(This.getPointer(), VBPtrOffset, "vbptr");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002845 if (VBPtrOut) *VBPtrOut = VBPtr;
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002846 VBPtr = Builder.CreateBitCast(VBPtr,
John McCall7f416cc2015-09-08 08:05:57 +00002847 CGM.Int32Ty->getPointerTo(0)->getPointerTo(This.getAddressSpace()));
2848
2849 CharUnits VBPtrAlign;
2850 if (auto CI = dyn_cast<llvm::ConstantInt>(VBPtrOffset)) {
2851 VBPtrAlign = This.getAlignment().alignmentAtOffset(
2852 CharUnits::fromQuantity(CI->getSExtValue()));
2853 } else {
2854 VBPtrAlign = CGF.getPointerAlign();
2855 }
2856
2857 llvm::Value *VBTable = Builder.CreateAlignedLoad(VBPtr, VBPtrAlign, "vbtable");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002858
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002859 // Translate from byte offset to table index. It improves analyzability.
2860 llvm::Value *VBTableIndex = Builder.CreateAShr(
2861 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
2862 "vbtindex", /*isExact=*/true);
2863
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002864 // Load an i32 offset from the vb-table.
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002865 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002866 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
John McCall7f416cc2015-09-08 08:05:57 +00002867 return Builder.CreateAlignedLoad(VBaseOffs, CharUnits::fromQuantity(4),
2868 "vbase_offs");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002869}
2870
Reid Kleckner2341ae32013-04-11 18:13:19 +00002871// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2872// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002873llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2874 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
John McCall7f416cc2015-09-08 08:05:57 +00002875 Address Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002876 CGBuilderTy &Builder = CGF.Builder;
John McCall7f416cc2015-09-08 08:05:57 +00002877 Base = Builder.CreateElementBitCast(Base, CGM.Int8Ty);
Craig Topper8a13c412014-05-21 05:09:00 +00002878 llvm::BasicBlock *OriginalBB = nullptr;
2879 llvm::BasicBlock *SkipAdjustBB = nullptr;
2880 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002881
2882 // In the unspecified inheritance model, there might not be a vbtable at all,
2883 // in which case we need to skip the virtual base lookup. If there is a
2884 // vbtable, the first entry is a no-op entry that gives back the original
2885 // base, so look for a virtual base adjustment offset of zero.
2886 if (VBPtrOffset) {
2887 OriginalBB = Builder.GetInsertBlock();
2888 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2889 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2890 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002891 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002892 "memptr.is_vbase");
2893 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2894 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002895 }
2896
Reid Kleckner2341ae32013-04-11 18:13:19 +00002897 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
2898 // know the vbptr offset.
2899 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002900 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00002901 if (!RD->hasDefinition()) {
2902 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
2903 unsigned DiagID = Diags.getCustomDiagID(
2904 DiagnosticsEngine::Error,
2905 "member pointer representation requires a "
2906 "complete class type for %0 to perform this expression");
2907 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
2908 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002909 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002910 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
2911 }
Craig Topper8a13c412014-05-21 05:09:00 +00002912 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002913 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002914 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002915 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
2916
2917 // Merge control flow with the case where we didn't have to adjust.
2918 if (VBaseAdjustBB) {
2919 Builder.CreateBr(SkipAdjustBB);
2920 CGF.EmitBlock(SkipAdjustBB);
2921 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
John McCall7f416cc2015-09-08 08:05:57 +00002922 Phi->addIncoming(Base.getPointer(), OriginalBB);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002923 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
2924 return Phi;
2925 }
2926 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002927}
2928
David Majnemer2b0d66d2014-02-20 23:22:07 +00002929llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
John McCall7f416cc2015-09-08 08:05:57 +00002930 CodeGenFunction &CGF, const Expr *E, Address Base, llvm::Value *MemPtr,
David Majnemer2b0d66d2014-02-20 23:22:07 +00002931 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002932 assert(MPT->isMemberDataPointer());
John McCall7f416cc2015-09-08 08:05:57 +00002933 unsigned AS = Base.getAddressSpace();
Reid Kleckner407e8b62013-03-22 19:02:54 +00002934 llvm::Type *PType =
2935 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
2936 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002937 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2938 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00002939
Reid Kleckner2341ae32013-04-11 18:13:19 +00002940 // Extract the fields we need, regardless of model. We'll apply them if we
2941 // have them.
2942 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002943 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2944 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002945 if (MemPtr->getType()->isStructTy()) {
2946 // We need to extract values.
2947 unsigned I = 0;
2948 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002949 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002950 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002951 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002952 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002953 }
2954
John McCall7f416cc2015-09-08 08:05:57 +00002955 llvm::Value *Addr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002956 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00002957 Addr = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00002958 VBPtrOffset);
John McCall7f416cc2015-09-08 08:05:57 +00002959 } else {
2960 Addr = Base.getPointer();
Reid Kleckner407e8b62013-03-22 19:02:54 +00002961 }
Reid Klecknerae945122013-12-05 22:44:07 +00002962
2963 // Cast to char*.
John McCall7f416cc2015-09-08 08:05:57 +00002964 Addr = Builder.CreateBitCast(Addr, CGF.Int8Ty->getPointerTo(AS));
Reid Klecknerae945122013-12-05 22:44:07 +00002965
2966 // Apply the offset, which we assume is non-null.
John McCall7f416cc2015-09-08 08:05:57 +00002967 Addr = Builder.CreateInBoundsGEP(Addr, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002968
2969 // Cast the address to the appropriate pointer type, adopting the address
2970 // space of the base pointer.
2971 return Builder.CreateBitCast(Addr, PType);
2972}
2973
Reid Kleckner452abac2013-05-09 21:01:17 +00002974llvm::Value *
2975MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
2976 const CastExpr *E,
2977 llvm::Value *Src) {
2978 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
2979 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
2980 E->getCastKind() == CK_ReinterpretMemberPointer);
2981
2982 // Use constant emission if we can.
2983 if (isa<llvm::Constant>(Src))
2984 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
2985
2986 // We may be adding or dropping fields from the member pointer, so we need
2987 // both types and the inheritance models of both records.
2988 const MemberPointerType *SrcTy =
2989 E->getSubExpr()->getType()->castAs<MemberPointerType>();
2990 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002991 bool IsFunc = SrcTy->isMemberFunctionPointer();
2992
2993 // If the classes use the same null representation, reinterpret_cast is a nop.
2994 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002995 if (IsReinterpret && IsFunc)
2996 return Src;
2997
2998 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
2999 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3000 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00003001 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00003002 return Src;
3003
3004 CGBuilderTy &Builder = CGF.Builder;
3005
3006 // Branch past the conversion if Src is null.
3007 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
3008 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
3009
3010 // C++ 5.2.10p9: The null member pointer value is converted to the null member
3011 // pointer value of the destination type.
3012 if (IsReinterpret) {
3013 // For reinterpret casts, sema ensures that src and dst are both functions
3014 // or data and have the same size, which means the LLVM types should match.
3015 assert(Src->getType() == DstNull->getType());
3016 return Builder.CreateSelect(IsNotNull, Src, DstNull);
3017 }
3018
3019 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
3020 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
3021 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
3022 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
3023 CGF.EmitBlock(ConvertBB);
3024
David Majnemer0d9ad682015-06-29 00:06:50 +00003025 llvm::Value *Dst = EmitNonNullMemberPointerConversion(
3026 SrcTy, DstTy, E->getCastKind(), E->path_begin(), E->path_end(), Src,
3027 Builder);
3028
3029 Builder.CreateBr(ContinueBB);
3030
3031 // In the continuation, choose between DstNull and Dst.
3032 CGF.EmitBlock(ContinueBB);
3033 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
3034 Phi->addIncoming(DstNull, OriginalBB);
3035 Phi->addIncoming(Dst, ConvertBB);
3036 return Phi;
3037}
3038
3039llvm::Value *MicrosoftCXXABI::EmitNonNullMemberPointerConversion(
3040 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3041 CastExpr::path_const_iterator PathBegin,
3042 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
3043 CGBuilderTy &Builder) {
3044 const CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3045 const CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3046 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
3047 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
3048 bool IsFunc = SrcTy->isMemberFunctionPointer();
3049 bool IsConstant = isa<llvm::Constant>(Src);
3050
Reid Kleckner452abac2013-05-09 21:01:17 +00003051 // Decompose src.
3052 llvm::Value *FirstField = Src;
David Majnemerc1709d32015-06-23 07:31:11 +00003053 llvm::Value *NonVirtualBaseAdjustment = getZeroInt();
3054 llvm::Value *VirtualBaseAdjustmentOffset = getZeroInt();
3055 llvm::Value *VBPtrOffset = getZeroInt();
Reid Kleckner96f8f932014-02-05 17:27:08 +00003056 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003057 // We need to extract values.
3058 unsigned I = 0;
3059 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003060 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003061 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003062 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003063 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003064 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003065 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
3066 }
3067
David Majnemer0d9ad682015-06-29 00:06:50 +00003068 bool IsDerivedToBase = (CK == CK_DerivedToBaseMemberPointer);
David Majnemerc1709d32015-06-23 07:31:11 +00003069 const MemberPointerType *DerivedTy = IsDerivedToBase ? SrcTy : DstTy;
3070 const CXXRecordDecl *DerivedClass = DerivedTy->getMostRecentCXXRecordDecl();
3071
Reid Kleckner452abac2013-05-09 21:01:17 +00003072 // For data pointers, we adjust the field offset directly. For functions, we
3073 // have a separate field.
David Majnemerc1709d32015-06-23 07:31:11 +00003074 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
3075
3076 // The virtual inheritance model has a quirk: the virtual base table is always
3077 // referenced when dereferencing a member pointer even if the member pointer
3078 // is non-virtual. This is accounted for by adjusting the non-virtual offset
3079 // to point backwards to the top of the MDC from the first VBase. Undo this
3080 // adjustment to normalize the member pointer.
3081 llvm::Value *SrcVBIndexEqZero =
3082 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3083 if (SrcInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3084 if (int64_t SrcOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003085 getContext().getOffsetOfBaseWithVBPtr(SrcRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003086 llvm::Value *UndoSrcAdjustment = Builder.CreateSelect(
3087 SrcVBIndexEqZero,
3088 llvm::ConstantInt::get(CGM.IntTy, SrcOffsetToFirstVBase),
3089 getZeroInt());
3090 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, UndoSrcAdjustment);
3091 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003092 }
3093
David Majnemerc1709d32015-06-23 07:31:11 +00003094 // A non-zero vbindex implies that we are dealing with a source member in a
3095 // floating virtual base in addition to some non-virtual offset. If the
3096 // vbindex is zero, we are dealing with a source that exists in a non-virtual,
3097 // fixed, base. The difference between these two cases is that the vbindex +
3098 // nvoffset *always* point to the member regardless of what context they are
3099 // evaluated in so long as the vbindex is adjusted. A member inside a fixed
3100 // base requires explicit nv adjustment.
3101 llvm::Constant *BaseClassOffset = llvm::ConstantInt::get(
David Majnemer0d9ad682015-06-29 00:06:50 +00003102 CGM.IntTy,
3103 CGM.computeNonVirtualBaseClassOffset(DerivedClass, PathBegin, PathEnd)
3104 .getQuantity());
David Majnemerc1709d32015-06-23 07:31:11 +00003105
3106 llvm::Value *NVDisp;
3107 if (IsDerivedToBase)
3108 NVDisp = Builder.CreateNSWSub(NVAdjustField, BaseClassOffset, "adj");
3109 else
3110 NVDisp = Builder.CreateNSWAdd(NVAdjustField, BaseClassOffset, "adj");
3111
3112 NVAdjustField = Builder.CreateSelect(SrcVBIndexEqZero, NVDisp, getZeroInt());
3113
3114 // Update the vbindex to an appropriate value in the destination because
3115 // SrcRD's vbtable might not be a strict prefix of the one in DstRD.
3116 llvm::Value *DstVBIndexEqZero = SrcVBIndexEqZero;
3117 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance) &&
3118 MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance)) {
3119 if (llvm::GlobalVariable *VDispMap =
3120 getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) {
3121 llvm::Value *VBIndex = Builder.CreateExactUDiv(
3122 VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003123 if (IsConstant) {
3124 llvm::Constant *Mapping = VDispMap->getInitializer();
3125 VirtualBaseAdjustmentOffset =
3126 Mapping->getAggregateElement(cast<llvm::Constant>(VBIndex));
3127 } else {
3128 llvm::Value *Idxs[] = {getZeroInt(), VBIndex};
3129 VirtualBaseAdjustmentOffset =
John McCall7f416cc2015-09-08 08:05:57 +00003130 Builder.CreateAlignedLoad(Builder.CreateInBoundsGEP(VDispMap, Idxs),
3131 CharUnits::fromQuantity(4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003132 }
David Majnemerc1709d32015-06-23 07:31:11 +00003133
3134 DstVBIndexEqZero =
3135 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3136 }
3137 }
3138
3139 // Set the VBPtrOffset to zero if the vbindex is zero. Otherwise, initialize
3140 // it to the offset of the vbptr.
3141 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance)) {
3142 llvm::Value *DstVBPtrOffset = llvm::ConstantInt::get(
3143 CGM.IntTy,
3144 getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity());
3145 VBPtrOffset =
3146 Builder.CreateSelect(DstVBIndexEqZero, getZeroInt(), DstVBPtrOffset);
3147 }
3148
3149 // Likewise, apply a similar adjustment so that dereferencing the member
3150 // pointer correctly accounts for the distance between the start of the first
3151 // virtual base and the top of the MDC.
3152 if (DstInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3153 if (int64_t DstOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003154 getContext().getOffsetOfBaseWithVBPtr(DstRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003155 llvm::Value *DoDstAdjustment = Builder.CreateSelect(
3156 DstVBIndexEqZero,
3157 llvm::ConstantInt::get(CGM.IntTy, DstOffsetToFirstVBase),
3158 getZeroInt());
3159 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, DoDstAdjustment);
3160 }
3161 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003162
3163 // Recompose dst from the null struct and the adjusted fields from src.
3164 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00003165 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003166 Dst = FirstField;
3167 } else {
David Majnemer0d9ad682015-06-29 00:06:50 +00003168 Dst = llvm::UndefValue::get(ConvertMemberPointerType(DstTy));
Reid Kleckner452abac2013-05-09 21:01:17 +00003169 unsigned Idx = 0;
3170 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003171 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003172 Dst = Builder.CreateInsertValue(Dst, NonVirtualBaseAdjustment, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003173 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003174 Dst = Builder.CreateInsertValue(Dst, VBPtrOffset, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003175 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003176 Dst = Builder.CreateInsertValue(Dst, VirtualBaseAdjustmentOffset, Idx++);
Reid Kleckner452abac2013-05-09 21:01:17 +00003177 }
David Majnemer0d9ad682015-06-29 00:06:50 +00003178 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003179}
3180
3181llvm::Constant *
3182MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
3183 llvm::Constant *Src) {
3184 const MemberPointerType *SrcTy =
David Majnemer5ca193c2015-06-23 07:31:07 +00003185 E->getSubExpr()->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003186 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3187
David Majnemer5ca193c2015-06-23 07:31:07 +00003188 CastKind CK = E->getCastKind();
3189
3190 return EmitMemberPointerConversion(SrcTy, DstTy, CK, E->path_begin(),
3191 E->path_end(), Src);
3192}
3193
3194llvm::Constant *MicrosoftCXXABI::EmitMemberPointerConversion(
3195 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3196 CastExpr::path_const_iterator PathBegin,
3197 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src) {
3198 assert(CK == CK_DerivedToBaseMemberPointer ||
3199 CK == CK_BaseToDerivedMemberPointer ||
3200 CK == CK_ReinterpretMemberPointer);
Reid Kleckner452abac2013-05-09 21:01:17 +00003201 // If src is null, emit a new null for dst. We can't return src because dst
3202 // might have a new representation.
3203 if (MemberPointerConstantIsNull(SrcTy, Src))
3204 return EmitNullMemberPointer(DstTy);
3205
3206 // We don't need to do anything for reinterpret_casts of non-null member
3207 // pointers. We should only get here when the two type representations have
3208 // the same size.
David Majnemer5ca193c2015-06-23 07:31:07 +00003209 if (CK == CK_ReinterpretMemberPointer)
Reid Kleckner452abac2013-05-09 21:01:17 +00003210 return Src;
3211
John McCall7f416cc2015-09-08 08:05:57 +00003212 CGBuilderTy Builder(CGM, CGM.getLLVMContext());
David Majnemer0d9ad682015-06-29 00:06:50 +00003213 auto *Dst = cast<llvm::Constant>(EmitNonNullMemberPointerConversion(
3214 SrcTy, DstTy, CK, PathBegin, PathEnd, Src, Builder));
Reid Kleckner452abac2013-05-09 21:01:17 +00003215
David Majnemer0d9ad682015-06-29 00:06:50 +00003216 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003217}
3218
David Majnemer2b0d66d2014-02-20 23:22:07 +00003219llvm::Value *MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
John McCall7f416cc2015-09-08 08:05:57 +00003220 CodeGenFunction &CGF, const Expr *E, Address This,
3221 llvm::Value *&ThisPtrForCall, llvm::Value *MemPtr,
3222 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003223 assert(MPT->isMemberFunctionPointer());
3224 const FunctionProtoType *FPT =
3225 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00003226 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003227 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(
3228 CGM.getTypes().arrangeCXXMethodType(RD, FPT, /*FD=*/nullptr));
Reid Kleckner2341ae32013-04-11 18:13:19 +00003229 CGBuilderTy &Builder = CGF.Builder;
3230
David Majnemer1cdd96d2014-01-17 09:01:00 +00003231 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003232
3233 // Extract the fields we need, regardless of model. We'll apply them if we
3234 // have them.
3235 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003236 llvm::Value *NonVirtualBaseAdjustment = nullptr;
3237 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3238 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003239 if (MemPtr->getType()->isStructTy()) {
3240 // We need to extract values.
3241 unsigned I = 0;
3242 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003243 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003244 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003245 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00003246 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003247 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003248 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3249 }
3250
3251 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003252 ThisPtrForCall = AdjustVirtualBase(CGF, E, RD, This,
3253 VirtualBaseAdjustmentOffset, VBPtrOffset);
3254 } else {
3255 ThisPtrForCall = This.getPointer();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003256 }
3257
3258 if (NonVirtualBaseAdjustment) {
3259 // Apply the adjustment and cast back to the original struct type.
John McCall7f416cc2015-09-08 08:05:57 +00003260 llvm::Value *Ptr = Builder.CreateBitCast(ThisPtrForCall, CGF.Int8PtrTy);
Reid Kleckner2341ae32013-04-11 18:13:19 +00003261 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
John McCall7f416cc2015-09-08 08:05:57 +00003262 ThisPtrForCall = Builder.CreateBitCast(Ptr, ThisPtrForCall->getType(),
3263 "this.adjusted");
Reid Kleckner2341ae32013-04-11 18:13:19 +00003264 }
3265
3266 return Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
3267}
3268
Charles Davis53c59df2010-08-16 03:33:14 +00003269CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00003270 return new MicrosoftCXXABI(CGM);
3271}
David Majnemere2cb8d12014-07-07 06:20:47 +00003272
3273// MS RTTI Overview:
3274// The run time type information emitted by cl.exe contains 5 distinct types of
3275// structures. Many of them reference each other.
3276//
3277// TypeInfo: Static classes that are returned by typeid.
3278//
3279// CompleteObjectLocator: Referenced by vftables. They contain information
3280// required for dynamic casting, including OffsetFromTop. They also contain
3281// a reference to the TypeInfo for the type and a reference to the
3282// CompleteHierarchyDescriptor for the type.
3283//
3284// ClassHieararchyDescriptor: Contains information about a class hierarchy.
3285// Used during dynamic_cast to walk a class hierarchy. References a base
3286// class array and the size of said array.
3287//
3288// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
3289// somewhat of a misnomer because the most derived class is also in the list
3290// as well as multiple copies of virtual bases (if they occur multiple times
3291// in the hiearchy.) The BaseClassArray contains one BaseClassDescriptor for
3292// every path in the hierarchy, in pre-order depth first order. Note, we do
3293// not declare a specific llvm type for BaseClassArray, it's merely an array
3294// of BaseClassDescriptor pointers.
3295//
3296// BaseClassDescriptor: Contains information about a class in a class hierarchy.
3297// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
3298// BaseClassArray is. It contains information about a class within a
3299// hierarchy such as: is this base is ambiguous and what is its offset in the
3300// vbtable. The names of the BaseClassDescriptors have all of their fields
3301// mangled into them so they can be aggressively deduplicated by the linker.
3302
David Majnemere2cb8d12014-07-07 06:20:47 +00003303static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
3304 StringRef MangledName("\01??_7type_info@@6B@");
3305 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
3306 return VTable;
3307 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
3308 /*Constant=*/true,
3309 llvm::GlobalVariable::ExternalLinkage,
3310 /*Initializer=*/nullptr, MangledName);
3311}
3312
3313namespace {
3314
3315/// \brief A Helper struct that stores information about a class in a class
3316/// hierarchy. The information stored in these structs struct is used during
3317/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
3318// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
3319// implicit depth first pre-order tree connectivity. getFirstChild and
3320// getNextSibling allow us to walk the tree efficiently.
3321struct MSRTTIClass {
3322 enum {
3323 IsPrivateOnPath = 1 | 8,
3324 IsAmbiguous = 2,
3325 IsPrivate = 4,
3326 IsVirtual = 16,
3327 HasHierarchyDescriptor = 64
3328 };
3329 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
3330 uint32_t initialize(const MSRTTIClass *Parent,
3331 const CXXBaseSpecifier *Specifier);
3332
3333 MSRTTIClass *getFirstChild() { return this + 1; }
3334 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
3335 return Child + 1 + Child->NumBases;
3336 }
3337
3338 const CXXRecordDecl *RD, *VirtualRoot;
3339 uint32_t Flags, NumBases, OffsetInVBase;
3340};
3341
3342/// \brief Recursively initialize the base class array.
3343uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
3344 const CXXBaseSpecifier *Specifier) {
3345 Flags = HasHierarchyDescriptor;
3346 if (!Parent) {
3347 VirtualRoot = nullptr;
3348 OffsetInVBase = 0;
3349 } else {
3350 if (Specifier->getAccessSpecifier() != AS_public)
3351 Flags |= IsPrivate | IsPrivateOnPath;
3352 if (Specifier->isVirtual()) {
3353 Flags |= IsVirtual;
3354 VirtualRoot = RD;
3355 OffsetInVBase = 0;
3356 } else {
3357 if (Parent->Flags & IsPrivateOnPath)
3358 Flags |= IsPrivateOnPath;
3359 VirtualRoot = Parent->VirtualRoot;
3360 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
3361 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
3362 }
3363 }
3364 NumBases = 0;
3365 MSRTTIClass *Child = getFirstChild();
3366 for (const CXXBaseSpecifier &Base : RD->bases()) {
3367 NumBases += Child->initialize(this, &Base) + 1;
3368 Child = getNextChild(Child);
3369 }
3370 return NumBases;
3371}
3372
3373static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
3374 switch (Ty->getLinkage()) {
3375 case NoLinkage:
3376 case InternalLinkage:
3377 case UniqueExternalLinkage:
3378 return llvm::GlobalValue::InternalLinkage;
3379
3380 case VisibleNoLinkage:
3381 case ExternalLinkage:
3382 return llvm::GlobalValue::LinkOnceODRLinkage;
3383 }
3384 llvm_unreachable("Invalid linkage!");
3385}
3386
3387/// \brief An ephemeral helper class for building MS RTTI types. It caches some
3388/// calls to the module and information about the most derived class in a
3389/// hierarchy.
3390struct MSRTTIBuilder {
3391 enum {
3392 HasBranchingHierarchy = 1,
3393 HasVirtualBranchingHierarchy = 2,
3394 HasAmbiguousBases = 4
3395 };
3396
David Majnemer611cdb92014-07-07 08:09:15 +00003397 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
3398 : CGM(ABI.CGM), Context(CGM.getContext()),
3399 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00003400 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003401 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00003402
3403 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
3404 llvm::GlobalVariable *
3405 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
3406 llvm::GlobalVariable *getClassHierarchyDescriptor();
3407 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo *Info);
3408
3409 CodeGenModule &CGM;
3410 ASTContext &Context;
3411 llvm::LLVMContext &VMContext;
3412 llvm::Module &Module;
3413 const CXXRecordDecl *RD;
3414 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00003415 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00003416};
3417
3418} // namespace
3419
3420/// \brief Recursively serializes a class hierarchy in pre-order depth first
3421/// order.
3422static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
3423 const CXXRecordDecl *RD) {
3424 Classes.push_back(MSRTTIClass(RD));
3425 for (const CXXBaseSpecifier &Base : RD->bases())
3426 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
3427}
3428
3429/// \brief Find ambiguity among base classes.
3430static void
3431detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
3432 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
3433 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
3434 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
3435 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
3436 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
David Blaikie82e95a32014-11-19 07:49:47 +00003437 !VirtualBases.insert(Class->RD).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003438 Class = MSRTTIClass::getNextChild(Class);
3439 continue;
3440 }
David Blaikie82e95a32014-11-19 07:49:47 +00003441 if (!UniqueBases.insert(Class->RD).second)
David Majnemere2cb8d12014-07-07 06:20:47 +00003442 AmbiguousBases.insert(Class->RD);
3443 Class++;
3444 }
3445 if (AmbiguousBases.empty())
3446 return;
3447 for (MSRTTIClass &Class : Classes)
3448 if (AmbiguousBases.count(Class.RD))
3449 Class.Flags |= MSRTTIClass::IsAmbiguous;
3450}
3451
3452llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
3453 SmallString<256> MangledName;
3454 {
3455 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003456 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003457 }
3458
3459 // Check to see if we've already declared this ClassHierarchyDescriptor.
3460 if (auto CHD = Module.getNamedGlobal(MangledName))
3461 return CHD;
3462
3463 // Serialize the class hierarchy and initialize the CHD Fields.
3464 SmallVector<MSRTTIClass, 8> Classes;
3465 serializeClassHierarchy(Classes, RD);
3466 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3467 detectAmbiguousBases(Classes);
3468 int Flags = 0;
3469 for (auto Class : Classes) {
3470 if (Class.RD->getNumBases() > 1)
3471 Flags |= HasBranchingHierarchy;
3472 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
3473 // believe the field isn't actually used.
3474 if (Class.Flags & MSRTTIClass::IsAmbiguous)
3475 Flags |= HasAmbiguousBases;
3476 }
3477 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
3478 Flags |= HasVirtualBranchingHierarchy;
3479 // These gep indices are used to get the address of the first element of the
3480 // base class array.
3481 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
3482 llvm::ConstantInt::get(CGM.IntTy, 0)};
3483
3484 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00003485 auto Type = ABI.getClassHierarchyDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003486 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3487 /*Initializer=*/nullptr,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003488 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003489 if (CHD->isWeakForLinker())
3490 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003491
David Blaikiee3b172a2015-04-02 18:55:21 +00003492 auto *Bases = getBaseClassArray(Classes);
3493
David Majnemere2cb8d12014-07-07 06:20:47 +00003494 // Initialize the base class ClassHierarchyDescriptor.
3495 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003496 llvm::ConstantInt::get(CGM.IntTy, 0), // Unknown
3497 llvm::ConstantInt::get(CGM.IntTy, Flags),
3498 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
3499 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00003500 Bases->getValueType(), Bases,
David Majnemer611cdb92014-07-07 08:09:15 +00003501 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00003502 };
3503 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3504 return CHD;
3505}
3506
3507llvm::GlobalVariable *
3508MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3509 SmallString<256> MangledName;
3510 {
3511 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003512 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003513 }
3514
3515 // Forward-declare the base class array.
3516 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3517 // mode) bytes of padding. We provide a pointer sized amount of padding by
3518 // adding +1 to Classes.size(). The sections have pointer alignment and are
3519 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00003520 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00003521 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00003522 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
David Majnemer7c237072015-03-05 00:46:22 +00003523 auto *BCA =
3524 new llvm::GlobalVariable(Module, ArrType,
3525 /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003526 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003527 if (BCA->isWeakForLinker())
3528 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003529
3530 // Initialize the BaseClassArray.
3531 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3532 for (MSRTTIClass &Class : Classes)
3533 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00003534 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00003535 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00003536 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00003537 return BCA;
3538}
3539
3540llvm::GlobalVariable *
3541MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3542 // Compute the fields for the BaseClassDescriptor. They are computed up front
3543 // because they are mangled into the name of the object.
3544 uint32_t OffsetInVBTable = 0;
3545 int32_t VBPtrOffset = -1;
3546 if (Class.VirtualRoot) {
3547 auto &VTableContext = CGM.getMicrosoftVTableContext();
3548 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3549 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3550 }
3551
3552 SmallString<256> MangledName;
3553 {
3554 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003555 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3556 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3557 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003558 }
3559
David Majnemer26a90f82014-07-07 15:29:10 +00003560 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00003561 if (auto BCD = Module.getNamedGlobal(MangledName))
3562 return BCD;
3563
3564 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00003565 auto Type = ABI.getBaseClassDescriptorType();
David Majnemer7c237072015-03-05 00:46:22 +00003566 auto BCD =
3567 new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003568 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003569 if (BCD->isWeakForLinker())
3570 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003571
3572 // Initialize the BaseClassDescriptor.
3573 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003574 ABI.getImageRelativeConstant(
David Majnemer443250f2015-03-17 20:35:00 +00003575 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003576 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3577 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3578 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3579 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3580 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3581 ABI.getImageRelativeConstant(
3582 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00003583 };
3584 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3585 return BCD;
3586}
3587
3588llvm::GlobalVariable *
3589MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo *Info) {
3590 SmallString<256> MangledName;
3591 {
3592 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003593 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info->MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003594 }
3595
3596 // Check to see if we've already computed this complete object locator.
3597 if (auto COL = Module.getNamedGlobal(MangledName))
3598 return COL;
3599
3600 // Compute the fields of the complete object locator.
3601 int OffsetToTop = Info->FullOffsetInMDC.getQuantity();
3602 int VFPtrOffset = 0;
3603 // The offset includes the vtordisp if one exists.
3604 if (const CXXRecordDecl *VBase = Info->getVBaseWithVPtr())
3605 if (Context.getASTRecordLayout(RD)
3606 .getVBaseOffsetsMap()
3607 .find(VBase)
3608 ->second.hasVtorDisp())
3609 VFPtrOffset = Info->NonVirtualOffset.getQuantity() + 4;
3610
3611 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00003612 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003613 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003614 /*Initializer=*/nullptr, MangledName);
David Majnemere2cb8d12014-07-07 06:20:47 +00003615
3616 // Initialize the CompleteObjectLocator.
3617 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003618 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3619 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3620 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3621 ABI.getImageRelativeConstant(
3622 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3623 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3624 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00003625 };
3626 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00003627 if (!ABI.isImageRelative())
3628 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00003629 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
Rafael Espindola654542a2015-01-16 19:23:42 +00003630 if (COL->isWeakForLinker())
3631 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003632 return COL;
3633}
3634
David Majnemerad803d42015-03-15 07:10:01 +00003635static QualType decomposeTypeForEH(ASTContext &Context, QualType T,
3636 bool &IsConst, bool &IsVolatile) {
3637 T = Context.getExceptionObjectType(T);
3638
3639 // C++14 [except.handle]p3:
3640 // A handler is a match for an exception object of type E if [...]
3641 // - the handler is of type cv T or const T& where T is a pointer type and
3642 // E is a pointer type that can be converted to T by [...]
3643 // - a qualification conversion
3644 IsConst = false;
3645 IsVolatile = false;
3646 QualType PointeeType = T->getPointeeType();
3647 if (!PointeeType.isNull()) {
3648 IsConst = PointeeType.isConstQualified();
3649 IsVolatile = PointeeType.isVolatileQualified();
3650 }
3651
3652 // Member pointer types like "const int A::*" are represented by having RTTI
3653 // for "int A::*" and separately storing the const qualifier.
3654 if (const auto *MPTy = T->getAs<MemberPointerType>())
3655 T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(),
3656 MPTy->getClass());
3657
3658 // Pointer types like "const int * const *" are represented by having RTTI
3659 // for "const int **" and separately storing the const qualifier.
3660 if (T->isPointerType())
3661 T = Context.getPointerType(PointeeType.getUnqualifiedType());
3662
3663 return T;
3664}
3665
Reid Kleckner10aa7702015-09-16 20:15:55 +00003666CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +00003667MicrosoftCXXABI::getAddrOfCXXCatchHandlerType(QualType Type,
3668 QualType CatchHandlerType) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003669 // TypeDescriptors for exceptions never have qualified pointer types,
David Majnemer443250f2015-03-17 20:35:00 +00003670 // qualifiers are stored seperately in order to support qualification
3671 // conversions.
3672 bool IsConst, IsVolatile;
3673 Type = decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile);
3674
David Majnemer5f0dd612015-03-17 20:35:05 +00003675 bool IsReference = CatchHandlerType->isReferenceType();
3676
David Majnemer5f0dd612015-03-17 20:35:05 +00003677 uint32_t Flags = 0;
3678 if (IsConst)
3679 Flags |= 1;
3680 if (IsVolatile)
3681 Flags |= 2;
3682 if (IsReference)
3683 Flags |= 8;
3684
Reid Kleckner10aa7702015-09-16 20:15:55 +00003685 return CatchTypeInfo{getAddrOfRTTIDescriptor(Type)->stripPointerCasts(),
3686 Flags};
David Majnemer443250f2015-03-17 20:35:00 +00003687}
3688
David Majnemere2cb8d12014-07-07 06:20:47 +00003689/// \brief Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
3690/// llvm::GlobalVariable * because different type descriptors have different
3691/// types, and need to be abstracted. They are abstracting by casting the
3692/// address to an Int8PtrTy.
David Majnemer443250f2015-03-17 20:35:00 +00003693llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003694 SmallString<256> MangledName;
David Majnemere2cb8d12014-07-07 06:20:47 +00003695 {
3696 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003697 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003698 }
3699
3700 // Check to see if we've already declared this TypeDescriptor.
3701 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3702 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3703
3704 // Compute the fields for the TypeDescriptor.
David Majnemer5f0dd612015-03-17 20:35:05 +00003705 SmallString<256> TypeInfoString;
David Majnemere2cb8d12014-07-07 06:20:47 +00003706 {
3707 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00003708 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003709 }
3710
3711 // Declare and initialize the TypeDescriptor.
3712 llvm::Constant *Fields[] = {
3713 getTypeInfoVTable(CGM), // VFPtr
3714 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3715 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3716 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00003717 getTypeDescriptorType(TypeInfoString);
Rafael Espindola654542a2015-01-16 19:23:42 +00003718 auto *Var = new llvm::GlobalVariable(
3719 CGM.getModule(), TypeDescriptorType, /*Constant=*/false,
3720 getLinkageForRTTI(Type),
3721 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
Yaron Keren2c07cc72015-12-01 08:14:39 +00003722 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003723 if (Var->isWeakForLinker())
3724 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3725 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003726}
3727
3728/// \brief Gets or a creates a Microsoft CompleteObjectLocator.
3729llvm::GlobalVariable *
3730MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
3731 const VPtrInfo *Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00003732 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003733}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003734
3735static void emitCXXConstructor(CodeGenModule &CGM,
3736 const CXXConstructorDecl *ctor,
3737 StructorType ctorType) {
Rafael Espindolad48b51b2014-09-15 19:24:44 +00003738 // There are no constructor variants, always emit the complete destructor.
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003739 llvm::Function *Fn = CGM.codegenCXXStructor(ctor, StructorType::Complete);
3740 CGM.maybeSetTrivialComdat(*ctor, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003741}
3742
3743static void emitCXXDestructor(CodeGenModule &CGM, const CXXDestructorDecl *dtor,
3744 StructorType dtorType) {
3745 // The complete destructor is equivalent to the base destructor for
3746 // classes with no virtual bases, so try to emit it as an alias.
3747 if (!dtor->getParent()->getNumVBases() &&
3748 (dtorType == StructorType::Complete || dtorType == StructorType::Base)) {
3749 bool ProducedAlias = !CGM.TryEmitDefinitionAsAlias(
3750 GlobalDecl(dtor, Dtor_Complete), GlobalDecl(dtor, Dtor_Base), true);
3751 if (ProducedAlias) {
3752 if (dtorType == StructorType::Complete)
3753 return;
3754 if (dtor->isVirtual())
3755 CGM.getVTables().EmitThunks(GlobalDecl(dtor, Dtor_Complete));
3756 }
3757 }
3758
3759 // The base destructor is equivalent to the base destructor of its
3760 // base class if there is exactly one non-virtual base class with a
3761 // non-trivial destructor, there are no fields with a non-trivial
3762 // destructor, and the body of the destructor is trivial.
3763 if (dtorType == StructorType::Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
3764 return;
3765
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003766 llvm::Function *Fn = CGM.codegenCXXStructor(dtor, dtorType);
Rafael Espindolad3e04692015-01-17 01:47:39 +00003767 if (Fn->isWeakForLinker())
3768 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003769}
3770
3771void MicrosoftCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3772 StructorType Type) {
3773 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
3774 emitCXXConstructor(CGM, CD, Type);
3775 return;
3776 }
3777 emitCXXDestructor(CGM, cast<CXXDestructorDecl>(MD), Type);
3778}
David Majnemer7c237072015-03-05 00:46:22 +00003779
David Majnemerdfa6d202015-03-11 18:36:39 +00003780llvm::Function *
David Majnemer37fd66e2015-03-13 22:36:55 +00003781MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
3782 CXXCtorType CT) {
3783 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
3784
David Majnemerdfa6d202015-03-11 18:36:39 +00003785 // Calculate the mangled name.
3786 SmallString<256> ThunkName;
3787 llvm::raw_svector_ostream Out(ThunkName);
David Majnemer37fd66e2015-03-13 22:36:55 +00003788 getMangleContext().mangleCXXCtor(CD, CT, Out);
David Majnemerdfa6d202015-03-11 18:36:39 +00003789
3790 // If the thunk has been generated previously, just return it.
3791 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
3792 return cast<llvm::Function>(GV);
3793
3794 // Create the llvm::Function.
David Majnemer37fd66e2015-03-13 22:36:55 +00003795 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT);
David Majnemerdfa6d202015-03-11 18:36:39 +00003796 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
3797 const CXXRecordDecl *RD = CD->getParent();
3798 QualType RecordTy = getContext().getRecordType(RD);
3799 llvm::Function *ThunkFn = llvm::Function::Create(
3800 ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule());
Reid Klecknerbba3cb92015-03-17 19:00:50 +00003801 ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>(
3802 FnInfo.getEffectiveCallingConvention()));
David Majnemer63aa2fb2015-06-30 21:23:51 +00003803 if (ThunkFn->isWeakForLinker())
3804 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
David Majnemer37fd66e2015-03-13 22:36:55 +00003805 bool IsCopy = CT == Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003806
3807 // Start codegen.
3808 CodeGenFunction CGF(CGM);
3809 CGF.CurGD = GlobalDecl(CD, Ctor_Complete);
3810
3811 // Build FunctionArgs.
3812 FunctionArgList FunctionArgs;
3813
David Majnemer37fd66e2015-03-13 22:36:55 +00003814 // A constructor always starts with a 'this' pointer as its first argument.
David Majnemerdfa6d202015-03-11 18:36:39 +00003815 buildThisParam(CGF, FunctionArgs);
3816
3817 // Following the 'this' pointer is a reference to the source object that we
3818 // are copying from.
3819 ImplicitParamDecl SrcParam(
3820 getContext(), nullptr, SourceLocation(), &getContext().Idents.get("src"),
3821 getContext().getLValueReferenceType(RecordTy,
3822 /*SpelledAsLValue=*/true));
David Majnemer37fd66e2015-03-13 22:36:55 +00003823 if (IsCopy)
3824 FunctionArgs.push_back(&SrcParam);
David Majnemerdfa6d202015-03-11 18:36:39 +00003825
David Majnemer37fd66e2015-03-13 22:36:55 +00003826 // Constructors for classes which utilize virtual bases have an additional
3827 // parameter which indicates whether or not it is being delegated to by a more
3828 // derived constructor.
David Majnemerdfa6d202015-03-11 18:36:39 +00003829 ImplicitParamDecl IsMostDerived(getContext(), nullptr, SourceLocation(),
3830 &getContext().Idents.get("is_most_derived"),
3831 getContext().IntTy);
3832 // Only add the parameter to the list if thie class has virtual bases.
3833 if (RD->getNumVBases() > 0)
3834 FunctionArgs.push_back(&IsMostDerived);
3835
3836 // Start defining the function.
3837 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
3838 FunctionArgs, CD->getLocation(), SourceLocation());
3839 EmitThisParam(CGF);
3840 llvm::Value *This = getThisValue(CGF);
3841
3842 llvm::Value *SrcVal =
David Majnemer37fd66e2015-03-13 22:36:55 +00003843 IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src")
3844 : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003845
3846 CallArgList Args;
3847
3848 // Push the this ptr.
3849 Args.add(RValue::get(This), CD->getThisType(getContext()));
3850
3851 // Push the src ptr.
David Majnemer37fd66e2015-03-13 22:36:55 +00003852 if (SrcVal)
3853 Args.add(RValue::get(SrcVal), SrcParam.getType());
David Majnemerdfa6d202015-03-11 18:36:39 +00003854
3855 // Add the rest of the default arguments.
3856 std::vector<Stmt *> ArgVec;
Reid Kleckner93f661a2015-03-17 21:51:43 +00003857 for (unsigned I = IsCopy ? 1 : 0, E = CD->getNumParams(); I != E; ++I) {
3858 Stmt *DefaultArg = getContext().getDefaultArgExprForConstructor(CD, I);
3859 assert(DefaultArg && "sema forgot to instantiate default args");
3860 ArgVec.push_back(DefaultArg);
3861 }
David Majnemerdfa6d202015-03-11 18:36:39 +00003862
3863 CodeGenFunction::RunCleanupsScope Cleanups(CGF);
3864
3865 const auto *FPT = CD->getType()->castAs<FunctionProtoType>();
David Blaikief05779e2015-07-21 18:37:18 +00003866 CGF.EmitCallArgs(Args, FPT, llvm::makeArrayRef(ArgVec), CD, IsCopy ? 1 : 0);
David Majnemerdfa6d202015-03-11 18:36:39 +00003867
3868 // Insert any ABI-specific implicit constructor arguments.
3869 unsigned ExtraArgs = addImplicitConstructorArgs(CGF, CD, Ctor_Complete,
3870 /*ForVirtualBase=*/false,
3871 /*Delegating=*/false, Args);
3872
3873 // Call the destructor with our arguments.
3874 llvm::Value *CalleeFn = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3875 const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall(
3876 Args, CD, Ctor_Complete, ExtraArgs);
3877 CGF.EmitCall(CalleeInfo, CalleeFn, ReturnValueSlot(), Args, CD);
3878
3879 Cleanups.ForceCleanup();
3880
3881 // Emit the ret instruction, remove any temporary instructions created for the
3882 // aid of CodeGen.
3883 CGF.FinishFunction(SourceLocation());
3884
3885 return ThunkFn;
3886}
3887
David Majnemer7c237072015-03-05 00:46:22 +00003888llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
3889 uint32_t NVOffset,
3890 int32_t VBPtrOffset,
3891 uint32_t VBIndex) {
3892 assert(!T->isReferenceType());
3893
David Majnemere7a818f2015-03-06 18:53:55 +00003894 CXXRecordDecl *RD = T->getAsCXXRecordDecl();
3895 const CXXConstructorDecl *CD =
3896 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003897 CXXCtorType CT = Ctor_Complete;
David Majnemer37fd66e2015-03-13 22:36:55 +00003898 if (CD)
3899 if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1)
David Majnemerdfa6d202015-03-11 18:36:39 +00003900 CT = Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003901
David Majnemer7c237072015-03-05 00:46:22 +00003902 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
3903 SmallString<256> MangledName;
3904 {
3905 llvm::raw_svector_ostream Out(MangledName);
David Majnemerdfa6d202015-03-11 18:36:39 +00003906 getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +00003907 VBPtrOffset, VBIndex, Out);
David Majnemer7c237072015-03-05 00:46:22 +00003908 }
3909 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3910 return getImageRelativeConstant(GV);
3911
David Majnemerdfa6d202015-03-11 18:36:39 +00003912 // The TypeDescriptor is used by the runtime to determine if a catch handler
David Majnemer7c237072015-03-05 00:46:22 +00003913 // is appropriate for the exception object.
David Majnemer443250f2015-03-17 20:35:00 +00003914 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
David Majnemer7c237072015-03-05 00:46:22 +00003915
3916 // The runtime is responsible for calling the copy constructor if the
3917 // exception is caught by value.
David Majnemerdfa6d202015-03-11 18:36:39 +00003918 llvm::Constant *CopyCtor;
3919 if (CD) {
3920 if (CT == Ctor_CopyingClosure)
David Majnemer37fd66e2015-03-13 22:36:55 +00003921 CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure);
David Majnemerdfa6d202015-03-11 18:36:39 +00003922 else
3923 CopyCtor = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3924
3925 CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy);
3926 } else {
3927 CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
3928 }
David Majnemere7a818f2015-03-06 18:53:55 +00003929 CopyCtor = getImageRelativeConstant(CopyCtor);
David Majnemer7c237072015-03-05 00:46:22 +00003930
David Majnemere7a818f2015-03-06 18:53:55 +00003931 bool IsScalar = !RD;
David Majnemer7c237072015-03-05 00:46:22 +00003932 bool HasVirtualBases = false;
3933 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
David Majnemer7c237072015-03-05 00:46:22 +00003934 QualType PointeeType = T;
3935 if (T->isPointerType())
3936 PointeeType = T->getPointeeType();
3937 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
3938 HasVirtualBases = RD->getNumVBases() > 0;
3939 if (IdentifierInfo *II = RD->getIdentifier())
3940 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
3941 }
3942
3943 // Encode the relevant CatchableType properties into the Flags bitfield.
3944 // FIXME: Figure out how bits 2 or 8 can get set.
3945 uint32_t Flags = 0;
3946 if (IsScalar)
3947 Flags |= 1;
3948 if (HasVirtualBases)
3949 Flags |= 4;
3950 if (IsStdBadAlloc)
3951 Flags |= 16;
3952
3953 llvm::Constant *Fields[] = {
3954 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
3955 TD, // TypeDescriptor
3956 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment
3957 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
3958 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex
3959 llvm::ConstantInt::get(CGM.IntTy, Size), // Size
3960 CopyCtor // CopyCtor
3961 };
3962 llvm::StructType *CTType = getCatchableTypeType();
3963 auto *GV = new llvm::GlobalVariable(
3964 CGM.getModule(), CTType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00003965 llvm::ConstantStruct::get(CTType, Fields), MangledName);
David Majnemer322fe412015-03-06 23:45:23 +00003966 GV->setUnnamedAddr(true);
3967 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00003968 if (GV->isWeakForLinker())
3969 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00003970 return getImageRelativeConstant(GV);
3971}
3972
3973llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
3974 assert(!T->isReferenceType());
3975
3976 // See if we've already generated a CatchableTypeArray for this type before.
3977 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
3978 if (CTA)
3979 return CTA;
3980
3981 // Ensure that we don't have duplicate entries in our CatchableTypeArray by
3982 // using a SmallSetVector. Duplicates may arise due to virtual bases
3983 // occurring more than once in the hierarchy.
3984 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
3985
3986 // C++14 [except.handle]p3:
3987 // A handler is a match for an exception object of type E if [...]
3988 // - the handler is of type cv T or cv T& and T is an unambiguous public
3989 // base class of E, or
3990 // - the handler is of type cv T or const T& where T is a pointer type and
3991 // E is a pointer type that can be converted to T by [...]
3992 // - a standard pointer conversion (4.10) not involving conversions to
3993 // pointers to private or protected or ambiguous classes
3994 const CXXRecordDecl *MostDerivedClass = nullptr;
3995 bool IsPointer = T->isPointerType();
3996 if (IsPointer)
3997 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
3998 else
3999 MostDerivedClass = T->getAsCXXRecordDecl();
4000
4001 // Collect all the unambiguous public bases of the MostDerivedClass.
4002 if (MostDerivedClass) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00004003 const ASTContext &Context = getContext();
David Majnemer7c237072015-03-05 00:46:22 +00004004 const ASTRecordLayout &MostDerivedLayout =
4005 Context.getASTRecordLayout(MostDerivedClass);
4006 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
4007 SmallVector<MSRTTIClass, 8> Classes;
4008 serializeClassHierarchy(Classes, MostDerivedClass);
4009 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
4010 detectAmbiguousBases(Classes);
4011 for (const MSRTTIClass &Class : Classes) {
4012 // Skip any ambiguous or private bases.
4013 if (Class.Flags &
4014 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
4015 continue;
4016 // Write down how to convert from a derived pointer to a base pointer.
4017 uint32_t OffsetInVBTable = 0;
4018 int32_t VBPtrOffset = -1;
4019 if (Class.VirtualRoot) {
4020 OffsetInVBTable =
4021 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
4022 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
4023 }
4024
4025 // Turn our record back into a pointer if the exception object is a
4026 // pointer.
4027 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
4028 if (IsPointer)
4029 RTTITy = Context.getPointerType(RTTITy);
4030 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
4031 VBPtrOffset, OffsetInVBTable));
4032 }
4033 }
4034
4035 // C++14 [except.handle]p3:
4036 // A handler is a match for an exception object of type E if
4037 // - The handler is of type cv T or cv T& and E and T are the same type
4038 // (ignoring the top-level cv-qualifiers)
4039 CatchableTypes.insert(getCatchableType(T));
4040
4041 // C++14 [except.handle]p3:
4042 // A handler is a match for an exception object of type E if
4043 // - the handler is of type cv T or const T& where T is a pointer type and
4044 // E is a pointer type that can be converted to T by [...]
4045 // - a standard pointer conversion (4.10) not involving conversions to
4046 // pointers to private or protected or ambiguous classes
4047 //
David Majnemerf205f532015-04-04 05:37:48 +00004048 // C++14 [conv.ptr]p2:
4049 // A prvalue of type "pointer to cv T," where T is an object type, can be
4050 // converted to a prvalue of type "pointer to cv void".
4051 if (IsPointer && T->getPointeeType()->isObjectType())
David Majnemer7c237072015-03-05 00:46:22 +00004052 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4053
David Majnemera1aea9a2015-03-12 17:44:49 +00004054 // C++14 [except.handle]p3:
4055 // A handler is a match for an exception object of type E if [...]
4056 // - the handler is of type cv T or const T& where T is a pointer or
4057 // pointer to member type and E is std::nullptr_t.
4058 //
4059 // We cannot possibly list all possible pointer types here, making this
4060 // implementation incompatible with the standard. However, MSVC includes an
4061 // entry for pointer-to-void in this case. Let's do the same.
4062 if (T->isNullPtrType())
4063 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4064
David Majnemer7c237072015-03-05 00:46:22 +00004065 uint32_t NumEntries = CatchableTypes.size();
4066 llvm::Type *CTType =
4067 getImageRelativeType(getCatchableTypeType()->getPointerTo());
4068 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
4069 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
4070 llvm::Constant *Fields[] = {
4071 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries
4072 llvm::ConstantArray::get(
4073 AT, llvm::makeArrayRef(CatchableTypes.begin(),
4074 CatchableTypes.end())) // CatchableTypes
4075 };
4076 SmallString<256> MangledName;
4077 {
4078 llvm::raw_svector_ostream Out(MangledName);
4079 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
4080 }
4081 CTA = new llvm::GlobalVariable(
4082 CGM.getModule(), CTAType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004083 llvm::ConstantStruct::get(CTAType, Fields), MangledName);
David Majnemer322fe412015-03-06 23:45:23 +00004084 CTA->setUnnamedAddr(true);
4085 CTA->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004086 if (CTA->isWeakForLinker())
4087 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004088 return CTA;
4089}
4090
4091llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
David Majnemerad803d42015-03-15 07:10:01 +00004092 bool IsConst, IsVolatile;
4093 T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile);
David Majnemer7c237072015-03-05 00:46:22 +00004094
4095 // The CatchableTypeArray enumerates the various (CV-unqualified) types that
4096 // the exception object may be caught as.
4097 llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
4098 // The first field in a CatchableTypeArray is the number of CatchableTypes.
4099 // This is used as a component of the mangled name which means that we need to
4100 // know what it is in order to see if we have previously generated the
4101 // ThrowInfo.
4102 uint32_t NumEntries =
4103 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
4104 ->getLimitedValue();
4105
4106 SmallString<256> MangledName;
4107 {
4108 llvm::raw_svector_ostream Out(MangledName);
4109 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, NumEntries,
4110 Out);
4111 }
4112
4113 // Reuse a previously generated ThrowInfo if we have generated an appropriate
4114 // one before.
4115 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4116 return GV;
4117
4118 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
4119 // be at least as CV qualified. Encode this requirement into the Flags
4120 // bitfield.
4121 uint32_t Flags = 0;
4122 if (IsConst)
4123 Flags |= 1;
4124 if (IsVolatile)
4125 Flags |= 2;
4126
4127 // The cleanup-function (a destructor) must be called when the exception
4128 // object's lifetime ends.
4129 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4130 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
4131 if (CXXDestructorDecl *DtorD = RD->getDestructor())
4132 if (!DtorD->isTrivial())
4133 CleanupFn = llvm::ConstantExpr::getBitCast(
4134 CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete),
4135 CGM.Int8PtrTy);
4136 // This is unused as far as we can tell, initialize it to null.
4137 llvm::Constant *ForwardCompat =
4138 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
4139 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
4140 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
4141 llvm::StructType *TIType = getThrowInfoType();
4142 llvm::Constant *Fields[] = {
4143 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4144 getImageRelativeConstant(CleanupFn), // CleanupFn
4145 ForwardCompat, // ForwardCompat
4146 PointerToCatchableTypes // CatchableTypeArray
4147 };
4148 auto *GV = new llvm::GlobalVariable(
4149 CGM.getModule(), TIType, /*Constant=*/true, getLinkageForRTTI(T),
4150 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00004151 GV->setUnnamedAddr(true);
4152 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004153 if (GV->isWeakForLinker())
4154 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004155 return GV;
4156}
4157
4158void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
4159 const Expr *SubExpr = E->getSubExpr();
4160 QualType ThrowType = SubExpr->getType();
4161 // The exception object lives on the stack and it's address is passed to the
4162 // runtime function.
John McCall7f416cc2015-09-08 08:05:57 +00004163 Address AI = CGF.CreateMemTemp(ThrowType);
David Majnemer7c237072015-03-05 00:46:22 +00004164 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
4165 /*IsInit=*/true);
4166
4167 // The so-called ThrowInfo is used to describe how the exception object may be
4168 // caught.
4169 llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
4170
4171 // Call into the runtime to throw the exception.
John McCall7f416cc2015-09-08 08:05:57 +00004172 llvm::Value *Args[] = {
4173 CGF.Builder.CreateBitCast(AI.getPointer(), CGM.Int8PtrTy),
4174 TI
4175 };
David Majnemer7c237072015-03-05 00:46:22 +00004176 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
4177}