blob: 2d8b538bc2eec5f06fdd227fc4682b0b88bd183d [file] [log] [blame]
Charles Davis74ce8592010-06-09 23:25:41 +00001//===--- MicrosoftCXXABI.cpp - Emit LLVM Code from ASTs for a Module ------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Charles Davis74ce8592010-06-09 23:25:41 +00006//
7//===----------------------------------------------------------------------===//
8//
Chris Lattner57540c52011-04-15 05:22:18 +00009// This provides C++ code generation targeting the Microsoft Visual C++ ABI.
Charles Davis74ce8592010-06-09 23:25:41 +000010// The class in this file generates structures that follow the Microsoft
11// Visual C++ ABI, which is actually not very well documented at all outside
12// of Microsoft.
13//
14//===----------------------------------------------------------------------===//
15
16#include "CGCXXABI.h"
Reid Kleckner10aa7702015-09-16 20:15:55 +000017#include "CGCleanup.h"
Reid Kleckner7810af02013-06-19 15:20:38 +000018#include "CGVTables.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000019#include "CodeGenModule.h"
David Majnemere7a818f2015-03-06 18:53:55 +000020#include "CodeGenTypes.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000021#include "TargetInfo.h"
John McCall5ad74072017-03-02 20:04:19 +000022#include "clang/CodeGen/ConstantInitBuilder.h"
Charles Davis74ce8592010-06-09 23:25:41 +000023#include "clang/AST/Decl.h"
24#include "clang/AST/DeclCXX.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000025#include "clang/AST/StmtCXX.h"
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +000026#include "clang/AST/VTableBuilder.h"
David Majnemer611cdb92014-07-07 08:09:15 +000027#include "llvm/ADT/StringExtras.h"
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +000028#include "llvm/ADT/StringSet.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000029#include "llvm/IR/Intrinsics.h"
Charles Davis74ce8592010-06-09 23:25:41 +000030
31using namespace clang;
32using namespace CodeGen;
33
34namespace {
35
Reid Klecknerb40a27d2014-01-03 00:14:35 +000036/// Holds all the vbtable globals for a given class.
37struct VBTableGlobals {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +000038 const VPtrInfoVector *VBTables;
Reid Klecknerb40a27d2014-01-03 00:14:35 +000039 SmallVector<llvm::GlobalVariable *, 2> Globals;
40};
41
Charles Davis53c59df2010-08-16 03:33:14 +000042class MicrosoftCXXABI : public CGCXXABI {
Charles Davis74ce8592010-06-09 23:25:41 +000043public:
David Majnemer611cdb92014-07-07 08:09:15 +000044 MicrosoftCXXABI(CodeGenModule &CGM)
45 : CGCXXABI(CGM), BaseClassDescriptorType(nullptr),
46 ClassHierarchyDescriptorType(nullptr),
David Majnemer7c237072015-03-05 00:46:22 +000047 CompleteObjectLocatorType(nullptr), CatchableTypeType(nullptr),
Benjamin Kramerc2d2b422015-10-15 15:29:40 +000048 ThrowInfoType(nullptr) {}
John McCall5d865c322010-08-31 07:33:07 +000049
Craig Topper4f12f102014-03-12 06:41:41 +000050 bool HasThisReturn(GlobalDecl GD) const override;
David Majnemer0c0b6d92014-10-31 20:09:12 +000051 bool hasMostDerivedReturn(GlobalDecl GD) const override;
Stephen Lin9dc6eef2013-06-30 20:40:16 +000052
Reid Kleckner40ca9132014-05-13 22:05:45 +000053 bool classifyReturnType(CGFunctionInfo &FI) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000054
Reid Klecknere39ee212014-05-03 00:33:28 +000055 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000056
Reid Kleckner37abaca2014-05-09 22:46:15 +000057 bool isSRetParameterAfterThis() const override { return true; }
58
John McCall7f416cc2015-09-08 08:05:57 +000059 bool isThisCompleteObject(GlobalDecl GD) const override {
60 // The Microsoft ABI doesn't use separate complete-object vs.
61 // base-object variants of constructors, but it does of destructors.
62 if (isa<CXXDestructorDecl>(GD.getDecl())) {
63 switch (GD.getDtorType()) {
64 case Dtor_Complete:
65 case Dtor_Deleting:
66 return true;
67
68 case Dtor_Base:
69 return false;
70
71 case Dtor_Comdat: llvm_unreachable("emitting dtor comdat as function?");
72 }
73 llvm_unreachable("bad dtor kind");
74 }
75
76 // No other kinds.
77 return false;
78 }
79
David Majnemer196ac332014-09-11 23:05:02 +000080 size_t getSrcArgforCopyCtor(const CXXConstructorDecl *CD,
81 FunctionArgList &Args) const override {
82 assert(Args.size() >= 2 &&
83 "expected the arglist to have at least two args!");
84 // The 'most_derived' parameter goes second if the ctor is variadic and
85 // has v-bases.
86 if (CD->getParent()->getNumVBases() > 0 &&
87 CD->getType()->castAs<FunctionProtoType>()->isVariadic())
88 return 2;
89 return 1;
90 }
91
David Majnemer8671c6e2015-11-02 09:01:44 +000092 std::vector<CharUnits> getVBPtrOffsets(const CXXRecordDecl *RD) override {
93 std::vector<CharUnits> VBPtrOffsets;
94 const ASTContext &Context = getContext();
95 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
96
97 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
Justin Lebar562914e2016-10-10 16:26:29 +000098 for (const std::unique_ptr<VPtrInfo> &VBT : *VBGlobals.VBTables) {
David Majnemer8671c6e2015-11-02 09:01:44 +000099 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +0000100 Context.getASTRecordLayout(VBT->IntroducingObject);
David Majnemer8671c6e2015-11-02 09:01:44 +0000101 CharUnits Offs = VBT->NonVirtualOffset;
102 Offs += SubobjectLayout.getVBPtrOffset();
103 if (VBT->getVBaseWithVPtr())
104 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
105 VBPtrOffsets.push_back(Offs);
106 }
107 llvm::array_pod_sort(VBPtrOffsets.begin(), VBPtrOffsets.end());
108 return VBPtrOffsets;
109 }
110
Craig Topper4f12f102014-03-12 06:41:41 +0000111 StringRef GetPureVirtualCallName() override { return "_purecall"; }
Craig Topper4f12f102014-03-12 06:41:41 +0000112 StringRef GetDeletedVirtualCallName() override { return "_purecall"; }
Joao Matos2ce88ef2012-07-17 17:10:11 +0000113
David Majnemer08681372014-11-01 07:37:17 +0000114 void emitVirtualObjectDelete(CodeGenFunction &CGF, const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000115 Address Ptr, QualType ElementType,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000116 const CXXDestructorDecl *Dtor) override;
John McCall82fb8922012-09-25 10:10:39 +0000117
Chandler Carruth4b9e8572014-11-25 08:59:34 +0000118 void emitRethrow(CodeGenFunction &CGF, bool isNoReturn) override;
David Majnemer7c237072015-03-05 00:46:22 +0000119 void emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) override;
David Majnemer442d0a22014-11-25 07:20:20 +0000120
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000121 void emitBeginCatch(CodeGenFunction &CGF, const CXXCatchStmt *C) override;
122
David Majnemere2cb8d12014-07-07 06:20:47 +0000123 llvm::GlobalVariable *getMSCompleteObjectLocator(const CXXRecordDecl *RD,
Justin Lebar562914e2016-10-10 16:26:29 +0000124 const VPtrInfo &Info);
David Majnemere2cb8d12014-07-07 06:20:47 +0000125
David Majnemer443250f2015-03-17 20:35:00 +0000126 llvm::Constant *getAddrOfRTTIDescriptor(QualType Ty) override;
Reid Kleckner10aa7702015-09-16 20:15:55 +0000127 CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +0000128 getAddrOfCXXCatchHandlerType(QualType Ty, QualType CatchHandlerType) override;
David Majnemere2cb8d12014-07-07 06:20:47 +0000129
Reid Kleckner10aa7702015-09-16 20:15:55 +0000130 /// MSVC needs an extra flag to indicate a catchall.
131 CatchTypeInfo getCatchAllTypeInfo() override {
132 return CatchTypeInfo{nullptr, 0x40};
133 }
134
David Majnemer1162d252014-06-22 19:05:33 +0000135 bool shouldTypeidBeNullChecked(bool IsDeref, QualType SrcRecordTy) override;
136 void EmitBadTypeidCall(CodeGenFunction &CGF) override;
137 llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000138 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000139 llvm::Type *StdTypeInfoPtrTy) override;
140
141 bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
142 QualType SrcRecordTy) override;
143
John McCall7f416cc2015-09-08 08:05:57 +0000144 llvm::Value *EmitDynamicCastCall(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000145 QualType SrcRecordTy, QualType DestTy,
146 QualType DestRecordTy,
147 llvm::BasicBlock *CastEnd) override;
148
John McCall7f416cc2015-09-08 08:05:57 +0000149 llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000150 QualType SrcRecordTy,
151 QualType DestTy) override;
152
153 bool EmitBadCastCall(CodeGenFunction &CGF) override;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000154 bool canSpeculativelyEmitVTable(const CXXRecordDecl *RD) const override {
Piotr Padlewskia68a7872015-07-24 04:04:49 +0000155 return false;
156 }
David Majnemer1162d252014-06-22 19:05:33 +0000157
Craig Topper4f12f102014-03-12 06:41:41 +0000158 llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +0000159 GetVirtualBaseClassOffset(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000160 const CXXRecordDecl *ClassDecl,
161 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000162
Craig Topper4f12f102014-03-12 06:41:41 +0000163 llvm::BasicBlock *
164 EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
165 const CXXRecordDecl *RD) override;
Fangrui Song6907ce22018-07-30 19:24:48 +0000166
Erich Keane13c7ec52016-12-07 00:21:45 +0000167 llvm::BasicBlock *
168 EmitDtorCompleteObjectHandler(CodeGenFunction &CGF);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000169
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000170 void initializeHiddenVirtualInheritanceMembers(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000171 const CXXRecordDecl *RD) override;
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000172
Craig Topper4f12f102014-03-12 06:41:41 +0000173 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000174
Reid Klecknere7de47e2013-07-22 13:51:44 +0000175 // Background on MSVC destructors
176 // ==============================
177 //
178 // Both Itanium and MSVC ABIs have destructor variants. The variant names
179 // roughly correspond in the following way:
180 // Itanium Microsoft
181 // Base -> no name, just ~Class
182 // Complete -> vbase destructor
183 // Deleting -> scalar deleting destructor
184 // vector deleting destructor
185 //
186 // The base and complete destructors are the same as in Itanium, although the
187 // complete destructor does not accept a VTT parameter when there are virtual
188 // bases. A separate mechanism involving vtordisps is used to ensure that
189 // virtual methods of destroyed subobjects are not called.
190 //
191 // The deleting destructors accept an i32 bitfield as a second parameter. Bit
192 // 1 indicates if the memory should be deleted. Bit 2 indicates if the this
193 // pointer points to an array. The scalar deleting destructor assumes that
194 // bit 2 is zero, and therefore does not contain a loop.
195 //
196 // For virtual destructors, only one entry is reserved in the vftable, and it
197 // always points to the vector deleting destructor. The vector deleting
198 // destructor is the most general, so it can be used to destroy objects in
199 // place, delete single heap objects, or delete arrays.
200 //
201 // A TU defining a non-inline destructor is only guaranteed to emit a base
202 // destructor, and all of the other variants are emitted on an as-needed basis
203 // in COMDATs. Because a non-base destructor can be emitted in a TU that
204 // lacks a definition for the destructor, non-base destructors must always
205 // delegate to or alias the base destructor.
206
George Burgess IVf203dbf2017-02-22 20:28:02 +0000207 AddedStructorArgs
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000208 buildStructorSignature(GlobalDecl GD,
George Burgess IVf203dbf2017-02-22 20:28:02 +0000209 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000210
Reid Klecknere7de47e2013-07-22 13:51:44 +0000211 /// Non-base dtors should be emitted as delegating thunks in this ABI.
212 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000213 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000214 return DT != Dtor_Base;
215 }
216
Reid Klecknerae9b0702018-03-16 19:40:50 +0000217 void setCXXDestructorDLLStorage(llvm::GlobalValue *GV,
218 const CXXDestructorDecl *Dtor,
219 CXXDtorType DT) const override;
220
221 llvm::GlobalValue::LinkageTypes
222 getCXXDestructorLinkage(GVALinkage Linkage, const CXXDestructorDecl *Dtor,
223 CXXDtorType DT) const override;
224
Craig Topper4f12f102014-03-12 06:41:41 +0000225 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000226
Craig Topper4f12f102014-03-12 06:41:41 +0000227 const CXXRecordDecl *
228 getThisArgumentTypeForMethod(const CXXMethodDecl *MD) override {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000229 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD)) {
Reid Klecknercbec0262018-04-02 20:00:39 +0000230 MethodVFTableLocation ML =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000231 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000232 // The vbases might be ordered differently in the final overrider object
233 // and the complete object, so the "this" argument may sometimes point to
234 // memory that has no particular type (e.g. past the complete object).
235 // In this case, we just use a generic pointer type.
236 // FIXME: might want to have a more precise type in the non-virtual
237 // multiple inheritance case.
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +0000238 if (ML.VBase || !ML.VFPtrOffset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000239 return nullptr;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000240 }
241 return MD->getParent();
242 }
243
John McCall7f416cc2015-09-08 08:05:57 +0000244 Address
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000245 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD,
John McCall7f416cc2015-09-08 08:05:57 +0000246 Address This,
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000247 bool VirtualCall) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000248
Reid Kleckner89077a12013-12-17 19:46:40 +0000249 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000250 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000251
Craig Topper4f12f102014-03-12 06:41:41 +0000252 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall29036752011-01-27 02:46:02 +0000253
George Burgess IVf203dbf2017-02-22 20:28:02 +0000254 AddedStructorArgs
255 addImplicitConstructorArgs(CodeGenFunction &CGF, const CXXConstructorDecl *D,
256 CXXCtorType Type, bool ForVirtualBase,
257 bool Delegating, CallArgList &Args) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000258
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000259 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
260 CXXDtorType Type, bool ForVirtualBase,
Marco Antognini88559632019-07-22 09:39:13 +0000261 bool Delegating, Address This,
262 QualType ThisTy) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000263
Justin Lebar562914e2016-10-10 16:26:29 +0000264 void emitVTableTypeMetadata(const VPtrInfo &Info, const CXXRecordDecl *RD,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +0000265 llvm::GlobalVariable *VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +0000266
Craig Topper4f12f102014-03-12 06:41:41 +0000267 void emitVTableDefinitions(CodeGenVTables &CGVT,
268 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000269
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000270 bool isVirtualOffsetNeededForVTableField(CodeGenFunction &CGF,
271 CodeGenFunction::VPtr Vptr) override;
272
273 /// Don't initialize vptrs if dynamic class
274 /// is marked with with the 'novtable' attribute.
275 bool doStructorsInitializeVPtrs(const CXXRecordDecl *VTableClass) override {
276 return !VTableClass->hasAttr<MSNoVTableAttr>();
277 }
278
279 llvm::Constant *
280 getVTableAddressPoint(BaseSubobject Base,
281 const CXXRecordDecl *VTableClass) override;
282
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000283 llvm::Value *getVTableAddressPointInStructor(
284 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000285 BaseSubobject Base, const CXXRecordDecl *NearestVBase) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000286
287 llvm::Constant *
288 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000289 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000290
291 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000292 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000293
John McCall9831b842018-02-06 18:52:44 +0000294 CGCallee getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
295 Address This, llvm::Type *Ty,
296 SourceLocation Loc) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000297
David Majnemer0c0b6d92014-10-31 20:09:12 +0000298 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF,
299 const CXXDestructorDecl *Dtor,
Marco Antognini88559632019-07-22 09:39:13 +0000300 CXXDtorType DtorType, Address This,
301 DeleteOrMemberCallExpr E) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000302
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000303 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000304 CallArgList &CallArgs) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000305 assert(GD.getDtorType() == Dtor_Deleting &&
306 "Only deleting destructor thunks are available in this ABI");
307 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)),
David Majnemer9ced3dd2015-03-14 23:44:48 +0000308 getContext().IntTy);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000309 }
310
Craig Topper4f12f102014-03-12 06:41:41 +0000311 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000312
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000313 llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000314 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000315 llvm::GlobalVariable::LinkageTypes Linkage);
316
David Majnemerc1709d32015-06-23 07:31:11 +0000317 llvm::GlobalVariable *
318 getAddrOfVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
319 const CXXRecordDecl *DstRD) {
320 SmallString<256> OutName;
321 llvm::raw_svector_ostream Out(OutName);
322 getMangleContext().mangleCXXVirtualDisplacementMap(SrcRD, DstRD, Out);
David Majnemerc1709d32015-06-23 07:31:11 +0000323 StringRef MangledName = OutName.str();
324
325 if (auto *VDispMap = CGM.getModule().getNamedGlobal(MangledName))
326 return VDispMap;
327
328 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
329 unsigned NumEntries = 1 + SrcRD->getNumVBases();
330 SmallVector<llvm::Constant *, 4> Map(NumEntries,
331 llvm::UndefValue::get(CGM.IntTy));
332 Map[0] = llvm::ConstantInt::get(CGM.IntTy, 0);
333 bool AnyDifferent = false;
334 for (const auto &I : SrcRD->vbases()) {
335 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
336 if (!DstRD->isVirtuallyDerivedFrom(VBase))
337 continue;
338
339 unsigned SrcVBIndex = VTContext.getVBTableIndex(SrcRD, VBase);
340 unsigned DstVBIndex = VTContext.getVBTableIndex(DstRD, VBase);
341 Map[SrcVBIndex] = llvm::ConstantInt::get(CGM.IntTy, DstVBIndex * 4);
342 AnyDifferent |= SrcVBIndex != DstVBIndex;
343 }
344 // This map would be useless, don't use it.
345 if (!AnyDifferent)
346 return nullptr;
347
348 llvm::ArrayType *VDispMapTy = llvm::ArrayType::get(CGM.IntTy, Map.size());
349 llvm::Constant *Init = llvm::ConstantArray::get(VDispMapTy, Map);
350 llvm::GlobalValue::LinkageTypes Linkage =
351 SrcRD->isExternallyVisible() && DstRD->isExternallyVisible()
352 ? llvm::GlobalValue::LinkOnceODRLinkage
353 : llvm::GlobalValue::InternalLinkage;
354 auto *VDispMap = new llvm::GlobalVariable(
Rui Ueyama49a3ad22019-07-16 04:46:31 +0000355 CGM.getModule(), VDispMapTy, /*isConstant=*/true, Linkage,
David Majnemerc1709d32015-06-23 07:31:11 +0000356 /*Initializer=*/Init, MangledName);
357 return VDispMap;
358 }
359
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000360 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000361 llvm::GlobalVariable *GV) const;
362
Hans Wennborgc94391d2014-06-06 20:04:01 +0000363 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
364 GlobalDecl GD, bool ReturnAdjustment) override {
Hans Wennborgc94391d2014-06-06 20:04:01 +0000365 GVALinkage Linkage =
366 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
367
368 if (Linkage == GVA_Internal)
369 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
370 else if (ReturnAdjustment)
371 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
372 else
373 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000374 }
375
Rafael Espindolab7350042018-03-01 00:35:47 +0000376 bool exportThunk() override { return false; }
377
John McCall7f416cc2015-09-08 08:05:57 +0000378 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000379 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000380
John McCall7f416cc2015-09-08 08:05:57 +0000381 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000382 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000383
David Majnemerb3341ea2014-10-05 05:05:40 +0000384 void EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +0000385 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +0000386 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +0000387 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000388
Richard Smith00223822019-09-12 20:00:24 +0000389 bool usesThreadWrapperFunction(const VarDecl *VD) const override {
390 return false;
391 }
David Majnemerb3341ea2014-10-05 05:05:40 +0000392 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
393 QualType LValType) override;
394
John McCallc84ed6a2012-05-01 06:13:13 +0000395 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
396 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000397 bool PerformInit) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000398 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
James Y Knightf7321542019-02-07 01:14:17 +0000399 llvm::FunctionCallee Dtor,
400 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 {
Rui Ueyama49a3ad22019-07-16 04:46:31 +0000441 return CGM.getTarget().getPointerWidth(/*AddrSpace=*/0) == 64;
David Majnemer611cdb92014-07-07 08:09:15 +0000442 }
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
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000570 /// Shared code for virtual base adjustment. Returns the offset from
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000571 /// 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
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000594 /// Performs a full virtual base adjustment. Used to dereference
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000595 /// 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
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000601 /// Emits a full member pointer with the fields common to data and
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000602 /// 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
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000612 /// - Initialize all vbptrs of 'this' with RD as the complete type.
Reid Kleckner7810af02013-06-19 15:20:38 +0000613 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
614
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000615 /// 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
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000618 /// Generate a thunk for calling a virtual member function MD.
Reid Klecknercbec0262018-04-02 20:00:39 +0000619 llvm::Function *EmitVirtualMemPtrThunk(const CXXMethodDecl *MD,
620 const MethodVFTableLocation &ML);
Hans Wennborg88497d62013-11-15 17:24:45 +0000621
Reid Kleckner407e8b62013-03-22 19:02:54 +0000622public:
Craig Topper4f12f102014-03-12 06:41:41 +0000623 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000624
Craig Topper4f12f102014-03-12 06:41:41 +0000625 bool isZeroInitializable(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000626
David Majnemerb3e56542014-08-07 22:56:13 +0000627 bool isMemberPointerConvertible(const MemberPointerType *MPT) const override {
628 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemer99281062014-09-18 22:05:54 +0000629 return RD->hasAttr<MSInheritanceAttr>();
630 }
631
Craig Topper4f12f102014-03-12 06:41:41 +0000632 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000633
Craig Topper4f12f102014-03-12 06:41:41 +0000634 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
635 CharUnits offset) override;
David Majnemere2be95b2015-06-23 07:31:01 +0000636 llvm::Constant *EmitMemberFunctionPointer(const CXXMethodDecl *MD) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000637 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000638
Craig Topper4f12f102014-03-12 06:41:41 +0000639 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
640 llvm::Value *L,
641 llvm::Value *R,
642 const MemberPointerType *MPT,
643 bool Inequality) override;
Reid Kleckner700c3ee2013-04-30 20:15:14 +0000644
Craig Topper4f12f102014-03-12 06:41:41 +0000645 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
646 llvm::Value *MemPtr,
647 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000648
Craig Topper4f12f102014-03-12 06:41:41 +0000649 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000650 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000651 Address Base, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000652 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000653
David Majnemer0d9ad682015-06-29 00:06:50 +0000654 llvm::Value *EmitNonNullMemberPointerConversion(
655 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
656 CastKind CK, CastExpr::path_const_iterator PathBegin,
657 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
658 CGBuilderTy &Builder);
659
Craig Topper4f12f102014-03-12 06:41:41 +0000660 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
661 const CastExpr *E,
662 llvm::Value *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000663
Craig Topper4f12f102014-03-12 06:41:41 +0000664 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
665 llvm::Constant *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000666
David Majnemer5ca193c2015-06-23 07:31:07 +0000667 llvm::Constant *EmitMemberPointerConversion(
668 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
669 CastKind CK, CastExpr::path_const_iterator PathBegin,
670 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src);
671
John McCallb92ab1a2016-10-26 23:46:34 +0000672 CGCallee
David Majnemer2b0d66d2014-02-20 23:22:07 +0000673 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000674 Address This, llvm::Value *&ThisPtrForCall,
675 llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000676 const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000677
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000678 void emitCXXStructor(GlobalDecl GD) override;
Rafael Espindola91f68b42014-09-15 19:20:10 +0000679
David Majnemer7c237072015-03-05 00:46:22 +0000680 llvm::StructType *getCatchableTypeType() {
681 if (CatchableTypeType)
682 return CatchableTypeType;
683 llvm::Type *FieldTypes[] = {
684 CGM.IntTy, // Flags
685 getImageRelativeType(CGM.Int8PtrTy), // TypeDescriptor
686 CGM.IntTy, // NonVirtualAdjustment
687 CGM.IntTy, // OffsetToVBPtr
688 CGM.IntTy, // VBTableIndex
689 CGM.IntTy, // Size
690 getImageRelativeType(CGM.Int8PtrTy) // CopyCtor
691 };
692 CatchableTypeType = llvm::StructType::create(
693 CGM.getLLVMContext(), FieldTypes, "eh.CatchableType");
694 return CatchableTypeType;
695 }
696
697 llvm::StructType *getCatchableTypeArrayType(uint32_t NumEntries) {
698 llvm::StructType *&CatchableTypeArrayType =
699 CatchableTypeArrayTypeMap[NumEntries];
700 if (CatchableTypeArrayType)
701 return CatchableTypeArrayType;
702
703 llvm::SmallString<23> CTATypeName("eh.CatchableTypeArray.");
704 CTATypeName += llvm::utostr(NumEntries);
705 llvm::Type *CTType =
706 getImageRelativeType(getCatchableTypeType()->getPointerTo());
707 llvm::Type *FieldTypes[] = {
708 CGM.IntTy, // NumEntries
709 llvm::ArrayType::get(CTType, NumEntries) // CatchableTypes
710 };
711 CatchableTypeArrayType =
712 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, CTATypeName);
713 return CatchableTypeArrayType;
714 }
715
716 llvm::StructType *getThrowInfoType() {
717 if (ThrowInfoType)
718 return ThrowInfoType;
719 llvm::Type *FieldTypes[] = {
720 CGM.IntTy, // Flags
721 getImageRelativeType(CGM.Int8PtrTy), // CleanupFn
722 getImageRelativeType(CGM.Int8PtrTy), // ForwardCompat
723 getImageRelativeType(CGM.Int8PtrTy) // CatchableTypeArray
724 };
725 ThrowInfoType = llvm::StructType::create(CGM.getLLVMContext(), FieldTypes,
726 "eh.ThrowInfo");
727 return ThrowInfoType;
728 }
729
James Y Knight9871db02019-02-05 16:42:33 +0000730 llvm::FunctionCallee getThrowFn() {
David Majnemer7c237072015-03-05 00:46:22 +0000731 // _CxxThrowException is passed an exception object and a ThrowInfo object
732 // which describes the exception.
733 llvm::Type *Args[] = {CGM.Int8PtrTy, getThrowInfoType()->getPointerTo()};
734 llvm::FunctionType *FTy =
Rui Ueyama49a3ad22019-07-16 04:46:31 +0000735 llvm::FunctionType::get(CGM.VoidTy, Args, /*isVarArg=*/false);
James Y Knight9871db02019-02-05 16:42:33 +0000736 llvm::FunctionCallee Throw =
737 CGM.CreateRuntimeFunction(FTy, "_CxxThrowException");
David Majnemer7c237072015-03-05 00:46:22 +0000738 // _CxxThrowException is stdcall on 32-bit x86 platforms.
James Y Knight9871db02019-02-05 16:42:33 +0000739 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::x86) {
Don Hintonf170dff2019-03-19 06:14:14 +0000740 if (auto *Fn = dyn_cast<llvm::Function>(Throw.getCallee()))
James Y Knight9871db02019-02-05 16:42:33 +0000741 Fn->setCallingConv(llvm::CallingConv::X86_StdCall);
742 }
743 return Throw;
David Majnemer7c237072015-03-05 00:46:22 +0000744 }
745
David Majnemer37fd66e2015-03-13 22:36:55 +0000746 llvm::Function *getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
747 CXXCtorType CT);
David Majnemerdfa6d202015-03-11 18:36:39 +0000748
David Majnemer7c237072015-03-05 00:46:22 +0000749 llvm::Constant *getCatchableType(QualType T,
750 uint32_t NVOffset = 0,
751 int32_t VBPtrOffset = -1,
752 uint32_t VBIndex = 0);
753
754 llvm::GlobalVariable *getCatchableTypeArray(QualType T);
755
David Majnemerba3e5ec2015-03-13 18:26:17 +0000756 llvm::GlobalVariable *getThrowInfo(QualType T) override;
David Majnemer7c237072015-03-05 00:46:22 +0000757
Peter Collingbourne60108802017-12-13 21:53:04 +0000758 std::pair<llvm::Value *, const CXXRecordDecl *>
759 LoadVTablePtr(CodeGenFunction &CGF, Address This,
760 const CXXRecordDecl *RD) override;
761
Reid Kleckner7810af02013-06-19 15:20:38 +0000762private:
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000763 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy;
David Majnemerd905da42014-07-01 20:30:31 +0000764 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy;
765 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000766 /// All the vftables that have been referenced.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000767 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000768 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000769
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000770 /// This set holds the record decls we've deferred vtable emission for.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000771 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
772
773
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000774 /// All the vbtables which have been referenced.
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000775 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap;
Reid Klecknerd8110b62013-09-10 20:14:30 +0000776
777 /// Info on the global variable used to guard initialization of static locals.
778 /// The BitIndex field is only used for externally invisible declarations.
779 struct GuardInfo {
Craig Topper8a13c412014-05-21 05:09:00 +0000780 GuardInfo() : Guard(nullptr), BitIndex(0) {}
Reid Klecknerd8110b62013-09-10 20:14:30 +0000781 llvm::GlobalVariable *Guard;
782 unsigned BitIndex;
783 };
784
785 /// Map from DeclContext to the current guard variable. We assume that the
786 /// AST is visited in source code order.
787 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap;
David Majnemerec8e54b2015-05-07 21:19:06 +0000788 llvm::DenseMap<const DeclContext *, GuardInfo> ThreadLocalGuardVariableMap;
David Majnemer8354eee2015-05-07 06:15:46 +0000789 llvm::DenseMap<const DeclContext *, unsigned> ThreadSafeGuardNumMap;
David Majnemer611cdb92014-07-07 08:09:15 +0000790
791 llvm::DenseMap<size_t, llvm::StructType *> TypeDescriptorTypeMap;
792 llvm::StructType *BaseClassDescriptorType;
793 llvm::StructType *ClassHierarchyDescriptorType;
794 llvm::StructType *CompleteObjectLocatorType;
David Majnemer7c237072015-03-05 00:46:22 +0000795
796 llvm::DenseMap<QualType, llvm::GlobalVariable *> CatchableTypeArrays;
797
798 llvm::StructType *CatchableTypeType;
799 llvm::DenseMap<uint32_t, llvm::StructType *> CatchableTypeArrayTypeMap;
800 llvm::StructType *ThrowInfoType;
Charles Davis74ce8592010-06-09 23:25:41 +0000801};
802
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000803}
Charles Davis74ce8592010-06-09 23:25:41 +0000804
Reid Klecknere39ee212014-05-03 00:33:28 +0000805CGCXXABI::RecordArgABI
806MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const {
807 switch (CGM.getTarget().getTriple().getArch()) {
808 default:
809 // FIXME: Implement for other architectures.
810 return RAA_Default;
811
Reid Kleckner44051e62016-08-25 18:23:28 +0000812 case llvm::Triple::thumb:
813 // Use the simple Itanium rules for now.
814 // FIXME: This is incompatible with MSVC for arguments with a dtor and no
815 // copy ctor.
Reid Kleckneradb41982019-04-30 22:23:20 +0000816 return !RD->canPassInRegisters() ? RAA_Indirect : RAA_Default;
Reid Kleckner44051e62016-08-25 18:23:28 +0000817
Reid Klecknere39ee212014-05-03 00:33:28 +0000818 case llvm::Triple::x86:
Reid Klecknercf87e102014-05-14 16:02:09 +0000819 // All record arguments are passed in memory on x86. Decide whether to
820 // construct the object directly in argument memory, or to construct the
821 // argument elsewhere and copy the bytes during the call.
822
823 // If C++ prohibits us from making a copy, construct the arguments directly
824 // into argument memory.
Reid Kleckneradb41982019-04-30 22:23:20 +0000825 if (!RD->canPassInRegisters())
Reid Klecknere39ee212014-05-03 00:33:28 +0000826 return RAA_DirectInMemory;
Reid Klecknercf87e102014-05-14 16:02:09 +0000827
828 // Otherwise, construct the argument into a temporary and copy the bytes
829 // into the outgoing argument memory.
Reid Klecknere39ee212014-05-03 00:33:28 +0000830 return RAA_Default;
831
832 case llvm::Triple::x86_64:
Sanjin Sijaric56391d62018-07-26 22:18:28 +0000833 case llvm::Triple::aarch64:
Reid Kleckneradb41982019-04-30 22:23:20 +0000834 return !RD->canPassInRegisters() ? RAA_Indirect : RAA_Default;
Reid Klecknere39ee212014-05-03 00:33:28 +0000835 }
836
837 llvm_unreachable("invalid enum");
838}
839
David Majnemer08681372014-11-01 07:37:17 +0000840void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
841 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000842 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +0000843 QualType ElementType,
844 const CXXDestructorDecl *Dtor) {
David Majnemer0c0b6d92014-10-31 20:09:12 +0000845 // FIXME: Provide a source location here even though there's no
846 // CXXMemberCallExpr for dtor call.
David Majnemer08681372014-11-01 07:37:17 +0000847 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000848 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
Marco Antognini88559632019-07-22 09:39:13 +0000849 llvm::Value *MDThis = EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, DE);
David Majnemer0c0b6d92014-10-31 20:09:12 +0000850 if (UseGlobalDelete)
David Majnemer08681372014-11-01 07:37:17 +0000851 CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType);
John McCall82fb8922012-09-25 10:10:39 +0000852}
853
David Majnemer442d0a22014-11-25 07:20:20 +0000854void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
David Majnemer7c237072015-03-05 00:46:22 +0000855 llvm::Value *Args[] = {
856 llvm::ConstantPointerNull::get(CGM.Int8PtrTy),
857 llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())};
James Y Knight9871db02019-02-05 16:42:33 +0000858 llvm::FunctionCallee Fn = getThrowFn();
David Majnemer442d0a22014-11-25 07:20:20 +0000859 if (isNoReturn)
860 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args);
861 else
862 CGF.EmitRuntimeCallOrInvoke(Fn, Args);
863}
864
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000865void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF,
866 const CXXCatchStmt *S) {
867 // In the MS ABI, the runtime handles the copy, and the catch handler is
868 // responsible for destruction.
869 VarDecl *CatchParam = S->getExceptionDecl();
David Majnemer4e52d6f2015-12-12 05:39:21 +0000870 llvm::BasicBlock *CatchPadBB = CGF.Builder.GetInsertBlock();
Reid Kleckner129552b2015-10-08 01:13:52 +0000871 llvm::CatchPadInst *CPI =
872 cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
David Majnemer4e52d6f2015-12-12 05:39:21 +0000873 CGF.CurrentFuncletPad = CPI;
Reid Kleckner129552b2015-10-08 01:13:52 +0000874
Reid Kleckner67cf0352015-04-07 00:09:59 +0000875 // If this is a catch-all or the catch parameter is unnamed, we don't need to
876 // emit an alloca to the object.
877 if (!CatchParam || !CatchParam->getDeclName()) {
Reid Kleckner129552b2015-10-08 01:13:52 +0000878 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000879 return;
880 }
881
882 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
Reid Kleckner129552b2015-10-08 01:13:52 +0000883 CPI->setArgOperand(2, var.getObjectAddress(CGF).getPointer());
884 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000885 CGF.EmitAutoVarCleanups(var);
886}
887
John McCall7f416cc2015-09-08 08:05:57 +0000888/// We need to perform a generic polymorphic operation (like a typeid
889/// or a cast), which requires an object with a vfptr. Adjust the
890/// address to point to an object with a vfptr.
Peter Collingbourne60108802017-12-13 21:53:04 +0000891std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000892MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000893 QualType SrcRecordTy) {
David Majnemer1162d252014-06-22 19:05:33 +0000894 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
895 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
David Majnemer9ced3dd2015-03-14 23:44:48 +0000896 const ASTContext &Context = getContext();
David Majnemer1162d252014-06-22 19:05:33 +0000897
John McCall7f416cc2015-09-08 08:05:57 +0000898 // If the class itself has a vfptr, great. This check implicitly
899 // covers non-virtual base subobjects: a class with its own virtual
900 // functions would be a candidate to be a primary base.
David Majnemer5bc883f2015-02-27 02:38:02 +0000901 if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
Peter Collingbourne60108802017-12-13 21:53:04 +0000902 return std::make_tuple(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0),
903 SrcDecl);
David Majnemer1162d252014-06-22 19:05:33 +0000904
John McCall7f416cc2015-09-08 08:05:57 +0000905 // Okay, one of the vbases must have a vfptr, or else this isn't
906 // actually a polymorphic class.
907 const CXXRecordDecl *PolymorphicBase = nullptr;
908 for (auto &Base : SrcDecl->vbases()) {
909 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
910 if (Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr()) {
911 PolymorphicBase = BaseDecl;
912 break;
913 }
914 }
915 assert(PolymorphicBase && "polymorphic class has no apparent vfptr?");
916
917 llvm::Value *Offset =
918 GetVirtualBaseClassOffset(CGF, Value, SrcDecl, PolymorphicBase);
919 llvm::Value *Ptr = CGF.Builder.CreateInBoundsGEP(Value.getPointer(), Offset);
John McCall7f416cc2015-09-08 08:05:57 +0000920 CharUnits VBaseAlign =
921 CGF.CGM.getVBaseAlignment(Value.getAlignment(), SrcDecl, PolymorphicBase);
Peter Collingbourne60108802017-12-13 21:53:04 +0000922 return std::make_tuple(Address(Ptr, VBaseAlign), Offset, PolymorphicBase);
David Majnemer1162d252014-06-22 19:05:33 +0000923}
924
925bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
926 QualType SrcRecordTy) {
927 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
928 return IsDeref &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000929 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000930}
931
James Y Knight3933add2019-01-30 02:54:28 +0000932static llvm::CallBase *emitRTtypeidCall(CodeGenFunction &CGF,
933 llvm::Value *Argument) {
David Majnemer1162d252014-06-22 19:05:33 +0000934 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
935 llvm::FunctionType *FTy =
936 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
937 llvm::Value *Args[] = {Argument};
James Y Knight9871db02019-02-05 16:42:33 +0000938 llvm::FunctionCallee Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
David Majnemer1162d252014-06-22 19:05:33 +0000939 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
940}
941
942void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
James Y Knight3933add2019-01-30 02:54:28 +0000943 llvm::CallBase *Call =
David Majnemer1162d252014-06-22 19:05:33 +0000944 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
James Y Knight3933add2019-01-30 02:54:28 +0000945 Call->setDoesNotReturn();
David Majnemer1162d252014-06-22 19:05:33 +0000946 CGF.Builder.CreateUnreachable();
947}
948
949llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
950 QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000951 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000952 llvm::Type *StdTypeInfoPtrTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +0000953 std::tie(ThisPtr, std::ignore, std::ignore) =
David Majnemer17755352016-07-09 19:26:25 +0000954 performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
James Y Knight3933add2019-01-30 02:54:28 +0000955 llvm::CallBase *Typeid = emitRTtypeidCall(CGF, ThisPtr.getPointer());
John McCall7f416cc2015-09-08 08:05:57 +0000956 return CGF.Builder.CreateBitCast(Typeid, StdTypeInfoPtrTy);
David Majnemer1162d252014-06-22 19:05:33 +0000957}
958
959bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
960 QualType SrcRecordTy) {
961 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
962 return SrcIsPtr &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000963 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000964}
965
966llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
John McCall7f416cc2015-09-08 08:05:57 +0000967 CodeGenFunction &CGF, Address This, QualType SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +0000968 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
969 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
970
971 llvm::Value *SrcRTTI =
972 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
973 llvm::Value *DestRTTI =
974 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
975
976 llvm::Value *Offset;
Peter Collingbourne60108802017-12-13 21:53:04 +0000977 std::tie(This, Offset, std::ignore) =
978 performBaseAdjustment(CGF, This, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +0000979 llvm::Value *ThisPtr = This.getPointer();
David Majnemer17755352016-07-09 19:26:25 +0000980 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
David Majnemer1162d252014-06-22 19:05:33 +0000981
982 // PVOID __RTDynamicCast(
983 // PVOID inptr,
984 // LONG VfDelta,
985 // PVOID SrcType,
986 // PVOID TargetType,
987 // BOOL isReference)
988 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
989 CGF.Int8PtrTy, CGF.Int32Ty};
James Y Knight9871db02019-02-05 16:42:33 +0000990 llvm::FunctionCallee Function = CGF.CGM.CreateRuntimeFunction(
David Majnemer1162d252014-06-22 19:05:33 +0000991 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
992 "__RTDynamicCast");
993 llvm::Value *Args[] = {
John McCall7f416cc2015-09-08 08:05:57 +0000994 ThisPtr, Offset, SrcRTTI, DestRTTI,
David Majnemer1162d252014-06-22 19:05:33 +0000995 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
James Y Knight3933add2019-01-30 02:54:28 +0000996 ThisPtr = CGF.EmitRuntimeCallOrInvoke(Function, Args);
John McCall7f416cc2015-09-08 08:05:57 +0000997 return CGF.Builder.CreateBitCast(ThisPtr, DestLTy);
David Majnemer1162d252014-06-22 19:05:33 +0000998}
999
1000llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00001001MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +00001002 QualType SrcRecordTy,
1003 QualType DestTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +00001004 std::tie(Value, std::ignore, std::ignore) =
1005 performBaseAdjustment(CGF, Value, SrcRecordTy);
David Majnemer1162d252014-06-22 19:05:33 +00001006
1007 // PVOID __RTCastToVoid(
1008 // PVOID inptr)
1009 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
James Y Knight9871db02019-02-05 16:42:33 +00001010 llvm::FunctionCallee Function = CGF.CGM.CreateRuntimeFunction(
David Majnemer1162d252014-06-22 19:05:33 +00001011 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1012 "__RTCastToVoid");
John McCall7f416cc2015-09-08 08:05:57 +00001013 llvm::Value *Args[] = {Value.getPointer()};
David Majnemer1162d252014-06-22 19:05:33 +00001014 return CGF.EmitRuntimeCall(Function, Args);
1015}
1016
1017bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
1018 return false;
1019}
1020
David Majnemerca32f932014-09-01 18:50:02 +00001021llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
John McCall7f416cc2015-09-08 08:05:57 +00001022 CodeGenFunction &CGF, Address This, const CXXRecordDecl *ClassDecl,
David Majnemerca32f932014-09-01 18:50:02 +00001023 const CXXRecordDecl *BaseClassDecl) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001024 const ASTContext &Context = getContext();
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00001025 int64_t VBPtrChars =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001026 Context.getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001027 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
David Majnemer9ced3dd2015-03-14 23:44:48 +00001028 CharUnits IntSize = Context.getTypeSizeInChars(Context.IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001029 CharUnits VBTableChars =
1030 IntSize *
1031 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001032 llvm::Value *VBTableOffset =
David Majnemerca32f932014-09-01 18:50:02 +00001033 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001034
1035 llvm::Value *VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001036 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001037 VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001038 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001039 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
1040}
1041
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001042bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
1043 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +00001044}
1045
David Majnemer0c0b6d92014-10-31 20:09:12 +00001046static bool isDeletingDtor(GlobalDecl GD) {
1047 return isa<CXXDestructorDecl>(GD.getDecl()) &&
1048 GD.getDtorType() == Dtor_Deleting;
1049}
1050
1051bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const {
1052 return isDeletingDtor(GD);
1053}
1054
Mandeep Singh Grang85a0f8f2019-05-03 21:12:24 +00001055static bool IsSizeGreaterThan128(const CXXRecordDecl *RD) {
1056 return RD->getASTContext().getTypeSize(RD->getTypeForDecl()) > 128;
1057}
1058
1059static bool hasMicrosoftABIRestrictions(const CXXRecordDecl *RD) {
1060 // For AArch64, we use the C++14 definition of an aggregate, so we also
1061 // check for:
1062 // No private or protected non static data members.
1063 // No base classes
1064 // No virtual functions
1065 // Additionally, we need to ensure that there is a trivial copy assignment
1066 // operator, a trivial destructor and no user-provided constructors.
1067 if (RD->hasProtectedFields() || RD->hasPrivateFields())
1068 return true;
1069 if (RD->getNumBases() > 0)
1070 return true;
1071 if (RD->isPolymorphic())
1072 return true;
1073 if (RD->hasNonTrivialCopyAssignment())
1074 return true;
1075 for (const CXXConstructorDecl *Ctor : RD->ctors())
1076 if (Ctor->isUserProvided())
1077 return true;
1078 if (RD->hasNonTrivialDestructor())
1079 return true;
1080 return false;
1081}
1082
Reid Kleckner40ca9132014-05-13 22:05:45 +00001083bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
1084 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
1085 if (!RD)
1086 return false;
1087
Mandeep Singh Grang85a0f8f2019-05-03 21:12:24 +00001088 bool isAArch64 = CGM.getTarget().getTriple().isAArch64();
1089 bool isSimple = !isAArch64 || !hasMicrosoftABIRestrictions(RD);
1090 bool isIndirectReturn =
1091 isAArch64 ? (!RD->canPassInRegisters() ||
1092 IsSizeGreaterThan128(RD))
1093 : !RD->isPOD();
1094 bool isInstanceMethod = FI.isInstanceMethod();
Mandeep Singh Grang2a153102018-07-26 18:07:59 +00001095
Mandeep Singh Grang85a0f8f2019-05-03 21:12:24 +00001096 if (isIndirectReturn || !isSimple || isInstanceMethod) {
1097 CharUnits Align = CGM.getContext().getTypeAlignInChars(FI.getReturnType());
John McCall7f416cc2015-09-08 08:05:57 +00001098 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Mandeep Singh Grang85a0f8f2019-05-03 21:12:24 +00001099 FI.getReturnInfo().setSRetAfterThis(isInstanceMethod);
Mandeep Singh Grang2a153102018-07-26 18:07:59 +00001100
Mandeep Singh Grang85a0f8f2019-05-03 21:12:24 +00001101 FI.getReturnInfo().setInReg(isAArch64 &&
1102 !(isSimple && IsSizeGreaterThan128(RD)));
1103
Reid Kleckner40ca9132014-05-13 22:05:45 +00001104 return true;
1105 }
1106
1107 // Otherwise, use the C ABI rules.
1108 return false;
1109}
1110
Reid Kleckner7810af02013-06-19 15:20:38 +00001111llvm::BasicBlock *
1112MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
1113 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001114 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1115 assert(IsMostDerivedClass &&
1116 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +00001117 llvm::Value *IsCompleteObject =
1118 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001119
1120 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
1121 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
1122 CGF.Builder.CreateCondBr(IsCompleteObject,
1123 CallVbaseCtorsBB, SkipVbaseCtorsBB);
1124
1125 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +00001126
1127 // Fill in the vbtable pointers here.
1128 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001129
1130 // CGF will put the base ctor calls in this basic block for us later.
1131
1132 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +00001133}
1134
Erich Keane13c7ec52016-12-07 00:21:45 +00001135llvm::BasicBlock *
1136MicrosoftCXXABI::EmitDtorCompleteObjectHandler(CodeGenFunction &CGF) {
1137 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1138 assert(IsMostDerivedClass &&
1139 "ctor for a class with virtual bases must have an implicit parameter");
1140 llvm::Value *IsCompleteObject =
1141 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
1142
1143 llvm::BasicBlock *CallVbaseDtorsBB = CGF.createBasicBlock("Dtor.dtor_vbases");
1144 llvm::BasicBlock *SkipVbaseDtorsBB = CGF.createBasicBlock("Dtor.skip_vbases");
1145 CGF.Builder.CreateCondBr(IsCompleteObject,
1146 CallVbaseDtorsBB, SkipVbaseDtorsBB);
1147
1148 CGF.EmitBlock(CallVbaseDtorsBB);
1149 // CGF will put the base dtor calls in this basic block for us later.
Fangrui Song6907ce22018-07-30 19:24:48 +00001150
Erich Keane13c7ec52016-12-07 00:21:45 +00001151 return SkipVbaseDtorsBB;
1152}
1153
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001154void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
1155 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
1156 // In most cases, an override for a vbase virtual method can adjust
1157 // the "this" parameter by applying a constant offset.
1158 // However, this is not enough while a constructor or a destructor of some
1159 // class X is being executed if all the following conditions are met:
1160 // - X has virtual bases, (1)
1161 // - X overrides a virtual method M of a vbase Y, (2)
1162 // - X itself is a vbase of the most derived class.
1163 //
1164 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
1165 // which holds the extra amount of "this" adjustment we must do when we use
1166 // the X vftables (i.e. during X ctor or dtor).
1167 // Outside the ctors and dtors, the values of vtorDisps are zero.
1168
1169 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
1170 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
1171 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
1172 CGBuilderTy &Builder = CGF.Builder;
1173
John McCall7f416cc2015-09-08 08:05:57 +00001174 unsigned AS = getThisAddress(CGF).getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +00001175 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001176
Nico Weber91af2742018-03-07 23:15:20 +00001177 for (const CXXBaseSpecifier &S : RD->vbases()) {
1178 const CXXRecordDecl *VBase = S.getType()->getAsCXXRecordDecl();
1179 auto I = VBaseMap.find(VBase);
1180 assert(I != VBaseMap.end());
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001181 if (!I->second.hasVtorDisp())
1182 continue;
1183
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +00001184 llvm::Value *VBaseOffset =
Nico Weber91af2742018-03-07 23:15:20 +00001185 GetVirtualBaseClassOffset(CGF, getThisAddress(CGF), RD, VBase);
1186 uint64_t ConstantVBaseOffset = I->second.VBaseOffset.getQuantity();
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001187
1188 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
1189 llvm::Value *VtorDispValue = Builder.CreateSub(
David Majnemer17755352016-07-09 19:26:25 +00001190 VBaseOffset, llvm::ConstantInt::get(CGM.PtrDiffTy, ConstantVBaseOffset),
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001191 "vtordisp.value");
David Majnemer17755352016-07-09 19:26:25 +00001192 VtorDispValue = Builder.CreateTruncOrBitCast(VtorDispValue, CGF.Int32Ty);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001193
1194 if (!Int8This)
1195 Int8This = Builder.CreateBitCast(getThisValue(CGF),
1196 CGF.Int8Ty->getPointerTo(AS));
1197 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
1198 // vtorDisp is always the 32-bits before the vbase in the class layout.
1199 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
1200 VtorDispPtr = Builder.CreateBitCast(
1201 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
1202
John McCall7f416cc2015-09-08 08:05:57 +00001203 Builder.CreateAlignedStore(VtorDispValue, VtorDispPtr,
1204 CharUnits::fromQuantity(4));
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001205 }
1206}
1207
David Majnemer37fd66e2015-03-13 22:36:55 +00001208static bool hasDefaultCXXMethodCC(ASTContext &Context,
1209 const CXXMethodDecl *MD) {
1210 CallingConv ExpectedCallingConv = Context.getDefaultCallingConvention(
1211 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1212 CallingConv ActualCallingConv =
Simon Pilgrim7e38f0c2019-10-07 16:42:25 +00001213 MD->getType()->castAs<FunctionProtoType>()->getCallConv();
David Majnemer37fd66e2015-03-13 22:36:55 +00001214 return ExpectedCallingConv == ActualCallingConv;
1215}
1216
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001217void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1218 // There's only one constructor type in this ABI.
1219 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
David Majnemer37fd66e2015-03-13 22:36:55 +00001220
1221 // Exported default constructors either have a simple call-site where they use
1222 // the typical calling convention and have a single 'this' pointer for an
1223 // argument -or- they get a wrapper function which appropriately thunks to the
1224 // real default constructor. This thunk is the default constructor closure.
1225 if (D->hasAttr<DLLExportAttr>() && D->isDefaultConstructor())
1226 if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) {
1227 llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure);
1228 Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage);
Rafael Espindolab7350042018-03-01 00:35:47 +00001229 CGM.setGVProperties(Fn, D);
David Majnemer37fd66e2015-03-13 22:36:55 +00001230 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001231}
1232
Reid Kleckner7810af02013-06-19 15:20:38 +00001233void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1234 const CXXRecordDecl *RD) {
John McCall7f416cc2015-09-08 08:05:57 +00001235 Address This = getThisAddress(CGF);
1236 This = CGF.Builder.CreateElementBitCast(This, CGM.Int8Ty, "this.int8");
David Majnemer9ced3dd2015-03-14 23:44:48 +00001237 const ASTContext &Context = getContext();
1238 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001239
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001240 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1241 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00001242 const std::unique_ptr<VPtrInfo> &VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001243 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +00001244 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001245 Context.getASTRecordLayout(VBT->IntroducingObject);
Reid Kleckner5f080942014-01-03 23:42:00 +00001246 CharUnits Offs = VBT->NonVirtualOffset;
1247 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001248 if (VBT->getVBaseWithVPtr())
1249 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
John McCall7f416cc2015-09-08 08:05:57 +00001250 Address VBPtr = CGF.Builder.CreateConstInBoundsByteGEP(This, Offs);
David Blaikie1ed728c2015-04-05 22:45:47 +00001251 llvm::Value *GVPtr =
1252 CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001253 VBPtr = CGF.Builder.CreateElementBitCast(VBPtr, GVPtr->getType(),
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001254 "vbptr." + VBT->ObjectWithVPtr->getName());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001255 CGF.Builder.CreateStore(GVPtr, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +00001256 }
1257}
1258
George Burgess IVf203dbf2017-02-22 20:28:02 +00001259CGCXXABI::AddedStructorArgs
Peter Collingbourned1c5b282019-03-22 23:05:10 +00001260MicrosoftCXXABI::buildStructorSignature(GlobalDecl GD,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001261 SmallVectorImpl<CanQualType> &ArgTys) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001262 AddedStructorArgs Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001263 // TODO: 'for base' flag
Peter Collingbourned1c5b282019-03-22 23:05:10 +00001264 if (isa<CXXDestructorDecl>(GD.getDecl()) &&
1265 GD.getDtorType() == Dtor_Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001266 // The scalar deleting destructor takes an implicit int parameter.
David Majnemer9ced3dd2015-03-14 23:44:48 +00001267 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001268 ++Added.Suffix;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001269 }
Peter Collingbourned1c5b282019-03-22 23:05:10 +00001270 auto *CD = dyn_cast<CXXConstructorDecl>(GD.getDecl());
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001271 if (!CD)
George Burgess IVf203dbf2017-02-22 20:28:02 +00001272 return Added;
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001273
1274 // All parameters are already in place except is_most_derived, which goes
1275 // after 'this' if it's variadic and last if it's not.
1276
1277 const CXXRecordDecl *Class = CD->getParent();
1278 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1279 if (Class->getNumVBases()) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001280 if (FPT->isVariadic()) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001281 ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001282 ++Added.Prefix;
1283 } else {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001284 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001285 ++Added.Suffix;
1286 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001287 }
George Burgess IVf203dbf2017-02-22 20:28:02 +00001288
1289 return Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001290}
1291
Reid Klecknerae9b0702018-03-16 19:40:50 +00001292void MicrosoftCXXABI::setCXXDestructorDLLStorage(llvm::GlobalValue *GV,
1293 const CXXDestructorDecl *Dtor,
1294 CXXDtorType DT) const {
1295 // Deleting destructor variants are never imported or exported. Give them the
1296 // default storage class.
1297 if (DT == Dtor_Deleting) {
1298 GV->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
1299 } else {
1300 const NamedDecl *ND = Dtor;
1301 CGM.setDLLImportDLLExport(GV, ND);
1302 }
1303}
1304
1305llvm::GlobalValue::LinkageTypes MicrosoftCXXABI::getCXXDestructorLinkage(
1306 GVALinkage Linkage, const CXXDestructorDecl *Dtor, CXXDtorType DT) const {
1307 // Internal things are always internal, regardless of attributes. After this,
1308 // we know the thunk is externally visible.
1309 if (Linkage == GVA_Internal)
1310 return llvm::GlobalValue::InternalLinkage;
1311
1312 switch (DT) {
1313 case Dtor_Base:
1314 // The base destructor most closely tracks the user-declared constructor, so
1315 // we delegate back to the normal declarator case.
1316 return CGM.getLLVMLinkageForDeclarator(Dtor, Linkage,
Rui Ueyama49a3ad22019-07-16 04:46:31 +00001317 /*IsConstantVariable=*/false);
Reid Klecknerae9b0702018-03-16 19:40:50 +00001318 case Dtor_Complete:
1319 // The complete destructor is like an inline function, but it may be
1320 // imported and therefore must be exported as well. This requires changing
1321 // the linkage if a DLL attribute is present.
1322 if (Dtor->hasAttr<DLLExportAttr>())
1323 return llvm::GlobalValue::WeakODRLinkage;
1324 if (Dtor->hasAttr<DLLImportAttr>())
1325 return llvm::GlobalValue::AvailableExternallyLinkage;
1326 return llvm::GlobalValue::LinkOnceODRLinkage;
1327 case Dtor_Deleting:
1328 // Deleting destructors are like inline functions. They have vague linkage
1329 // and are emitted everywhere they are used. They are internal if the class
1330 // is internal.
1331 return llvm::GlobalValue::LinkOnceODRLinkage;
1332 case Dtor_Comdat:
1333 llvm_unreachable("MS C++ ABI does not support comdat dtors");
1334 }
1335 llvm_unreachable("invalid dtor type");
1336}
1337
Reid Klecknere7de47e2013-07-22 13:51:44 +00001338void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1339 // The TU defining a dtor is only guaranteed to emit a base destructor. All
1340 // other destructor variants are delegating thunks.
1341 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1342}
1343
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001344CharUnits
1345MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001346 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001347
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001348 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1349 // Complete destructors take a pointer to the complete object as a
1350 // parameter, thus don't need this adjustment.
1351 if (GD.getDtorType() == Dtor_Complete)
1352 return CharUnits();
1353
1354 // There's no Dtor_Base in vftable but it shares the this adjustment with
1355 // the deleting one, so look it up instead.
Reid Kleckner138ab492018-05-17 18:12:18 +00001356 GD = GlobalDecl(DD, Dtor_Deleting);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001357 }
1358
Reid Klecknercbec0262018-04-02 20:00:39 +00001359 MethodVFTableLocation ML =
Reid Kleckner138ab492018-05-17 18:12:18 +00001360 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001361 CharUnits Adjustment = ML.VFPtrOffset;
1362
1363 // Normal virtual instance methods need to adjust from the vfptr that first
1364 // defined the virtual method to the virtual base subobject, but destructors
1365 // do not. The vector deleting destructor thunk applies this adjustment for
1366 // us if necessary.
1367 if (isa<CXXDestructorDecl>(MD))
1368 Adjustment = CharUnits::Zero();
1369
1370 if (ML.VBase) {
1371 const ASTRecordLayout &DerivedLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001372 getContext().getASTRecordLayout(MD->getParent());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001373 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1374 }
1375
1376 return Adjustment;
1377}
1378
John McCall7f416cc2015-09-08 08:05:57 +00001379Address MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1380 CodeGenFunction &CGF, GlobalDecl GD, Address This,
1381 bool VirtualCall) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001382 if (!VirtualCall) {
1383 // If the call of a virtual function is not virtual, we just have to
1384 // compensate for the adjustment the virtual function does in its prologue.
1385 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1386 if (Adjustment.isZero())
1387 return This;
1388
John McCall7f416cc2015-09-08 08:05:57 +00001389 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001390 assert(Adjustment.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001391 return CGF.Builder.CreateConstByteGEP(This, Adjustment);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001392 }
1393
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001394 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001395
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001396 GlobalDecl LookupGD = GD;
1397 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1398 // Complete dtors take a pointer to the complete object,
1399 // thus don't need adjustment.
1400 if (GD.getDtorType() == Dtor_Complete)
1401 return This;
1402
1403 // There's only Dtor_Deleting in vftable but it shares the this adjustment
1404 // with the base one, so look up the deleting one instead.
1405 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1406 }
Reid Klecknercbec0262018-04-02 20:00:39 +00001407 MethodVFTableLocation ML =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001408 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001409
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001410 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001411
1412 // Base destructors expect 'this' to point to the beginning of the base
1413 // subobject, not the first vfptr that happens to contain the virtual dtor.
1414 // However, we still need to apply the virtual base adjustment.
1415 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1416 StaticOffset = CharUnits::Zero();
1417
John McCall7f416cc2015-09-08 08:05:57 +00001418 Address Result = This;
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001419 if (ML.VBase) {
John McCall7f416cc2015-09-08 08:05:57 +00001420 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
Fangrui Song6907ce22018-07-30 19:24:48 +00001421
John McCall7f416cc2015-09-08 08:05:57 +00001422 const CXXRecordDecl *Derived = MD->getParent();
1423 const CXXRecordDecl *VBase = ML.VBase;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001424 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00001425 GetVirtualBaseClassOffset(CGF, Result, Derived, VBase);
1426 llvm::Value *VBasePtr =
1427 CGF.Builder.CreateInBoundsGEP(Result.getPointer(), VBaseOffset);
1428 CharUnits VBaseAlign =
1429 CGF.CGM.getVBaseAlignment(Result.getAlignment(), Derived, VBase);
1430 Result = Address(VBasePtr, VBaseAlign);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001431 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001432 if (!StaticOffset.isZero()) {
1433 assert(StaticOffset.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001434 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001435 if (ML.VBase) {
1436 // Non-virtual adjustment might result in a pointer outside the allocated
1437 // object, e.g. if the final overrider class is laid out after the virtual
1438 // base that declares a method in the most derived class.
1439 // FIXME: Update the code that emits this adjustment in thunks prologues.
John McCall7f416cc2015-09-08 08:05:57 +00001440 Result = CGF.Builder.CreateConstByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001441 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001442 Result = CGF.Builder.CreateConstInBoundsByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001443 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001444 }
John McCall7f416cc2015-09-08 08:05:57 +00001445 return Result;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001446}
1447
Reid Kleckner89077a12013-12-17 19:46:40 +00001448void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1449 QualType &ResTy,
1450 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001451 ASTContext &Context = getContext();
1452 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001453 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001454 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
Alexey Bataev56223232017-06-09 13:40:18 +00001455 auto *IsMostDerived = ImplicitParamDecl::Create(
1456 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1457 &Context.Idents.get("is_most_derived"), Context.IntTy,
1458 ImplicitParamDecl::Other);
Reid Kleckner89077a12013-12-17 19:46:40 +00001459 // The 'most_derived' parameter goes second if the ctor is variadic and last
1460 // if it's not. Dtors can't be variadic.
1461 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1462 if (FPT->isVariadic())
1463 Params.insert(Params.begin() + 1, IsMostDerived);
1464 else
1465 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001466 getStructorImplicitParamDecl(CGF) = IsMostDerived;
David Majnemer0c0b6d92014-10-31 20:09:12 +00001467 } else if (isDeletingDtor(CGF.CurGD)) {
Alexey Bataev56223232017-06-09 13:40:18 +00001468 auto *ShouldDelete = ImplicitParamDecl::Create(
1469 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1470 &Context.Idents.get("should_call_delete"), Context.IntTy,
1471 ImplicitParamDecl::Other);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001472 Params.push_back(ShouldDelete);
1473 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1474 }
John McCall0f999f32012-09-25 08:00:39 +00001475}
1476
1477void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
Justin Lebared4f1722016-07-27 22:04:24 +00001478 // Naked functions have no prolog.
1479 if (CGF.CurFuncDecl && CGF.CurFuncDecl->hasAttr<NakedAttr>())
1480 return;
1481
Reid Kleckner06239e42017-11-16 19:09:36 +00001482 // Overridden virtual methods of non-primary bases need to adjust the incoming
1483 // 'this' pointer in the prologue. In this hierarchy, C::b will subtract
1484 // sizeof(void*) to adjust from B* to C*:
1485 // struct A { virtual void a(); };
1486 // struct B { virtual void b(); };
1487 // struct C : A, B { virtual void b(); };
1488 //
1489 // Leave the value stored in the 'this' alloca unadjusted, so that the
1490 // debugger sees the unadjusted value. Microsoft debuggers require this, and
1491 // will apply the ThisAdjustment in the method type information.
1492 // FIXME: Do something better for DWARF debuggers, which won't expect this,
1493 // without making our codegen depend on debug info settings.
1494 llvm::Value *This = loadIncomingCXXThis(CGF);
1495 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1496 if (!CGF.CurFuncIsThunk && MD->isVirtual()) {
1497 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(CGF.CurGD);
1498 if (!Adjustment.isZero()) {
1499 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1500 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1501 *thisTy = This->getType();
1502 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1503 assert(Adjustment.isPositive());
1504 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
1505 -Adjustment.getQuantity());
1506 This = CGF.Builder.CreateBitCast(This, thisTy, "this.adjusted");
1507 }
1508 }
1509 setCXXABIThisValue(CGF, This);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001510
Reid Kleckner06239e42017-11-16 19:09:36 +00001511 // If this is a function that the ABI specifies returns 'this', initialize
1512 // the return slot to 'this' at the start of the function.
1513 //
1514 // Unlike the setting of return types, this is done within the ABI
1515 // implementation instead of by clients of CGCXXABI because:
1516 // 1) getThisValue is currently protected
1517 // 2) in theory, an ABI could implement 'this' returns some other way;
1518 // HasThisReturn only specifies a contract, not the implementation
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001519 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001520 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001521 else if (hasMostDerivedReturn(CGF.CurGD))
1522 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1523 CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001524
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001525 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1526 assert(getStructorImplicitParamDecl(CGF) &&
1527 "no implicit parameter for a constructor with virtual bases?");
1528 getStructorImplicitParamValue(CGF)
1529 = CGF.Builder.CreateLoad(
1530 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1531 "is_most_derived");
1532 }
1533
David Majnemer0c0b6d92014-10-31 20:09:12 +00001534 if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001535 assert(getStructorImplicitParamDecl(CGF) &&
1536 "no implicit parameter for a deleting destructor?");
1537 getStructorImplicitParamValue(CGF)
1538 = CGF.Builder.CreateLoad(
1539 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1540 "should_call_delete");
1541 }
John McCall0f999f32012-09-25 08:00:39 +00001542}
1543
George Burgess IVf203dbf2017-02-22 20:28:02 +00001544CGCXXABI::AddedStructorArgs MicrosoftCXXABI::addImplicitConstructorArgs(
Reid Kleckner89077a12013-12-17 19:46:40 +00001545 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1546 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001547 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001548
Reid Kleckner89077a12013-12-17 19:46:40 +00001549 // Check if we need a 'most_derived' parameter.
1550 if (!D->getParent()->getNumVBases())
George Burgess IVf203dbf2017-02-22 20:28:02 +00001551 return AddedStructorArgs{};
Reid Kleckner89077a12013-12-17 19:46:40 +00001552
1553 // Add the 'most_derived' argument second if we are variadic or last if not.
1554 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
David Majnemer833b91e2016-05-13 20:05:09 +00001555 llvm::Value *MostDerivedArg;
1556 if (Delegating) {
1557 MostDerivedArg = getStructorImplicitParamValue(CGF);
1558 } else {
1559 MostDerivedArg = llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001560 }
David Majnemer833b91e2016-05-13 20:05:09 +00001561 RValue RV = RValue::get(MostDerivedArg);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001562 if (FPT->isVariadic()) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001563 Args.insert(Args.begin() + 1, CallArg(RV, getContext().IntTy));
George Burgess IVf203dbf2017-02-22 20:28:02 +00001564 return AddedStructorArgs::prefix(1);
1565 }
1566 Args.add(RV, getContext().IntTy);
1567 return AddedStructorArgs::suffix(1);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001568}
1569
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001570void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1571 const CXXDestructorDecl *DD,
1572 CXXDtorType Type, bool ForVirtualBase,
Marco Antognini88559632019-07-22 09:39:13 +00001573 bool Delegating, Address This,
1574 QualType ThisTy) {
Reid Klecknerae9b0702018-03-16 19:40:50 +00001575 // Use the base destructor variant in place of the complete destructor variant
1576 // if the class has no virtual bases. This effectively implements some of the
1577 // -mconstructor-aliases optimization, but as part of the MS C++ ABI.
1578 if (Type == Dtor_Complete && DD->getParent()->getNumVBases() == 0)
1579 Type = Dtor_Base;
1580
Peter Collingbourned1c5b282019-03-22 23:05:10 +00001581 GlobalDecl GD(DD, Type);
1582 CGCallee Callee = CGCallee::forDirect(CGM.getAddrOfCXXStructor(GD), GD);
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001583
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001584 if (DD->isVirtual()) {
1585 assert(Type != CXXDtorType::Dtor_Deleting &&
1586 "The deleting destructor should only be called via a virtual call");
1587 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1588 This, false);
1589 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001590
Erich Keane13c7ec52016-12-07 00:21:45 +00001591 llvm::BasicBlock *BaseDtorEndBB = nullptr;
1592 if (ForVirtualBase && isa<CXXConstructorDecl>(CGF.CurCodeDecl)) {
1593 BaseDtorEndBB = EmitDtorCompleteObjectHandler(CGF);
Fangrui Song6907ce22018-07-30 19:24:48 +00001594 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001595
Marco Antognini88559632019-07-22 09:39:13 +00001596 CGF.EmitCXXDestructorCall(GD, Callee, This.getPointer(), ThisTy,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001597 /*ImplicitParam=*/nullptr,
Peter Collingbourned1c5b282019-03-22 23:05:10 +00001598 /*ImplicitParamTy=*/QualType(), nullptr);
Erich Keane13c7ec52016-12-07 00:21:45 +00001599 if (BaseDtorEndBB) {
Fangrui Song6907ce22018-07-30 19:24:48 +00001600 // Complete object handler should continue to be the remaining
Erich Keane13c7ec52016-12-07 00:21:45 +00001601 CGF.Builder.CreateBr(BaseDtorEndBB);
1602 CGF.EmitBlock(BaseDtorEndBB);
Fangrui Song6907ce22018-07-30 19:24:48 +00001603 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001604}
1605
Justin Lebar562914e2016-10-10 16:26:29 +00001606void MicrosoftCXXABI::emitVTableTypeMetadata(const VPtrInfo &Info,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001607 const CXXRecordDecl *RD,
1608 llvm::GlobalVariable *VTable) {
Peter Collingbourne1e1475a2017-01-18 23:55:27 +00001609 if (!CGM.getCodeGenOpts().LTOUnit)
Peter Collingbourned9546012015-06-19 02:30:43 +00001610 return;
1611
Peter Collingbournee5706442015-07-09 19:56:14 +00001612 // The location of the first virtual function pointer in the virtual table,
1613 // aka the "address point" on Itanium. This is at offset 0 if RTTI is
1614 // disabled, or sizeof(void*) if RTTI is enabled.
1615 CharUnits AddressPoint =
1616 getContext().getLangOpts().RTTIData
1617 ? getContext().toCharUnitsFromBits(
1618 getContext().getTargetInfo().getPointerWidth(0))
1619 : CharUnits::Zero();
Peter Collingbourned9546012015-06-19 02:30:43 +00001620
Justin Lebar562914e2016-10-10 16:26:29 +00001621 if (Info.PathToIntroducingObject.empty()) {
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001622 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001623 return;
1624 }
1625
1626 // Add a bitset entry for the least derived base belonging to this vftable.
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001627 CGM.AddVTableTypeMetadata(VTable, AddressPoint,
Justin Lebar562914e2016-10-10 16:26:29 +00001628 Info.PathToIntroducingObject.back());
Peter Collingbourned9546012015-06-19 02:30:43 +00001629
1630 // Add a bitset entry for each derived class that is laid out at the same
1631 // offset as the least derived base.
Justin Lebar562914e2016-10-10 16:26:29 +00001632 for (unsigned I = Info.PathToIntroducingObject.size() - 1; I != 0; --I) {
1633 const CXXRecordDecl *DerivedRD = Info.PathToIntroducingObject[I - 1];
1634 const CXXRecordDecl *BaseRD = Info.PathToIntroducingObject[I];
Peter Collingbourned9546012015-06-19 02:30:43 +00001635
1636 const ASTRecordLayout &Layout =
1637 getContext().getASTRecordLayout(DerivedRD);
1638 CharUnits Offset;
1639 auto VBI = Layout.getVBaseOffsetsMap().find(BaseRD);
1640 if (VBI == Layout.getVBaseOffsetsMap().end())
1641 Offset = Layout.getBaseClassOffset(BaseRD);
1642 else
1643 Offset = VBI->second.VBaseOffset;
1644 if (!Offset.isZero())
1645 return;
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001646 CGM.AddVTableTypeMetadata(VTable, AddressPoint, DerivedRD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001647 }
1648
1649 // Finally do the same for the most derived class.
Justin Lebar562914e2016-10-10 16:26:29 +00001650 if (Info.FullOffsetInMDC.isZero())
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001651 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001652}
1653
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001654void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1655 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001656 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001657 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001658
Justin Lebar562914e2016-10-10 16:26:29 +00001659 for (const std::unique_ptr<VPtrInfo>& Info : VFPtrs) {
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001660 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001661 if (VTable->hasInitializer())
1662 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001663
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001664 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001665 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
David Majnemer470ee612016-02-09 17:27:52 +00001666
1667 llvm::Constant *RTTI = nullptr;
1668 if (any_of(VTLayout.vtable_components(),
1669 [](const VTableComponent &VTC) { return VTC.isRTTIKind(); }))
Justin Lebar562914e2016-10-10 16:26:29 +00001670 RTTI = getMSCompleteObjectLocator(RD, *Info);
David Majnemer470ee612016-02-09 17:27:52 +00001671
John McCall9c6cb762016-11-28 22:18:33 +00001672 ConstantInitBuilder Builder(CGM);
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001673 auto Components = Builder.beginStruct();
John McCall9c6cb762016-11-28 22:18:33 +00001674 CGVT.createVTableInitializer(Components, VTLayout, RTTI);
1675 Components.finishAndSetAsInitializer(VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +00001676
Justin Lebar562914e2016-10-10 16:26:29 +00001677 emitVTableTypeMetadata(*Info, RD, VTable);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001678 }
1679}
1680
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001681bool MicrosoftCXXABI::isVirtualOffsetNeededForVTableField(
1682 CodeGenFunction &CGF, CodeGenFunction::VPtr Vptr) {
1683 return Vptr.NearestVBase != nullptr;
1684}
1685
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001686llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1687 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001688 const CXXRecordDecl *NearestVBase) {
1689 llvm::Constant *VTableAddressPoint = getVTableAddressPoint(Base, VTableClass);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001690 if (!VTableAddressPoint) {
1691 assert(Base.getBase()->getNumVBases() &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001692 !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001693 }
1694 return VTableAddressPoint;
1695}
1696
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001697static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Justin Lebar562914e2016-10-10 16:26:29 +00001698 const CXXRecordDecl *RD, const VPtrInfo &VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001699 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001700 llvm::raw_svector_ostream Out(Name);
Justin Lebar562914e2016-10-10 16:26:29 +00001701 MangleContext.mangleCXXVFTable(RD, VFPtr.MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001702}
1703
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001704llvm::Constant *
1705MicrosoftCXXABI::getVTableAddressPoint(BaseSubobject Base,
1706 const CXXRecordDecl *VTableClass) {
Piotr Padlewski4bed31b2015-09-10 20:18:30 +00001707 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1708 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001709 return VFTablesMap[ID];
1710}
1711
1712llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1713 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1714 llvm::Constant *VFTable = getVTableAddressPoint(Base, VTableClass);
David Majnemerd905da42014-07-01 20:30:31 +00001715 assert(VFTable && "Couldn't find a vftable for the given base?");
1716 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001717}
1718
1719llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1720 CharUnits VPtrOffset) {
1721 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1722 // shouldn't be used in the given record type. We want to cache this result in
1723 // VFTablesMap, thus a simple zero check is not sufficient.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001724
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001725 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001726 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001727 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001728 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001729 if (!Inserted)
1730 return I->second;
1731
1732 llvm::GlobalVariable *&VTable = I->second;
1733
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001734 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001735 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001736
David Blaikie82e95a32014-11-19 07:49:47 +00001737 if (DeferredVFTables.insert(RD).second) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001738 // We haven't processed this record type before.
Eric Christopherd160c502016-01-29 01:35:53 +00001739 // Queue up this vtable for possible deferred emission.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001740 CGM.addDeferredVTable(RD);
1741
1742#ifndef NDEBUG
1743 // Create all the vftables at once in order to make sure each vftable has
1744 // a unique mangled name.
1745 llvm::StringSet<> ObservedMangledNames;
1746 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1747 SmallString<256> Name;
Justin Lebar562914e2016-10-10 16:26:29 +00001748 mangleVFTableName(getMangleContext(), RD, *VFPtrs[J], Name);
David Blaikie61b86d42014-11-19 02:56:13 +00001749 if (!ObservedMangledNames.insert(Name.str()).second)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001750 llvm_unreachable("Already saw this mangling before?");
1751 }
1752#endif
1753 }
1754
Justin Lebar562914e2016-10-10 16:26:29 +00001755 const std::unique_ptr<VPtrInfo> *VFPtrI = std::find_if(
1756 VFPtrs.begin(), VFPtrs.end(), [&](const std::unique_ptr<VPtrInfo>& VPI) {
David Majnemera03849b2015-03-18 22:04:43 +00001757 return VPI->FullOffsetInMDC == VPtrOffset;
1758 });
1759 if (VFPtrI == VFPtrs.end()) {
1760 VFTablesMap[ID] = nullptr;
1761 return nullptr;
1762 }
Justin Lebar562914e2016-10-10 16:26:29 +00001763 const std::unique_ptr<VPtrInfo> &VFPtr = *VFPtrI;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001764
David Majnemera03849b2015-03-18 22:04:43 +00001765 SmallString<256> VFTableName;
Justin Lebar562914e2016-10-10 16:26:29 +00001766 mangleVFTableName(getMangleContext(), RD, *VFPtr, VFTableName);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001767
David Majnemer2d8b2002016-02-11 17:49:28 +00001768 // Classes marked __declspec(dllimport) need vftables generated on the
1769 // import-side in order to support features like constexpr. No other
1770 // translation unit relies on the emission of the local vftable, translation
1771 // units are expected to generate them as needed.
1772 //
1773 // Because of this unique behavior, we maintain this logic here instead of
1774 // getVTableLinkage.
1775 llvm::GlobalValue::LinkageTypes VFTableLinkage =
1776 RD->hasAttr<DLLImportAttr>() ? llvm::GlobalValue::LinkOnceODRLinkage
1777 : CGM.getVTableLinkage(RD);
David Majnemera03849b2015-03-18 22:04:43 +00001778 bool VFTableComesFromAnotherTU =
1779 llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) ||
1780 llvm::GlobalValue::isExternalLinkage(VFTableLinkage);
1781 bool VTableAliasIsRequred =
1782 !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData;
David Majnemerbb848712014-07-01 22:37:08 +00001783
David Majnemera03849b2015-03-18 22:04:43 +00001784 if (llvm::GlobalValue *VFTable =
1785 CGM.getModule().getNamedGlobal(VFTableName)) {
1786 VFTablesMap[ID] = VFTable;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001787 VTable = VTableAliasIsRequred
1788 ? cast<llvm::GlobalVariable>(
1789 cast<llvm::GlobalAlias>(VFTable)->getBaseObject())
1790 : cast<llvm::GlobalVariable>(VFTable);
1791 return VTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001792 }
1793
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001794 const VTableLayout &VTLayout =
1795 VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC);
David Majnemera03849b2015-03-18 22:04:43 +00001796 llvm::GlobalValue::LinkageTypes VTableLinkage =
1797 VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage;
1798
1799 StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str();
1800
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001801 llvm::Type *VTableType = CGM.getVTables().getVTableType(VTLayout);
David Majnemera03849b2015-03-18 22:04:43 +00001802
1803 // Create a backing variable for the contents of VTable. The VTable may
1804 // or may not include space for a pointer to RTTI data.
1805 llvm::GlobalValue *VFTable;
1806 VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType,
1807 /*isConstant=*/true, VTableLinkage,
1808 /*Initializer=*/nullptr, VTableName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001809 VTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001810
1811 llvm::Comdat *C = nullptr;
1812 if (!VFTableComesFromAnotherTU &&
1813 (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) ||
1814 (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) &&
1815 VTableAliasIsRequred)))
1816 C = CGM.getModule().getOrInsertComdat(VFTableName.str());
1817
1818 // Only insert a pointer into the VFTable for RTTI data if we are not
1819 // importing it. We never reference the RTTI data directly so there is no
1820 // need to make room for it.
1821 if (VTableAliasIsRequred) {
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001822 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.Int32Ty, 0),
1823 llvm::ConstantInt::get(CGM.Int32Ty, 0),
1824 llvm::ConstantInt::get(CGM.Int32Ty, 1)};
David Majnemera03849b2015-03-18 22:04:43 +00001825 // Create a GEP which points just after the first entry in the VFTable,
1826 // this should be the location of the first virtual method.
David Blaikiee3b172a2015-04-02 18:55:21 +00001827 llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr(
1828 VTable->getValueType(), VTable, GEPIndices);
David Majnemera03849b2015-03-18 22:04:43 +00001829 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) {
1830 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1831 if (C)
1832 C->setSelectionKind(llvm::Comdat::Largest);
1833 }
David Blaikie2a791d72015-09-14 18:38:22 +00001834 VFTable = llvm::GlobalAlias::create(CGM.Int8PtrTy,
1835 /*AddressSpace=*/0, VFTableLinkage,
1836 VFTableName.str(), VTableGEP,
1837 &CGM.getModule());
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001838 VFTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001839 } else {
1840 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1841 // be referencing any RTTI data.
1842 // The GlobalVariable will end up being an appropriate definition of the
1843 // VFTable.
1844 VFTable = VTable;
1845 }
1846 if (C)
1847 VTable->setComdat(C);
1848
David Majnemer2d8b2002016-02-11 17:49:28 +00001849 if (RD->hasAttr<DLLExportAttr>())
David Majnemera03849b2015-03-18 22:04:43 +00001850 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1851
1852 VFTablesMap[ID] = VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001853 return VTable;
1854}
1855
John McCall9831b842018-02-06 18:52:44 +00001856CGCallee MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1857 GlobalDecl GD,
1858 Address This,
1859 llvm::Type *Ty,
1860 SourceLocation Loc) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001861 CGBuilderTy &Builder = CGF.Builder;
1862
1863 Ty = Ty->getPointerTo()->getPointerTo();
John McCall7f416cc2015-09-08 08:05:57 +00001864 Address VPtr =
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001865 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001866
1867 auto *MethodDecl = cast<CXXMethodDecl>(GD.getDecl());
1868 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty, MethodDecl->getParent());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001869
David Majnemer07c915e2016-10-27 17:11:51 +00001870 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Reid Klecknercbec0262018-04-02 20:00:39 +00001871 MethodVFTableLocation ML = VFTContext.getMethodVFTableLocation(GD);
David Majnemer07c915e2016-10-27 17:11:51 +00001872
1873 // Compute the identity of the most derived class whose virtual table is
1874 // located at the MethodVFTableLocation ML.
1875 auto getObjectWithVPtr = [&] {
1876 return llvm::find_if(VFTContext.getVFPtrOffsets(
1877 ML.VBase ? ML.VBase : MethodDecl->getParent()),
1878 [&](const std::unique_ptr<VPtrInfo> &Info) {
1879 return Info->FullOffsetInMDC == ML.VFPtrOffset;
1880 })
1881 ->get()
1882 ->ObjectWithVPtr;
1883 };
Peter Collingbourned9546012015-06-19 02:30:43 +00001884
John McCall9831b842018-02-06 18:52:44 +00001885 llvm::Value *VFunc;
1886 if (CGF.ShouldEmitVTableTypeCheckedLoad(MethodDecl->getParent())) {
1887 VFunc = CGF.EmitVTableTypeCheckedLoad(
David Majnemer07c915e2016-10-27 17:11:51 +00001888 getObjectWithVPtr(), VTable,
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001889 ML.Index * CGM.getContext().getTargetInfo().getPointerWidth(0) / 8);
John McCall9831b842018-02-06 18:52:44 +00001890 } else {
1891 if (CGM.getCodeGenOpts().PrepareForLTO)
1892 CGF.EmitTypeMetadataCodeForVCall(getObjectWithVPtr(), VTable, Loc);
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001893
John McCall9831b842018-02-06 18:52:44 +00001894 llvm::Value *VFuncPtr =
1895 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1896 VFunc = Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
1897 }
John McCallb92ab1a2016-10-26 23:46:34 +00001898
Erich Keanede6480a32018-11-13 15:48:08 +00001899 CGCallee Callee(GD, VFunc);
John McCall9831b842018-02-06 18:52:44 +00001900 return Callee;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001901}
1902
David Majnemer0c0b6d92014-10-31 20:09:12 +00001903llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1904 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
Marco Antognini88559632019-07-22 09:39:13 +00001905 Address This, DeleteOrMemberCallExpr E) {
1906 auto *CE = E.dyn_cast<const CXXMemberCallExpr *>();
1907 auto *D = E.dyn_cast<const CXXDeleteExpr *>();
1908 assert((CE != nullptr) ^ (D != nullptr));
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001909 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001910 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1911
1912 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001913 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001914 GlobalDecl GD(Dtor, Dtor_Deleting);
Peter Collingbourned1c5b282019-03-22 23:05:10 +00001915 const CGFunctionInfo *FInfo =
1916 &CGM.getTypes().arrangeCXXStructorDeclaration(GD);
George Burgess IV00f70bd2018-03-01 05:43:23 +00001917 llvm::FunctionType *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Peter Collingbourneea211002018-02-05 23:09:13 +00001918 CGCallee Callee = CGCallee::forVirtual(CE, GD, This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001919
David Majnemer9ced3dd2015-03-14 23:44:48 +00001920 ASTContext &Context = getContext();
Nico Weber0a029922015-01-12 21:24:10 +00001921 llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1922 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1923 DtorType == Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001924
Marco Antognini88559632019-07-22 09:39:13 +00001925 QualType ThisTy;
1926 if (CE) {
1927 ThisTy = CE->getObjectType();
1928 } else {
1929 ThisTy = D->getDestroyedType();
1930 }
1931
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001932 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Marco Antognini88559632019-07-22 09:39:13 +00001933 RValue RV = CGF.EmitCXXDestructorCall(GD, Callee, This.getPointer(), ThisTy,
Peter Collingbourned1c5b282019-03-22 23:05:10 +00001934 ImplicitParam, Context.IntTy, CE);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001935 return RV.getScalarVal();
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001936}
1937
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001938const VBTableGlobals &
1939MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001940 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001941 // easier than caching each vbtable individually.
1942 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1943 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001944 std::tie(Entry, Added) =
1945 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001946 VBTableGlobals &VBGlobals = Entry->second;
1947 if (!Added)
1948 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001949
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001950 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1951 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001952
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001953 // Cache the globals for all vbtables so we don't have to recompute the
1954 // mangled names.
1955 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001956 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1957 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001958 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001959 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001960 }
1961
1962 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001963}
1964
Reid Klecknercbec0262018-04-02 20:00:39 +00001965llvm::Function *
1966MicrosoftCXXABI::EmitVirtualMemPtrThunk(const CXXMethodDecl *MD,
1967 const MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001968 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1969 "can't form pointers to ctors or virtual dtors");
1970
Reid Klecknere4a52202014-02-21 02:27:32 +00001971 // Calculate the mangled name.
1972 SmallString<256> ThunkName;
1973 llvm::raw_svector_ostream Out(ThunkName);
Reid Klecknercbec0262018-04-02 20:00:39 +00001974 getMangleContext().mangleVirtualMemPtrThunk(MD, ML, Out);
Reid Klecknere4a52202014-02-21 02:27:32 +00001975
Hans Wennborg88497d62013-11-15 17:24:45 +00001976 // If the thunk has been generated previously, just return it.
1977 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1978 return cast<llvm::Function>(GV);
1979
1980 // Create the llvm::Function.
Reid Kleckner399d96e2018-04-02 20:20:33 +00001981 const CGFunctionInfo &FnInfo =
1982 CGM.getTypes().arrangeUnprototypedMustTailThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00001983 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1984 llvm::Function *ThunkFn =
1985 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1986 ThunkName.str(), &CGM.getModule());
1987 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1988
Hans Wennborg88497d62013-11-15 17:24:45 +00001989 ThunkFn->setLinkage(MD->isExternallyVisible()
1990 ? llvm::GlobalValue::LinkOnceODRLinkage
1991 : llvm::GlobalValue::InternalLinkage);
David Majnemer8c9cdb62015-01-21 01:21:31 +00001992 if (MD->isExternallyVisible())
1993 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
Hans Wennborg88497d62013-11-15 17:24:45 +00001994
1995 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1996 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1997
Reid Kleckner9da94482015-01-21 22:18:17 +00001998 // Add the "thunk" attribute so that LLVM knows that the return type is
1999 // meaningless. These thunks can be used to call functions with differing
2000 // return types, and the caller is required to cast the prototype
2001 // appropriately to extract the correct value.
2002 ThunkFn->addFnAttr("thunk");
2003
Reid Klecknerb9538a62014-08-15 18:12:40 +00002004 // These thunks can be compared, so they are not unnamed.
Peter Collingbournebcf909d2016-06-14 21:02:05 +00002005 ThunkFn->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::None);
Reid Klecknerb9538a62014-08-15 18:12:40 +00002006
Hans Wennborg88497d62013-11-15 17:24:45 +00002007 // Start codegen.
2008 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00002009 CGF.CurGD = GlobalDecl(MD);
2010 CGF.CurFuncIsThunk = true;
2011
2012 // Build FunctionArgs, but only include the implicit 'this' parameter
2013 // declaration.
2014 FunctionArgList FunctionArgs;
2015 buildThisParam(CGF, FunctionArgs);
2016
2017 // Start defining the function.
2018 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
2019 FunctionArgs, MD->getLocation(), SourceLocation());
Reid Kleckner06239e42017-11-16 19:09:36 +00002020 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
Hans Wennborg88497d62013-11-15 17:24:45 +00002021
Reid Klecknere4a52202014-02-21 02:27:32 +00002022 // Load the vfptr and then callee from the vftable. The callee should have
2023 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00002024 llvm::Value *VTable = CGF.GetVTablePtr(
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002025 getThisAddress(CGF), ThunkTy->getPointerTo()->getPointerTo(), MD->getParent());
2026
Reid Klecknere4a52202014-02-21 02:27:32 +00002027 llvm::Value *VFuncPtr =
2028 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
John McCall7f416cc2015-09-08 08:05:57 +00002029 llvm::Value *Callee =
2030 CGF.Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
Hans Wennborg88497d62013-11-15 17:24:45 +00002031
James Y Knight76f78742019-02-05 19:17:50 +00002032 CGF.EmitMustTailThunk(MD, getThisValue(CGF), {ThunkTy, Callee});
Hans Wennborg88497d62013-11-15 17:24:45 +00002033
2034 return ThunkFn;
2035}
2036
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002037void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002038 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
2039 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00002040 const std::unique_ptr<VPtrInfo>& VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002041 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
David Majnemer129f4172015-02-02 10:22:20 +00002042 if (GV->isDeclaration())
2043 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00002044 }
2045}
2046
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002047llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002048MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002049 llvm::GlobalVariable::LinkageTypes Linkage) {
2050 SmallString<256> OutName;
2051 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00002052 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002053 StringRef Name = OutName.str();
2054
2055 llvm::ArrayType *VBTableType =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002056 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ObjectWithVPtr->getNumVBases());
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002057
2058 assert(!CGM.getModule().getNamedGlobal(Name) &&
2059 "vbtable with this name already exists: mangling bug?");
David Greenbe0c5b62018-09-12 14:09:06 +00002060 CharUnits Alignment =
2061 CGM.getContext().getTypeAlignInChars(CGM.getContext().IntTy);
2062 llvm::GlobalVariable *GV = CGM.CreateOrReplaceCXXRuntimeVariable(
2063 Name, VBTableType, Linkage, Alignment.getQuantity());
Peter Collingbournebcf909d2016-06-14 21:02:05 +00002064 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Hans Wennborg853ae942014-05-30 16:59:42 +00002065
2066 if (RD->hasAttr<DLLImportAttr>())
2067 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
2068 else if (RD->hasAttr<DLLExportAttr>())
2069 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
2070
David Majnemer129f4172015-02-02 10:22:20 +00002071 if (!GV->hasExternalLinkage())
2072 emitVBTableDefinition(VBT, RD, GV);
2073
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002074 return GV;
2075}
2076
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002077void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002078 const CXXRecordDecl *RD,
2079 llvm::GlobalVariable *GV) const {
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002080 const CXXRecordDecl *ObjectWithVPtr = VBT.ObjectWithVPtr;
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002081
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002082 assert(RD->getNumVBases() && ObjectWithVPtr->getNumVBases() &&
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002083 "should only emit vbtables for classes with vbtables");
2084
2085 const ASTRecordLayout &BaseLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002086 getContext().getASTRecordLayout(VBT.IntroducingObject);
David Majnemer9ced3dd2015-03-14 23:44:48 +00002087 const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002088
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002089 SmallVector<llvm::Constant *, 4> Offsets(1 + ObjectWithVPtr->getNumVBases(),
Craig Topper8a13c412014-05-21 05:09:00 +00002090 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002091
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002092 // The offset from ObjectWithVPtr's vbptr to itself always leads.
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002093 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
2094 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
2095
2096 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002097 for (const auto &I : ObjectWithVPtr->vbases()) {
Aaron Ballman445a9392014-03-13 16:15:17 +00002098 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002099 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
2100 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00002101
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002102 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00002103 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002104 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00002105 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002106 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00002107 Offset -= CompleteVBPtrOffset;
2108
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002109 unsigned VBIndex = Context.getVBTableIndex(ObjectWithVPtr, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00002110 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002111 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
2112 }
2113
2114 assert(Offsets.size() ==
2115 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
2116 ->getElementType())->getNumElements());
2117 llvm::ArrayType *VBTableType =
2118 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
2119 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
2120 GV->setInitializer(Init);
David Majnemer46e39cc2016-02-22 17:22:08 +00002121
2122 if (RD->hasAttr<DLLImportAttr>())
2123 GV->setLinkage(llvm::GlobalVariable::AvailableExternallyLinkage);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002124}
2125
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002126llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002127 Address This,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002128 const ThisAdjustment &TA) {
2129 if (TA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002130 return This.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002131
John McCall7f416cc2015-09-08 08:05:57 +00002132 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002133
John McCall7f416cc2015-09-08 08:05:57 +00002134 llvm::Value *V;
2135 if (TA.Virtual.isEmpty()) {
2136 V = This.getPointer();
2137 } else {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002138 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
2139 // Adjust the this argument based on the vtordisp value.
John McCall7f416cc2015-09-08 08:05:57 +00002140 Address VtorDispPtr =
2141 CGF.Builder.CreateConstInBoundsByteGEP(This,
2142 CharUnits::fromQuantity(TA.Virtual.Microsoft.VtordispOffset));
2143 VtorDispPtr = CGF.Builder.CreateElementBitCast(VtorDispPtr, CGF.Int32Ty);
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002144 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
John McCall7f416cc2015-09-08 08:05:57 +00002145 V = CGF.Builder.CreateGEP(This.getPointer(),
2146 CGF.Builder.CreateNeg(VtorDisp));
2147
2148 // Unfortunately, having applied the vtordisp means that we no
2149 // longer really have a known alignment for the vbptr step.
2150 // We'll assume the vbptr is pointer-aligned.
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002151
2152 if (TA.Virtual.Microsoft.VBPtrOffset) {
2153 // If the final overrider is defined in a virtual base other than the one
2154 // that holds the vfptr, we have to use a vtordispex thunk which looks up
2155 // the vbtable of the derived class.
2156 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
2157 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
2158 llvm::Value *VBPtr;
2159 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002160 GetVBaseOffsetFromVBPtr(CGF, Address(V, CGF.getPointerAlign()),
2161 -TA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002162 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
2163 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2164 }
2165 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002166
2167 if (TA.NonVirtual) {
2168 // Non-virtual adjustment might result in a pointer outside the allocated
2169 // object, e.g. if the final overrider class is laid out after the virtual
2170 // base that declares a method in the most derived class.
2171 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
2172 }
2173
2174 // Don't need to bitcast back, the call CodeGen will handle this.
2175 return V;
2176}
2177
2178llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00002179MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002180 const ReturnAdjustment &RA) {
2181 if (RA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002182 return Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002183
John McCall7f416cc2015-09-08 08:05:57 +00002184 auto OrigTy = Ret.getType();
2185 Ret = CGF.Builder.CreateElementBitCast(Ret, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002186
John McCall7f416cc2015-09-08 08:05:57 +00002187 llvm::Value *V = Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002188 if (RA.Virtual.Microsoft.VBIndex) {
2189 assert(RA.Virtual.Microsoft.VBIndex > 0);
John McCall7f416cc2015-09-08 08:05:57 +00002190 int32_t IntSize = CGF.getIntSize().getQuantity();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002191 llvm::Value *VBPtr;
2192 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002193 GetVBaseOffsetFromVBPtr(CGF, Ret, RA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002194 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
2195 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2196 }
2197
2198 if (RA.NonVirtual)
David Blaikiefb901c7a2015-04-04 15:12:29 +00002199 V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002200
2201 // Cast back to the original type.
John McCall7f416cc2015-09-08 08:05:57 +00002202 return CGF.Builder.CreateBitCast(V, OrigTy);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002203}
2204
John McCallb91cd662012-05-01 05:23:51 +00002205bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
2206 QualType elementType) {
2207 // Microsoft seems to completely ignore the possibility of a
2208 // two-argument usual deallocation function.
2209 return elementType.isDestructedType();
2210}
2211
2212bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
2213 // Microsoft seems to completely ignore the possibility of a
2214 // two-argument usual deallocation function.
2215 return expr->getAllocatedType().isDestructedType();
2216}
2217
2218CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
2219 // The array cookie is always a size_t; we then pad that out to the
2220 // alignment of the element type.
2221 ASTContext &Ctx = getContext();
2222 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
2223 Ctx.getTypeAlignInChars(type));
2224}
2225
2226llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002227 Address allocPtr,
John McCallb91cd662012-05-01 05:23:51 +00002228 CharUnits cookieSize) {
John McCall7f416cc2015-09-08 08:05:57 +00002229 Address numElementsPtr =
2230 CGF.Builder.CreateElementBitCast(allocPtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002231 return CGF.Builder.CreateLoad(numElementsPtr);
2232}
2233
John McCall7f416cc2015-09-08 08:05:57 +00002234Address MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
2235 Address newPtr,
2236 llvm::Value *numElements,
2237 const CXXNewExpr *expr,
2238 QualType elementType) {
John McCallb91cd662012-05-01 05:23:51 +00002239 assert(requiresArrayCookie(expr));
2240
2241 // The size of the cookie.
2242 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
2243
2244 // Compute an offset to the cookie.
John McCall7f416cc2015-09-08 08:05:57 +00002245 Address cookiePtr = newPtr;
John McCallb91cd662012-05-01 05:23:51 +00002246
2247 // Write the number of elements into the appropriate slot.
John McCall7f416cc2015-09-08 08:05:57 +00002248 Address numElementsPtr
2249 = CGF.Builder.CreateElementBitCast(cookiePtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002250 CGF.Builder.CreateStore(numElements, numElementsPtr);
2251
2252 // Finally, compute a pointer to the actual data buffer by skipping
2253 // over the cookie completely.
John McCall7f416cc2015-09-08 08:05:57 +00002254 return CGF.Builder.CreateConstInBoundsByteGEP(newPtr, cookieSize);
John McCallb91cd662012-05-01 05:23:51 +00002255}
2256
David Majnemerb3341ea2014-10-05 05:05:40 +00002257static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
James Y Knightf7321542019-02-07 01:14:17 +00002258 llvm::FunctionCallee Dtor,
David Majnemerb3341ea2014-10-05 05:05:40 +00002259 llvm::Constant *Addr) {
2260 // Create a function which calls the destructor.
2261 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
2262
2263 // extern "C" int __tlregdtor(void (*f)(void));
2264 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
Rui Ueyama49a3ad22019-07-16 04:46:31 +00002265 CGF.IntTy, DtorStub->getType(), /*isVarArg=*/false);
David Majnemerb3341ea2014-10-05 05:05:40 +00002266
James Y Knight9871db02019-02-05 16:42:33 +00002267 llvm::FunctionCallee TLRegDtor = CGF.CGM.CreateRuntimeFunction(
Reid Klecknerde864822017-03-21 16:57:30 +00002268 TLRegDtorTy, "__tlregdtor", llvm::AttributeList(), /*Local=*/true);
James Y Knight9871db02019-02-05 16:42:33 +00002269 if (llvm::Function *TLRegDtorFn =
2270 dyn_cast<llvm::Function>(TLRegDtor.getCallee()))
David Majnemerb3341ea2014-10-05 05:05:40 +00002271 TLRegDtorFn->setDoesNotThrow();
2272
2273 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
2274}
2275
2276void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
James Y Knightf7321542019-02-07 01:14:17 +00002277 llvm::FunctionCallee Dtor,
David Majnemerb3341ea2014-10-05 05:05:40 +00002278 llvm::Constant *Addr) {
Erik Pilkington5a559e62018-08-21 17:24:06 +00002279 if (D.isNoDestroy(CGM.getContext()))
2280 return;
2281
David Majnemerb3341ea2014-10-05 05:05:40 +00002282 if (D.getTLSKind())
2283 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
2284
2285 // The default behavior is to use atexit.
2286 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
2287}
2288
2289void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +00002290 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +00002291 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +00002292 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) {
David Majnemercb60a432016-09-12 02:51:43 +00002293 if (CXXThreadLocalInits.empty())
2294 return;
2295
2296 CGM.AppendLinkerOptions(CGM.getTarget().getTriple().getArch() ==
2297 llvm::Triple::x86
2298 ? "/include:___dyn_tls_init@12"
2299 : "/include:__dyn_tls_init");
2300
David Majnemerb3341ea2014-10-05 05:05:40 +00002301 // This will create a GV in the .CRT$XDU section. It will point to our
2302 // initialization function. The CRT will call all of these function
2303 // pointers at start-up time and, eventually, at thread-creation time.
2304 auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
2305 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
Rui Ueyama49a3ad22019-07-16 04:46:31 +00002306 CGM.getModule(), InitFunc->getType(), /*isConstant=*/true,
David Majnemerb3341ea2014-10-05 05:05:40 +00002307 llvm::GlobalVariable::InternalLinkage, InitFunc,
2308 Twine(InitFunc->getName(), "$initializer$"));
2309 InitFuncPtr->setSection(".CRT$XDU");
2310 // This variable has discardable linkage, we have to add it to @llvm.used to
2311 // ensure it won't get discarded.
2312 CGM.addUsedGlobal(InitFuncPtr);
2313 return InitFuncPtr;
2314 };
2315
2316 std::vector<llvm::Function *> NonComdatInits;
2317 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
Richard Smith5a99c492015-12-01 01:10:48 +00002318 llvm::GlobalVariable *GV = cast<llvm::GlobalVariable>(
2319 CGM.GetGlobalValue(CGM.getMangledName(CXXThreadLocalInitVars[I])));
David Majnemerb3341ea2014-10-05 05:05:40 +00002320 llvm::Function *F = CXXThreadLocalInits[I];
2321
2322 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002323 if (llvm::Comdat *C = GV->getComdat())
David Majnemerb3341ea2014-10-05 05:05:40 +00002324 AddToXDU(F)->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002325 else
David Majnemerb3341ea2014-10-05 05:05:40 +00002326 NonComdatInits.push_back(F);
David Majnemerb3341ea2014-10-05 05:05:40 +00002327 }
2328
2329 if (!NonComdatInits.empty()) {
2330 llvm::FunctionType *FTy =
2331 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002332 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +00002333 FTy, "__tls_init", CGM.getTypes().arrangeNullaryFunction(),
2334 SourceLocation(), /*TLS=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002335 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2336
2337 AddToXDU(InitFunc);
2338 }
2339}
2340
2341LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2342 const VarDecl *VD,
2343 QualType LValType) {
2344 CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2345 return LValue();
2346}
2347
John McCall7f416cc2015-09-08 08:05:57 +00002348static ConstantAddress getInitThreadEpochPtr(CodeGenModule &CGM) {
David Majnemer8354eee2015-05-07 06:15:46 +00002349 StringRef VarName("_Init_thread_epoch");
John McCall7f416cc2015-09-08 08:05:57 +00002350 CharUnits Align = CGM.getIntAlign();
David Majnemer8354eee2015-05-07 06:15:46 +00002351 if (auto *GV = CGM.getModule().getNamedGlobal(VarName))
John McCall7f416cc2015-09-08 08:05:57 +00002352 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002353 auto *GV = new llvm::GlobalVariable(
2354 CGM.getModule(), CGM.IntTy,
Rui Ueyama49a3ad22019-07-16 04:46:31 +00002355 /*isConstant=*/false, llvm::GlobalVariable::ExternalLinkage,
David Majnemer8354eee2015-05-07 06:15:46 +00002356 /*Initializer=*/nullptr, VarName,
2357 /*InsertBefore=*/nullptr, llvm::GlobalVariable::GeneralDynamicTLSModel);
Guillaume Chateletc79099e2019-10-03 13:00:29 +00002358 GV->setAlignment(Align.getAsAlign());
John McCall7f416cc2015-09-08 08:05:57 +00002359 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002360}
2361
James Y Knight9871db02019-02-05 16:42:33 +00002362static llvm::FunctionCallee getInitThreadHeaderFn(CodeGenModule &CGM) {
David Majnemer8354eee2015-05-07 06:15:46 +00002363 llvm::FunctionType *FTy =
2364 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2365 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2366 return CGM.CreateRuntimeFunction(
2367 FTy, "_Init_thread_header",
Reid Klecknerde864822017-03-21 16:57:30 +00002368 llvm::AttributeList::get(CGM.getLLVMContext(),
2369 llvm::AttributeList::FunctionIndex,
2370 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002371 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002372}
2373
James Y Knight9871db02019-02-05 16:42:33 +00002374static llvm::FunctionCallee getInitThreadFooterFn(CodeGenModule &CGM) {
David Majnemer8354eee2015-05-07 06:15:46 +00002375 llvm::FunctionType *FTy =
2376 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2377 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2378 return CGM.CreateRuntimeFunction(
2379 FTy, "_Init_thread_footer",
Reid Klecknerde864822017-03-21 16:57:30 +00002380 llvm::AttributeList::get(CGM.getLLVMContext(),
2381 llvm::AttributeList::FunctionIndex,
2382 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002383 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002384}
2385
James Y Knight9871db02019-02-05 16:42:33 +00002386static llvm::FunctionCallee getInitThreadAbortFn(CodeGenModule &CGM) {
David Majnemer8354eee2015-05-07 06:15:46 +00002387 llvm::FunctionType *FTy =
2388 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2389 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2390 return CGM.CreateRuntimeFunction(
2391 FTy, "_Init_thread_abort",
Reid Klecknerde864822017-03-21 16:57:30 +00002392 llvm::AttributeList::get(CGM.getLLVMContext(),
2393 llvm::AttributeList::FunctionIndex,
2394 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002395 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002396}
2397
2398namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002399struct ResetGuardBit final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002400 Address Guard;
David Majnemer8354eee2015-05-07 06:15:46 +00002401 unsigned GuardNum;
John McCall7f416cc2015-09-08 08:05:57 +00002402 ResetGuardBit(Address Guard, unsigned GuardNum)
David Majnemer8354eee2015-05-07 06:15:46 +00002403 : Guard(Guard), GuardNum(GuardNum) {}
2404
2405 void Emit(CodeGenFunction &CGF, Flags flags) override {
2406 // Reset the bit in the mask so that the static variable may be
2407 // reinitialized.
2408 CGBuilderTy &Builder = CGF.Builder;
2409 llvm::LoadInst *LI = Builder.CreateLoad(Guard);
2410 llvm::ConstantInt *Mask =
Reid Klecknerd16cebe2016-02-10 19:09:15 +00002411 llvm::ConstantInt::get(CGF.IntTy, ~(1ULL << GuardNum));
David Majnemer8354eee2015-05-07 06:15:46 +00002412 Builder.CreateStore(Builder.CreateAnd(LI, Mask), Guard);
2413 }
2414};
2415
David Blaikie7e70d682015-08-18 22:40:54 +00002416struct CallInitThreadAbort final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002417 llvm::Value *Guard;
2418 CallInitThreadAbort(Address Guard) : Guard(Guard.getPointer()) {}
David Majnemer8354eee2015-05-07 06:15:46 +00002419
2420 void Emit(CodeGenFunction &CGF, Flags flags) override {
2421 // Calling _Init_thread_abort will reset the guard's state.
2422 CGF.EmitNounwindRuntimeCall(getInitThreadAbortFn(CGF.CGM), Guard);
2423 }
2424};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002425}
David Majnemer8354eee2015-05-07 06:15:46 +00002426
John McCallc84ed6a2012-05-01 06:13:13 +00002427void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00002428 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00002429 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00002430 // MSVC only uses guards for static locals.
2431 if (!D.isStaticLocal()) {
2432 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2433 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
Rafael Espindola77abc3a2015-01-16 16:04:45 +00002434 llvm::Function *F = CGF.CurFn;
2435 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2436 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
Reid Kleckner563f0e82014-05-23 21:13:45 +00002437 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2438 return;
2439 }
2440
David Majnemerec8e54b2015-05-07 21:19:06 +00002441 bool ThreadlocalStatic = D.getTLSKind();
2442 bool ThreadsafeStatic = getContext().getLangOpts().ThreadsafeStatics;
2443
2444 // Thread-safe static variables which aren't thread-specific have a
2445 // per-variable guard.
2446 bool HasPerVariableGuard = ThreadsafeStatic && !ThreadlocalStatic;
Richard Smithdbf74ba2013-04-14 23:01:42 +00002447
Reid Klecknerd8110b62013-09-10 20:14:30 +00002448 CGBuilderTy &Builder = CGF.Builder;
2449 llvm::IntegerType *GuardTy = CGF.Int32Ty;
2450 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
John McCall7f416cc2015-09-08 08:05:57 +00002451 CharUnits GuardAlign = CharUnits::fromQuantity(4);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002452
2453 // Get the guard variable for this function if we have one already.
David Majnemerec8e54b2015-05-07 21:19:06 +00002454 GuardInfo *GI = nullptr;
2455 if (ThreadlocalStatic)
2456 GI = &ThreadLocalGuardVariableMap[D.getDeclContext()];
2457 else if (!ThreadsafeStatic)
2458 GI = &GuardVariableMap[D.getDeclContext()];
2459
2460 llvm::GlobalVariable *GuardVar = GI ? GI->Guard : nullptr;
David Majnemer8354eee2015-05-07 06:15:46 +00002461 unsigned GuardNum;
David Majnemerec8e54b2015-05-07 21:19:06 +00002462 if (D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002463 // Externally visible variables have to be numbered in Sema to properly
2464 // handle unreachable VarDecls.
David Majnemer8354eee2015-05-07 06:15:46 +00002465 GuardNum = getContext().getStaticLocalNumber(&D);
2466 assert(GuardNum > 0);
2467 GuardNum--;
2468 } else if (HasPerVariableGuard) {
2469 GuardNum = ThreadSafeGuardNumMap[D.getDeclContext()]++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002470 } else {
2471 // Non-externally visible variables are numbered here in CodeGen.
David Majnemer8354eee2015-05-07 06:15:46 +00002472 GuardNum = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002473 }
2474
David Majnemer8354eee2015-05-07 06:15:46 +00002475 if (!HasPerVariableGuard && GuardNum >= 32) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002476 if (D.isExternallyVisible())
2477 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
David Majnemer8354eee2015-05-07 06:15:46 +00002478 GuardNum %= 32;
2479 GuardVar = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002480 }
2481
David Majnemer8354eee2015-05-07 06:15:46 +00002482 if (!GuardVar) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002483 // Mangle the name for the guard.
2484 SmallString<256> GuardName;
2485 {
2486 llvm::raw_svector_ostream Out(GuardName);
David Majnemer8354eee2015-05-07 06:15:46 +00002487 if (HasPerVariableGuard)
2488 getMangleContext().mangleThreadSafeStaticGuardVariable(&D, GuardNum,
2489 Out);
2490 else
2491 getMangleContext().mangleStaticGuardVariable(&D, Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002492 }
2493
Hans Wennborgef2272c2014-06-18 15:55:13 +00002494 // Create the guard variable with a zero-initializer. Just absorb linkage,
2495 // visibility and dll storage class from the guarded variable.
David Majnemer8354eee2015-05-07 06:15:46 +00002496 GuardVar =
2497 new llvm::GlobalVariable(CGM.getModule(), GuardTy, /*isConstant=*/false,
Reid Klecknere9591b32014-04-23 18:22:11 +00002498 GV->getLinkage(), Zero, GuardName.str());
David Majnemer8354eee2015-05-07 06:15:46 +00002499 GuardVar->setVisibility(GV->getVisibility());
2500 GuardVar->setDLLStorageClass(GV->getDLLStorageClass());
Guillaume Chateletc79099e2019-10-03 13:00:29 +00002501 GuardVar->setAlignment(GuardAlign.getAsAlign());
David Majnemer8354eee2015-05-07 06:15:46 +00002502 if (GuardVar->isWeakForLinker())
2503 GuardVar->setComdat(
2504 CGM.getModule().getOrInsertComdat(GuardVar->getName()));
2505 if (D.getTLSKind())
2506 GuardVar->setThreadLocal(true);
2507 if (GI && !HasPerVariableGuard)
2508 GI->Guard = GuardVar;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002509 }
2510
John McCall7f416cc2015-09-08 08:05:57 +00002511 ConstantAddress GuardAddr(GuardVar, GuardAlign);
2512
David Majnemer8354eee2015-05-07 06:15:46 +00002513 assert(GuardVar->getLinkage() == GV->getLinkage() &&
2514 "static local from the same function had different linkage");
Reid Klecknerd8110b62013-09-10 20:14:30 +00002515
David Majnemer8354eee2015-05-07 06:15:46 +00002516 if (!HasPerVariableGuard) {
2517 // Pseudo code for the test:
2518 // if (!(GuardVar & MyGuardBit)) {
2519 // GuardVar |= MyGuardBit;
2520 // ... initialize the object ...;
2521 // }
Reid Klecknerd8110b62013-09-10 20:14:30 +00002522
David Majnemer8354eee2015-05-07 06:15:46 +00002523 // Test our bit from the guard variable.
Aaron Ballmanabd466e2016-03-30 21:33:34 +00002524 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1ULL << GuardNum);
John McCall7f416cc2015-09-08 08:05:57 +00002525 llvm::LoadInst *LI = Builder.CreateLoad(GuardAddr);
Richard Smithae8d62c2017-07-26 22:01:09 +00002526 llvm::Value *NeedsInit =
2527 Builder.CreateICmpEQ(Builder.CreateAnd(LI, Bit), Zero);
David Majnemer8354eee2015-05-07 06:15:46 +00002528 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2529 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002530 CGF.EmitCXXGuardedInitBranch(NeedsInit, InitBlock, EndBlock,
2531 CodeGenFunction::GuardKind::VariableGuard, &D);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002532
David Majnemer8354eee2015-05-07 06:15:46 +00002533 // Set our bit in the guard variable and emit the initializer and add a global
2534 // destructor if appropriate.
2535 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002536 Builder.CreateStore(Builder.CreateOr(LI, Bit), GuardAddr);
2537 CGF.EHStack.pushCleanup<ResetGuardBit>(EHCleanup, GuardAddr, GuardNum);
David Majnemer8354eee2015-05-07 06:15:46 +00002538 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2539 CGF.PopCleanupBlock();
2540 Builder.CreateBr(EndBlock);
2541
2542 // Continue.
2543 CGF.EmitBlock(EndBlock);
2544 } else {
2545 // Pseudo code for the test:
2546 // if (TSS > _Init_thread_epoch) {
2547 // _Init_thread_header(&TSS);
2548 // if (TSS == -1) {
2549 // ... initialize the object ...;
2550 // _Init_thread_footer(&TSS);
2551 // }
2552 // }
2553 //
2554 // The algorithm is almost identical to what can be found in the appendix
2555 // found in N2325.
2556
David Majnemer8354eee2015-05-07 06:15:46 +00002557 // This BasicBLock determines whether or not we have any work to do.
John McCall7f416cc2015-09-08 08:05:57 +00002558 llvm::LoadInst *FirstGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002559 FirstGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2560 llvm::LoadInst *InitThreadEpoch =
2561 Builder.CreateLoad(getInitThreadEpochPtr(CGM));
2562 llvm::Value *IsUninitialized =
2563 Builder.CreateICmpSGT(FirstGuardLoad, InitThreadEpoch);
2564 llvm::BasicBlock *AttemptInitBlock = CGF.createBasicBlock("init.attempt");
2565 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002566 CGF.EmitCXXGuardedInitBranch(IsUninitialized, AttemptInitBlock, EndBlock,
2567 CodeGenFunction::GuardKind::VariableGuard, &D);
David Majnemer8354eee2015-05-07 06:15:46 +00002568
2569 // This BasicBlock attempts to determine whether or not this thread is
2570 // responsible for doing the initialization.
2571 CGF.EmitBlock(AttemptInitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002572 CGF.EmitNounwindRuntimeCall(getInitThreadHeaderFn(CGM),
2573 GuardAddr.getPointer());
2574 llvm::LoadInst *SecondGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002575 SecondGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2576 llvm::Value *ShouldDoInit =
2577 Builder.CreateICmpEQ(SecondGuardLoad, getAllOnesInt());
2578 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2579 Builder.CreateCondBr(ShouldDoInit, InitBlock, EndBlock);
2580
2581 // Ok, we ended up getting selected as the initializing thread.
2582 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002583 CGF.EHStack.pushCleanup<CallInitThreadAbort>(EHCleanup, GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002584 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2585 CGF.PopCleanupBlock();
John McCall7f416cc2015-09-08 08:05:57 +00002586 CGF.EmitNounwindRuntimeCall(getInitThreadFooterFn(CGM),
2587 GuardAddr.getPointer());
David Majnemer8354eee2015-05-07 06:15:46 +00002588 Builder.CreateBr(EndBlock);
2589
2590 CGF.EmitBlock(EndBlock);
2591 }
John McCallc84ed6a2012-05-01 06:13:13 +00002592}
2593
Reid Kleckner2341ae32013-04-11 18:13:19 +00002594bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2595 // Null-ness for function memptrs only depends on the first field, which is
2596 // the function pointer. The rest don't matter, so we can zero initialize.
2597 if (MPT->isMemberFunctionPointer())
2598 return true;
2599
2600 // The virtual base adjustment field is always -1 for null, so if we have one
2601 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
2602 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002603 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2604 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002605 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
2606 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00002607}
2608
2609llvm::Type *
2610MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002611 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2612 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002613 llvm::SmallVector<llvm::Type *, 4> fields;
2614 if (MPT->isMemberFunctionPointer())
2615 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
2616 else
2617 fields.push_back(CGM.IntTy); // FieldOffset
2618
Reid Kleckner96f8f932014-02-05 17:27:08 +00002619 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2620 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002621 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002622 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002623 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002624 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002625 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
2626
2627 if (fields.size() == 1)
2628 return fields[0];
2629 return llvm::StructType::get(CGM.getLLVMContext(), fields);
2630}
2631
2632void MicrosoftCXXABI::
2633GetNullMemberPointerFields(const MemberPointerType *MPT,
2634 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2635 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00002636 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2637 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002638 if (MPT->isMemberFunctionPointer()) {
2639 // FunctionPointerOrVirtualThunk
2640 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2641 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00002642 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00002643 fields.push_back(getZeroInt()); // FieldOffset
2644 else
2645 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00002646 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00002647
Reid Kleckner96f8f932014-02-05 17:27:08 +00002648 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2649 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002650 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002651 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002652 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002653 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002654 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002655}
2656
2657llvm::Constant *
2658MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002659 llvm::SmallVector<llvm::Constant *, 4> fields;
2660 GetNullMemberPointerFields(MPT, fields);
2661 if (fields.size() == 1)
2662 return fields[0];
2663 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2664 assert(Res->getType() == ConvertMemberPointerType(MPT));
2665 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002666}
2667
2668llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002669MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2670 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00002671 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +00002672 CharUnits NonVirtualBaseAdjustment,
2673 unsigned VBTableIndex) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002674 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002675
2676 // Single inheritance class member pointer are represented as scalars instead
2677 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002678 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002679 return FirstField;
2680
Reid Kleckner2341ae32013-04-11 18:13:19 +00002681 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002682 fields.push_back(FirstField);
2683
Reid Kleckner96f8f932014-02-05 17:27:08 +00002684 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002685 fields.push_back(llvm::ConstantInt::get(
2686 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002687
Reid Kleckner96f8f932014-02-05 17:27:08 +00002688 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00002689 CharUnits Offs = CharUnits::Zero();
David Majnemerc1709d32015-06-23 07:31:11 +00002690 if (VBTableIndex)
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002691 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00002692 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00002693 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002694
2695 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002696 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
David Majnemere60813f2015-05-10 21:48:08 +00002697 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, VBTableIndex));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002698
Reid Kleckner2341ae32013-04-11 18:13:19 +00002699 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002700}
2701
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002702llvm::Constant *
2703MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2704 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002705 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerc1709d32015-06-23 07:31:11 +00002706 if (RD->getMSInheritanceModel() ==
2707 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002708 offset -= getContext().getOffsetOfBaseWithVBPtr(RD);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002709 llvm::Constant *FirstField =
2710 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00002711 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002712 CharUnits::Zero(), /*VBTableIndex=*/0);
Reid Kleckner452abac2013-05-09 21:01:17 +00002713}
2714
Reid Kleckner452abac2013-05-09 21:01:17 +00002715llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2716 QualType MPType) {
David Majnemer5ca193c2015-06-23 07:31:07 +00002717 const MemberPointerType *DstTy = MPType->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002718 const ValueDecl *MPD = MP.getMemberPointerDecl();
2719 if (!MPD)
David Majnemer5ca193c2015-06-23 07:31:07 +00002720 return EmitNullMemberPointer(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002721
David Majnemer5ca193c2015-06-23 07:31:07 +00002722 ASTContext &Ctx = getContext();
2723 ArrayRef<const CXXRecordDecl *> MemberPointerPath = MP.getMemberPointerPath();
Reid Kleckner452abac2013-05-09 21:01:17 +00002724
David Majnemer5ca193c2015-06-23 07:31:07 +00002725 llvm::Constant *C;
2726 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) {
2727 C = EmitMemberFunctionPointer(MD);
2728 } else {
2729 CharUnits FieldOffset = Ctx.toCharUnitsFromBits(Ctx.getFieldOffset(MPD));
2730 C = EmitMemberDataPointer(DstTy, FieldOffset);
2731 }
Reid Kleckner452abac2013-05-09 21:01:17 +00002732
David Majnemer5ca193c2015-06-23 07:31:07 +00002733 if (!MemberPointerPath.empty()) {
2734 const CXXRecordDecl *SrcRD = cast<CXXRecordDecl>(MPD->getDeclContext());
2735 const Type *SrcRecTy = Ctx.getTypeDeclType(SrcRD).getTypePtr();
2736 const MemberPointerType *SrcTy =
2737 Ctx.getMemberPointerType(DstTy->getPointeeType(), SrcRecTy)
2738 ->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002739
David Majnemer5ca193c2015-06-23 07:31:07 +00002740 bool DerivedMember = MP.isMemberPointerToDerivedMember();
2741 SmallVector<const CXXBaseSpecifier *, 4> DerivedToBasePath;
2742 const CXXRecordDecl *PrevRD = SrcRD;
2743 for (const CXXRecordDecl *PathElem : MemberPointerPath) {
2744 const CXXRecordDecl *Base = nullptr;
2745 const CXXRecordDecl *Derived = nullptr;
2746 if (DerivedMember) {
2747 Base = PathElem;
2748 Derived = PrevRD;
2749 } else {
2750 Base = PrevRD;
2751 Derived = PathElem;
2752 }
2753 for (const CXXBaseSpecifier &BS : Derived->bases())
2754 if (BS.getType()->getAsCXXRecordDecl()->getCanonicalDecl() ==
2755 Base->getCanonicalDecl())
2756 DerivedToBasePath.push_back(&BS);
2757 PrevRD = PathElem;
2758 }
2759 assert(DerivedToBasePath.size() == MemberPointerPath.size());
2760
2761 CastKind CK = DerivedMember ? CK_DerivedToBaseMemberPointer
2762 : CK_BaseToDerivedMemberPointer;
2763 C = EmitMemberPointerConversion(SrcTy, DstTy, CK, DerivedToBasePath.begin(),
2764 DerivedToBasePath.end(), C);
2765 }
2766 return C;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002767}
2768
2769llvm::Constant *
David Majnemer5ca193c2015-06-23 07:31:07 +00002770MicrosoftCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002771 assert(MD->isInstance() && "Member function must not be static!");
David Majnemer5ca193c2015-06-23 07:31:07 +00002772
David Majnemer5ca193c2015-06-23 07:31:07 +00002773 CharUnits NonVirtualBaseAdjustment = CharUnits::Zero();
Reid Kleckner26fc5312018-05-31 18:42:29 +00002774 const CXXRecordDecl *RD = MD->getParent()->getMostRecentNonInjectedDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002775 CodeGenTypes &Types = CGM.getTypes();
2776
David Majnemere60813f2015-05-10 21:48:08 +00002777 unsigned VBTableIndex = 0;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002778 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00002779 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00002780 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002781 llvm::Type *Ty;
2782 // Check whether the function has a computable LLVM signature.
2783 if (Types.isFuncTypeConvertible(FPT)) {
2784 // The function has a computable LLVM signature; use the correct type.
2785 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2786 } else {
2787 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2788 // function type is incomplete.
2789 Ty = CGM.PtrDiffTy;
2790 }
2791 FirstField = CGM.GetAddrOfFunction(MD, Ty);
Hans Wennborg88497d62013-11-15 17:24:45 +00002792 } else {
David Majnemere0e228a2015-06-11 08:12:44 +00002793 auto &VTableContext = CGM.getMicrosoftVTableContext();
Reid Klecknercbec0262018-04-02 20:00:39 +00002794 MethodVFTableLocation ML = VTableContext.getMethodVFTableLocation(MD);
David Majnemerc1709d32015-06-23 07:31:11 +00002795 FirstField = EmitVirtualMemPtrThunk(MD, ML);
David Majnemere0e228a2015-06-11 08:12:44 +00002796 // Include the vfptr adjustment if the method is in a non-primary vftable.
2797 NonVirtualBaseAdjustment += ML.VFPtrOffset;
2798 if (ML.VBase)
2799 VBTableIndex = VTableContext.getVBTableIndex(RD, ML.VBase) * 4;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002800 }
2801
David Majnemerc1709d32015-06-23 07:31:11 +00002802 if (VBTableIndex == 0 &&
2803 RD->getMSInheritanceModel() ==
2804 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002805 NonVirtualBaseAdjustment -= getContext().getOffsetOfBaseWithVBPtr(RD);
David Majnemerc1709d32015-06-23 07:31:11 +00002806
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002807 // The rest of the fields are common with data member pointers.
David Majnemerc1709d32015-06-23 07:31:11 +00002808 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002809 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002810 NonVirtualBaseAdjustment, VBTableIndex);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002811}
2812
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002813/// Member pointers are the same if they're either bitwise identical *or* both
2814/// null. Null-ness for function members is determined by the first field,
2815/// while for data member pointers we must compare all fields.
2816llvm::Value *
2817MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2818 llvm::Value *L,
2819 llvm::Value *R,
2820 const MemberPointerType *MPT,
2821 bool Inequality) {
2822 CGBuilderTy &Builder = CGF.Builder;
2823
2824 // Handle != comparisons by switching the sense of all boolean operations.
2825 llvm::ICmpInst::Predicate Eq;
2826 llvm::Instruction::BinaryOps And, Or;
2827 if (Inequality) {
2828 Eq = llvm::ICmpInst::ICMP_NE;
2829 And = llvm::Instruction::Or;
2830 Or = llvm::Instruction::And;
2831 } else {
2832 Eq = llvm::ICmpInst::ICMP_EQ;
2833 And = llvm::Instruction::And;
2834 Or = llvm::Instruction::Or;
2835 }
2836
2837 // If this is a single field member pointer (single inheritance), this is a
2838 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002839 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2840 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002841 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2842 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002843 return Builder.CreateICmp(Eq, L, R);
2844
2845 // Compare the first field.
2846 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2847 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2848 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2849
2850 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002851 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002852 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2853 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2854 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2855 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2856 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2857 if (Res)
2858 Res = Builder.CreateBinOp(And, Res, Cmp);
2859 else
2860 Res = Cmp;
2861 }
2862
2863 // Check if the first field is 0 if this is a function pointer.
2864 if (MPT->isMemberFunctionPointer()) {
2865 // (l1 == r1 && ...) || l0 == 0
2866 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2867 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2868 Res = Builder.CreateBinOp(Or, Res, IsZero);
2869 }
2870
2871 // Combine the comparison of the first field, which must always be true for
2872 // this comparison to succeeed.
2873 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2874}
2875
Reid Kleckner407e8b62013-03-22 19:02:54 +00002876llvm::Value *
2877MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2878 llvm::Value *MemPtr,
2879 const MemberPointerType *MPT) {
2880 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002881 llvm::SmallVector<llvm::Constant *, 4> fields;
2882 // We only need one field for member functions.
2883 if (MPT->isMemberFunctionPointer())
2884 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2885 else
2886 GetNullMemberPointerFields(MPT, fields);
2887 assert(!fields.empty());
2888 llvm::Value *FirstField = MemPtr;
2889 if (MemPtr->getType()->isStructTy())
2890 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2891 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002892
Reid Kleckner2341ae32013-04-11 18:13:19 +00002893 // For function member pointers, we only need to test the function pointer
2894 // field. The other fields if any can be garbage.
2895 if (MPT->isMemberFunctionPointer())
2896 return Res;
2897
2898 // Otherwise, emit a series of compares and combine the results.
2899 for (int I = 1, E = fields.size(); I < E; ++I) {
2900 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2901 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002902 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002903 }
2904 return Res;
2905}
2906
Reid Kleckner452abac2013-05-09 21:01:17 +00002907bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2908 llvm::Constant *Val) {
2909 // Function pointers are null if the pointer in the first field is null.
2910 if (MPT->isMemberFunctionPointer()) {
2911 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2912 Val->getAggregateElement(0U) : Val;
2913 return FirstField->isNullValue();
2914 }
2915
2916 // If it's not a function pointer and it's zero initializable, we can easily
2917 // check zero.
2918 if (isZeroInitializable(MPT) && Val->isNullValue())
2919 return true;
2920
2921 // Otherwise, break down all the fields for comparison. Hopefully these
2922 // little Constants are reused, while a big null struct might not be.
2923 llvm::SmallVector<llvm::Constant *, 4> Fields;
2924 GetNullMemberPointerFields(MPT, Fields);
2925 if (Fields.size() == 1) {
2926 assert(Val->getType()->isIntegerTy());
2927 return Val == Fields[0];
2928 }
2929
2930 unsigned I, E;
2931 for (I = 0, E = Fields.size(); I != E; ++I) {
2932 if (Val->getAggregateElement(I) != Fields[I])
2933 break;
2934 }
2935 return I == E;
2936}
2937
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002938llvm::Value *
2939MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002940 Address This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002941 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002942 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002943 llvm::Value **VBPtrOut) {
2944 CGBuilderTy &Builder = CGF.Builder;
2945 // Load the vbtable pointer from the vbptr in the instance.
John McCall7f416cc2015-09-08 08:05:57 +00002946 This = Builder.CreateElementBitCast(This, CGM.Int8Ty);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002947 llvm::Value *VBPtr =
John McCall7f416cc2015-09-08 08:05:57 +00002948 Builder.CreateInBoundsGEP(This.getPointer(), VBPtrOffset, "vbptr");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002949 if (VBPtrOut) *VBPtrOut = VBPtr;
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002950 VBPtr = Builder.CreateBitCast(VBPtr,
John McCall7f416cc2015-09-08 08:05:57 +00002951 CGM.Int32Ty->getPointerTo(0)->getPointerTo(This.getAddressSpace()));
2952
2953 CharUnits VBPtrAlign;
2954 if (auto CI = dyn_cast<llvm::ConstantInt>(VBPtrOffset)) {
2955 VBPtrAlign = This.getAlignment().alignmentAtOffset(
2956 CharUnits::fromQuantity(CI->getSExtValue()));
2957 } else {
2958 VBPtrAlign = CGF.getPointerAlign();
2959 }
2960
2961 llvm::Value *VBTable = Builder.CreateAlignedLoad(VBPtr, VBPtrAlign, "vbtable");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002962
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002963 // Translate from byte offset to table index. It improves analyzability.
2964 llvm::Value *VBTableIndex = Builder.CreateAShr(
2965 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
2966 "vbtindex", /*isExact=*/true);
2967
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002968 // Load an i32 offset from the vb-table.
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002969 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002970 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
John McCall7f416cc2015-09-08 08:05:57 +00002971 return Builder.CreateAlignedLoad(VBaseOffs, CharUnits::fromQuantity(4),
2972 "vbase_offs");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002973}
2974
Reid Kleckner2341ae32013-04-11 18:13:19 +00002975// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2976// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002977llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2978 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
John McCall7f416cc2015-09-08 08:05:57 +00002979 Address Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002980 CGBuilderTy &Builder = CGF.Builder;
John McCall7f416cc2015-09-08 08:05:57 +00002981 Base = Builder.CreateElementBitCast(Base, CGM.Int8Ty);
Craig Topper8a13c412014-05-21 05:09:00 +00002982 llvm::BasicBlock *OriginalBB = nullptr;
2983 llvm::BasicBlock *SkipAdjustBB = nullptr;
2984 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002985
2986 // In the unspecified inheritance model, there might not be a vbtable at all,
2987 // in which case we need to skip the virtual base lookup. If there is a
2988 // vbtable, the first entry is a no-op entry that gives back the original
2989 // base, so look for a virtual base adjustment offset of zero.
2990 if (VBPtrOffset) {
2991 OriginalBB = Builder.GetInsertBlock();
2992 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2993 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2994 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002995 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002996 "memptr.is_vbase");
2997 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2998 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002999 }
3000
Reid Kleckner2341ae32013-04-11 18:13:19 +00003001 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
3002 // know the vbptr offset.
3003 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00003004 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00003005 if (!RD->hasDefinition()) {
3006 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
3007 unsigned DiagID = Diags.getCustomDiagID(
3008 DiagnosticsEngine::Error,
3009 "member pointer representation requires a "
3010 "complete class type for %0 to perform this expression");
3011 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
3012 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00003013 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003014 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
3015 }
Craig Topper8a13c412014-05-21 05:09:00 +00003016 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003017 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00003018 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00003019 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
3020
3021 // Merge control flow with the case where we didn't have to adjust.
3022 if (VBaseAdjustBB) {
3023 Builder.CreateBr(SkipAdjustBB);
3024 CGF.EmitBlock(SkipAdjustBB);
3025 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
John McCall7f416cc2015-09-08 08:05:57 +00003026 Phi->addIncoming(Base.getPointer(), OriginalBB);
Reid Kleckner2341ae32013-04-11 18:13:19 +00003027 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
3028 return Phi;
3029 }
3030 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00003031}
3032
David Majnemer2b0d66d2014-02-20 23:22:07 +00003033llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
John McCall7f416cc2015-09-08 08:05:57 +00003034 CodeGenFunction &CGF, const Expr *E, Address Base, llvm::Value *MemPtr,
David Majnemer2b0d66d2014-02-20 23:22:07 +00003035 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003036 assert(MPT->isMemberDataPointer());
John McCall7f416cc2015-09-08 08:05:57 +00003037 unsigned AS = Base.getAddressSpace();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003038 llvm::Type *PType =
3039 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
3040 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003041 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
3042 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003043
Reid Kleckner2341ae32013-04-11 18:13:19 +00003044 // Extract the fields we need, regardless of model. We'll apply them if we
3045 // have them.
3046 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003047 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3048 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003049 if (MemPtr->getType()->isStructTy()) {
3050 // We need to extract values.
3051 unsigned I = 0;
3052 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003053 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003054 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003055 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003056 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00003057 }
3058
John McCall7f416cc2015-09-08 08:05:57 +00003059 llvm::Value *Addr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003060 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003061 Addr = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00003062 VBPtrOffset);
John McCall7f416cc2015-09-08 08:05:57 +00003063 } else {
3064 Addr = Base.getPointer();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003065 }
Reid Klecknerae945122013-12-05 22:44:07 +00003066
3067 // Cast to char*.
John McCall7f416cc2015-09-08 08:05:57 +00003068 Addr = Builder.CreateBitCast(Addr, CGF.Int8Ty->getPointerTo(AS));
Reid Klecknerae945122013-12-05 22:44:07 +00003069
3070 // Apply the offset, which we assume is non-null.
John McCall7f416cc2015-09-08 08:05:57 +00003071 Addr = Builder.CreateInBoundsGEP(Addr, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00003072
3073 // Cast the address to the appropriate pointer type, adopting the address
3074 // space of the base pointer.
3075 return Builder.CreateBitCast(Addr, PType);
3076}
3077
Reid Kleckner452abac2013-05-09 21:01:17 +00003078llvm::Value *
3079MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
3080 const CastExpr *E,
3081 llvm::Value *Src) {
3082 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
3083 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
3084 E->getCastKind() == CK_ReinterpretMemberPointer);
3085
3086 // Use constant emission if we can.
3087 if (isa<llvm::Constant>(Src))
3088 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
3089
3090 // We may be adding or dropping fields from the member pointer, so we need
3091 // both types and the inheritance models of both records.
3092 const MemberPointerType *SrcTy =
3093 E->getSubExpr()->getType()->castAs<MemberPointerType>();
3094 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003095 bool IsFunc = SrcTy->isMemberFunctionPointer();
3096
3097 // If the classes use the same null representation, reinterpret_cast is a nop.
3098 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003099 if (IsReinterpret && IsFunc)
3100 return Src;
3101
3102 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3103 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3104 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00003105 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00003106 return Src;
3107
3108 CGBuilderTy &Builder = CGF.Builder;
3109
3110 // Branch past the conversion if Src is null.
3111 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
3112 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
3113
3114 // C++ 5.2.10p9: The null member pointer value is converted to the null member
3115 // pointer value of the destination type.
3116 if (IsReinterpret) {
3117 // For reinterpret casts, sema ensures that src and dst are both functions
3118 // or data and have the same size, which means the LLVM types should match.
3119 assert(Src->getType() == DstNull->getType());
3120 return Builder.CreateSelect(IsNotNull, Src, DstNull);
3121 }
3122
3123 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
3124 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
3125 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
3126 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
3127 CGF.EmitBlock(ConvertBB);
3128
David Majnemer0d9ad682015-06-29 00:06:50 +00003129 llvm::Value *Dst = EmitNonNullMemberPointerConversion(
3130 SrcTy, DstTy, E->getCastKind(), E->path_begin(), E->path_end(), Src,
3131 Builder);
3132
3133 Builder.CreateBr(ContinueBB);
3134
3135 // In the continuation, choose between DstNull and Dst.
3136 CGF.EmitBlock(ContinueBB);
3137 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
3138 Phi->addIncoming(DstNull, OriginalBB);
3139 Phi->addIncoming(Dst, ConvertBB);
3140 return Phi;
3141}
3142
3143llvm::Value *MicrosoftCXXABI::EmitNonNullMemberPointerConversion(
3144 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3145 CastExpr::path_const_iterator PathBegin,
3146 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
3147 CGBuilderTy &Builder) {
3148 const CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3149 const CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3150 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
3151 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
3152 bool IsFunc = SrcTy->isMemberFunctionPointer();
3153 bool IsConstant = isa<llvm::Constant>(Src);
3154
Reid Kleckner452abac2013-05-09 21:01:17 +00003155 // Decompose src.
3156 llvm::Value *FirstField = Src;
David Majnemerc1709d32015-06-23 07:31:11 +00003157 llvm::Value *NonVirtualBaseAdjustment = getZeroInt();
3158 llvm::Value *VirtualBaseAdjustmentOffset = getZeroInt();
3159 llvm::Value *VBPtrOffset = getZeroInt();
Reid Kleckner96f8f932014-02-05 17:27:08 +00003160 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003161 // We need to extract values.
3162 unsigned I = 0;
3163 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003164 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003165 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003166 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003167 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003168 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003169 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
3170 }
3171
David Majnemer0d9ad682015-06-29 00:06:50 +00003172 bool IsDerivedToBase = (CK == CK_DerivedToBaseMemberPointer);
David Majnemerc1709d32015-06-23 07:31:11 +00003173 const MemberPointerType *DerivedTy = IsDerivedToBase ? SrcTy : DstTy;
3174 const CXXRecordDecl *DerivedClass = DerivedTy->getMostRecentCXXRecordDecl();
3175
Reid Kleckner452abac2013-05-09 21:01:17 +00003176 // For data pointers, we adjust the field offset directly. For functions, we
3177 // have a separate field.
David Majnemerc1709d32015-06-23 07:31:11 +00003178 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
3179
3180 // The virtual inheritance model has a quirk: the virtual base table is always
3181 // referenced when dereferencing a member pointer even if the member pointer
3182 // is non-virtual. This is accounted for by adjusting the non-virtual offset
3183 // to point backwards to the top of the MDC from the first VBase. Undo this
3184 // adjustment to normalize the member pointer.
3185 llvm::Value *SrcVBIndexEqZero =
3186 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3187 if (SrcInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3188 if (int64_t SrcOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003189 getContext().getOffsetOfBaseWithVBPtr(SrcRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003190 llvm::Value *UndoSrcAdjustment = Builder.CreateSelect(
3191 SrcVBIndexEqZero,
3192 llvm::ConstantInt::get(CGM.IntTy, SrcOffsetToFirstVBase),
3193 getZeroInt());
3194 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, UndoSrcAdjustment);
3195 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003196 }
3197
David Majnemerc1709d32015-06-23 07:31:11 +00003198 // A non-zero vbindex implies that we are dealing with a source member in a
3199 // floating virtual base in addition to some non-virtual offset. If the
3200 // vbindex is zero, we are dealing with a source that exists in a non-virtual,
3201 // fixed, base. The difference between these two cases is that the vbindex +
3202 // nvoffset *always* point to the member regardless of what context they are
3203 // evaluated in so long as the vbindex is adjusted. A member inside a fixed
3204 // base requires explicit nv adjustment.
3205 llvm::Constant *BaseClassOffset = llvm::ConstantInt::get(
David Majnemer0d9ad682015-06-29 00:06:50 +00003206 CGM.IntTy,
3207 CGM.computeNonVirtualBaseClassOffset(DerivedClass, PathBegin, PathEnd)
3208 .getQuantity());
David Majnemerc1709d32015-06-23 07:31:11 +00003209
3210 llvm::Value *NVDisp;
3211 if (IsDerivedToBase)
3212 NVDisp = Builder.CreateNSWSub(NVAdjustField, BaseClassOffset, "adj");
3213 else
3214 NVDisp = Builder.CreateNSWAdd(NVAdjustField, BaseClassOffset, "adj");
3215
3216 NVAdjustField = Builder.CreateSelect(SrcVBIndexEqZero, NVDisp, getZeroInt());
3217
3218 // Update the vbindex to an appropriate value in the destination because
3219 // SrcRD's vbtable might not be a strict prefix of the one in DstRD.
3220 llvm::Value *DstVBIndexEqZero = SrcVBIndexEqZero;
3221 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance) &&
3222 MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance)) {
3223 if (llvm::GlobalVariable *VDispMap =
3224 getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) {
3225 llvm::Value *VBIndex = Builder.CreateExactUDiv(
3226 VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003227 if (IsConstant) {
3228 llvm::Constant *Mapping = VDispMap->getInitializer();
3229 VirtualBaseAdjustmentOffset =
3230 Mapping->getAggregateElement(cast<llvm::Constant>(VBIndex));
3231 } else {
3232 llvm::Value *Idxs[] = {getZeroInt(), VBIndex};
3233 VirtualBaseAdjustmentOffset =
John McCall7f416cc2015-09-08 08:05:57 +00003234 Builder.CreateAlignedLoad(Builder.CreateInBoundsGEP(VDispMap, Idxs),
3235 CharUnits::fromQuantity(4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003236 }
David Majnemerc1709d32015-06-23 07:31:11 +00003237
3238 DstVBIndexEqZero =
3239 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3240 }
3241 }
3242
3243 // Set the VBPtrOffset to zero if the vbindex is zero. Otherwise, initialize
3244 // it to the offset of the vbptr.
3245 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance)) {
3246 llvm::Value *DstVBPtrOffset = llvm::ConstantInt::get(
3247 CGM.IntTy,
3248 getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity());
3249 VBPtrOffset =
3250 Builder.CreateSelect(DstVBIndexEqZero, getZeroInt(), DstVBPtrOffset);
3251 }
3252
3253 // Likewise, apply a similar adjustment so that dereferencing the member
3254 // pointer correctly accounts for the distance between the start of the first
3255 // virtual base and the top of the MDC.
3256 if (DstInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3257 if (int64_t DstOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003258 getContext().getOffsetOfBaseWithVBPtr(DstRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003259 llvm::Value *DoDstAdjustment = Builder.CreateSelect(
3260 DstVBIndexEqZero,
3261 llvm::ConstantInt::get(CGM.IntTy, DstOffsetToFirstVBase),
3262 getZeroInt());
3263 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, DoDstAdjustment);
3264 }
3265 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003266
3267 // Recompose dst from the null struct and the adjusted fields from src.
3268 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00003269 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003270 Dst = FirstField;
3271 } else {
David Majnemer0d9ad682015-06-29 00:06:50 +00003272 Dst = llvm::UndefValue::get(ConvertMemberPointerType(DstTy));
Reid Kleckner452abac2013-05-09 21:01:17 +00003273 unsigned Idx = 0;
3274 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003275 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003276 Dst = Builder.CreateInsertValue(Dst, NonVirtualBaseAdjustment, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003277 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003278 Dst = Builder.CreateInsertValue(Dst, VBPtrOffset, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003279 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003280 Dst = Builder.CreateInsertValue(Dst, VirtualBaseAdjustmentOffset, Idx++);
Reid Kleckner452abac2013-05-09 21:01:17 +00003281 }
David Majnemer0d9ad682015-06-29 00:06:50 +00003282 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003283}
3284
3285llvm::Constant *
3286MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
3287 llvm::Constant *Src) {
3288 const MemberPointerType *SrcTy =
David Majnemer5ca193c2015-06-23 07:31:07 +00003289 E->getSubExpr()->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003290 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3291
David Majnemer5ca193c2015-06-23 07:31:07 +00003292 CastKind CK = E->getCastKind();
3293
3294 return EmitMemberPointerConversion(SrcTy, DstTy, CK, E->path_begin(),
3295 E->path_end(), Src);
3296}
3297
3298llvm::Constant *MicrosoftCXXABI::EmitMemberPointerConversion(
3299 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3300 CastExpr::path_const_iterator PathBegin,
3301 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src) {
3302 assert(CK == CK_DerivedToBaseMemberPointer ||
3303 CK == CK_BaseToDerivedMemberPointer ||
3304 CK == CK_ReinterpretMemberPointer);
Reid Kleckner452abac2013-05-09 21:01:17 +00003305 // If src is null, emit a new null for dst. We can't return src because dst
3306 // might have a new representation.
3307 if (MemberPointerConstantIsNull(SrcTy, Src))
3308 return EmitNullMemberPointer(DstTy);
3309
3310 // We don't need to do anything for reinterpret_casts of non-null member
3311 // pointers. We should only get here when the two type representations have
3312 // the same size.
David Majnemer5ca193c2015-06-23 07:31:07 +00003313 if (CK == CK_ReinterpretMemberPointer)
Reid Kleckner452abac2013-05-09 21:01:17 +00003314 return Src;
3315
John McCall7f416cc2015-09-08 08:05:57 +00003316 CGBuilderTy Builder(CGM, CGM.getLLVMContext());
David Majnemer0d9ad682015-06-29 00:06:50 +00003317 auto *Dst = cast<llvm::Constant>(EmitNonNullMemberPointerConversion(
3318 SrcTy, DstTy, CK, PathBegin, PathEnd, Src, Builder));
Reid Kleckner452abac2013-05-09 21:01:17 +00003319
David Majnemer0d9ad682015-06-29 00:06:50 +00003320 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003321}
3322
John McCallb92ab1a2016-10-26 23:46:34 +00003323CGCallee MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
John McCall7f416cc2015-09-08 08:05:57 +00003324 CodeGenFunction &CGF, const Expr *E, Address This,
3325 llvm::Value *&ThisPtrForCall, llvm::Value *MemPtr,
3326 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003327 assert(MPT->isMemberFunctionPointer());
3328 const FunctionProtoType *FPT =
3329 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00003330 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003331 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(
3332 CGM.getTypes().arrangeCXXMethodType(RD, FPT, /*FD=*/nullptr));
Reid Kleckner2341ae32013-04-11 18:13:19 +00003333 CGBuilderTy &Builder = CGF.Builder;
3334
David Majnemer1cdd96d2014-01-17 09:01:00 +00003335 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003336
3337 // Extract the fields we need, regardless of model. We'll apply them if we
3338 // have them.
3339 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003340 llvm::Value *NonVirtualBaseAdjustment = nullptr;
3341 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3342 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003343 if (MemPtr->getType()->isStructTy()) {
3344 // We need to extract values.
3345 unsigned I = 0;
3346 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003347 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003348 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003349 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00003350 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003351 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003352 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3353 }
3354
3355 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003356 ThisPtrForCall = AdjustVirtualBase(CGF, E, RD, This,
3357 VirtualBaseAdjustmentOffset, VBPtrOffset);
3358 } else {
3359 ThisPtrForCall = This.getPointer();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003360 }
3361
3362 if (NonVirtualBaseAdjustment) {
3363 // Apply the adjustment and cast back to the original struct type.
John McCall7f416cc2015-09-08 08:05:57 +00003364 llvm::Value *Ptr = Builder.CreateBitCast(ThisPtrForCall, CGF.Int8PtrTy);
Reid Kleckner2341ae32013-04-11 18:13:19 +00003365 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
John McCall7f416cc2015-09-08 08:05:57 +00003366 ThisPtrForCall = Builder.CreateBitCast(Ptr, ThisPtrForCall->getType(),
3367 "this.adjusted");
Reid Kleckner2341ae32013-04-11 18:13:19 +00003368 }
3369
John McCallb92ab1a2016-10-26 23:46:34 +00003370 FunctionPointer =
3371 Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
3372 CGCallee Callee(FPT, FunctionPointer);
3373 return Callee;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003374}
3375
Charles Davis53c59df2010-08-16 03:33:14 +00003376CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00003377 return new MicrosoftCXXABI(CGM);
3378}
David Majnemere2cb8d12014-07-07 06:20:47 +00003379
3380// MS RTTI Overview:
3381// The run time type information emitted by cl.exe contains 5 distinct types of
3382// structures. Many of them reference each other.
3383//
3384// TypeInfo: Static classes that are returned by typeid.
3385//
3386// CompleteObjectLocator: Referenced by vftables. They contain information
3387// required for dynamic casting, including OffsetFromTop. They also contain
3388// a reference to the TypeInfo for the type and a reference to the
3389// CompleteHierarchyDescriptor for the type.
3390//
Nico Weberf2904452018-07-19 18:59:38 +00003391// ClassHierarchyDescriptor: Contains information about a class hierarchy.
David Majnemere2cb8d12014-07-07 06:20:47 +00003392// Used during dynamic_cast to walk a class hierarchy. References a base
3393// class array and the size of said array.
3394//
3395// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
3396// somewhat of a misnomer because the most derived class is also in the list
3397// as well as multiple copies of virtual bases (if they occur multiple times
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003398// in the hierarchy.) The BaseClassArray contains one BaseClassDescriptor for
David Majnemere2cb8d12014-07-07 06:20:47 +00003399// every path in the hierarchy, in pre-order depth first order. Note, we do
3400// not declare a specific llvm type for BaseClassArray, it's merely an array
3401// of BaseClassDescriptor pointers.
3402//
3403// BaseClassDescriptor: Contains information about a class in a class hierarchy.
3404// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
3405// BaseClassArray is. It contains information about a class within a
3406// hierarchy such as: is this base is ambiguous and what is its offset in the
3407// vbtable. The names of the BaseClassDescriptors have all of their fields
3408// mangled into them so they can be aggressively deduplicated by the linker.
3409
David Majnemere2cb8d12014-07-07 06:20:47 +00003410static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
Reid Klecknerfb931542018-03-16 20:36:49 +00003411 StringRef MangledName("??_7type_info@@6B@");
David Majnemere2cb8d12014-07-07 06:20:47 +00003412 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
3413 return VTable;
3414 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
Rui Ueyama49a3ad22019-07-16 04:46:31 +00003415 /*isConstant=*/true,
David Majnemere2cb8d12014-07-07 06:20:47 +00003416 llvm::GlobalVariable::ExternalLinkage,
3417 /*Initializer=*/nullptr, MangledName);
3418}
3419
3420namespace {
3421
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003422/// A Helper struct that stores information about a class in a class
David Majnemere2cb8d12014-07-07 06:20:47 +00003423/// hierarchy. The information stored in these structs struct is used during
3424/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
3425// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
3426// implicit depth first pre-order tree connectivity. getFirstChild and
3427// getNextSibling allow us to walk the tree efficiently.
3428struct MSRTTIClass {
3429 enum {
3430 IsPrivateOnPath = 1 | 8,
3431 IsAmbiguous = 2,
3432 IsPrivate = 4,
3433 IsVirtual = 16,
3434 HasHierarchyDescriptor = 64
3435 };
3436 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
3437 uint32_t initialize(const MSRTTIClass *Parent,
3438 const CXXBaseSpecifier *Specifier);
3439
3440 MSRTTIClass *getFirstChild() { return this + 1; }
3441 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
3442 return Child + 1 + Child->NumBases;
3443 }
3444
3445 const CXXRecordDecl *RD, *VirtualRoot;
3446 uint32_t Flags, NumBases, OffsetInVBase;
3447};
3448
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003449/// Recursively initialize the base class array.
David Majnemere2cb8d12014-07-07 06:20:47 +00003450uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
3451 const CXXBaseSpecifier *Specifier) {
3452 Flags = HasHierarchyDescriptor;
3453 if (!Parent) {
3454 VirtualRoot = nullptr;
3455 OffsetInVBase = 0;
3456 } else {
3457 if (Specifier->getAccessSpecifier() != AS_public)
3458 Flags |= IsPrivate | IsPrivateOnPath;
3459 if (Specifier->isVirtual()) {
3460 Flags |= IsVirtual;
3461 VirtualRoot = RD;
3462 OffsetInVBase = 0;
3463 } else {
3464 if (Parent->Flags & IsPrivateOnPath)
3465 Flags |= IsPrivateOnPath;
3466 VirtualRoot = Parent->VirtualRoot;
3467 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
3468 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
3469 }
3470 }
3471 NumBases = 0;
3472 MSRTTIClass *Child = getFirstChild();
3473 for (const CXXBaseSpecifier &Base : RD->bases()) {
3474 NumBases += Child->initialize(this, &Base) + 1;
3475 Child = getNextChild(Child);
3476 }
3477 return NumBases;
3478}
3479
3480static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
3481 switch (Ty->getLinkage()) {
3482 case NoLinkage:
3483 case InternalLinkage:
3484 case UniqueExternalLinkage:
3485 return llvm::GlobalValue::InternalLinkage;
3486
3487 case VisibleNoLinkage:
Richard Smith1283e982017-07-07 20:04:28 +00003488 case ModuleInternalLinkage:
3489 case ModuleLinkage:
David Majnemere2cb8d12014-07-07 06:20:47 +00003490 case ExternalLinkage:
3491 return llvm::GlobalValue::LinkOnceODRLinkage;
3492 }
3493 llvm_unreachable("Invalid linkage!");
3494}
3495
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003496/// An ephemeral helper class for building MS RTTI types. It caches some
David Majnemere2cb8d12014-07-07 06:20:47 +00003497/// calls to the module and information about the most derived class in a
3498/// hierarchy.
3499struct MSRTTIBuilder {
3500 enum {
3501 HasBranchingHierarchy = 1,
3502 HasVirtualBranchingHierarchy = 2,
3503 HasAmbiguousBases = 4
3504 };
3505
David Majnemer611cdb92014-07-07 08:09:15 +00003506 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
3507 : CGM(ABI.CGM), Context(CGM.getContext()),
3508 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00003509 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003510 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00003511
3512 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
3513 llvm::GlobalVariable *
3514 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
3515 llvm::GlobalVariable *getClassHierarchyDescriptor();
Justin Lebar562914e2016-10-10 16:26:29 +00003516 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo &Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003517
3518 CodeGenModule &CGM;
3519 ASTContext &Context;
3520 llvm::LLVMContext &VMContext;
3521 llvm::Module &Module;
3522 const CXXRecordDecl *RD;
3523 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00003524 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00003525};
3526
3527} // namespace
3528
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003529/// Recursively serializes a class hierarchy in pre-order depth first
David Majnemere2cb8d12014-07-07 06:20:47 +00003530/// order.
3531static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
3532 const CXXRecordDecl *RD) {
3533 Classes.push_back(MSRTTIClass(RD));
3534 for (const CXXBaseSpecifier &Base : RD->bases())
3535 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
3536}
3537
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003538/// Find ambiguity among base classes.
David Majnemere2cb8d12014-07-07 06:20:47 +00003539static void
3540detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
3541 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
3542 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
3543 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
3544 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
3545 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
David Blaikie82e95a32014-11-19 07:49:47 +00003546 !VirtualBases.insert(Class->RD).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003547 Class = MSRTTIClass::getNextChild(Class);
3548 continue;
3549 }
David Blaikie82e95a32014-11-19 07:49:47 +00003550 if (!UniqueBases.insert(Class->RD).second)
David Majnemere2cb8d12014-07-07 06:20:47 +00003551 AmbiguousBases.insert(Class->RD);
3552 Class++;
3553 }
3554 if (AmbiguousBases.empty())
3555 return;
3556 for (MSRTTIClass &Class : Classes)
3557 if (AmbiguousBases.count(Class.RD))
3558 Class.Flags |= MSRTTIClass::IsAmbiguous;
3559}
3560
3561llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
3562 SmallString<256> MangledName;
3563 {
3564 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003565 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003566 }
3567
3568 // Check to see if we've already declared this ClassHierarchyDescriptor.
3569 if (auto CHD = Module.getNamedGlobal(MangledName))
3570 return CHD;
3571
3572 // Serialize the class hierarchy and initialize the CHD Fields.
3573 SmallVector<MSRTTIClass, 8> Classes;
3574 serializeClassHierarchy(Classes, RD);
3575 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3576 detectAmbiguousBases(Classes);
3577 int Flags = 0;
3578 for (auto Class : Classes) {
3579 if (Class.RD->getNumBases() > 1)
3580 Flags |= HasBranchingHierarchy;
3581 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
3582 // believe the field isn't actually used.
3583 if (Class.Flags & MSRTTIClass::IsAmbiguous)
3584 Flags |= HasAmbiguousBases;
3585 }
3586 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
3587 Flags |= HasVirtualBranchingHierarchy;
3588 // These gep indices are used to get the address of the first element of the
3589 // base class array.
3590 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
3591 llvm::ConstantInt::get(CGM.IntTy, 0)};
3592
3593 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00003594 auto Type = ABI.getClassHierarchyDescriptorType();
Rui Ueyama49a3ad22019-07-16 04:46:31 +00003595 auto CHD = new llvm::GlobalVariable(Module, Type, /*isConstant=*/true, Linkage,
David Majnemere2cb8d12014-07-07 06:20:47 +00003596 /*Initializer=*/nullptr,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003597 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003598 if (CHD->isWeakForLinker())
3599 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003600
David Blaikiee3b172a2015-04-02 18:55:21 +00003601 auto *Bases = getBaseClassArray(Classes);
3602
David Majnemere2cb8d12014-07-07 06:20:47 +00003603 // Initialize the base class ClassHierarchyDescriptor.
3604 llvm::Constant *Fields[] = {
Saleem Abdulrasoola9e14502017-01-01 19:16:02 +00003605 llvm::ConstantInt::get(CGM.IntTy, 0), // reserved by the runtime
David Majnemer611cdb92014-07-07 08:09:15 +00003606 llvm::ConstantInt::get(CGM.IntTy, Flags),
3607 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
3608 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00003609 Bases->getValueType(), Bases,
David Majnemer611cdb92014-07-07 08:09:15 +00003610 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00003611 };
3612 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3613 return CHD;
3614}
3615
3616llvm::GlobalVariable *
3617MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3618 SmallString<256> MangledName;
3619 {
3620 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003621 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003622 }
3623
3624 // Forward-declare the base class array.
3625 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3626 // mode) bytes of padding. We provide a pointer sized amount of padding by
3627 // adding +1 to Classes.size(). The sections have pointer alignment and are
3628 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00003629 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00003630 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00003631 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
David Majnemer7c237072015-03-05 00:46:22 +00003632 auto *BCA =
3633 new llvm::GlobalVariable(Module, ArrType,
Rui Ueyama49a3ad22019-07-16 04:46:31 +00003634 /*isConstant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003635 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003636 if (BCA->isWeakForLinker())
3637 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003638
3639 // Initialize the BaseClassArray.
3640 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3641 for (MSRTTIClass &Class : Classes)
3642 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00003643 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00003644 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00003645 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00003646 return BCA;
3647}
3648
3649llvm::GlobalVariable *
3650MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3651 // Compute the fields for the BaseClassDescriptor. They are computed up front
3652 // because they are mangled into the name of the object.
3653 uint32_t OffsetInVBTable = 0;
3654 int32_t VBPtrOffset = -1;
3655 if (Class.VirtualRoot) {
3656 auto &VTableContext = CGM.getMicrosoftVTableContext();
3657 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3658 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3659 }
3660
3661 SmallString<256> MangledName;
3662 {
3663 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003664 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3665 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3666 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003667 }
3668
David Majnemer26a90f82014-07-07 15:29:10 +00003669 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00003670 if (auto BCD = Module.getNamedGlobal(MangledName))
3671 return BCD;
3672
3673 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00003674 auto Type = ABI.getBaseClassDescriptorType();
David Majnemer7c237072015-03-05 00:46:22 +00003675 auto BCD =
Rui Ueyama49a3ad22019-07-16 04:46:31 +00003676 new llvm::GlobalVariable(Module, Type, /*isConstant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003677 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003678 if (BCD->isWeakForLinker())
3679 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003680
3681 // Initialize the BaseClassDescriptor.
3682 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003683 ABI.getImageRelativeConstant(
David Majnemer443250f2015-03-17 20:35:00 +00003684 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003685 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3686 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3687 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3688 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3689 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3690 ABI.getImageRelativeConstant(
3691 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00003692 };
3693 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3694 return BCD;
3695}
3696
3697llvm::GlobalVariable *
Justin Lebar562914e2016-10-10 16:26:29 +00003698MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo &Info) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003699 SmallString<256> MangledName;
3700 {
3701 llvm::raw_svector_ostream Out(MangledName);
Justin Lebar562914e2016-10-10 16:26:29 +00003702 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info.MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003703 }
3704
3705 // Check to see if we've already computed this complete object locator.
3706 if (auto COL = Module.getNamedGlobal(MangledName))
3707 return COL;
3708
3709 // Compute the fields of the complete object locator.
Justin Lebar562914e2016-10-10 16:26:29 +00003710 int OffsetToTop = Info.FullOffsetInMDC.getQuantity();
David Majnemere2cb8d12014-07-07 06:20:47 +00003711 int VFPtrOffset = 0;
3712 // The offset includes the vtordisp if one exists.
Justin Lebar562914e2016-10-10 16:26:29 +00003713 if (const CXXRecordDecl *VBase = Info.getVBaseWithVPtr())
David Majnemere2cb8d12014-07-07 06:20:47 +00003714 if (Context.getASTRecordLayout(RD)
3715 .getVBaseOffsetsMap()
3716 .find(VBase)
3717 ->second.hasVtorDisp())
Justin Lebar562914e2016-10-10 16:26:29 +00003718 VFPtrOffset = Info.NonVirtualOffset.getQuantity() + 4;
David Majnemere2cb8d12014-07-07 06:20:47 +00003719
3720 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00003721 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
Rui Ueyama49a3ad22019-07-16 04:46:31 +00003722 auto COL = new llvm::GlobalVariable(Module, Type, /*isConstant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003723 /*Initializer=*/nullptr, MangledName);
David Majnemere2cb8d12014-07-07 06:20:47 +00003724
3725 // Initialize the CompleteObjectLocator.
3726 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003727 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3728 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3729 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3730 ABI.getImageRelativeConstant(
3731 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3732 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3733 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00003734 };
3735 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00003736 if (!ABI.isImageRelative())
3737 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00003738 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
Rafael Espindola654542a2015-01-16 19:23:42 +00003739 if (COL->isWeakForLinker())
3740 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003741 return COL;
3742}
3743
David Majnemerad803d42015-03-15 07:10:01 +00003744static QualType decomposeTypeForEH(ASTContext &Context, QualType T,
David Majnemer526793d2016-07-12 04:42:50 +00003745 bool &IsConst, bool &IsVolatile,
3746 bool &IsUnaligned) {
David Majnemerad803d42015-03-15 07:10:01 +00003747 T = Context.getExceptionObjectType(T);
3748
3749 // C++14 [except.handle]p3:
3750 // A handler is a match for an exception object of type E if [...]
3751 // - the handler is of type cv T or const T& where T is a pointer type and
3752 // E is a pointer type that can be converted to T by [...]
3753 // - a qualification conversion
3754 IsConst = false;
3755 IsVolatile = false;
David Majnemer526793d2016-07-12 04:42:50 +00003756 IsUnaligned = false;
David Majnemerad803d42015-03-15 07:10:01 +00003757 QualType PointeeType = T->getPointeeType();
3758 if (!PointeeType.isNull()) {
3759 IsConst = PointeeType.isConstQualified();
3760 IsVolatile = PointeeType.isVolatileQualified();
David Majnemer526793d2016-07-12 04:42:50 +00003761 IsUnaligned = PointeeType.getQualifiers().hasUnaligned();
David Majnemerad803d42015-03-15 07:10:01 +00003762 }
3763
3764 // Member pointer types like "const int A::*" are represented by having RTTI
3765 // for "int A::*" and separately storing the const qualifier.
3766 if (const auto *MPTy = T->getAs<MemberPointerType>())
3767 T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(),
3768 MPTy->getClass());
3769
3770 // Pointer types like "const int * const *" are represented by having RTTI
3771 // for "const int **" and separately storing the const qualifier.
3772 if (T->isPointerType())
3773 T = Context.getPointerType(PointeeType.getUnqualifiedType());
3774
3775 return T;
3776}
3777
Reid Kleckner10aa7702015-09-16 20:15:55 +00003778CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +00003779MicrosoftCXXABI::getAddrOfCXXCatchHandlerType(QualType Type,
3780 QualType CatchHandlerType) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003781 // TypeDescriptors for exceptions never have qualified pointer types,
Simon Pilgrim2c518802017-03-30 14:13:19 +00003782 // qualifiers are stored separately in order to support qualification
David Majnemer443250f2015-03-17 20:35:00 +00003783 // conversions.
David Majnemer526793d2016-07-12 04:42:50 +00003784 bool IsConst, IsVolatile, IsUnaligned;
3785 Type =
3786 decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile, IsUnaligned);
David Majnemer443250f2015-03-17 20:35:00 +00003787
David Majnemer5f0dd612015-03-17 20:35:05 +00003788 bool IsReference = CatchHandlerType->isReferenceType();
3789
David Majnemer5f0dd612015-03-17 20:35:05 +00003790 uint32_t Flags = 0;
3791 if (IsConst)
3792 Flags |= 1;
3793 if (IsVolatile)
3794 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00003795 if (IsUnaligned)
3796 Flags |= 4;
David Majnemer5f0dd612015-03-17 20:35:05 +00003797 if (IsReference)
3798 Flags |= 8;
3799
Reid Kleckner10aa7702015-09-16 20:15:55 +00003800 return CatchTypeInfo{getAddrOfRTTIDescriptor(Type)->stripPointerCasts(),
3801 Flags};
David Majnemer443250f2015-03-17 20:35:00 +00003802}
3803
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003804/// Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
David Majnemere2cb8d12014-07-07 06:20:47 +00003805/// llvm::GlobalVariable * because different type descriptors have different
3806/// types, and need to be abstracted. They are abstracting by casting the
3807/// address to an Int8PtrTy.
David Majnemer443250f2015-03-17 20:35:00 +00003808llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003809 SmallString<256> MangledName;
David Majnemere2cb8d12014-07-07 06:20:47 +00003810 {
3811 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003812 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003813 }
3814
3815 // Check to see if we've already declared this TypeDescriptor.
3816 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3817 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3818
Piotr Padlewskid3b1cbd2017-06-01 08:04:05 +00003819 // Note for the future: If we would ever like to do deferred emission of
3820 // RTTI, check if emitting vtables opportunistically need any adjustment.
3821
David Majnemere2cb8d12014-07-07 06:20:47 +00003822 // Compute the fields for the TypeDescriptor.
David Majnemer5f0dd612015-03-17 20:35:05 +00003823 SmallString<256> TypeInfoString;
David Majnemere2cb8d12014-07-07 06:20:47 +00003824 {
3825 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00003826 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003827 }
3828
3829 // Declare and initialize the TypeDescriptor.
3830 llvm::Constant *Fields[] = {
3831 getTypeInfoVTable(CGM), // VFPtr
3832 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3833 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3834 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00003835 getTypeDescriptorType(TypeInfoString);
Rafael Espindola654542a2015-01-16 19:23:42 +00003836 auto *Var = new llvm::GlobalVariable(
Rui Ueyama49a3ad22019-07-16 04:46:31 +00003837 CGM.getModule(), TypeDescriptorType, /*isConstant=*/false,
Rafael Espindola654542a2015-01-16 19:23:42 +00003838 getLinkageForRTTI(Type),
3839 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
Yaron Keren2c07cc72015-12-01 08:14:39 +00003840 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003841 if (Var->isWeakForLinker())
3842 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3843 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003844}
3845
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003846/// Gets or a creates a Microsoft CompleteObjectLocator.
David Majnemere2cb8d12014-07-07 06:20:47 +00003847llvm::GlobalVariable *
3848MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
Justin Lebar562914e2016-10-10 16:26:29 +00003849 const VPtrInfo &Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00003850 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003851}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003852
Peter Collingbourned1c5b282019-03-22 23:05:10 +00003853void MicrosoftCXXABI::emitCXXStructor(GlobalDecl GD) {
3854 if (auto *ctor = dyn_cast<CXXConstructorDecl>(GD.getDecl())) {
3855 // There are no constructor variants, always emit the complete destructor.
3856 llvm::Function *Fn =
3857 CGM.codegenCXXStructor(GD.getWithCtorType(Ctor_Complete));
3858 CGM.maybeSetTrivialComdat(*ctor, *Fn);
3859 return;
3860 }
Rafael Espindola91f68b42014-09-15 19:20:10 +00003861
Peter Collingbourned1c5b282019-03-22 23:05:10 +00003862 auto *dtor = cast<CXXDestructorDecl>(GD.getDecl());
3863
Reid Klecknerae9b0702018-03-16 19:40:50 +00003864 // Emit the base destructor if the base and complete (vbase) destructors are
3865 // equivalent. This effectively implements -mconstructor-aliases as part of
3866 // the ABI.
Peter Collingbourned1c5b282019-03-22 23:05:10 +00003867 if (GD.getDtorType() == Dtor_Complete &&
Reid Klecknerae9b0702018-03-16 19:40:50 +00003868 dtor->getParent()->getNumVBases() == 0)
Peter Collingbourned1c5b282019-03-22 23:05:10 +00003869 GD = GD.getWithDtorType(Dtor_Base);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003870
3871 // The base destructor is equivalent to the base destructor of its
3872 // base class if there is exactly one non-virtual base class with a
3873 // non-trivial destructor, there are no fields with a non-trivial
3874 // destructor, and the body of the destructor is trivial.
Peter Collingbourned1c5b282019-03-22 23:05:10 +00003875 if (GD.getDtorType() == Dtor_Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
Rafael Espindola91f68b42014-09-15 19:20:10 +00003876 return;
3877
Peter Collingbourned1c5b282019-03-22 23:05:10 +00003878 llvm::Function *Fn = CGM.codegenCXXStructor(GD);
Rafael Espindolad3e04692015-01-17 01:47:39 +00003879 if (Fn->isWeakForLinker())
3880 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003881}
3882
David Majnemerdfa6d202015-03-11 18:36:39 +00003883llvm::Function *
David Majnemer37fd66e2015-03-13 22:36:55 +00003884MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
3885 CXXCtorType CT) {
3886 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
3887
David Majnemerdfa6d202015-03-11 18:36:39 +00003888 // Calculate the mangled name.
3889 SmallString<256> ThunkName;
3890 llvm::raw_svector_ostream Out(ThunkName);
David Majnemer37fd66e2015-03-13 22:36:55 +00003891 getMangleContext().mangleCXXCtor(CD, CT, Out);
David Majnemerdfa6d202015-03-11 18:36:39 +00003892
3893 // If the thunk has been generated previously, just return it.
3894 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
3895 return cast<llvm::Function>(GV);
3896
3897 // Create the llvm::Function.
David Majnemer37fd66e2015-03-13 22:36:55 +00003898 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT);
David Majnemerdfa6d202015-03-11 18:36:39 +00003899 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
3900 const CXXRecordDecl *RD = CD->getParent();
3901 QualType RecordTy = getContext().getRecordType(RD);
3902 llvm::Function *ThunkFn = llvm::Function::Create(
3903 ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule());
Reid Klecknerbba3cb92015-03-17 19:00:50 +00003904 ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>(
3905 FnInfo.getEffectiveCallingConvention()));
David Majnemer63aa2fb2015-06-30 21:23:51 +00003906 if (ThunkFn->isWeakForLinker())
3907 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
David Majnemer37fd66e2015-03-13 22:36:55 +00003908 bool IsCopy = CT == Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003909
3910 // Start codegen.
3911 CodeGenFunction CGF(CGM);
3912 CGF.CurGD = GlobalDecl(CD, Ctor_Complete);
3913
3914 // Build FunctionArgs.
3915 FunctionArgList FunctionArgs;
3916
David Majnemer37fd66e2015-03-13 22:36:55 +00003917 // A constructor always starts with a 'this' pointer as its first argument.
David Majnemerdfa6d202015-03-11 18:36:39 +00003918 buildThisParam(CGF, FunctionArgs);
3919
3920 // Following the 'this' pointer is a reference to the source object that we
3921 // are copying from.
3922 ImplicitParamDecl SrcParam(
Alexey Bataev56223232017-06-09 13:40:18 +00003923 getContext(), /*DC=*/nullptr, SourceLocation(),
3924 &getContext().Idents.get("src"),
David Majnemerdfa6d202015-03-11 18:36:39 +00003925 getContext().getLValueReferenceType(RecordTy,
Alexey Bataev56223232017-06-09 13:40:18 +00003926 /*SpelledAsLValue=*/true),
3927 ImplicitParamDecl::Other);
David Majnemer37fd66e2015-03-13 22:36:55 +00003928 if (IsCopy)
3929 FunctionArgs.push_back(&SrcParam);
David Majnemerdfa6d202015-03-11 18:36:39 +00003930
David Majnemer37fd66e2015-03-13 22:36:55 +00003931 // Constructors for classes which utilize virtual bases have an additional
3932 // parameter which indicates whether or not it is being delegated to by a more
3933 // derived constructor.
Alexey Bataev56223232017-06-09 13:40:18 +00003934 ImplicitParamDecl IsMostDerived(getContext(), /*DC=*/nullptr,
3935 SourceLocation(),
David Majnemerdfa6d202015-03-11 18:36:39 +00003936 &getContext().Idents.get("is_most_derived"),
Alexey Bataev56223232017-06-09 13:40:18 +00003937 getContext().IntTy, ImplicitParamDecl::Other);
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003938 // Only add the parameter to the list if the class has virtual bases.
David Majnemerdfa6d202015-03-11 18:36:39 +00003939 if (RD->getNumVBases() > 0)
3940 FunctionArgs.push_back(&IsMostDerived);
3941
3942 // Start defining the function.
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003943 auto NL = ApplyDebugLocation::CreateEmpty(CGF);
David Majnemerdfa6d202015-03-11 18:36:39 +00003944 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
3945 FunctionArgs, CD->getLocation(), SourceLocation());
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003946 // Create a scope with an artificial location for the body of this function.
3947 auto AL = ApplyDebugLocation::CreateArtificial(CGF);
Reid Kleckner06239e42017-11-16 19:09:36 +00003948 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
David Majnemerdfa6d202015-03-11 18:36:39 +00003949 llvm::Value *This = getThisValue(CGF);
3950
3951 llvm::Value *SrcVal =
David Majnemer37fd66e2015-03-13 22:36:55 +00003952 IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src")
3953 : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003954
3955 CallArgList Args;
3956
3957 // Push the this ptr.
Brian Gesiak5488ab42019-01-11 01:54:53 +00003958 Args.add(RValue::get(This), CD->getThisType());
David Majnemerdfa6d202015-03-11 18:36:39 +00003959
3960 // Push the src ptr.
David Majnemer37fd66e2015-03-13 22:36:55 +00003961 if (SrcVal)
3962 Args.add(RValue::get(SrcVal), SrcParam.getType());
David Majnemerdfa6d202015-03-11 18:36:39 +00003963
3964 // Add the rest of the default arguments.
Reid Klecknerc01ee752016-11-23 16:51:30 +00003965 SmallVector<const Stmt *, 4> ArgVec;
3966 ArrayRef<ParmVarDecl *> params = CD->parameters().drop_front(IsCopy ? 1 : 0);
3967 for (const ParmVarDecl *PD : params) {
3968 assert(PD->hasDefaultArg() && "ctor closure lacks default args");
3969 ArgVec.push_back(PD->getDefaultArg());
Reid Kleckner93f661a2015-03-17 21:51:43 +00003970 }
David Majnemerdfa6d202015-03-11 18:36:39 +00003971
3972 CodeGenFunction::RunCleanupsScope Cleanups(CGF);
3973
3974 const auto *FPT = CD->getType()->castAs<FunctionProtoType>();
David Blaikief05779e2015-07-21 18:37:18 +00003975 CGF.EmitCallArgs(Args, FPT, llvm::makeArrayRef(ArgVec), CD, IsCopy ? 1 : 0);
David Majnemerdfa6d202015-03-11 18:36:39 +00003976
3977 // Insert any ABI-specific implicit constructor arguments.
George Burgess IVf203dbf2017-02-22 20:28:02 +00003978 AddedStructorArgs ExtraArgs =
3979 addImplicitConstructorArgs(CGF, CD, Ctor_Complete,
3980 /*ForVirtualBase=*/false,
3981 /*Delegating=*/false, Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00003982 // Call the destructor with our arguments.
John McCallb92ab1a2016-10-26 23:46:34 +00003983 llvm::Constant *CalleePtr =
Peter Collingbourned1c5b282019-03-22 23:05:10 +00003984 CGM.getAddrOfCXXStructor(GlobalDecl(CD, Ctor_Complete));
Erich Keanede6480a32018-11-13 15:48:08 +00003985 CGCallee Callee =
3986 CGCallee::forDirect(CalleePtr, GlobalDecl(CD, Ctor_Complete));
David Majnemerdfa6d202015-03-11 18:36:39 +00003987 const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall(
George Burgess IVd0a9e802017-02-23 22:07:35 +00003988 Args, CD, Ctor_Complete, ExtraArgs.Prefix, ExtraArgs.Suffix);
John McCallb92ab1a2016-10-26 23:46:34 +00003989 CGF.EmitCall(CalleeInfo, Callee, ReturnValueSlot(), Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00003990
3991 Cleanups.ForceCleanup();
3992
3993 // Emit the ret instruction, remove any temporary instructions created for the
3994 // aid of CodeGen.
3995 CGF.FinishFunction(SourceLocation());
3996
3997 return ThunkFn;
3998}
3999
David Majnemer7c237072015-03-05 00:46:22 +00004000llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
4001 uint32_t NVOffset,
4002 int32_t VBPtrOffset,
4003 uint32_t VBIndex) {
4004 assert(!T->isReferenceType());
4005
David Majnemere7a818f2015-03-06 18:53:55 +00004006 CXXRecordDecl *RD = T->getAsCXXRecordDecl();
4007 const CXXConstructorDecl *CD =
4008 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00004009 CXXCtorType CT = Ctor_Complete;
David Majnemer37fd66e2015-03-13 22:36:55 +00004010 if (CD)
4011 if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1)
David Majnemerdfa6d202015-03-11 18:36:39 +00004012 CT = Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00004013
David Majnemer7c237072015-03-05 00:46:22 +00004014 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
4015 SmallString<256> MangledName;
4016 {
4017 llvm::raw_svector_ostream Out(MangledName);
David Majnemerdfa6d202015-03-11 18:36:39 +00004018 getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +00004019 VBPtrOffset, VBIndex, Out);
David Majnemer7c237072015-03-05 00:46:22 +00004020 }
4021 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4022 return getImageRelativeConstant(GV);
4023
David Majnemerdfa6d202015-03-11 18:36:39 +00004024 // The TypeDescriptor is used by the runtime to determine if a catch handler
David Majnemer7c237072015-03-05 00:46:22 +00004025 // is appropriate for the exception object.
David Majnemer443250f2015-03-17 20:35:00 +00004026 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
David Majnemer7c237072015-03-05 00:46:22 +00004027
4028 // The runtime is responsible for calling the copy constructor if the
4029 // exception is caught by value.
David Majnemerdfa6d202015-03-11 18:36:39 +00004030 llvm::Constant *CopyCtor;
4031 if (CD) {
4032 if (CT == Ctor_CopyingClosure)
David Majnemer37fd66e2015-03-13 22:36:55 +00004033 CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure);
David Majnemerdfa6d202015-03-11 18:36:39 +00004034 else
Peter Collingbourned1c5b282019-03-22 23:05:10 +00004035 CopyCtor = CGM.getAddrOfCXXStructor(GlobalDecl(CD, Ctor_Complete));
David Majnemerdfa6d202015-03-11 18:36:39 +00004036
4037 CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy);
4038 } else {
4039 CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4040 }
David Majnemere7a818f2015-03-06 18:53:55 +00004041 CopyCtor = getImageRelativeConstant(CopyCtor);
David Majnemer7c237072015-03-05 00:46:22 +00004042
David Majnemere7a818f2015-03-06 18:53:55 +00004043 bool IsScalar = !RD;
David Majnemer7c237072015-03-05 00:46:22 +00004044 bool HasVirtualBases = false;
4045 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
David Majnemer7c237072015-03-05 00:46:22 +00004046 QualType PointeeType = T;
4047 if (T->isPointerType())
4048 PointeeType = T->getPointeeType();
4049 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
4050 HasVirtualBases = RD->getNumVBases() > 0;
4051 if (IdentifierInfo *II = RD->getIdentifier())
4052 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
4053 }
4054
4055 // Encode the relevant CatchableType properties into the Flags bitfield.
4056 // FIXME: Figure out how bits 2 or 8 can get set.
4057 uint32_t Flags = 0;
4058 if (IsScalar)
4059 Flags |= 1;
4060 if (HasVirtualBases)
4061 Flags |= 4;
4062 if (IsStdBadAlloc)
4063 Flags |= 16;
4064
4065 llvm::Constant *Fields[] = {
4066 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4067 TD, // TypeDescriptor
4068 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment
4069 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
4070 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex
4071 llvm::ConstantInt::get(CGM.IntTy, Size), // Size
4072 CopyCtor // CopyCtor
4073 };
4074 llvm::StructType *CTType = getCatchableTypeType();
4075 auto *GV = new llvm::GlobalVariable(
Rui Ueyama49a3ad22019-07-16 04:46:31 +00004076 CGM.getModule(), CTType, /*isConstant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004077 llvm::ConstantStruct::get(CTType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004078 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004079 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004080 if (GV->isWeakForLinker())
4081 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004082 return getImageRelativeConstant(GV);
4083}
4084
4085llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
4086 assert(!T->isReferenceType());
4087
4088 // See if we've already generated a CatchableTypeArray for this type before.
4089 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
4090 if (CTA)
4091 return CTA;
4092
4093 // Ensure that we don't have duplicate entries in our CatchableTypeArray by
4094 // using a SmallSetVector. Duplicates may arise due to virtual bases
4095 // occurring more than once in the hierarchy.
4096 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
4097
4098 // C++14 [except.handle]p3:
4099 // A handler is a match for an exception object of type E if [...]
4100 // - the handler is of type cv T or cv T& and T is an unambiguous public
4101 // base class of E, or
4102 // - the handler is of type cv T or const T& where T is a pointer type and
4103 // E is a pointer type that can be converted to T by [...]
4104 // - a standard pointer conversion (4.10) not involving conversions to
4105 // pointers to private or protected or ambiguous classes
4106 const CXXRecordDecl *MostDerivedClass = nullptr;
4107 bool IsPointer = T->isPointerType();
4108 if (IsPointer)
4109 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
4110 else
4111 MostDerivedClass = T->getAsCXXRecordDecl();
4112
4113 // Collect all the unambiguous public bases of the MostDerivedClass.
4114 if (MostDerivedClass) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00004115 const ASTContext &Context = getContext();
David Majnemer7c237072015-03-05 00:46:22 +00004116 const ASTRecordLayout &MostDerivedLayout =
4117 Context.getASTRecordLayout(MostDerivedClass);
4118 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
4119 SmallVector<MSRTTIClass, 8> Classes;
4120 serializeClassHierarchy(Classes, MostDerivedClass);
4121 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
4122 detectAmbiguousBases(Classes);
4123 for (const MSRTTIClass &Class : Classes) {
4124 // Skip any ambiguous or private bases.
4125 if (Class.Flags &
4126 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
4127 continue;
4128 // Write down how to convert from a derived pointer to a base pointer.
4129 uint32_t OffsetInVBTable = 0;
4130 int32_t VBPtrOffset = -1;
4131 if (Class.VirtualRoot) {
4132 OffsetInVBTable =
4133 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
4134 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
4135 }
4136
4137 // Turn our record back into a pointer if the exception object is a
4138 // pointer.
4139 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
4140 if (IsPointer)
4141 RTTITy = Context.getPointerType(RTTITy);
4142 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
4143 VBPtrOffset, OffsetInVBTable));
4144 }
4145 }
4146
4147 // C++14 [except.handle]p3:
4148 // A handler is a match for an exception object of type E if
4149 // - The handler is of type cv T or cv T& and E and T are the same type
4150 // (ignoring the top-level cv-qualifiers)
4151 CatchableTypes.insert(getCatchableType(T));
4152
4153 // C++14 [except.handle]p3:
4154 // A handler is a match for an exception object of type E if
4155 // - the handler is of type cv T or const T& where T is a pointer type and
4156 // E is a pointer type that can be converted to T by [...]
4157 // - a standard pointer conversion (4.10) not involving conversions to
4158 // pointers to private or protected or ambiguous classes
4159 //
David Majnemerf205f532015-04-04 05:37:48 +00004160 // C++14 [conv.ptr]p2:
4161 // A prvalue of type "pointer to cv T," where T is an object type, can be
4162 // converted to a prvalue of type "pointer to cv void".
4163 if (IsPointer && T->getPointeeType()->isObjectType())
David Majnemer7c237072015-03-05 00:46:22 +00004164 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4165
David Majnemera1aea9a2015-03-12 17:44:49 +00004166 // C++14 [except.handle]p3:
4167 // A handler is a match for an exception object of type E if [...]
4168 // - the handler is of type cv T or const T& where T is a pointer or
4169 // pointer to member type and E is std::nullptr_t.
4170 //
4171 // We cannot possibly list all possible pointer types here, making this
4172 // implementation incompatible with the standard. However, MSVC includes an
4173 // entry for pointer-to-void in this case. Let's do the same.
4174 if (T->isNullPtrType())
4175 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4176
David Majnemer7c237072015-03-05 00:46:22 +00004177 uint32_t NumEntries = CatchableTypes.size();
4178 llvm::Type *CTType =
4179 getImageRelativeType(getCatchableTypeType()->getPointerTo());
4180 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
4181 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
4182 llvm::Constant *Fields[] = {
4183 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries
4184 llvm::ConstantArray::get(
4185 AT, llvm::makeArrayRef(CatchableTypes.begin(),
4186 CatchableTypes.end())) // CatchableTypes
4187 };
4188 SmallString<256> MangledName;
4189 {
4190 llvm::raw_svector_ostream Out(MangledName);
4191 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
4192 }
4193 CTA = new llvm::GlobalVariable(
Rui Ueyama49a3ad22019-07-16 04:46:31 +00004194 CGM.getModule(), CTAType, /*isConstant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004195 llvm::ConstantStruct::get(CTAType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004196 CTA->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004197 CTA->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004198 if (CTA->isWeakForLinker())
4199 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004200 return CTA;
4201}
4202
4203llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
David Majnemer526793d2016-07-12 04:42:50 +00004204 bool IsConst, IsVolatile, IsUnaligned;
4205 T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile, IsUnaligned);
David Majnemer7c237072015-03-05 00:46:22 +00004206
4207 // The CatchableTypeArray enumerates the various (CV-unqualified) types that
4208 // the exception object may be caught as.
4209 llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
4210 // The first field in a CatchableTypeArray is the number of CatchableTypes.
4211 // This is used as a component of the mangled name which means that we need to
4212 // know what it is in order to see if we have previously generated the
4213 // ThrowInfo.
4214 uint32_t NumEntries =
4215 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
4216 ->getLimitedValue();
4217
4218 SmallString<256> MangledName;
4219 {
4220 llvm::raw_svector_ostream Out(MangledName);
David Majnemer526793d2016-07-12 04:42:50 +00004221 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, IsUnaligned,
4222 NumEntries, Out);
David Majnemer7c237072015-03-05 00:46:22 +00004223 }
4224
4225 // Reuse a previously generated ThrowInfo if we have generated an appropriate
4226 // one before.
4227 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4228 return GV;
4229
4230 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
4231 // be at least as CV qualified. Encode this requirement into the Flags
4232 // bitfield.
4233 uint32_t Flags = 0;
4234 if (IsConst)
4235 Flags |= 1;
4236 if (IsVolatile)
4237 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00004238 if (IsUnaligned)
4239 Flags |= 4;
David Majnemer7c237072015-03-05 00:46:22 +00004240
4241 // The cleanup-function (a destructor) must be called when the exception
4242 // object's lifetime ends.
4243 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4244 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
4245 if (CXXDestructorDecl *DtorD = RD->getDestructor())
4246 if (!DtorD->isTrivial())
4247 CleanupFn = llvm::ConstantExpr::getBitCast(
Peter Collingbourned1c5b282019-03-22 23:05:10 +00004248 CGM.getAddrOfCXXStructor(GlobalDecl(DtorD, Dtor_Complete)),
David Majnemer7c237072015-03-05 00:46:22 +00004249 CGM.Int8PtrTy);
4250 // This is unused as far as we can tell, initialize it to null.
4251 llvm::Constant *ForwardCompat =
4252 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
4253 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
4254 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
4255 llvm::StructType *TIType = getThrowInfoType();
4256 llvm::Constant *Fields[] = {
4257 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4258 getImageRelativeConstant(CleanupFn), // CleanupFn
4259 ForwardCompat, // ForwardCompat
4260 PointerToCatchableTypes // CatchableTypeArray
4261 };
4262 auto *GV = new llvm::GlobalVariable(
Rui Ueyama49a3ad22019-07-16 04:46:31 +00004263 CGM.getModule(), TIType, /*isConstant=*/true, getLinkageForRTTI(T),
David Majnemer7c237072015-03-05 00:46:22 +00004264 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004265 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004266 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004267 if (GV->isWeakForLinker())
4268 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004269 return GV;
4270}
4271
4272void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
4273 const Expr *SubExpr = E->getSubExpr();
4274 QualType ThrowType = SubExpr->getType();
4275 // The exception object lives on the stack and it's address is passed to the
4276 // runtime function.
John McCall7f416cc2015-09-08 08:05:57 +00004277 Address AI = CGF.CreateMemTemp(ThrowType);
David Majnemer7c237072015-03-05 00:46:22 +00004278 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
4279 /*IsInit=*/true);
4280
4281 // The so-called ThrowInfo is used to describe how the exception object may be
4282 // caught.
4283 llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
4284
4285 // Call into the runtime to throw the exception.
John McCall7f416cc2015-09-08 08:05:57 +00004286 llvm::Value *Args[] = {
4287 CGF.Builder.CreateBitCast(AI.getPointer(), CGM.Int8PtrTy),
4288 TI
4289 };
David Majnemer7c237072015-03-05 00:46:22 +00004290 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
4291}
Peter Collingbourne60108802017-12-13 21:53:04 +00004292
4293std::pair<llvm::Value *, const CXXRecordDecl *>
4294MicrosoftCXXABI::LoadVTablePtr(CodeGenFunction &CGF, Address This,
4295 const CXXRecordDecl *RD) {
4296 std::tie(This, std::ignore, RD) =
4297 performBaseAdjustment(CGF, This, QualType(RD->getTypeForDecl(), 0));
4298 return {CGF.GetVTablePtr(This, CGM.Int8PtrTy, RD), RD};
4299}