blob: 542e1bf5fa37db39675e8d913e13ac1bcac3fb43 [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"
John McCall5ad74072017-03-02 20:04:19 +000023#include "clang/CodeGen/ConstantInitBuilder.h"
Charles Davis74ce8592010-06-09 23:25:41 +000024#include "clang/AST/Decl.h"
25#include "clang/AST/DeclCXX.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000026#include "clang/AST/StmtCXX.h"
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +000027#include "clang/AST/VTableBuilder.h"
David Majnemer611cdb92014-07-07 08:09:15 +000028#include "llvm/ADT/StringExtras.h"
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +000029#include "llvm/ADT/StringSet.h"
David Majnemer1162d252014-06-22 19:05:33 +000030#include "llvm/IR/CallSite.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000031#include "llvm/IR/Intrinsics.h"
Charles Davis74ce8592010-06-09 23:25:41 +000032
33using namespace clang;
34using namespace CodeGen;
35
36namespace {
37
Reid Klecknerb40a27d2014-01-03 00:14:35 +000038/// Holds all the vbtable globals for a given class.
39struct VBTableGlobals {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +000040 const VPtrInfoVector *VBTables;
Reid Klecknerb40a27d2014-01-03 00:14:35 +000041 SmallVector<llvm::GlobalVariable *, 2> Globals;
42};
43
Charles Davis53c59df2010-08-16 03:33:14 +000044class MicrosoftCXXABI : public CGCXXABI {
Charles Davis74ce8592010-06-09 23:25:41 +000045public:
David Majnemer611cdb92014-07-07 08:09:15 +000046 MicrosoftCXXABI(CodeGenModule &CGM)
47 : CGCXXABI(CGM), BaseClassDescriptorType(nullptr),
48 ClassHierarchyDescriptorType(nullptr),
David Majnemer7c237072015-03-05 00:46:22 +000049 CompleteObjectLocatorType(nullptr), CatchableTypeType(nullptr),
Benjamin Kramerc2d2b422015-10-15 15:29:40 +000050 ThrowInfoType(nullptr) {}
John McCall5d865c322010-08-31 07:33:07 +000051
Craig Topper4f12f102014-03-12 06:41:41 +000052 bool HasThisReturn(GlobalDecl GD) const override;
David Majnemer0c0b6d92014-10-31 20:09:12 +000053 bool hasMostDerivedReturn(GlobalDecl GD) const override;
Stephen Lin9dc6eef2013-06-30 20:40:16 +000054
Reid Kleckner40ca9132014-05-13 22:05:45 +000055 bool classifyReturnType(CGFunctionInfo &FI) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000056
Reid Klecknere39ee212014-05-03 00:33:28 +000057 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000058
Reid Kleckner37abaca2014-05-09 22:46:15 +000059 bool isSRetParameterAfterThis() const override { return true; }
60
John McCall7f416cc2015-09-08 08:05:57 +000061 bool isThisCompleteObject(GlobalDecl GD) const override {
62 // The Microsoft ABI doesn't use separate complete-object vs.
63 // base-object variants of constructors, but it does of destructors.
64 if (isa<CXXDestructorDecl>(GD.getDecl())) {
65 switch (GD.getDtorType()) {
66 case Dtor_Complete:
67 case Dtor_Deleting:
68 return true;
69
70 case Dtor_Base:
71 return false;
72
73 case Dtor_Comdat: llvm_unreachable("emitting dtor comdat as function?");
74 }
75 llvm_unreachable("bad dtor kind");
76 }
77
78 // No other kinds.
79 return false;
80 }
81
David Majnemer196ac332014-09-11 23:05:02 +000082 size_t getSrcArgforCopyCtor(const CXXConstructorDecl *CD,
83 FunctionArgList &Args) const override {
84 assert(Args.size() >= 2 &&
85 "expected the arglist to have at least two args!");
86 // The 'most_derived' parameter goes second if the ctor is variadic and
87 // has v-bases.
88 if (CD->getParent()->getNumVBases() > 0 &&
89 CD->getType()->castAs<FunctionProtoType>()->isVariadic())
90 return 2;
91 return 1;
92 }
93
David Majnemer8671c6e2015-11-02 09:01:44 +000094 std::vector<CharUnits> getVBPtrOffsets(const CXXRecordDecl *RD) override {
95 std::vector<CharUnits> VBPtrOffsets;
96 const ASTContext &Context = getContext();
97 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
98
99 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
Justin Lebar562914e2016-10-10 16:26:29 +0000100 for (const std::unique_ptr<VPtrInfo> &VBT : *VBGlobals.VBTables) {
David Majnemer8671c6e2015-11-02 09:01:44 +0000101 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +0000102 Context.getASTRecordLayout(VBT->IntroducingObject);
David Majnemer8671c6e2015-11-02 09:01:44 +0000103 CharUnits Offs = VBT->NonVirtualOffset;
104 Offs += SubobjectLayout.getVBPtrOffset();
105 if (VBT->getVBaseWithVPtr())
106 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
107 VBPtrOffsets.push_back(Offs);
108 }
109 llvm::array_pod_sort(VBPtrOffsets.begin(), VBPtrOffsets.end());
110 return VBPtrOffsets;
111 }
112
Craig Topper4f12f102014-03-12 06:41:41 +0000113 StringRef GetPureVirtualCallName() override { return "_purecall"; }
Craig Topper4f12f102014-03-12 06:41:41 +0000114 StringRef GetDeletedVirtualCallName() override { return "_purecall"; }
Joao Matos2ce88ef2012-07-17 17:10:11 +0000115
David Majnemer08681372014-11-01 07:37:17 +0000116 void emitVirtualObjectDelete(CodeGenFunction &CGF, const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000117 Address Ptr, QualType ElementType,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000118 const CXXDestructorDecl *Dtor) override;
John McCall82fb8922012-09-25 10:10:39 +0000119
Chandler Carruth4b9e8572014-11-25 08:59:34 +0000120 void emitRethrow(CodeGenFunction &CGF, bool isNoReturn) override;
David Majnemer7c237072015-03-05 00:46:22 +0000121 void emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) override;
David Majnemer442d0a22014-11-25 07:20:20 +0000122
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000123 void emitBeginCatch(CodeGenFunction &CGF, const CXXCatchStmt *C) override;
124
David Majnemere2cb8d12014-07-07 06:20:47 +0000125 llvm::GlobalVariable *getMSCompleteObjectLocator(const CXXRecordDecl *RD,
Justin Lebar562914e2016-10-10 16:26:29 +0000126 const VPtrInfo &Info);
David Majnemere2cb8d12014-07-07 06:20:47 +0000127
David Majnemer443250f2015-03-17 20:35:00 +0000128 llvm::Constant *getAddrOfRTTIDescriptor(QualType Ty) override;
Reid Kleckner10aa7702015-09-16 20:15:55 +0000129 CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +0000130 getAddrOfCXXCatchHandlerType(QualType Ty, QualType CatchHandlerType) override;
David Majnemere2cb8d12014-07-07 06:20:47 +0000131
Reid Kleckner10aa7702015-09-16 20:15:55 +0000132 /// MSVC needs an extra flag to indicate a catchall.
133 CatchTypeInfo getCatchAllTypeInfo() override {
134 return CatchTypeInfo{nullptr, 0x40};
135 }
136
David Majnemer1162d252014-06-22 19:05:33 +0000137 bool shouldTypeidBeNullChecked(bool IsDeref, QualType SrcRecordTy) override;
138 void EmitBadTypeidCall(CodeGenFunction &CGF) override;
139 llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000140 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000141 llvm::Type *StdTypeInfoPtrTy) override;
142
143 bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
144 QualType SrcRecordTy) override;
145
John McCall7f416cc2015-09-08 08:05:57 +0000146 llvm::Value *EmitDynamicCastCall(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000147 QualType SrcRecordTy, QualType DestTy,
148 QualType DestRecordTy,
149 llvm::BasicBlock *CastEnd) override;
150
John McCall7f416cc2015-09-08 08:05:57 +0000151 llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000152 QualType SrcRecordTy,
153 QualType DestTy) override;
154
155 bool EmitBadCastCall(CodeGenFunction &CGF) override;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000156 bool canSpeculativelyEmitVTable(const CXXRecordDecl *RD) const override {
Piotr Padlewskia68a7872015-07-24 04:04:49 +0000157 return false;
158 }
David Majnemer1162d252014-06-22 19:05:33 +0000159
Craig Topper4f12f102014-03-12 06:41:41 +0000160 llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +0000161 GetVirtualBaseClassOffset(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000162 const CXXRecordDecl *ClassDecl,
163 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000164
Craig Topper4f12f102014-03-12 06:41:41 +0000165 llvm::BasicBlock *
166 EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
167 const CXXRecordDecl *RD) override;
Erich Keane13c7ec52016-12-07 00:21:45 +0000168
169 llvm::BasicBlock *
170 EmitDtorCompleteObjectHandler(CodeGenFunction &CGF);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000171
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000172 void initializeHiddenVirtualInheritanceMembers(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000173 const CXXRecordDecl *RD) override;
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000174
Craig Topper4f12f102014-03-12 06:41:41 +0000175 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000176
Reid Klecknere7de47e2013-07-22 13:51:44 +0000177 // Background on MSVC destructors
178 // ==============================
179 //
180 // Both Itanium and MSVC ABIs have destructor variants. The variant names
181 // roughly correspond in the following way:
182 // Itanium Microsoft
183 // Base -> no name, just ~Class
184 // Complete -> vbase destructor
185 // Deleting -> scalar deleting destructor
186 // vector deleting destructor
187 //
188 // The base and complete destructors are the same as in Itanium, although the
189 // complete destructor does not accept a VTT parameter when there are virtual
190 // bases. A separate mechanism involving vtordisps is used to ensure that
191 // virtual methods of destroyed subobjects are not called.
192 //
193 // The deleting destructors accept an i32 bitfield as a second parameter. Bit
194 // 1 indicates if the memory should be deleted. Bit 2 indicates if the this
195 // pointer points to an array. The scalar deleting destructor assumes that
196 // bit 2 is zero, and therefore does not contain a loop.
197 //
198 // For virtual destructors, only one entry is reserved in the vftable, and it
199 // always points to the vector deleting destructor. The vector deleting
200 // destructor is the most general, so it can be used to destroy objects in
201 // place, delete single heap objects, or delete arrays.
202 //
203 // A TU defining a non-inline destructor is only guaranteed to emit a base
204 // destructor, and all of the other variants are emitted on an as-needed basis
205 // in COMDATs. Because a non-base destructor can be emitted in a TU that
206 // lacks a definition for the destructor, non-base destructors must always
207 // delegate to or alias the base destructor.
208
George Burgess IVf203dbf2017-02-22 20:28:02 +0000209 AddedStructorArgs
210 buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
211 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000212
Reid Klecknere7de47e2013-07-22 13:51:44 +0000213 /// Non-base dtors should be emitted as delegating thunks in this ABI.
214 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000215 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000216 return DT != Dtor_Base;
217 }
218
Reid Klecknerae9b0702018-03-16 19:40:50 +0000219 void setCXXDestructorDLLStorage(llvm::GlobalValue *GV,
220 const CXXDestructorDecl *Dtor,
221 CXXDtorType DT) const override;
222
223 llvm::GlobalValue::LinkageTypes
224 getCXXDestructorLinkage(GVALinkage Linkage, const CXXDestructorDecl *Dtor,
225 CXXDtorType DT) const override;
226
Craig Topper4f12f102014-03-12 06:41:41 +0000227 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000228
Craig Topper4f12f102014-03-12 06:41:41 +0000229 const CXXRecordDecl *
230 getThisArgumentTypeForMethod(const CXXMethodDecl *MD) override {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000231 MD = MD->getCanonicalDecl();
232 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD)) {
Nico Webere7c7d702018-03-31 18:26:25 +0000233 MicrosoftVTableContext::MethodVFTableLocation ML =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000234 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000235 // The vbases might be ordered differently in the final overrider object
236 // and the complete object, so the "this" argument may sometimes point to
237 // memory that has no particular type (e.g. past the complete object).
238 // In this case, we just use a generic pointer type.
239 // FIXME: might want to have a more precise type in the non-virtual
240 // multiple inheritance case.
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +0000241 if (ML.VBase || !ML.VFPtrOffset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000242 return nullptr;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000243 }
244 return MD->getParent();
245 }
246
John McCall7f416cc2015-09-08 08:05:57 +0000247 Address
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000248 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD,
John McCall7f416cc2015-09-08 08:05:57 +0000249 Address This,
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000250 bool VirtualCall) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000251
Reid Kleckner89077a12013-12-17 19:46:40 +0000252 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000253 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000254
Craig Topper4f12f102014-03-12 06:41:41 +0000255 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall29036752011-01-27 02:46:02 +0000256
George Burgess IVf203dbf2017-02-22 20:28:02 +0000257 AddedStructorArgs
258 addImplicitConstructorArgs(CodeGenFunction &CGF, const CXXConstructorDecl *D,
259 CXXCtorType Type, bool ForVirtualBase,
260 bool Delegating, CallArgList &Args) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000261
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000262 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
263 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +0000264 bool Delegating, Address This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000265
Justin Lebar562914e2016-10-10 16:26:29 +0000266 void emitVTableTypeMetadata(const VPtrInfo &Info, const CXXRecordDecl *RD,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +0000267 llvm::GlobalVariable *VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +0000268
Craig Topper4f12f102014-03-12 06:41:41 +0000269 void emitVTableDefinitions(CodeGenVTables &CGVT,
270 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000271
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000272 bool isVirtualOffsetNeededForVTableField(CodeGenFunction &CGF,
273 CodeGenFunction::VPtr Vptr) override;
274
275 /// Don't initialize vptrs if dynamic class
276 /// is marked with with the 'novtable' attribute.
277 bool doStructorsInitializeVPtrs(const CXXRecordDecl *VTableClass) override {
278 return !VTableClass->hasAttr<MSNoVTableAttr>();
279 }
280
281 llvm::Constant *
282 getVTableAddressPoint(BaseSubobject Base,
283 const CXXRecordDecl *VTableClass) override;
284
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000285 llvm::Value *getVTableAddressPointInStructor(
286 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000287 BaseSubobject Base, const CXXRecordDecl *NearestVBase) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000288
289 llvm::Constant *
290 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000291 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000292
293 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000294 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000295
John McCall9831b842018-02-06 18:52:44 +0000296 CGCallee getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
297 Address This, llvm::Type *Ty,
298 SourceLocation Loc) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000299
David Majnemer0c0b6d92014-10-31 20:09:12 +0000300 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF,
301 const CXXDestructorDecl *Dtor,
302 CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +0000303 Address This,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000304 const CXXMemberCallExpr *CE) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000305
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000306 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000307 CallArgList &CallArgs) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000308 assert(GD.getDtorType() == Dtor_Deleting &&
309 "Only deleting destructor thunks are available in this ABI");
310 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)),
David Majnemer9ced3dd2015-03-14 23:44:48 +0000311 getContext().IntTy);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000312 }
313
Craig Topper4f12f102014-03-12 06:41:41 +0000314 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000315
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000316 llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000317 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000318 llvm::GlobalVariable::LinkageTypes Linkage);
319
David Majnemerc1709d32015-06-23 07:31:11 +0000320 llvm::GlobalVariable *
321 getAddrOfVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
322 const CXXRecordDecl *DstRD) {
323 SmallString<256> OutName;
324 llvm::raw_svector_ostream Out(OutName);
325 getMangleContext().mangleCXXVirtualDisplacementMap(SrcRD, DstRD, Out);
David Majnemerc1709d32015-06-23 07:31:11 +0000326 StringRef MangledName = OutName.str();
327
328 if (auto *VDispMap = CGM.getModule().getNamedGlobal(MangledName))
329 return VDispMap;
330
331 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
332 unsigned NumEntries = 1 + SrcRD->getNumVBases();
333 SmallVector<llvm::Constant *, 4> Map(NumEntries,
334 llvm::UndefValue::get(CGM.IntTy));
335 Map[0] = llvm::ConstantInt::get(CGM.IntTy, 0);
336 bool AnyDifferent = false;
337 for (const auto &I : SrcRD->vbases()) {
338 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
339 if (!DstRD->isVirtuallyDerivedFrom(VBase))
340 continue;
341
342 unsigned SrcVBIndex = VTContext.getVBTableIndex(SrcRD, VBase);
343 unsigned DstVBIndex = VTContext.getVBTableIndex(DstRD, VBase);
344 Map[SrcVBIndex] = llvm::ConstantInt::get(CGM.IntTy, DstVBIndex * 4);
345 AnyDifferent |= SrcVBIndex != DstVBIndex;
346 }
347 // This map would be useless, don't use it.
348 if (!AnyDifferent)
349 return nullptr;
350
351 llvm::ArrayType *VDispMapTy = llvm::ArrayType::get(CGM.IntTy, Map.size());
352 llvm::Constant *Init = llvm::ConstantArray::get(VDispMapTy, Map);
353 llvm::GlobalValue::LinkageTypes Linkage =
354 SrcRD->isExternallyVisible() && DstRD->isExternallyVisible()
355 ? llvm::GlobalValue::LinkOnceODRLinkage
356 : llvm::GlobalValue::InternalLinkage;
357 auto *VDispMap = new llvm::GlobalVariable(
358 CGM.getModule(), VDispMapTy, /*Constant=*/true, Linkage,
359 /*Initializer=*/Init, MangledName);
360 return VDispMap;
361 }
362
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000363 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000364 llvm::GlobalVariable *GV) const;
365
Hans Wennborgc94391d2014-06-06 20:04:01 +0000366 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
367 GlobalDecl GD, bool ReturnAdjustment) override {
Hans Wennborgc94391d2014-06-06 20:04:01 +0000368 GVALinkage Linkage =
369 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
370
371 if (Linkage == GVA_Internal)
372 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
373 else if (ReturnAdjustment)
374 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
375 else
376 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000377 }
378
Rafael Espindolab7350042018-03-01 00:35:47 +0000379 bool exportThunk() override { return false; }
380
John McCall7f416cc2015-09-08 08:05:57 +0000381 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000382 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000383
John McCall7f416cc2015-09-08 08:05:57 +0000384 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000385 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000386
David Majnemerb3341ea2014-10-05 05:05:40 +0000387 void EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +0000388 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +0000389 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +0000390 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000391
392 bool usesThreadWrapperFunction() const override { return false; }
393 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
394 QualType LValType) override;
395
John McCallc84ed6a2012-05-01 06:13:13 +0000396 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
397 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000398 bool PerformInit) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000399 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
400 llvm::Constant *Dtor, llvm::Constant *Addr) override;
John McCallc84ed6a2012-05-01 06:13:13 +0000401
John McCall29036752011-01-27 02:46:02 +0000402 // ==== Notes on array cookies =========
403 //
404 // MSVC seems to only use cookies when the class has a destructor; a
405 // two-argument usual array deallocation function isn't sufficient.
406 //
407 // For example, this code prints "100" and "1":
408 // struct A {
409 // char x;
410 // void *operator new[](size_t sz) {
411 // printf("%u\n", sz);
412 // return malloc(sz);
413 // }
414 // void operator delete[](void *p, size_t sz) {
415 // printf("%u\n", sz);
416 // free(p);
417 // }
418 // };
419 // int main() {
420 // A *p = new A[100];
421 // delete[] p;
422 // }
423 // Whereas it prints "104" and "104" if you give A a destructor.
John McCallb91cd662012-05-01 05:23:51 +0000424
Craig Topper4f12f102014-03-12 06:41:41 +0000425 bool requiresArrayCookie(const CXXDeleteExpr *expr,
426 QualType elementType) override;
427 bool requiresArrayCookie(const CXXNewExpr *expr) override;
428 CharUnits getArrayCookieSizeImpl(QualType type) override;
John McCall7f416cc2015-09-08 08:05:57 +0000429 Address InitializeArrayCookie(CodeGenFunction &CGF,
430 Address NewPtr,
431 llvm::Value *NumElements,
432 const CXXNewExpr *expr,
433 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000434 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000435 Address allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000436 CharUnits cookieSize) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000437
David Majnemer611cdb92014-07-07 08:09:15 +0000438 friend struct MSRTTIBuilder;
439
440 bool isImageRelative() const {
441 return CGM.getTarget().getPointerWidth(/*AddressSpace=*/0) == 64;
442 }
443
444 // 5 routines for constructing the llvm types for MS RTTI structs.
445 llvm::StructType *getTypeDescriptorType(StringRef TypeInfoString) {
446 llvm::SmallString<32> TDTypeName("rtti.TypeDescriptor");
447 TDTypeName += llvm::utostr(TypeInfoString.size());
448 llvm::StructType *&TypeDescriptorType =
449 TypeDescriptorTypeMap[TypeInfoString.size()];
450 if (TypeDescriptorType)
451 return TypeDescriptorType;
452 llvm::Type *FieldTypes[] = {
453 CGM.Int8PtrPtrTy,
454 CGM.Int8PtrTy,
455 llvm::ArrayType::get(CGM.Int8Ty, TypeInfoString.size() + 1)};
456 TypeDescriptorType =
457 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, TDTypeName);
458 return TypeDescriptorType;
459 }
460
461 llvm::Type *getImageRelativeType(llvm::Type *PtrType) {
462 if (!isImageRelative())
463 return PtrType;
464 return CGM.IntTy;
465 }
466
467 llvm::StructType *getBaseClassDescriptorType() {
468 if (BaseClassDescriptorType)
469 return BaseClassDescriptorType;
470 llvm::Type *FieldTypes[] = {
471 getImageRelativeType(CGM.Int8PtrTy),
472 CGM.IntTy,
473 CGM.IntTy,
474 CGM.IntTy,
475 CGM.IntTy,
476 CGM.IntTy,
477 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
478 };
479 BaseClassDescriptorType = llvm::StructType::create(
480 CGM.getLLVMContext(), FieldTypes, "rtti.BaseClassDescriptor");
481 return BaseClassDescriptorType;
482 }
483
484 llvm::StructType *getClassHierarchyDescriptorType() {
485 if (ClassHierarchyDescriptorType)
486 return ClassHierarchyDescriptorType;
487 // Forward-declare RTTIClassHierarchyDescriptor to break a cycle.
488 ClassHierarchyDescriptorType = llvm::StructType::create(
489 CGM.getLLVMContext(), "rtti.ClassHierarchyDescriptor");
490 llvm::Type *FieldTypes[] = {
491 CGM.IntTy,
492 CGM.IntTy,
493 CGM.IntTy,
494 getImageRelativeType(
495 getBaseClassDescriptorType()->getPointerTo()->getPointerTo()),
496 };
497 ClassHierarchyDescriptorType->setBody(FieldTypes);
498 return ClassHierarchyDescriptorType;
499 }
500
501 llvm::StructType *getCompleteObjectLocatorType() {
502 if (CompleteObjectLocatorType)
503 return CompleteObjectLocatorType;
504 CompleteObjectLocatorType = llvm::StructType::create(
505 CGM.getLLVMContext(), "rtti.CompleteObjectLocator");
506 llvm::Type *FieldTypes[] = {
507 CGM.IntTy,
508 CGM.IntTy,
509 CGM.IntTy,
510 getImageRelativeType(CGM.Int8PtrTy),
511 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
512 getImageRelativeType(CompleteObjectLocatorType),
513 };
514 llvm::ArrayRef<llvm::Type *> FieldTypesRef(FieldTypes);
515 if (!isImageRelative())
516 FieldTypesRef = FieldTypesRef.drop_back();
517 CompleteObjectLocatorType->setBody(FieldTypesRef);
518 return CompleteObjectLocatorType;
519 }
520
521 llvm::GlobalVariable *getImageBase() {
522 StringRef Name = "__ImageBase";
523 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name))
524 return GV;
525
Rafael Espindola1c406472018-03-22 23:02:19 +0000526 auto *GV = new llvm::GlobalVariable(CGM.getModule(), CGM.Int8Ty,
527 /*isConstant=*/true,
528 llvm::GlobalValue::ExternalLinkage,
529 /*Initializer=*/nullptr, Name);
530 CGM.setDSOLocal(GV);
531 return GV;
David Majnemer611cdb92014-07-07 08:09:15 +0000532 }
533
534 llvm::Constant *getImageRelativeConstant(llvm::Constant *PtrVal) {
535 if (!isImageRelative())
536 return PtrVal;
537
David Majnemer7c237072015-03-05 00:46:22 +0000538 if (PtrVal->isNullValue())
539 return llvm::Constant::getNullValue(CGM.IntTy);
540
David Majnemer611cdb92014-07-07 08:09:15 +0000541 llvm::Constant *ImageBaseAsInt =
542 llvm::ConstantExpr::getPtrToInt(getImageBase(), CGM.IntPtrTy);
543 llvm::Constant *PtrValAsInt =
544 llvm::ConstantExpr::getPtrToInt(PtrVal, CGM.IntPtrTy);
545 llvm::Constant *Diff =
546 llvm::ConstantExpr::getSub(PtrValAsInt, ImageBaseAsInt,
547 /*HasNUW=*/true, /*HasNSW=*/true);
548 return llvm::ConstantExpr::getTrunc(Diff, CGM.IntTy);
549 }
550
Reid Kleckner407e8b62013-03-22 19:02:54 +0000551private:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000552 MicrosoftMangleContext &getMangleContext() {
553 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext());
554 }
555
Reid Kleckner2341ae32013-04-11 18:13:19 +0000556 llvm::Constant *getZeroInt() {
557 return llvm::ConstantInt::get(CGM.IntTy, 0);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000558 }
559
Reid Kleckner2341ae32013-04-11 18:13:19 +0000560 llvm::Constant *getAllOnesInt() {
561 return llvm::Constant::getAllOnesValue(CGM.IntTy);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000562 }
563
Reid Kleckner0358cbf2016-07-01 02:41:25 +0000564 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) override;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000565
Reid Kleckner2341ae32013-04-11 18:13:19 +0000566 void
567 GetNullMemberPointerFields(const MemberPointerType *MPT,
568 llvm::SmallVectorImpl<llvm::Constant *> &fields);
569
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000570 /// \brief Shared code for virtual base adjustment. Returns the offset from
571 /// the vbptr to the virtual base. Optionally returns the address of the
572 /// vbptr itself.
573 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000574 Address Base,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000575 llvm::Value *VBPtrOffset,
576 llvm::Value *VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000577 llvm::Value **VBPtr = nullptr);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000578
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000579 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000580 Address Base,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000581 int32_t VBPtrOffset,
582 int32_t VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000583 llvm::Value **VBPtr = nullptr) {
Reid Kleckner0ba8ba42014-10-22 17:26:00 +0000584 assert(VBTableOffset % 4 == 0 && "should be byte offset into table of i32s");
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000585 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
586 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset);
587 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr);
588 }
589
Peter Collingbourne60108802017-12-13 21:53:04 +0000590 std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000591 performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000592 QualType SrcRecordTy);
593
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000594 /// \brief Performs a full virtual base adjustment. Used to dereference
595 /// pointers to members of virtual bases.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000596 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000597 const CXXRecordDecl *RD, Address Base,
Reid Kleckner2341ae32013-04-11 18:13:19 +0000598 llvm::Value *VirtualBaseAdjustmentOffset,
599 llvm::Value *VBPtrOffset /* optional */);
600
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000601 /// \brief Emits a full member pointer with the fields common to data and
602 /// function member pointers.
603 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField,
604 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +0000605 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +0000606 CharUnits NonVirtualBaseAdjustment,
607 unsigned VBTableIndex);
Reid Kleckner452abac2013-05-09 21:01:17 +0000608
Reid Kleckner452abac2013-05-09 21:01:17 +0000609 bool MemberPointerConstantIsNull(const MemberPointerType *MPT,
610 llvm::Constant *MP);
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000611
Reid Kleckner7810af02013-06-19 15:20:38 +0000612 /// \brief - Initialize all vbptrs of 'this' with RD as the complete type.
613 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
614
615 /// \brief Caching wrapper around VBTableBuilder::enumerateVBTables().
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000616 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000617
Hans Wennborg88497d62013-11-15 17:24:45 +0000618 /// \brief Generate a thunk for calling a virtual member function MD.
Nico Webere7c7d702018-03-31 18:26:25 +0000619 llvm::Function *EmitVirtualMemPtrThunk(
620 const CXXMethodDecl *MD,
621 const MicrosoftVTableContext::MethodVFTableLocation &ML);
Hans Wennborg88497d62013-11-15 17:24:45 +0000622
Reid Kleckner407e8b62013-03-22 19:02:54 +0000623public:
Craig Topper4f12f102014-03-12 06:41:41 +0000624 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000625
Craig Topper4f12f102014-03-12 06:41:41 +0000626 bool isZeroInitializable(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000627
David Majnemerb3e56542014-08-07 22:56:13 +0000628 bool isMemberPointerConvertible(const MemberPointerType *MPT) const override {
629 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemer99281062014-09-18 22:05:54 +0000630 return RD->hasAttr<MSInheritanceAttr>();
631 }
632
Craig Topper4f12f102014-03-12 06:41:41 +0000633 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000634
Craig Topper4f12f102014-03-12 06:41:41 +0000635 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
636 CharUnits offset) override;
David Majnemere2be95b2015-06-23 07:31:01 +0000637 llvm::Constant *EmitMemberFunctionPointer(const CXXMethodDecl *MD) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000638 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000639
Craig Topper4f12f102014-03-12 06:41:41 +0000640 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
641 llvm::Value *L,
642 llvm::Value *R,
643 const MemberPointerType *MPT,
644 bool Inequality) override;
Reid Kleckner700c3ee2013-04-30 20:15:14 +0000645
Craig Topper4f12f102014-03-12 06:41:41 +0000646 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
647 llvm::Value *MemPtr,
648 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000649
Craig Topper4f12f102014-03-12 06:41:41 +0000650 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000651 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000652 Address Base, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000653 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000654
David Majnemer0d9ad682015-06-29 00:06:50 +0000655 llvm::Value *EmitNonNullMemberPointerConversion(
656 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
657 CastKind CK, CastExpr::path_const_iterator PathBegin,
658 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
659 CGBuilderTy &Builder);
660
Craig Topper4f12f102014-03-12 06:41:41 +0000661 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
662 const CastExpr *E,
663 llvm::Value *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000664
Craig Topper4f12f102014-03-12 06:41:41 +0000665 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
666 llvm::Constant *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000667
David Majnemer5ca193c2015-06-23 07:31:07 +0000668 llvm::Constant *EmitMemberPointerConversion(
669 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
670 CastKind CK, CastExpr::path_const_iterator PathBegin,
671 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src);
672
John McCallb92ab1a2016-10-26 23:46:34 +0000673 CGCallee
David Majnemer2b0d66d2014-02-20 23:22:07 +0000674 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000675 Address This, llvm::Value *&ThisPtrForCall,
676 llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000677 const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000678
Rafael Espindola91f68b42014-09-15 19:20:10 +0000679 void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) override;
680
David Majnemer7c237072015-03-05 00:46:22 +0000681 llvm::StructType *getCatchableTypeType() {
682 if (CatchableTypeType)
683 return CatchableTypeType;
684 llvm::Type *FieldTypes[] = {
685 CGM.IntTy, // Flags
686 getImageRelativeType(CGM.Int8PtrTy), // TypeDescriptor
687 CGM.IntTy, // NonVirtualAdjustment
688 CGM.IntTy, // OffsetToVBPtr
689 CGM.IntTy, // VBTableIndex
690 CGM.IntTy, // Size
691 getImageRelativeType(CGM.Int8PtrTy) // CopyCtor
692 };
693 CatchableTypeType = llvm::StructType::create(
694 CGM.getLLVMContext(), FieldTypes, "eh.CatchableType");
695 return CatchableTypeType;
696 }
697
698 llvm::StructType *getCatchableTypeArrayType(uint32_t NumEntries) {
699 llvm::StructType *&CatchableTypeArrayType =
700 CatchableTypeArrayTypeMap[NumEntries];
701 if (CatchableTypeArrayType)
702 return CatchableTypeArrayType;
703
704 llvm::SmallString<23> CTATypeName("eh.CatchableTypeArray.");
705 CTATypeName += llvm::utostr(NumEntries);
706 llvm::Type *CTType =
707 getImageRelativeType(getCatchableTypeType()->getPointerTo());
708 llvm::Type *FieldTypes[] = {
709 CGM.IntTy, // NumEntries
710 llvm::ArrayType::get(CTType, NumEntries) // CatchableTypes
711 };
712 CatchableTypeArrayType =
713 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, CTATypeName);
714 return CatchableTypeArrayType;
715 }
716
717 llvm::StructType *getThrowInfoType() {
718 if (ThrowInfoType)
719 return ThrowInfoType;
720 llvm::Type *FieldTypes[] = {
721 CGM.IntTy, // Flags
722 getImageRelativeType(CGM.Int8PtrTy), // CleanupFn
723 getImageRelativeType(CGM.Int8PtrTy), // ForwardCompat
724 getImageRelativeType(CGM.Int8PtrTy) // CatchableTypeArray
725 };
726 ThrowInfoType = llvm::StructType::create(CGM.getLLVMContext(), FieldTypes,
727 "eh.ThrowInfo");
728 return ThrowInfoType;
729 }
730
731 llvm::Constant *getThrowFn() {
732 // _CxxThrowException is passed an exception object and a ThrowInfo object
733 // which describes the exception.
734 llvm::Type *Args[] = {CGM.Int8PtrTy, getThrowInfoType()->getPointerTo()};
735 llvm::FunctionType *FTy =
736 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
737 auto *Fn = cast<llvm::Function>(
738 CGM.CreateRuntimeFunction(FTy, "_CxxThrowException"));
739 // _CxxThrowException is stdcall on 32-bit x86 platforms.
740 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::x86)
741 Fn->setCallingConv(llvm::CallingConv::X86_StdCall);
742 return Fn;
743 }
744
David Majnemer37fd66e2015-03-13 22:36:55 +0000745 llvm::Function *getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
746 CXXCtorType CT);
David Majnemerdfa6d202015-03-11 18:36:39 +0000747
David Majnemer7c237072015-03-05 00:46:22 +0000748 llvm::Constant *getCatchableType(QualType T,
749 uint32_t NVOffset = 0,
750 int32_t VBPtrOffset = -1,
751 uint32_t VBIndex = 0);
752
753 llvm::GlobalVariable *getCatchableTypeArray(QualType T);
754
David Majnemerba3e5ec2015-03-13 18:26:17 +0000755 llvm::GlobalVariable *getThrowInfo(QualType T) override;
David Majnemer7c237072015-03-05 00:46:22 +0000756
Peter Collingbourne60108802017-12-13 21:53:04 +0000757 std::pair<llvm::Value *, const CXXRecordDecl *>
758 LoadVTablePtr(CodeGenFunction &CGF, Address This,
759 const CXXRecordDecl *RD) override;
760
Reid Kleckner7810af02013-06-19 15:20:38 +0000761private:
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000762 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy;
David Majnemerd905da42014-07-01 20:30:31 +0000763 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy;
764 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000765 /// \brief All the vftables that have been referenced.
766 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000767 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000768
769 /// \brief This set holds the record decls we've deferred vtable emission for.
770 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
771
772
773 /// \brief All the vbtables which have been referenced.
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000774 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap;
Reid Klecknerd8110b62013-09-10 20:14:30 +0000775
776 /// Info on the global variable used to guard initialization of static locals.
777 /// The BitIndex field is only used for externally invisible declarations.
778 struct GuardInfo {
Craig Topper8a13c412014-05-21 05:09:00 +0000779 GuardInfo() : Guard(nullptr), BitIndex(0) {}
Reid Klecknerd8110b62013-09-10 20:14:30 +0000780 llvm::GlobalVariable *Guard;
781 unsigned BitIndex;
782 };
783
784 /// Map from DeclContext to the current guard variable. We assume that the
785 /// AST is visited in source code order.
786 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap;
David Majnemerec8e54b2015-05-07 21:19:06 +0000787 llvm::DenseMap<const DeclContext *, GuardInfo> ThreadLocalGuardVariableMap;
David Majnemer8354eee2015-05-07 06:15:46 +0000788 llvm::DenseMap<const DeclContext *, unsigned> ThreadSafeGuardNumMap;
David Majnemer611cdb92014-07-07 08:09:15 +0000789
790 llvm::DenseMap<size_t, llvm::StructType *> TypeDescriptorTypeMap;
791 llvm::StructType *BaseClassDescriptorType;
792 llvm::StructType *ClassHierarchyDescriptorType;
793 llvm::StructType *CompleteObjectLocatorType;
David Majnemer7c237072015-03-05 00:46:22 +0000794
795 llvm::DenseMap<QualType, llvm::GlobalVariable *> CatchableTypeArrays;
796
797 llvm::StructType *CatchableTypeType;
798 llvm::DenseMap<uint32_t, llvm::StructType *> CatchableTypeArrayTypeMap;
799 llvm::StructType *ThrowInfoType;
Charles Davis74ce8592010-06-09 23:25:41 +0000800};
801
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000802}
Charles Davis74ce8592010-06-09 23:25:41 +0000803
Reid Klecknere39ee212014-05-03 00:33:28 +0000804CGCXXABI::RecordArgABI
805MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const {
806 switch (CGM.getTarget().getTriple().getArch()) {
807 default:
808 // FIXME: Implement for other architectures.
809 return RAA_Default;
810
Reid Kleckner44051e62016-08-25 18:23:28 +0000811 case llvm::Triple::thumb:
812 // Use the simple Itanium rules for now.
813 // FIXME: This is incompatible with MSVC for arguments with a dtor and no
814 // copy ctor.
815 return !canCopyArgument(RD) ? RAA_Indirect : RAA_Default;
816
Reid Klecknere39ee212014-05-03 00:33:28 +0000817 case llvm::Triple::x86:
Reid Klecknercf87e102014-05-14 16:02:09 +0000818 // All record arguments are passed in memory on x86. Decide whether to
819 // construct the object directly in argument memory, or to construct the
820 // argument elsewhere and copy the bytes during the call.
821
822 // If C++ prohibits us from making a copy, construct the arguments directly
823 // into argument memory.
824 if (!canCopyArgument(RD))
Reid Klecknere39ee212014-05-03 00:33:28 +0000825 return RAA_DirectInMemory;
Reid Klecknercf87e102014-05-14 16:02:09 +0000826
827 // Otherwise, construct the argument into a temporary and copy the bytes
828 // into the outgoing argument memory.
Reid Klecknere39ee212014-05-03 00:33:28 +0000829 return RAA_Default;
830
831 case llvm::Triple::x86_64:
Akira Hatanakafcbe17c2018-03-28 21:13:14 +0000832 return !canCopyArgument(RD) ? RAA_Indirect : RAA_Default;
Reid Klecknere39ee212014-05-03 00:33:28 +0000833 }
834
835 llvm_unreachable("invalid enum");
836}
837
David Majnemer08681372014-11-01 07:37:17 +0000838void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
839 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000840 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +0000841 QualType ElementType,
842 const CXXDestructorDecl *Dtor) {
David Majnemer0c0b6d92014-10-31 20:09:12 +0000843 // FIXME: Provide a source location here even though there's no
844 // CXXMemberCallExpr for dtor call.
David Majnemer08681372014-11-01 07:37:17 +0000845 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000846 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
847 llvm::Value *MDThis =
848 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr);
849 if (UseGlobalDelete)
David Majnemer08681372014-11-01 07:37:17 +0000850 CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType);
John McCall82fb8922012-09-25 10:10:39 +0000851}
852
David Majnemer442d0a22014-11-25 07:20:20 +0000853void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
David Majnemer7c237072015-03-05 00:46:22 +0000854 llvm::Value *Args[] = {
855 llvm::ConstantPointerNull::get(CGM.Int8PtrTy),
856 llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())};
857 auto *Fn = getThrowFn();
David Majnemer442d0a22014-11-25 07:20:20 +0000858 if (isNoReturn)
859 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args);
860 else
861 CGF.EmitRuntimeCallOrInvoke(Fn, Args);
862}
863
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000864namespace {
Reid Kleckner129552b2015-10-08 01:13:52 +0000865struct CatchRetScope final : EHScopeStack::Cleanup {
David Majnemere888a2f2015-08-15 03:21:08 +0000866 llvm::CatchPadInst *CPI;
867
Reid Kleckner129552b2015-10-08 01:13:52 +0000868 CatchRetScope(llvm::CatchPadInst *CPI) : CPI(CPI) {}
David Majnemere888a2f2015-08-15 03:21:08 +0000869
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000870 void Emit(CodeGenFunction &CGF, Flags flags) override {
Reid Kleckner129552b2015-10-08 01:13:52 +0000871 llvm::BasicBlock *BB = CGF.createBasicBlock("catchret.dest");
872 CGF.Builder.CreateCatchRet(CPI, BB);
873 CGF.EmitBlock(BB);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000874 }
875};
876}
877
878void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF,
879 const CXXCatchStmt *S) {
880 // In the MS ABI, the runtime handles the copy, and the catch handler is
881 // responsible for destruction.
882 VarDecl *CatchParam = S->getExceptionDecl();
David Majnemer4e52d6f2015-12-12 05:39:21 +0000883 llvm::BasicBlock *CatchPadBB = CGF.Builder.GetInsertBlock();
Reid Kleckner129552b2015-10-08 01:13:52 +0000884 llvm::CatchPadInst *CPI =
885 cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
David Majnemer4e52d6f2015-12-12 05:39:21 +0000886 CGF.CurrentFuncletPad = CPI;
Reid Kleckner129552b2015-10-08 01:13:52 +0000887
Reid Kleckner67cf0352015-04-07 00:09:59 +0000888 // If this is a catch-all or the catch parameter is unnamed, we don't need to
889 // emit an alloca to the object.
890 if (!CatchParam || !CatchParam->getDeclName()) {
Reid Kleckner129552b2015-10-08 01:13:52 +0000891 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000892 return;
893 }
894
895 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
Reid Kleckner129552b2015-10-08 01:13:52 +0000896 CPI->setArgOperand(2, var.getObjectAddress(CGF).getPointer());
897 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000898 CGF.EmitAutoVarCleanups(var);
899}
900
John McCall7f416cc2015-09-08 08:05:57 +0000901/// We need to perform a generic polymorphic operation (like a typeid
902/// or a cast), which requires an object with a vfptr. Adjust the
903/// address to point to an object with a vfptr.
Peter Collingbourne60108802017-12-13 21:53:04 +0000904std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000905MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000906 QualType SrcRecordTy) {
David Majnemer1162d252014-06-22 19:05:33 +0000907 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
908 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
David Majnemer9ced3dd2015-03-14 23:44:48 +0000909 const ASTContext &Context = getContext();
David Majnemer1162d252014-06-22 19:05:33 +0000910
John McCall7f416cc2015-09-08 08:05:57 +0000911 // If the class itself has a vfptr, great. This check implicitly
912 // covers non-virtual base subobjects: a class with its own virtual
913 // functions would be a candidate to be a primary base.
David Majnemer5bc883f2015-02-27 02:38:02 +0000914 if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
Peter Collingbourne60108802017-12-13 21:53:04 +0000915 return std::make_tuple(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0),
916 SrcDecl);
David Majnemer1162d252014-06-22 19:05:33 +0000917
John McCall7f416cc2015-09-08 08:05:57 +0000918 // Okay, one of the vbases must have a vfptr, or else this isn't
919 // actually a polymorphic class.
920 const CXXRecordDecl *PolymorphicBase = nullptr;
921 for (auto &Base : SrcDecl->vbases()) {
922 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
923 if (Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr()) {
924 PolymorphicBase = BaseDecl;
925 break;
926 }
927 }
928 assert(PolymorphicBase && "polymorphic class has no apparent vfptr?");
929
930 llvm::Value *Offset =
931 GetVirtualBaseClassOffset(CGF, Value, SrcDecl, PolymorphicBase);
932 llvm::Value *Ptr = CGF.Builder.CreateInBoundsGEP(Value.getPointer(), Offset);
John McCall7f416cc2015-09-08 08:05:57 +0000933 CharUnits VBaseAlign =
934 CGF.CGM.getVBaseAlignment(Value.getAlignment(), SrcDecl, PolymorphicBase);
Peter Collingbourne60108802017-12-13 21:53:04 +0000935 return std::make_tuple(Address(Ptr, VBaseAlign), Offset, PolymorphicBase);
David Majnemer1162d252014-06-22 19:05:33 +0000936}
937
938bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
939 QualType SrcRecordTy) {
940 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
941 return IsDeref &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000942 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000943}
944
945static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF,
946 llvm::Value *Argument) {
947 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
948 llvm::FunctionType *FTy =
949 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
950 llvm::Value *Args[] = {Argument};
951 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
952 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
953}
954
955void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
956 llvm::CallSite Call =
957 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
958 Call.setDoesNotReturn();
959 CGF.Builder.CreateUnreachable();
960}
961
962llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
963 QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000964 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000965 llvm::Type *StdTypeInfoPtrTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +0000966 std::tie(ThisPtr, std::ignore, std::ignore) =
David Majnemer17755352016-07-09 19:26:25 +0000967 performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +0000968 auto Typeid = emitRTtypeidCall(CGF, ThisPtr.getPointer()).getInstruction();
969 return CGF.Builder.CreateBitCast(Typeid, StdTypeInfoPtrTy);
David Majnemer1162d252014-06-22 19:05:33 +0000970}
971
972bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
973 QualType SrcRecordTy) {
974 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
975 return SrcIsPtr &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000976 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000977}
978
979llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
John McCall7f416cc2015-09-08 08:05:57 +0000980 CodeGenFunction &CGF, Address This, QualType SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +0000981 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
982 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
983
984 llvm::Value *SrcRTTI =
985 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
986 llvm::Value *DestRTTI =
987 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
988
989 llvm::Value *Offset;
Peter Collingbourne60108802017-12-13 21:53:04 +0000990 std::tie(This, Offset, std::ignore) =
991 performBaseAdjustment(CGF, This, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +0000992 llvm::Value *ThisPtr = This.getPointer();
David Majnemer17755352016-07-09 19:26:25 +0000993 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
David Majnemer1162d252014-06-22 19:05:33 +0000994
995 // PVOID __RTDynamicCast(
996 // PVOID inptr,
997 // LONG VfDelta,
998 // PVOID SrcType,
999 // PVOID TargetType,
1000 // BOOL isReference)
1001 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
1002 CGF.Int8PtrTy, CGF.Int32Ty};
1003 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1004 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1005 "__RTDynamicCast");
1006 llvm::Value *Args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001007 ThisPtr, Offset, SrcRTTI, DestRTTI,
David Majnemer1162d252014-06-22 19:05:33 +00001008 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
John McCall7f416cc2015-09-08 08:05:57 +00001009 ThisPtr = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction();
1010 return CGF.Builder.CreateBitCast(ThisPtr, DestLTy);
David Majnemer1162d252014-06-22 19:05:33 +00001011}
1012
1013llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00001014MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +00001015 QualType SrcRecordTy,
1016 QualType DestTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +00001017 std::tie(Value, std::ignore, std::ignore) =
1018 performBaseAdjustment(CGF, Value, SrcRecordTy);
David Majnemer1162d252014-06-22 19:05:33 +00001019
1020 // PVOID __RTCastToVoid(
1021 // PVOID inptr)
1022 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
1023 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1024 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1025 "__RTCastToVoid");
John McCall7f416cc2015-09-08 08:05:57 +00001026 llvm::Value *Args[] = {Value.getPointer()};
David Majnemer1162d252014-06-22 19:05:33 +00001027 return CGF.EmitRuntimeCall(Function, Args);
1028}
1029
1030bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
1031 return false;
1032}
1033
David Majnemerca32f932014-09-01 18:50:02 +00001034llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
John McCall7f416cc2015-09-08 08:05:57 +00001035 CodeGenFunction &CGF, Address This, const CXXRecordDecl *ClassDecl,
David Majnemerca32f932014-09-01 18:50:02 +00001036 const CXXRecordDecl *BaseClassDecl) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001037 const ASTContext &Context = getContext();
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00001038 int64_t VBPtrChars =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001039 Context.getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001040 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
David Majnemer9ced3dd2015-03-14 23:44:48 +00001041 CharUnits IntSize = Context.getTypeSizeInChars(Context.IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001042 CharUnits VBTableChars =
1043 IntSize *
1044 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001045 llvm::Value *VBTableOffset =
David Majnemerca32f932014-09-01 18:50:02 +00001046 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001047
1048 llvm::Value *VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001049 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001050 VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001051 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001052 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
1053}
1054
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001055bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
1056 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +00001057}
1058
David Majnemer0c0b6d92014-10-31 20:09:12 +00001059static bool isDeletingDtor(GlobalDecl GD) {
1060 return isa<CXXDestructorDecl>(GD.getDecl()) &&
1061 GD.getDtorType() == Dtor_Deleting;
1062}
1063
1064bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const {
1065 return isDeletingDtor(GD);
1066}
1067
Reid Kleckner40ca9132014-05-13 22:05:45 +00001068bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
1069 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
1070 if (!RD)
1071 return false;
1072
John McCall7f416cc2015-09-08 08:05:57 +00001073 CharUnits Align = CGM.getContext().getTypeAlignInChars(FI.getReturnType());
Reid Kleckner40ca9132014-05-13 22:05:45 +00001074 if (FI.isInstanceMethod()) {
1075 // If it's an instance method, aggregates are always returned indirectly via
1076 // the second parameter.
John McCall7f416cc2015-09-08 08:05:57 +00001077 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001078 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod());
1079 return true;
1080 } else if (!RD->isPOD()) {
1081 // If it's a free function, non-POD types are returned indirectly.
John McCall7f416cc2015-09-08 08:05:57 +00001082 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001083 return true;
1084 }
1085
1086 // Otherwise, use the C ABI rules.
1087 return false;
1088}
1089
Reid Kleckner7810af02013-06-19 15:20:38 +00001090llvm::BasicBlock *
1091MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
1092 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001093 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1094 assert(IsMostDerivedClass &&
1095 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +00001096 llvm::Value *IsCompleteObject =
1097 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001098
1099 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
1100 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
1101 CGF.Builder.CreateCondBr(IsCompleteObject,
1102 CallVbaseCtorsBB, SkipVbaseCtorsBB);
1103
1104 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +00001105
1106 // Fill in the vbtable pointers here.
1107 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001108
1109 // CGF will put the base ctor calls in this basic block for us later.
1110
1111 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +00001112}
1113
Erich Keane13c7ec52016-12-07 00:21:45 +00001114llvm::BasicBlock *
1115MicrosoftCXXABI::EmitDtorCompleteObjectHandler(CodeGenFunction &CGF) {
1116 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1117 assert(IsMostDerivedClass &&
1118 "ctor for a class with virtual bases must have an implicit parameter");
1119 llvm::Value *IsCompleteObject =
1120 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
1121
1122 llvm::BasicBlock *CallVbaseDtorsBB = CGF.createBasicBlock("Dtor.dtor_vbases");
1123 llvm::BasicBlock *SkipVbaseDtorsBB = CGF.createBasicBlock("Dtor.skip_vbases");
1124 CGF.Builder.CreateCondBr(IsCompleteObject,
1125 CallVbaseDtorsBB, SkipVbaseDtorsBB);
1126
1127 CGF.EmitBlock(CallVbaseDtorsBB);
1128 // CGF will put the base dtor calls in this basic block for us later.
1129
1130 return SkipVbaseDtorsBB;
1131}
1132
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001133void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
1134 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
1135 // In most cases, an override for a vbase virtual method can adjust
1136 // the "this" parameter by applying a constant offset.
1137 // However, this is not enough while a constructor or a destructor of some
1138 // class X is being executed if all the following conditions are met:
1139 // - X has virtual bases, (1)
1140 // - X overrides a virtual method M of a vbase Y, (2)
1141 // - X itself is a vbase of the most derived class.
1142 //
1143 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
1144 // which holds the extra amount of "this" adjustment we must do when we use
1145 // the X vftables (i.e. during X ctor or dtor).
1146 // Outside the ctors and dtors, the values of vtorDisps are zero.
1147
1148 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
1149 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
1150 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
1151 CGBuilderTy &Builder = CGF.Builder;
1152
John McCall7f416cc2015-09-08 08:05:57 +00001153 unsigned AS = getThisAddress(CGF).getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +00001154 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001155
Nico Weber91af2742018-03-07 23:15:20 +00001156 for (const CXXBaseSpecifier &S : RD->vbases()) {
1157 const CXXRecordDecl *VBase = S.getType()->getAsCXXRecordDecl();
1158 auto I = VBaseMap.find(VBase);
1159 assert(I != VBaseMap.end());
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001160 if (!I->second.hasVtorDisp())
1161 continue;
1162
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +00001163 llvm::Value *VBaseOffset =
Nico Weber91af2742018-03-07 23:15:20 +00001164 GetVirtualBaseClassOffset(CGF, getThisAddress(CGF), RD, VBase);
1165 uint64_t ConstantVBaseOffset = I->second.VBaseOffset.getQuantity();
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001166
1167 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
1168 llvm::Value *VtorDispValue = Builder.CreateSub(
David Majnemer17755352016-07-09 19:26:25 +00001169 VBaseOffset, llvm::ConstantInt::get(CGM.PtrDiffTy, ConstantVBaseOffset),
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001170 "vtordisp.value");
David Majnemer17755352016-07-09 19:26:25 +00001171 VtorDispValue = Builder.CreateTruncOrBitCast(VtorDispValue, CGF.Int32Ty);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001172
1173 if (!Int8This)
1174 Int8This = Builder.CreateBitCast(getThisValue(CGF),
1175 CGF.Int8Ty->getPointerTo(AS));
1176 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
1177 // vtorDisp is always the 32-bits before the vbase in the class layout.
1178 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
1179 VtorDispPtr = Builder.CreateBitCast(
1180 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
1181
John McCall7f416cc2015-09-08 08:05:57 +00001182 Builder.CreateAlignedStore(VtorDispValue, VtorDispPtr,
1183 CharUnits::fromQuantity(4));
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001184 }
1185}
1186
David Majnemer37fd66e2015-03-13 22:36:55 +00001187static bool hasDefaultCXXMethodCC(ASTContext &Context,
1188 const CXXMethodDecl *MD) {
1189 CallingConv ExpectedCallingConv = Context.getDefaultCallingConvention(
1190 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1191 CallingConv ActualCallingConv =
1192 MD->getType()->getAs<FunctionProtoType>()->getCallConv();
1193 return ExpectedCallingConv == ActualCallingConv;
1194}
1195
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001196void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1197 // There's only one constructor type in this ABI.
1198 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
David Majnemer37fd66e2015-03-13 22:36:55 +00001199
1200 // Exported default constructors either have a simple call-site where they use
1201 // the typical calling convention and have a single 'this' pointer for an
1202 // argument -or- they get a wrapper function which appropriately thunks to the
1203 // real default constructor. This thunk is the default constructor closure.
1204 if (D->hasAttr<DLLExportAttr>() && D->isDefaultConstructor())
1205 if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) {
1206 llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure);
1207 Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage);
Rafael Espindolab7350042018-03-01 00:35:47 +00001208 CGM.setGVProperties(Fn, D);
David Majnemer37fd66e2015-03-13 22:36:55 +00001209 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001210}
1211
Reid Kleckner7810af02013-06-19 15:20:38 +00001212void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1213 const CXXRecordDecl *RD) {
John McCall7f416cc2015-09-08 08:05:57 +00001214 Address This = getThisAddress(CGF);
1215 This = CGF.Builder.CreateElementBitCast(This, CGM.Int8Ty, "this.int8");
David Majnemer9ced3dd2015-03-14 23:44:48 +00001216 const ASTContext &Context = getContext();
1217 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001218
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001219 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1220 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00001221 const std::unique_ptr<VPtrInfo> &VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001222 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +00001223 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001224 Context.getASTRecordLayout(VBT->IntroducingObject);
Reid Kleckner5f080942014-01-03 23:42:00 +00001225 CharUnits Offs = VBT->NonVirtualOffset;
1226 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001227 if (VBT->getVBaseWithVPtr())
1228 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
John McCall7f416cc2015-09-08 08:05:57 +00001229 Address VBPtr = CGF.Builder.CreateConstInBoundsByteGEP(This, Offs);
David Blaikie1ed728c2015-04-05 22:45:47 +00001230 llvm::Value *GVPtr =
1231 CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001232 VBPtr = CGF.Builder.CreateElementBitCast(VBPtr, GVPtr->getType(),
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001233 "vbptr." + VBT->ObjectWithVPtr->getName());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001234 CGF.Builder.CreateStore(GVPtr, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +00001235 }
1236}
1237
George Burgess IVf203dbf2017-02-22 20:28:02 +00001238CGCXXABI::AddedStructorArgs
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001239MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001240 SmallVectorImpl<CanQualType> &ArgTys) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001241 AddedStructorArgs Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001242 // TODO: 'for base' flag
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001243 if (T == StructorType::Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001244 // The scalar deleting destructor takes an implicit int parameter.
David Majnemer9ced3dd2015-03-14 23:44:48 +00001245 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001246 ++Added.Suffix;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001247 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001248 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
1249 if (!CD)
George Burgess IVf203dbf2017-02-22 20:28:02 +00001250 return Added;
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001251
1252 // All parameters are already in place except is_most_derived, which goes
1253 // after 'this' if it's variadic and last if it's not.
1254
1255 const CXXRecordDecl *Class = CD->getParent();
1256 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1257 if (Class->getNumVBases()) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001258 if (FPT->isVariadic()) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001259 ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001260 ++Added.Prefix;
1261 } else {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001262 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001263 ++Added.Suffix;
1264 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001265 }
George Burgess IVf203dbf2017-02-22 20:28:02 +00001266
1267 return Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001268}
1269
Reid Klecknerae9b0702018-03-16 19:40:50 +00001270void MicrosoftCXXABI::setCXXDestructorDLLStorage(llvm::GlobalValue *GV,
1271 const CXXDestructorDecl *Dtor,
1272 CXXDtorType DT) const {
1273 // Deleting destructor variants are never imported or exported. Give them the
1274 // default storage class.
1275 if (DT == Dtor_Deleting) {
1276 GV->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
1277 } else {
1278 const NamedDecl *ND = Dtor;
1279 CGM.setDLLImportDLLExport(GV, ND);
1280 }
1281}
1282
1283llvm::GlobalValue::LinkageTypes MicrosoftCXXABI::getCXXDestructorLinkage(
1284 GVALinkage Linkage, const CXXDestructorDecl *Dtor, CXXDtorType DT) const {
1285 // Internal things are always internal, regardless of attributes. After this,
1286 // we know the thunk is externally visible.
1287 if (Linkage == GVA_Internal)
1288 return llvm::GlobalValue::InternalLinkage;
1289
1290 switch (DT) {
1291 case Dtor_Base:
1292 // The base destructor most closely tracks the user-declared constructor, so
1293 // we delegate back to the normal declarator case.
1294 return CGM.getLLVMLinkageForDeclarator(Dtor, Linkage,
1295 /*isConstantVariable=*/false);
1296 case Dtor_Complete:
1297 // The complete destructor is like an inline function, but it may be
1298 // imported and therefore must be exported as well. This requires changing
1299 // the linkage if a DLL attribute is present.
1300 if (Dtor->hasAttr<DLLExportAttr>())
1301 return llvm::GlobalValue::WeakODRLinkage;
1302 if (Dtor->hasAttr<DLLImportAttr>())
1303 return llvm::GlobalValue::AvailableExternallyLinkage;
1304 return llvm::GlobalValue::LinkOnceODRLinkage;
1305 case Dtor_Deleting:
1306 // Deleting destructors are like inline functions. They have vague linkage
1307 // and are emitted everywhere they are used. They are internal if the class
1308 // is internal.
1309 return llvm::GlobalValue::LinkOnceODRLinkage;
1310 case Dtor_Comdat:
1311 llvm_unreachable("MS C++ ABI does not support comdat dtors");
1312 }
1313 llvm_unreachable("invalid dtor type");
1314}
1315
Reid Klecknere7de47e2013-07-22 13:51:44 +00001316void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1317 // The TU defining a dtor is only guaranteed to emit a base destructor. All
1318 // other destructor variants are delegating thunks.
1319 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1320}
1321
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001322CharUnits
1323MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001324 GD = GD.getCanonicalDecl();
1325 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001326
1327 GlobalDecl LookupGD = GD;
1328 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1329 // Complete destructors take a pointer to the complete object as a
1330 // parameter, thus don't need this adjustment.
1331 if (GD.getDtorType() == Dtor_Complete)
1332 return CharUnits();
1333
1334 // There's no Dtor_Base in vftable but it shares the this adjustment with
1335 // the deleting one, so look it up instead.
1336 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1337 }
1338
Nico Webere7c7d702018-03-31 18:26:25 +00001339 MicrosoftVTableContext::MethodVFTableLocation ML =
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001340 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
1341 CharUnits Adjustment = ML.VFPtrOffset;
1342
1343 // Normal virtual instance methods need to adjust from the vfptr that first
1344 // defined the virtual method to the virtual base subobject, but destructors
1345 // do not. The vector deleting destructor thunk applies this adjustment for
1346 // us if necessary.
1347 if (isa<CXXDestructorDecl>(MD))
1348 Adjustment = CharUnits::Zero();
1349
1350 if (ML.VBase) {
1351 const ASTRecordLayout &DerivedLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001352 getContext().getASTRecordLayout(MD->getParent());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001353 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1354 }
1355
1356 return Adjustment;
1357}
1358
John McCall7f416cc2015-09-08 08:05:57 +00001359Address MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1360 CodeGenFunction &CGF, GlobalDecl GD, Address This,
1361 bool VirtualCall) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001362 if (!VirtualCall) {
1363 // If the call of a virtual function is not virtual, we just have to
1364 // compensate for the adjustment the virtual function does in its prologue.
1365 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1366 if (Adjustment.isZero())
1367 return This;
1368
John McCall7f416cc2015-09-08 08:05:57 +00001369 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001370 assert(Adjustment.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001371 return CGF.Builder.CreateConstByteGEP(This, Adjustment);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001372 }
1373
1374 GD = GD.getCanonicalDecl();
1375 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001376
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001377 GlobalDecl LookupGD = GD;
1378 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1379 // Complete dtors take a pointer to the complete object,
1380 // thus don't need adjustment.
1381 if (GD.getDtorType() == Dtor_Complete)
1382 return This;
1383
1384 // There's only Dtor_Deleting in vftable but it shares the this adjustment
1385 // with the base one, so look up the deleting one instead.
1386 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1387 }
Nico Webere7c7d702018-03-31 18:26:25 +00001388 MicrosoftVTableContext::MethodVFTableLocation ML =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001389 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001390
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001391 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001392
1393 // Base destructors expect 'this' to point to the beginning of the base
1394 // subobject, not the first vfptr that happens to contain the virtual dtor.
1395 // However, we still need to apply the virtual base adjustment.
1396 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1397 StaticOffset = CharUnits::Zero();
1398
John McCall7f416cc2015-09-08 08:05:57 +00001399 Address Result = This;
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001400 if (ML.VBase) {
John McCall7f416cc2015-09-08 08:05:57 +00001401 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
1402
1403 const CXXRecordDecl *Derived = MD->getParent();
1404 const CXXRecordDecl *VBase = ML.VBase;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001405 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00001406 GetVirtualBaseClassOffset(CGF, Result, Derived, VBase);
1407 llvm::Value *VBasePtr =
1408 CGF.Builder.CreateInBoundsGEP(Result.getPointer(), VBaseOffset);
1409 CharUnits VBaseAlign =
1410 CGF.CGM.getVBaseAlignment(Result.getAlignment(), Derived, VBase);
1411 Result = Address(VBasePtr, VBaseAlign);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001412 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001413 if (!StaticOffset.isZero()) {
1414 assert(StaticOffset.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001415 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001416 if (ML.VBase) {
1417 // Non-virtual adjustment might result in a pointer outside the allocated
1418 // object, e.g. if the final overrider class is laid out after the virtual
1419 // base that declares a method in the most derived class.
1420 // FIXME: Update the code that emits this adjustment in thunks prologues.
John McCall7f416cc2015-09-08 08:05:57 +00001421 Result = CGF.Builder.CreateConstByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001422 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001423 Result = CGF.Builder.CreateConstInBoundsByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001424 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001425 }
John McCall7f416cc2015-09-08 08:05:57 +00001426 return Result;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001427}
1428
Reid Kleckner89077a12013-12-17 19:46:40 +00001429void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1430 QualType &ResTy,
1431 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001432 ASTContext &Context = getContext();
1433 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001434 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001435 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
Alexey Bataev56223232017-06-09 13:40:18 +00001436 auto *IsMostDerived = ImplicitParamDecl::Create(
1437 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1438 &Context.Idents.get("is_most_derived"), Context.IntTy,
1439 ImplicitParamDecl::Other);
Reid Kleckner89077a12013-12-17 19:46:40 +00001440 // The 'most_derived' parameter goes second if the ctor is variadic and last
1441 // if it's not. Dtors can't be variadic.
1442 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1443 if (FPT->isVariadic())
1444 Params.insert(Params.begin() + 1, IsMostDerived);
1445 else
1446 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001447 getStructorImplicitParamDecl(CGF) = IsMostDerived;
David Majnemer0c0b6d92014-10-31 20:09:12 +00001448 } else if (isDeletingDtor(CGF.CurGD)) {
Alexey Bataev56223232017-06-09 13:40:18 +00001449 auto *ShouldDelete = ImplicitParamDecl::Create(
1450 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1451 &Context.Idents.get("should_call_delete"), Context.IntTy,
1452 ImplicitParamDecl::Other);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001453 Params.push_back(ShouldDelete);
1454 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1455 }
John McCall0f999f32012-09-25 08:00:39 +00001456}
1457
1458void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
Justin Lebared4f1722016-07-27 22:04:24 +00001459 // Naked functions have no prolog.
1460 if (CGF.CurFuncDecl && CGF.CurFuncDecl->hasAttr<NakedAttr>())
1461 return;
1462
Reid Kleckner06239e42017-11-16 19:09:36 +00001463 // Overridden virtual methods of non-primary bases need to adjust the incoming
1464 // 'this' pointer in the prologue. In this hierarchy, C::b will subtract
1465 // sizeof(void*) to adjust from B* to C*:
1466 // struct A { virtual void a(); };
1467 // struct B { virtual void b(); };
1468 // struct C : A, B { virtual void b(); };
1469 //
1470 // Leave the value stored in the 'this' alloca unadjusted, so that the
1471 // debugger sees the unadjusted value. Microsoft debuggers require this, and
1472 // will apply the ThisAdjustment in the method type information.
1473 // FIXME: Do something better for DWARF debuggers, which won't expect this,
1474 // without making our codegen depend on debug info settings.
1475 llvm::Value *This = loadIncomingCXXThis(CGF);
1476 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1477 if (!CGF.CurFuncIsThunk && MD->isVirtual()) {
1478 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(CGF.CurGD);
1479 if (!Adjustment.isZero()) {
1480 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1481 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1482 *thisTy = This->getType();
1483 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1484 assert(Adjustment.isPositive());
1485 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
1486 -Adjustment.getQuantity());
1487 This = CGF.Builder.CreateBitCast(This, thisTy, "this.adjusted");
1488 }
1489 }
1490 setCXXABIThisValue(CGF, This);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001491
Reid Kleckner06239e42017-11-16 19:09:36 +00001492 // If this is a function that the ABI specifies returns 'this', initialize
1493 // the return slot to 'this' at the start of the function.
1494 //
1495 // Unlike the setting of return types, this is done within the ABI
1496 // implementation instead of by clients of CGCXXABI because:
1497 // 1) getThisValue is currently protected
1498 // 2) in theory, an ABI could implement 'this' returns some other way;
1499 // HasThisReturn only specifies a contract, not the implementation
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001500 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001501 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001502 else if (hasMostDerivedReturn(CGF.CurGD))
1503 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1504 CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001505
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001506 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1507 assert(getStructorImplicitParamDecl(CGF) &&
1508 "no implicit parameter for a constructor with virtual bases?");
1509 getStructorImplicitParamValue(CGF)
1510 = CGF.Builder.CreateLoad(
1511 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1512 "is_most_derived");
1513 }
1514
David Majnemer0c0b6d92014-10-31 20:09:12 +00001515 if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001516 assert(getStructorImplicitParamDecl(CGF) &&
1517 "no implicit parameter for a deleting destructor?");
1518 getStructorImplicitParamValue(CGF)
1519 = CGF.Builder.CreateLoad(
1520 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1521 "should_call_delete");
1522 }
John McCall0f999f32012-09-25 08:00:39 +00001523}
1524
George Burgess IVf203dbf2017-02-22 20:28:02 +00001525CGCXXABI::AddedStructorArgs MicrosoftCXXABI::addImplicitConstructorArgs(
Reid Kleckner89077a12013-12-17 19:46:40 +00001526 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1527 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001528 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001529
Reid Kleckner89077a12013-12-17 19:46:40 +00001530 // Check if we need a 'most_derived' parameter.
1531 if (!D->getParent()->getNumVBases())
George Burgess IVf203dbf2017-02-22 20:28:02 +00001532 return AddedStructorArgs{};
Reid Kleckner89077a12013-12-17 19:46:40 +00001533
1534 // Add the 'most_derived' argument second if we are variadic or last if not.
1535 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
David Majnemer833b91e2016-05-13 20:05:09 +00001536 llvm::Value *MostDerivedArg;
1537 if (Delegating) {
1538 MostDerivedArg = getStructorImplicitParamValue(CGF);
1539 } else {
1540 MostDerivedArg = llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001541 }
David Majnemer833b91e2016-05-13 20:05:09 +00001542 RValue RV = RValue::get(MostDerivedArg);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001543 if (FPT->isVariadic()) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001544 Args.insert(Args.begin() + 1, CallArg(RV, getContext().IntTy));
George Burgess IVf203dbf2017-02-22 20:28:02 +00001545 return AddedStructorArgs::prefix(1);
1546 }
1547 Args.add(RV, getContext().IntTy);
1548 return AddedStructorArgs::suffix(1);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001549}
1550
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001551void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1552 const CXXDestructorDecl *DD,
1553 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +00001554 bool Delegating, Address This) {
Reid Klecknerae9b0702018-03-16 19:40:50 +00001555 // Use the base destructor variant in place of the complete destructor variant
1556 // if the class has no virtual bases. This effectively implements some of the
1557 // -mconstructor-aliases optimization, but as part of the MS C++ ABI.
1558 if (Type == Dtor_Complete && DD->getParent()->getNumVBases() == 0)
1559 Type = Dtor_Base;
1560
John McCallb92ab1a2016-10-26 23:46:34 +00001561 CGCallee Callee = CGCallee::forDirect(
1562 CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type)),
1563 DD);
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001564
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001565 if (DD->isVirtual()) {
1566 assert(Type != CXXDtorType::Dtor_Deleting &&
1567 "The deleting destructor should only be called via a virtual call");
1568 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1569 This, false);
1570 }
Erich Keane13c7ec52016-12-07 00:21:45 +00001571
1572 llvm::BasicBlock *BaseDtorEndBB = nullptr;
1573 if (ForVirtualBase && isa<CXXConstructorDecl>(CGF.CurCodeDecl)) {
1574 BaseDtorEndBB = EmitDtorCompleteObjectHandler(CGF);
1575 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001576
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001577 CGF.EmitCXXDestructorCall(DD, Callee, This.getPointer(),
1578 /*ImplicitParam=*/nullptr,
1579 /*ImplicitParamTy=*/QualType(), nullptr,
1580 getFromDtorType(Type));
Erich Keane13c7ec52016-12-07 00:21:45 +00001581 if (BaseDtorEndBB) {
1582 // Complete object handler should continue to be the remaining
1583 CGF.Builder.CreateBr(BaseDtorEndBB);
1584 CGF.EmitBlock(BaseDtorEndBB);
1585 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001586}
1587
Justin Lebar562914e2016-10-10 16:26:29 +00001588void MicrosoftCXXABI::emitVTableTypeMetadata(const VPtrInfo &Info,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001589 const CXXRecordDecl *RD,
1590 llvm::GlobalVariable *VTable) {
Peter Collingbourne1e1475a2017-01-18 23:55:27 +00001591 if (!CGM.getCodeGenOpts().LTOUnit)
Peter Collingbourned9546012015-06-19 02:30:43 +00001592 return;
1593
Peter Collingbournee5706442015-07-09 19:56:14 +00001594 // The location of the first virtual function pointer in the virtual table,
1595 // aka the "address point" on Itanium. This is at offset 0 if RTTI is
1596 // disabled, or sizeof(void*) if RTTI is enabled.
1597 CharUnits AddressPoint =
1598 getContext().getLangOpts().RTTIData
1599 ? getContext().toCharUnitsFromBits(
1600 getContext().getTargetInfo().getPointerWidth(0))
1601 : CharUnits::Zero();
Peter Collingbourned9546012015-06-19 02:30:43 +00001602
Justin Lebar562914e2016-10-10 16:26:29 +00001603 if (Info.PathToIntroducingObject.empty()) {
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001604 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001605 return;
1606 }
1607
1608 // Add a bitset entry for the least derived base belonging to this vftable.
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001609 CGM.AddVTableTypeMetadata(VTable, AddressPoint,
Justin Lebar562914e2016-10-10 16:26:29 +00001610 Info.PathToIntroducingObject.back());
Peter Collingbourned9546012015-06-19 02:30:43 +00001611
1612 // Add a bitset entry for each derived class that is laid out at the same
1613 // offset as the least derived base.
Justin Lebar562914e2016-10-10 16:26:29 +00001614 for (unsigned I = Info.PathToIntroducingObject.size() - 1; I != 0; --I) {
1615 const CXXRecordDecl *DerivedRD = Info.PathToIntroducingObject[I - 1];
1616 const CXXRecordDecl *BaseRD = Info.PathToIntroducingObject[I];
Peter Collingbourned9546012015-06-19 02:30:43 +00001617
1618 const ASTRecordLayout &Layout =
1619 getContext().getASTRecordLayout(DerivedRD);
1620 CharUnits Offset;
1621 auto VBI = Layout.getVBaseOffsetsMap().find(BaseRD);
1622 if (VBI == Layout.getVBaseOffsetsMap().end())
1623 Offset = Layout.getBaseClassOffset(BaseRD);
1624 else
1625 Offset = VBI->second.VBaseOffset;
1626 if (!Offset.isZero())
1627 return;
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001628 CGM.AddVTableTypeMetadata(VTable, AddressPoint, DerivedRD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001629 }
1630
1631 // Finally do the same for the most derived class.
Justin Lebar562914e2016-10-10 16:26:29 +00001632 if (Info.FullOffsetInMDC.isZero())
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001633 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001634}
1635
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001636void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1637 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001638 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001639 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001640
Justin Lebar562914e2016-10-10 16:26:29 +00001641 for (const std::unique_ptr<VPtrInfo>& Info : VFPtrs) {
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001642 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001643 if (VTable->hasInitializer())
1644 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001645
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001646 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001647 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
David Majnemer470ee612016-02-09 17:27:52 +00001648
1649 llvm::Constant *RTTI = nullptr;
1650 if (any_of(VTLayout.vtable_components(),
1651 [](const VTableComponent &VTC) { return VTC.isRTTIKind(); }))
Justin Lebar562914e2016-10-10 16:26:29 +00001652 RTTI = getMSCompleteObjectLocator(RD, *Info);
David Majnemer470ee612016-02-09 17:27:52 +00001653
John McCall9c6cb762016-11-28 22:18:33 +00001654 ConstantInitBuilder Builder(CGM);
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001655 auto Components = Builder.beginStruct();
John McCall9c6cb762016-11-28 22:18:33 +00001656 CGVT.createVTableInitializer(Components, VTLayout, RTTI);
1657 Components.finishAndSetAsInitializer(VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +00001658
Justin Lebar562914e2016-10-10 16:26:29 +00001659 emitVTableTypeMetadata(*Info, RD, VTable);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001660 }
1661}
1662
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001663bool MicrosoftCXXABI::isVirtualOffsetNeededForVTableField(
1664 CodeGenFunction &CGF, CodeGenFunction::VPtr Vptr) {
1665 return Vptr.NearestVBase != nullptr;
1666}
1667
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001668llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1669 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001670 const CXXRecordDecl *NearestVBase) {
1671 llvm::Constant *VTableAddressPoint = getVTableAddressPoint(Base, VTableClass);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001672 if (!VTableAddressPoint) {
1673 assert(Base.getBase()->getNumVBases() &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001674 !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001675 }
1676 return VTableAddressPoint;
1677}
1678
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001679static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Justin Lebar562914e2016-10-10 16:26:29 +00001680 const CXXRecordDecl *RD, const VPtrInfo &VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001681 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001682 llvm::raw_svector_ostream Out(Name);
Justin Lebar562914e2016-10-10 16:26:29 +00001683 MangleContext.mangleCXXVFTable(RD, VFPtr.MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001684}
1685
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001686llvm::Constant *
1687MicrosoftCXXABI::getVTableAddressPoint(BaseSubobject Base,
1688 const CXXRecordDecl *VTableClass) {
Piotr Padlewski4bed31b2015-09-10 20:18:30 +00001689 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1690 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001691 return VFTablesMap[ID];
1692}
1693
1694llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1695 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1696 llvm::Constant *VFTable = getVTableAddressPoint(Base, VTableClass);
David Majnemerd905da42014-07-01 20:30:31 +00001697 assert(VFTable && "Couldn't find a vftable for the given base?");
1698 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001699}
1700
1701llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1702 CharUnits VPtrOffset) {
1703 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1704 // shouldn't be used in the given record type. We want to cache this result in
1705 // VFTablesMap, thus a simple zero check is not sufficient.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001706
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001707 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001708 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001709 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001710 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001711 if (!Inserted)
1712 return I->second;
1713
1714 llvm::GlobalVariable *&VTable = I->second;
1715
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001716 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001717 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001718
David Blaikie82e95a32014-11-19 07:49:47 +00001719 if (DeferredVFTables.insert(RD).second) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001720 // We haven't processed this record type before.
Eric Christopherd160c502016-01-29 01:35:53 +00001721 // Queue up this vtable for possible deferred emission.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001722 CGM.addDeferredVTable(RD);
1723
1724#ifndef NDEBUG
1725 // Create all the vftables at once in order to make sure each vftable has
1726 // a unique mangled name.
1727 llvm::StringSet<> ObservedMangledNames;
1728 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1729 SmallString<256> Name;
Justin Lebar562914e2016-10-10 16:26:29 +00001730 mangleVFTableName(getMangleContext(), RD, *VFPtrs[J], Name);
David Blaikie61b86d42014-11-19 02:56:13 +00001731 if (!ObservedMangledNames.insert(Name.str()).second)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001732 llvm_unreachable("Already saw this mangling before?");
1733 }
1734#endif
1735 }
1736
Justin Lebar562914e2016-10-10 16:26:29 +00001737 const std::unique_ptr<VPtrInfo> *VFPtrI = std::find_if(
1738 VFPtrs.begin(), VFPtrs.end(), [&](const std::unique_ptr<VPtrInfo>& VPI) {
David Majnemera03849b2015-03-18 22:04:43 +00001739 return VPI->FullOffsetInMDC == VPtrOffset;
1740 });
1741 if (VFPtrI == VFPtrs.end()) {
1742 VFTablesMap[ID] = nullptr;
1743 return nullptr;
1744 }
Justin Lebar562914e2016-10-10 16:26:29 +00001745 const std::unique_ptr<VPtrInfo> &VFPtr = *VFPtrI;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001746
David Majnemera03849b2015-03-18 22:04:43 +00001747 SmallString<256> VFTableName;
Justin Lebar562914e2016-10-10 16:26:29 +00001748 mangleVFTableName(getMangleContext(), RD, *VFPtr, VFTableName);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001749
David Majnemer2d8b2002016-02-11 17:49:28 +00001750 // Classes marked __declspec(dllimport) need vftables generated on the
1751 // import-side in order to support features like constexpr. No other
1752 // translation unit relies on the emission of the local vftable, translation
1753 // units are expected to generate them as needed.
1754 //
1755 // Because of this unique behavior, we maintain this logic here instead of
1756 // getVTableLinkage.
1757 llvm::GlobalValue::LinkageTypes VFTableLinkage =
1758 RD->hasAttr<DLLImportAttr>() ? llvm::GlobalValue::LinkOnceODRLinkage
1759 : CGM.getVTableLinkage(RD);
David Majnemera03849b2015-03-18 22:04:43 +00001760 bool VFTableComesFromAnotherTU =
1761 llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) ||
1762 llvm::GlobalValue::isExternalLinkage(VFTableLinkage);
1763 bool VTableAliasIsRequred =
1764 !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData;
David Majnemerbb848712014-07-01 22:37:08 +00001765
David Majnemera03849b2015-03-18 22:04:43 +00001766 if (llvm::GlobalValue *VFTable =
1767 CGM.getModule().getNamedGlobal(VFTableName)) {
1768 VFTablesMap[ID] = VFTable;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001769 VTable = VTableAliasIsRequred
1770 ? cast<llvm::GlobalVariable>(
1771 cast<llvm::GlobalAlias>(VFTable)->getBaseObject())
1772 : cast<llvm::GlobalVariable>(VFTable);
1773 return VTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001774 }
1775
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001776 const VTableLayout &VTLayout =
1777 VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC);
David Majnemera03849b2015-03-18 22:04:43 +00001778 llvm::GlobalValue::LinkageTypes VTableLinkage =
1779 VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage;
1780
1781 StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str();
1782
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001783 llvm::Type *VTableType = CGM.getVTables().getVTableType(VTLayout);
David Majnemera03849b2015-03-18 22:04:43 +00001784
1785 // Create a backing variable for the contents of VTable. The VTable may
1786 // or may not include space for a pointer to RTTI data.
1787 llvm::GlobalValue *VFTable;
1788 VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType,
1789 /*isConstant=*/true, VTableLinkage,
1790 /*Initializer=*/nullptr, VTableName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001791 VTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001792
1793 llvm::Comdat *C = nullptr;
1794 if (!VFTableComesFromAnotherTU &&
1795 (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) ||
1796 (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) &&
1797 VTableAliasIsRequred)))
1798 C = CGM.getModule().getOrInsertComdat(VFTableName.str());
1799
1800 // Only insert a pointer into the VFTable for RTTI data if we are not
1801 // importing it. We never reference the RTTI data directly so there is no
1802 // need to make room for it.
1803 if (VTableAliasIsRequred) {
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001804 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.Int32Ty, 0),
1805 llvm::ConstantInt::get(CGM.Int32Ty, 0),
1806 llvm::ConstantInt::get(CGM.Int32Ty, 1)};
David Majnemera03849b2015-03-18 22:04:43 +00001807 // Create a GEP which points just after the first entry in the VFTable,
1808 // this should be the location of the first virtual method.
David Blaikiee3b172a2015-04-02 18:55:21 +00001809 llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr(
1810 VTable->getValueType(), VTable, GEPIndices);
David Majnemera03849b2015-03-18 22:04:43 +00001811 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) {
1812 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1813 if (C)
1814 C->setSelectionKind(llvm::Comdat::Largest);
1815 }
David Blaikie2a791d72015-09-14 18:38:22 +00001816 VFTable = llvm::GlobalAlias::create(CGM.Int8PtrTy,
1817 /*AddressSpace=*/0, VFTableLinkage,
1818 VFTableName.str(), VTableGEP,
1819 &CGM.getModule());
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001820 VFTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001821 } else {
1822 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1823 // be referencing any RTTI data.
1824 // The GlobalVariable will end up being an appropriate definition of the
1825 // VFTable.
1826 VFTable = VTable;
1827 }
1828 if (C)
1829 VTable->setComdat(C);
1830
David Majnemer2d8b2002016-02-11 17:49:28 +00001831 if (RD->hasAttr<DLLExportAttr>())
David Majnemera03849b2015-03-18 22:04:43 +00001832 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1833
1834 VFTablesMap[ID] = VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001835 return VTable;
1836}
1837
John McCall9831b842018-02-06 18:52:44 +00001838CGCallee MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1839 GlobalDecl GD,
1840 Address This,
1841 llvm::Type *Ty,
1842 SourceLocation Loc) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001843 GD = GD.getCanonicalDecl();
1844 CGBuilderTy &Builder = CGF.Builder;
1845
1846 Ty = Ty->getPointerTo()->getPointerTo();
John McCall7f416cc2015-09-08 08:05:57 +00001847 Address VPtr =
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001848 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001849
1850 auto *MethodDecl = cast<CXXMethodDecl>(GD.getDecl());
1851 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty, MethodDecl->getParent());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001852
David Majnemer07c915e2016-10-27 17:11:51 +00001853 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Nico Webere7c7d702018-03-31 18:26:25 +00001854 MicrosoftVTableContext::MethodVFTableLocation ML =
1855 VFTContext.getMethodVFTableLocation(GD);
David Majnemer07c915e2016-10-27 17:11:51 +00001856
1857 // Compute the identity of the most derived class whose virtual table is
1858 // located at the MethodVFTableLocation ML.
1859 auto getObjectWithVPtr = [&] {
1860 return llvm::find_if(VFTContext.getVFPtrOffsets(
1861 ML.VBase ? ML.VBase : MethodDecl->getParent()),
1862 [&](const std::unique_ptr<VPtrInfo> &Info) {
1863 return Info->FullOffsetInMDC == ML.VFPtrOffset;
1864 })
1865 ->get()
1866 ->ObjectWithVPtr;
1867 };
Peter Collingbourned9546012015-06-19 02:30:43 +00001868
John McCall9831b842018-02-06 18:52:44 +00001869 llvm::Value *VFunc;
1870 if (CGF.ShouldEmitVTableTypeCheckedLoad(MethodDecl->getParent())) {
1871 VFunc = CGF.EmitVTableTypeCheckedLoad(
David Majnemer07c915e2016-10-27 17:11:51 +00001872 getObjectWithVPtr(), VTable,
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001873 ML.Index * CGM.getContext().getTargetInfo().getPointerWidth(0) / 8);
John McCall9831b842018-02-06 18:52:44 +00001874 } else {
1875 if (CGM.getCodeGenOpts().PrepareForLTO)
1876 CGF.EmitTypeMetadataCodeForVCall(getObjectWithVPtr(), VTable, Loc);
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001877
John McCall9831b842018-02-06 18:52:44 +00001878 llvm::Value *VFuncPtr =
1879 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1880 VFunc = Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
1881 }
John McCallb92ab1a2016-10-26 23:46:34 +00001882
John McCall9831b842018-02-06 18:52:44 +00001883 CGCallee Callee(MethodDecl, VFunc);
1884 return Callee;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001885}
1886
David Majnemer0c0b6d92014-10-31 20:09:12 +00001887llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1888 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +00001889 Address This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001890 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001891 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1892
1893 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001894 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001895 GlobalDecl GD(Dtor, Dtor_Deleting);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001896 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1897 Dtor, StructorType::Deleting);
George Burgess IV00f70bd2018-03-01 05:43:23 +00001898 llvm::FunctionType *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Peter Collingbourneea211002018-02-05 23:09:13 +00001899 CGCallee Callee = CGCallee::forVirtual(CE, GD, This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001900
David Majnemer9ced3dd2015-03-14 23:44:48 +00001901 ASTContext &Context = getContext();
Nico Weber0a029922015-01-12 21:24:10 +00001902 llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1903 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1904 DtorType == Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001905
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001906 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001907 RValue RV =
1908 CGF.EmitCXXDestructorCall(Dtor, Callee, This.getPointer(), ImplicitParam,
1909 Context.IntTy, CE, StructorType::Deleting);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001910 return RV.getScalarVal();
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001911}
1912
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001913const VBTableGlobals &
1914MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001915 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001916 // easier than caching each vbtable individually.
1917 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1918 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001919 std::tie(Entry, Added) =
1920 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001921 VBTableGlobals &VBGlobals = Entry->second;
1922 if (!Added)
1923 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001924
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001925 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1926 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001927
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001928 // Cache the globals for all vbtables so we don't have to recompute the
1929 // mangled names.
1930 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001931 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1932 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001933 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001934 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001935 }
1936
1937 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001938}
1939
Nico Webere7c7d702018-03-31 18:26:25 +00001940llvm::Function *MicrosoftCXXABI::EmitVirtualMemPtrThunk(
1941 const CXXMethodDecl *MD,
1942 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001943 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1944 "can't form pointers to ctors or virtual dtors");
1945
Reid Klecknere4a52202014-02-21 02:27:32 +00001946 // Calculate the mangled name.
1947 SmallString<256> ThunkName;
1948 llvm::raw_svector_ostream Out(ThunkName);
Nico Webere7c7d702018-03-31 18:26:25 +00001949 getMangleContext().mangleVirtualMemPtrThunk(MD, Out);
Reid Klecknere4a52202014-02-21 02:27:32 +00001950
Hans Wennborg88497d62013-11-15 17:24:45 +00001951 // If the thunk has been generated previously, just return it.
1952 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1953 return cast<llvm::Function>(GV);
1954
1955 // Create the llvm::Function.
Reid Klecknerc3473512014-08-29 21:43:29 +00001956 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSMemberPointerThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00001957 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1958 llvm::Function *ThunkFn =
1959 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1960 ThunkName.str(), &CGM.getModule());
1961 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1962
Hans Wennborg88497d62013-11-15 17:24:45 +00001963 ThunkFn->setLinkage(MD->isExternallyVisible()
1964 ? llvm::GlobalValue::LinkOnceODRLinkage
1965 : llvm::GlobalValue::InternalLinkage);
David Majnemer8c9cdb62015-01-21 01:21:31 +00001966 if (MD->isExternallyVisible())
1967 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
Hans Wennborg88497d62013-11-15 17:24:45 +00001968
1969 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1970 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1971
Reid Kleckner9da94482015-01-21 22:18:17 +00001972 // Add the "thunk" attribute so that LLVM knows that the return type is
1973 // meaningless. These thunks can be used to call functions with differing
1974 // return types, and the caller is required to cast the prototype
1975 // appropriately to extract the correct value.
1976 ThunkFn->addFnAttr("thunk");
1977
Reid Klecknerb9538a62014-08-15 18:12:40 +00001978 // These thunks can be compared, so they are not unnamed.
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001979 ThunkFn->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::None);
Reid Klecknerb9538a62014-08-15 18:12:40 +00001980
Hans Wennborg88497d62013-11-15 17:24:45 +00001981 // Start codegen.
1982 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00001983 CGF.CurGD = GlobalDecl(MD);
1984 CGF.CurFuncIsThunk = true;
1985
1986 // Build FunctionArgs, but only include the implicit 'this' parameter
1987 // declaration.
1988 FunctionArgList FunctionArgs;
1989 buildThisParam(CGF, FunctionArgs);
1990
1991 // Start defining the function.
1992 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
1993 FunctionArgs, MD->getLocation(), SourceLocation());
Reid Kleckner06239e42017-11-16 19:09:36 +00001994 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
Hans Wennborg88497d62013-11-15 17:24:45 +00001995
Reid Klecknere4a52202014-02-21 02:27:32 +00001996 // Load the vfptr and then callee from the vftable. The callee should have
1997 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00001998 llvm::Value *VTable = CGF.GetVTablePtr(
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001999 getThisAddress(CGF), ThunkTy->getPointerTo()->getPointerTo(), MD->getParent());
2000
Reid Klecknere4a52202014-02-21 02:27:32 +00002001 llvm::Value *VFuncPtr =
2002 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
John McCall7f416cc2015-09-08 08:05:57 +00002003 llvm::Value *Callee =
2004 CGF.Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
Hans Wennborg88497d62013-11-15 17:24:45 +00002005
Reid Klecknerc3473512014-08-29 21:43:29 +00002006 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee);
Hans Wennborg88497d62013-11-15 17:24:45 +00002007
2008 return ThunkFn;
2009}
2010
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002011void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002012 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
2013 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00002014 const std::unique_ptr<VPtrInfo>& VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002015 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
David Majnemer129f4172015-02-02 10:22:20 +00002016 if (GV->isDeclaration())
2017 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00002018 }
2019}
2020
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002021llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002022MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002023 llvm::GlobalVariable::LinkageTypes Linkage) {
2024 SmallString<256> OutName;
2025 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00002026 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002027 StringRef Name = OutName.str();
2028
2029 llvm::ArrayType *VBTableType =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002030 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ObjectWithVPtr->getNumVBases());
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002031
2032 assert(!CGM.getModule().getNamedGlobal(Name) &&
2033 "vbtable with this name already exists: mangling bug?");
2034 llvm::GlobalVariable *GV =
2035 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00002036 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Hans Wennborg853ae942014-05-30 16:59:42 +00002037
2038 if (RD->hasAttr<DLLImportAttr>())
2039 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
2040 else if (RD->hasAttr<DLLExportAttr>())
2041 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
2042
David Majnemer129f4172015-02-02 10:22:20 +00002043 if (!GV->hasExternalLinkage())
2044 emitVBTableDefinition(VBT, RD, GV);
2045
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002046 return GV;
2047}
2048
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002049void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002050 const CXXRecordDecl *RD,
2051 llvm::GlobalVariable *GV) const {
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002052 const CXXRecordDecl *ObjectWithVPtr = VBT.ObjectWithVPtr;
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002053
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002054 assert(RD->getNumVBases() && ObjectWithVPtr->getNumVBases() &&
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002055 "should only emit vbtables for classes with vbtables");
2056
2057 const ASTRecordLayout &BaseLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002058 getContext().getASTRecordLayout(VBT.IntroducingObject);
David Majnemer9ced3dd2015-03-14 23:44:48 +00002059 const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002060
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002061 SmallVector<llvm::Constant *, 4> Offsets(1 + ObjectWithVPtr->getNumVBases(),
Craig Topper8a13c412014-05-21 05:09:00 +00002062 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002063
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002064 // The offset from ObjectWithVPtr's vbptr to itself always leads.
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002065 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
2066 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
2067
2068 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002069 for (const auto &I : ObjectWithVPtr->vbases()) {
Aaron Ballman445a9392014-03-13 16:15:17 +00002070 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002071 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
2072 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00002073
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002074 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00002075 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002076 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00002077 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002078 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00002079 Offset -= CompleteVBPtrOffset;
2080
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002081 unsigned VBIndex = Context.getVBTableIndex(ObjectWithVPtr, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00002082 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002083 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
2084 }
2085
2086 assert(Offsets.size() ==
2087 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
2088 ->getElementType())->getNumElements());
2089 llvm::ArrayType *VBTableType =
2090 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
2091 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
2092 GV->setInitializer(Init);
David Majnemer46e39cc2016-02-22 17:22:08 +00002093
2094 if (RD->hasAttr<DLLImportAttr>())
2095 GV->setLinkage(llvm::GlobalVariable::AvailableExternallyLinkage);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002096}
2097
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002098llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002099 Address This,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002100 const ThisAdjustment &TA) {
2101 if (TA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002102 return This.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002103
John McCall7f416cc2015-09-08 08:05:57 +00002104 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002105
John McCall7f416cc2015-09-08 08:05:57 +00002106 llvm::Value *V;
2107 if (TA.Virtual.isEmpty()) {
2108 V = This.getPointer();
2109 } else {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002110 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
2111 // Adjust the this argument based on the vtordisp value.
John McCall7f416cc2015-09-08 08:05:57 +00002112 Address VtorDispPtr =
2113 CGF.Builder.CreateConstInBoundsByteGEP(This,
2114 CharUnits::fromQuantity(TA.Virtual.Microsoft.VtordispOffset));
2115 VtorDispPtr = CGF.Builder.CreateElementBitCast(VtorDispPtr, CGF.Int32Ty);
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002116 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
John McCall7f416cc2015-09-08 08:05:57 +00002117 V = CGF.Builder.CreateGEP(This.getPointer(),
2118 CGF.Builder.CreateNeg(VtorDisp));
2119
2120 // Unfortunately, having applied the vtordisp means that we no
2121 // longer really have a known alignment for the vbptr step.
2122 // We'll assume the vbptr is pointer-aligned.
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002123
2124 if (TA.Virtual.Microsoft.VBPtrOffset) {
2125 // If the final overrider is defined in a virtual base other than the one
2126 // that holds the vfptr, we have to use a vtordispex thunk which looks up
2127 // the vbtable of the derived class.
2128 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
2129 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
2130 llvm::Value *VBPtr;
2131 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002132 GetVBaseOffsetFromVBPtr(CGF, Address(V, CGF.getPointerAlign()),
2133 -TA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002134 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
2135 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2136 }
2137 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002138
2139 if (TA.NonVirtual) {
2140 // Non-virtual adjustment might result in a pointer outside the allocated
2141 // object, e.g. if the final overrider class is laid out after the virtual
2142 // base that declares a method in the most derived class.
2143 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
2144 }
2145
2146 // Don't need to bitcast back, the call CodeGen will handle this.
2147 return V;
2148}
2149
2150llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00002151MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002152 const ReturnAdjustment &RA) {
2153 if (RA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002154 return Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002155
John McCall7f416cc2015-09-08 08:05:57 +00002156 auto OrigTy = Ret.getType();
2157 Ret = CGF.Builder.CreateElementBitCast(Ret, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002158
John McCall7f416cc2015-09-08 08:05:57 +00002159 llvm::Value *V = Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002160 if (RA.Virtual.Microsoft.VBIndex) {
2161 assert(RA.Virtual.Microsoft.VBIndex > 0);
John McCall7f416cc2015-09-08 08:05:57 +00002162 int32_t IntSize = CGF.getIntSize().getQuantity();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002163 llvm::Value *VBPtr;
2164 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002165 GetVBaseOffsetFromVBPtr(CGF, Ret, RA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002166 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
2167 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2168 }
2169
2170 if (RA.NonVirtual)
David Blaikiefb901c7a2015-04-04 15:12:29 +00002171 V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002172
2173 // Cast back to the original type.
John McCall7f416cc2015-09-08 08:05:57 +00002174 return CGF.Builder.CreateBitCast(V, OrigTy);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002175}
2176
John McCallb91cd662012-05-01 05:23:51 +00002177bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
2178 QualType elementType) {
2179 // Microsoft seems to completely ignore the possibility of a
2180 // two-argument usual deallocation function.
2181 return elementType.isDestructedType();
2182}
2183
2184bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
2185 // Microsoft seems to completely ignore the possibility of a
2186 // two-argument usual deallocation function.
2187 return expr->getAllocatedType().isDestructedType();
2188}
2189
2190CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
2191 // The array cookie is always a size_t; we then pad that out to the
2192 // alignment of the element type.
2193 ASTContext &Ctx = getContext();
2194 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
2195 Ctx.getTypeAlignInChars(type));
2196}
2197
2198llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002199 Address allocPtr,
John McCallb91cd662012-05-01 05:23:51 +00002200 CharUnits cookieSize) {
John McCall7f416cc2015-09-08 08:05:57 +00002201 Address numElementsPtr =
2202 CGF.Builder.CreateElementBitCast(allocPtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002203 return CGF.Builder.CreateLoad(numElementsPtr);
2204}
2205
John McCall7f416cc2015-09-08 08:05:57 +00002206Address MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
2207 Address newPtr,
2208 llvm::Value *numElements,
2209 const CXXNewExpr *expr,
2210 QualType elementType) {
John McCallb91cd662012-05-01 05:23:51 +00002211 assert(requiresArrayCookie(expr));
2212
2213 // The size of the cookie.
2214 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
2215
2216 // Compute an offset to the cookie.
John McCall7f416cc2015-09-08 08:05:57 +00002217 Address cookiePtr = newPtr;
John McCallb91cd662012-05-01 05:23:51 +00002218
2219 // Write the number of elements into the appropriate slot.
John McCall7f416cc2015-09-08 08:05:57 +00002220 Address numElementsPtr
2221 = CGF.Builder.CreateElementBitCast(cookiePtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002222 CGF.Builder.CreateStore(numElements, numElementsPtr);
2223
2224 // Finally, compute a pointer to the actual data buffer by skipping
2225 // over the cookie completely.
John McCall7f416cc2015-09-08 08:05:57 +00002226 return CGF.Builder.CreateConstInBoundsByteGEP(newPtr, cookieSize);
John McCallb91cd662012-05-01 05:23:51 +00002227}
2228
David Majnemerb3341ea2014-10-05 05:05:40 +00002229static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
2230 llvm::Constant *Dtor,
2231 llvm::Constant *Addr) {
2232 // Create a function which calls the destructor.
2233 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
2234
2235 // extern "C" int __tlregdtor(void (*f)(void));
2236 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
2237 CGF.IntTy, DtorStub->getType(), /*IsVarArg=*/false);
2238
Reid Klecknerde864822017-03-21 16:57:30 +00002239 llvm::Constant *TLRegDtor = CGF.CGM.CreateRuntimeFunction(
2240 TLRegDtorTy, "__tlregdtor", llvm::AttributeList(), /*Local=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002241 if (llvm::Function *TLRegDtorFn = dyn_cast<llvm::Function>(TLRegDtor))
2242 TLRegDtorFn->setDoesNotThrow();
2243
2244 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
2245}
2246
2247void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
2248 llvm::Constant *Dtor,
2249 llvm::Constant *Addr) {
2250 if (D.getTLSKind())
2251 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
2252
2253 // The default behavior is to use atexit.
2254 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
2255}
2256
2257void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +00002258 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +00002259 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +00002260 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) {
David Majnemercb60a432016-09-12 02:51:43 +00002261 if (CXXThreadLocalInits.empty())
2262 return;
2263
2264 CGM.AppendLinkerOptions(CGM.getTarget().getTriple().getArch() ==
2265 llvm::Triple::x86
2266 ? "/include:___dyn_tls_init@12"
2267 : "/include:__dyn_tls_init");
2268
David Majnemerb3341ea2014-10-05 05:05:40 +00002269 // This will create a GV in the .CRT$XDU section. It will point to our
2270 // initialization function. The CRT will call all of these function
2271 // pointers at start-up time and, eventually, at thread-creation time.
2272 auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
2273 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
2274 CGM.getModule(), InitFunc->getType(), /*IsConstant=*/true,
2275 llvm::GlobalVariable::InternalLinkage, InitFunc,
2276 Twine(InitFunc->getName(), "$initializer$"));
2277 InitFuncPtr->setSection(".CRT$XDU");
2278 // This variable has discardable linkage, we have to add it to @llvm.used to
2279 // ensure it won't get discarded.
2280 CGM.addUsedGlobal(InitFuncPtr);
2281 return InitFuncPtr;
2282 };
2283
2284 std::vector<llvm::Function *> NonComdatInits;
2285 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
Richard Smith5a99c492015-12-01 01:10:48 +00002286 llvm::GlobalVariable *GV = cast<llvm::GlobalVariable>(
2287 CGM.GetGlobalValue(CGM.getMangledName(CXXThreadLocalInitVars[I])));
David Majnemerb3341ea2014-10-05 05:05:40 +00002288 llvm::Function *F = CXXThreadLocalInits[I];
2289
2290 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002291 if (llvm::Comdat *C = GV->getComdat())
David Majnemerb3341ea2014-10-05 05:05:40 +00002292 AddToXDU(F)->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002293 else
David Majnemerb3341ea2014-10-05 05:05:40 +00002294 NonComdatInits.push_back(F);
David Majnemerb3341ea2014-10-05 05:05:40 +00002295 }
2296
2297 if (!NonComdatInits.empty()) {
2298 llvm::FunctionType *FTy =
2299 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002300 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +00002301 FTy, "__tls_init", CGM.getTypes().arrangeNullaryFunction(),
2302 SourceLocation(), /*TLS=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002303 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2304
2305 AddToXDU(InitFunc);
2306 }
2307}
2308
2309LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2310 const VarDecl *VD,
2311 QualType LValType) {
2312 CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2313 return LValue();
2314}
2315
John McCall7f416cc2015-09-08 08:05:57 +00002316static ConstantAddress getInitThreadEpochPtr(CodeGenModule &CGM) {
David Majnemer8354eee2015-05-07 06:15:46 +00002317 StringRef VarName("_Init_thread_epoch");
John McCall7f416cc2015-09-08 08:05:57 +00002318 CharUnits Align = CGM.getIntAlign();
David Majnemer8354eee2015-05-07 06:15:46 +00002319 if (auto *GV = CGM.getModule().getNamedGlobal(VarName))
John McCall7f416cc2015-09-08 08:05:57 +00002320 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002321 auto *GV = new llvm::GlobalVariable(
2322 CGM.getModule(), CGM.IntTy,
2323 /*Constant=*/false, llvm::GlobalVariable::ExternalLinkage,
2324 /*Initializer=*/nullptr, VarName,
2325 /*InsertBefore=*/nullptr, llvm::GlobalVariable::GeneralDynamicTLSModel);
John McCall7f416cc2015-09-08 08:05:57 +00002326 GV->setAlignment(Align.getQuantity());
2327 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002328}
2329
2330static llvm::Constant *getInitThreadHeaderFn(CodeGenModule &CGM) {
2331 llvm::FunctionType *FTy =
2332 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2333 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2334 return CGM.CreateRuntimeFunction(
2335 FTy, "_Init_thread_header",
Reid Klecknerde864822017-03-21 16:57:30 +00002336 llvm::AttributeList::get(CGM.getLLVMContext(),
2337 llvm::AttributeList::FunctionIndex,
2338 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002339 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002340}
2341
2342static llvm::Constant *getInitThreadFooterFn(CodeGenModule &CGM) {
2343 llvm::FunctionType *FTy =
2344 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2345 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2346 return CGM.CreateRuntimeFunction(
2347 FTy, "_Init_thread_footer",
Reid Klecknerde864822017-03-21 16:57:30 +00002348 llvm::AttributeList::get(CGM.getLLVMContext(),
2349 llvm::AttributeList::FunctionIndex,
2350 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002351 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002352}
2353
2354static llvm::Constant *getInitThreadAbortFn(CodeGenModule &CGM) {
2355 llvm::FunctionType *FTy =
2356 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2357 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2358 return CGM.CreateRuntimeFunction(
2359 FTy, "_Init_thread_abort",
Reid Klecknerde864822017-03-21 16:57:30 +00002360 llvm::AttributeList::get(CGM.getLLVMContext(),
2361 llvm::AttributeList::FunctionIndex,
2362 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002363 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002364}
2365
2366namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002367struct ResetGuardBit final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002368 Address Guard;
David Majnemer8354eee2015-05-07 06:15:46 +00002369 unsigned GuardNum;
John McCall7f416cc2015-09-08 08:05:57 +00002370 ResetGuardBit(Address Guard, unsigned GuardNum)
David Majnemer8354eee2015-05-07 06:15:46 +00002371 : Guard(Guard), GuardNum(GuardNum) {}
2372
2373 void Emit(CodeGenFunction &CGF, Flags flags) override {
2374 // Reset the bit in the mask so that the static variable may be
2375 // reinitialized.
2376 CGBuilderTy &Builder = CGF.Builder;
2377 llvm::LoadInst *LI = Builder.CreateLoad(Guard);
2378 llvm::ConstantInt *Mask =
Reid Klecknerd16cebe2016-02-10 19:09:15 +00002379 llvm::ConstantInt::get(CGF.IntTy, ~(1ULL << GuardNum));
David Majnemer8354eee2015-05-07 06:15:46 +00002380 Builder.CreateStore(Builder.CreateAnd(LI, Mask), Guard);
2381 }
2382};
2383
David Blaikie7e70d682015-08-18 22:40:54 +00002384struct CallInitThreadAbort final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002385 llvm::Value *Guard;
2386 CallInitThreadAbort(Address Guard) : Guard(Guard.getPointer()) {}
David Majnemer8354eee2015-05-07 06:15:46 +00002387
2388 void Emit(CodeGenFunction &CGF, Flags flags) override {
2389 // Calling _Init_thread_abort will reset the guard's state.
2390 CGF.EmitNounwindRuntimeCall(getInitThreadAbortFn(CGF.CGM), Guard);
2391 }
2392};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002393}
David Majnemer8354eee2015-05-07 06:15:46 +00002394
John McCallc84ed6a2012-05-01 06:13:13 +00002395void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00002396 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00002397 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00002398 // MSVC only uses guards for static locals.
2399 if (!D.isStaticLocal()) {
2400 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2401 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
Rafael Espindola77abc3a2015-01-16 16:04:45 +00002402 llvm::Function *F = CGF.CurFn;
2403 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2404 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
Reid Kleckner563f0e82014-05-23 21:13:45 +00002405 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2406 return;
2407 }
2408
David Majnemerec8e54b2015-05-07 21:19:06 +00002409 bool ThreadlocalStatic = D.getTLSKind();
2410 bool ThreadsafeStatic = getContext().getLangOpts().ThreadsafeStatics;
2411
2412 // Thread-safe static variables which aren't thread-specific have a
2413 // per-variable guard.
2414 bool HasPerVariableGuard = ThreadsafeStatic && !ThreadlocalStatic;
Richard Smithdbf74ba2013-04-14 23:01:42 +00002415
Reid Klecknerd8110b62013-09-10 20:14:30 +00002416 CGBuilderTy &Builder = CGF.Builder;
2417 llvm::IntegerType *GuardTy = CGF.Int32Ty;
2418 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
John McCall7f416cc2015-09-08 08:05:57 +00002419 CharUnits GuardAlign = CharUnits::fromQuantity(4);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002420
2421 // Get the guard variable for this function if we have one already.
David Majnemerec8e54b2015-05-07 21:19:06 +00002422 GuardInfo *GI = nullptr;
2423 if (ThreadlocalStatic)
2424 GI = &ThreadLocalGuardVariableMap[D.getDeclContext()];
2425 else if (!ThreadsafeStatic)
2426 GI = &GuardVariableMap[D.getDeclContext()];
2427
2428 llvm::GlobalVariable *GuardVar = GI ? GI->Guard : nullptr;
David Majnemer8354eee2015-05-07 06:15:46 +00002429 unsigned GuardNum;
David Majnemerec8e54b2015-05-07 21:19:06 +00002430 if (D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002431 // Externally visible variables have to be numbered in Sema to properly
2432 // handle unreachable VarDecls.
David Majnemer8354eee2015-05-07 06:15:46 +00002433 GuardNum = getContext().getStaticLocalNumber(&D);
2434 assert(GuardNum > 0);
2435 GuardNum--;
2436 } else if (HasPerVariableGuard) {
2437 GuardNum = ThreadSafeGuardNumMap[D.getDeclContext()]++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002438 } else {
2439 // Non-externally visible variables are numbered here in CodeGen.
David Majnemer8354eee2015-05-07 06:15:46 +00002440 GuardNum = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002441 }
2442
David Majnemer8354eee2015-05-07 06:15:46 +00002443 if (!HasPerVariableGuard && GuardNum >= 32) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002444 if (D.isExternallyVisible())
2445 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
David Majnemer8354eee2015-05-07 06:15:46 +00002446 GuardNum %= 32;
2447 GuardVar = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002448 }
2449
David Majnemer8354eee2015-05-07 06:15:46 +00002450 if (!GuardVar) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002451 // Mangle the name for the guard.
2452 SmallString<256> GuardName;
2453 {
2454 llvm::raw_svector_ostream Out(GuardName);
David Majnemer8354eee2015-05-07 06:15:46 +00002455 if (HasPerVariableGuard)
2456 getMangleContext().mangleThreadSafeStaticGuardVariable(&D, GuardNum,
2457 Out);
2458 else
2459 getMangleContext().mangleStaticGuardVariable(&D, Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002460 }
2461
Hans Wennborgef2272c2014-06-18 15:55:13 +00002462 // Create the guard variable with a zero-initializer. Just absorb linkage,
2463 // visibility and dll storage class from the guarded variable.
David Majnemer8354eee2015-05-07 06:15:46 +00002464 GuardVar =
2465 new llvm::GlobalVariable(CGM.getModule(), GuardTy, /*isConstant=*/false,
Reid Klecknere9591b32014-04-23 18:22:11 +00002466 GV->getLinkage(), Zero, GuardName.str());
David Majnemer8354eee2015-05-07 06:15:46 +00002467 GuardVar->setVisibility(GV->getVisibility());
2468 GuardVar->setDLLStorageClass(GV->getDLLStorageClass());
John McCall7f416cc2015-09-08 08:05:57 +00002469 GuardVar->setAlignment(GuardAlign.getQuantity());
David Majnemer8354eee2015-05-07 06:15:46 +00002470 if (GuardVar->isWeakForLinker())
2471 GuardVar->setComdat(
2472 CGM.getModule().getOrInsertComdat(GuardVar->getName()));
2473 if (D.getTLSKind())
2474 GuardVar->setThreadLocal(true);
2475 if (GI && !HasPerVariableGuard)
2476 GI->Guard = GuardVar;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002477 }
2478
John McCall7f416cc2015-09-08 08:05:57 +00002479 ConstantAddress GuardAddr(GuardVar, GuardAlign);
2480
David Majnemer8354eee2015-05-07 06:15:46 +00002481 assert(GuardVar->getLinkage() == GV->getLinkage() &&
2482 "static local from the same function had different linkage");
Reid Klecknerd8110b62013-09-10 20:14:30 +00002483
David Majnemer8354eee2015-05-07 06:15:46 +00002484 if (!HasPerVariableGuard) {
2485 // Pseudo code for the test:
2486 // if (!(GuardVar & MyGuardBit)) {
2487 // GuardVar |= MyGuardBit;
2488 // ... initialize the object ...;
2489 // }
Reid Klecknerd8110b62013-09-10 20:14:30 +00002490
David Majnemer8354eee2015-05-07 06:15:46 +00002491 // Test our bit from the guard variable.
Aaron Ballmanabd466e2016-03-30 21:33:34 +00002492 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1ULL << GuardNum);
John McCall7f416cc2015-09-08 08:05:57 +00002493 llvm::LoadInst *LI = Builder.CreateLoad(GuardAddr);
Richard Smithae8d62c2017-07-26 22:01:09 +00002494 llvm::Value *NeedsInit =
2495 Builder.CreateICmpEQ(Builder.CreateAnd(LI, Bit), Zero);
David Majnemer8354eee2015-05-07 06:15:46 +00002496 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2497 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002498 CGF.EmitCXXGuardedInitBranch(NeedsInit, InitBlock, EndBlock,
2499 CodeGenFunction::GuardKind::VariableGuard, &D);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002500
David Majnemer8354eee2015-05-07 06:15:46 +00002501 // Set our bit in the guard variable and emit the initializer and add a global
2502 // destructor if appropriate.
2503 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002504 Builder.CreateStore(Builder.CreateOr(LI, Bit), GuardAddr);
2505 CGF.EHStack.pushCleanup<ResetGuardBit>(EHCleanup, GuardAddr, GuardNum);
David Majnemer8354eee2015-05-07 06:15:46 +00002506 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2507 CGF.PopCleanupBlock();
2508 Builder.CreateBr(EndBlock);
2509
2510 // Continue.
2511 CGF.EmitBlock(EndBlock);
2512 } else {
2513 // Pseudo code for the test:
2514 // if (TSS > _Init_thread_epoch) {
2515 // _Init_thread_header(&TSS);
2516 // if (TSS == -1) {
2517 // ... initialize the object ...;
2518 // _Init_thread_footer(&TSS);
2519 // }
2520 // }
2521 //
2522 // The algorithm is almost identical to what can be found in the appendix
2523 // found in N2325.
2524
David Majnemer8354eee2015-05-07 06:15:46 +00002525 // This BasicBLock determines whether or not we have any work to do.
John McCall7f416cc2015-09-08 08:05:57 +00002526 llvm::LoadInst *FirstGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002527 FirstGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2528 llvm::LoadInst *InitThreadEpoch =
2529 Builder.CreateLoad(getInitThreadEpochPtr(CGM));
2530 llvm::Value *IsUninitialized =
2531 Builder.CreateICmpSGT(FirstGuardLoad, InitThreadEpoch);
2532 llvm::BasicBlock *AttemptInitBlock = CGF.createBasicBlock("init.attempt");
2533 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002534 CGF.EmitCXXGuardedInitBranch(IsUninitialized, AttemptInitBlock, EndBlock,
2535 CodeGenFunction::GuardKind::VariableGuard, &D);
David Majnemer8354eee2015-05-07 06:15:46 +00002536
2537 // This BasicBlock attempts to determine whether or not this thread is
2538 // responsible for doing the initialization.
2539 CGF.EmitBlock(AttemptInitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002540 CGF.EmitNounwindRuntimeCall(getInitThreadHeaderFn(CGM),
2541 GuardAddr.getPointer());
2542 llvm::LoadInst *SecondGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002543 SecondGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2544 llvm::Value *ShouldDoInit =
2545 Builder.CreateICmpEQ(SecondGuardLoad, getAllOnesInt());
2546 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2547 Builder.CreateCondBr(ShouldDoInit, InitBlock, EndBlock);
2548
2549 // Ok, we ended up getting selected as the initializing thread.
2550 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002551 CGF.EHStack.pushCleanup<CallInitThreadAbort>(EHCleanup, GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002552 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2553 CGF.PopCleanupBlock();
John McCall7f416cc2015-09-08 08:05:57 +00002554 CGF.EmitNounwindRuntimeCall(getInitThreadFooterFn(CGM),
2555 GuardAddr.getPointer());
David Majnemer8354eee2015-05-07 06:15:46 +00002556 Builder.CreateBr(EndBlock);
2557
2558 CGF.EmitBlock(EndBlock);
2559 }
John McCallc84ed6a2012-05-01 06:13:13 +00002560}
2561
Reid Kleckner2341ae32013-04-11 18:13:19 +00002562bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2563 // Null-ness for function memptrs only depends on the first field, which is
2564 // the function pointer. The rest don't matter, so we can zero initialize.
2565 if (MPT->isMemberFunctionPointer())
2566 return true;
2567
2568 // The virtual base adjustment field is always -1 for null, so if we have one
2569 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
2570 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002571 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2572 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002573 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
2574 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00002575}
2576
2577llvm::Type *
2578MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002579 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2580 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002581 llvm::SmallVector<llvm::Type *, 4> fields;
2582 if (MPT->isMemberFunctionPointer())
2583 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
2584 else
2585 fields.push_back(CGM.IntTy); // FieldOffset
2586
Reid Kleckner96f8f932014-02-05 17:27:08 +00002587 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2588 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002589 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002590 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002591 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002592 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002593 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
2594
2595 if (fields.size() == 1)
2596 return fields[0];
2597 return llvm::StructType::get(CGM.getLLVMContext(), fields);
2598}
2599
2600void MicrosoftCXXABI::
2601GetNullMemberPointerFields(const MemberPointerType *MPT,
2602 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2603 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00002604 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2605 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002606 if (MPT->isMemberFunctionPointer()) {
2607 // FunctionPointerOrVirtualThunk
2608 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2609 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00002610 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00002611 fields.push_back(getZeroInt()); // FieldOffset
2612 else
2613 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00002614 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00002615
Reid Kleckner96f8f932014-02-05 17:27:08 +00002616 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2617 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002618 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002619 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002620 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002621 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002622 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002623}
2624
2625llvm::Constant *
2626MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002627 llvm::SmallVector<llvm::Constant *, 4> fields;
2628 GetNullMemberPointerFields(MPT, fields);
2629 if (fields.size() == 1)
2630 return fields[0];
2631 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2632 assert(Res->getType() == ConvertMemberPointerType(MPT));
2633 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002634}
2635
2636llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002637MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2638 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00002639 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +00002640 CharUnits NonVirtualBaseAdjustment,
2641 unsigned VBTableIndex) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002642 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002643
2644 // Single inheritance class member pointer are represented as scalars instead
2645 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002646 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002647 return FirstField;
2648
Reid Kleckner2341ae32013-04-11 18:13:19 +00002649 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002650 fields.push_back(FirstField);
2651
Reid Kleckner96f8f932014-02-05 17:27:08 +00002652 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002653 fields.push_back(llvm::ConstantInt::get(
2654 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002655
Reid Kleckner96f8f932014-02-05 17:27:08 +00002656 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00002657 CharUnits Offs = CharUnits::Zero();
David Majnemerc1709d32015-06-23 07:31:11 +00002658 if (VBTableIndex)
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002659 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00002660 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00002661 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002662
2663 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002664 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
David Majnemere60813f2015-05-10 21:48:08 +00002665 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, VBTableIndex));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002666
Reid Kleckner2341ae32013-04-11 18:13:19 +00002667 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002668}
2669
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002670llvm::Constant *
2671MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2672 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002673 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerc1709d32015-06-23 07:31:11 +00002674 if (RD->getMSInheritanceModel() ==
2675 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002676 offset -= getContext().getOffsetOfBaseWithVBPtr(RD);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002677 llvm::Constant *FirstField =
2678 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00002679 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002680 CharUnits::Zero(), /*VBTableIndex=*/0);
Reid Kleckner452abac2013-05-09 21:01:17 +00002681}
2682
Reid Kleckner452abac2013-05-09 21:01:17 +00002683llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2684 QualType MPType) {
David Majnemer5ca193c2015-06-23 07:31:07 +00002685 const MemberPointerType *DstTy = MPType->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002686 const ValueDecl *MPD = MP.getMemberPointerDecl();
2687 if (!MPD)
David Majnemer5ca193c2015-06-23 07:31:07 +00002688 return EmitNullMemberPointer(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002689
David Majnemer5ca193c2015-06-23 07:31:07 +00002690 ASTContext &Ctx = getContext();
2691 ArrayRef<const CXXRecordDecl *> MemberPointerPath = MP.getMemberPointerPath();
Reid Kleckner452abac2013-05-09 21:01:17 +00002692
David Majnemer5ca193c2015-06-23 07:31:07 +00002693 llvm::Constant *C;
2694 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) {
2695 C = EmitMemberFunctionPointer(MD);
2696 } else {
2697 CharUnits FieldOffset = Ctx.toCharUnitsFromBits(Ctx.getFieldOffset(MPD));
2698 C = EmitMemberDataPointer(DstTy, FieldOffset);
2699 }
Reid Kleckner452abac2013-05-09 21:01:17 +00002700
David Majnemer5ca193c2015-06-23 07:31:07 +00002701 if (!MemberPointerPath.empty()) {
2702 const CXXRecordDecl *SrcRD = cast<CXXRecordDecl>(MPD->getDeclContext());
2703 const Type *SrcRecTy = Ctx.getTypeDeclType(SrcRD).getTypePtr();
2704 const MemberPointerType *SrcTy =
2705 Ctx.getMemberPointerType(DstTy->getPointeeType(), SrcRecTy)
2706 ->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002707
David Majnemer5ca193c2015-06-23 07:31:07 +00002708 bool DerivedMember = MP.isMemberPointerToDerivedMember();
2709 SmallVector<const CXXBaseSpecifier *, 4> DerivedToBasePath;
2710 const CXXRecordDecl *PrevRD = SrcRD;
2711 for (const CXXRecordDecl *PathElem : MemberPointerPath) {
2712 const CXXRecordDecl *Base = nullptr;
2713 const CXXRecordDecl *Derived = nullptr;
2714 if (DerivedMember) {
2715 Base = PathElem;
2716 Derived = PrevRD;
2717 } else {
2718 Base = PrevRD;
2719 Derived = PathElem;
2720 }
2721 for (const CXXBaseSpecifier &BS : Derived->bases())
2722 if (BS.getType()->getAsCXXRecordDecl()->getCanonicalDecl() ==
2723 Base->getCanonicalDecl())
2724 DerivedToBasePath.push_back(&BS);
2725 PrevRD = PathElem;
2726 }
2727 assert(DerivedToBasePath.size() == MemberPointerPath.size());
2728
2729 CastKind CK = DerivedMember ? CK_DerivedToBaseMemberPointer
2730 : CK_BaseToDerivedMemberPointer;
2731 C = EmitMemberPointerConversion(SrcTy, DstTy, CK, DerivedToBasePath.begin(),
2732 DerivedToBasePath.end(), C);
2733 }
2734 return C;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002735}
2736
2737llvm::Constant *
David Majnemer5ca193c2015-06-23 07:31:07 +00002738MicrosoftCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002739 assert(MD->isInstance() && "Member function must not be static!");
David Majnemer5ca193c2015-06-23 07:31:07 +00002740
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002741 MD = MD->getCanonicalDecl();
David Majnemer5ca193c2015-06-23 07:31:07 +00002742 CharUnits NonVirtualBaseAdjustment = CharUnits::Zero();
2743 const CXXRecordDecl *RD = MD->getParent()->getMostRecentDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002744 CodeGenTypes &Types = CGM.getTypes();
2745
David Majnemere60813f2015-05-10 21:48:08 +00002746 unsigned VBTableIndex = 0;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002747 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00002748 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00002749 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002750 llvm::Type *Ty;
2751 // Check whether the function has a computable LLVM signature.
2752 if (Types.isFuncTypeConvertible(FPT)) {
2753 // The function has a computable LLVM signature; use the correct type.
2754 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2755 } else {
2756 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2757 // function type is incomplete.
2758 Ty = CGM.PtrDiffTy;
2759 }
2760 FirstField = CGM.GetAddrOfFunction(MD, Ty);
Hans Wennborg88497d62013-11-15 17:24:45 +00002761 } else {
David Majnemere0e228a2015-06-11 08:12:44 +00002762 auto &VTableContext = CGM.getMicrosoftVTableContext();
Nico Webere7c7d702018-03-31 18:26:25 +00002763 MicrosoftVTableContext::MethodVFTableLocation ML =
David Majnemere0e228a2015-06-11 08:12:44 +00002764 VTableContext.getMethodVFTableLocation(MD);
David Majnemerc1709d32015-06-23 07:31:11 +00002765 FirstField = EmitVirtualMemPtrThunk(MD, ML);
David Majnemere0e228a2015-06-11 08:12:44 +00002766 // Include the vfptr adjustment if the method is in a non-primary vftable.
2767 NonVirtualBaseAdjustment += ML.VFPtrOffset;
2768 if (ML.VBase)
2769 VBTableIndex = VTableContext.getVBTableIndex(RD, ML.VBase) * 4;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002770 }
2771
David Majnemerc1709d32015-06-23 07:31:11 +00002772 if (VBTableIndex == 0 &&
2773 RD->getMSInheritanceModel() ==
2774 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002775 NonVirtualBaseAdjustment -= getContext().getOffsetOfBaseWithVBPtr(RD);
David Majnemerc1709d32015-06-23 07:31:11 +00002776
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002777 // The rest of the fields are common with data member pointers.
David Majnemerc1709d32015-06-23 07:31:11 +00002778 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002779 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002780 NonVirtualBaseAdjustment, VBTableIndex);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002781}
2782
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002783/// Member pointers are the same if they're either bitwise identical *or* both
2784/// null. Null-ness for function members is determined by the first field,
2785/// while for data member pointers we must compare all fields.
2786llvm::Value *
2787MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2788 llvm::Value *L,
2789 llvm::Value *R,
2790 const MemberPointerType *MPT,
2791 bool Inequality) {
2792 CGBuilderTy &Builder = CGF.Builder;
2793
2794 // Handle != comparisons by switching the sense of all boolean operations.
2795 llvm::ICmpInst::Predicate Eq;
2796 llvm::Instruction::BinaryOps And, Or;
2797 if (Inequality) {
2798 Eq = llvm::ICmpInst::ICMP_NE;
2799 And = llvm::Instruction::Or;
2800 Or = llvm::Instruction::And;
2801 } else {
2802 Eq = llvm::ICmpInst::ICMP_EQ;
2803 And = llvm::Instruction::And;
2804 Or = llvm::Instruction::Or;
2805 }
2806
2807 // If this is a single field member pointer (single inheritance), this is a
2808 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002809 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2810 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002811 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2812 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002813 return Builder.CreateICmp(Eq, L, R);
2814
2815 // Compare the first field.
2816 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2817 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2818 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2819
2820 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002821 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002822 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2823 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2824 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2825 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2826 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2827 if (Res)
2828 Res = Builder.CreateBinOp(And, Res, Cmp);
2829 else
2830 Res = Cmp;
2831 }
2832
2833 // Check if the first field is 0 if this is a function pointer.
2834 if (MPT->isMemberFunctionPointer()) {
2835 // (l1 == r1 && ...) || l0 == 0
2836 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2837 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2838 Res = Builder.CreateBinOp(Or, Res, IsZero);
2839 }
2840
2841 // Combine the comparison of the first field, which must always be true for
2842 // this comparison to succeeed.
2843 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2844}
2845
Reid Kleckner407e8b62013-03-22 19:02:54 +00002846llvm::Value *
2847MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2848 llvm::Value *MemPtr,
2849 const MemberPointerType *MPT) {
2850 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002851 llvm::SmallVector<llvm::Constant *, 4> fields;
2852 // We only need one field for member functions.
2853 if (MPT->isMemberFunctionPointer())
2854 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2855 else
2856 GetNullMemberPointerFields(MPT, fields);
2857 assert(!fields.empty());
2858 llvm::Value *FirstField = MemPtr;
2859 if (MemPtr->getType()->isStructTy())
2860 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2861 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002862
Reid Kleckner2341ae32013-04-11 18:13:19 +00002863 // For function member pointers, we only need to test the function pointer
2864 // field. The other fields if any can be garbage.
2865 if (MPT->isMemberFunctionPointer())
2866 return Res;
2867
2868 // Otherwise, emit a series of compares and combine the results.
2869 for (int I = 1, E = fields.size(); I < E; ++I) {
2870 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2871 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002872 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002873 }
2874 return Res;
2875}
2876
Reid Kleckner452abac2013-05-09 21:01:17 +00002877bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2878 llvm::Constant *Val) {
2879 // Function pointers are null if the pointer in the first field is null.
2880 if (MPT->isMemberFunctionPointer()) {
2881 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2882 Val->getAggregateElement(0U) : Val;
2883 return FirstField->isNullValue();
2884 }
2885
2886 // If it's not a function pointer and it's zero initializable, we can easily
2887 // check zero.
2888 if (isZeroInitializable(MPT) && Val->isNullValue())
2889 return true;
2890
2891 // Otherwise, break down all the fields for comparison. Hopefully these
2892 // little Constants are reused, while a big null struct might not be.
2893 llvm::SmallVector<llvm::Constant *, 4> Fields;
2894 GetNullMemberPointerFields(MPT, Fields);
2895 if (Fields.size() == 1) {
2896 assert(Val->getType()->isIntegerTy());
2897 return Val == Fields[0];
2898 }
2899
2900 unsigned I, E;
2901 for (I = 0, E = Fields.size(); I != E; ++I) {
2902 if (Val->getAggregateElement(I) != Fields[I])
2903 break;
2904 }
2905 return I == E;
2906}
2907
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002908llvm::Value *
2909MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002910 Address This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002911 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002912 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002913 llvm::Value **VBPtrOut) {
2914 CGBuilderTy &Builder = CGF.Builder;
2915 // Load the vbtable pointer from the vbptr in the instance.
John McCall7f416cc2015-09-08 08:05:57 +00002916 This = Builder.CreateElementBitCast(This, CGM.Int8Ty);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002917 llvm::Value *VBPtr =
John McCall7f416cc2015-09-08 08:05:57 +00002918 Builder.CreateInBoundsGEP(This.getPointer(), VBPtrOffset, "vbptr");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002919 if (VBPtrOut) *VBPtrOut = VBPtr;
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002920 VBPtr = Builder.CreateBitCast(VBPtr,
John McCall7f416cc2015-09-08 08:05:57 +00002921 CGM.Int32Ty->getPointerTo(0)->getPointerTo(This.getAddressSpace()));
2922
2923 CharUnits VBPtrAlign;
2924 if (auto CI = dyn_cast<llvm::ConstantInt>(VBPtrOffset)) {
2925 VBPtrAlign = This.getAlignment().alignmentAtOffset(
2926 CharUnits::fromQuantity(CI->getSExtValue()));
2927 } else {
2928 VBPtrAlign = CGF.getPointerAlign();
2929 }
2930
2931 llvm::Value *VBTable = Builder.CreateAlignedLoad(VBPtr, VBPtrAlign, "vbtable");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002932
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002933 // Translate from byte offset to table index. It improves analyzability.
2934 llvm::Value *VBTableIndex = Builder.CreateAShr(
2935 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
2936 "vbtindex", /*isExact=*/true);
2937
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002938 // Load an i32 offset from the vb-table.
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002939 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002940 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
John McCall7f416cc2015-09-08 08:05:57 +00002941 return Builder.CreateAlignedLoad(VBaseOffs, CharUnits::fromQuantity(4),
2942 "vbase_offs");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002943}
2944
Reid Kleckner2341ae32013-04-11 18:13:19 +00002945// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2946// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002947llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2948 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
John McCall7f416cc2015-09-08 08:05:57 +00002949 Address Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002950 CGBuilderTy &Builder = CGF.Builder;
John McCall7f416cc2015-09-08 08:05:57 +00002951 Base = Builder.CreateElementBitCast(Base, CGM.Int8Ty);
Craig Topper8a13c412014-05-21 05:09:00 +00002952 llvm::BasicBlock *OriginalBB = nullptr;
2953 llvm::BasicBlock *SkipAdjustBB = nullptr;
2954 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002955
2956 // In the unspecified inheritance model, there might not be a vbtable at all,
2957 // in which case we need to skip the virtual base lookup. If there is a
2958 // vbtable, the first entry is a no-op entry that gives back the original
2959 // base, so look for a virtual base adjustment offset of zero.
2960 if (VBPtrOffset) {
2961 OriginalBB = Builder.GetInsertBlock();
2962 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2963 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2964 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002965 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002966 "memptr.is_vbase");
2967 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2968 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002969 }
2970
Reid Kleckner2341ae32013-04-11 18:13:19 +00002971 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
2972 // know the vbptr offset.
2973 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002974 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00002975 if (!RD->hasDefinition()) {
2976 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
2977 unsigned DiagID = Diags.getCustomDiagID(
2978 DiagnosticsEngine::Error,
2979 "member pointer representation requires a "
2980 "complete class type for %0 to perform this expression");
2981 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
2982 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002983 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002984 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
2985 }
Craig Topper8a13c412014-05-21 05:09:00 +00002986 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002987 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002988 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002989 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
2990
2991 // Merge control flow with the case where we didn't have to adjust.
2992 if (VBaseAdjustBB) {
2993 Builder.CreateBr(SkipAdjustBB);
2994 CGF.EmitBlock(SkipAdjustBB);
2995 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
John McCall7f416cc2015-09-08 08:05:57 +00002996 Phi->addIncoming(Base.getPointer(), OriginalBB);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002997 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
2998 return Phi;
2999 }
3000 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00003001}
3002
David Majnemer2b0d66d2014-02-20 23:22:07 +00003003llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
John McCall7f416cc2015-09-08 08:05:57 +00003004 CodeGenFunction &CGF, const Expr *E, Address Base, llvm::Value *MemPtr,
David Majnemer2b0d66d2014-02-20 23:22:07 +00003005 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003006 assert(MPT->isMemberDataPointer());
John McCall7f416cc2015-09-08 08:05:57 +00003007 unsigned AS = Base.getAddressSpace();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003008 llvm::Type *PType =
3009 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
3010 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003011 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
3012 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003013
Reid Kleckner2341ae32013-04-11 18:13:19 +00003014 // Extract the fields we need, regardless of model. We'll apply them if we
3015 // have them.
3016 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003017 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3018 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003019 if (MemPtr->getType()->isStructTy()) {
3020 // We need to extract values.
3021 unsigned I = 0;
3022 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003023 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003024 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003025 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003026 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00003027 }
3028
John McCall7f416cc2015-09-08 08:05:57 +00003029 llvm::Value *Addr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003030 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003031 Addr = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00003032 VBPtrOffset);
John McCall7f416cc2015-09-08 08:05:57 +00003033 } else {
3034 Addr = Base.getPointer();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003035 }
Reid Klecknerae945122013-12-05 22:44:07 +00003036
3037 // Cast to char*.
John McCall7f416cc2015-09-08 08:05:57 +00003038 Addr = Builder.CreateBitCast(Addr, CGF.Int8Ty->getPointerTo(AS));
Reid Klecknerae945122013-12-05 22:44:07 +00003039
3040 // Apply the offset, which we assume is non-null.
John McCall7f416cc2015-09-08 08:05:57 +00003041 Addr = Builder.CreateInBoundsGEP(Addr, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00003042
3043 // Cast the address to the appropriate pointer type, adopting the address
3044 // space of the base pointer.
3045 return Builder.CreateBitCast(Addr, PType);
3046}
3047
Reid Kleckner452abac2013-05-09 21:01:17 +00003048llvm::Value *
3049MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
3050 const CastExpr *E,
3051 llvm::Value *Src) {
3052 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
3053 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
3054 E->getCastKind() == CK_ReinterpretMemberPointer);
3055
3056 // Use constant emission if we can.
3057 if (isa<llvm::Constant>(Src))
3058 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
3059
3060 // We may be adding or dropping fields from the member pointer, so we need
3061 // both types and the inheritance models of both records.
3062 const MemberPointerType *SrcTy =
3063 E->getSubExpr()->getType()->castAs<MemberPointerType>();
3064 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003065 bool IsFunc = SrcTy->isMemberFunctionPointer();
3066
3067 // If the classes use the same null representation, reinterpret_cast is a nop.
3068 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003069 if (IsReinterpret && IsFunc)
3070 return Src;
3071
3072 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3073 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3074 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00003075 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00003076 return Src;
3077
3078 CGBuilderTy &Builder = CGF.Builder;
3079
3080 // Branch past the conversion if Src is null.
3081 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
3082 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
3083
3084 // C++ 5.2.10p9: The null member pointer value is converted to the null member
3085 // pointer value of the destination type.
3086 if (IsReinterpret) {
3087 // For reinterpret casts, sema ensures that src and dst are both functions
3088 // or data and have the same size, which means the LLVM types should match.
3089 assert(Src->getType() == DstNull->getType());
3090 return Builder.CreateSelect(IsNotNull, Src, DstNull);
3091 }
3092
3093 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
3094 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
3095 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
3096 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
3097 CGF.EmitBlock(ConvertBB);
3098
David Majnemer0d9ad682015-06-29 00:06:50 +00003099 llvm::Value *Dst = EmitNonNullMemberPointerConversion(
3100 SrcTy, DstTy, E->getCastKind(), E->path_begin(), E->path_end(), Src,
3101 Builder);
3102
3103 Builder.CreateBr(ContinueBB);
3104
3105 // In the continuation, choose between DstNull and Dst.
3106 CGF.EmitBlock(ContinueBB);
3107 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
3108 Phi->addIncoming(DstNull, OriginalBB);
3109 Phi->addIncoming(Dst, ConvertBB);
3110 return Phi;
3111}
3112
3113llvm::Value *MicrosoftCXXABI::EmitNonNullMemberPointerConversion(
3114 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3115 CastExpr::path_const_iterator PathBegin,
3116 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
3117 CGBuilderTy &Builder) {
3118 const CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3119 const CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3120 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
3121 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
3122 bool IsFunc = SrcTy->isMemberFunctionPointer();
3123 bool IsConstant = isa<llvm::Constant>(Src);
3124
Reid Kleckner452abac2013-05-09 21:01:17 +00003125 // Decompose src.
3126 llvm::Value *FirstField = Src;
David Majnemerc1709d32015-06-23 07:31:11 +00003127 llvm::Value *NonVirtualBaseAdjustment = getZeroInt();
3128 llvm::Value *VirtualBaseAdjustmentOffset = getZeroInt();
3129 llvm::Value *VBPtrOffset = getZeroInt();
Reid Kleckner96f8f932014-02-05 17:27:08 +00003130 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003131 // We need to extract values.
3132 unsigned I = 0;
3133 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003134 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003135 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003136 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003137 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003138 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003139 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
3140 }
3141
David Majnemer0d9ad682015-06-29 00:06:50 +00003142 bool IsDerivedToBase = (CK == CK_DerivedToBaseMemberPointer);
David Majnemerc1709d32015-06-23 07:31:11 +00003143 const MemberPointerType *DerivedTy = IsDerivedToBase ? SrcTy : DstTy;
3144 const CXXRecordDecl *DerivedClass = DerivedTy->getMostRecentCXXRecordDecl();
3145
Reid Kleckner452abac2013-05-09 21:01:17 +00003146 // For data pointers, we adjust the field offset directly. For functions, we
3147 // have a separate field.
David Majnemerc1709d32015-06-23 07:31:11 +00003148 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
3149
3150 // The virtual inheritance model has a quirk: the virtual base table is always
3151 // referenced when dereferencing a member pointer even if the member pointer
3152 // is non-virtual. This is accounted for by adjusting the non-virtual offset
3153 // to point backwards to the top of the MDC from the first VBase. Undo this
3154 // adjustment to normalize the member pointer.
3155 llvm::Value *SrcVBIndexEqZero =
3156 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3157 if (SrcInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3158 if (int64_t SrcOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003159 getContext().getOffsetOfBaseWithVBPtr(SrcRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003160 llvm::Value *UndoSrcAdjustment = Builder.CreateSelect(
3161 SrcVBIndexEqZero,
3162 llvm::ConstantInt::get(CGM.IntTy, SrcOffsetToFirstVBase),
3163 getZeroInt());
3164 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, UndoSrcAdjustment);
3165 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003166 }
3167
David Majnemerc1709d32015-06-23 07:31:11 +00003168 // A non-zero vbindex implies that we are dealing with a source member in a
3169 // floating virtual base in addition to some non-virtual offset. If the
3170 // vbindex is zero, we are dealing with a source that exists in a non-virtual,
3171 // fixed, base. The difference between these two cases is that the vbindex +
3172 // nvoffset *always* point to the member regardless of what context they are
3173 // evaluated in so long as the vbindex is adjusted. A member inside a fixed
3174 // base requires explicit nv adjustment.
3175 llvm::Constant *BaseClassOffset = llvm::ConstantInt::get(
David Majnemer0d9ad682015-06-29 00:06:50 +00003176 CGM.IntTy,
3177 CGM.computeNonVirtualBaseClassOffset(DerivedClass, PathBegin, PathEnd)
3178 .getQuantity());
David Majnemerc1709d32015-06-23 07:31:11 +00003179
3180 llvm::Value *NVDisp;
3181 if (IsDerivedToBase)
3182 NVDisp = Builder.CreateNSWSub(NVAdjustField, BaseClassOffset, "adj");
3183 else
3184 NVDisp = Builder.CreateNSWAdd(NVAdjustField, BaseClassOffset, "adj");
3185
3186 NVAdjustField = Builder.CreateSelect(SrcVBIndexEqZero, NVDisp, getZeroInt());
3187
3188 // Update the vbindex to an appropriate value in the destination because
3189 // SrcRD's vbtable might not be a strict prefix of the one in DstRD.
3190 llvm::Value *DstVBIndexEqZero = SrcVBIndexEqZero;
3191 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance) &&
3192 MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance)) {
3193 if (llvm::GlobalVariable *VDispMap =
3194 getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) {
3195 llvm::Value *VBIndex = Builder.CreateExactUDiv(
3196 VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003197 if (IsConstant) {
3198 llvm::Constant *Mapping = VDispMap->getInitializer();
3199 VirtualBaseAdjustmentOffset =
3200 Mapping->getAggregateElement(cast<llvm::Constant>(VBIndex));
3201 } else {
3202 llvm::Value *Idxs[] = {getZeroInt(), VBIndex};
3203 VirtualBaseAdjustmentOffset =
John McCall7f416cc2015-09-08 08:05:57 +00003204 Builder.CreateAlignedLoad(Builder.CreateInBoundsGEP(VDispMap, Idxs),
3205 CharUnits::fromQuantity(4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003206 }
David Majnemerc1709d32015-06-23 07:31:11 +00003207
3208 DstVBIndexEqZero =
3209 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3210 }
3211 }
3212
3213 // Set the VBPtrOffset to zero if the vbindex is zero. Otherwise, initialize
3214 // it to the offset of the vbptr.
3215 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance)) {
3216 llvm::Value *DstVBPtrOffset = llvm::ConstantInt::get(
3217 CGM.IntTy,
3218 getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity());
3219 VBPtrOffset =
3220 Builder.CreateSelect(DstVBIndexEqZero, getZeroInt(), DstVBPtrOffset);
3221 }
3222
3223 // Likewise, apply a similar adjustment so that dereferencing the member
3224 // pointer correctly accounts for the distance between the start of the first
3225 // virtual base and the top of the MDC.
3226 if (DstInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3227 if (int64_t DstOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003228 getContext().getOffsetOfBaseWithVBPtr(DstRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003229 llvm::Value *DoDstAdjustment = Builder.CreateSelect(
3230 DstVBIndexEqZero,
3231 llvm::ConstantInt::get(CGM.IntTy, DstOffsetToFirstVBase),
3232 getZeroInt());
3233 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, DoDstAdjustment);
3234 }
3235 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003236
3237 // Recompose dst from the null struct and the adjusted fields from src.
3238 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00003239 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003240 Dst = FirstField;
3241 } else {
David Majnemer0d9ad682015-06-29 00:06:50 +00003242 Dst = llvm::UndefValue::get(ConvertMemberPointerType(DstTy));
Reid Kleckner452abac2013-05-09 21:01:17 +00003243 unsigned Idx = 0;
3244 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003245 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003246 Dst = Builder.CreateInsertValue(Dst, NonVirtualBaseAdjustment, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003247 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003248 Dst = Builder.CreateInsertValue(Dst, VBPtrOffset, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003249 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003250 Dst = Builder.CreateInsertValue(Dst, VirtualBaseAdjustmentOffset, Idx++);
Reid Kleckner452abac2013-05-09 21:01:17 +00003251 }
David Majnemer0d9ad682015-06-29 00:06:50 +00003252 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003253}
3254
3255llvm::Constant *
3256MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
3257 llvm::Constant *Src) {
3258 const MemberPointerType *SrcTy =
David Majnemer5ca193c2015-06-23 07:31:07 +00003259 E->getSubExpr()->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003260 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3261
David Majnemer5ca193c2015-06-23 07:31:07 +00003262 CastKind CK = E->getCastKind();
3263
3264 return EmitMemberPointerConversion(SrcTy, DstTy, CK, E->path_begin(),
3265 E->path_end(), Src);
3266}
3267
3268llvm::Constant *MicrosoftCXXABI::EmitMemberPointerConversion(
3269 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3270 CastExpr::path_const_iterator PathBegin,
3271 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src) {
3272 assert(CK == CK_DerivedToBaseMemberPointer ||
3273 CK == CK_BaseToDerivedMemberPointer ||
3274 CK == CK_ReinterpretMemberPointer);
Reid Kleckner452abac2013-05-09 21:01:17 +00003275 // If src is null, emit a new null for dst. We can't return src because dst
3276 // might have a new representation.
3277 if (MemberPointerConstantIsNull(SrcTy, Src))
3278 return EmitNullMemberPointer(DstTy);
3279
3280 // We don't need to do anything for reinterpret_casts of non-null member
3281 // pointers. We should only get here when the two type representations have
3282 // the same size.
David Majnemer5ca193c2015-06-23 07:31:07 +00003283 if (CK == CK_ReinterpretMemberPointer)
Reid Kleckner452abac2013-05-09 21:01:17 +00003284 return Src;
3285
John McCall7f416cc2015-09-08 08:05:57 +00003286 CGBuilderTy Builder(CGM, CGM.getLLVMContext());
David Majnemer0d9ad682015-06-29 00:06:50 +00003287 auto *Dst = cast<llvm::Constant>(EmitNonNullMemberPointerConversion(
3288 SrcTy, DstTy, CK, PathBegin, PathEnd, Src, Builder));
Reid Kleckner452abac2013-05-09 21:01:17 +00003289
David Majnemer0d9ad682015-06-29 00:06:50 +00003290 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003291}
3292
John McCallb92ab1a2016-10-26 23:46:34 +00003293CGCallee MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
John McCall7f416cc2015-09-08 08:05:57 +00003294 CodeGenFunction &CGF, const Expr *E, Address This,
3295 llvm::Value *&ThisPtrForCall, llvm::Value *MemPtr,
3296 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003297 assert(MPT->isMemberFunctionPointer());
3298 const FunctionProtoType *FPT =
3299 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00003300 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003301 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(
3302 CGM.getTypes().arrangeCXXMethodType(RD, FPT, /*FD=*/nullptr));
Reid Kleckner2341ae32013-04-11 18:13:19 +00003303 CGBuilderTy &Builder = CGF.Builder;
3304
David Majnemer1cdd96d2014-01-17 09:01:00 +00003305 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003306
3307 // Extract the fields we need, regardless of model. We'll apply them if we
3308 // have them.
3309 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003310 llvm::Value *NonVirtualBaseAdjustment = nullptr;
3311 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3312 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003313 if (MemPtr->getType()->isStructTy()) {
3314 // We need to extract values.
3315 unsigned I = 0;
3316 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003317 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003318 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003319 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00003320 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003321 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003322 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3323 }
3324
3325 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003326 ThisPtrForCall = AdjustVirtualBase(CGF, E, RD, This,
3327 VirtualBaseAdjustmentOffset, VBPtrOffset);
3328 } else {
3329 ThisPtrForCall = This.getPointer();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003330 }
3331
3332 if (NonVirtualBaseAdjustment) {
3333 // Apply the adjustment and cast back to the original struct type.
John McCall7f416cc2015-09-08 08:05:57 +00003334 llvm::Value *Ptr = Builder.CreateBitCast(ThisPtrForCall, CGF.Int8PtrTy);
Reid Kleckner2341ae32013-04-11 18:13:19 +00003335 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
John McCall7f416cc2015-09-08 08:05:57 +00003336 ThisPtrForCall = Builder.CreateBitCast(Ptr, ThisPtrForCall->getType(),
3337 "this.adjusted");
Reid Kleckner2341ae32013-04-11 18:13:19 +00003338 }
3339
John McCallb92ab1a2016-10-26 23:46:34 +00003340 FunctionPointer =
3341 Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
3342 CGCallee Callee(FPT, FunctionPointer);
3343 return Callee;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003344}
3345
Charles Davis53c59df2010-08-16 03:33:14 +00003346CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00003347 return new MicrosoftCXXABI(CGM);
3348}
David Majnemere2cb8d12014-07-07 06:20:47 +00003349
3350// MS RTTI Overview:
3351// The run time type information emitted by cl.exe contains 5 distinct types of
3352// structures. Many of them reference each other.
3353//
3354// TypeInfo: Static classes that are returned by typeid.
3355//
3356// CompleteObjectLocator: Referenced by vftables. They contain information
3357// required for dynamic casting, including OffsetFromTop. They also contain
3358// a reference to the TypeInfo for the type and a reference to the
3359// CompleteHierarchyDescriptor for the type.
3360//
3361// ClassHieararchyDescriptor: Contains information about a class hierarchy.
3362// Used during dynamic_cast to walk a class hierarchy. References a base
3363// class array and the size of said array.
3364//
3365// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
3366// somewhat of a misnomer because the most derived class is also in the list
3367// as well as multiple copies of virtual bases (if they occur multiple times
3368// in the hiearchy.) The BaseClassArray contains one BaseClassDescriptor for
3369// every path in the hierarchy, in pre-order depth first order. Note, we do
3370// not declare a specific llvm type for BaseClassArray, it's merely an array
3371// of BaseClassDescriptor pointers.
3372//
3373// BaseClassDescriptor: Contains information about a class in a class hierarchy.
3374// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
3375// BaseClassArray is. It contains information about a class within a
3376// hierarchy such as: is this base is ambiguous and what is its offset in the
3377// vbtable. The names of the BaseClassDescriptors have all of their fields
3378// mangled into them so they can be aggressively deduplicated by the linker.
3379
David Majnemere2cb8d12014-07-07 06:20:47 +00003380static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
Reid Klecknerfb931542018-03-16 20:36:49 +00003381 StringRef MangledName("??_7type_info@@6B@");
David Majnemere2cb8d12014-07-07 06:20:47 +00003382 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
3383 return VTable;
3384 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
3385 /*Constant=*/true,
3386 llvm::GlobalVariable::ExternalLinkage,
3387 /*Initializer=*/nullptr, MangledName);
3388}
3389
3390namespace {
3391
3392/// \brief A Helper struct that stores information about a class in a class
3393/// hierarchy. The information stored in these structs struct is used during
3394/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
3395// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
3396// implicit depth first pre-order tree connectivity. getFirstChild and
3397// getNextSibling allow us to walk the tree efficiently.
3398struct MSRTTIClass {
3399 enum {
3400 IsPrivateOnPath = 1 | 8,
3401 IsAmbiguous = 2,
3402 IsPrivate = 4,
3403 IsVirtual = 16,
3404 HasHierarchyDescriptor = 64
3405 };
3406 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
3407 uint32_t initialize(const MSRTTIClass *Parent,
3408 const CXXBaseSpecifier *Specifier);
3409
3410 MSRTTIClass *getFirstChild() { return this + 1; }
3411 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
3412 return Child + 1 + Child->NumBases;
3413 }
3414
3415 const CXXRecordDecl *RD, *VirtualRoot;
3416 uint32_t Flags, NumBases, OffsetInVBase;
3417};
3418
3419/// \brief Recursively initialize the base class array.
3420uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
3421 const CXXBaseSpecifier *Specifier) {
3422 Flags = HasHierarchyDescriptor;
3423 if (!Parent) {
3424 VirtualRoot = nullptr;
3425 OffsetInVBase = 0;
3426 } else {
3427 if (Specifier->getAccessSpecifier() != AS_public)
3428 Flags |= IsPrivate | IsPrivateOnPath;
3429 if (Specifier->isVirtual()) {
3430 Flags |= IsVirtual;
3431 VirtualRoot = RD;
3432 OffsetInVBase = 0;
3433 } else {
3434 if (Parent->Flags & IsPrivateOnPath)
3435 Flags |= IsPrivateOnPath;
3436 VirtualRoot = Parent->VirtualRoot;
3437 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
3438 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
3439 }
3440 }
3441 NumBases = 0;
3442 MSRTTIClass *Child = getFirstChild();
3443 for (const CXXBaseSpecifier &Base : RD->bases()) {
3444 NumBases += Child->initialize(this, &Base) + 1;
3445 Child = getNextChild(Child);
3446 }
3447 return NumBases;
3448}
3449
3450static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
3451 switch (Ty->getLinkage()) {
3452 case NoLinkage:
3453 case InternalLinkage:
3454 case UniqueExternalLinkage:
3455 return llvm::GlobalValue::InternalLinkage;
3456
3457 case VisibleNoLinkage:
Richard Smith1283e982017-07-07 20:04:28 +00003458 case ModuleInternalLinkage:
3459 case ModuleLinkage:
David Majnemere2cb8d12014-07-07 06:20:47 +00003460 case ExternalLinkage:
3461 return llvm::GlobalValue::LinkOnceODRLinkage;
3462 }
3463 llvm_unreachable("Invalid linkage!");
3464}
3465
3466/// \brief An ephemeral helper class for building MS RTTI types. It caches some
3467/// calls to the module and information about the most derived class in a
3468/// hierarchy.
3469struct MSRTTIBuilder {
3470 enum {
3471 HasBranchingHierarchy = 1,
3472 HasVirtualBranchingHierarchy = 2,
3473 HasAmbiguousBases = 4
3474 };
3475
David Majnemer611cdb92014-07-07 08:09:15 +00003476 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
3477 : CGM(ABI.CGM), Context(CGM.getContext()),
3478 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00003479 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003480 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00003481
3482 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
3483 llvm::GlobalVariable *
3484 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
3485 llvm::GlobalVariable *getClassHierarchyDescriptor();
Justin Lebar562914e2016-10-10 16:26:29 +00003486 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo &Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003487
3488 CodeGenModule &CGM;
3489 ASTContext &Context;
3490 llvm::LLVMContext &VMContext;
3491 llvm::Module &Module;
3492 const CXXRecordDecl *RD;
3493 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00003494 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00003495};
3496
3497} // namespace
3498
3499/// \brief Recursively serializes a class hierarchy in pre-order depth first
3500/// order.
3501static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
3502 const CXXRecordDecl *RD) {
3503 Classes.push_back(MSRTTIClass(RD));
3504 for (const CXXBaseSpecifier &Base : RD->bases())
3505 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
3506}
3507
3508/// \brief Find ambiguity among base classes.
3509static void
3510detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
3511 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
3512 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
3513 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
3514 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
3515 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
David Blaikie82e95a32014-11-19 07:49:47 +00003516 !VirtualBases.insert(Class->RD).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003517 Class = MSRTTIClass::getNextChild(Class);
3518 continue;
3519 }
David Blaikie82e95a32014-11-19 07:49:47 +00003520 if (!UniqueBases.insert(Class->RD).second)
David Majnemere2cb8d12014-07-07 06:20:47 +00003521 AmbiguousBases.insert(Class->RD);
3522 Class++;
3523 }
3524 if (AmbiguousBases.empty())
3525 return;
3526 for (MSRTTIClass &Class : Classes)
3527 if (AmbiguousBases.count(Class.RD))
3528 Class.Flags |= MSRTTIClass::IsAmbiguous;
3529}
3530
3531llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
3532 SmallString<256> MangledName;
3533 {
3534 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003535 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003536 }
3537
3538 // Check to see if we've already declared this ClassHierarchyDescriptor.
3539 if (auto CHD = Module.getNamedGlobal(MangledName))
3540 return CHD;
3541
3542 // Serialize the class hierarchy and initialize the CHD Fields.
3543 SmallVector<MSRTTIClass, 8> Classes;
3544 serializeClassHierarchy(Classes, RD);
3545 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3546 detectAmbiguousBases(Classes);
3547 int Flags = 0;
3548 for (auto Class : Classes) {
3549 if (Class.RD->getNumBases() > 1)
3550 Flags |= HasBranchingHierarchy;
3551 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
3552 // believe the field isn't actually used.
3553 if (Class.Flags & MSRTTIClass::IsAmbiguous)
3554 Flags |= HasAmbiguousBases;
3555 }
3556 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
3557 Flags |= HasVirtualBranchingHierarchy;
3558 // These gep indices are used to get the address of the first element of the
3559 // base class array.
3560 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
3561 llvm::ConstantInt::get(CGM.IntTy, 0)};
3562
3563 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00003564 auto Type = ABI.getClassHierarchyDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003565 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3566 /*Initializer=*/nullptr,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003567 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003568 if (CHD->isWeakForLinker())
3569 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003570
David Blaikiee3b172a2015-04-02 18:55:21 +00003571 auto *Bases = getBaseClassArray(Classes);
3572
David Majnemere2cb8d12014-07-07 06:20:47 +00003573 // Initialize the base class ClassHierarchyDescriptor.
3574 llvm::Constant *Fields[] = {
Saleem Abdulrasoola9e14502017-01-01 19:16:02 +00003575 llvm::ConstantInt::get(CGM.IntTy, 0), // reserved by the runtime
David Majnemer611cdb92014-07-07 08:09:15 +00003576 llvm::ConstantInt::get(CGM.IntTy, Flags),
3577 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
3578 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00003579 Bases->getValueType(), Bases,
David Majnemer611cdb92014-07-07 08:09:15 +00003580 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00003581 };
3582 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3583 return CHD;
3584}
3585
3586llvm::GlobalVariable *
3587MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3588 SmallString<256> MangledName;
3589 {
3590 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003591 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003592 }
3593
3594 // Forward-declare the base class array.
3595 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3596 // mode) bytes of padding. We provide a pointer sized amount of padding by
3597 // adding +1 to Classes.size(). The sections have pointer alignment and are
3598 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00003599 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00003600 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00003601 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
David Majnemer7c237072015-03-05 00:46:22 +00003602 auto *BCA =
3603 new llvm::GlobalVariable(Module, ArrType,
3604 /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003605 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003606 if (BCA->isWeakForLinker())
3607 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003608
3609 // Initialize the BaseClassArray.
3610 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3611 for (MSRTTIClass &Class : Classes)
3612 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00003613 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00003614 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00003615 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00003616 return BCA;
3617}
3618
3619llvm::GlobalVariable *
3620MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3621 // Compute the fields for the BaseClassDescriptor. They are computed up front
3622 // because they are mangled into the name of the object.
3623 uint32_t OffsetInVBTable = 0;
3624 int32_t VBPtrOffset = -1;
3625 if (Class.VirtualRoot) {
3626 auto &VTableContext = CGM.getMicrosoftVTableContext();
3627 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3628 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3629 }
3630
3631 SmallString<256> MangledName;
3632 {
3633 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003634 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3635 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3636 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003637 }
3638
David Majnemer26a90f82014-07-07 15:29:10 +00003639 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00003640 if (auto BCD = Module.getNamedGlobal(MangledName))
3641 return BCD;
3642
3643 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00003644 auto Type = ABI.getBaseClassDescriptorType();
David Majnemer7c237072015-03-05 00:46:22 +00003645 auto BCD =
3646 new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003647 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003648 if (BCD->isWeakForLinker())
3649 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003650
3651 // Initialize the BaseClassDescriptor.
3652 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003653 ABI.getImageRelativeConstant(
David Majnemer443250f2015-03-17 20:35:00 +00003654 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003655 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3656 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3657 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3658 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3659 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3660 ABI.getImageRelativeConstant(
3661 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00003662 };
3663 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3664 return BCD;
3665}
3666
3667llvm::GlobalVariable *
Justin Lebar562914e2016-10-10 16:26:29 +00003668MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo &Info) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003669 SmallString<256> MangledName;
3670 {
3671 llvm::raw_svector_ostream Out(MangledName);
Justin Lebar562914e2016-10-10 16:26:29 +00003672 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info.MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003673 }
3674
3675 // Check to see if we've already computed this complete object locator.
3676 if (auto COL = Module.getNamedGlobal(MangledName))
3677 return COL;
3678
3679 // Compute the fields of the complete object locator.
Justin Lebar562914e2016-10-10 16:26:29 +00003680 int OffsetToTop = Info.FullOffsetInMDC.getQuantity();
David Majnemere2cb8d12014-07-07 06:20:47 +00003681 int VFPtrOffset = 0;
3682 // The offset includes the vtordisp if one exists.
Justin Lebar562914e2016-10-10 16:26:29 +00003683 if (const CXXRecordDecl *VBase = Info.getVBaseWithVPtr())
David Majnemere2cb8d12014-07-07 06:20:47 +00003684 if (Context.getASTRecordLayout(RD)
3685 .getVBaseOffsetsMap()
3686 .find(VBase)
3687 ->second.hasVtorDisp())
Justin Lebar562914e2016-10-10 16:26:29 +00003688 VFPtrOffset = Info.NonVirtualOffset.getQuantity() + 4;
David Majnemere2cb8d12014-07-07 06:20:47 +00003689
3690 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00003691 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003692 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003693 /*Initializer=*/nullptr, MangledName);
David Majnemere2cb8d12014-07-07 06:20:47 +00003694
3695 // Initialize the CompleteObjectLocator.
3696 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003697 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3698 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3699 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3700 ABI.getImageRelativeConstant(
3701 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3702 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3703 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00003704 };
3705 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00003706 if (!ABI.isImageRelative())
3707 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00003708 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
Rafael Espindola654542a2015-01-16 19:23:42 +00003709 if (COL->isWeakForLinker())
3710 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003711 return COL;
3712}
3713
David Majnemerad803d42015-03-15 07:10:01 +00003714static QualType decomposeTypeForEH(ASTContext &Context, QualType T,
David Majnemer526793d2016-07-12 04:42:50 +00003715 bool &IsConst, bool &IsVolatile,
3716 bool &IsUnaligned) {
David Majnemerad803d42015-03-15 07:10:01 +00003717 T = Context.getExceptionObjectType(T);
3718
3719 // C++14 [except.handle]p3:
3720 // A handler is a match for an exception object of type E if [...]
3721 // - the handler is of type cv T or const T& where T is a pointer type and
3722 // E is a pointer type that can be converted to T by [...]
3723 // - a qualification conversion
3724 IsConst = false;
3725 IsVolatile = false;
David Majnemer526793d2016-07-12 04:42:50 +00003726 IsUnaligned = false;
David Majnemerad803d42015-03-15 07:10:01 +00003727 QualType PointeeType = T->getPointeeType();
3728 if (!PointeeType.isNull()) {
3729 IsConst = PointeeType.isConstQualified();
3730 IsVolatile = PointeeType.isVolatileQualified();
David Majnemer526793d2016-07-12 04:42:50 +00003731 IsUnaligned = PointeeType.getQualifiers().hasUnaligned();
David Majnemerad803d42015-03-15 07:10:01 +00003732 }
3733
3734 // Member pointer types like "const int A::*" are represented by having RTTI
3735 // for "int A::*" and separately storing the const qualifier.
3736 if (const auto *MPTy = T->getAs<MemberPointerType>())
3737 T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(),
3738 MPTy->getClass());
3739
3740 // Pointer types like "const int * const *" are represented by having RTTI
3741 // for "const int **" and separately storing the const qualifier.
3742 if (T->isPointerType())
3743 T = Context.getPointerType(PointeeType.getUnqualifiedType());
3744
3745 return T;
3746}
3747
Reid Kleckner10aa7702015-09-16 20:15:55 +00003748CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +00003749MicrosoftCXXABI::getAddrOfCXXCatchHandlerType(QualType Type,
3750 QualType CatchHandlerType) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003751 // TypeDescriptors for exceptions never have qualified pointer types,
Simon Pilgrim2c518802017-03-30 14:13:19 +00003752 // qualifiers are stored separately in order to support qualification
David Majnemer443250f2015-03-17 20:35:00 +00003753 // conversions.
David Majnemer526793d2016-07-12 04:42:50 +00003754 bool IsConst, IsVolatile, IsUnaligned;
3755 Type =
3756 decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile, IsUnaligned);
David Majnemer443250f2015-03-17 20:35:00 +00003757
David Majnemer5f0dd612015-03-17 20:35:05 +00003758 bool IsReference = CatchHandlerType->isReferenceType();
3759
David Majnemer5f0dd612015-03-17 20:35:05 +00003760 uint32_t Flags = 0;
3761 if (IsConst)
3762 Flags |= 1;
3763 if (IsVolatile)
3764 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00003765 if (IsUnaligned)
3766 Flags |= 4;
David Majnemer5f0dd612015-03-17 20:35:05 +00003767 if (IsReference)
3768 Flags |= 8;
3769
Reid Kleckner10aa7702015-09-16 20:15:55 +00003770 return CatchTypeInfo{getAddrOfRTTIDescriptor(Type)->stripPointerCasts(),
3771 Flags};
David Majnemer443250f2015-03-17 20:35:00 +00003772}
3773
David Majnemere2cb8d12014-07-07 06:20:47 +00003774/// \brief Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
3775/// llvm::GlobalVariable * because different type descriptors have different
3776/// types, and need to be abstracted. They are abstracting by casting the
3777/// address to an Int8PtrTy.
David Majnemer443250f2015-03-17 20:35:00 +00003778llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003779 SmallString<256> MangledName;
David Majnemere2cb8d12014-07-07 06:20:47 +00003780 {
3781 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003782 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003783 }
3784
3785 // Check to see if we've already declared this TypeDescriptor.
3786 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3787 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3788
Piotr Padlewskid3b1cbd2017-06-01 08:04:05 +00003789 // Note for the future: If we would ever like to do deferred emission of
3790 // RTTI, check if emitting vtables opportunistically need any adjustment.
3791
David Majnemere2cb8d12014-07-07 06:20:47 +00003792 // Compute the fields for the TypeDescriptor.
David Majnemer5f0dd612015-03-17 20:35:05 +00003793 SmallString<256> TypeInfoString;
David Majnemere2cb8d12014-07-07 06:20:47 +00003794 {
3795 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00003796 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003797 }
3798
3799 // Declare and initialize the TypeDescriptor.
3800 llvm::Constant *Fields[] = {
3801 getTypeInfoVTable(CGM), // VFPtr
3802 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3803 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3804 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00003805 getTypeDescriptorType(TypeInfoString);
Rafael Espindola654542a2015-01-16 19:23:42 +00003806 auto *Var = new llvm::GlobalVariable(
3807 CGM.getModule(), TypeDescriptorType, /*Constant=*/false,
3808 getLinkageForRTTI(Type),
3809 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
Yaron Keren2c07cc72015-12-01 08:14:39 +00003810 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003811 if (Var->isWeakForLinker())
3812 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3813 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003814}
3815
3816/// \brief Gets or a creates a Microsoft CompleteObjectLocator.
3817llvm::GlobalVariable *
3818MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
Justin Lebar562914e2016-10-10 16:26:29 +00003819 const VPtrInfo &Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00003820 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003821}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003822
3823static void emitCXXConstructor(CodeGenModule &CGM,
3824 const CXXConstructorDecl *ctor,
3825 StructorType ctorType) {
Rafael Espindolad48b51b2014-09-15 19:24:44 +00003826 // There are no constructor variants, always emit the complete destructor.
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003827 llvm::Function *Fn = CGM.codegenCXXStructor(ctor, StructorType::Complete);
3828 CGM.maybeSetTrivialComdat(*ctor, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003829}
3830
3831static void emitCXXDestructor(CodeGenModule &CGM, const CXXDestructorDecl *dtor,
3832 StructorType dtorType) {
Reid Klecknerae9b0702018-03-16 19:40:50 +00003833 // Emit the base destructor if the base and complete (vbase) destructors are
3834 // equivalent. This effectively implements -mconstructor-aliases as part of
3835 // the ABI.
3836 if (dtorType == StructorType::Complete &&
3837 dtor->getParent()->getNumVBases() == 0)
3838 dtorType = StructorType::Base;
Rafael Espindola91f68b42014-09-15 19:20:10 +00003839
3840 // The base destructor is equivalent to the base destructor of its
3841 // base class if there is exactly one non-virtual base class with a
3842 // non-trivial destructor, there are no fields with a non-trivial
3843 // destructor, and the body of the destructor is trivial.
3844 if (dtorType == StructorType::Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
3845 return;
3846
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003847 llvm::Function *Fn = CGM.codegenCXXStructor(dtor, dtorType);
Rafael Espindolad3e04692015-01-17 01:47:39 +00003848 if (Fn->isWeakForLinker())
3849 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003850}
3851
3852void MicrosoftCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3853 StructorType Type) {
3854 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
3855 emitCXXConstructor(CGM, CD, Type);
3856 return;
3857 }
3858 emitCXXDestructor(CGM, cast<CXXDestructorDecl>(MD), Type);
3859}
David Majnemer7c237072015-03-05 00:46:22 +00003860
David Majnemerdfa6d202015-03-11 18:36:39 +00003861llvm::Function *
David Majnemer37fd66e2015-03-13 22:36:55 +00003862MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
3863 CXXCtorType CT) {
3864 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
3865
David Majnemerdfa6d202015-03-11 18:36:39 +00003866 // Calculate the mangled name.
3867 SmallString<256> ThunkName;
3868 llvm::raw_svector_ostream Out(ThunkName);
David Majnemer37fd66e2015-03-13 22:36:55 +00003869 getMangleContext().mangleCXXCtor(CD, CT, Out);
David Majnemerdfa6d202015-03-11 18:36:39 +00003870
3871 // If the thunk has been generated previously, just return it.
3872 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
3873 return cast<llvm::Function>(GV);
3874
3875 // Create the llvm::Function.
David Majnemer37fd66e2015-03-13 22:36:55 +00003876 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT);
David Majnemerdfa6d202015-03-11 18:36:39 +00003877 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
3878 const CXXRecordDecl *RD = CD->getParent();
3879 QualType RecordTy = getContext().getRecordType(RD);
3880 llvm::Function *ThunkFn = llvm::Function::Create(
3881 ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule());
Reid Klecknerbba3cb92015-03-17 19:00:50 +00003882 ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>(
3883 FnInfo.getEffectiveCallingConvention()));
David Majnemer63aa2fb2015-06-30 21:23:51 +00003884 if (ThunkFn->isWeakForLinker())
3885 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
David Majnemer37fd66e2015-03-13 22:36:55 +00003886 bool IsCopy = CT == Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003887
3888 // Start codegen.
3889 CodeGenFunction CGF(CGM);
3890 CGF.CurGD = GlobalDecl(CD, Ctor_Complete);
3891
3892 // Build FunctionArgs.
3893 FunctionArgList FunctionArgs;
3894
David Majnemer37fd66e2015-03-13 22:36:55 +00003895 // A constructor always starts with a 'this' pointer as its first argument.
David Majnemerdfa6d202015-03-11 18:36:39 +00003896 buildThisParam(CGF, FunctionArgs);
3897
3898 // Following the 'this' pointer is a reference to the source object that we
3899 // are copying from.
3900 ImplicitParamDecl SrcParam(
Alexey Bataev56223232017-06-09 13:40:18 +00003901 getContext(), /*DC=*/nullptr, SourceLocation(),
3902 &getContext().Idents.get("src"),
David Majnemerdfa6d202015-03-11 18:36:39 +00003903 getContext().getLValueReferenceType(RecordTy,
Alexey Bataev56223232017-06-09 13:40:18 +00003904 /*SpelledAsLValue=*/true),
3905 ImplicitParamDecl::Other);
David Majnemer37fd66e2015-03-13 22:36:55 +00003906 if (IsCopy)
3907 FunctionArgs.push_back(&SrcParam);
David Majnemerdfa6d202015-03-11 18:36:39 +00003908
David Majnemer37fd66e2015-03-13 22:36:55 +00003909 // Constructors for classes which utilize virtual bases have an additional
3910 // parameter which indicates whether or not it is being delegated to by a more
3911 // derived constructor.
Alexey Bataev56223232017-06-09 13:40:18 +00003912 ImplicitParamDecl IsMostDerived(getContext(), /*DC=*/nullptr,
3913 SourceLocation(),
David Majnemerdfa6d202015-03-11 18:36:39 +00003914 &getContext().Idents.get("is_most_derived"),
Alexey Bataev56223232017-06-09 13:40:18 +00003915 getContext().IntTy, ImplicitParamDecl::Other);
David Majnemerdfa6d202015-03-11 18:36:39 +00003916 // Only add the parameter to the list if thie class has virtual bases.
3917 if (RD->getNumVBases() > 0)
3918 FunctionArgs.push_back(&IsMostDerived);
3919
3920 // Start defining the function.
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003921 auto NL = ApplyDebugLocation::CreateEmpty(CGF);
David Majnemerdfa6d202015-03-11 18:36:39 +00003922 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
3923 FunctionArgs, CD->getLocation(), SourceLocation());
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003924 // Create a scope with an artificial location for the body of this function.
3925 auto AL = ApplyDebugLocation::CreateArtificial(CGF);
Reid Kleckner06239e42017-11-16 19:09:36 +00003926 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
David Majnemerdfa6d202015-03-11 18:36:39 +00003927 llvm::Value *This = getThisValue(CGF);
3928
3929 llvm::Value *SrcVal =
David Majnemer37fd66e2015-03-13 22:36:55 +00003930 IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src")
3931 : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003932
3933 CallArgList Args;
3934
3935 // Push the this ptr.
3936 Args.add(RValue::get(This), CD->getThisType(getContext()));
3937
3938 // Push the src ptr.
David Majnemer37fd66e2015-03-13 22:36:55 +00003939 if (SrcVal)
3940 Args.add(RValue::get(SrcVal), SrcParam.getType());
David Majnemerdfa6d202015-03-11 18:36:39 +00003941
3942 // Add the rest of the default arguments.
Reid Klecknerc01ee752016-11-23 16:51:30 +00003943 SmallVector<const Stmt *, 4> ArgVec;
3944 ArrayRef<ParmVarDecl *> params = CD->parameters().drop_front(IsCopy ? 1 : 0);
3945 for (const ParmVarDecl *PD : params) {
3946 assert(PD->hasDefaultArg() && "ctor closure lacks default args");
3947 ArgVec.push_back(PD->getDefaultArg());
Reid Kleckner93f661a2015-03-17 21:51:43 +00003948 }
David Majnemerdfa6d202015-03-11 18:36:39 +00003949
3950 CodeGenFunction::RunCleanupsScope Cleanups(CGF);
3951
3952 const auto *FPT = CD->getType()->castAs<FunctionProtoType>();
David Blaikief05779e2015-07-21 18:37:18 +00003953 CGF.EmitCallArgs(Args, FPT, llvm::makeArrayRef(ArgVec), CD, IsCopy ? 1 : 0);
David Majnemerdfa6d202015-03-11 18:36:39 +00003954
3955 // Insert any ABI-specific implicit constructor arguments.
George Burgess IVf203dbf2017-02-22 20:28:02 +00003956 AddedStructorArgs ExtraArgs =
3957 addImplicitConstructorArgs(CGF, CD, Ctor_Complete,
3958 /*ForVirtualBase=*/false,
3959 /*Delegating=*/false, Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00003960 // Call the destructor with our arguments.
John McCallb92ab1a2016-10-26 23:46:34 +00003961 llvm::Constant *CalleePtr =
3962 CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3963 CGCallee Callee = CGCallee::forDirect(CalleePtr, CD);
David Majnemerdfa6d202015-03-11 18:36:39 +00003964 const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall(
George Burgess IVd0a9e802017-02-23 22:07:35 +00003965 Args, CD, Ctor_Complete, ExtraArgs.Prefix, ExtraArgs.Suffix);
John McCallb92ab1a2016-10-26 23:46:34 +00003966 CGF.EmitCall(CalleeInfo, Callee, ReturnValueSlot(), Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00003967
3968 Cleanups.ForceCleanup();
3969
3970 // Emit the ret instruction, remove any temporary instructions created for the
3971 // aid of CodeGen.
3972 CGF.FinishFunction(SourceLocation());
3973
3974 return ThunkFn;
3975}
3976
David Majnemer7c237072015-03-05 00:46:22 +00003977llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
3978 uint32_t NVOffset,
3979 int32_t VBPtrOffset,
3980 uint32_t VBIndex) {
3981 assert(!T->isReferenceType());
3982
David Majnemere7a818f2015-03-06 18:53:55 +00003983 CXXRecordDecl *RD = T->getAsCXXRecordDecl();
3984 const CXXConstructorDecl *CD =
3985 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003986 CXXCtorType CT = Ctor_Complete;
David Majnemer37fd66e2015-03-13 22:36:55 +00003987 if (CD)
3988 if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1)
David Majnemerdfa6d202015-03-11 18:36:39 +00003989 CT = Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003990
David Majnemer7c237072015-03-05 00:46:22 +00003991 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
3992 SmallString<256> MangledName;
3993 {
3994 llvm::raw_svector_ostream Out(MangledName);
David Majnemerdfa6d202015-03-11 18:36:39 +00003995 getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +00003996 VBPtrOffset, VBIndex, Out);
David Majnemer7c237072015-03-05 00:46:22 +00003997 }
3998 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3999 return getImageRelativeConstant(GV);
4000
David Majnemerdfa6d202015-03-11 18:36:39 +00004001 // The TypeDescriptor is used by the runtime to determine if a catch handler
David Majnemer7c237072015-03-05 00:46:22 +00004002 // is appropriate for the exception object.
David Majnemer443250f2015-03-17 20:35:00 +00004003 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
David Majnemer7c237072015-03-05 00:46:22 +00004004
4005 // The runtime is responsible for calling the copy constructor if the
4006 // exception is caught by value.
David Majnemerdfa6d202015-03-11 18:36:39 +00004007 llvm::Constant *CopyCtor;
4008 if (CD) {
4009 if (CT == Ctor_CopyingClosure)
David Majnemer37fd66e2015-03-13 22:36:55 +00004010 CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure);
David Majnemerdfa6d202015-03-11 18:36:39 +00004011 else
4012 CopyCtor = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
4013
4014 CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy);
4015 } else {
4016 CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4017 }
David Majnemere7a818f2015-03-06 18:53:55 +00004018 CopyCtor = getImageRelativeConstant(CopyCtor);
David Majnemer7c237072015-03-05 00:46:22 +00004019
David Majnemere7a818f2015-03-06 18:53:55 +00004020 bool IsScalar = !RD;
David Majnemer7c237072015-03-05 00:46:22 +00004021 bool HasVirtualBases = false;
4022 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
David Majnemer7c237072015-03-05 00:46:22 +00004023 QualType PointeeType = T;
4024 if (T->isPointerType())
4025 PointeeType = T->getPointeeType();
4026 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
4027 HasVirtualBases = RD->getNumVBases() > 0;
4028 if (IdentifierInfo *II = RD->getIdentifier())
4029 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
4030 }
4031
4032 // Encode the relevant CatchableType properties into the Flags bitfield.
4033 // FIXME: Figure out how bits 2 or 8 can get set.
4034 uint32_t Flags = 0;
4035 if (IsScalar)
4036 Flags |= 1;
4037 if (HasVirtualBases)
4038 Flags |= 4;
4039 if (IsStdBadAlloc)
4040 Flags |= 16;
4041
4042 llvm::Constant *Fields[] = {
4043 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4044 TD, // TypeDescriptor
4045 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment
4046 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
4047 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex
4048 llvm::ConstantInt::get(CGM.IntTy, Size), // Size
4049 CopyCtor // CopyCtor
4050 };
4051 llvm::StructType *CTType = getCatchableTypeType();
4052 auto *GV = new llvm::GlobalVariable(
4053 CGM.getModule(), CTType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004054 llvm::ConstantStruct::get(CTType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004055 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004056 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004057 if (GV->isWeakForLinker())
4058 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004059 return getImageRelativeConstant(GV);
4060}
4061
4062llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
4063 assert(!T->isReferenceType());
4064
4065 // See if we've already generated a CatchableTypeArray for this type before.
4066 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
4067 if (CTA)
4068 return CTA;
4069
4070 // Ensure that we don't have duplicate entries in our CatchableTypeArray by
4071 // using a SmallSetVector. Duplicates may arise due to virtual bases
4072 // occurring more than once in the hierarchy.
4073 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
4074
4075 // C++14 [except.handle]p3:
4076 // A handler is a match for an exception object of type E if [...]
4077 // - the handler is of type cv T or cv T& and T is an unambiguous public
4078 // base class of E, or
4079 // - the handler is of type cv T or const T& where T is a pointer type and
4080 // E is a pointer type that can be converted to T by [...]
4081 // - a standard pointer conversion (4.10) not involving conversions to
4082 // pointers to private or protected or ambiguous classes
4083 const CXXRecordDecl *MostDerivedClass = nullptr;
4084 bool IsPointer = T->isPointerType();
4085 if (IsPointer)
4086 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
4087 else
4088 MostDerivedClass = T->getAsCXXRecordDecl();
4089
4090 // Collect all the unambiguous public bases of the MostDerivedClass.
4091 if (MostDerivedClass) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00004092 const ASTContext &Context = getContext();
David Majnemer7c237072015-03-05 00:46:22 +00004093 const ASTRecordLayout &MostDerivedLayout =
4094 Context.getASTRecordLayout(MostDerivedClass);
4095 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
4096 SmallVector<MSRTTIClass, 8> Classes;
4097 serializeClassHierarchy(Classes, MostDerivedClass);
4098 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
4099 detectAmbiguousBases(Classes);
4100 for (const MSRTTIClass &Class : Classes) {
4101 // Skip any ambiguous or private bases.
4102 if (Class.Flags &
4103 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
4104 continue;
4105 // Write down how to convert from a derived pointer to a base pointer.
4106 uint32_t OffsetInVBTable = 0;
4107 int32_t VBPtrOffset = -1;
4108 if (Class.VirtualRoot) {
4109 OffsetInVBTable =
4110 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
4111 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
4112 }
4113
4114 // Turn our record back into a pointer if the exception object is a
4115 // pointer.
4116 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
4117 if (IsPointer)
4118 RTTITy = Context.getPointerType(RTTITy);
4119 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
4120 VBPtrOffset, OffsetInVBTable));
4121 }
4122 }
4123
4124 // C++14 [except.handle]p3:
4125 // A handler is a match for an exception object of type E if
4126 // - The handler is of type cv T or cv T& and E and T are the same type
4127 // (ignoring the top-level cv-qualifiers)
4128 CatchableTypes.insert(getCatchableType(T));
4129
4130 // C++14 [except.handle]p3:
4131 // A handler is a match for an exception object of type E if
4132 // - the handler is of type cv T or const T& where T is a pointer type and
4133 // E is a pointer type that can be converted to T by [...]
4134 // - a standard pointer conversion (4.10) not involving conversions to
4135 // pointers to private or protected or ambiguous classes
4136 //
David Majnemerf205f532015-04-04 05:37:48 +00004137 // C++14 [conv.ptr]p2:
4138 // A prvalue of type "pointer to cv T," where T is an object type, can be
4139 // converted to a prvalue of type "pointer to cv void".
4140 if (IsPointer && T->getPointeeType()->isObjectType())
David Majnemer7c237072015-03-05 00:46:22 +00004141 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4142
David Majnemera1aea9a2015-03-12 17:44:49 +00004143 // C++14 [except.handle]p3:
4144 // A handler is a match for an exception object of type E if [...]
4145 // - the handler is of type cv T or const T& where T is a pointer or
4146 // pointer to member type and E is std::nullptr_t.
4147 //
4148 // We cannot possibly list all possible pointer types here, making this
4149 // implementation incompatible with the standard. However, MSVC includes an
4150 // entry for pointer-to-void in this case. Let's do the same.
4151 if (T->isNullPtrType())
4152 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4153
David Majnemer7c237072015-03-05 00:46:22 +00004154 uint32_t NumEntries = CatchableTypes.size();
4155 llvm::Type *CTType =
4156 getImageRelativeType(getCatchableTypeType()->getPointerTo());
4157 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
4158 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
4159 llvm::Constant *Fields[] = {
4160 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries
4161 llvm::ConstantArray::get(
4162 AT, llvm::makeArrayRef(CatchableTypes.begin(),
4163 CatchableTypes.end())) // CatchableTypes
4164 };
4165 SmallString<256> MangledName;
4166 {
4167 llvm::raw_svector_ostream Out(MangledName);
4168 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
4169 }
4170 CTA = new llvm::GlobalVariable(
4171 CGM.getModule(), CTAType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004172 llvm::ConstantStruct::get(CTAType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004173 CTA->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004174 CTA->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004175 if (CTA->isWeakForLinker())
4176 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004177 return CTA;
4178}
4179
4180llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
David Majnemer526793d2016-07-12 04:42:50 +00004181 bool IsConst, IsVolatile, IsUnaligned;
4182 T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile, IsUnaligned);
David Majnemer7c237072015-03-05 00:46:22 +00004183
4184 // The CatchableTypeArray enumerates the various (CV-unqualified) types that
4185 // the exception object may be caught as.
4186 llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
4187 // The first field in a CatchableTypeArray is the number of CatchableTypes.
4188 // This is used as a component of the mangled name which means that we need to
4189 // know what it is in order to see if we have previously generated the
4190 // ThrowInfo.
4191 uint32_t NumEntries =
4192 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
4193 ->getLimitedValue();
4194
4195 SmallString<256> MangledName;
4196 {
4197 llvm::raw_svector_ostream Out(MangledName);
David Majnemer526793d2016-07-12 04:42:50 +00004198 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, IsUnaligned,
4199 NumEntries, Out);
David Majnemer7c237072015-03-05 00:46:22 +00004200 }
4201
4202 // Reuse a previously generated ThrowInfo if we have generated an appropriate
4203 // one before.
4204 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4205 return GV;
4206
4207 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
4208 // be at least as CV qualified. Encode this requirement into the Flags
4209 // bitfield.
4210 uint32_t Flags = 0;
4211 if (IsConst)
4212 Flags |= 1;
4213 if (IsVolatile)
4214 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00004215 if (IsUnaligned)
4216 Flags |= 4;
David Majnemer7c237072015-03-05 00:46:22 +00004217
4218 // The cleanup-function (a destructor) must be called when the exception
4219 // object's lifetime ends.
4220 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4221 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
4222 if (CXXDestructorDecl *DtorD = RD->getDestructor())
4223 if (!DtorD->isTrivial())
4224 CleanupFn = llvm::ConstantExpr::getBitCast(
4225 CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete),
4226 CGM.Int8PtrTy);
4227 // This is unused as far as we can tell, initialize it to null.
4228 llvm::Constant *ForwardCompat =
4229 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
4230 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
4231 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
4232 llvm::StructType *TIType = getThrowInfoType();
4233 llvm::Constant *Fields[] = {
4234 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4235 getImageRelativeConstant(CleanupFn), // CleanupFn
4236 ForwardCompat, // ForwardCompat
4237 PointerToCatchableTypes // CatchableTypeArray
4238 };
4239 auto *GV = new llvm::GlobalVariable(
4240 CGM.getModule(), TIType, /*Constant=*/true, getLinkageForRTTI(T),
4241 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004242 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004243 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004244 if (GV->isWeakForLinker())
4245 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004246 return GV;
4247}
4248
4249void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
4250 const Expr *SubExpr = E->getSubExpr();
4251 QualType ThrowType = SubExpr->getType();
4252 // The exception object lives on the stack and it's address is passed to the
4253 // runtime function.
John McCall7f416cc2015-09-08 08:05:57 +00004254 Address AI = CGF.CreateMemTemp(ThrowType);
David Majnemer7c237072015-03-05 00:46:22 +00004255 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
4256 /*IsInit=*/true);
4257
4258 // The so-called ThrowInfo is used to describe how the exception object may be
4259 // caught.
4260 llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
4261
4262 // Call into the runtime to throw the exception.
John McCall7f416cc2015-09-08 08:05:57 +00004263 llvm::Value *Args[] = {
4264 CGF.Builder.CreateBitCast(AI.getPointer(), CGM.Int8PtrTy),
4265 TI
4266 };
David Majnemer7c237072015-03-05 00:46:22 +00004267 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
4268}
Peter Collingbourne60108802017-12-13 21:53:04 +00004269
4270std::pair<llvm::Value *, const CXXRecordDecl *>
4271MicrosoftCXXABI::LoadVTablePtr(CodeGenFunction &CGF, Address This,
4272 const CXXRecordDecl *RD) {
4273 std::tie(This, std::ignore, RD) =
4274 performBaseAdjustment(CGF, This, QualType(RD->getTypeForDecl(), 0));
4275 return {CGF.GetVTablePtr(This, CGM.Int8PtrTy, RD), RD};
4276}