blob: d7fac79c86e8ea4bac148ffc8f39b0d7bb5ee2ce [file] [log] [blame]
Charles Davis74ce8592010-06-09 23:25:41 +00001//===--- MicrosoftCXXABI.cpp - Emit LLVM Code from ASTs for a Module ------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
Chris Lattner57540c52011-04-15 05:22:18 +000010// This provides C++ code generation targeting the Microsoft Visual C++ ABI.
Charles Davis74ce8592010-06-09 23:25:41 +000011// The class in this file generates structures that follow the Microsoft
12// Visual C++ ABI, which is actually not very well documented at all outside
13// of Microsoft.
14//
15//===----------------------------------------------------------------------===//
16
17#include "CGCXXABI.h"
Reid Kleckner10aa7702015-09-16 20:15:55 +000018#include "CGCleanup.h"
Reid Kleckner7810af02013-06-19 15:20:38 +000019#include "CGVTables.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000020#include "CodeGenModule.h"
David Majnemere7a818f2015-03-06 18:53:55 +000021#include "CodeGenTypes.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000022#include "TargetInfo.h"
John McCall5ad74072017-03-02 20:04:19 +000023#include "clang/CodeGen/ConstantInitBuilder.h"
Charles Davis74ce8592010-06-09 23:25:41 +000024#include "clang/AST/Decl.h"
25#include "clang/AST/DeclCXX.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000026#include "clang/AST/StmtCXX.h"
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +000027#include "clang/AST/VTableBuilder.h"
David Majnemer611cdb92014-07-07 08:09:15 +000028#include "llvm/ADT/StringExtras.h"
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +000029#include "llvm/ADT/StringSet.h"
David Majnemer1162d252014-06-22 19:05:33 +000030#include "llvm/IR/CallSite.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000031#include "llvm/IR/Intrinsics.h"
Charles Davis74ce8592010-06-09 23:25:41 +000032
33using namespace clang;
34using namespace CodeGen;
35
36namespace {
37
Reid Klecknerb40a27d2014-01-03 00:14:35 +000038/// Holds all the vbtable globals for a given class.
39struct VBTableGlobals {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +000040 const VPtrInfoVector *VBTables;
Reid Klecknerb40a27d2014-01-03 00:14:35 +000041 SmallVector<llvm::GlobalVariable *, 2> Globals;
42};
43
Charles Davis53c59df2010-08-16 03:33:14 +000044class MicrosoftCXXABI : public CGCXXABI {
Charles Davis74ce8592010-06-09 23:25:41 +000045public:
David Majnemer611cdb92014-07-07 08:09:15 +000046 MicrosoftCXXABI(CodeGenModule &CGM)
47 : CGCXXABI(CGM), BaseClassDescriptorType(nullptr),
48 ClassHierarchyDescriptorType(nullptr),
David Majnemer7c237072015-03-05 00:46:22 +000049 CompleteObjectLocatorType(nullptr), CatchableTypeType(nullptr),
Benjamin Kramerc2d2b422015-10-15 15:29:40 +000050 ThrowInfoType(nullptr) {}
John McCall5d865c322010-08-31 07:33:07 +000051
Craig Topper4f12f102014-03-12 06:41:41 +000052 bool HasThisReturn(GlobalDecl GD) const override;
David Majnemer0c0b6d92014-10-31 20:09:12 +000053 bool hasMostDerivedReturn(GlobalDecl GD) const override;
Stephen Lin9dc6eef2013-06-30 20:40:16 +000054
Reid Kleckner40ca9132014-05-13 22:05:45 +000055 bool classifyReturnType(CGFunctionInfo &FI) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000056
Reid Klecknere39ee212014-05-03 00:33:28 +000057 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000058
Reid Kleckner37abaca2014-05-09 22:46:15 +000059 bool isSRetParameterAfterThis() const override { return true; }
60
John McCall7f416cc2015-09-08 08:05:57 +000061 bool isThisCompleteObject(GlobalDecl GD) const override {
62 // The Microsoft ABI doesn't use separate complete-object vs.
63 // base-object variants of constructors, but it does of destructors.
64 if (isa<CXXDestructorDecl>(GD.getDecl())) {
65 switch (GD.getDtorType()) {
66 case Dtor_Complete:
67 case Dtor_Deleting:
68 return true;
69
70 case Dtor_Base:
71 return false;
72
73 case Dtor_Comdat: llvm_unreachable("emitting dtor comdat as function?");
74 }
75 llvm_unreachable("bad dtor kind");
76 }
77
78 // No other kinds.
79 return false;
80 }
81
David Majnemer196ac332014-09-11 23:05:02 +000082 size_t getSrcArgforCopyCtor(const CXXConstructorDecl *CD,
83 FunctionArgList &Args) const override {
84 assert(Args.size() >= 2 &&
85 "expected the arglist to have at least two args!");
86 // The 'most_derived' parameter goes second if the ctor is variadic and
87 // has v-bases.
88 if (CD->getParent()->getNumVBases() > 0 &&
89 CD->getType()->castAs<FunctionProtoType>()->isVariadic())
90 return 2;
91 return 1;
92 }
93
David Majnemer8671c6e2015-11-02 09:01:44 +000094 std::vector<CharUnits> getVBPtrOffsets(const CXXRecordDecl *RD) override {
95 std::vector<CharUnits> VBPtrOffsets;
96 const ASTContext &Context = getContext();
97 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
98
99 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
Justin Lebar562914e2016-10-10 16:26:29 +0000100 for (const std::unique_ptr<VPtrInfo> &VBT : *VBGlobals.VBTables) {
David Majnemer8671c6e2015-11-02 09:01:44 +0000101 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +0000102 Context.getASTRecordLayout(VBT->IntroducingObject);
David Majnemer8671c6e2015-11-02 09:01:44 +0000103 CharUnits Offs = VBT->NonVirtualOffset;
104 Offs += SubobjectLayout.getVBPtrOffset();
105 if (VBT->getVBaseWithVPtr())
106 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
107 VBPtrOffsets.push_back(Offs);
108 }
109 llvm::array_pod_sort(VBPtrOffsets.begin(), VBPtrOffsets.end());
110 return VBPtrOffsets;
111 }
112
Craig Topper4f12f102014-03-12 06:41:41 +0000113 StringRef GetPureVirtualCallName() override { return "_purecall"; }
Craig Topper4f12f102014-03-12 06:41:41 +0000114 StringRef GetDeletedVirtualCallName() override { return "_purecall"; }
Joao Matos2ce88ef2012-07-17 17:10:11 +0000115
David Majnemer08681372014-11-01 07:37:17 +0000116 void emitVirtualObjectDelete(CodeGenFunction &CGF, const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000117 Address Ptr, QualType ElementType,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000118 const CXXDestructorDecl *Dtor) override;
John McCall82fb8922012-09-25 10:10:39 +0000119
Chandler Carruth4b9e8572014-11-25 08:59:34 +0000120 void emitRethrow(CodeGenFunction &CGF, bool isNoReturn) override;
David Majnemer7c237072015-03-05 00:46:22 +0000121 void emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) override;
David Majnemer442d0a22014-11-25 07:20:20 +0000122
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000123 void emitBeginCatch(CodeGenFunction &CGF, const CXXCatchStmt *C) override;
124
David Majnemere2cb8d12014-07-07 06:20:47 +0000125 llvm::GlobalVariable *getMSCompleteObjectLocator(const CXXRecordDecl *RD,
Justin Lebar562914e2016-10-10 16:26:29 +0000126 const VPtrInfo &Info);
David Majnemere2cb8d12014-07-07 06:20:47 +0000127
David Majnemer443250f2015-03-17 20:35:00 +0000128 llvm::Constant *getAddrOfRTTIDescriptor(QualType Ty) override;
Reid Kleckner10aa7702015-09-16 20:15:55 +0000129 CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +0000130 getAddrOfCXXCatchHandlerType(QualType Ty, QualType CatchHandlerType) override;
David Majnemere2cb8d12014-07-07 06:20:47 +0000131
Reid Kleckner10aa7702015-09-16 20:15:55 +0000132 /// MSVC needs an extra flag to indicate a catchall.
133 CatchTypeInfo getCatchAllTypeInfo() override {
134 return CatchTypeInfo{nullptr, 0x40};
135 }
136
David Majnemer1162d252014-06-22 19:05:33 +0000137 bool shouldTypeidBeNullChecked(bool IsDeref, QualType SrcRecordTy) override;
138 void EmitBadTypeidCall(CodeGenFunction &CGF) override;
139 llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000140 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000141 llvm::Type *StdTypeInfoPtrTy) override;
142
143 bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
144 QualType SrcRecordTy) override;
145
John McCall7f416cc2015-09-08 08:05:57 +0000146 llvm::Value *EmitDynamicCastCall(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000147 QualType SrcRecordTy, QualType DestTy,
148 QualType DestRecordTy,
149 llvm::BasicBlock *CastEnd) override;
150
John McCall7f416cc2015-09-08 08:05:57 +0000151 llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000152 QualType SrcRecordTy,
153 QualType DestTy) override;
154
155 bool EmitBadCastCall(CodeGenFunction &CGF) override;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000156 bool canSpeculativelyEmitVTable(const CXXRecordDecl *RD) const override {
Piotr Padlewskia68a7872015-07-24 04:04:49 +0000157 return false;
158 }
David Majnemer1162d252014-06-22 19:05:33 +0000159
Craig Topper4f12f102014-03-12 06:41:41 +0000160 llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +0000161 GetVirtualBaseClassOffset(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000162 const CXXRecordDecl *ClassDecl,
163 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000164
Craig Topper4f12f102014-03-12 06:41:41 +0000165 llvm::BasicBlock *
166 EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
167 const CXXRecordDecl *RD) override;
Erich Keane13c7ec52016-12-07 00:21:45 +0000168
169 llvm::BasicBlock *
170 EmitDtorCompleteObjectHandler(CodeGenFunction &CGF);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000171
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000172 void initializeHiddenVirtualInheritanceMembers(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000173 const CXXRecordDecl *RD) override;
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000174
Craig Topper4f12f102014-03-12 06:41:41 +0000175 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000176
Reid Klecknere7de47e2013-07-22 13:51:44 +0000177 // Background on MSVC destructors
178 // ==============================
179 //
180 // Both Itanium and MSVC ABIs have destructor variants. The variant names
181 // roughly correspond in the following way:
182 // Itanium Microsoft
183 // Base -> no name, just ~Class
184 // Complete -> vbase destructor
185 // Deleting -> scalar deleting destructor
186 // vector deleting destructor
187 //
188 // The base and complete destructors are the same as in Itanium, although the
189 // complete destructor does not accept a VTT parameter when there are virtual
190 // bases. A separate mechanism involving vtordisps is used to ensure that
191 // virtual methods of destroyed subobjects are not called.
192 //
193 // The deleting destructors accept an i32 bitfield as a second parameter. Bit
194 // 1 indicates if the memory should be deleted. Bit 2 indicates if the this
195 // pointer points to an array. The scalar deleting destructor assumes that
196 // bit 2 is zero, and therefore does not contain a loop.
197 //
198 // For virtual destructors, only one entry is reserved in the vftable, and it
199 // always points to the vector deleting destructor. The vector deleting
200 // destructor is the most general, so it can be used to destroy objects in
201 // place, delete single heap objects, or delete arrays.
202 //
203 // A TU defining a non-inline destructor is only guaranteed to emit a base
204 // destructor, and all of the other variants are emitted on an as-needed basis
205 // in COMDATs. Because a non-base destructor can be emitted in a TU that
206 // lacks a definition for the destructor, non-base destructors must always
207 // delegate to or alias the base destructor.
208
George Burgess IVf203dbf2017-02-22 20:28:02 +0000209 AddedStructorArgs
210 buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
211 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000212
Reid Klecknere7de47e2013-07-22 13:51:44 +0000213 /// Non-base dtors should be emitted as delegating thunks in this ABI.
214 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000215 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000216 return DT != Dtor_Base;
217 }
218
Reid Klecknerae9b0702018-03-16 19:40:50 +0000219 void setCXXDestructorDLLStorage(llvm::GlobalValue *GV,
220 const CXXDestructorDecl *Dtor,
221 CXXDtorType DT) const override;
222
223 llvm::GlobalValue::LinkageTypes
224 getCXXDestructorLinkage(GVALinkage Linkage, const CXXDestructorDecl *Dtor,
225 CXXDtorType DT) const override;
226
Craig Topper4f12f102014-03-12 06:41:41 +0000227 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000228
Craig Topper4f12f102014-03-12 06:41:41 +0000229 const CXXRecordDecl *
230 getThisArgumentTypeForMethod(const CXXMethodDecl *MD) override {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000231 MD = MD->getCanonicalDecl();
232 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD)) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000233 MicrosoftVTableContext::MethodVFTableLocation ML =
234 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000235 // The vbases might be ordered differently in the final overrider object
236 // and the complete object, so the "this" argument may sometimes point to
237 // memory that has no particular type (e.g. past the complete object).
238 // In this case, we just use a generic pointer type.
239 // FIXME: might want to have a more precise type in the non-virtual
240 // multiple inheritance case.
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +0000241 if (ML.VBase || !ML.VFPtrOffset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000242 return nullptr;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000243 }
244 return MD->getParent();
245 }
246
John McCall7f416cc2015-09-08 08:05:57 +0000247 Address
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000248 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD,
John McCall7f416cc2015-09-08 08:05:57 +0000249 Address This,
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000250 bool VirtualCall) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000251
Reid Kleckner89077a12013-12-17 19:46:40 +0000252 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000253 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000254
Craig Topper4f12f102014-03-12 06:41:41 +0000255 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall29036752011-01-27 02:46:02 +0000256
George Burgess IVf203dbf2017-02-22 20:28:02 +0000257 AddedStructorArgs
258 addImplicitConstructorArgs(CodeGenFunction &CGF, const CXXConstructorDecl *D,
259 CXXCtorType Type, bool ForVirtualBase,
260 bool Delegating, CallArgList &Args) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000261
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000262 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
263 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +0000264 bool Delegating, Address This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000265
Justin Lebar562914e2016-10-10 16:26:29 +0000266 void emitVTableTypeMetadata(const VPtrInfo &Info, const CXXRecordDecl *RD,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +0000267 llvm::GlobalVariable *VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +0000268
Craig Topper4f12f102014-03-12 06:41:41 +0000269 void emitVTableDefinitions(CodeGenVTables &CGVT,
270 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000271
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000272 bool isVirtualOffsetNeededForVTableField(CodeGenFunction &CGF,
273 CodeGenFunction::VPtr Vptr) override;
274
275 /// Don't initialize vptrs if dynamic class
276 /// is marked with with the 'novtable' attribute.
277 bool doStructorsInitializeVPtrs(const CXXRecordDecl *VTableClass) override {
278 return !VTableClass->hasAttr<MSNoVTableAttr>();
279 }
280
281 llvm::Constant *
282 getVTableAddressPoint(BaseSubobject Base,
283 const CXXRecordDecl *VTableClass) override;
284
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000285 llvm::Value *getVTableAddressPointInStructor(
286 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000287 BaseSubobject Base, const CXXRecordDecl *NearestVBase) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000288
289 llvm::Constant *
290 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000291 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000292
293 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000294 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000295
John McCall9831b842018-02-06 18:52:44 +0000296 CGCallee getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
297 Address This, llvm::Type *Ty,
298 SourceLocation Loc) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000299
David Majnemer0c0b6d92014-10-31 20:09:12 +0000300 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF,
301 const CXXDestructorDecl *Dtor,
302 CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +0000303 Address This,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000304 const CXXMemberCallExpr *CE) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000305
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000306 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000307 CallArgList &CallArgs) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000308 assert(GD.getDtorType() == Dtor_Deleting &&
309 "Only deleting destructor thunks are available in this ABI");
310 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)),
David Majnemer9ced3dd2015-03-14 23:44:48 +0000311 getContext().IntTy);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000312 }
313
Craig Topper4f12f102014-03-12 06:41:41 +0000314 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000315
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000316 llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000317 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000318 llvm::GlobalVariable::LinkageTypes Linkage);
319
David Majnemerc1709d32015-06-23 07:31:11 +0000320 llvm::GlobalVariable *
321 getAddrOfVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
322 const CXXRecordDecl *DstRD) {
323 SmallString<256> OutName;
324 llvm::raw_svector_ostream Out(OutName);
325 getMangleContext().mangleCXXVirtualDisplacementMap(SrcRD, DstRD, Out);
David Majnemerc1709d32015-06-23 07:31:11 +0000326 StringRef MangledName = OutName.str();
327
328 if (auto *VDispMap = CGM.getModule().getNamedGlobal(MangledName))
329 return VDispMap;
330
331 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
332 unsigned NumEntries = 1 + SrcRD->getNumVBases();
333 SmallVector<llvm::Constant *, 4> Map(NumEntries,
334 llvm::UndefValue::get(CGM.IntTy));
335 Map[0] = llvm::ConstantInt::get(CGM.IntTy, 0);
336 bool AnyDifferent = false;
337 for (const auto &I : SrcRD->vbases()) {
338 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
339 if (!DstRD->isVirtuallyDerivedFrom(VBase))
340 continue;
341
342 unsigned SrcVBIndex = VTContext.getVBTableIndex(SrcRD, VBase);
343 unsigned DstVBIndex = VTContext.getVBTableIndex(DstRD, VBase);
344 Map[SrcVBIndex] = llvm::ConstantInt::get(CGM.IntTy, DstVBIndex * 4);
345 AnyDifferent |= SrcVBIndex != DstVBIndex;
346 }
347 // This map would be useless, don't use it.
348 if (!AnyDifferent)
349 return nullptr;
350
351 llvm::ArrayType *VDispMapTy = llvm::ArrayType::get(CGM.IntTy, Map.size());
352 llvm::Constant *Init = llvm::ConstantArray::get(VDispMapTy, Map);
353 llvm::GlobalValue::LinkageTypes Linkage =
354 SrcRD->isExternallyVisible() && DstRD->isExternallyVisible()
355 ? llvm::GlobalValue::LinkOnceODRLinkage
356 : llvm::GlobalValue::InternalLinkage;
357 auto *VDispMap = new llvm::GlobalVariable(
358 CGM.getModule(), VDispMapTy, /*Constant=*/true, Linkage,
359 /*Initializer=*/Init, MangledName);
360 return VDispMap;
361 }
362
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000363 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000364 llvm::GlobalVariable *GV) const;
365
Hans Wennborgc94391d2014-06-06 20:04:01 +0000366 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
367 GlobalDecl GD, bool ReturnAdjustment) override {
Hans Wennborgc94391d2014-06-06 20:04:01 +0000368 GVALinkage Linkage =
369 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
370
371 if (Linkage == GVA_Internal)
372 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
373 else if (ReturnAdjustment)
374 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
375 else
376 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000377 }
378
Rafael Espindolab7350042018-03-01 00:35:47 +0000379 bool exportThunk() override { return false; }
380
John McCall7f416cc2015-09-08 08:05:57 +0000381 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000382 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000383
John McCall7f416cc2015-09-08 08:05:57 +0000384 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000385 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000386
David Majnemerb3341ea2014-10-05 05:05:40 +0000387 void EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +0000388 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +0000389 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +0000390 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000391
392 bool usesThreadWrapperFunction() const override { return false; }
393 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
394 QualType LValType) override;
395
John McCallc84ed6a2012-05-01 06:13:13 +0000396 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
397 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000398 bool PerformInit) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000399 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
400 llvm::Constant *Dtor, llvm::Constant *Addr) override;
John McCallc84ed6a2012-05-01 06:13:13 +0000401
John McCall29036752011-01-27 02:46:02 +0000402 // ==== Notes on array cookies =========
403 //
404 // MSVC seems to only use cookies when the class has a destructor; a
405 // two-argument usual array deallocation function isn't sufficient.
406 //
407 // For example, this code prints "100" and "1":
408 // struct A {
409 // char x;
410 // void *operator new[](size_t sz) {
411 // printf("%u\n", sz);
412 // return malloc(sz);
413 // }
414 // void operator delete[](void *p, size_t sz) {
415 // printf("%u\n", sz);
416 // free(p);
417 // }
418 // };
419 // int main() {
420 // A *p = new A[100];
421 // delete[] p;
422 // }
423 // Whereas it prints "104" and "104" if you give A a destructor.
John McCallb91cd662012-05-01 05:23:51 +0000424
Craig Topper4f12f102014-03-12 06:41:41 +0000425 bool requiresArrayCookie(const CXXDeleteExpr *expr,
426 QualType elementType) override;
427 bool requiresArrayCookie(const CXXNewExpr *expr) override;
428 CharUnits getArrayCookieSizeImpl(QualType type) override;
John McCall7f416cc2015-09-08 08:05:57 +0000429 Address InitializeArrayCookie(CodeGenFunction &CGF,
430 Address NewPtr,
431 llvm::Value *NumElements,
432 const CXXNewExpr *expr,
433 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000434 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000435 Address allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000436 CharUnits cookieSize) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000437
David Majnemer611cdb92014-07-07 08:09:15 +0000438 friend struct MSRTTIBuilder;
439
440 bool isImageRelative() const {
441 return CGM.getTarget().getPointerWidth(/*AddressSpace=*/0) == 64;
442 }
443
444 // 5 routines for constructing the llvm types for MS RTTI structs.
445 llvm::StructType *getTypeDescriptorType(StringRef TypeInfoString) {
446 llvm::SmallString<32> TDTypeName("rtti.TypeDescriptor");
447 TDTypeName += llvm::utostr(TypeInfoString.size());
448 llvm::StructType *&TypeDescriptorType =
449 TypeDescriptorTypeMap[TypeInfoString.size()];
450 if (TypeDescriptorType)
451 return TypeDescriptorType;
452 llvm::Type *FieldTypes[] = {
453 CGM.Int8PtrPtrTy,
454 CGM.Int8PtrTy,
455 llvm::ArrayType::get(CGM.Int8Ty, TypeInfoString.size() + 1)};
456 TypeDescriptorType =
457 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, TDTypeName);
458 return TypeDescriptorType;
459 }
460
461 llvm::Type *getImageRelativeType(llvm::Type *PtrType) {
462 if (!isImageRelative())
463 return PtrType;
464 return CGM.IntTy;
465 }
466
467 llvm::StructType *getBaseClassDescriptorType() {
468 if (BaseClassDescriptorType)
469 return BaseClassDescriptorType;
470 llvm::Type *FieldTypes[] = {
471 getImageRelativeType(CGM.Int8PtrTy),
472 CGM.IntTy,
473 CGM.IntTy,
474 CGM.IntTy,
475 CGM.IntTy,
476 CGM.IntTy,
477 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
478 };
479 BaseClassDescriptorType = llvm::StructType::create(
480 CGM.getLLVMContext(), FieldTypes, "rtti.BaseClassDescriptor");
481 return BaseClassDescriptorType;
482 }
483
484 llvm::StructType *getClassHierarchyDescriptorType() {
485 if (ClassHierarchyDescriptorType)
486 return ClassHierarchyDescriptorType;
487 // Forward-declare RTTIClassHierarchyDescriptor to break a cycle.
488 ClassHierarchyDescriptorType = llvm::StructType::create(
489 CGM.getLLVMContext(), "rtti.ClassHierarchyDescriptor");
490 llvm::Type *FieldTypes[] = {
491 CGM.IntTy,
492 CGM.IntTy,
493 CGM.IntTy,
494 getImageRelativeType(
495 getBaseClassDescriptorType()->getPointerTo()->getPointerTo()),
496 };
497 ClassHierarchyDescriptorType->setBody(FieldTypes);
498 return ClassHierarchyDescriptorType;
499 }
500
501 llvm::StructType *getCompleteObjectLocatorType() {
502 if (CompleteObjectLocatorType)
503 return CompleteObjectLocatorType;
504 CompleteObjectLocatorType = llvm::StructType::create(
505 CGM.getLLVMContext(), "rtti.CompleteObjectLocator");
506 llvm::Type *FieldTypes[] = {
507 CGM.IntTy,
508 CGM.IntTy,
509 CGM.IntTy,
510 getImageRelativeType(CGM.Int8PtrTy),
511 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
512 getImageRelativeType(CompleteObjectLocatorType),
513 };
514 llvm::ArrayRef<llvm::Type *> FieldTypesRef(FieldTypes);
515 if (!isImageRelative())
516 FieldTypesRef = FieldTypesRef.drop_back();
517 CompleteObjectLocatorType->setBody(FieldTypesRef);
518 return CompleteObjectLocatorType;
519 }
520
521 llvm::GlobalVariable *getImageBase() {
522 StringRef Name = "__ImageBase";
523 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name))
524 return GV;
525
526 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8Ty,
527 /*isConstant=*/true,
528 llvm::GlobalValue::ExternalLinkage,
529 /*Initializer=*/nullptr, Name);
530 }
531
532 llvm::Constant *getImageRelativeConstant(llvm::Constant *PtrVal) {
533 if (!isImageRelative())
534 return PtrVal;
535
David Majnemer7c237072015-03-05 00:46:22 +0000536 if (PtrVal->isNullValue())
537 return llvm::Constant::getNullValue(CGM.IntTy);
538
David Majnemer611cdb92014-07-07 08:09:15 +0000539 llvm::Constant *ImageBaseAsInt =
540 llvm::ConstantExpr::getPtrToInt(getImageBase(), CGM.IntPtrTy);
541 llvm::Constant *PtrValAsInt =
542 llvm::ConstantExpr::getPtrToInt(PtrVal, CGM.IntPtrTy);
543 llvm::Constant *Diff =
544 llvm::ConstantExpr::getSub(PtrValAsInt, ImageBaseAsInt,
545 /*HasNUW=*/true, /*HasNSW=*/true);
546 return llvm::ConstantExpr::getTrunc(Diff, CGM.IntTy);
547 }
548
Reid Kleckner407e8b62013-03-22 19:02:54 +0000549private:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000550 MicrosoftMangleContext &getMangleContext() {
551 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext());
552 }
553
Reid Kleckner2341ae32013-04-11 18:13:19 +0000554 llvm::Constant *getZeroInt() {
555 return llvm::ConstantInt::get(CGM.IntTy, 0);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000556 }
557
Reid Kleckner2341ae32013-04-11 18:13:19 +0000558 llvm::Constant *getAllOnesInt() {
559 return llvm::Constant::getAllOnesValue(CGM.IntTy);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000560 }
561
Reid Kleckner0358cbf2016-07-01 02:41:25 +0000562 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) override;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000563
Reid Kleckner2341ae32013-04-11 18:13:19 +0000564 void
565 GetNullMemberPointerFields(const MemberPointerType *MPT,
566 llvm::SmallVectorImpl<llvm::Constant *> &fields);
567
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000568 /// \brief Shared code for virtual base adjustment. Returns the offset from
569 /// the vbptr to the virtual base. Optionally returns the address of the
570 /// vbptr itself.
571 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000572 Address Base,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000573 llvm::Value *VBPtrOffset,
574 llvm::Value *VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000575 llvm::Value **VBPtr = nullptr);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000576
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000577 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000578 Address Base,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000579 int32_t VBPtrOffset,
580 int32_t VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000581 llvm::Value **VBPtr = nullptr) {
Reid Kleckner0ba8ba42014-10-22 17:26:00 +0000582 assert(VBTableOffset % 4 == 0 && "should be byte offset into table of i32s");
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000583 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
584 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset);
585 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr);
586 }
587
Peter Collingbourne60108802017-12-13 21:53:04 +0000588 std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000589 performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000590 QualType SrcRecordTy);
591
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000592 /// \brief Performs a full virtual base adjustment. Used to dereference
593 /// pointers to members of virtual bases.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000594 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000595 const CXXRecordDecl *RD, Address Base,
Reid Kleckner2341ae32013-04-11 18:13:19 +0000596 llvm::Value *VirtualBaseAdjustmentOffset,
597 llvm::Value *VBPtrOffset /* optional */);
598
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000599 /// \brief Emits a full member pointer with the fields common to data and
600 /// function member pointers.
601 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField,
602 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +0000603 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +0000604 CharUnits NonVirtualBaseAdjustment,
605 unsigned VBTableIndex);
Reid Kleckner452abac2013-05-09 21:01:17 +0000606
Reid Kleckner452abac2013-05-09 21:01:17 +0000607 bool MemberPointerConstantIsNull(const MemberPointerType *MPT,
608 llvm::Constant *MP);
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000609
Reid Kleckner7810af02013-06-19 15:20:38 +0000610 /// \brief - Initialize all vbptrs of 'this' with RD as the complete type.
611 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
612
613 /// \brief Caching wrapper around VBTableBuilder::enumerateVBTables().
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000614 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000615
Hans Wennborg88497d62013-11-15 17:24:45 +0000616 /// \brief Generate a thunk for calling a virtual member function MD.
Reid Klecknere4a52202014-02-21 02:27:32 +0000617 llvm::Function *EmitVirtualMemPtrThunk(
618 const CXXMethodDecl *MD,
619 const MicrosoftVTableContext::MethodVFTableLocation &ML);
Hans Wennborg88497d62013-11-15 17:24:45 +0000620
Reid Kleckner407e8b62013-03-22 19:02:54 +0000621public:
Craig Topper4f12f102014-03-12 06:41:41 +0000622 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000623
Craig Topper4f12f102014-03-12 06:41:41 +0000624 bool isZeroInitializable(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000625
David Majnemerb3e56542014-08-07 22:56:13 +0000626 bool isMemberPointerConvertible(const MemberPointerType *MPT) const override {
627 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemer99281062014-09-18 22:05:54 +0000628 return RD->hasAttr<MSInheritanceAttr>();
629 }
630
Craig Topper4f12f102014-03-12 06:41:41 +0000631 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000632
Craig Topper4f12f102014-03-12 06:41:41 +0000633 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
634 CharUnits offset) override;
David Majnemere2be95b2015-06-23 07:31:01 +0000635 llvm::Constant *EmitMemberFunctionPointer(const CXXMethodDecl *MD) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000636 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000637
Craig Topper4f12f102014-03-12 06:41:41 +0000638 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
639 llvm::Value *L,
640 llvm::Value *R,
641 const MemberPointerType *MPT,
642 bool Inequality) override;
Reid Kleckner700c3ee2013-04-30 20:15:14 +0000643
Craig Topper4f12f102014-03-12 06:41:41 +0000644 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
645 llvm::Value *MemPtr,
646 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000647
Craig Topper4f12f102014-03-12 06:41:41 +0000648 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000649 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000650 Address Base, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000651 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000652
David Majnemer0d9ad682015-06-29 00:06:50 +0000653 llvm::Value *EmitNonNullMemberPointerConversion(
654 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
655 CastKind CK, CastExpr::path_const_iterator PathBegin,
656 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
657 CGBuilderTy &Builder);
658
Craig Topper4f12f102014-03-12 06:41:41 +0000659 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
660 const CastExpr *E,
661 llvm::Value *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000662
Craig Topper4f12f102014-03-12 06:41:41 +0000663 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
664 llvm::Constant *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000665
David Majnemer5ca193c2015-06-23 07:31:07 +0000666 llvm::Constant *EmitMemberPointerConversion(
667 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
668 CastKind CK, CastExpr::path_const_iterator PathBegin,
669 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src);
670
John McCallb92ab1a2016-10-26 23:46:34 +0000671 CGCallee
David Majnemer2b0d66d2014-02-20 23:22:07 +0000672 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000673 Address This, llvm::Value *&ThisPtrForCall,
674 llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000675 const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000676
Rafael Espindola91f68b42014-09-15 19:20:10 +0000677 void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) override;
678
David Majnemer7c237072015-03-05 00:46:22 +0000679 llvm::StructType *getCatchableTypeType() {
680 if (CatchableTypeType)
681 return CatchableTypeType;
682 llvm::Type *FieldTypes[] = {
683 CGM.IntTy, // Flags
684 getImageRelativeType(CGM.Int8PtrTy), // TypeDescriptor
685 CGM.IntTy, // NonVirtualAdjustment
686 CGM.IntTy, // OffsetToVBPtr
687 CGM.IntTy, // VBTableIndex
688 CGM.IntTy, // Size
689 getImageRelativeType(CGM.Int8PtrTy) // CopyCtor
690 };
691 CatchableTypeType = llvm::StructType::create(
692 CGM.getLLVMContext(), FieldTypes, "eh.CatchableType");
693 return CatchableTypeType;
694 }
695
696 llvm::StructType *getCatchableTypeArrayType(uint32_t NumEntries) {
697 llvm::StructType *&CatchableTypeArrayType =
698 CatchableTypeArrayTypeMap[NumEntries];
699 if (CatchableTypeArrayType)
700 return CatchableTypeArrayType;
701
702 llvm::SmallString<23> CTATypeName("eh.CatchableTypeArray.");
703 CTATypeName += llvm::utostr(NumEntries);
704 llvm::Type *CTType =
705 getImageRelativeType(getCatchableTypeType()->getPointerTo());
706 llvm::Type *FieldTypes[] = {
707 CGM.IntTy, // NumEntries
708 llvm::ArrayType::get(CTType, NumEntries) // CatchableTypes
709 };
710 CatchableTypeArrayType =
711 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, CTATypeName);
712 return CatchableTypeArrayType;
713 }
714
715 llvm::StructType *getThrowInfoType() {
716 if (ThrowInfoType)
717 return ThrowInfoType;
718 llvm::Type *FieldTypes[] = {
719 CGM.IntTy, // Flags
720 getImageRelativeType(CGM.Int8PtrTy), // CleanupFn
721 getImageRelativeType(CGM.Int8PtrTy), // ForwardCompat
722 getImageRelativeType(CGM.Int8PtrTy) // CatchableTypeArray
723 };
724 ThrowInfoType = llvm::StructType::create(CGM.getLLVMContext(), FieldTypes,
725 "eh.ThrowInfo");
726 return ThrowInfoType;
727 }
728
729 llvm::Constant *getThrowFn() {
730 // _CxxThrowException is passed an exception object and a ThrowInfo object
731 // which describes the exception.
732 llvm::Type *Args[] = {CGM.Int8PtrTy, getThrowInfoType()->getPointerTo()};
733 llvm::FunctionType *FTy =
734 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
735 auto *Fn = cast<llvm::Function>(
736 CGM.CreateRuntimeFunction(FTy, "_CxxThrowException"));
737 // _CxxThrowException is stdcall on 32-bit x86 platforms.
738 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::x86)
739 Fn->setCallingConv(llvm::CallingConv::X86_StdCall);
740 return Fn;
741 }
742
David Majnemer37fd66e2015-03-13 22:36:55 +0000743 llvm::Function *getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
744 CXXCtorType CT);
David Majnemerdfa6d202015-03-11 18:36:39 +0000745
David Majnemer7c237072015-03-05 00:46:22 +0000746 llvm::Constant *getCatchableType(QualType T,
747 uint32_t NVOffset = 0,
748 int32_t VBPtrOffset = -1,
749 uint32_t VBIndex = 0);
750
751 llvm::GlobalVariable *getCatchableTypeArray(QualType T);
752
David Majnemerba3e5ec2015-03-13 18:26:17 +0000753 llvm::GlobalVariable *getThrowInfo(QualType T) override;
David Majnemer7c237072015-03-05 00:46:22 +0000754
Peter Collingbourne60108802017-12-13 21:53:04 +0000755 std::pair<llvm::Value *, const CXXRecordDecl *>
756 LoadVTablePtr(CodeGenFunction &CGF, Address This,
757 const CXXRecordDecl *RD) override;
758
Reid Kleckner7810af02013-06-19 15:20:38 +0000759private:
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000760 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy;
David Majnemerd905da42014-07-01 20:30:31 +0000761 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy;
762 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000763 /// \brief All the vftables that have been referenced.
764 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000765 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000766
767 /// \brief This set holds the record decls we've deferred vtable emission for.
768 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
769
770
771 /// \brief All the vbtables which have been referenced.
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000772 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap;
Reid Klecknerd8110b62013-09-10 20:14:30 +0000773
774 /// Info on the global variable used to guard initialization of static locals.
775 /// The BitIndex field is only used for externally invisible declarations.
776 struct GuardInfo {
Craig Topper8a13c412014-05-21 05:09:00 +0000777 GuardInfo() : Guard(nullptr), BitIndex(0) {}
Reid Klecknerd8110b62013-09-10 20:14:30 +0000778 llvm::GlobalVariable *Guard;
779 unsigned BitIndex;
780 };
781
782 /// Map from DeclContext to the current guard variable. We assume that the
783 /// AST is visited in source code order.
784 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap;
David Majnemerec8e54b2015-05-07 21:19:06 +0000785 llvm::DenseMap<const DeclContext *, GuardInfo> ThreadLocalGuardVariableMap;
David Majnemer8354eee2015-05-07 06:15:46 +0000786 llvm::DenseMap<const DeclContext *, unsigned> ThreadSafeGuardNumMap;
David Majnemer611cdb92014-07-07 08:09:15 +0000787
788 llvm::DenseMap<size_t, llvm::StructType *> TypeDescriptorTypeMap;
789 llvm::StructType *BaseClassDescriptorType;
790 llvm::StructType *ClassHierarchyDescriptorType;
791 llvm::StructType *CompleteObjectLocatorType;
David Majnemer7c237072015-03-05 00:46:22 +0000792
793 llvm::DenseMap<QualType, llvm::GlobalVariable *> CatchableTypeArrays;
794
795 llvm::StructType *CatchableTypeType;
796 llvm::DenseMap<uint32_t, llvm::StructType *> CatchableTypeArrayTypeMap;
797 llvm::StructType *ThrowInfoType;
Charles Davis74ce8592010-06-09 23:25:41 +0000798};
799
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000800}
Charles Davis74ce8592010-06-09 23:25:41 +0000801
Reid Klecknere39ee212014-05-03 00:33:28 +0000802CGCXXABI::RecordArgABI
803MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const {
804 switch (CGM.getTarget().getTriple().getArch()) {
805 default:
806 // FIXME: Implement for other architectures.
807 return RAA_Default;
808
Reid Kleckner44051e62016-08-25 18:23:28 +0000809 case llvm::Triple::thumb:
810 // Use the simple Itanium rules for now.
811 // FIXME: This is incompatible with MSVC for arguments with a dtor and no
812 // copy ctor.
813 return !canCopyArgument(RD) ? RAA_Indirect : RAA_Default;
814
Reid Klecknere39ee212014-05-03 00:33:28 +0000815 case llvm::Triple::x86:
Reid Klecknercf87e102014-05-14 16:02:09 +0000816 // All record arguments are passed in memory on x86. Decide whether to
817 // construct the object directly in argument memory, or to construct the
818 // argument elsewhere and copy the bytes during the call.
819
820 // If C++ prohibits us from making a copy, construct the arguments directly
821 // into argument memory.
822 if (!canCopyArgument(RD))
Reid Klecknere39ee212014-05-03 00:33:28 +0000823 return RAA_DirectInMemory;
Reid Klecknercf87e102014-05-14 16:02:09 +0000824
825 // Otherwise, construct the argument into a temporary and copy the bytes
826 // into the outgoing argument memory.
Reid Klecknere39ee212014-05-03 00:33:28 +0000827 return RAA_Default;
828
829 case llvm::Triple::x86_64:
Akira Hatanaka02914dc2018-02-05 20:23:22 +0000830 bool CopyCtorIsTrivial = false, CopyCtorIsTrivialForCall = false;
831 bool DtorIsTrivialForCall = false;
Reid Klecknercf87e102014-05-14 16:02:09 +0000832
Richard Smith96cd6712017-08-16 01:49:53 +0000833 // If a class has at least one non-deleted, trivial copy constructor, it
834 // is passed according to the C ABI. Otherwise, it is passed indirectly.
835 //
836 // Note: This permits classes with non-trivial copy or move ctors to be
837 // passed in registers, so long as they *also* have a trivial copy ctor,
838 // which is non-conforming.
839 if (RD->needsImplicitCopyConstructor()) {
Akira Hatanaka02914dc2018-02-05 20:23:22 +0000840 if (!RD->defaultedCopyConstructorIsDeleted()) {
841 if (RD->hasTrivialCopyConstructor())
842 CopyCtorIsTrivial = true;
843 if (RD->hasTrivialCopyConstructorForCall())
844 CopyCtorIsTrivialForCall = true;
845 }
Richard Smith96cd6712017-08-16 01:49:53 +0000846 } else {
Richard Smith96cd6712017-08-16 01:49:53 +0000847 for (const CXXConstructorDecl *CD : RD->ctors()) {
Akira Hatanaka02914dc2018-02-05 20:23:22 +0000848 if (CD->isCopyConstructor() && !CD->isDeleted()) {
849 if (CD->isTrivial())
850 CopyCtorIsTrivial = true;
851 if (CD->isTrivialForCall())
852 CopyCtorIsTrivialForCall = true;
Richard Smith96cd6712017-08-16 01:49:53 +0000853 }
Reid Klecknercf87e102014-05-14 16:02:09 +0000854 }
855 }
856
Akira Hatanaka02914dc2018-02-05 20:23:22 +0000857 if (RD->needsImplicitDestructor()) {
858 if (!RD->defaultedDestructorIsDeleted() &&
859 RD->hasTrivialDestructorForCall())
860 DtorIsTrivialForCall = true;
861 } else if (const auto *D = RD->getDestructor()) {
862 if (!D->isDeleted() && D->isTrivialForCall())
863 DtorIsTrivialForCall = true;
864 }
865
866 // If the copy ctor and dtor are both trivial-for-calls, pass direct.
867 if (CopyCtorIsTrivialForCall && DtorIsTrivialForCall)
868 return RAA_Default;
869
870 // If a class has a destructor, we'd really like to pass it indirectly
871 // because it allows us to elide copies. Unfortunately, MSVC makes that
872 // impossible for small types, which it will pass in a single register or
873 // stack slot. Most objects with dtors are large-ish, so handle that early.
874 // We can't call out all large objects as being indirect because there are
875 // multiple x64 calling conventions and the C++ ABI code shouldn't dictate
876 // how we pass large POD types.
877
878 // Note: This permits small classes with nontrivial destructors to be
879 // passed in registers, which is non-conforming.
880 if (CopyCtorIsTrivial &&
881 getContext().getTypeSize(RD->getTypeForDecl()) <= 64)
882 return RAA_Default;
Peter Collingbourne120eb542016-11-22 00:21:43 +0000883 return RAA_Indirect;
Reid Klecknere39ee212014-05-03 00:33:28 +0000884 }
885
886 llvm_unreachable("invalid enum");
887}
888
David Majnemer08681372014-11-01 07:37:17 +0000889void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
890 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000891 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +0000892 QualType ElementType,
893 const CXXDestructorDecl *Dtor) {
David Majnemer0c0b6d92014-10-31 20:09:12 +0000894 // FIXME: Provide a source location here even though there's no
895 // CXXMemberCallExpr for dtor call.
David Majnemer08681372014-11-01 07:37:17 +0000896 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000897 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
898 llvm::Value *MDThis =
899 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr);
900 if (UseGlobalDelete)
David Majnemer08681372014-11-01 07:37:17 +0000901 CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType);
John McCall82fb8922012-09-25 10:10:39 +0000902}
903
David Majnemer442d0a22014-11-25 07:20:20 +0000904void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
David Majnemer7c237072015-03-05 00:46:22 +0000905 llvm::Value *Args[] = {
906 llvm::ConstantPointerNull::get(CGM.Int8PtrTy),
907 llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())};
908 auto *Fn = getThrowFn();
David Majnemer442d0a22014-11-25 07:20:20 +0000909 if (isNoReturn)
910 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args);
911 else
912 CGF.EmitRuntimeCallOrInvoke(Fn, Args);
913}
914
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000915namespace {
Reid Kleckner129552b2015-10-08 01:13:52 +0000916struct CatchRetScope final : EHScopeStack::Cleanup {
David Majnemere888a2f2015-08-15 03:21:08 +0000917 llvm::CatchPadInst *CPI;
918
Reid Kleckner129552b2015-10-08 01:13:52 +0000919 CatchRetScope(llvm::CatchPadInst *CPI) : CPI(CPI) {}
David Majnemere888a2f2015-08-15 03:21:08 +0000920
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000921 void Emit(CodeGenFunction &CGF, Flags flags) override {
Reid Kleckner129552b2015-10-08 01:13:52 +0000922 llvm::BasicBlock *BB = CGF.createBasicBlock("catchret.dest");
923 CGF.Builder.CreateCatchRet(CPI, BB);
924 CGF.EmitBlock(BB);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000925 }
926};
927}
928
929void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF,
930 const CXXCatchStmt *S) {
931 // In the MS ABI, the runtime handles the copy, and the catch handler is
932 // responsible for destruction.
933 VarDecl *CatchParam = S->getExceptionDecl();
David Majnemer4e52d6f2015-12-12 05:39:21 +0000934 llvm::BasicBlock *CatchPadBB = CGF.Builder.GetInsertBlock();
Reid Kleckner129552b2015-10-08 01:13:52 +0000935 llvm::CatchPadInst *CPI =
936 cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
David Majnemer4e52d6f2015-12-12 05:39:21 +0000937 CGF.CurrentFuncletPad = CPI;
Reid Kleckner129552b2015-10-08 01:13:52 +0000938
Reid Kleckner67cf0352015-04-07 00:09:59 +0000939 // If this is a catch-all or the catch parameter is unnamed, we don't need to
940 // emit an alloca to the object.
941 if (!CatchParam || !CatchParam->getDeclName()) {
Reid Kleckner129552b2015-10-08 01:13:52 +0000942 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000943 return;
944 }
945
946 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
Reid Kleckner129552b2015-10-08 01:13:52 +0000947 CPI->setArgOperand(2, var.getObjectAddress(CGF).getPointer());
948 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000949 CGF.EmitAutoVarCleanups(var);
950}
951
John McCall7f416cc2015-09-08 08:05:57 +0000952/// We need to perform a generic polymorphic operation (like a typeid
953/// or a cast), which requires an object with a vfptr. Adjust the
954/// address to point to an object with a vfptr.
Peter Collingbourne60108802017-12-13 21:53:04 +0000955std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000956MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000957 QualType SrcRecordTy) {
David Majnemer1162d252014-06-22 19:05:33 +0000958 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
959 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
David Majnemer9ced3dd2015-03-14 23:44:48 +0000960 const ASTContext &Context = getContext();
David Majnemer1162d252014-06-22 19:05:33 +0000961
John McCall7f416cc2015-09-08 08:05:57 +0000962 // If the class itself has a vfptr, great. This check implicitly
963 // covers non-virtual base subobjects: a class with its own virtual
964 // functions would be a candidate to be a primary base.
David Majnemer5bc883f2015-02-27 02:38:02 +0000965 if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
Peter Collingbourne60108802017-12-13 21:53:04 +0000966 return std::make_tuple(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0),
967 SrcDecl);
David Majnemer1162d252014-06-22 19:05:33 +0000968
John McCall7f416cc2015-09-08 08:05:57 +0000969 // Okay, one of the vbases must have a vfptr, or else this isn't
970 // actually a polymorphic class.
971 const CXXRecordDecl *PolymorphicBase = nullptr;
972 for (auto &Base : SrcDecl->vbases()) {
973 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
974 if (Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr()) {
975 PolymorphicBase = BaseDecl;
976 break;
977 }
978 }
979 assert(PolymorphicBase && "polymorphic class has no apparent vfptr?");
980
981 llvm::Value *Offset =
982 GetVirtualBaseClassOffset(CGF, Value, SrcDecl, PolymorphicBase);
983 llvm::Value *Ptr = CGF.Builder.CreateInBoundsGEP(Value.getPointer(), Offset);
John McCall7f416cc2015-09-08 08:05:57 +0000984 CharUnits VBaseAlign =
985 CGF.CGM.getVBaseAlignment(Value.getAlignment(), SrcDecl, PolymorphicBase);
Peter Collingbourne60108802017-12-13 21:53:04 +0000986 return std::make_tuple(Address(Ptr, VBaseAlign), Offset, PolymorphicBase);
David Majnemer1162d252014-06-22 19:05:33 +0000987}
988
989bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
990 QualType SrcRecordTy) {
991 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
992 return IsDeref &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000993 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000994}
995
996static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF,
997 llvm::Value *Argument) {
998 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
999 llvm::FunctionType *FTy =
1000 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
1001 llvm::Value *Args[] = {Argument};
1002 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
1003 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
1004}
1005
1006void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
1007 llvm::CallSite Call =
1008 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
1009 Call.setDoesNotReturn();
1010 CGF.Builder.CreateUnreachable();
1011}
1012
1013llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
1014 QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +00001015 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +00001016 llvm::Type *StdTypeInfoPtrTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +00001017 std::tie(ThisPtr, std::ignore, std::ignore) =
David Majnemer17755352016-07-09 19:26:25 +00001018 performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +00001019 auto Typeid = emitRTtypeidCall(CGF, ThisPtr.getPointer()).getInstruction();
1020 return CGF.Builder.CreateBitCast(Typeid, StdTypeInfoPtrTy);
David Majnemer1162d252014-06-22 19:05:33 +00001021}
1022
1023bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
1024 QualType SrcRecordTy) {
1025 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
1026 return SrcIsPtr &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001027 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +00001028}
1029
1030llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
John McCall7f416cc2015-09-08 08:05:57 +00001031 CodeGenFunction &CGF, Address This, QualType SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00001032 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
1033 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
1034
1035 llvm::Value *SrcRTTI =
1036 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
1037 llvm::Value *DestRTTI =
1038 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
1039
1040 llvm::Value *Offset;
Peter Collingbourne60108802017-12-13 21:53:04 +00001041 std::tie(This, Offset, std::ignore) =
1042 performBaseAdjustment(CGF, This, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +00001043 llvm::Value *ThisPtr = This.getPointer();
David Majnemer17755352016-07-09 19:26:25 +00001044 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
David Majnemer1162d252014-06-22 19:05:33 +00001045
1046 // PVOID __RTDynamicCast(
1047 // PVOID inptr,
1048 // LONG VfDelta,
1049 // PVOID SrcType,
1050 // PVOID TargetType,
1051 // BOOL isReference)
1052 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
1053 CGF.Int8PtrTy, CGF.Int32Ty};
1054 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1055 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1056 "__RTDynamicCast");
1057 llvm::Value *Args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001058 ThisPtr, Offset, SrcRTTI, DestRTTI,
David Majnemer1162d252014-06-22 19:05:33 +00001059 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
John McCall7f416cc2015-09-08 08:05:57 +00001060 ThisPtr = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction();
1061 return CGF.Builder.CreateBitCast(ThisPtr, DestLTy);
David Majnemer1162d252014-06-22 19:05:33 +00001062}
1063
1064llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00001065MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +00001066 QualType SrcRecordTy,
1067 QualType DestTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +00001068 std::tie(Value, std::ignore, std::ignore) =
1069 performBaseAdjustment(CGF, Value, SrcRecordTy);
David Majnemer1162d252014-06-22 19:05:33 +00001070
1071 // PVOID __RTCastToVoid(
1072 // PVOID inptr)
1073 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
1074 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1075 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1076 "__RTCastToVoid");
John McCall7f416cc2015-09-08 08:05:57 +00001077 llvm::Value *Args[] = {Value.getPointer()};
David Majnemer1162d252014-06-22 19:05:33 +00001078 return CGF.EmitRuntimeCall(Function, Args);
1079}
1080
1081bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
1082 return false;
1083}
1084
David Majnemerca32f932014-09-01 18:50:02 +00001085llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
John McCall7f416cc2015-09-08 08:05:57 +00001086 CodeGenFunction &CGF, Address This, const CXXRecordDecl *ClassDecl,
David Majnemerca32f932014-09-01 18:50:02 +00001087 const CXXRecordDecl *BaseClassDecl) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001088 const ASTContext &Context = getContext();
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00001089 int64_t VBPtrChars =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001090 Context.getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001091 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
David Majnemer9ced3dd2015-03-14 23:44:48 +00001092 CharUnits IntSize = Context.getTypeSizeInChars(Context.IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001093 CharUnits VBTableChars =
1094 IntSize *
1095 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001096 llvm::Value *VBTableOffset =
David Majnemerca32f932014-09-01 18:50:02 +00001097 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001098
1099 llvm::Value *VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001100 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001101 VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001102 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001103 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
1104}
1105
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001106bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
1107 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +00001108}
1109
David Majnemer0c0b6d92014-10-31 20:09:12 +00001110static bool isDeletingDtor(GlobalDecl GD) {
1111 return isa<CXXDestructorDecl>(GD.getDecl()) &&
1112 GD.getDtorType() == Dtor_Deleting;
1113}
1114
1115bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const {
1116 return isDeletingDtor(GD);
1117}
1118
Reid Kleckner40ca9132014-05-13 22:05:45 +00001119bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
1120 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
1121 if (!RD)
1122 return false;
1123
John McCall7f416cc2015-09-08 08:05:57 +00001124 CharUnits Align = CGM.getContext().getTypeAlignInChars(FI.getReturnType());
Reid Kleckner40ca9132014-05-13 22:05:45 +00001125 if (FI.isInstanceMethod()) {
1126 // If it's an instance method, aggregates are always returned indirectly via
1127 // the second parameter.
John McCall7f416cc2015-09-08 08:05:57 +00001128 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001129 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod());
1130 return true;
1131 } else if (!RD->isPOD()) {
1132 // If it's a free function, non-POD types are returned indirectly.
John McCall7f416cc2015-09-08 08:05:57 +00001133 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001134 return true;
1135 }
1136
1137 // Otherwise, use the C ABI rules.
1138 return false;
1139}
1140
Reid Kleckner7810af02013-06-19 15:20:38 +00001141llvm::BasicBlock *
1142MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
1143 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001144 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1145 assert(IsMostDerivedClass &&
1146 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +00001147 llvm::Value *IsCompleteObject =
1148 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001149
1150 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
1151 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
1152 CGF.Builder.CreateCondBr(IsCompleteObject,
1153 CallVbaseCtorsBB, SkipVbaseCtorsBB);
1154
1155 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +00001156
1157 // Fill in the vbtable pointers here.
1158 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001159
1160 // CGF will put the base ctor calls in this basic block for us later.
1161
1162 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +00001163}
1164
Erich Keane13c7ec52016-12-07 00:21:45 +00001165llvm::BasicBlock *
1166MicrosoftCXXABI::EmitDtorCompleteObjectHandler(CodeGenFunction &CGF) {
1167 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1168 assert(IsMostDerivedClass &&
1169 "ctor for a class with virtual bases must have an implicit parameter");
1170 llvm::Value *IsCompleteObject =
1171 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
1172
1173 llvm::BasicBlock *CallVbaseDtorsBB = CGF.createBasicBlock("Dtor.dtor_vbases");
1174 llvm::BasicBlock *SkipVbaseDtorsBB = CGF.createBasicBlock("Dtor.skip_vbases");
1175 CGF.Builder.CreateCondBr(IsCompleteObject,
1176 CallVbaseDtorsBB, SkipVbaseDtorsBB);
1177
1178 CGF.EmitBlock(CallVbaseDtorsBB);
1179 // CGF will put the base dtor calls in this basic block for us later.
1180
1181 return SkipVbaseDtorsBB;
1182}
1183
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001184void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
1185 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
1186 // In most cases, an override for a vbase virtual method can adjust
1187 // the "this" parameter by applying a constant offset.
1188 // However, this is not enough while a constructor or a destructor of some
1189 // class X is being executed if all the following conditions are met:
1190 // - X has virtual bases, (1)
1191 // - X overrides a virtual method M of a vbase Y, (2)
1192 // - X itself is a vbase of the most derived class.
1193 //
1194 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
1195 // which holds the extra amount of "this" adjustment we must do when we use
1196 // the X vftables (i.e. during X ctor or dtor).
1197 // Outside the ctors and dtors, the values of vtorDisps are zero.
1198
1199 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
1200 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
1201 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
1202 CGBuilderTy &Builder = CGF.Builder;
1203
John McCall7f416cc2015-09-08 08:05:57 +00001204 unsigned AS = getThisAddress(CGF).getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +00001205 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001206
Nico Weber91af2742018-03-07 23:15:20 +00001207 for (const CXXBaseSpecifier &S : RD->vbases()) {
1208 const CXXRecordDecl *VBase = S.getType()->getAsCXXRecordDecl();
1209 auto I = VBaseMap.find(VBase);
1210 assert(I != VBaseMap.end());
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001211 if (!I->second.hasVtorDisp())
1212 continue;
1213
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +00001214 llvm::Value *VBaseOffset =
Nico Weber91af2742018-03-07 23:15:20 +00001215 GetVirtualBaseClassOffset(CGF, getThisAddress(CGF), RD, VBase);
1216 uint64_t ConstantVBaseOffset = I->second.VBaseOffset.getQuantity();
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001217
1218 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
1219 llvm::Value *VtorDispValue = Builder.CreateSub(
David Majnemer17755352016-07-09 19:26:25 +00001220 VBaseOffset, llvm::ConstantInt::get(CGM.PtrDiffTy, ConstantVBaseOffset),
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001221 "vtordisp.value");
David Majnemer17755352016-07-09 19:26:25 +00001222 VtorDispValue = Builder.CreateTruncOrBitCast(VtorDispValue, CGF.Int32Ty);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001223
1224 if (!Int8This)
1225 Int8This = Builder.CreateBitCast(getThisValue(CGF),
1226 CGF.Int8Ty->getPointerTo(AS));
1227 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
1228 // vtorDisp is always the 32-bits before the vbase in the class layout.
1229 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
1230 VtorDispPtr = Builder.CreateBitCast(
1231 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
1232
John McCall7f416cc2015-09-08 08:05:57 +00001233 Builder.CreateAlignedStore(VtorDispValue, VtorDispPtr,
1234 CharUnits::fromQuantity(4));
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001235 }
1236}
1237
David Majnemer37fd66e2015-03-13 22:36:55 +00001238static bool hasDefaultCXXMethodCC(ASTContext &Context,
1239 const CXXMethodDecl *MD) {
1240 CallingConv ExpectedCallingConv = Context.getDefaultCallingConvention(
1241 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1242 CallingConv ActualCallingConv =
1243 MD->getType()->getAs<FunctionProtoType>()->getCallConv();
1244 return ExpectedCallingConv == ActualCallingConv;
1245}
1246
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001247void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1248 // There's only one constructor type in this ABI.
1249 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
David Majnemer37fd66e2015-03-13 22:36:55 +00001250
1251 // Exported default constructors either have a simple call-site where they use
1252 // the typical calling convention and have a single 'this' pointer for an
1253 // argument -or- they get a wrapper function which appropriately thunks to the
1254 // real default constructor. This thunk is the default constructor closure.
1255 if (D->hasAttr<DLLExportAttr>() && D->isDefaultConstructor())
1256 if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) {
1257 llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure);
1258 Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage);
Rafael Espindolab7350042018-03-01 00:35:47 +00001259 CGM.setGVProperties(Fn, D);
David Majnemer37fd66e2015-03-13 22:36:55 +00001260 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001261}
1262
Reid Kleckner7810af02013-06-19 15:20:38 +00001263void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1264 const CXXRecordDecl *RD) {
John McCall7f416cc2015-09-08 08:05:57 +00001265 Address This = getThisAddress(CGF);
1266 This = CGF.Builder.CreateElementBitCast(This, CGM.Int8Ty, "this.int8");
David Majnemer9ced3dd2015-03-14 23:44:48 +00001267 const ASTContext &Context = getContext();
1268 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001269
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001270 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1271 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00001272 const std::unique_ptr<VPtrInfo> &VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001273 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +00001274 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001275 Context.getASTRecordLayout(VBT->IntroducingObject);
Reid Kleckner5f080942014-01-03 23:42:00 +00001276 CharUnits Offs = VBT->NonVirtualOffset;
1277 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001278 if (VBT->getVBaseWithVPtr())
1279 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
John McCall7f416cc2015-09-08 08:05:57 +00001280 Address VBPtr = CGF.Builder.CreateConstInBoundsByteGEP(This, Offs);
David Blaikie1ed728c2015-04-05 22:45:47 +00001281 llvm::Value *GVPtr =
1282 CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001283 VBPtr = CGF.Builder.CreateElementBitCast(VBPtr, GVPtr->getType(),
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001284 "vbptr." + VBT->ObjectWithVPtr->getName());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001285 CGF.Builder.CreateStore(GVPtr, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +00001286 }
1287}
1288
George Burgess IVf203dbf2017-02-22 20:28:02 +00001289CGCXXABI::AddedStructorArgs
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001290MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001291 SmallVectorImpl<CanQualType> &ArgTys) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001292 AddedStructorArgs Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001293 // TODO: 'for base' flag
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001294 if (T == StructorType::Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001295 // The scalar deleting destructor takes an implicit int parameter.
David Majnemer9ced3dd2015-03-14 23:44:48 +00001296 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001297 ++Added.Suffix;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001298 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001299 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
1300 if (!CD)
George Burgess IVf203dbf2017-02-22 20:28:02 +00001301 return Added;
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001302
1303 // All parameters are already in place except is_most_derived, which goes
1304 // after 'this' if it's variadic and last if it's not.
1305
1306 const CXXRecordDecl *Class = CD->getParent();
1307 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1308 if (Class->getNumVBases()) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001309 if (FPT->isVariadic()) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001310 ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001311 ++Added.Prefix;
1312 } else {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001313 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001314 ++Added.Suffix;
1315 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001316 }
George Burgess IVf203dbf2017-02-22 20:28:02 +00001317
1318 return Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001319}
1320
Reid Klecknerae9b0702018-03-16 19:40:50 +00001321void MicrosoftCXXABI::setCXXDestructorDLLStorage(llvm::GlobalValue *GV,
1322 const CXXDestructorDecl *Dtor,
1323 CXXDtorType DT) const {
1324 // Deleting destructor variants are never imported or exported. Give them the
1325 // default storage class.
1326 if (DT == Dtor_Deleting) {
1327 GV->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
1328 } else {
1329 const NamedDecl *ND = Dtor;
1330 CGM.setDLLImportDLLExport(GV, ND);
1331 }
1332}
1333
1334llvm::GlobalValue::LinkageTypes MicrosoftCXXABI::getCXXDestructorLinkage(
1335 GVALinkage Linkage, const CXXDestructorDecl *Dtor, CXXDtorType DT) const {
1336 // Internal things are always internal, regardless of attributes. After this,
1337 // we know the thunk is externally visible.
1338 if (Linkage == GVA_Internal)
1339 return llvm::GlobalValue::InternalLinkage;
1340
1341 switch (DT) {
1342 case Dtor_Base:
1343 // The base destructor most closely tracks the user-declared constructor, so
1344 // we delegate back to the normal declarator case.
1345 return CGM.getLLVMLinkageForDeclarator(Dtor, Linkage,
1346 /*isConstantVariable=*/false);
1347 case Dtor_Complete:
1348 // The complete destructor is like an inline function, but it may be
1349 // imported and therefore must be exported as well. This requires changing
1350 // the linkage if a DLL attribute is present.
1351 if (Dtor->hasAttr<DLLExportAttr>())
1352 return llvm::GlobalValue::WeakODRLinkage;
1353 if (Dtor->hasAttr<DLLImportAttr>())
1354 return llvm::GlobalValue::AvailableExternallyLinkage;
1355 return llvm::GlobalValue::LinkOnceODRLinkage;
1356 case Dtor_Deleting:
1357 // Deleting destructors are like inline functions. They have vague linkage
1358 // and are emitted everywhere they are used. They are internal if the class
1359 // is internal.
1360 return llvm::GlobalValue::LinkOnceODRLinkage;
1361 case Dtor_Comdat:
1362 llvm_unreachable("MS C++ ABI does not support comdat dtors");
1363 }
1364 llvm_unreachable("invalid dtor type");
1365}
1366
Reid Klecknere7de47e2013-07-22 13:51:44 +00001367void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1368 // The TU defining a dtor is only guaranteed to emit a base destructor. All
1369 // other destructor variants are delegating thunks.
1370 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1371}
1372
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001373CharUnits
1374MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001375 GD = GD.getCanonicalDecl();
1376 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001377
1378 GlobalDecl LookupGD = GD;
1379 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1380 // Complete destructors take a pointer to the complete object as a
1381 // parameter, thus don't need this adjustment.
1382 if (GD.getDtorType() == Dtor_Complete)
1383 return CharUnits();
1384
1385 // There's no Dtor_Base in vftable but it shares the this adjustment with
1386 // the deleting one, so look it up instead.
1387 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1388 }
1389
1390 MicrosoftVTableContext::MethodVFTableLocation ML =
1391 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
1392 CharUnits Adjustment = ML.VFPtrOffset;
1393
1394 // Normal virtual instance methods need to adjust from the vfptr that first
1395 // defined the virtual method to the virtual base subobject, but destructors
1396 // do not. The vector deleting destructor thunk applies this adjustment for
1397 // us if necessary.
1398 if (isa<CXXDestructorDecl>(MD))
1399 Adjustment = CharUnits::Zero();
1400
1401 if (ML.VBase) {
1402 const ASTRecordLayout &DerivedLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001403 getContext().getASTRecordLayout(MD->getParent());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001404 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1405 }
1406
1407 return Adjustment;
1408}
1409
John McCall7f416cc2015-09-08 08:05:57 +00001410Address MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1411 CodeGenFunction &CGF, GlobalDecl GD, Address This,
1412 bool VirtualCall) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001413 if (!VirtualCall) {
1414 // If the call of a virtual function is not virtual, we just have to
1415 // compensate for the adjustment the virtual function does in its prologue.
1416 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1417 if (Adjustment.isZero())
1418 return This;
1419
John McCall7f416cc2015-09-08 08:05:57 +00001420 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001421 assert(Adjustment.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001422 return CGF.Builder.CreateConstByteGEP(This, Adjustment);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001423 }
1424
1425 GD = GD.getCanonicalDecl();
1426 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001427
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001428 GlobalDecl LookupGD = GD;
1429 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1430 // Complete dtors take a pointer to the complete object,
1431 // thus don't need adjustment.
1432 if (GD.getDtorType() == Dtor_Complete)
1433 return This;
1434
1435 // There's only Dtor_Deleting in vftable but it shares the this adjustment
1436 // with the base one, so look up the deleting one instead.
1437 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1438 }
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001439 MicrosoftVTableContext::MethodVFTableLocation ML =
1440 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001441
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001442 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001443
1444 // Base destructors expect 'this' to point to the beginning of the base
1445 // subobject, not the first vfptr that happens to contain the virtual dtor.
1446 // However, we still need to apply the virtual base adjustment.
1447 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1448 StaticOffset = CharUnits::Zero();
1449
John McCall7f416cc2015-09-08 08:05:57 +00001450 Address Result = This;
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001451 if (ML.VBase) {
John McCall7f416cc2015-09-08 08:05:57 +00001452 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
1453
1454 const CXXRecordDecl *Derived = MD->getParent();
1455 const CXXRecordDecl *VBase = ML.VBase;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001456 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00001457 GetVirtualBaseClassOffset(CGF, Result, Derived, VBase);
1458 llvm::Value *VBasePtr =
1459 CGF.Builder.CreateInBoundsGEP(Result.getPointer(), VBaseOffset);
1460 CharUnits VBaseAlign =
1461 CGF.CGM.getVBaseAlignment(Result.getAlignment(), Derived, VBase);
1462 Result = Address(VBasePtr, VBaseAlign);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001463 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001464 if (!StaticOffset.isZero()) {
1465 assert(StaticOffset.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001466 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001467 if (ML.VBase) {
1468 // Non-virtual adjustment might result in a pointer outside the allocated
1469 // object, e.g. if the final overrider class is laid out after the virtual
1470 // base that declares a method in the most derived class.
1471 // FIXME: Update the code that emits this adjustment in thunks prologues.
John McCall7f416cc2015-09-08 08:05:57 +00001472 Result = CGF.Builder.CreateConstByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001473 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001474 Result = CGF.Builder.CreateConstInBoundsByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001475 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001476 }
John McCall7f416cc2015-09-08 08:05:57 +00001477 return Result;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001478}
1479
Reid Kleckner89077a12013-12-17 19:46:40 +00001480void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1481 QualType &ResTy,
1482 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001483 ASTContext &Context = getContext();
1484 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001485 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001486 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
Alexey Bataev56223232017-06-09 13:40:18 +00001487 auto *IsMostDerived = ImplicitParamDecl::Create(
1488 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1489 &Context.Idents.get("is_most_derived"), Context.IntTy,
1490 ImplicitParamDecl::Other);
Reid Kleckner89077a12013-12-17 19:46:40 +00001491 // The 'most_derived' parameter goes second if the ctor is variadic and last
1492 // if it's not. Dtors can't be variadic.
1493 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1494 if (FPT->isVariadic())
1495 Params.insert(Params.begin() + 1, IsMostDerived);
1496 else
1497 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001498 getStructorImplicitParamDecl(CGF) = IsMostDerived;
David Majnemer0c0b6d92014-10-31 20:09:12 +00001499 } else if (isDeletingDtor(CGF.CurGD)) {
Alexey Bataev56223232017-06-09 13:40:18 +00001500 auto *ShouldDelete = ImplicitParamDecl::Create(
1501 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1502 &Context.Idents.get("should_call_delete"), Context.IntTy,
1503 ImplicitParamDecl::Other);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001504 Params.push_back(ShouldDelete);
1505 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1506 }
John McCall0f999f32012-09-25 08:00:39 +00001507}
1508
1509void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
Justin Lebared4f1722016-07-27 22:04:24 +00001510 // Naked functions have no prolog.
1511 if (CGF.CurFuncDecl && CGF.CurFuncDecl->hasAttr<NakedAttr>())
1512 return;
1513
Reid Kleckner06239e42017-11-16 19:09:36 +00001514 // Overridden virtual methods of non-primary bases need to adjust the incoming
1515 // 'this' pointer in the prologue. In this hierarchy, C::b will subtract
1516 // sizeof(void*) to adjust from B* to C*:
1517 // struct A { virtual void a(); };
1518 // struct B { virtual void b(); };
1519 // struct C : A, B { virtual void b(); };
1520 //
1521 // Leave the value stored in the 'this' alloca unadjusted, so that the
1522 // debugger sees the unadjusted value. Microsoft debuggers require this, and
1523 // will apply the ThisAdjustment in the method type information.
1524 // FIXME: Do something better for DWARF debuggers, which won't expect this,
1525 // without making our codegen depend on debug info settings.
1526 llvm::Value *This = loadIncomingCXXThis(CGF);
1527 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1528 if (!CGF.CurFuncIsThunk && MD->isVirtual()) {
1529 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(CGF.CurGD);
1530 if (!Adjustment.isZero()) {
1531 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1532 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1533 *thisTy = This->getType();
1534 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1535 assert(Adjustment.isPositive());
1536 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
1537 -Adjustment.getQuantity());
1538 This = CGF.Builder.CreateBitCast(This, thisTy, "this.adjusted");
1539 }
1540 }
1541 setCXXABIThisValue(CGF, This);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001542
Reid Kleckner06239e42017-11-16 19:09:36 +00001543 // If this is a function that the ABI specifies returns 'this', initialize
1544 // the return slot to 'this' at the start of the function.
1545 //
1546 // Unlike the setting of return types, this is done within the ABI
1547 // implementation instead of by clients of CGCXXABI because:
1548 // 1) getThisValue is currently protected
1549 // 2) in theory, an ABI could implement 'this' returns some other way;
1550 // HasThisReturn only specifies a contract, not the implementation
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001551 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001552 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001553 else if (hasMostDerivedReturn(CGF.CurGD))
1554 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1555 CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001556
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001557 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1558 assert(getStructorImplicitParamDecl(CGF) &&
1559 "no implicit parameter for a constructor with virtual bases?");
1560 getStructorImplicitParamValue(CGF)
1561 = CGF.Builder.CreateLoad(
1562 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1563 "is_most_derived");
1564 }
1565
David Majnemer0c0b6d92014-10-31 20:09:12 +00001566 if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001567 assert(getStructorImplicitParamDecl(CGF) &&
1568 "no implicit parameter for a deleting destructor?");
1569 getStructorImplicitParamValue(CGF)
1570 = CGF.Builder.CreateLoad(
1571 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1572 "should_call_delete");
1573 }
John McCall0f999f32012-09-25 08:00:39 +00001574}
1575
George Burgess IVf203dbf2017-02-22 20:28:02 +00001576CGCXXABI::AddedStructorArgs MicrosoftCXXABI::addImplicitConstructorArgs(
Reid Kleckner89077a12013-12-17 19:46:40 +00001577 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1578 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001579 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001580
Reid Kleckner89077a12013-12-17 19:46:40 +00001581 // Check if we need a 'most_derived' parameter.
1582 if (!D->getParent()->getNumVBases())
George Burgess IVf203dbf2017-02-22 20:28:02 +00001583 return AddedStructorArgs{};
Reid Kleckner89077a12013-12-17 19:46:40 +00001584
1585 // Add the 'most_derived' argument second if we are variadic or last if not.
1586 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
David Majnemer833b91e2016-05-13 20:05:09 +00001587 llvm::Value *MostDerivedArg;
1588 if (Delegating) {
1589 MostDerivedArg = getStructorImplicitParamValue(CGF);
1590 } else {
1591 MostDerivedArg = llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001592 }
David Majnemer833b91e2016-05-13 20:05:09 +00001593 RValue RV = RValue::get(MostDerivedArg);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001594 if (FPT->isVariadic()) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001595 Args.insert(Args.begin() + 1, CallArg(RV, getContext().IntTy));
George Burgess IVf203dbf2017-02-22 20:28:02 +00001596 return AddedStructorArgs::prefix(1);
1597 }
1598 Args.add(RV, getContext().IntTy);
1599 return AddedStructorArgs::suffix(1);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001600}
1601
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001602void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1603 const CXXDestructorDecl *DD,
1604 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +00001605 bool Delegating, Address This) {
Reid Klecknerae9b0702018-03-16 19:40:50 +00001606 // Use the base destructor variant in place of the complete destructor variant
1607 // if the class has no virtual bases. This effectively implements some of the
1608 // -mconstructor-aliases optimization, but as part of the MS C++ ABI.
1609 if (Type == Dtor_Complete && DD->getParent()->getNumVBases() == 0)
1610 Type = Dtor_Base;
1611
John McCallb92ab1a2016-10-26 23:46:34 +00001612 CGCallee Callee = CGCallee::forDirect(
1613 CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type)),
1614 DD);
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001615
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001616 if (DD->isVirtual()) {
1617 assert(Type != CXXDtorType::Dtor_Deleting &&
1618 "The deleting destructor should only be called via a virtual call");
1619 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1620 This, false);
1621 }
Erich Keane13c7ec52016-12-07 00:21:45 +00001622
1623 llvm::BasicBlock *BaseDtorEndBB = nullptr;
1624 if (ForVirtualBase && isa<CXXConstructorDecl>(CGF.CurCodeDecl)) {
1625 BaseDtorEndBB = EmitDtorCompleteObjectHandler(CGF);
1626 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001627
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001628 CGF.EmitCXXDestructorCall(DD, Callee, This.getPointer(),
1629 /*ImplicitParam=*/nullptr,
1630 /*ImplicitParamTy=*/QualType(), nullptr,
1631 getFromDtorType(Type));
Erich Keane13c7ec52016-12-07 00:21:45 +00001632 if (BaseDtorEndBB) {
1633 // Complete object handler should continue to be the remaining
1634 CGF.Builder.CreateBr(BaseDtorEndBB);
1635 CGF.EmitBlock(BaseDtorEndBB);
1636 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001637}
1638
Justin Lebar562914e2016-10-10 16:26:29 +00001639void MicrosoftCXXABI::emitVTableTypeMetadata(const VPtrInfo &Info,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001640 const CXXRecordDecl *RD,
1641 llvm::GlobalVariable *VTable) {
Peter Collingbourne1e1475a2017-01-18 23:55:27 +00001642 if (!CGM.getCodeGenOpts().LTOUnit)
Peter Collingbourned9546012015-06-19 02:30:43 +00001643 return;
1644
Peter Collingbournee5706442015-07-09 19:56:14 +00001645 // The location of the first virtual function pointer in the virtual table,
1646 // aka the "address point" on Itanium. This is at offset 0 if RTTI is
1647 // disabled, or sizeof(void*) if RTTI is enabled.
1648 CharUnits AddressPoint =
1649 getContext().getLangOpts().RTTIData
1650 ? getContext().toCharUnitsFromBits(
1651 getContext().getTargetInfo().getPointerWidth(0))
1652 : CharUnits::Zero();
Peter Collingbourned9546012015-06-19 02:30:43 +00001653
Justin Lebar562914e2016-10-10 16:26:29 +00001654 if (Info.PathToIntroducingObject.empty()) {
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001655 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001656 return;
1657 }
1658
1659 // Add a bitset entry for the least derived base belonging to this vftable.
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001660 CGM.AddVTableTypeMetadata(VTable, AddressPoint,
Justin Lebar562914e2016-10-10 16:26:29 +00001661 Info.PathToIntroducingObject.back());
Peter Collingbourned9546012015-06-19 02:30:43 +00001662
1663 // Add a bitset entry for each derived class that is laid out at the same
1664 // offset as the least derived base.
Justin Lebar562914e2016-10-10 16:26:29 +00001665 for (unsigned I = Info.PathToIntroducingObject.size() - 1; I != 0; --I) {
1666 const CXXRecordDecl *DerivedRD = Info.PathToIntroducingObject[I - 1];
1667 const CXXRecordDecl *BaseRD = Info.PathToIntroducingObject[I];
Peter Collingbourned9546012015-06-19 02:30:43 +00001668
1669 const ASTRecordLayout &Layout =
1670 getContext().getASTRecordLayout(DerivedRD);
1671 CharUnits Offset;
1672 auto VBI = Layout.getVBaseOffsetsMap().find(BaseRD);
1673 if (VBI == Layout.getVBaseOffsetsMap().end())
1674 Offset = Layout.getBaseClassOffset(BaseRD);
1675 else
1676 Offset = VBI->second.VBaseOffset;
1677 if (!Offset.isZero())
1678 return;
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001679 CGM.AddVTableTypeMetadata(VTable, AddressPoint, DerivedRD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001680 }
1681
1682 // Finally do the same for the most derived class.
Justin Lebar562914e2016-10-10 16:26:29 +00001683 if (Info.FullOffsetInMDC.isZero())
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001684 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001685}
1686
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001687void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1688 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001689 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001690 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001691
Justin Lebar562914e2016-10-10 16:26:29 +00001692 for (const std::unique_ptr<VPtrInfo>& Info : VFPtrs) {
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001693 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001694 if (VTable->hasInitializer())
1695 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001696
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001697 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001698 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
David Majnemer470ee612016-02-09 17:27:52 +00001699
1700 llvm::Constant *RTTI = nullptr;
1701 if (any_of(VTLayout.vtable_components(),
1702 [](const VTableComponent &VTC) { return VTC.isRTTIKind(); }))
Justin Lebar562914e2016-10-10 16:26:29 +00001703 RTTI = getMSCompleteObjectLocator(RD, *Info);
David Majnemer470ee612016-02-09 17:27:52 +00001704
John McCall9c6cb762016-11-28 22:18:33 +00001705 ConstantInitBuilder Builder(CGM);
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001706 auto Components = Builder.beginStruct();
John McCall9c6cb762016-11-28 22:18:33 +00001707 CGVT.createVTableInitializer(Components, VTLayout, RTTI);
1708 Components.finishAndSetAsInitializer(VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +00001709
Justin Lebar562914e2016-10-10 16:26:29 +00001710 emitVTableTypeMetadata(*Info, RD, VTable);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001711 }
1712}
1713
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001714bool MicrosoftCXXABI::isVirtualOffsetNeededForVTableField(
1715 CodeGenFunction &CGF, CodeGenFunction::VPtr Vptr) {
1716 return Vptr.NearestVBase != nullptr;
1717}
1718
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001719llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1720 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001721 const CXXRecordDecl *NearestVBase) {
1722 llvm::Constant *VTableAddressPoint = getVTableAddressPoint(Base, VTableClass);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001723 if (!VTableAddressPoint) {
1724 assert(Base.getBase()->getNumVBases() &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001725 !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001726 }
1727 return VTableAddressPoint;
1728}
1729
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001730static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Justin Lebar562914e2016-10-10 16:26:29 +00001731 const CXXRecordDecl *RD, const VPtrInfo &VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001732 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001733 llvm::raw_svector_ostream Out(Name);
Justin Lebar562914e2016-10-10 16:26:29 +00001734 MangleContext.mangleCXXVFTable(RD, VFPtr.MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001735}
1736
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001737llvm::Constant *
1738MicrosoftCXXABI::getVTableAddressPoint(BaseSubobject Base,
1739 const CXXRecordDecl *VTableClass) {
Piotr Padlewski4bed31b2015-09-10 20:18:30 +00001740 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1741 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001742 return VFTablesMap[ID];
1743}
1744
1745llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1746 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1747 llvm::Constant *VFTable = getVTableAddressPoint(Base, VTableClass);
David Majnemerd905da42014-07-01 20:30:31 +00001748 assert(VFTable && "Couldn't find a vftable for the given base?");
1749 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001750}
1751
1752llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1753 CharUnits VPtrOffset) {
1754 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1755 // shouldn't be used in the given record type. We want to cache this result in
1756 // VFTablesMap, thus a simple zero check is not sufficient.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001757
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001758 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001759 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001760 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001761 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001762 if (!Inserted)
1763 return I->second;
1764
1765 llvm::GlobalVariable *&VTable = I->second;
1766
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001767 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001768 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001769
David Blaikie82e95a32014-11-19 07:49:47 +00001770 if (DeferredVFTables.insert(RD).second) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001771 // We haven't processed this record type before.
Eric Christopherd160c502016-01-29 01:35:53 +00001772 // Queue up this vtable for possible deferred emission.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001773 CGM.addDeferredVTable(RD);
1774
1775#ifndef NDEBUG
1776 // Create all the vftables at once in order to make sure each vftable has
1777 // a unique mangled name.
1778 llvm::StringSet<> ObservedMangledNames;
1779 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1780 SmallString<256> Name;
Justin Lebar562914e2016-10-10 16:26:29 +00001781 mangleVFTableName(getMangleContext(), RD, *VFPtrs[J], Name);
David Blaikie61b86d42014-11-19 02:56:13 +00001782 if (!ObservedMangledNames.insert(Name.str()).second)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001783 llvm_unreachable("Already saw this mangling before?");
1784 }
1785#endif
1786 }
1787
Justin Lebar562914e2016-10-10 16:26:29 +00001788 const std::unique_ptr<VPtrInfo> *VFPtrI = std::find_if(
1789 VFPtrs.begin(), VFPtrs.end(), [&](const std::unique_ptr<VPtrInfo>& VPI) {
David Majnemera03849b2015-03-18 22:04:43 +00001790 return VPI->FullOffsetInMDC == VPtrOffset;
1791 });
1792 if (VFPtrI == VFPtrs.end()) {
1793 VFTablesMap[ID] = nullptr;
1794 return nullptr;
1795 }
Justin Lebar562914e2016-10-10 16:26:29 +00001796 const std::unique_ptr<VPtrInfo> &VFPtr = *VFPtrI;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001797
David Majnemera03849b2015-03-18 22:04:43 +00001798 SmallString<256> VFTableName;
Justin Lebar562914e2016-10-10 16:26:29 +00001799 mangleVFTableName(getMangleContext(), RD, *VFPtr, VFTableName);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001800
David Majnemer2d8b2002016-02-11 17:49:28 +00001801 // Classes marked __declspec(dllimport) need vftables generated on the
1802 // import-side in order to support features like constexpr. No other
1803 // translation unit relies on the emission of the local vftable, translation
1804 // units are expected to generate them as needed.
1805 //
1806 // Because of this unique behavior, we maintain this logic here instead of
1807 // getVTableLinkage.
1808 llvm::GlobalValue::LinkageTypes VFTableLinkage =
1809 RD->hasAttr<DLLImportAttr>() ? llvm::GlobalValue::LinkOnceODRLinkage
1810 : CGM.getVTableLinkage(RD);
David Majnemera03849b2015-03-18 22:04:43 +00001811 bool VFTableComesFromAnotherTU =
1812 llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) ||
1813 llvm::GlobalValue::isExternalLinkage(VFTableLinkage);
1814 bool VTableAliasIsRequred =
1815 !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData;
David Majnemerbb848712014-07-01 22:37:08 +00001816
David Majnemera03849b2015-03-18 22:04:43 +00001817 if (llvm::GlobalValue *VFTable =
1818 CGM.getModule().getNamedGlobal(VFTableName)) {
1819 VFTablesMap[ID] = VFTable;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001820 VTable = VTableAliasIsRequred
1821 ? cast<llvm::GlobalVariable>(
1822 cast<llvm::GlobalAlias>(VFTable)->getBaseObject())
1823 : cast<llvm::GlobalVariable>(VFTable);
1824 return VTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001825 }
1826
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001827 const VTableLayout &VTLayout =
1828 VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC);
David Majnemera03849b2015-03-18 22:04:43 +00001829 llvm::GlobalValue::LinkageTypes VTableLinkage =
1830 VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage;
1831
1832 StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str();
1833
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001834 llvm::Type *VTableType = CGM.getVTables().getVTableType(VTLayout);
David Majnemera03849b2015-03-18 22:04:43 +00001835
1836 // Create a backing variable for the contents of VTable. The VTable may
1837 // or may not include space for a pointer to RTTI data.
1838 llvm::GlobalValue *VFTable;
1839 VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType,
1840 /*isConstant=*/true, VTableLinkage,
1841 /*Initializer=*/nullptr, VTableName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001842 VTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001843
1844 llvm::Comdat *C = nullptr;
1845 if (!VFTableComesFromAnotherTU &&
1846 (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) ||
1847 (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) &&
1848 VTableAliasIsRequred)))
1849 C = CGM.getModule().getOrInsertComdat(VFTableName.str());
1850
1851 // Only insert a pointer into the VFTable for RTTI data if we are not
1852 // importing it. We never reference the RTTI data directly so there is no
1853 // need to make room for it.
1854 if (VTableAliasIsRequred) {
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001855 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.Int32Ty, 0),
1856 llvm::ConstantInt::get(CGM.Int32Ty, 0),
1857 llvm::ConstantInt::get(CGM.Int32Ty, 1)};
David Majnemera03849b2015-03-18 22:04:43 +00001858 // Create a GEP which points just after the first entry in the VFTable,
1859 // this should be the location of the first virtual method.
David Blaikiee3b172a2015-04-02 18:55:21 +00001860 llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr(
1861 VTable->getValueType(), VTable, GEPIndices);
David Majnemera03849b2015-03-18 22:04:43 +00001862 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) {
1863 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1864 if (C)
1865 C->setSelectionKind(llvm::Comdat::Largest);
1866 }
David Blaikie2a791d72015-09-14 18:38:22 +00001867 VFTable = llvm::GlobalAlias::create(CGM.Int8PtrTy,
1868 /*AddressSpace=*/0, VFTableLinkage,
1869 VFTableName.str(), VTableGEP,
1870 &CGM.getModule());
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001871 VFTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001872 } else {
1873 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1874 // be referencing any RTTI data.
1875 // The GlobalVariable will end up being an appropriate definition of the
1876 // VFTable.
1877 VFTable = VTable;
1878 }
1879 if (C)
1880 VTable->setComdat(C);
1881
David Majnemer2d8b2002016-02-11 17:49:28 +00001882 if (RD->hasAttr<DLLExportAttr>())
David Majnemera03849b2015-03-18 22:04:43 +00001883 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1884
1885 VFTablesMap[ID] = VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001886 return VTable;
1887}
1888
John McCall9831b842018-02-06 18:52:44 +00001889CGCallee MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1890 GlobalDecl GD,
1891 Address This,
1892 llvm::Type *Ty,
1893 SourceLocation Loc) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001894 GD = GD.getCanonicalDecl();
1895 CGBuilderTy &Builder = CGF.Builder;
1896
1897 Ty = Ty->getPointerTo()->getPointerTo();
John McCall7f416cc2015-09-08 08:05:57 +00001898 Address VPtr =
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001899 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001900
1901 auto *MethodDecl = cast<CXXMethodDecl>(GD.getDecl());
1902 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty, MethodDecl->getParent());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001903
David Majnemer07c915e2016-10-27 17:11:51 +00001904 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001905 MicrosoftVTableContext::MethodVFTableLocation ML =
David Majnemer07c915e2016-10-27 17:11:51 +00001906 VFTContext.getMethodVFTableLocation(GD);
1907
1908 // Compute the identity of the most derived class whose virtual table is
1909 // located at the MethodVFTableLocation ML.
1910 auto getObjectWithVPtr = [&] {
1911 return llvm::find_if(VFTContext.getVFPtrOffsets(
1912 ML.VBase ? ML.VBase : MethodDecl->getParent()),
1913 [&](const std::unique_ptr<VPtrInfo> &Info) {
1914 return Info->FullOffsetInMDC == ML.VFPtrOffset;
1915 })
1916 ->get()
1917 ->ObjectWithVPtr;
1918 };
Peter Collingbourned9546012015-06-19 02:30:43 +00001919
John McCall9831b842018-02-06 18:52:44 +00001920 llvm::Value *VFunc;
1921 if (CGF.ShouldEmitVTableTypeCheckedLoad(MethodDecl->getParent())) {
1922 VFunc = CGF.EmitVTableTypeCheckedLoad(
David Majnemer07c915e2016-10-27 17:11:51 +00001923 getObjectWithVPtr(), VTable,
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001924 ML.Index * CGM.getContext().getTargetInfo().getPointerWidth(0) / 8);
John McCall9831b842018-02-06 18:52:44 +00001925 } else {
1926 if (CGM.getCodeGenOpts().PrepareForLTO)
1927 CGF.EmitTypeMetadataCodeForVCall(getObjectWithVPtr(), VTable, Loc);
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001928
John McCall9831b842018-02-06 18:52:44 +00001929 llvm::Value *VFuncPtr =
1930 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1931 VFunc = Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
1932 }
John McCallb92ab1a2016-10-26 23:46:34 +00001933
John McCall9831b842018-02-06 18:52:44 +00001934 CGCallee Callee(MethodDecl, VFunc);
1935 return Callee;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001936}
1937
David Majnemer0c0b6d92014-10-31 20:09:12 +00001938llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1939 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +00001940 Address This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001941 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001942 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1943
1944 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001945 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001946 GlobalDecl GD(Dtor, Dtor_Deleting);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001947 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1948 Dtor, StructorType::Deleting);
George Burgess IV00f70bd2018-03-01 05:43:23 +00001949 llvm::FunctionType *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Peter Collingbourneea211002018-02-05 23:09:13 +00001950 CGCallee Callee = CGCallee::forVirtual(CE, GD, This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001951
David Majnemer9ced3dd2015-03-14 23:44:48 +00001952 ASTContext &Context = getContext();
Nico Weber0a029922015-01-12 21:24:10 +00001953 llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1954 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1955 DtorType == Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001956
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001957 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001958 RValue RV =
1959 CGF.EmitCXXDestructorCall(Dtor, Callee, This.getPointer(), ImplicitParam,
1960 Context.IntTy, CE, StructorType::Deleting);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001961 return RV.getScalarVal();
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001962}
1963
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001964const VBTableGlobals &
1965MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001966 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001967 // easier than caching each vbtable individually.
1968 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1969 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001970 std::tie(Entry, Added) =
1971 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001972 VBTableGlobals &VBGlobals = Entry->second;
1973 if (!Added)
1974 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001975
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001976 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1977 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001978
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001979 // Cache the globals for all vbtables so we don't have to recompute the
1980 // mangled names.
1981 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001982 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1983 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001984 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001985 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001986 }
1987
1988 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001989}
1990
Reid Klecknere4a52202014-02-21 02:27:32 +00001991llvm::Function *MicrosoftCXXABI::EmitVirtualMemPtrThunk(
1992 const CXXMethodDecl *MD,
1993 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001994 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1995 "can't form pointers to ctors or virtual dtors");
1996
Reid Klecknere4a52202014-02-21 02:27:32 +00001997 // Calculate the mangled name.
1998 SmallString<256> ThunkName;
1999 llvm::raw_svector_ostream Out(ThunkName);
2000 getMangleContext().mangleVirtualMemPtrThunk(MD, Out);
Reid Klecknere4a52202014-02-21 02:27:32 +00002001
Hans Wennborg88497d62013-11-15 17:24:45 +00002002 // If the thunk has been generated previously, just return it.
2003 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
2004 return cast<llvm::Function>(GV);
2005
2006 // Create the llvm::Function.
Reid Klecknerc3473512014-08-29 21:43:29 +00002007 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSMemberPointerThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00002008 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
2009 llvm::Function *ThunkFn =
2010 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
2011 ThunkName.str(), &CGM.getModule());
2012 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
2013
Hans Wennborg88497d62013-11-15 17:24:45 +00002014 ThunkFn->setLinkage(MD->isExternallyVisible()
2015 ? llvm::GlobalValue::LinkOnceODRLinkage
2016 : llvm::GlobalValue::InternalLinkage);
David Majnemer8c9cdb62015-01-21 01:21:31 +00002017 if (MD->isExternallyVisible())
2018 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
Hans Wennborg88497d62013-11-15 17:24:45 +00002019
2020 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
2021 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
2022
Reid Kleckner9da94482015-01-21 22:18:17 +00002023 // Add the "thunk" attribute so that LLVM knows that the return type is
2024 // meaningless. These thunks can be used to call functions with differing
2025 // return types, and the caller is required to cast the prototype
2026 // appropriately to extract the correct value.
2027 ThunkFn->addFnAttr("thunk");
2028
Reid Klecknerb9538a62014-08-15 18:12:40 +00002029 // These thunks can be compared, so they are not unnamed.
Peter Collingbournebcf909d2016-06-14 21:02:05 +00002030 ThunkFn->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::None);
Reid Klecknerb9538a62014-08-15 18:12:40 +00002031
Hans Wennborg88497d62013-11-15 17:24:45 +00002032 // Start codegen.
2033 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00002034 CGF.CurGD = GlobalDecl(MD);
2035 CGF.CurFuncIsThunk = true;
2036
2037 // Build FunctionArgs, but only include the implicit 'this' parameter
2038 // declaration.
2039 FunctionArgList FunctionArgs;
2040 buildThisParam(CGF, FunctionArgs);
2041
2042 // Start defining the function.
2043 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
2044 FunctionArgs, MD->getLocation(), SourceLocation());
Reid Kleckner06239e42017-11-16 19:09:36 +00002045 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
Hans Wennborg88497d62013-11-15 17:24:45 +00002046
Reid Klecknere4a52202014-02-21 02:27:32 +00002047 // Load the vfptr and then callee from the vftable. The callee should have
2048 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00002049 llvm::Value *VTable = CGF.GetVTablePtr(
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00002050 getThisAddress(CGF), ThunkTy->getPointerTo()->getPointerTo(), MD->getParent());
2051
Reid Klecknere4a52202014-02-21 02:27:32 +00002052 llvm::Value *VFuncPtr =
2053 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
John McCall7f416cc2015-09-08 08:05:57 +00002054 llvm::Value *Callee =
2055 CGF.Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
Hans Wennborg88497d62013-11-15 17:24:45 +00002056
Reid Klecknerc3473512014-08-29 21:43:29 +00002057 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee);
Hans Wennborg88497d62013-11-15 17:24:45 +00002058
2059 return ThunkFn;
2060}
2061
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002062void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002063 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
2064 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00002065 const std::unique_ptr<VPtrInfo>& VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002066 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
David Majnemer129f4172015-02-02 10:22:20 +00002067 if (GV->isDeclaration())
2068 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00002069 }
2070}
2071
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002072llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002073MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002074 llvm::GlobalVariable::LinkageTypes Linkage) {
2075 SmallString<256> OutName;
2076 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00002077 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002078 StringRef Name = OutName.str();
2079
2080 llvm::ArrayType *VBTableType =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002081 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ObjectWithVPtr->getNumVBases());
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002082
2083 assert(!CGM.getModule().getNamedGlobal(Name) &&
2084 "vbtable with this name already exists: mangling bug?");
2085 llvm::GlobalVariable *GV =
2086 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00002087 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Hans Wennborg853ae942014-05-30 16:59:42 +00002088
2089 if (RD->hasAttr<DLLImportAttr>())
2090 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
2091 else if (RD->hasAttr<DLLExportAttr>())
2092 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
2093
David Majnemer129f4172015-02-02 10:22:20 +00002094 if (!GV->hasExternalLinkage())
2095 emitVBTableDefinition(VBT, RD, GV);
2096
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002097 return GV;
2098}
2099
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002100void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002101 const CXXRecordDecl *RD,
2102 llvm::GlobalVariable *GV) const {
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002103 const CXXRecordDecl *ObjectWithVPtr = VBT.ObjectWithVPtr;
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002104
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002105 assert(RD->getNumVBases() && ObjectWithVPtr->getNumVBases() &&
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002106 "should only emit vbtables for classes with vbtables");
2107
2108 const ASTRecordLayout &BaseLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002109 getContext().getASTRecordLayout(VBT.IntroducingObject);
David Majnemer9ced3dd2015-03-14 23:44:48 +00002110 const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002111
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002112 SmallVector<llvm::Constant *, 4> Offsets(1 + ObjectWithVPtr->getNumVBases(),
Craig Topper8a13c412014-05-21 05:09:00 +00002113 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002114
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002115 // The offset from ObjectWithVPtr's vbptr to itself always leads.
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002116 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
2117 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
2118
2119 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002120 for (const auto &I : ObjectWithVPtr->vbases()) {
Aaron Ballman445a9392014-03-13 16:15:17 +00002121 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002122 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
2123 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00002124
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002125 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00002126 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002127 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00002128 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002129 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00002130 Offset -= CompleteVBPtrOffset;
2131
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002132 unsigned VBIndex = Context.getVBTableIndex(ObjectWithVPtr, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00002133 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002134 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
2135 }
2136
2137 assert(Offsets.size() ==
2138 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
2139 ->getElementType())->getNumElements());
2140 llvm::ArrayType *VBTableType =
2141 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
2142 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
2143 GV->setInitializer(Init);
David Majnemer46e39cc2016-02-22 17:22:08 +00002144
2145 if (RD->hasAttr<DLLImportAttr>())
2146 GV->setLinkage(llvm::GlobalVariable::AvailableExternallyLinkage);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002147}
2148
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002149llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002150 Address This,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002151 const ThisAdjustment &TA) {
2152 if (TA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002153 return This.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002154
John McCall7f416cc2015-09-08 08:05:57 +00002155 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002156
John McCall7f416cc2015-09-08 08:05:57 +00002157 llvm::Value *V;
2158 if (TA.Virtual.isEmpty()) {
2159 V = This.getPointer();
2160 } else {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002161 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
2162 // Adjust the this argument based on the vtordisp value.
John McCall7f416cc2015-09-08 08:05:57 +00002163 Address VtorDispPtr =
2164 CGF.Builder.CreateConstInBoundsByteGEP(This,
2165 CharUnits::fromQuantity(TA.Virtual.Microsoft.VtordispOffset));
2166 VtorDispPtr = CGF.Builder.CreateElementBitCast(VtorDispPtr, CGF.Int32Ty);
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002167 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
John McCall7f416cc2015-09-08 08:05:57 +00002168 V = CGF.Builder.CreateGEP(This.getPointer(),
2169 CGF.Builder.CreateNeg(VtorDisp));
2170
2171 // Unfortunately, having applied the vtordisp means that we no
2172 // longer really have a known alignment for the vbptr step.
2173 // We'll assume the vbptr is pointer-aligned.
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002174
2175 if (TA.Virtual.Microsoft.VBPtrOffset) {
2176 // If the final overrider is defined in a virtual base other than the one
2177 // that holds the vfptr, we have to use a vtordispex thunk which looks up
2178 // the vbtable of the derived class.
2179 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
2180 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
2181 llvm::Value *VBPtr;
2182 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002183 GetVBaseOffsetFromVBPtr(CGF, Address(V, CGF.getPointerAlign()),
2184 -TA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002185 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
2186 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2187 }
2188 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002189
2190 if (TA.NonVirtual) {
2191 // Non-virtual adjustment might result in a pointer outside the allocated
2192 // object, e.g. if the final overrider class is laid out after the virtual
2193 // base that declares a method in the most derived class.
2194 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
2195 }
2196
2197 // Don't need to bitcast back, the call CodeGen will handle this.
2198 return V;
2199}
2200
2201llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00002202MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002203 const ReturnAdjustment &RA) {
2204 if (RA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002205 return Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002206
John McCall7f416cc2015-09-08 08:05:57 +00002207 auto OrigTy = Ret.getType();
2208 Ret = CGF.Builder.CreateElementBitCast(Ret, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002209
John McCall7f416cc2015-09-08 08:05:57 +00002210 llvm::Value *V = Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002211 if (RA.Virtual.Microsoft.VBIndex) {
2212 assert(RA.Virtual.Microsoft.VBIndex > 0);
John McCall7f416cc2015-09-08 08:05:57 +00002213 int32_t IntSize = CGF.getIntSize().getQuantity();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002214 llvm::Value *VBPtr;
2215 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002216 GetVBaseOffsetFromVBPtr(CGF, Ret, RA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002217 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
2218 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2219 }
2220
2221 if (RA.NonVirtual)
David Blaikiefb901c7a2015-04-04 15:12:29 +00002222 V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002223
2224 // Cast back to the original type.
John McCall7f416cc2015-09-08 08:05:57 +00002225 return CGF.Builder.CreateBitCast(V, OrigTy);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002226}
2227
John McCallb91cd662012-05-01 05:23:51 +00002228bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
2229 QualType elementType) {
2230 // Microsoft seems to completely ignore the possibility of a
2231 // two-argument usual deallocation function.
2232 return elementType.isDestructedType();
2233}
2234
2235bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
2236 // Microsoft seems to completely ignore the possibility of a
2237 // two-argument usual deallocation function.
2238 return expr->getAllocatedType().isDestructedType();
2239}
2240
2241CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
2242 // The array cookie is always a size_t; we then pad that out to the
2243 // alignment of the element type.
2244 ASTContext &Ctx = getContext();
2245 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
2246 Ctx.getTypeAlignInChars(type));
2247}
2248
2249llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002250 Address allocPtr,
John McCallb91cd662012-05-01 05:23:51 +00002251 CharUnits cookieSize) {
John McCall7f416cc2015-09-08 08:05:57 +00002252 Address numElementsPtr =
2253 CGF.Builder.CreateElementBitCast(allocPtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002254 return CGF.Builder.CreateLoad(numElementsPtr);
2255}
2256
John McCall7f416cc2015-09-08 08:05:57 +00002257Address MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
2258 Address newPtr,
2259 llvm::Value *numElements,
2260 const CXXNewExpr *expr,
2261 QualType elementType) {
John McCallb91cd662012-05-01 05:23:51 +00002262 assert(requiresArrayCookie(expr));
2263
2264 // The size of the cookie.
2265 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
2266
2267 // Compute an offset to the cookie.
John McCall7f416cc2015-09-08 08:05:57 +00002268 Address cookiePtr = newPtr;
John McCallb91cd662012-05-01 05:23:51 +00002269
2270 // Write the number of elements into the appropriate slot.
John McCall7f416cc2015-09-08 08:05:57 +00002271 Address numElementsPtr
2272 = CGF.Builder.CreateElementBitCast(cookiePtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002273 CGF.Builder.CreateStore(numElements, numElementsPtr);
2274
2275 // Finally, compute a pointer to the actual data buffer by skipping
2276 // over the cookie completely.
John McCall7f416cc2015-09-08 08:05:57 +00002277 return CGF.Builder.CreateConstInBoundsByteGEP(newPtr, cookieSize);
John McCallb91cd662012-05-01 05:23:51 +00002278}
2279
David Majnemerb3341ea2014-10-05 05:05:40 +00002280static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
2281 llvm::Constant *Dtor,
2282 llvm::Constant *Addr) {
2283 // Create a function which calls the destructor.
2284 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
2285
2286 // extern "C" int __tlregdtor(void (*f)(void));
2287 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
2288 CGF.IntTy, DtorStub->getType(), /*IsVarArg=*/false);
2289
Reid Klecknerde864822017-03-21 16:57:30 +00002290 llvm::Constant *TLRegDtor = CGF.CGM.CreateRuntimeFunction(
2291 TLRegDtorTy, "__tlregdtor", llvm::AttributeList(), /*Local=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002292 if (llvm::Function *TLRegDtorFn = dyn_cast<llvm::Function>(TLRegDtor))
2293 TLRegDtorFn->setDoesNotThrow();
2294
2295 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
2296}
2297
2298void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
2299 llvm::Constant *Dtor,
2300 llvm::Constant *Addr) {
2301 if (D.getTLSKind())
2302 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
2303
2304 // The default behavior is to use atexit.
2305 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
2306}
2307
2308void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +00002309 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +00002310 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +00002311 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) {
David Majnemercb60a432016-09-12 02:51:43 +00002312 if (CXXThreadLocalInits.empty())
2313 return;
2314
2315 CGM.AppendLinkerOptions(CGM.getTarget().getTriple().getArch() ==
2316 llvm::Triple::x86
2317 ? "/include:___dyn_tls_init@12"
2318 : "/include:__dyn_tls_init");
2319
David Majnemerb3341ea2014-10-05 05:05:40 +00002320 // This will create a GV in the .CRT$XDU section. It will point to our
2321 // initialization function. The CRT will call all of these function
2322 // pointers at start-up time and, eventually, at thread-creation time.
2323 auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
2324 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
2325 CGM.getModule(), InitFunc->getType(), /*IsConstant=*/true,
2326 llvm::GlobalVariable::InternalLinkage, InitFunc,
2327 Twine(InitFunc->getName(), "$initializer$"));
2328 InitFuncPtr->setSection(".CRT$XDU");
2329 // This variable has discardable linkage, we have to add it to @llvm.used to
2330 // ensure it won't get discarded.
2331 CGM.addUsedGlobal(InitFuncPtr);
2332 return InitFuncPtr;
2333 };
2334
2335 std::vector<llvm::Function *> NonComdatInits;
2336 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
Richard Smith5a99c492015-12-01 01:10:48 +00002337 llvm::GlobalVariable *GV = cast<llvm::GlobalVariable>(
2338 CGM.GetGlobalValue(CGM.getMangledName(CXXThreadLocalInitVars[I])));
David Majnemerb3341ea2014-10-05 05:05:40 +00002339 llvm::Function *F = CXXThreadLocalInits[I];
2340
2341 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002342 if (llvm::Comdat *C = GV->getComdat())
David Majnemerb3341ea2014-10-05 05:05:40 +00002343 AddToXDU(F)->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002344 else
David Majnemerb3341ea2014-10-05 05:05:40 +00002345 NonComdatInits.push_back(F);
David Majnemerb3341ea2014-10-05 05:05:40 +00002346 }
2347
2348 if (!NonComdatInits.empty()) {
2349 llvm::FunctionType *FTy =
2350 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002351 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +00002352 FTy, "__tls_init", CGM.getTypes().arrangeNullaryFunction(),
2353 SourceLocation(), /*TLS=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002354 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2355
2356 AddToXDU(InitFunc);
2357 }
2358}
2359
2360LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2361 const VarDecl *VD,
2362 QualType LValType) {
2363 CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2364 return LValue();
2365}
2366
John McCall7f416cc2015-09-08 08:05:57 +00002367static ConstantAddress getInitThreadEpochPtr(CodeGenModule &CGM) {
David Majnemer8354eee2015-05-07 06:15:46 +00002368 StringRef VarName("_Init_thread_epoch");
John McCall7f416cc2015-09-08 08:05:57 +00002369 CharUnits Align = CGM.getIntAlign();
David Majnemer8354eee2015-05-07 06:15:46 +00002370 if (auto *GV = CGM.getModule().getNamedGlobal(VarName))
John McCall7f416cc2015-09-08 08:05:57 +00002371 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002372 auto *GV = new llvm::GlobalVariable(
2373 CGM.getModule(), CGM.IntTy,
2374 /*Constant=*/false, llvm::GlobalVariable::ExternalLinkage,
2375 /*Initializer=*/nullptr, VarName,
2376 /*InsertBefore=*/nullptr, llvm::GlobalVariable::GeneralDynamicTLSModel);
John McCall7f416cc2015-09-08 08:05:57 +00002377 GV->setAlignment(Align.getQuantity());
2378 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002379}
2380
2381static llvm::Constant *getInitThreadHeaderFn(CodeGenModule &CGM) {
2382 llvm::FunctionType *FTy =
2383 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2384 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2385 return CGM.CreateRuntimeFunction(
2386 FTy, "_Init_thread_header",
Reid Klecknerde864822017-03-21 16:57:30 +00002387 llvm::AttributeList::get(CGM.getLLVMContext(),
2388 llvm::AttributeList::FunctionIndex,
2389 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002390 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002391}
2392
2393static llvm::Constant *getInitThreadFooterFn(CodeGenModule &CGM) {
2394 llvm::FunctionType *FTy =
2395 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2396 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2397 return CGM.CreateRuntimeFunction(
2398 FTy, "_Init_thread_footer",
Reid Klecknerde864822017-03-21 16:57:30 +00002399 llvm::AttributeList::get(CGM.getLLVMContext(),
2400 llvm::AttributeList::FunctionIndex,
2401 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002402 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002403}
2404
2405static llvm::Constant *getInitThreadAbortFn(CodeGenModule &CGM) {
2406 llvm::FunctionType *FTy =
2407 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2408 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2409 return CGM.CreateRuntimeFunction(
2410 FTy, "_Init_thread_abort",
Reid Klecknerde864822017-03-21 16:57:30 +00002411 llvm::AttributeList::get(CGM.getLLVMContext(),
2412 llvm::AttributeList::FunctionIndex,
2413 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002414 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002415}
2416
2417namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002418struct ResetGuardBit final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002419 Address Guard;
David Majnemer8354eee2015-05-07 06:15:46 +00002420 unsigned GuardNum;
John McCall7f416cc2015-09-08 08:05:57 +00002421 ResetGuardBit(Address Guard, unsigned GuardNum)
David Majnemer8354eee2015-05-07 06:15:46 +00002422 : Guard(Guard), GuardNum(GuardNum) {}
2423
2424 void Emit(CodeGenFunction &CGF, Flags flags) override {
2425 // Reset the bit in the mask so that the static variable may be
2426 // reinitialized.
2427 CGBuilderTy &Builder = CGF.Builder;
2428 llvm::LoadInst *LI = Builder.CreateLoad(Guard);
2429 llvm::ConstantInt *Mask =
Reid Klecknerd16cebe2016-02-10 19:09:15 +00002430 llvm::ConstantInt::get(CGF.IntTy, ~(1ULL << GuardNum));
David Majnemer8354eee2015-05-07 06:15:46 +00002431 Builder.CreateStore(Builder.CreateAnd(LI, Mask), Guard);
2432 }
2433};
2434
David Blaikie7e70d682015-08-18 22:40:54 +00002435struct CallInitThreadAbort final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002436 llvm::Value *Guard;
2437 CallInitThreadAbort(Address Guard) : Guard(Guard.getPointer()) {}
David Majnemer8354eee2015-05-07 06:15:46 +00002438
2439 void Emit(CodeGenFunction &CGF, Flags flags) override {
2440 // Calling _Init_thread_abort will reset the guard's state.
2441 CGF.EmitNounwindRuntimeCall(getInitThreadAbortFn(CGF.CGM), Guard);
2442 }
2443};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002444}
David Majnemer8354eee2015-05-07 06:15:46 +00002445
John McCallc84ed6a2012-05-01 06:13:13 +00002446void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00002447 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00002448 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00002449 // MSVC only uses guards for static locals.
2450 if (!D.isStaticLocal()) {
2451 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2452 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
Rafael Espindola77abc3a2015-01-16 16:04:45 +00002453 llvm::Function *F = CGF.CurFn;
2454 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2455 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
Reid Kleckner563f0e82014-05-23 21:13:45 +00002456 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2457 return;
2458 }
2459
David Majnemerec8e54b2015-05-07 21:19:06 +00002460 bool ThreadlocalStatic = D.getTLSKind();
2461 bool ThreadsafeStatic = getContext().getLangOpts().ThreadsafeStatics;
2462
2463 // Thread-safe static variables which aren't thread-specific have a
2464 // per-variable guard.
2465 bool HasPerVariableGuard = ThreadsafeStatic && !ThreadlocalStatic;
Richard Smithdbf74ba2013-04-14 23:01:42 +00002466
Reid Klecknerd8110b62013-09-10 20:14:30 +00002467 CGBuilderTy &Builder = CGF.Builder;
2468 llvm::IntegerType *GuardTy = CGF.Int32Ty;
2469 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
John McCall7f416cc2015-09-08 08:05:57 +00002470 CharUnits GuardAlign = CharUnits::fromQuantity(4);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002471
2472 // Get the guard variable for this function if we have one already.
David Majnemerec8e54b2015-05-07 21:19:06 +00002473 GuardInfo *GI = nullptr;
2474 if (ThreadlocalStatic)
2475 GI = &ThreadLocalGuardVariableMap[D.getDeclContext()];
2476 else if (!ThreadsafeStatic)
2477 GI = &GuardVariableMap[D.getDeclContext()];
2478
2479 llvm::GlobalVariable *GuardVar = GI ? GI->Guard : nullptr;
David Majnemer8354eee2015-05-07 06:15:46 +00002480 unsigned GuardNum;
David Majnemerec8e54b2015-05-07 21:19:06 +00002481 if (D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002482 // Externally visible variables have to be numbered in Sema to properly
2483 // handle unreachable VarDecls.
David Majnemer8354eee2015-05-07 06:15:46 +00002484 GuardNum = getContext().getStaticLocalNumber(&D);
2485 assert(GuardNum > 0);
2486 GuardNum--;
2487 } else if (HasPerVariableGuard) {
2488 GuardNum = ThreadSafeGuardNumMap[D.getDeclContext()]++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002489 } else {
2490 // Non-externally visible variables are numbered here in CodeGen.
David Majnemer8354eee2015-05-07 06:15:46 +00002491 GuardNum = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002492 }
2493
David Majnemer8354eee2015-05-07 06:15:46 +00002494 if (!HasPerVariableGuard && GuardNum >= 32) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002495 if (D.isExternallyVisible())
2496 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
David Majnemer8354eee2015-05-07 06:15:46 +00002497 GuardNum %= 32;
2498 GuardVar = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002499 }
2500
David Majnemer8354eee2015-05-07 06:15:46 +00002501 if (!GuardVar) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002502 // Mangle the name for the guard.
2503 SmallString<256> GuardName;
2504 {
2505 llvm::raw_svector_ostream Out(GuardName);
David Majnemer8354eee2015-05-07 06:15:46 +00002506 if (HasPerVariableGuard)
2507 getMangleContext().mangleThreadSafeStaticGuardVariable(&D, GuardNum,
2508 Out);
2509 else
2510 getMangleContext().mangleStaticGuardVariable(&D, Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002511 }
2512
Hans Wennborgef2272c2014-06-18 15:55:13 +00002513 // Create the guard variable with a zero-initializer. Just absorb linkage,
2514 // visibility and dll storage class from the guarded variable.
David Majnemer8354eee2015-05-07 06:15:46 +00002515 GuardVar =
2516 new llvm::GlobalVariable(CGM.getModule(), GuardTy, /*isConstant=*/false,
Reid Klecknere9591b32014-04-23 18:22:11 +00002517 GV->getLinkage(), Zero, GuardName.str());
David Majnemer8354eee2015-05-07 06:15:46 +00002518 GuardVar->setVisibility(GV->getVisibility());
2519 GuardVar->setDLLStorageClass(GV->getDLLStorageClass());
John McCall7f416cc2015-09-08 08:05:57 +00002520 GuardVar->setAlignment(GuardAlign.getQuantity());
David Majnemer8354eee2015-05-07 06:15:46 +00002521 if (GuardVar->isWeakForLinker())
2522 GuardVar->setComdat(
2523 CGM.getModule().getOrInsertComdat(GuardVar->getName()));
2524 if (D.getTLSKind())
2525 GuardVar->setThreadLocal(true);
2526 if (GI && !HasPerVariableGuard)
2527 GI->Guard = GuardVar;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002528 }
2529
John McCall7f416cc2015-09-08 08:05:57 +00002530 ConstantAddress GuardAddr(GuardVar, GuardAlign);
2531
David Majnemer8354eee2015-05-07 06:15:46 +00002532 assert(GuardVar->getLinkage() == GV->getLinkage() &&
2533 "static local from the same function had different linkage");
Reid Klecknerd8110b62013-09-10 20:14:30 +00002534
David Majnemer8354eee2015-05-07 06:15:46 +00002535 if (!HasPerVariableGuard) {
2536 // Pseudo code for the test:
2537 // if (!(GuardVar & MyGuardBit)) {
2538 // GuardVar |= MyGuardBit;
2539 // ... initialize the object ...;
2540 // }
Reid Klecknerd8110b62013-09-10 20:14:30 +00002541
David Majnemer8354eee2015-05-07 06:15:46 +00002542 // Test our bit from the guard variable.
Aaron Ballmanabd466e2016-03-30 21:33:34 +00002543 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1ULL << GuardNum);
John McCall7f416cc2015-09-08 08:05:57 +00002544 llvm::LoadInst *LI = Builder.CreateLoad(GuardAddr);
Richard Smithae8d62c2017-07-26 22:01:09 +00002545 llvm::Value *NeedsInit =
2546 Builder.CreateICmpEQ(Builder.CreateAnd(LI, Bit), Zero);
David Majnemer8354eee2015-05-07 06:15:46 +00002547 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2548 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002549 CGF.EmitCXXGuardedInitBranch(NeedsInit, InitBlock, EndBlock,
2550 CodeGenFunction::GuardKind::VariableGuard, &D);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002551
David Majnemer8354eee2015-05-07 06:15:46 +00002552 // Set our bit in the guard variable and emit the initializer and add a global
2553 // destructor if appropriate.
2554 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002555 Builder.CreateStore(Builder.CreateOr(LI, Bit), GuardAddr);
2556 CGF.EHStack.pushCleanup<ResetGuardBit>(EHCleanup, GuardAddr, GuardNum);
David Majnemer8354eee2015-05-07 06:15:46 +00002557 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2558 CGF.PopCleanupBlock();
2559 Builder.CreateBr(EndBlock);
2560
2561 // Continue.
2562 CGF.EmitBlock(EndBlock);
2563 } else {
2564 // Pseudo code for the test:
2565 // if (TSS > _Init_thread_epoch) {
2566 // _Init_thread_header(&TSS);
2567 // if (TSS == -1) {
2568 // ... initialize the object ...;
2569 // _Init_thread_footer(&TSS);
2570 // }
2571 // }
2572 //
2573 // The algorithm is almost identical to what can be found in the appendix
2574 // found in N2325.
2575
David Majnemer8354eee2015-05-07 06:15:46 +00002576 // This BasicBLock determines whether or not we have any work to do.
John McCall7f416cc2015-09-08 08:05:57 +00002577 llvm::LoadInst *FirstGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002578 FirstGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2579 llvm::LoadInst *InitThreadEpoch =
2580 Builder.CreateLoad(getInitThreadEpochPtr(CGM));
2581 llvm::Value *IsUninitialized =
2582 Builder.CreateICmpSGT(FirstGuardLoad, InitThreadEpoch);
2583 llvm::BasicBlock *AttemptInitBlock = CGF.createBasicBlock("init.attempt");
2584 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002585 CGF.EmitCXXGuardedInitBranch(IsUninitialized, AttemptInitBlock, EndBlock,
2586 CodeGenFunction::GuardKind::VariableGuard, &D);
David Majnemer8354eee2015-05-07 06:15:46 +00002587
2588 // This BasicBlock attempts to determine whether or not this thread is
2589 // responsible for doing the initialization.
2590 CGF.EmitBlock(AttemptInitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002591 CGF.EmitNounwindRuntimeCall(getInitThreadHeaderFn(CGM),
2592 GuardAddr.getPointer());
2593 llvm::LoadInst *SecondGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002594 SecondGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2595 llvm::Value *ShouldDoInit =
2596 Builder.CreateICmpEQ(SecondGuardLoad, getAllOnesInt());
2597 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2598 Builder.CreateCondBr(ShouldDoInit, InitBlock, EndBlock);
2599
2600 // Ok, we ended up getting selected as the initializing thread.
2601 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002602 CGF.EHStack.pushCleanup<CallInitThreadAbort>(EHCleanup, GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002603 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2604 CGF.PopCleanupBlock();
John McCall7f416cc2015-09-08 08:05:57 +00002605 CGF.EmitNounwindRuntimeCall(getInitThreadFooterFn(CGM),
2606 GuardAddr.getPointer());
David Majnemer8354eee2015-05-07 06:15:46 +00002607 Builder.CreateBr(EndBlock);
2608
2609 CGF.EmitBlock(EndBlock);
2610 }
John McCallc84ed6a2012-05-01 06:13:13 +00002611}
2612
Reid Kleckner2341ae32013-04-11 18:13:19 +00002613bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2614 // Null-ness for function memptrs only depends on the first field, which is
2615 // the function pointer. The rest don't matter, so we can zero initialize.
2616 if (MPT->isMemberFunctionPointer())
2617 return true;
2618
2619 // The virtual base adjustment field is always -1 for null, so if we have one
2620 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
2621 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002622 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2623 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002624 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
2625 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00002626}
2627
2628llvm::Type *
2629MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002630 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2631 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002632 llvm::SmallVector<llvm::Type *, 4> fields;
2633 if (MPT->isMemberFunctionPointer())
2634 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
2635 else
2636 fields.push_back(CGM.IntTy); // FieldOffset
2637
Reid Kleckner96f8f932014-02-05 17:27:08 +00002638 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2639 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002640 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002641 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002642 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002643 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002644 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
2645
2646 if (fields.size() == 1)
2647 return fields[0];
2648 return llvm::StructType::get(CGM.getLLVMContext(), fields);
2649}
2650
2651void MicrosoftCXXABI::
2652GetNullMemberPointerFields(const MemberPointerType *MPT,
2653 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2654 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00002655 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2656 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002657 if (MPT->isMemberFunctionPointer()) {
2658 // FunctionPointerOrVirtualThunk
2659 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2660 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00002661 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00002662 fields.push_back(getZeroInt()); // FieldOffset
2663 else
2664 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00002665 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00002666
Reid Kleckner96f8f932014-02-05 17:27:08 +00002667 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2668 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002669 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002670 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002671 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002672 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002673 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002674}
2675
2676llvm::Constant *
2677MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002678 llvm::SmallVector<llvm::Constant *, 4> fields;
2679 GetNullMemberPointerFields(MPT, fields);
2680 if (fields.size() == 1)
2681 return fields[0];
2682 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2683 assert(Res->getType() == ConvertMemberPointerType(MPT));
2684 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002685}
2686
2687llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002688MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2689 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00002690 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +00002691 CharUnits NonVirtualBaseAdjustment,
2692 unsigned VBTableIndex) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002693 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002694
2695 // Single inheritance class member pointer are represented as scalars instead
2696 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002697 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002698 return FirstField;
2699
Reid Kleckner2341ae32013-04-11 18:13:19 +00002700 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002701 fields.push_back(FirstField);
2702
Reid Kleckner96f8f932014-02-05 17:27:08 +00002703 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002704 fields.push_back(llvm::ConstantInt::get(
2705 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002706
Reid Kleckner96f8f932014-02-05 17:27:08 +00002707 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00002708 CharUnits Offs = CharUnits::Zero();
David Majnemerc1709d32015-06-23 07:31:11 +00002709 if (VBTableIndex)
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002710 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00002711 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00002712 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002713
2714 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002715 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
David Majnemere60813f2015-05-10 21:48:08 +00002716 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, VBTableIndex));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002717
Reid Kleckner2341ae32013-04-11 18:13:19 +00002718 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002719}
2720
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002721llvm::Constant *
2722MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2723 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002724 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerc1709d32015-06-23 07:31:11 +00002725 if (RD->getMSInheritanceModel() ==
2726 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002727 offset -= getContext().getOffsetOfBaseWithVBPtr(RD);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002728 llvm::Constant *FirstField =
2729 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00002730 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002731 CharUnits::Zero(), /*VBTableIndex=*/0);
Reid Kleckner452abac2013-05-09 21:01:17 +00002732}
2733
Reid Kleckner452abac2013-05-09 21:01:17 +00002734llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2735 QualType MPType) {
David Majnemer5ca193c2015-06-23 07:31:07 +00002736 const MemberPointerType *DstTy = MPType->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002737 const ValueDecl *MPD = MP.getMemberPointerDecl();
2738 if (!MPD)
David Majnemer5ca193c2015-06-23 07:31:07 +00002739 return EmitNullMemberPointer(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002740
David Majnemer5ca193c2015-06-23 07:31:07 +00002741 ASTContext &Ctx = getContext();
2742 ArrayRef<const CXXRecordDecl *> MemberPointerPath = MP.getMemberPointerPath();
Reid Kleckner452abac2013-05-09 21:01:17 +00002743
David Majnemer5ca193c2015-06-23 07:31:07 +00002744 llvm::Constant *C;
2745 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) {
2746 C = EmitMemberFunctionPointer(MD);
2747 } else {
2748 CharUnits FieldOffset = Ctx.toCharUnitsFromBits(Ctx.getFieldOffset(MPD));
2749 C = EmitMemberDataPointer(DstTy, FieldOffset);
2750 }
Reid Kleckner452abac2013-05-09 21:01:17 +00002751
David Majnemer5ca193c2015-06-23 07:31:07 +00002752 if (!MemberPointerPath.empty()) {
2753 const CXXRecordDecl *SrcRD = cast<CXXRecordDecl>(MPD->getDeclContext());
2754 const Type *SrcRecTy = Ctx.getTypeDeclType(SrcRD).getTypePtr();
2755 const MemberPointerType *SrcTy =
2756 Ctx.getMemberPointerType(DstTy->getPointeeType(), SrcRecTy)
2757 ->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002758
David Majnemer5ca193c2015-06-23 07:31:07 +00002759 bool DerivedMember = MP.isMemberPointerToDerivedMember();
2760 SmallVector<const CXXBaseSpecifier *, 4> DerivedToBasePath;
2761 const CXXRecordDecl *PrevRD = SrcRD;
2762 for (const CXXRecordDecl *PathElem : MemberPointerPath) {
2763 const CXXRecordDecl *Base = nullptr;
2764 const CXXRecordDecl *Derived = nullptr;
2765 if (DerivedMember) {
2766 Base = PathElem;
2767 Derived = PrevRD;
2768 } else {
2769 Base = PrevRD;
2770 Derived = PathElem;
2771 }
2772 for (const CXXBaseSpecifier &BS : Derived->bases())
2773 if (BS.getType()->getAsCXXRecordDecl()->getCanonicalDecl() ==
2774 Base->getCanonicalDecl())
2775 DerivedToBasePath.push_back(&BS);
2776 PrevRD = PathElem;
2777 }
2778 assert(DerivedToBasePath.size() == MemberPointerPath.size());
2779
2780 CastKind CK = DerivedMember ? CK_DerivedToBaseMemberPointer
2781 : CK_BaseToDerivedMemberPointer;
2782 C = EmitMemberPointerConversion(SrcTy, DstTy, CK, DerivedToBasePath.begin(),
2783 DerivedToBasePath.end(), C);
2784 }
2785 return C;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002786}
2787
2788llvm::Constant *
David Majnemer5ca193c2015-06-23 07:31:07 +00002789MicrosoftCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002790 assert(MD->isInstance() && "Member function must not be static!");
David Majnemer5ca193c2015-06-23 07:31:07 +00002791
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002792 MD = MD->getCanonicalDecl();
David Majnemer5ca193c2015-06-23 07:31:07 +00002793 CharUnits NonVirtualBaseAdjustment = CharUnits::Zero();
2794 const CXXRecordDecl *RD = MD->getParent()->getMostRecentDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002795 CodeGenTypes &Types = CGM.getTypes();
2796
David Majnemere60813f2015-05-10 21:48:08 +00002797 unsigned VBTableIndex = 0;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002798 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00002799 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00002800 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002801 llvm::Type *Ty;
2802 // Check whether the function has a computable LLVM signature.
2803 if (Types.isFuncTypeConvertible(FPT)) {
2804 // The function has a computable LLVM signature; use the correct type.
2805 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2806 } else {
2807 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2808 // function type is incomplete.
2809 Ty = CGM.PtrDiffTy;
2810 }
2811 FirstField = CGM.GetAddrOfFunction(MD, Ty);
Hans Wennborg88497d62013-11-15 17:24:45 +00002812 } else {
David Majnemere0e228a2015-06-11 08:12:44 +00002813 auto &VTableContext = CGM.getMicrosoftVTableContext();
2814 MicrosoftVTableContext::MethodVFTableLocation ML =
2815 VTableContext.getMethodVFTableLocation(MD);
David Majnemerc1709d32015-06-23 07:31:11 +00002816 FirstField = EmitVirtualMemPtrThunk(MD, ML);
David Majnemere0e228a2015-06-11 08:12:44 +00002817 // Include the vfptr adjustment if the method is in a non-primary vftable.
2818 NonVirtualBaseAdjustment += ML.VFPtrOffset;
2819 if (ML.VBase)
2820 VBTableIndex = VTableContext.getVBTableIndex(RD, ML.VBase) * 4;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002821 }
2822
David Majnemerc1709d32015-06-23 07:31:11 +00002823 if (VBTableIndex == 0 &&
2824 RD->getMSInheritanceModel() ==
2825 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002826 NonVirtualBaseAdjustment -= getContext().getOffsetOfBaseWithVBPtr(RD);
David Majnemerc1709d32015-06-23 07:31:11 +00002827
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002828 // The rest of the fields are common with data member pointers.
David Majnemerc1709d32015-06-23 07:31:11 +00002829 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002830 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002831 NonVirtualBaseAdjustment, VBTableIndex);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002832}
2833
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002834/// Member pointers are the same if they're either bitwise identical *or* both
2835/// null. Null-ness for function members is determined by the first field,
2836/// while for data member pointers we must compare all fields.
2837llvm::Value *
2838MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2839 llvm::Value *L,
2840 llvm::Value *R,
2841 const MemberPointerType *MPT,
2842 bool Inequality) {
2843 CGBuilderTy &Builder = CGF.Builder;
2844
2845 // Handle != comparisons by switching the sense of all boolean operations.
2846 llvm::ICmpInst::Predicate Eq;
2847 llvm::Instruction::BinaryOps And, Or;
2848 if (Inequality) {
2849 Eq = llvm::ICmpInst::ICMP_NE;
2850 And = llvm::Instruction::Or;
2851 Or = llvm::Instruction::And;
2852 } else {
2853 Eq = llvm::ICmpInst::ICMP_EQ;
2854 And = llvm::Instruction::And;
2855 Or = llvm::Instruction::Or;
2856 }
2857
2858 // If this is a single field member pointer (single inheritance), this is a
2859 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002860 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2861 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002862 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2863 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002864 return Builder.CreateICmp(Eq, L, R);
2865
2866 // Compare the first field.
2867 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2868 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2869 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2870
2871 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002872 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002873 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2874 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2875 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2876 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2877 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2878 if (Res)
2879 Res = Builder.CreateBinOp(And, Res, Cmp);
2880 else
2881 Res = Cmp;
2882 }
2883
2884 // Check if the first field is 0 if this is a function pointer.
2885 if (MPT->isMemberFunctionPointer()) {
2886 // (l1 == r1 && ...) || l0 == 0
2887 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2888 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2889 Res = Builder.CreateBinOp(Or, Res, IsZero);
2890 }
2891
2892 // Combine the comparison of the first field, which must always be true for
2893 // this comparison to succeeed.
2894 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2895}
2896
Reid Kleckner407e8b62013-03-22 19:02:54 +00002897llvm::Value *
2898MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2899 llvm::Value *MemPtr,
2900 const MemberPointerType *MPT) {
2901 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002902 llvm::SmallVector<llvm::Constant *, 4> fields;
2903 // We only need one field for member functions.
2904 if (MPT->isMemberFunctionPointer())
2905 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2906 else
2907 GetNullMemberPointerFields(MPT, fields);
2908 assert(!fields.empty());
2909 llvm::Value *FirstField = MemPtr;
2910 if (MemPtr->getType()->isStructTy())
2911 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2912 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002913
Reid Kleckner2341ae32013-04-11 18:13:19 +00002914 // For function member pointers, we only need to test the function pointer
2915 // field. The other fields if any can be garbage.
2916 if (MPT->isMemberFunctionPointer())
2917 return Res;
2918
2919 // Otherwise, emit a series of compares and combine the results.
2920 for (int I = 1, E = fields.size(); I < E; ++I) {
2921 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2922 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002923 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002924 }
2925 return Res;
2926}
2927
Reid Kleckner452abac2013-05-09 21:01:17 +00002928bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2929 llvm::Constant *Val) {
2930 // Function pointers are null if the pointer in the first field is null.
2931 if (MPT->isMemberFunctionPointer()) {
2932 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2933 Val->getAggregateElement(0U) : Val;
2934 return FirstField->isNullValue();
2935 }
2936
2937 // If it's not a function pointer and it's zero initializable, we can easily
2938 // check zero.
2939 if (isZeroInitializable(MPT) && Val->isNullValue())
2940 return true;
2941
2942 // Otherwise, break down all the fields for comparison. Hopefully these
2943 // little Constants are reused, while a big null struct might not be.
2944 llvm::SmallVector<llvm::Constant *, 4> Fields;
2945 GetNullMemberPointerFields(MPT, Fields);
2946 if (Fields.size() == 1) {
2947 assert(Val->getType()->isIntegerTy());
2948 return Val == Fields[0];
2949 }
2950
2951 unsigned I, E;
2952 for (I = 0, E = Fields.size(); I != E; ++I) {
2953 if (Val->getAggregateElement(I) != Fields[I])
2954 break;
2955 }
2956 return I == E;
2957}
2958
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002959llvm::Value *
2960MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002961 Address This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002962 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002963 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002964 llvm::Value **VBPtrOut) {
2965 CGBuilderTy &Builder = CGF.Builder;
2966 // Load the vbtable pointer from the vbptr in the instance.
John McCall7f416cc2015-09-08 08:05:57 +00002967 This = Builder.CreateElementBitCast(This, CGM.Int8Ty);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002968 llvm::Value *VBPtr =
John McCall7f416cc2015-09-08 08:05:57 +00002969 Builder.CreateInBoundsGEP(This.getPointer(), VBPtrOffset, "vbptr");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002970 if (VBPtrOut) *VBPtrOut = VBPtr;
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002971 VBPtr = Builder.CreateBitCast(VBPtr,
John McCall7f416cc2015-09-08 08:05:57 +00002972 CGM.Int32Ty->getPointerTo(0)->getPointerTo(This.getAddressSpace()));
2973
2974 CharUnits VBPtrAlign;
2975 if (auto CI = dyn_cast<llvm::ConstantInt>(VBPtrOffset)) {
2976 VBPtrAlign = This.getAlignment().alignmentAtOffset(
2977 CharUnits::fromQuantity(CI->getSExtValue()));
2978 } else {
2979 VBPtrAlign = CGF.getPointerAlign();
2980 }
2981
2982 llvm::Value *VBTable = Builder.CreateAlignedLoad(VBPtr, VBPtrAlign, "vbtable");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002983
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002984 // Translate from byte offset to table index. It improves analyzability.
2985 llvm::Value *VBTableIndex = Builder.CreateAShr(
2986 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
2987 "vbtindex", /*isExact=*/true);
2988
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002989 // Load an i32 offset from the vb-table.
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002990 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002991 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
John McCall7f416cc2015-09-08 08:05:57 +00002992 return Builder.CreateAlignedLoad(VBaseOffs, CharUnits::fromQuantity(4),
2993 "vbase_offs");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002994}
2995
Reid Kleckner2341ae32013-04-11 18:13:19 +00002996// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2997// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002998llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2999 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
John McCall7f416cc2015-09-08 08:05:57 +00003000 Address Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003001 CGBuilderTy &Builder = CGF.Builder;
John McCall7f416cc2015-09-08 08:05:57 +00003002 Base = Builder.CreateElementBitCast(Base, CGM.Int8Ty);
Craig Topper8a13c412014-05-21 05:09:00 +00003003 llvm::BasicBlock *OriginalBB = nullptr;
3004 llvm::BasicBlock *SkipAdjustBB = nullptr;
3005 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003006
3007 // In the unspecified inheritance model, there might not be a vbtable at all,
3008 // in which case we need to skip the virtual base lookup. If there is a
3009 // vbtable, the first entry is a no-op entry that gives back the original
3010 // base, so look for a virtual base adjustment offset of zero.
3011 if (VBPtrOffset) {
3012 OriginalBB = Builder.GetInsertBlock();
3013 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
3014 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
3015 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00003016 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00003017 "memptr.is_vbase");
3018 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
3019 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00003020 }
3021
Reid Kleckner2341ae32013-04-11 18:13:19 +00003022 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
3023 // know the vbptr offset.
3024 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00003025 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00003026 if (!RD->hasDefinition()) {
3027 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
3028 unsigned DiagID = Diags.getCustomDiagID(
3029 DiagnosticsEngine::Error,
3030 "member pointer representation requires a "
3031 "complete class type for %0 to perform this expression");
3032 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
3033 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00003034 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003035 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
3036 }
Craig Topper8a13c412014-05-21 05:09:00 +00003037 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003038 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00003039 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00003040 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
3041
3042 // Merge control flow with the case where we didn't have to adjust.
3043 if (VBaseAdjustBB) {
3044 Builder.CreateBr(SkipAdjustBB);
3045 CGF.EmitBlock(SkipAdjustBB);
3046 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
John McCall7f416cc2015-09-08 08:05:57 +00003047 Phi->addIncoming(Base.getPointer(), OriginalBB);
Reid Kleckner2341ae32013-04-11 18:13:19 +00003048 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
3049 return Phi;
3050 }
3051 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00003052}
3053
David Majnemer2b0d66d2014-02-20 23:22:07 +00003054llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
John McCall7f416cc2015-09-08 08:05:57 +00003055 CodeGenFunction &CGF, const Expr *E, Address Base, llvm::Value *MemPtr,
David Majnemer2b0d66d2014-02-20 23:22:07 +00003056 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003057 assert(MPT->isMemberDataPointer());
John McCall7f416cc2015-09-08 08:05:57 +00003058 unsigned AS = Base.getAddressSpace();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003059 llvm::Type *PType =
3060 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
3061 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003062 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
3063 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003064
Reid Kleckner2341ae32013-04-11 18:13:19 +00003065 // Extract the fields we need, regardless of model. We'll apply them if we
3066 // have them.
3067 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003068 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3069 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003070 if (MemPtr->getType()->isStructTy()) {
3071 // We need to extract values.
3072 unsigned I = 0;
3073 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003074 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003075 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003076 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003077 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00003078 }
3079
John McCall7f416cc2015-09-08 08:05:57 +00003080 llvm::Value *Addr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003081 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003082 Addr = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00003083 VBPtrOffset);
John McCall7f416cc2015-09-08 08:05:57 +00003084 } else {
3085 Addr = Base.getPointer();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003086 }
Reid Klecknerae945122013-12-05 22:44:07 +00003087
3088 // Cast to char*.
John McCall7f416cc2015-09-08 08:05:57 +00003089 Addr = Builder.CreateBitCast(Addr, CGF.Int8Ty->getPointerTo(AS));
Reid Klecknerae945122013-12-05 22:44:07 +00003090
3091 // Apply the offset, which we assume is non-null.
John McCall7f416cc2015-09-08 08:05:57 +00003092 Addr = Builder.CreateInBoundsGEP(Addr, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00003093
3094 // Cast the address to the appropriate pointer type, adopting the address
3095 // space of the base pointer.
3096 return Builder.CreateBitCast(Addr, PType);
3097}
3098
Reid Kleckner452abac2013-05-09 21:01:17 +00003099llvm::Value *
3100MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
3101 const CastExpr *E,
3102 llvm::Value *Src) {
3103 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
3104 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
3105 E->getCastKind() == CK_ReinterpretMemberPointer);
3106
3107 // Use constant emission if we can.
3108 if (isa<llvm::Constant>(Src))
3109 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
3110
3111 // We may be adding or dropping fields from the member pointer, so we need
3112 // both types and the inheritance models of both records.
3113 const MemberPointerType *SrcTy =
3114 E->getSubExpr()->getType()->castAs<MemberPointerType>();
3115 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003116 bool IsFunc = SrcTy->isMemberFunctionPointer();
3117
3118 // If the classes use the same null representation, reinterpret_cast is a nop.
3119 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003120 if (IsReinterpret && IsFunc)
3121 return Src;
3122
3123 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3124 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3125 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00003126 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00003127 return Src;
3128
3129 CGBuilderTy &Builder = CGF.Builder;
3130
3131 // Branch past the conversion if Src is null.
3132 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
3133 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
3134
3135 // C++ 5.2.10p9: The null member pointer value is converted to the null member
3136 // pointer value of the destination type.
3137 if (IsReinterpret) {
3138 // For reinterpret casts, sema ensures that src and dst are both functions
3139 // or data and have the same size, which means the LLVM types should match.
3140 assert(Src->getType() == DstNull->getType());
3141 return Builder.CreateSelect(IsNotNull, Src, DstNull);
3142 }
3143
3144 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
3145 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
3146 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
3147 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
3148 CGF.EmitBlock(ConvertBB);
3149
David Majnemer0d9ad682015-06-29 00:06:50 +00003150 llvm::Value *Dst = EmitNonNullMemberPointerConversion(
3151 SrcTy, DstTy, E->getCastKind(), E->path_begin(), E->path_end(), Src,
3152 Builder);
3153
3154 Builder.CreateBr(ContinueBB);
3155
3156 // In the continuation, choose between DstNull and Dst.
3157 CGF.EmitBlock(ContinueBB);
3158 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
3159 Phi->addIncoming(DstNull, OriginalBB);
3160 Phi->addIncoming(Dst, ConvertBB);
3161 return Phi;
3162}
3163
3164llvm::Value *MicrosoftCXXABI::EmitNonNullMemberPointerConversion(
3165 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3166 CastExpr::path_const_iterator PathBegin,
3167 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
3168 CGBuilderTy &Builder) {
3169 const CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3170 const CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3171 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
3172 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
3173 bool IsFunc = SrcTy->isMemberFunctionPointer();
3174 bool IsConstant = isa<llvm::Constant>(Src);
3175
Reid Kleckner452abac2013-05-09 21:01:17 +00003176 // Decompose src.
3177 llvm::Value *FirstField = Src;
David Majnemerc1709d32015-06-23 07:31:11 +00003178 llvm::Value *NonVirtualBaseAdjustment = getZeroInt();
3179 llvm::Value *VirtualBaseAdjustmentOffset = getZeroInt();
3180 llvm::Value *VBPtrOffset = getZeroInt();
Reid Kleckner96f8f932014-02-05 17:27:08 +00003181 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003182 // We need to extract values.
3183 unsigned I = 0;
3184 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003185 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003186 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003187 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003188 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003189 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003190 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
3191 }
3192
David Majnemer0d9ad682015-06-29 00:06:50 +00003193 bool IsDerivedToBase = (CK == CK_DerivedToBaseMemberPointer);
David Majnemerc1709d32015-06-23 07:31:11 +00003194 const MemberPointerType *DerivedTy = IsDerivedToBase ? SrcTy : DstTy;
3195 const CXXRecordDecl *DerivedClass = DerivedTy->getMostRecentCXXRecordDecl();
3196
Reid Kleckner452abac2013-05-09 21:01:17 +00003197 // For data pointers, we adjust the field offset directly. For functions, we
3198 // have a separate field.
David Majnemerc1709d32015-06-23 07:31:11 +00003199 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
3200
3201 // The virtual inheritance model has a quirk: the virtual base table is always
3202 // referenced when dereferencing a member pointer even if the member pointer
3203 // is non-virtual. This is accounted for by adjusting the non-virtual offset
3204 // to point backwards to the top of the MDC from the first VBase. Undo this
3205 // adjustment to normalize the member pointer.
3206 llvm::Value *SrcVBIndexEqZero =
3207 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3208 if (SrcInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3209 if (int64_t SrcOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003210 getContext().getOffsetOfBaseWithVBPtr(SrcRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003211 llvm::Value *UndoSrcAdjustment = Builder.CreateSelect(
3212 SrcVBIndexEqZero,
3213 llvm::ConstantInt::get(CGM.IntTy, SrcOffsetToFirstVBase),
3214 getZeroInt());
3215 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, UndoSrcAdjustment);
3216 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003217 }
3218
David Majnemerc1709d32015-06-23 07:31:11 +00003219 // A non-zero vbindex implies that we are dealing with a source member in a
3220 // floating virtual base in addition to some non-virtual offset. If the
3221 // vbindex is zero, we are dealing with a source that exists in a non-virtual,
3222 // fixed, base. The difference between these two cases is that the vbindex +
3223 // nvoffset *always* point to the member regardless of what context they are
3224 // evaluated in so long as the vbindex is adjusted. A member inside a fixed
3225 // base requires explicit nv adjustment.
3226 llvm::Constant *BaseClassOffset = llvm::ConstantInt::get(
David Majnemer0d9ad682015-06-29 00:06:50 +00003227 CGM.IntTy,
3228 CGM.computeNonVirtualBaseClassOffset(DerivedClass, PathBegin, PathEnd)
3229 .getQuantity());
David Majnemerc1709d32015-06-23 07:31:11 +00003230
3231 llvm::Value *NVDisp;
3232 if (IsDerivedToBase)
3233 NVDisp = Builder.CreateNSWSub(NVAdjustField, BaseClassOffset, "adj");
3234 else
3235 NVDisp = Builder.CreateNSWAdd(NVAdjustField, BaseClassOffset, "adj");
3236
3237 NVAdjustField = Builder.CreateSelect(SrcVBIndexEqZero, NVDisp, getZeroInt());
3238
3239 // Update the vbindex to an appropriate value in the destination because
3240 // SrcRD's vbtable might not be a strict prefix of the one in DstRD.
3241 llvm::Value *DstVBIndexEqZero = SrcVBIndexEqZero;
3242 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance) &&
3243 MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance)) {
3244 if (llvm::GlobalVariable *VDispMap =
3245 getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) {
3246 llvm::Value *VBIndex = Builder.CreateExactUDiv(
3247 VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003248 if (IsConstant) {
3249 llvm::Constant *Mapping = VDispMap->getInitializer();
3250 VirtualBaseAdjustmentOffset =
3251 Mapping->getAggregateElement(cast<llvm::Constant>(VBIndex));
3252 } else {
3253 llvm::Value *Idxs[] = {getZeroInt(), VBIndex};
3254 VirtualBaseAdjustmentOffset =
John McCall7f416cc2015-09-08 08:05:57 +00003255 Builder.CreateAlignedLoad(Builder.CreateInBoundsGEP(VDispMap, Idxs),
3256 CharUnits::fromQuantity(4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003257 }
David Majnemerc1709d32015-06-23 07:31:11 +00003258
3259 DstVBIndexEqZero =
3260 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3261 }
3262 }
3263
3264 // Set the VBPtrOffset to zero if the vbindex is zero. Otherwise, initialize
3265 // it to the offset of the vbptr.
3266 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance)) {
3267 llvm::Value *DstVBPtrOffset = llvm::ConstantInt::get(
3268 CGM.IntTy,
3269 getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity());
3270 VBPtrOffset =
3271 Builder.CreateSelect(DstVBIndexEqZero, getZeroInt(), DstVBPtrOffset);
3272 }
3273
3274 // Likewise, apply a similar adjustment so that dereferencing the member
3275 // pointer correctly accounts for the distance between the start of the first
3276 // virtual base and the top of the MDC.
3277 if (DstInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3278 if (int64_t DstOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003279 getContext().getOffsetOfBaseWithVBPtr(DstRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003280 llvm::Value *DoDstAdjustment = Builder.CreateSelect(
3281 DstVBIndexEqZero,
3282 llvm::ConstantInt::get(CGM.IntTy, DstOffsetToFirstVBase),
3283 getZeroInt());
3284 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, DoDstAdjustment);
3285 }
3286 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003287
3288 // Recompose dst from the null struct and the adjusted fields from src.
3289 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00003290 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003291 Dst = FirstField;
3292 } else {
David Majnemer0d9ad682015-06-29 00:06:50 +00003293 Dst = llvm::UndefValue::get(ConvertMemberPointerType(DstTy));
Reid Kleckner452abac2013-05-09 21:01:17 +00003294 unsigned Idx = 0;
3295 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003296 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003297 Dst = Builder.CreateInsertValue(Dst, NonVirtualBaseAdjustment, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003298 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003299 Dst = Builder.CreateInsertValue(Dst, VBPtrOffset, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003300 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003301 Dst = Builder.CreateInsertValue(Dst, VirtualBaseAdjustmentOffset, Idx++);
Reid Kleckner452abac2013-05-09 21:01:17 +00003302 }
David Majnemer0d9ad682015-06-29 00:06:50 +00003303 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003304}
3305
3306llvm::Constant *
3307MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
3308 llvm::Constant *Src) {
3309 const MemberPointerType *SrcTy =
David Majnemer5ca193c2015-06-23 07:31:07 +00003310 E->getSubExpr()->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003311 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3312
David Majnemer5ca193c2015-06-23 07:31:07 +00003313 CastKind CK = E->getCastKind();
3314
3315 return EmitMemberPointerConversion(SrcTy, DstTy, CK, E->path_begin(),
3316 E->path_end(), Src);
3317}
3318
3319llvm::Constant *MicrosoftCXXABI::EmitMemberPointerConversion(
3320 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3321 CastExpr::path_const_iterator PathBegin,
3322 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src) {
3323 assert(CK == CK_DerivedToBaseMemberPointer ||
3324 CK == CK_BaseToDerivedMemberPointer ||
3325 CK == CK_ReinterpretMemberPointer);
Reid Kleckner452abac2013-05-09 21:01:17 +00003326 // If src is null, emit a new null for dst. We can't return src because dst
3327 // might have a new representation.
3328 if (MemberPointerConstantIsNull(SrcTy, Src))
3329 return EmitNullMemberPointer(DstTy);
3330
3331 // We don't need to do anything for reinterpret_casts of non-null member
3332 // pointers. We should only get here when the two type representations have
3333 // the same size.
David Majnemer5ca193c2015-06-23 07:31:07 +00003334 if (CK == CK_ReinterpretMemberPointer)
Reid Kleckner452abac2013-05-09 21:01:17 +00003335 return Src;
3336
John McCall7f416cc2015-09-08 08:05:57 +00003337 CGBuilderTy Builder(CGM, CGM.getLLVMContext());
David Majnemer0d9ad682015-06-29 00:06:50 +00003338 auto *Dst = cast<llvm::Constant>(EmitNonNullMemberPointerConversion(
3339 SrcTy, DstTy, CK, PathBegin, PathEnd, Src, Builder));
Reid Kleckner452abac2013-05-09 21:01:17 +00003340
David Majnemer0d9ad682015-06-29 00:06:50 +00003341 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003342}
3343
John McCallb92ab1a2016-10-26 23:46:34 +00003344CGCallee MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
John McCall7f416cc2015-09-08 08:05:57 +00003345 CodeGenFunction &CGF, const Expr *E, Address This,
3346 llvm::Value *&ThisPtrForCall, llvm::Value *MemPtr,
3347 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003348 assert(MPT->isMemberFunctionPointer());
3349 const FunctionProtoType *FPT =
3350 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00003351 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003352 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(
3353 CGM.getTypes().arrangeCXXMethodType(RD, FPT, /*FD=*/nullptr));
Reid Kleckner2341ae32013-04-11 18:13:19 +00003354 CGBuilderTy &Builder = CGF.Builder;
3355
David Majnemer1cdd96d2014-01-17 09:01:00 +00003356 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003357
3358 // Extract the fields we need, regardless of model. We'll apply them if we
3359 // have them.
3360 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003361 llvm::Value *NonVirtualBaseAdjustment = nullptr;
3362 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3363 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003364 if (MemPtr->getType()->isStructTy()) {
3365 // We need to extract values.
3366 unsigned I = 0;
3367 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003368 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003369 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003370 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00003371 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003372 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003373 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3374 }
3375
3376 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003377 ThisPtrForCall = AdjustVirtualBase(CGF, E, RD, This,
3378 VirtualBaseAdjustmentOffset, VBPtrOffset);
3379 } else {
3380 ThisPtrForCall = This.getPointer();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003381 }
3382
3383 if (NonVirtualBaseAdjustment) {
3384 // Apply the adjustment and cast back to the original struct type.
John McCall7f416cc2015-09-08 08:05:57 +00003385 llvm::Value *Ptr = Builder.CreateBitCast(ThisPtrForCall, CGF.Int8PtrTy);
Reid Kleckner2341ae32013-04-11 18:13:19 +00003386 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
John McCall7f416cc2015-09-08 08:05:57 +00003387 ThisPtrForCall = Builder.CreateBitCast(Ptr, ThisPtrForCall->getType(),
3388 "this.adjusted");
Reid Kleckner2341ae32013-04-11 18:13:19 +00003389 }
3390
John McCallb92ab1a2016-10-26 23:46:34 +00003391 FunctionPointer =
3392 Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
3393 CGCallee Callee(FPT, FunctionPointer);
3394 return Callee;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003395}
3396
Charles Davis53c59df2010-08-16 03:33:14 +00003397CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00003398 return new MicrosoftCXXABI(CGM);
3399}
David Majnemere2cb8d12014-07-07 06:20:47 +00003400
3401// MS RTTI Overview:
3402// The run time type information emitted by cl.exe contains 5 distinct types of
3403// structures. Many of them reference each other.
3404//
3405// TypeInfo: Static classes that are returned by typeid.
3406//
3407// CompleteObjectLocator: Referenced by vftables. They contain information
3408// required for dynamic casting, including OffsetFromTop. They also contain
3409// a reference to the TypeInfo for the type and a reference to the
3410// CompleteHierarchyDescriptor for the type.
3411//
3412// ClassHieararchyDescriptor: Contains information about a class hierarchy.
3413// Used during dynamic_cast to walk a class hierarchy. References a base
3414// class array and the size of said array.
3415//
3416// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
3417// somewhat of a misnomer because the most derived class is also in the list
3418// as well as multiple copies of virtual bases (if they occur multiple times
3419// in the hiearchy.) The BaseClassArray contains one BaseClassDescriptor for
3420// every path in the hierarchy, in pre-order depth first order. Note, we do
3421// not declare a specific llvm type for BaseClassArray, it's merely an array
3422// of BaseClassDescriptor pointers.
3423//
3424// BaseClassDescriptor: Contains information about a class in a class hierarchy.
3425// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
3426// BaseClassArray is. It contains information about a class within a
3427// hierarchy such as: is this base is ambiguous and what is its offset in the
3428// vbtable. The names of the BaseClassDescriptors have all of their fields
3429// mangled into them so they can be aggressively deduplicated by the linker.
3430
David Majnemere2cb8d12014-07-07 06:20:47 +00003431static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
Reid Klecknerfb931542018-03-16 20:36:49 +00003432 StringRef MangledName("??_7type_info@@6B@");
David Majnemere2cb8d12014-07-07 06:20:47 +00003433 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
3434 return VTable;
3435 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
3436 /*Constant=*/true,
3437 llvm::GlobalVariable::ExternalLinkage,
3438 /*Initializer=*/nullptr, MangledName);
3439}
3440
3441namespace {
3442
3443/// \brief A Helper struct that stores information about a class in a class
3444/// hierarchy. The information stored in these structs struct is used during
3445/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
3446// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
3447// implicit depth first pre-order tree connectivity. getFirstChild and
3448// getNextSibling allow us to walk the tree efficiently.
3449struct MSRTTIClass {
3450 enum {
3451 IsPrivateOnPath = 1 | 8,
3452 IsAmbiguous = 2,
3453 IsPrivate = 4,
3454 IsVirtual = 16,
3455 HasHierarchyDescriptor = 64
3456 };
3457 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
3458 uint32_t initialize(const MSRTTIClass *Parent,
3459 const CXXBaseSpecifier *Specifier);
3460
3461 MSRTTIClass *getFirstChild() { return this + 1; }
3462 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
3463 return Child + 1 + Child->NumBases;
3464 }
3465
3466 const CXXRecordDecl *RD, *VirtualRoot;
3467 uint32_t Flags, NumBases, OffsetInVBase;
3468};
3469
3470/// \brief Recursively initialize the base class array.
3471uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
3472 const CXXBaseSpecifier *Specifier) {
3473 Flags = HasHierarchyDescriptor;
3474 if (!Parent) {
3475 VirtualRoot = nullptr;
3476 OffsetInVBase = 0;
3477 } else {
3478 if (Specifier->getAccessSpecifier() != AS_public)
3479 Flags |= IsPrivate | IsPrivateOnPath;
3480 if (Specifier->isVirtual()) {
3481 Flags |= IsVirtual;
3482 VirtualRoot = RD;
3483 OffsetInVBase = 0;
3484 } else {
3485 if (Parent->Flags & IsPrivateOnPath)
3486 Flags |= IsPrivateOnPath;
3487 VirtualRoot = Parent->VirtualRoot;
3488 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
3489 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
3490 }
3491 }
3492 NumBases = 0;
3493 MSRTTIClass *Child = getFirstChild();
3494 for (const CXXBaseSpecifier &Base : RD->bases()) {
3495 NumBases += Child->initialize(this, &Base) + 1;
3496 Child = getNextChild(Child);
3497 }
3498 return NumBases;
3499}
3500
3501static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
3502 switch (Ty->getLinkage()) {
3503 case NoLinkage:
3504 case InternalLinkage:
3505 case UniqueExternalLinkage:
3506 return llvm::GlobalValue::InternalLinkage;
3507
3508 case VisibleNoLinkage:
Richard Smith1283e982017-07-07 20:04:28 +00003509 case ModuleInternalLinkage:
3510 case ModuleLinkage:
David Majnemere2cb8d12014-07-07 06:20:47 +00003511 case ExternalLinkage:
3512 return llvm::GlobalValue::LinkOnceODRLinkage;
3513 }
3514 llvm_unreachable("Invalid linkage!");
3515}
3516
3517/// \brief An ephemeral helper class for building MS RTTI types. It caches some
3518/// calls to the module and information about the most derived class in a
3519/// hierarchy.
3520struct MSRTTIBuilder {
3521 enum {
3522 HasBranchingHierarchy = 1,
3523 HasVirtualBranchingHierarchy = 2,
3524 HasAmbiguousBases = 4
3525 };
3526
David Majnemer611cdb92014-07-07 08:09:15 +00003527 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
3528 : CGM(ABI.CGM), Context(CGM.getContext()),
3529 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00003530 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003531 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00003532
3533 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
3534 llvm::GlobalVariable *
3535 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
3536 llvm::GlobalVariable *getClassHierarchyDescriptor();
Justin Lebar562914e2016-10-10 16:26:29 +00003537 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo &Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003538
3539 CodeGenModule &CGM;
3540 ASTContext &Context;
3541 llvm::LLVMContext &VMContext;
3542 llvm::Module &Module;
3543 const CXXRecordDecl *RD;
3544 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00003545 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00003546};
3547
3548} // namespace
3549
3550/// \brief Recursively serializes a class hierarchy in pre-order depth first
3551/// order.
3552static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
3553 const CXXRecordDecl *RD) {
3554 Classes.push_back(MSRTTIClass(RD));
3555 for (const CXXBaseSpecifier &Base : RD->bases())
3556 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
3557}
3558
3559/// \brief Find ambiguity among base classes.
3560static void
3561detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
3562 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
3563 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
3564 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
3565 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
3566 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
David Blaikie82e95a32014-11-19 07:49:47 +00003567 !VirtualBases.insert(Class->RD).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003568 Class = MSRTTIClass::getNextChild(Class);
3569 continue;
3570 }
David Blaikie82e95a32014-11-19 07:49:47 +00003571 if (!UniqueBases.insert(Class->RD).second)
David Majnemere2cb8d12014-07-07 06:20:47 +00003572 AmbiguousBases.insert(Class->RD);
3573 Class++;
3574 }
3575 if (AmbiguousBases.empty())
3576 return;
3577 for (MSRTTIClass &Class : Classes)
3578 if (AmbiguousBases.count(Class.RD))
3579 Class.Flags |= MSRTTIClass::IsAmbiguous;
3580}
3581
3582llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
3583 SmallString<256> MangledName;
3584 {
3585 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003586 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003587 }
3588
3589 // Check to see if we've already declared this ClassHierarchyDescriptor.
3590 if (auto CHD = Module.getNamedGlobal(MangledName))
3591 return CHD;
3592
3593 // Serialize the class hierarchy and initialize the CHD Fields.
3594 SmallVector<MSRTTIClass, 8> Classes;
3595 serializeClassHierarchy(Classes, RD);
3596 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3597 detectAmbiguousBases(Classes);
3598 int Flags = 0;
3599 for (auto Class : Classes) {
3600 if (Class.RD->getNumBases() > 1)
3601 Flags |= HasBranchingHierarchy;
3602 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
3603 // believe the field isn't actually used.
3604 if (Class.Flags & MSRTTIClass::IsAmbiguous)
3605 Flags |= HasAmbiguousBases;
3606 }
3607 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
3608 Flags |= HasVirtualBranchingHierarchy;
3609 // These gep indices are used to get the address of the first element of the
3610 // base class array.
3611 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
3612 llvm::ConstantInt::get(CGM.IntTy, 0)};
3613
3614 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00003615 auto Type = ABI.getClassHierarchyDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003616 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3617 /*Initializer=*/nullptr,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003618 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003619 if (CHD->isWeakForLinker())
3620 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003621
David Blaikiee3b172a2015-04-02 18:55:21 +00003622 auto *Bases = getBaseClassArray(Classes);
3623
David Majnemere2cb8d12014-07-07 06:20:47 +00003624 // Initialize the base class ClassHierarchyDescriptor.
3625 llvm::Constant *Fields[] = {
Saleem Abdulrasoola9e14502017-01-01 19:16:02 +00003626 llvm::ConstantInt::get(CGM.IntTy, 0), // reserved by the runtime
David Majnemer611cdb92014-07-07 08:09:15 +00003627 llvm::ConstantInt::get(CGM.IntTy, Flags),
3628 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
3629 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00003630 Bases->getValueType(), Bases,
David Majnemer611cdb92014-07-07 08:09:15 +00003631 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00003632 };
3633 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3634 return CHD;
3635}
3636
3637llvm::GlobalVariable *
3638MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3639 SmallString<256> MangledName;
3640 {
3641 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003642 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003643 }
3644
3645 // Forward-declare the base class array.
3646 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3647 // mode) bytes of padding. We provide a pointer sized amount of padding by
3648 // adding +1 to Classes.size(). The sections have pointer alignment and are
3649 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00003650 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00003651 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00003652 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
David Majnemer7c237072015-03-05 00:46:22 +00003653 auto *BCA =
3654 new llvm::GlobalVariable(Module, ArrType,
3655 /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003656 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003657 if (BCA->isWeakForLinker())
3658 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003659
3660 // Initialize the BaseClassArray.
3661 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3662 for (MSRTTIClass &Class : Classes)
3663 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00003664 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00003665 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00003666 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00003667 return BCA;
3668}
3669
3670llvm::GlobalVariable *
3671MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3672 // Compute the fields for the BaseClassDescriptor. They are computed up front
3673 // because they are mangled into the name of the object.
3674 uint32_t OffsetInVBTable = 0;
3675 int32_t VBPtrOffset = -1;
3676 if (Class.VirtualRoot) {
3677 auto &VTableContext = CGM.getMicrosoftVTableContext();
3678 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3679 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3680 }
3681
3682 SmallString<256> MangledName;
3683 {
3684 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003685 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3686 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3687 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003688 }
3689
David Majnemer26a90f82014-07-07 15:29:10 +00003690 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00003691 if (auto BCD = Module.getNamedGlobal(MangledName))
3692 return BCD;
3693
3694 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00003695 auto Type = ABI.getBaseClassDescriptorType();
David Majnemer7c237072015-03-05 00:46:22 +00003696 auto BCD =
3697 new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003698 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003699 if (BCD->isWeakForLinker())
3700 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003701
3702 // Initialize the BaseClassDescriptor.
3703 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003704 ABI.getImageRelativeConstant(
David Majnemer443250f2015-03-17 20:35:00 +00003705 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003706 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3707 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3708 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3709 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3710 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3711 ABI.getImageRelativeConstant(
3712 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00003713 };
3714 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3715 return BCD;
3716}
3717
3718llvm::GlobalVariable *
Justin Lebar562914e2016-10-10 16:26:29 +00003719MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo &Info) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003720 SmallString<256> MangledName;
3721 {
3722 llvm::raw_svector_ostream Out(MangledName);
Justin Lebar562914e2016-10-10 16:26:29 +00003723 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info.MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003724 }
3725
3726 // Check to see if we've already computed this complete object locator.
3727 if (auto COL = Module.getNamedGlobal(MangledName))
3728 return COL;
3729
3730 // Compute the fields of the complete object locator.
Justin Lebar562914e2016-10-10 16:26:29 +00003731 int OffsetToTop = Info.FullOffsetInMDC.getQuantity();
David Majnemere2cb8d12014-07-07 06:20:47 +00003732 int VFPtrOffset = 0;
3733 // The offset includes the vtordisp if one exists.
Justin Lebar562914e2016-10-10 16:26:29 +00003734 if (const CXXRecordDecl *VBase = Info.getVBaseWithVPtr())
David Majnemere2cb8d12014-07-07 06:20:47 +00003735 if (Context.getASTRecordLayout(RD)
3736 .getVBaseOffsetsMap()
3737 .find(VBase)
3738 ->second.hasVtorDisp())
Justin Lebar562914e2016-10-10 16:26:29 +00003739 VFPtrOffset = Info.NonVirtualOffset.getQuantity() + 4;
David Majnemere2cb8d12014-07-07 06:20:47 +00003740
3741 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00003742 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003743 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003744 /*Initializer=*/nullptr, MangledName);
David Majnemere2cb8d12014-07-07 06:20:47 +00003745
3746 // Initialize the CompleteObjectLocator.
3747 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003748 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3749 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3750 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3751 ABI.getImageRelativeConstant(
3752 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3753 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3754 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00003755 };
3756 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00003757 if (!ABI.isImageRelative())
3758 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00003759 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
Rafael Espindola654542a2015-01-16 19:23:42 +00003760 if (COL->isWeakForLinker())
3761 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003762 return COL;
3763}
3764
David Majnemerad803d42015-03-15 07:10:01 +00003765static QualType decomposeTypeForEH(ASTContext &Context, QualType T,
David Majnemer526793d2016-07-12 04:42:50 +00003766 bool &IsConst, bool &IsVolatile,
3767 bool &IsUnaligned) {
David Majnemerad803d42015-03-15 07:10:01 +00003768 T = Context.getExceptionObjectType(T);
3769
3770 // C++14 [except.handle]p3:
3771 // A handler is a match for an exception object of type E if [...]
3772 // - the handler is of type cv T or const T& where T is a pointer type and
3773 // E is a pointer type that can be converted to T by [...]
3774 // - a qualification conversion
3775 IsConst = false;
3776 IsVolatile = false;
David Majnemer526793d2016-07-12 04:42:50 +00003777 IsUnaligned = false;
David Majnemerad803d42015-03-15 07:10:01 +00003778 QualType PointeeType = T->getPointeeType();
3779 if (!PointeeType.isNull()) {
3780 IsConst = PointeeType.isConstQualified();
3781 IsVolatile = PointeeType.isVolatileQualified();
David Majnemer526793d2016-07-12 04:42:50 +00003782 IsUnaligned = PointeeType.getQualifiers().hasUnaligned();
David Majnemerad803d42015-03-15 07:10:01 +00003783 }
3784
3785 // Member pointer types like "const int A::*" are represented by having RTTI
3786 // for "int A::*" and separately storing the const qualifier.
3787 if (const auto *MPTy = T->getAs<MemberPointerType>())
3788 T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(),
3789 MPTy->getClass());
3790
3791 // Pointer types like "const int * const *" are represented by having RTTI
3792 // for "const int **" and separately storing the const qualifier.
3793 if (T->isPointerType())
3794 T = Context.getPointerType(PointeeType.getUnqualifiedType());
3795
3796 return T;
3797}
3798
Reid Kleckner10aa7702015-09-16 20:15:55 +00003799CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +00003800MicrosoftCXXABI::getAddrOfCXXCatchHandlerType(QualType Type,
3801 QualType CatchHandlerType) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003802 // TypeDescriptors for exceptions never have qualified pointer types,
Simon Pilgrim2c518802017-03-30 14:13:19 +00003803 // qualifiers are stored separately in order to support qualification
David Majnemer443250f2015-03-17 20:35:00 +00003804 // conversions.
David Majnemer526793d2016-07-12 04:42:50 +00003805 bool IsConst, IsVolatile, IsUnaligned;
3806 Type =
3807 decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile, IsUnaligned);
David Majnemer443250f2015-03-17 20:35:00 +00003808
David Majnemer5f0dd612015-03-17 20:35:05 +00003809 bool IsReference = CatchHandlerType->isReferenceType();
3810
David Majnemer5f0dd612015-03-17 20:35:05 +00003811 uint32_t Flags = 0;
3812 if (IsConst)
3813 Flags |= 1;
3814 if (IsVolatile)
3815 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00003816 if (IsUnaligned)
3817 Flags |= 4;
David Majnemer5f0dd612015-03-17 20:35:05 +00003818 if (IsReference)
3819 Flags |= 8;
3820
Reid Kleckner10aa7702015-09-16 20:15:55 +00003821 return CatchTypeInfo{getAddrOfRTTIDescriptor(Type)->stripPointerCasts(),
3822 Flags};
David Majnemer443250f2015-03-17 20:35:00 +00003823}
3824
David Majnemere2cb8d12014-07-07 06:20:47 +00003825/// \brief Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
3826/// llvm::GlobalVariable * because different type descriptors have different
3827/// types, and need to be abstracted. They are abstracting by casting the
3828/// address to an Int8PtrTy.
David Majnemer443250f2015-03-17 20:35:00 +00003829llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003830 SmallString<256> MangledName;
David Majnemere2cb8d12014-07-07 06:20:47 +00003831 {
3832 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003833 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003834 }
3835
3836 // Check to see if we've already declared this TypeDescriptor.
3837 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3838 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3839
Piotr Padlewskid3b1cbd2017-06-01 08:04:05 +00003840 // Note for the future: If we would ever like to do deferred emission of
3841 // RTTI, check if emitting vtables opportunistically need any adjustment.
3842
David Majnemere2cb8d12014-07-07 06:20:47 +00003843 // Compute the fields for the TypeDescriptor.
David Majnemer5f0dd612015-03-17 20:35:05 +00003844 SmallString<256> TypeInfoString;
David Majnemere2cb8d12014-07-07 06:20:47 +00003845 {
3846 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00003847 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003848 }
3849
3850 // Declare and initialize the TypeDescriptor.
3851 llvm::Constant *Fields[] = {
3852 getTypeInfoVTable(CGM), // VFPtr
3853 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3854 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3855 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00003856 getTypeDescriptorType(TypeInfoString);
Rafael Espindola654542a2015-01-16 19:23:42 +00003857 auto *Var = new llvm::GlobalVariable(
3858 CGM.getModule(), TypeDescriptorType, /*Constant=*/false,
3859 getLinkageForRTTI(Type),
3860 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
Yaron Keren2c07cc72015-12-01 08:14:39 +00003861 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003862 if (Var->isWeakForLinker())
3863 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3864 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003865}
3866
3867/// \brief Gets or a creates a Microsoft CompleteObjectLocator.
3868llvm::GlobalVariable *
3869MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
Justin Lebar562914e2016-10-10 16:26:29 +00003870 const VPtrInfo &Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00003871 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003872}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003873
3874static void emitCXXConstructor(CodeGenModule &CGM,
3875 const CXXConstructorDecl *ctor,
3876 StructorType ctorType) {
Rafael Espindolad48b51b2014-09-15 19:24:44 +00003877 // There are no constructor variants, always emit the complete destructor.
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003878 llvm::Function *Fn = CGM.codegenCXXStructor(ctor, StructorType::Complete);
3879 CGM.maybeSetTrivialComdat(*ctor, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003880}
3881
3882static void emitCXXDestructor(CodeGenModule &CGM, const CXXDestructorDecl *dtor,
3883 StructorType dtorType) {
Reid Klecknerae9b0702018-03-16 19:40:50 +00003884 // Emit the base destructor if the base and complete (vbase) destructors are
3885 // equivalent. This effectively implements -mconstructor-aliases as part of
3886 // the ABI.
3887 if (dtorType == StructorType::Complete &&
3888 dtor->getParent()->getNumVBases() == 0)
3889 dtorType = StructorType::Base;
Rafael Espindola91f68b42014-09-15 19:20:10 +00003890
3891 // The base destructor is equivalent to the base destructor of its
3892 // base class if there is exactly one non-virtual base class with a
3893 // non-trivial destructor, there are no fields with a non-trivial
3894 // destructor, and the body of the destructor is trivial.
3895 if (dtorType == StructorType::Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
3896 return;
3897
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003898 llvm::Function *Fn = CGM.codegenCXXStructor(dtor, dtorType);
Rafael Espindolad3e04692015-01-17 01:47:39 +00003899 if (Fn->isWeakForLinker())
3900 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003901}
3902
3903void MicrosoftCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3904 StructorType Type) {
3905 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
3906 emitCXXConstructor(CGM, CD, Type);
3907 return;
3908 }
3909 emitCXXDestructor(CGM, cast<CXXDestructorDecl>(MD), Type);
3910}
David Majnemer7c237072015-03-05 00:46:22 +00003911
David Majnemerdfa6d202015-03-11 18:36:39 +00003912llvm::Function *
David Majnemer37fd66e2015-03-13 22:36:55 +00003913MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
3914 CXXCtorType CT) {
3915 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
3916
David Majnemerdfa6d202015-03-11 18:36:39 +00003917 // Calculate the mangled name.
3918 SmallString<256> ThunkName;
3919 llvm::raw_svector_ostream Out(ThunkName);
David Majnemer37fd66e2015-03-13 22:36:55 +00003920 getMangleContext().mangleCXXCtor(CD, CT, Out);
David Majnemerdfa6d202015-03-11 18:36:39 +00003921
3922 // If the thunk has been generated previously, just return it.
3923 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
3924 return cast<llvm::Function>(GV);
3925
3926 // Create the llvm::Function.
David Majnemer37fd66e2015-03-13 22:36:55 +00003927 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT);
David Majnemerdfa6d202015-03-11 18:36:39 +00003928 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
3929 const CXXRecordDecl *RD = CD->getParent();
3930 QualType RecordTy = getContext().getRecordType(RD);
3931 llvm::Function *ThunkFn = llvm::Function::Create(
3932 ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule());
Reid Klecknerbba3cb92015-03-17 19:00:50 +00003933 ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>(
3934 FnInfo.getEffectiveCallingConvention()));
David Majnemer63aa2fb2015-06-30 21:23:51 +00003935 if (ThunkFn->isWeakForLinker())
3936 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
David Majnemer37fd66e2015-03-13 22:36:55 +00003937 bool IsCopy = CT == Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003938
3939 // Start codegen.
3940 CodeGenFunction CGF(CGM);
3941 CGF.CurGD = GlobalDecl(CD, Ctor_Complete);
3942
3943 // Build FunctionArgs.
3944 FunctionArgList FunctionArgs;
3945
David Majnemer37fd66e2015-03-13 22:36:55 +00003946 // A constructor always starts with a 'this' pointer as its first argument.
David Majnemerdfa6d202015-03-11 18:36:39 +00003947 buildThisParam(CGF, FunctionArgs);
3948
3949 // Following the 'this' pointer is a reference to the source object that we
3950 // are copying from.
3951 ImplicitParamDecl SrcParam(
Alexey Bataev56223232017-06-09 13:40:18 +00003952 getContext(), /*DC=*/nullptr, SourceLocation(),
3953 &getContext().Idents.get("src"),
David Majnemerdfa6d202015-03-11 18:36:39 +00003954 getContext().getLValueReferenceType(RecordTy,
Alexey Bataev56223232017-06-09 13:40:18 +00003955 /*SpelledAsLValue=*/true),
3956 ImplicitParamDecl::Other);
David Majnemer37fd66e2015-03-13 22:36:55 +00003957 if (IsCopy)
3958 FunctionArgs.push_back(&SrcParam);
David Majnemerdfa6d202015-03-11 18:36:39 +00003959
David Majnemer37fd66e2015-03-13 22:36:55 +00003960 // Constructors for classes which utilize virtual bases have an additional
3961 // parameter which indicates whether or not it is being delegated to by a more
3962 // derived constructor.
Alexey Bataev56223232017-06-09 13:40:18 +00003963 ImplicitParamDecl IsMostDerived(getContext(), /*DC=*/nullptr,
3964 SourceLocation(),
David Majnemerdfa6d202015-03-11 18:36:39 +00003965 &getContext().Idents.get("is_most_derived"),
Alexey Bataev56223232017-06-09 13:40:18 +00003966 getContext().IntTy, ImplicitParamDecl::Other);
David Majnemerdfa6d202015-03-11 18:36:39 +00003967 // Only add the parameter to the list if thie class has virtual bases.
3968 if (RD->getNumVBases() > 0)
3969 FunctionArgs.push_back(&IsMostDerived);
3970
3971 // Start defining the function.
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003972 auto NL = ApplyDebugLocation::CreateEmpty(CGF);
David Majnemerdfa6d202015-03-11 18:36:39 +00003973 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
3974 FunctionArgs, CD->getLocation(), SourceLocation());
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003975 // Create a scope with an artificial location for the body of this function.
3976 auto AL = ApplyDebugLocation::CreateArtificial(CGF);
Reid Kleckner06239e42017-11-16 19:09:36 +00003977 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
David Majnemerdfa6d202015-03-11 18:36:39 +00003978 llvm::Value *This = getThisValue(CGF);
3979
3980 llvm::Value *SrcVal =
David Majnemer37fd66e2015-03-13 22:36:55 +00003981 IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src")
3982 : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003983
3984 CallArgList Args;
3985
3986 // Push the this ptr.
3987 Args.add(RValue::get(This), CD->getThisType(getContext()));
3988
3989 // Push the src ptr.
David Majnemer37fd66e2015-03-13 22:36:55 +00003990 if (SrcVal)
3991 Args.add(RValue::get(SrcVal), SrcParam.getType());
David Majnemerdfa6d202015-03-11 18:36:39 +00003992
3993 // Add the rest of the default arguments.
Reid Klecknerc01ee752016-11-23 16:51:30 +00003994 SmallVector<const Stmt *, 4> ArgVec;
3995 ArrayRef<ParmVarDecl *> params = CD->parameters().drop_front(IsCopy ? 1 : 0);
3996 for (const ParmVarDecl *PD : params) {
3997 assert(PD->hasDefaultArg() && "ctor closure lacks default args");
3998 ArgVec.push_back(PD->getDefaultArg());
Reid Kleckner93f661a2015-03-17 21:51:43 +00003999 }
David Majnemerdfa6d202015-03-11 18:36:39 +00004000
4001 CodeGenFunction::RunCleanupsScope Cleanups(CGF);
4002
4003 const auto *FPT = CD->getType()->castAs<FunctionProtoType>();
David Blaikief05779e2015-07-21 18:37:18 +00004004 CGF.EmitCallArgs(Args, FPT, llvm::makeArrayRef(ArgVec), CD, IsCopy ? 1 : 0);
David Majnemerdfa6d202015-03-11 18:36:39 +00004005
4006 // Insert any ABI-specific implicit constructor arguments.
George Burgess IVf203dbf2017-02-22 20:28:02 +00004007 AddedStructorArgs ExtraArgs =
4008 addImplicitConstructorArgs(CGF, CD, Ctor_Complete,
4009 /*ForVirtualBase=*/false,
4010 /*Delegating=*/false, Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00004011 // Call the destructor with our arguments.
John McCallb92ab1a2016-10-26 23:46:34 +00004012 llvm::Constant *CalleePtr =
4013 CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
4014 CGCallee Callee = CGCallee::forDirect(CalleePtr, CD);
David Majnemerdfa6d202015-03-11 18:36:39 +00004015 const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall(
George Burgess IVd0a9e802017-02-23 22:07:35 +00004016 Args, CD, Ctor_Complete, ExtraArgs.Prefix, ExtraArgs.Suffix);
John McCallb92ab1a2016-10-26 23:46:34 +00004017 CGF.EmitCall(CalleeInfo, Callee, ReturnValueSlot(), Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00004018
4019 Cleanups.ForceCleanup();
4020
4021 // Emit the ret instruction, remove any temporary instructions created for the
4022 // aid of CodeGen.
4023 CGF.FinishFunction(SourceLocation());
4024
4025 return ThunkFn;
4026}
4027
David Majnemer7c237072015-03-05 00:46:22 +00004028llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
4029 uint32_t NVOffset,
4030 int32_t VBPtrOffset,
4031 uint32_t VBIndex) {
4032 assert(!T->isReferenceType());
4033
David Majnemere7a818f2015-03-06 18:53:55 +00004034 CXXRecordDecl *RD = T->getAsCXXRecordDecl();
4035 const CXXConstructorDecl *CD =
4036 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00004037 CXXCtorType CT = Ctor_Complete;
David Majnemer37fd66e2015-03-13 22:36:55 +00004038 if (CD)
4039 if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1)
David Majnemerdfa6d202015-03-11 18:36:39 +00004040 CT = Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00004041
David Majnemer7c237072015-03-05 00:46:22 +00004042 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
4043 SmallString<256> MangledName;
4044 {
4045 llvm::raw_svector_ostream Out(MangledName);
David Majnemerdfa6d202015-03-11 18:36:39 +00004046 getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +00004047 VBPtrOffset, VBIndex, Out);
David Majnemer7c237072015-03-05 00:46:22 +00004048 }
4049 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4050 return getImageRelativeConstant(GV);
4051
David Majnemerdfa6d202015-03-11 18:36:39 +00004052 // The TypeDescriptor is used by the runtime to determine if a catch handler
David Majnemer7c237072015-03-05 00:46:22 +00004053 // is appropriate for the exception object.
David Majnemer443250f2015-03-17 20:35:00 +00004054 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
David Majnemer7c237072015-03-05 00:46:22 +00004055
4056 // The runtime is responsible for calling the copy constructor if the
4057 // exception is caught by value.
David Majnemerdfa6d202015-03-11 18:36:39 +00004058 llvm::Constant *CopyCtor;
4059 if (CD) {
4060 if (CT == Ctor_CopyingClosure)
David Majnemer37fd66e2015-03-13 22:36:55 +00004061 CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure);
David Majnemerdfa6d202015-03-11 18:36:39 +00004062 else
4063 CopyCtor = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
4064
4065 CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy);
4066 } else {
4067 CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4068 }
David Majnemere7a818f2015-03-06 18:53:55 +00004069 CopyCtor = getImageRelativeConstant(CopyCtor);
David Majnemer7c237072015-03-05 00:46:22 +00004070
David Majnemere7a818f2015-03-06 18:53:55 +00004071 bool IsScalar = !RD;
David Majnemer7c237072015-03-05 00:46:22 +00004072 bool HasVirtualBases = false;
4073 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
David Majnemer7c237072015-03-05 00:46:22 +00004074 QualType PointeeType = T;
4075 if (T->isPointerType())
4076 PointeeType = T->getPointeeType();
4077 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
4078 HasVirtualBases = RD->getNumVBases() > 0;
4079 if (IdentifierInfo *II = RD->getIdentifier())
4080 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
4081 }
4082
4083 // Encode the relevant CatchableType properties into the Flags bitfield.
4084 // FIXME: Figure out how bits 2 or 8 can get set.
4085 uint32_t Flags = 0;
4086 if (IsScalar)
4087 Flags |= 1;
4088 if (HasVirtualBases)
4089 Flags |= 4;
4090 if (IsStdBadAlloc)
4091 Flags |= 16;
4092
4093 llvm::Constant *Fields[] = {
4094 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4095 TD, // TypeDescriptor
4096 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment
4097 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
4098 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex
4099 llvm::ConstantInt::get(CGM.IntTy, Size), // Size
4100 CopyCtor // CopyCtor
4101 };
4102 llvm::StructType *CTType = getCatchableTypeType();
4103 auto *GV = new llvm::GlobalVariable(
4104 CGM.getModule(), CTType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004105 llvm::ConstantStruct::get(CTType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004106 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004107 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004108 if (GV->isWeakForLinker())
4109 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004110 return getImageRelativeConstant(GV);
4111}
4112
4113llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
4114 assert(!T->isReferenceType());
4115
4116 // See if we've already generated a CatchableTypeArray for this type before.
4117 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
4118 if (CTA)
4119 return CTA;
4120
4121 // Ensure that we don't have duplicate entries in our CatchableTypeArray by
4122 // using a SmallSetVector. Duplicates may arise due to virtual bases
4123 // occurring more than once in the hierarchy.
4124 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
4125
4126 // C++14 [except.handle]p3:
4127 // A handler is a match for an exception object of type E if [...]
4128 // - the handler is of type cv T or cv T& and T is an unambiguous public
4129 // base class of E, or
4130 // - the handler is of type cv T or const T& where T is a pointer type and
4131 // E is a pointer type that can be converted to T by [...]
4132 // - a standard pointer conversion (4.10) not involving conversions to
4133 // pointers to private or protected or ambiguous classes
4134 const CXXRecordDecl *MostDerivedClass = nullptr;
4135 bool IsPointer = T->isPointerType();
4136 if (IsPointer)
4137 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
4138 else
4139 MostDerivedClass = T->getAsCXXRecordDecl();
4140
4141 // Collect all the unambiguous public bases of the MostDerivedClass.
4142 if (MostDerivedClass) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00004143 const ASTContext &Context = getContext();
David Majnemer7c237072015-03-05 00:46:22 +00004144 const ASTRecordLayout &MostDerivedLayout =
4145 Context.getASTRecordLayout(MostDerivedClass);
4146 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
4147 SmallVector<MSRTTIClass, 8> Classes;
4148 serializeClassHierarchy(Classes, MostDerivedClass);
4149 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
4150 detectAmbiguousBases(Classes);
4151 for (const MSRTTIClass &Class : Classes) {
4152 // Skip any ambiguous or private bases.
4153 if (Class.Flags &
4154 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
4155 continue;
4156 // Write down how to convert from a derived pointer to a base pointer.
4157 uint32_t OffsetInVBTable = 0;
4158 int32_t VBPtrOffset = -1;
4159 if (Class.VirtualRoot) {
4160 OffsetInVBTable =
4161 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
4162 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
4163 }
4164
4165 // Turn our record back into a pointer if the exception object is a
4166 // pointer.
4167 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
4168 if (IsPointer)
4169 RTTITy = Context.getPointerType(RTTITy);
4170 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
4171 VBPtrOffset, OffsetInVBTable));
4172 }
4173 }
4174
4175 // C++14 [except.handle]p3:
4176 // A handler is a match for an exception object of type E if
4177 // - The handler is of type cv T or cv T& and E and T are the same type
4178 // (ignoring the top-level cv-qualifiers)
4179 CatchableTypes.insert(getCatchableType(T));
4180
4181 // C++14 [except.handle]p3:
4182 // A handler is a match for an exception object of type E if
4183 // - the handler is of type cv T or const T& where T is a pointer type and
4184 // E is a pointer type that can be converted to T by [...]
4185 // - a standard pointer conversion (4.10) not involving conversions to
4186 // pointers to private or protected or ambiguous classes
4187 //
David Majnemerf205f532015-04-04 05:37:48 +00004188 // C++14 [conv.ptr]p2:
4189 // A prvalue of type "pointer to cv T," where T is an object type, can be
4190 // converted to a prvalue of type "pointer to cv void".
4191 if (IsPointer && T->getPointeeType()->isObjectType())
David Majnemer7c237072015-03-05 00:46:22 +00004192 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4193
David Majnemera1aea9a2015-03-12 17:44:49 +00004194 // C++14 [except.handle]p3:
4195 // A handler is a match for an exception object of type E if [...]
4196 // - the handler is of type cv T or const T& where T is a pointer or
4197 // pointer to member type and E is std::nullptr_t.
4198 //
4199 // We cannot possibly list all possible pointer types here, making this
4200 // implementation incompatible with the standard. However, MSVC includes an
4201 // entry for pointer-to-void in this case. Let's do the same.
4202 if (T->isNullPtrType())
4203 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4204
David Majnemer7c237072015-03-05 00:46:22 +00004205 uint32_t NumEntries = CatchableTypes.size();
4206 llvm::Type *CTType =
4207 getImageRelativeType(getCatchableTypeType()->getPointerTo());
4208 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
4209 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
4210 llvm::Constant *Fields[] = {
4211 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries
4212 llvm::ConstantArray::get(
4213 AT, llvm::makeArrayRef(CatchableTypes.begin(),
4214 CatchableTypes.end())) // CatchableTypes
4215 };
4216 SmallString<256> MangledName;
4217 {
4218 llvm::raw_svector_ostream Out(MangledName);
4219 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
4220 }
4221 CTA = new llvm::GlobalVariable(
4222 CGM.getModule(), CTAType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004223 llvm::ConstantStruct::get(CTAType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004224 CTA->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004225 CTA->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004226 if (CTA->isWeakForLinker())
4227 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004228 return CTA;
4229}
4230
4231llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
David Majnemer526793d2016-07-12 04:42:50 +00004232 bool IsConst, IsVolatile, IsUnaligned;
4233 T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile, IsUnaligned);
David Majnemer7c237072015-03-05 00:46:22 +00004234
4235 // The CatchableTypeArray enumerates the various (CV-unqualified) types that
4236 // the exception object may be caught as.
4237 llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
4238 // The first field in a CatchableTypeArray is the number of CatchableTypes.
4239 // This is used as a component of the mangled name which means that we need to
4240 // know what it is in order to see if we have previously generated the
4241 // ThrowInfo.
4242 uint32_t NumEntries =
4243 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
4244 ->getLimitedValue();
4245
4246 SmallString<256> MangledName;
4247 {
4248 llvm::raw_svector_ostream Out(MangledName);
David Majnemer526793d2016-07-12 04:42:50 +00004249 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, IsUnaligned,
4250 NumEntries, Out);
David Majnemer7c237072015-03-05 00:46:22 +00004251 }
4252
4253 // Reuse a previously generated ThrowInfo if we have generated an appropriate
4254 // one before.
4255 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4256 return GV;
4257
4258 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
4259 // be at least as CV qualified. Encode this requirement into the Flags
4260 // bitfield.
4261 uint32_t Flags = 0;
4262 if (IsConst)
4263 Flags |= 1;
4264 if (IsVolatile)
4265 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00004266 if (IsUnaligned)
4267 Flags |= 4;
David Majnemer7c237072015-03-05 00:46:22 +00004268
4269 // The cleanup-function (a destructor) must be called when the exception
4270 // object's lifetime ends.
4271 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4272 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
4273 if (CXXDestructorDecl *DtorD = RD->getDestructor())
4274 if (!DtorD->isTrivial())
4275 CleanupFn = llvm::ConstantExpr::getBitCast(
4276 CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete),
4277 CGM.Int8PtrTy);
4278 // This is unused as far as we can tell, initialize it to null.
4279 llvm::Constant *ForwardCompat =
4280 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
4281 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
4282 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
4283 llvm::StructType *TIType = getThrowInfoType();
4284 llvm::Constant *Fields[] = {
4285 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4286 getImageRelativeConstant(CleanupFn), // CleanupFn
4287 ForwardCompat, // ForwardCompat
4288 PointerToCatchableTypes // CatchableTypeArray
4289 };
4290 auto *GV = new llvm::GlobalVariable(
4291 CGM.getModule(), TIType, /*Constant=*/true, getLinkageForRTTI(T),
4292 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004293 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004294 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004295 if (GV->isWeakForLinker())
4296 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004297 return GV;
4298}
4299
4300void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
4301 const Expr *SubExpr = E->getSubExpr();
4302 QualType ThrowType = SubExpr->getType();
4303 // The exception object lives on the stack and it's address is passed to the
4304 // runtime function.
John McCall7f416cc2015-09-08 08:05:57 +00004305 Address AI = CGF.CreateMemTemp(ThrowType);
David Majnemer7c237072015-03-05 00:46:22 +00004306 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
4307 /*IsInit=*/true);
4308
4309 // The so-called ThrowInfo is used to describe how the exception object may be
4310 // caught.
4311 llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
4312
4313 // Call into the runtime to throw the exception.
John McCall7f416cc2015-09-08 08:05:57 +00004314 llvm::Value *Args[] = {
4315 CGF.Builder.CreateBitCast(AI.getPointer(), CGM.Int8PtrTy),
4316 TI
4317 };
David Majnemer7c237072015-03-05 00:46:22 +00004318 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
4319}
Peter Collingbourne60108802017-12-13 21:53:04 +00004320
4321std::pair<llvm::Value *, const CXXRecordDecl *>
4322MicrosoftCXXABI::LoadVTablePtr(CodeGenFunction &CGF, Address This,
4323 const CXXRecordDecl *RD) {
4324 std::tie(This, std::ignore, RD) =
4325 performBaseAdjustment(CGF, This, QualType(RD->getTypeForDecl(), 0));
4326 return {CGF.GetVTablePtr(This, CGM.Int8PtrTy, RD), RD};
4327}