blob: a8260b49ed9916e6a61f639e22b97a490e4d3b1c [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 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD)) {
Reid Klecknercbec0262018-04-02 20:00:39 +0000232 MethodVFTableLocation ML =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000233 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000234 // The vbases might be ordered differently in the final overrider object
235 // and the complete object, so the "this" argument may sometimes point to
236 // memory that has no particular type (e.g. past the complete object).
237 // In this case, we just use a generic pointer type.
238 // FIXME: might want to have a more precise type in the non-virtual
239 // multiple inheritance case.
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +0000240 if (ML.VBase || !ML.VFPtrOffset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000241 return nullptr;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000242 }
243 return MD->getParent();
244 }
245
John McCall7f416cc2015-09-08 08:05:57 +0000246 Address
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000247 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD,
John McCall7f416cc2015-09-08 08:05:57 +0000248 Address This,
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000249 bool VirtualCall) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000250
Reid Kleckner89077a12013-12-17 19:46:40 +0000251 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000252 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000253
Craig Topper4f12f102014-03-12 06:41:41 +0000254 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall29036752011-01-27 02:46:02 +0000255
George Burgess IVf203dbf2017-02-22 20:28:02 +0000256 AddedStructorArgs
257 addImplicitConstructorArgs(CodeGenFunction &CGF, const CXXConstructorDecl *D,
258 CXXCtorType Type, bool ForVirtualBase,
259 bool Delegating, CallArgList &Args) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000260
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000261 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
262 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +0000263 bool Delegating, Address This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000264
Justin Lebar562914e2016-10-10 16:26:29 +0000265 void emitVTableTypeMetadata(const VPtrInfo &Info, const CXXRecordDecl *RD,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +0000266 llvm::GlobalVariable *VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +0000267
Craig Topper4f12f102014-03-12 06:41:41 +0000268 void emitVTableDefinitions(CodeGenVTables &CGVT,
269 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000270
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000271 bool isVirtualOffsetNeededForVTableField(CodeGenFunction &CGF,
272 CodeGenFunction::VPtr Vptr) override;
273
274 /// Don't initialize vptrs if dynamic class
275 /// is marked with with the 'novtable' attribute.
276 bool doStructorsInitializeVPtrs(const CXXRecordDecl *VTableClass) override {
277 return !VTableClass->hasAttr<MSNoVTableAttr>();
278 }
279
280 llvm::Constant *
281 getVTableAddressPoint(BaseSubobject Base,
282 const CXXRecordDecl *VTableClass) override;
283
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000284 llvm::Value *getVTableAddressPointInStructor(
285 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000286 BaseSubobject Base, const CXXRecordDecl *NearestVBase) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000287
288 llvm::Constant *
289 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000290 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000291
292 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000293 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000294
John McCall9831b842018-02-06 18:52:44 +0000295 CGCallee getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
296 Address This, llvm::Type *Ty,
297 SourceLocation Loc) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000298
David Majnemer0c0b6d92014-10-31 20:09:12 +0000299 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF,
300 const CXXDestructorDecl *Dtor,
301 CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +0000302 Address This,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000303 const CXXMemberCallExpr *CE) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000304
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000305 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000306 CallArgList &CallArgs) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000307 assert(GD.getDtorType() == Dtor_Deleting &&
308 "Only deleting destructor thunks are available in this ABI");
309 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)),
David Majnemer9ced3dd2015-03-14 23:44:48 +0000310 getContext().IntTy);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000311 }
312
Craig Topper4f12f102014-03-12 06:41:41 +0000313 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000314
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000315 llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000316 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000317 llvm::GlobalVariable::LinkageTypes Linkage);
318
David Majnemerc1709d32015-06-23 07:31:11 +0000319 llvm::GlobalVariable *
320 getAddrOfVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
321 const CXXRecordDecl *DstRD) {
322 SmallString<256> OutName;
323 llvm::raw_svector_ostream Out(OutName);
324 getMangleContext().mangleCXXVirtualDisplacementMap(SrcRD, DstRD, Out);
David Majnemerc1709d32015-06-23 07:31:11 +0000325 StringRef MangledName = OutName.str();
326
327 if (auto *VDispMap = CGM.getModule().getNamedGlobal(MangledName))
328 return VDispMap;
329
330 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
331 unsigned NumEntries = 1 + SrcRD->getNumVBases();
332 SmallVector<llvm::Constant *, 4> Map(NumEntries,
333 llvm::UndefValue::get(CGM.IntTy));
334 Map[0] = llvm::ConstantInt::get(CGM.IntTy, 0);
335 bool AnyDifferent = false;
336 for (const auto &I : SrcRD->vbases()) {
337 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
338 if (!DstRD->isVirtuallyDerivedFrom(VBase))
339 continue;
340
341 unsigned SrcVBIndex = VTContext.getVBTableIndex(SrcRD, VBase);
342 unsigned DstVBIndex = VTContext.getVBTableIndex(DstRD, VBase);
343 Map[SrcVBIndex] = llvm::ConstantInt::get(CGM.IntTy, DstVBIndex * 4);
344 AnyDifferent |= SrcVBIndex != DstVBIndex;
345 }
346 // This map would be useless, don't use it.
347 if (!AnyDifferent)
348 return nullptr;
349
350 llvm::ArrayType *VDispMapTy = llvm::ArrayType::get(CGM.IntTy, Map.size());
351 llvm::Constant *Init = llvm::ConstantArray::get(VDispMapTy, Map);
352 llvm::GlobalValue::LinkageTypes Linkage =
353 SrcRD->isExternallyVisible() && DstRD->isExternallyVisible()
354 ? llvm::GlobalValue::LinkOnceODRLinkage
355 : llvm::GlobalValue::InternalLinkage;
356 auto *VDispMap = new llvm::GlobalVariable(
357 CGM.getModule(), VDispMapTy, /*Constant=*/true, Linkage,
358 /*Initializer=*/Init, MangledName);
359 return VDispMap;
360 }
361
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000362 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000363 llvm::GlobalVariable *GV) const;
364
Hans Wennborgc94391d2014-06-06 20:04:01 +0000365 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
366 GlobalDecl GD, bool ReturnAdjustment) override {
Hans Wennborgc94391d2014-06-06 20:04:01 +0000367 GVALinkage Linkage =
368 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
369
370 if (Linkage == GVA_Internal)
371 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
372 else if (ReturnAdjustment)
373 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
374 else
375 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000376 }
377
Rafael Espindolab7350042018-03-01 00:35:47 +0000378 bool exportThunk() override { return false; }
379
John McCall7f416cc2015-09-08 08:05:57 +0000380 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000381 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000382
John McCall7f416cc2015-09-08 08:05:57 +0000383 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000384 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000385
David Majnemerb3341ea2014-10-05 05:05:40 +0000386 void EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +0000387 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +0000388 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +0000389 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000390
391 bool usesThreadWrapperFunction() const override { return false; }
392 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
393 QualType LValType) override;
394
John McCallc84ed6a2012-05-01 06:13:13 +0000395 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
396 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000397 bool PerformInit) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000398 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
399 llvm::Constant *Dtor, llvm::Constant *Addr) override;
John McCallc84ed6a2012-05-01 06:13:13 +0000400
John McCall29036752011-01-27 02:46:02 +0000401 // ==== Notes on array cookies =========
402 //
403 // MSVC seems to only use cookies when the class has a destructor; a
404 // two-argument usual array deallocation function isn't sufficient.
405 //
406 // For example, this code prints "100" and "1":
407 // struct A {
408 // char x;
409 // void *operator new[](size_t sz) {
410 // printf("%u\n", sz);
411 // return malloc(sz);
412 // }
413 // void operator delete[](void *p, size_t sz) {
414 // printf("%u\n", sz);
415 // free(p);
416 // }
417 // };
418 // int main() {
419 // A *p = new A[100];
420 // delete[] p;
421 // }
422 // Whereas it prints "104" and "104" if you give A a destructor.
John McCallb91cd662012-05-01 05:23:51 +0000423
Craig Topper4f12f102014-03-12 06:41:41 +0000424 bool requiresArrayCookie(const CXXDeleteExpr *expr,
425 QualType elementType) override;
426 bool requiresArrayCookie(const CXXNewExpr *expr) override;
427 CharUnits getArrayCookieSizeImpl(QualType type) override;
John McCall7f416cc2015-09-08 08:05:57 +0000428 Address InitializeArrayCookie(CodeGenFunction &CGF,
429 Address NewPtr,
430 llvm::Value *NumElements,
431 const CXXNewExpr *expr,
432 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000433 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000434 Address allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000435 CharUnits cookieSize) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000436
David Majnemer611cdb92014-07-07 08:09:15 +0000437 friend struct MSRTTIBuilder;
438
439 bool isImageRelative() const {
440 return CGM.getTarget().getPointerWidth(/*AddressSpace=*/0) == 64;
441 }
442
443 // 5 routines for constructing the llvm types for MS RTTI structs.
444 llvm::StructType *getTypeDescriptorType(StringRef TypeInfoString) {
445 llvm::SmallString<32> TDTypeName("rtti.TypeDescriptor");
446 TDTypeName += llvm::utostr(TypeInfoString.size());
447 llvm::StructType *&TypeDescriptorType =
448 TypeDescriptorTypeMap[TypeInfoString.size()];
449 if (TypeDescriptorType)
450 return TypeDescriptorType;
451 llvm::Type *FieldTypes[] = {
452 CGM.Int8PtrPtrTy,
453 CGM.Int8PtrTy,
454 llvm::ArrayType::get(CGM.Int8Ty, TypeInfoString.size() + 1)};
455 TypeDescriptorType =
456 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, TDTypeName);
457 return TypeDescriptorType;
458 }
459
460 llvm::Type *getImageRelativeType(llvm::Type *PtrType) {
461 if (!isImageRelative())
462 return PtrType;
463 return CGM.IntTy;
464 }
465
466 llvm::StructType *getBaseClassDescriptorType() {
467 if (BaseClassDescriptorType)
468 return BaseClassDescriptorType;
469 llvm::Type *FieldTypes[] = {
470 getImageRelativeType(CGM.Int8PtrTy),
471 CGM.IntTy,
472 CGM.IntTy,
473 CGM.IntTy,
474 CGM.IntTy,
475 CGM.IntTy,
476 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
477 };
478 BaseClassDescriptorType = llvm::StructType::create(
479 CGM.getLLVMContext(), FieldTypes, "rtti.BaseClassDescriptor");
480 return BaseClassDescriptorType;
481 }
482
483 llvm::StructType *getClassHierarchyDescriptorType() {
484 if (ClassHierarchyDescriptorType)
485 return ClassHierarchyDescriptorType;
486 // Forward-declare RTTIClassHierarchyDescriptor to break a cycle.
487 ClassHierarchyDescriptorType = llvm::StructType::create(
488 CGM.getLLVMContext(), "rtti.ClassHierarchyDescriptor");
489 llvm::Type *FieldTypes[] = {
490 CGM.IntTy,
491 CGM.IntTy,
492 CGM.IntTy,
493 getImageRelativeType(
494 getBaseClassDescriptorType()->getPointerTo()->getPointerTo()),
495 };
496 ClassHierarchyDescriptorType->setBody(FieldTypes);
497 return ClassHierarchyDescriptorType;
498 }
499
500 llvm::StructType *getCompleteObjectLocatorType() {
501 if (CompleteObjectLocatorType)
502 return CompleteObjectLocatorType;
503 CompleteObjectLocatorType = llvm::StructType::create(
504 CGM.getLLVMContext(), "rtti.CompleteObjectLocator");
505 llvm::Type *FieldTypes[] = {
506 CGM.IntTy,
507 CGM.IntTy,
508 CGM.IntTy,
509 getImageRelativeType(CGM.Int8PtrTy),
510 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
511 getImageRelativeType(CompleteObjectLocatorType),
512 };
513 llvm::ArrayRef<llvm::Type *> FieldTypesRef(FieldTypes);
514 if (!isImageRelative())
515 FieldTypesRef = FieldTypesRef.drop_back();
516 CompleteObjectLocatorType->setBody(FieldTypesRef);
517 return CompleteObjectLocatorType;
518 }
519
520 llvm::GlobalVariable *getImageBase() {
521 StringRef Name = "__ImageBase";
522 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name))
523 return GV;
524
Rafael Espindola1c406472018-03-22 23:02:19 +0000525 auto *GV = new llvm::GlobalVariable(CGM.getModule(), CGM.Int8Ty,
526 /*isConstant=*/true,
527 llvm::GlobalValue::ExternalLinkage,
528 /*Initializer=*/nullptr, Name);
529 CGM.setDSOLocal(GV);
530 return GV;
David Majnemer611cdb92014-07-07 08:09:15 +0000531 }
532
533 llvm::Constant *getImageRelativeConstant(llvm::Constant *PtrVal) {
534 if (!isImageRelative())
535 return PtrVal;
536
David Majnemer7c237072015-03-05 00:46:22 +0000537 if (PtrVal->isNullValue())
538 return llvm::Constant::getNullValue(CGM.IntTy);
539
David Majnemer611cdb92014-07-07 08:09:15 +0000540 llvm::Constant *ImageBaseAsInt =
541 llvm::ConstantExpr::getPtrToInt(getImageBase(), CGM.IntPtrTy);
542 llvm::Constant *PtrValAsInt =
543 llvm::ConstantExpr::getPtrToInt(PtrVal, CGM.IntPtrTy);
544 llvm::Constant *Diff =
545 llvm::ConstantExpr::getSub(PtrValAsInt, ImageBaseAsInt,
546 /*HasNUW=*/true, /*HasNSW=*/true);
547 return llvm::ConstantExpr::getTrunc(Diff, CGM.IntTy);
548 }
549
Reid Kleckner407e8b62013-03-22 19:02:54 +0000550private:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000551 MicrosoftMangleContext &getMangleContext() {
552 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext());
553 }
554
Reid Kleckner2341ae32013-04-11 18:13:19 +0000555 llvm::Constant *getZeroInt() {
556 return llvm::ConstantInt::get(CGM.IntTy, 0);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000557 }
558
Reid Kleckner2341ae32013-04-11 18:13:19 +0000559 llvm::Constant *getAllOnesInt() {
560 return llvm::Constant::getAllOnesValue(CGM.IntTy);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000561 }
562
Reid Kleckner0358cbf2016-07-01 02:41:25 +0000563 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) override;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000564
Reid Kleckner2341ae32013-04-11 18:13:19 +0000565 void
566 GetNullMemberPointerFields(const MemberPointerType *MPT,
567 llvm::SmallVectorImpl<llvm::Constant *> &fields);
568
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000569 /// Shared code for virtual base adjustment. Returns the offset from
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000570 /// the vbptr to the virtual base. Optionally returns the address of the
571 /// vbptr itself.
572 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000573 Address Base,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000574 llvm::Value *VBPtrOffset,
575 llvm::Value *VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000576 llvm::Value **VBPtr = nullptr);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000577
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000578 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000579 Address Base,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000580 int32_t VBPtrOffset,
581 int32_t VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000582 llvm::Value **VBPtr = nullptr) {
Reid Kleckner0ba8ba42014-10-22 17:26:00 +0000583 assert(VBTableOffset % 4 == 0 && "should be byte offset into table of i32s");
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000584 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
585 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset);
586 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr);
587 }
588
Peter Collingbourne60108802017-12-13 21:53:04 +0000589 std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000590 performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000591 QualType SrcRecordTy);
592
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000593 /// Performs a full virtual base adjustment. Used to dereference
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000594 /// pointers to members of virtual bases.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000595 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000596 const CXXRecordDecl *RD, Address Base,
Reid Kleckner2341ae32013-04-11 18:13:19 +0000597 llvm::Value *VirtualBaseAdjustmentOffset,
598 llvm::Value *VBPtrOffset /* optional */);
599
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000600 /// Emits a full member pointer with the fields common to data and
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000601 /// function member pointers.
602 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField,
603 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +0000604 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +0000605 CharUnits NonVirtualBaseAdjustment,
606 unsigned VBTableIndex);
Reid Kleckner452abac2013-05-09 21:01:17 +0000607
Reid Kleckner452abac2013-05-09 21:01:17 +0000608 bool MemberPointerConstantIsNull(const MemberPointerType *MPT,
609 llvm::Constant *MP);
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000610
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000611 /// - Initialize all vbptrs of 'this' with RD as the complete type.
Reid Kleckner7810af02013-06-19 15:20:38 +0000612 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
613
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000614 /// Caching wrapper around VBTableBuilder::enumerateVBTables().
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000615 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000616
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000617 /// Generate a thunk for calling a virtual member function MD.
Reid Klecknercbec0262018-04-02 20:00:39 +0000618 llvm::Function *EmitVirtualMemPtrThunk(const CXXMethodDecl *MD,
619 const 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;
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000763 /// All the vftables that have been referenced.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000764 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000765 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000766
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000767 /// This set holds the record decls we've deferred vtable emission for.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000768 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
769
770
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000771 /// 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 Hatanakafcbe17c2018-03-28 21:13:14 +0000830 return !canCopyArgument(RD) ? RAA_Indirect : RAA_Default;
Reid Klecknere39ee212014-05-03 00:33:28 +0000831 }
832
833 llvm_unreachable("invalid enum");
834}
835
David Majnemer08681372014-11-01 07:37:17 +0000836void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
837 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000838 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +0000839 QualType ElementType,
840 const CXXDestructorDecl *Dtor) {
David Majnemer0c0b6d92014-10-31 20:09:12 +0000841 // FIXME: Provide a source location here even though there's no
842 // CXXMemberCallExpr for dtor call.
David Majnemer08681372014-11-01 07:37:17 +0000843 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000844 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
845 llvm::Value *MDThis =
846 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr);
847 if (UseGlobalDelete)
David Majnemer08681372014-11-01 07:37:17 +0000848 CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType);
John McCall82fb8922012-09-25 10:10:39 +0000849}
850
David Majnemer442d0a22014-11-25 07:20:20 +0000851void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
David Majnemer7c237072015-03-05 00:46:22 +0000852 llvm::Value *Args[] = {
853 llvm::ConstantPointerNull::get(CGM.Int8PtrTy),
854 llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())};
855 auto *Fn = getThrowFn();
David Majnemer442d0a22014-11-25 07:20:20 +0000856 if (isNoReturn)
857 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args);
858 else
859 CGF.EmitRuntimeCallOrInvoke(Fn, Args);
860}
861
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000862namespace {
Reid Kleckner129552b2015-10-08 01:13:52 +0000863struct CatchRetScope final : EHScopeStack::Cleanup {
David Majnemere888a2f2015-08-15 03:21:08 +0000864 llvm::CatchPadInst *CPI;
865
Reid Kleckner129552b2015-10-08 01:13:52 +0000866 CatchRetScope(llvm::CatchPadInst *CPI) : CPI(CPI) {}
David Majnemere888a2f2015-08-15 03:21:08 +0000867
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000868 void Emit(CodeGenFunction &CGF, Flags flags) override {
Reid Kleckner129552b2015-10-08 01:13:52 +0000869 llvm::BasicBlock *BB = CGF.createBasicBlock("catchret.dest");
870 CGF.Builder.CreateCatchRet(CPI, BB);
871 CGF.EmitBlock(BB);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000872 }
873};
874}
875
876void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF,
877 const CXXCatchStmt *S) {
878 // In the MS ABI, the runtime handles the copy, and the catch handler is
879 // responsible for destruction.
880 VarDecl *CatchParam = S->getExceptionDecl();
David Majnemer4e52d6f2015-12-12 05:39:21 +0000881 llvm::BasicBlock *CatchPadBB = CGF.Builder.GetInsertBlock();
Reid Kleckner129552b2015-10-08 01:13:52 +0000882 llvm::CatchPadInst *CPI =
883 cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
David Majnemer4e52d6f2015-12-12 05:39:21 +0000884 CGF.CurrentFuncletPad = CPI;
Reid Kleckner129552b2015-10-08 01:13:52 +0000885
Reid Kleckner67cf0352015-04-07 00:09:59 +0000886 // If this is a catch-all or the catch parameter is unnamed, we don't need to
887 // emit an alloca to the object.
888 if (!CatchParam || !CatchParam->getDeclName()) {
Reid Kleckner129552b2015-10-08 01:13:52 +0000889 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000890 return;
891 }
892
893 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
Reid Kleckner129552b2015-10-08 01:13:52 +0000894 CPI->setArgOperand(2, var.getObjectAddress(CGF).getPointer());
895 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000896 CGF.EmitAutoVarCleanups(var);
897}
898
John McCall7f416cc2015-09-08 08:05:57 +0000899/// We need to perform a generic polymorphic operation (like a typeid
900/// or a cast), which requires an object with a vfptr. Adjust the
901/// address to point to an object with a vfptr.
Peter Collingbourne60108802017-12-13 21:53:04 +0000902std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000903MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000904 QualType SrcRecordTy) {
David Majnemer1162d252014-06-22 19:05:33 +0000905 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
906 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
David Majnemer9ced3dd2015-03-14 23:44:48 +0000907 const ASTContext &Context = getContext();
David Majnemer1162d252014-06-22 19:05:33 +0000908
John McCall7f416cc2015-09-08 08:05:57 +0000909 // If the class itself has a vfptr, great. This check implicitly
910 // covers non-virtual base subobjects: a class with its own virtual
911 // functions would be a candidate to be a primary base.
David Majnemer5bc883f2015-02-27 02:38:02 +0000912 if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
Peter Collingbourne60108802017-12-13 21:53:04 +0000913 return std::make_tuple(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0),
914 SrcDecl);
David Majnemer1162d252014-06-22 19:05:33 +0000915
John McCall7f416cc2015-09-08 08:05:57 +0000916 // Okay, one of the vbases must have a vfptr, or else this isn't
917 // actually a polymorphic class.
918 const CXXRecordDecl *PolymorphicBase = nullptr;
919 for (auto &Base : SrcDecl->vbases()) {
920 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
921 if (Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr()) {
922 PolymorphicBase = BaseDecl;
923 break;
924 }
925 }
926 assert(PolymorphicBase && "polymorphic class has no apparent vfptr?");
927
928 llvm::Value *Offset =
929 GetVirtualBaseClassOffset(CGF, Value, SrcDecl, PolymorphicBase);
930 llvm::Value *Ptr = CGF.Builder.CreateInBoundsGEP(Value.getPointer(), Offset);
John McCall7f416cc2015-09-08 08:05:57 +0000931 CharUnits VBaseAlign =
932 CGF.CGM.getVBaseAlignment(Value.getAlignment(), SrcDecl, PolymorphicBase);
Peter Collingbourne60108802017-12-13 21:53:04 +0000933 return std::make_tuple(Address(Ptr, VBaseAlign), Offset, PolymorphicBase);
David Majnemer1162d252014-06-22 19:05:33 +0000934}
935
936bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
937 QualType SrcRecordTy) {
938 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
939 return IsDeref &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000940 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000941}
942
943static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF,
944 llvm::Value *Argument) {
945 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
946 llvm::FunctionType *FTy =
947 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
948 llvm::Value *Args[] = {Argument};
949 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
950 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
951}
952
953void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
954 llvm::CallSite Call =
955 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
956 Call.setDoesNotReturn();
957 CGF.Builder.CreateUnreachable();
958}
959
960llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
961 QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000962 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000963 llvm::Type *StdTypeInfoPtrTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +0000964 std::tie(ThisPtr, std::ignore, std::ignore) =
David Majnemer17755352016-07-09 19:26:25 +0000965 performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +0000966 auto Typeid = emitRTtypeidCall(CGF, ThisPtr.getPointer()).getInstruction();
967 return CGF.Builder.CreateBitCast(Typeid, StdTypeInfoPtrTy);
David Majnemer1162d252014-06-22 19:05:33 +0000968}
969
970bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
971 QualType SrcRecordTy) {
972 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
973 return SrcIsPtr &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000974 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000975}
976
977llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
John McCall7f416cc2015-09-08 08:05:57 +0000978 CodeGenFunction &CGF, Address This, QualType SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +0000979 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
980 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
981
982 llvm::Value *SrcRTTI =
983 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
984 llvm::Value *DestRTTI =
985 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
986
987 llvm::Value *Offset;
Peter Collingbourne60108802017-12-13 21:53:04 +0000988 std::tie(This, Offset, std::ignore) =
989 performBaseAdjustment(CGF, This, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +0000990 llvm::Value *ThisPtr = This.getPointer();
David Majnemer17755352016-07-09 19:26:25 +0000991 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
David Majnemer1162d252014-06-22 19:05:33 +0000992
993 // PVOID __RTDynamicCast(
994 // PVOID inptr,
995 // LONG VfDelta,
996 // PVOID SrcType,
997 // PVOID TargetType,
998 // BOOL isReference)
999 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
1000 CGF.Int8PtrTy, CGF.Int32Ty};
1001 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1002 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1003 "__RTDynamicCast");
1004 llvm::Value *Args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001005 ThisPtr, Offset, SrcRTTI, DestRTTI,
David Majnemer1162d252014-06-22 19:05:33 +00001006 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
John McCall7f416cc2015-09-08 08:05:57 +00001007 ThisPtr = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction();
1008 return CGF.Builder.CreateBitCast(ThisPtr, DestLTy);
David Majnemer1162d252014-06-22 19:05:33 +00001009}
1010
1011llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00001012MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +00001013 QualType SrcRecordTy,
1014 QualType DestTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +00001015 std::tie(Value, std::ignore, std::ignore) =
1016 performBaseAdjustment(CGF, Value, SrcRecordTy);
David Majnemer1162d252014-06-22 19:05:33 +00001017
1018 // PVOID __RTCastToVoid(
1019 // PVOID inptr)
1020 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
1021 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1022 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1023 "__RTCastToVoid");
John McCall7f416cc2015-09-08 08:05:57 +00001024 llvm::Value *Args[] = {Value.getPointer()};
David Majnemer1162d252014-06-22 19:05:33 +00001025 return CGF.EmitRuntimeCall(Function, Args);
1026}
1027
1028bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
1029 return false;
1030}
1031
David Majnemerca32f932014-09-01 18:50:02 +00001032llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
John McCall7f416cc2015-09-08 08:05:57 +00001033 CodeGenFunction &CGF, Address This, const CXXRecordDecl *ClassDecl,
David Majnemerca32f932014-09-01 18:50:02 +00001034 const CXXRecordDecl *BaseClassDecl) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001035 const ASTContext &Context = getContext();
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00001036 int64_t VBPtrChars =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001037 Context.getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001038 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
David Majnemer9ced3dd2015-03-14 23:44:48 +00001039 CharUnits IntSize = Context.getTypeSizeInChars(Context.IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001040 CharUnits VBTableChars =
1041 IntSize *
1042 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001043 llvm::Value *VBTableOffset =
David Majnemerca32f932014-09-01 18:50:02 +00001044 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001045
1046 llvm::Value *VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001047 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001048 VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001049 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001050 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
1051}
1052
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001053bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
1054 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +00001055}
1056
David Majnemer0c0b6d92014-10-31 20:09:12 +00001057static bool isDeletingDtor(GlobalDecl GD) {
1058 return isa<CXXDestructorDecl>(GD.getDecl()) &&
1059 GD.getDtorType() == Dtor_Deleting;
1060}
1061
1062bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const {
1063 return isDeletingDtor(GD);
1064}
1065
Reid Kleckner40ca9132014-05-13 22:05:45 +00001066bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
1067 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
1068 if (!RD)
1069 return false;
1070
John McCall7f416cc2015-09-08 08:05:57 +00001071 CharUnits Align = CGM.getContext().getTypeAlignInChars(FI.getReturnType());
Reid Kleckner40ca9132014-05-13 22:05:45 +00001072 if (FI.isInstanceMethod()) {
1073 // If it's an instance method, aggregates are always returned indirectly via
1074 // the second parameter.
John McCall7f416cc2015-09-08 08:05:57 +00001075 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001076 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod());
1077 return true;
1078 } else if (!RD->isPOD()) {
1079 // If it's a free function, non-POD types are returned indirectly.
John McCall7f416cc2015-09-08 08:05:57 +00001080 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001081 return true;
1082 }
1083
1084 // Otherwise, use the C ABI rules.
1085 return false;
1086}
1087
Reid Kleckner7810af02013-06-19 15:20:38 +00001088llvm::BasicBlock *
1089MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
1090 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001091 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1092 assert(IsMostDerivedClass &&
1093 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +00001094 llvm::Value *IsCompleteObject =
1095 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001096
1097 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
1098 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
1099 CGF.Builder.CreateCondBr(IsCompleteObject,
1100 CallVbaseCtorsBB, SkipVbaseCtorsBB);
1101
1102 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +00001103
1104 // Fill in the vbtable pointers here.
1105 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001106
1107 // CGF will put the base ctor calls in this basic block for us later.
1108
1109 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +00001110}
1111
Erich Keane13c7ec52016-12-07 00:21:45 +00001112llvm::BasicBlock *
1113MicrosoftCXXABI::EmitDtorCompleteObjectHandler(CodeGenFunction &CGF) {
1114 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1115 assert(IsMostDerivedClass &&
1116 "ctor for a class with virtual bases must have an implicit parameter");
1117 llvm::Value *IsCompleteObject =
1118 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
1119
1120 llvm::BasicBlock *CallVbaseDtorsBB = CGF.createBasicBlock("Dtor.dtor_vbases");
1121 llvm::BasicBlock *SkipVbaseDtorsBB = CGF.createBasicBlock("Dtor.skip_vbases");
1122 CGF.Builder.CreateCondBr(IsCompleteObject,
1123 CallVbaseDtorsBB, SkipVbaseDtorsBB);
1124
1125 CGF.EmitBlock(CallVbaseDtorsBB);
1126 // CGF will put the base dtor calls in this basic block for us later.
1127
1128 return SkipVbaseDtorsBB;
1129}
1130
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001131void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
1132 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
1133 // In most cases, an override for a vbase virtual method can adjust
1134 // the "this" parameter by applying a constant offset.
1135 // However, this is not enough while a constructor or a destructor of some
1136 // class X is being executed if all the following conditions are met:
1137 // - X has virtual bases, (1)
1138 // - X overrides a virtual method M of a vbase Y, (2)
1139 // - X itself is a vbase of the most derived class.
1140 //
1141 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
1142 // which holds the extra amount of "this" adjustment we must do when we use
1143 // the X vftables (i.e. during X ctor or dtor).
1144 // Outside the ctors and dtors, the values of vtorDisps are zero.
1145
1146 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
1147 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
1148 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
1149 CGBuilderTy &Builder = CGF.Builder;
1150
John McCall7f416cc2015-09-08 08:05:57 +00001151 unsigned AS = getThisAddress(CGF).getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +00001152 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001153
Nico Weber91af2742018-03-07 23:15:20 +00001154 for (const CXXBaseSpecifier &S : RD->vbases()) {
1155 const CXXRecordDecl *VBase = S.getType()->getAsCXXRecordDecl();
1156 auto I = VBaseMap.find(VBase);
1157 assert(I != VBaseMap.end());
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001158 if (!I->second.hasVtorDisp())
1159 continue;
1160
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +00001161 llvm::Value *VBaseOffset =
Nico Weber91af2742018-03-07 23:15:20 +00001162 GetVirtualBaseClassOffset(CGF, getThisAddress(CGF), RD, VBase);
1163 uint64_t ConstantVBaseOffset = I->second.VBaseOffset.getQuantity();
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001164
1165 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
1166 llvm::Value *VtorDispValue = Builder.CreateSub(
David Majnemer17755352016-07-09 19:26:25 +00001167 VBaseOffset, llvm::ConstantInt::get(CGM.PtrDiffTy, ConstantVBaseOffset),
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001168 "vtordisp.value");
David Majnemer17755352016-07-09 19:26:25 +00001169 VtorDispValue = Builder.CreateTruncOrBitCast(VtorDispValue, CGF.Int32Ty);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001170
1171 if (!Int8This)
1172 Int8This = Builder.CreateBitCast(getThisValue(CGF),
1173 CGF.Int8Ty->getPointerTo(AS));
1174 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
1175 // vtorDisp is always the 32-bits before the vbase in the class layout.
1176 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
1177 VtorDispPtr = Builder.CreateBitCast(
1178 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
1179
John McCall7f416cc2015-09-08 08:05:57 +00001180 Builder.CreateAlignedStore(VtorDispValue, VtorDispPtr,
1181 CharUnits::fromQuantity(4));
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001182 }
1183}
1184
David Majnemer37fd66e2015-03-13 22:36:55 +00001185static bool hasDefaultCXXMethodCC(ASTContext &Context,
1186 const CXXMethodDecl *MD) {
1187 CallingConv ExpectedCallingConv = Context.getDefaultCallingConvention(
1188 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1189 CallingConv ActualCallingConv =
1190 MD->getType()->getAs<FunctionProtoType>()->getCallConv();
1191 return ExpectedCallingConv == ActualCallingConv;
1192}
1193
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001194void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1195 // There's only one constructor type in this ABI.
1196 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
David Majnemer37fd66e2015-03-13 22:36:55 +00001197
1198 // Exported default constructors either have a simple call-site where they use
1199 // the typical calling convention and have a single 'this' pointer for an
1200 // argument -or- they get a wrapper function which appropriately thunks to the
1201 // real default constructor. This thunk is the default constructor closure.
1202 if (D->hasAttr<DLLExportAttr>() && D->isDefaultConstructor())
1203 if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) {
1204 llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure);
1205 Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage);
Rafael Espindolab7350042018-03-01 00:35:47 +00001206 CGM.setGVProperties(Fn, D);
David Majnemer37fd66e2015-03-13 22:36:55 +00001207 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001208}
1209
Reid Kleckner7810af02013-06-19 15:20:38 +00001210void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1211 const CXXRecordDecl *RD) {
John McCall7f416cc2015-09-08 08:05:57 +00001212 Address This = getThisAddress(CGF);
1213 This = CGF.Builder.CreateElementBitCast(This, CGM.Int8Ty, "this.int8");
David Majnemer9ced3dd2015-03-14 23:44:48 +00001214 const ASTContext &Context = getContext();
1215 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001216
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001217 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1218 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00001219 const std::unique_ptr<VPtrInfo> &VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001220 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +00001221 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001222 Context.getASTRecordLayout(VBT->IntroducingObject);
Reid Kleckner5f080942014-01-03 23:42:00 +00001223 CharUnits Offs = VBT->NonVirtualOffset;
1224 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001225 if (VBT->getVBaseWithVPtr())
1226 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
John McCall7f416cc2015-09-08 08:05:57 +00001227 Address VBPtr = CGF.Builder.CreateConstInBoundsByteGEP(This, Offs);
David Blaikie1ed728c2015-04-05 22:45:47 +00001228 llvm::Value *GVPtr =
1229 CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001230 VBPtr = CGF.Builder.CreateElementBitCast(VBPtr, GVPtr->getType(),
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001231 "vbptr." + VBT->ObjectWithVPtr->getName());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001232 CGF.Builder.CreateStore(GVPtr, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +00001233 }
1234}
1235
George Burgess IVf203dbf2017-02-22 20:28:02 +00001236CGCXXABI::AddedStructorArgs
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001237MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001238 SmallVectorImpl<CanQualType> &ArgTys) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001239 AddedStructorArgs Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001240 // TODO: 'for base' flag
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001241 if (T == StructorType::Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001242 // The scalar deleting destructor takes an implicit int parameter.
David Majnemer9ced3dd2015-03-14 23:44:48 +00001243 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001244 ++Added.Suffix;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001245 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001246 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
1247 if (!CD)
George Burgess IVf203dbf2017-02-22 20:28:02 +00001248 return Added;
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001249
1250 // All parameters are already in place except is_most_derived, which goes
1251 // after 'this' if it's variadic and last if it's not.
1252
1253 const CXXRecordDecl *Class = CD->getParent();
1254 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1255 if (Class->getNumVBases()) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001256 if (FPT->isVariadic()) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001257 ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001258 ++Added.Prefix;
1259 } else {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001260 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001261 ++Added.Suffix;
1262 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001263 }
George Burgess IVf203dbf2017-02-22 20:28:02 +00001264
1265 return Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001266}
1267
Reid Klecknerae9b0702018-03-16 19:40:50 +00001268void MicrosoftCXXABI::setCXXDestructorDLLStorage(llvm::GlobalValue *GV,
1269 const CXXDestructorDecl *Dtor,
1270 CXXDtorType DT) const {
1271 // Deleting destructor variants are never imported or exported. Give them the
1272 // default storage class.
1273 if (DT == Dtor_Deleting) {
1274 GV->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
1275 } else {
1276 const NamedDecl *ND = Dtor;
1277 CGM.setDLLImportDLLExport(GV, ND);
1278 }
1279}
1280
1281llvm::GlobalValue::LinkageTypes MicrosoftCXXABI::getCXXDestructorLinkage(
1282 GVALinkage Linkage, const CXXDestructorDecl *Dtor, CXXDtorType DT) const {
1283 // Internal things are always internal, regardless of attributes. After this,
1284 // we know the thunk is externally visible.
1285 if (Linkage == GVA_Internal)
1286 return llvm::GlobalValue::InternalLinkage;
1287
1288 switch (DT) {
1289 case Dtor_Base:
1290 // The base destructor most closely tracks the user-declared constructor, so
1291 // we delegate back to the normal declarator case.
1292 return CGM.getLLVMLinkageForDeclarator(Dtor, Linkage,
1293 /*isConstantVariable=*/false);
1294 case Dtor_Complete:
1295 // The complete destructor is like an inline function, but it may be
1296 // imported and therefore must be exported as well. This requires changing
1297 // the linkage if a DLL attribute is present.
1298 if (Dtor->hasAttr<DLLExportAttr>())
1299 return llvm::GlobalValue::WeakODRLinkage;
1300 if (Dtor->hasAttr<DLLImportAttr>())
1301 return llvm::GlobalValue::AvailableExternallyLinkage;
1302 return llvm::GlobalValue::LinkOnceODRLinkage;
1303 case Dtor_Deleting:
1304 // Deleting destructors are like inline functions. They have vague linkage
1305 // and are emitted everywhere they are used. They are internal if the class
1306 // is internal.
1307 return llvm::GlobalValue::LinkOnceODRLinkage;
1308 case Dtor_Comdat:
1309 llvm_unreachable("MS C++ ABI does not support comdat dtors");
1310 }
1311 llvm_unreachable("invalid dtor type");
1312}
1313
Reid Klecknere7de47e2013-07-22 13:51:44 +00001314void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1315 // The TU defining a dtor is only guaranteed to emit a base destructor. All
1316 // other destructor variants are delegating thunks.
1317 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1318}
1319
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001320CharUnits
1321MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001322 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001323
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001324 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1325 // Complete destructors take a pointer to the complete object as a
1326 // parameter, thus don't need this adjustment.
1327 if (GD.getDtorType() == Dtor_Complete)
1328 return CharUnits();
1329
1330 // There's no Dtor_Base in vftable but it shares the this adjustment with
1331 // the deleting one, so look it up instead.
Reid Kleckner138ab492018-05-17 18:12:18 +00001332 GD = GlobalDecl(DD, Dtor_Deleting);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001333 }
1334
Reid Klecknercbec0262018-04-02 20:00:39 +00001335 MethodVFTableLocation ML =
Reid Kleckner138ab492018-05-17 18:12:18 +00001336 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001337 CharUnits Adjustment = ML.VFPtrOffset;
1338
1339 // Normal virtual instance methods need to adjust from the vfptr that first
1340 // defined the virtual method to the virtual base subobject, but destructors
1341 // do not. The vector deleting destructor thunk applies this adjustment for
1342 // us if necessary.
1343 if (isa<CXXDestructorDecl>(MD))
1344 Adjustment = CharUnits::Zero();
1345
1346 if (ML.VBase) {
1347 const ASTRecordLayout &DerivedLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001348 getContext().getASTRecordLayout(MD->getParent());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001349 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1350 }
1351
1352 return Adjustment;
1353}
1354
John McCall7f416cc2015-09-08 08:05:57 +00001355Address MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1356 CodeGenFunction &CGF, GlobalDecl GD, Address This,
1357 bool VirtualCall) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001358 if (!VirtualCall) {
1359 // If the call of a virtual function is not virtual, we just have to
1360 // compensate for the adjustment the virtual function does in its prologue.
1361 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1362 if (Adjustment.isZero())
1363 return This;
1364
John McCall7f416cc2015-09-08 08:05:57 +00001365 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001366 assert(Adjustment.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001367 return CGF.Builder.CreateConstByteGEP(This, Adjustment);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001368 }
1369
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001370 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001371
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001372 GlobalDecl LookupGD = GD;
1373 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1374 // Complete dtors take a pointer to the complete object,
1375 // thus don't need adjustment.
1376 if (GD.getDtorType() == Dtor_Complete)
1377 return This;
1378
1379 // There's only Dtor_Deleting in vftable but it shares the this adjustment
1380 // with the base one, so look up the deleting one instead.
1381 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1382 }
Reid Klecknercbec0262018-04-02 20:00:39 +00001383 MethodVFTableLocation ML =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001384 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001385
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001386 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001387
1388 // Base destructors expect 'this' to point to the beginning of the base
1389 // subobject, not the first vfptr that happens to contain the virtual dtor.
1390 // However, we still need to apply the virtual base adjustment.
1391 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1392 StaticOffset = CharUnits::Zero();
1393
John McCall7f416cc2015-09-08 08:05:57 +00001394 Address Result = This;
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001395 if (ML.VBase) {
John McCall7f416cc2015-09-08 08:05:57 +00001396 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
1397
1398 const CXXRecordDecl *Derived = MD->getParent();
1399 const CXXRecordDecl *VBase = ML.VBase;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001400 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00001401 GetVirtualBaseClassOffset(CGF, Result, Derived, VBase);
1402 llvm::Value *VBasePtr =
1403 CGF.Builder.CreateInBoundsGEP(Result.getPointer(), VBaseOffset);
1404 CharUnits VBaseAlign =
1405 CGF.CGM.getVBaseAlignment(Result.getAlignment(), Derived, VBase);
1406 Result = Address(VBasePtr, VBaseAlign);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001407 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001408 if (!StaticOffset.isZero()) {
1409 assert(StaticOffset.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001410 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001411 if (ML.VBase) {
1412 // Non-virtual adjustment might result in a pointer outside the allocated
1413 // object, e.g. if the final overrider class is laid out after the virtual
1414 // base that declares a method in the most derived class.
1415 // FIXME: Update the code that emits this adjustment in thunks prologues.
John McCall7f416cc2015-09-08 08:05:57 +00001416 Result = CGF.Builder.CreateConstByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001417 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001418 Result = CGF.Builder.CreateConstInBoundsByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001419 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001420 }
John McCall7f416cc2015-09-08 08:05:57 +00001421 return Result;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001422}
1423
Reid Kleckner89077a12013-12-17 19:46:40 +00001424void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1425 QualType &ResTy,
1426 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001427 ASTContext &Context = getContext();
1428 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001429 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001430 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
Alexey Bataev56223232017-06-09 13:40:18 +00001431 auto *IsMostDerived = ImplicitParamDecl::Create(
1432 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1433 &Context.Idents.get("is_most_derived"), Context.IntTy,
1434 ImplicitParamDecl::Other);
Reid Kleckner89077a12013-12-17 19:46:40 +00001435 // The 'most_derived' parameter goes second if the ctor is variadic and last
1436 // if it's not. Dtors can't be variadic.
1437 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1438 if (FPT->isVariadic())
1439 Params.insert(Params.begin() + 1, IsMostDerived);
1440 else
1441 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001442 getStructorImplicitParamDecl(CGF) = IsMostDerived;
David Majnemer0c0b6d92014-10-31 20:09:12 +00001443 } else if (isDeletingDtor(CGF.CurGD)) {
Alexey Bataev56223232017-06-09 13:40:18 +00001444 auto *ShouldDelete = ImplicitParamDecl::Create(
1445 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1446 &Context.Idents.get("should_call_delete"), Context.IntTy,
1447 ImplicitParamDecl::Other);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001448 Params.push_back(ShouldDelete);
1449 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1450 }
John McCall0f999f32012-09-25 08:00:39 +00001451}
1452
1453void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
Justin Lebared4f1722016-07-27 22:04:24 +00001454 // Naked functions have no prolog.
1455 if (CGF.CurFuncDecl && CGF.CurFuncDecl->hasAttr<NakedAttr>())
1456 return;
1457
Reid Kleckner06239e42017-11-16 19:09:36 +00001458 // Overridden virtual methods of non-primary bases need to adjust the incoming
1459 // 'this' pointer in the prologue. In this hierarchy, C::b will subtract
1460 // sizeof(void*) to adjust from B* to C*:
1461 // struct A { virtual void a(); };
1462 // struct B { virtual void b(); };
1463 // struct C : A, B { virtual void b(); };
1464 //
1465 // Leave the value stored in the 'this' alloca unadjusted, so that the
1466 // debugger sees the unadjusted value. Microsoft debuggers require this, and
1467 // will apply the ThisAdjustment in the method type information.
1468 // FIXME: Do something better for DWARF debuggers, which won't expect this,
1469 // without making our codegen depend on debug info settings.
1470 llvm::Value *This = loadIncomingCXXThis(CGF);
1471 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1472 if (!CGF.CurFuncIsThunk && MD->isVirtual()) {
1473 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(CGF.CurGD);
1474 if (!Adjustment.isZero()) {
1475 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1476 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1477 *thisTy = This->getType();
1478 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1479 assert(Adjustment.isPositive());
1480 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
1481 -Adjustment.getQuantity());
1482 This = CGF.Builder.CreateBitCast(This, thisTy, "this.adjusted");
1483 }
1484 }
1485 setCXXABIThisValue(CGF, This);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001486
Reid Kleckner06239e42017-11-16 19:09:36 +00001487 // If this is a function that the ABI specifies returns 'this', initialize
1488 // the return slot to 'this' at the start of the function.
1489 //
1490 // Unlike the setting of return types, this is done within the ABI
1491 // implementation instead of by clients of CGCXXABI because:
1492 // 1) getThisValue is currently protected
1493 // 2) in theory, an ABI could implement 'this' returns some other way;
1494 // HasThisReturn only specifies a contract, not the implementation
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001495 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001496 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001497 else if (hasMostDerivedReturn(CGF.CurGD))
1498 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1499 CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001500
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001501 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1502 assert(getStructorImplicitParamDecl(CGF) &&
1503 "no implicit parameter for a constructor with virtual bases?");
1504 getStructorImplicitParamValue(CGF)
1505 = CGF.Builder.CreateLoad(
1506 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1507 "is_most_derived");
1508 }
1509
David Majnemer0c0b6d92014-10-31 20:09:12 +00001510 if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001511 assert(getStructorImplicitParamDecl(CGF) &&
1512 "no implicit parameter for a deleting destructor?");
1513 getStructorImplicitParamValue(CGF)
1514 = CGF.Builder.CreateLoad(
1515 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1516 "should_call_delete");
1517 }
John McCall0f999f32012-09-25 08:00:39 +00001518}
1519
George Burgess IVf203dbf2017-02-22 20:28:02 +00001520CGCXXABI::AddedStructorArgs MicrosoftCXXABI::addImplicitConstructorArgs(
Reid Kleckner89077a12013-12-17 19:46:40 +00001521 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1522 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001523 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001524
Reid Kleckner89077a12013-12-17 19:46:40 +00001525 // Check if we need a 'most_derived' parameter.
1526 if (!D->getParent()->getNumVBases())
George Burgess IVf203dbf2017-02-22 20:28:02 +00001527 return AddedStructorArgs{};
Reid Kleckner89077a12013-12-17 19:46:40 +00001528
1529 // Add the 'most_derived' argument second if we are variadic or last if not.
1530 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
David Majnemer833b91e2016-05-13 20:05:09 +00001531 llvm::Value *MostDerivedArg;
1532 if (Delegating) {
1533 MostDerivedArg = getStructorImplicitParamValue(CGF);
1534 } else {
1535 MostDerivedArg = llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001536 }
David Majnemer833b91e2016-05-13 20:05:09 +00001537 RValue RV = RValue::get(MostDerivedArg);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001538 if (FPT->isVariadic()) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001539 Args.insert(Args.begin() + 1, CallArg(RV, getContext().IntTy));
George Burgess IVf203dbf2017-02-22 20:28:02 +00001540 return AddedStructorArgs::prefix(1);
1541 }
1542 Args.add(RV, getContext().IntTy);
1543 return AddedStructorArgs::suffix(1);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001544}
1545
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001546void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1547 const CXXDestructorDecl *DD,
1548 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +00001549 bool Delegating, Address This) {
Reid Klecknerae9b0702018-03-16 19:40:50 +00001550 // Use the base destructor variant in place of the complete destructor variant
1551 // if the class has no virtual bases. This effectively implements some of the
1552 // -mconstructor-aliases optimization, but as part of the MS C++ ABI.
1553 if (Type == Dtor_Complete && DD->getParent()->getNumVBases() == 0)
1554 Type = Dtor_Base;
1555
John McCallb92ab1a2016-10-26 23:46:34 +00001556 CGCallee Callee = CGCallee::forDirect(
1557 CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type)),
1558 DD);
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001559
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001560 if (DD->isVirtual()) {
1561 assert(Type != CXXDtorType::Dtor_Deleting &&
1562 "The deleting destructor should only be called via a virtual call");
1563 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1564 This, false);
1565 }
Erich Keane13c7ec52016-12-07 00:21:45 +00001566
1567 llvm::BasicBlock *BaseDtorEndBB = nullptr;
1568 if (ForVirtualBase && isa<CXXConstructorDecl>(CGF.CurCodeDecl)) {
1569 BaseDtorEndBB = EmitDtorCompleteObjectHandler(CGF);
1570 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001571
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001572 CGF.EmitCXXDestructorCall(DD, Callee, This.getPointer(),
1573 /*ImplicitParam=*/nullptr,
1574 /*ImplicitParamTy=*/QualType(), nullptr,
1575 getFromDtorType(Type));
Erich Keane13c7ec52016-12-07 00:21:45 +00001576 if (BaseDtorEndBB) {
1577 // Complete object handler should continue to be the remaining
1578 CGF.Builder.CreateBr(BaseDtorEndBB);
1579 CGF.EmitBlock(BaseDtorEndBB);
1580 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001581}
1582
Justin Lebar562914e2016-10-10 16:26:29 +00001583void MicrosoftCXXABI::emitVTableTypeMetadata(const VPtrInfo &Info,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001584 const CXXRecordDecl *RD,
1585 llvm::GlobalVariable *VTable) {
Peter Collingbourne1e1475a2017-01-18 23:55:27 +00001586 if (!CGM.getCodeGenOpts().LTOUnit)
Peter Collingbourned9546012015-06-19 02:30:43 +00001587 return;
1588
Peter Collingbournee5706442015-07-09 19:56:14 +00001589 // The location of the first virtual function pointer in the virtual table,
1590 // aka the "address point" on Itanium. This is at offset 0 if RTTI is
1591 // disabled, or sizeof(void*) if RTTI is enabled.
1592 CharUnits AddressPoint =
1593 getContext().getLangOpts().RTTIData
1594 ? getContext().toCharUnitsFromBits(
1595 getContext().getTargetInfo().getPointerWidth(0))
1596 : CharUnits::Zero();
Peter Collingbourned9546012015-06-19 02:30:43 +00001597
Justin Lebar562914e2016-10-10 16:26:29 +00001598 if (Info.PathToIntroducingObject.empty()) {
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001599 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001600 return;
1601 }
1602
1603 // Add a bitset entry for the least derived base belonging to this vftable.
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001604 CGM.AddVTableTypeMetadata(VTable, AddressPoint,
Justin Lebar562914e2016-10-10 16:26:29 +00001605 Info.PathToIntroducingObject.back());
Peter Collingbourned9546012015-06-19 02:30:43 +00001606
1607 // Add a bitset entry for each derived class that is laid out at the same
1608 // offset as the least derived base.
Justin Lebar562914e2016-10-10 16:26:29 +00001609 for (unsigned I = Info.PathToIntroducingObject.size() - 1; I != 0; --I) {
1610 const CXXRecordDecl *DerivedRD = Info.PathToIntroducingObject[I - 1];
1611 const CXXRecordDecl *BaseRD = Info.PathToIntroducingObject[I];
Peter Collingbourned9546012015-06-19 02:30:43 +00001612
1613 const ASTRecordLayout &Layout =
1614 getContext().getASTRecordLayout(DerivedRD);
1615 CharUnits Offset;
1616 auto VBI = Layout.getVBaseOffsetsMap().find(BaseRD);
1617 if (VBI == Layout.getVBaseOffsetsMap().end())
1618 Offset = Layout.getBaseClassOffset(BaseRD);
1619 else
1620 Offset = VBI->second.VBaseOffset;
1621 if (!Offset.isZero())
1622 return;
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001623 CGM.AddVTableTypeMetadata(VTable, AddressPoint, DerivedRD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001624 }
1625
1626 // Finally do the same for the most derived class.
Justin Lebar562914e2016-10-10 16:26:29 +00001627 if (Info.FullOffsetInMDC.isZero())
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001628 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001629}
1630
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001631void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1632 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001633 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001634 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001635
Justin Lebar562914e2016-10-10 16:26:29 +00001636 for (const std::unique_ptr<VPtrInfo>& Info : VFPtrs) {
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001637 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001638 if (VTable->hasInitializer())
1639 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001640
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001641 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001642 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
David Majnemer470ee612016-02-09 17:27:52 +00001643
1644 llvm::Constant *RTTI = nullptr;
1645 if (any_of(VTLayout.vtable_components(),
1646 [](const VTableComponent &VTC) { return VTC.isRTTIKind(); }))
Justin Lebar562914e2016-10-10 16:26:29 +00001647 RTTI = getMSCompleteObjectLocator(RD, *Info);
David Majnemer470ee612016-02-09 17:27:52 +00001648
John McCall9c6cb762016-11-28 22:18:33 +00001649 ConstantInitBuilder Builder(CGM);
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001650 auto Components = Builder.beginStruct();
John McCall9c6cb762016-11-28 22:18:33 +00001651 CGVT.createVTableInitializer(Components, VTLayout, RTTI);
1652 Components.finishAndSetAsInitializer(VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +00001653
Justin Lebar562914e2016-10-10 16:26:29 +00001654 emitVTableTypeMetadata(*Info, RD, VTable);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001655 }
1656}
1657
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001658bool MicrosoftCXXABI::isVirtualOffsetNeededForVTableField(
1659 CodeGenFunction &CGF, CodeGenFunction::VPtr Vptr) {
1660 return Vptr.NearestVBase != nullptr;
1661}
1662
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001663llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1664 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001665 const CXXRecordDecl *NearestVBase) {
1666 llvm::Constant *VTableAddressPoint = getVTableAddressPoint(Base, VTableClass);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001667 if (!VTableAddressPoint) {
1668 assert(Base.getBase()->getNumVBases() &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001669 !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001670 }
1671 return VTableAddressPoint;
1672}
1673
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001674static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Justin Lebar562914e2016-10-10 16:26:29 +00001675 const CXXRecordDecl *RD, const VPtrInfo &VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001676 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001677 llvm::raw_svector_ostream Out(Name);
Justin Lebar562914e2016-10-10 16:26:29 +00001678 MangleContext.mangleCXXVFTable(RD, VFPtr.MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001679}
1680
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001681llvm::Constant *
1682MicrosoftCXXABI::getVTableAddressPoint(BaseSubobject Base,
1683 const CXXRecordDecl *VTableClass) {
Piotr Padlewski4bed31b2015-09-10 20:18:30 +00001684 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1685 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001686 return VFTablesMap[ID];
1687}
1688
1689llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1690 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1691 llvm::Constant *VFTable = getVTableAddressPoint(Base, VTableClass);
David Majnemerd905da42014-07-01 20:30:31 +00001692 assert(VFTable && "Couldn't find a vftable for the given base?");
1693 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001694}
1695
1696llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1697 CharUnits VPtrOffset) {
1698 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1699 // shouldn't be used in the given record type. We want to cache this result in
1700 // VFTablesMap, thus a simple zero check is not sufficient.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001701
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001702 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001703 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001704 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001705 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001706 if (!Inserted)
1707 return I->second;
1708
1709 llvm::GlobalVariable *&VTable = I->second;
1710
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001711 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001712 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001713
David Blaikie82e95a32014-11-19 07:49:47 +00001714 if (DeferredVFTables.insert(RD).second) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001715 // We haven't processed this record type before.
Eric Christopherd160c502016-01-29 01:35:53 +00001716 // Queue up this vtable for possible deferred emission.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001717 CGM.addDeferredVTable(RD);
1718
1719#ifndef NDEBUG
1720 // Create all the vftables at once in order to make sure each vftable has
1721 // a unique mangled name.
1722 llvm::StringSet<> ObservedMangledNames;
1723 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1724 SmallString<256> Name;
Justin Lebar562914e2016-10-10 16:26:29 +00001725 mangleVFTableName(getMangleContext(), RD, *VFPtrs[J], Name);
David Blaikie61b86d42014-11-19 02:56:13 +00001726 if (!ObservedMangledNames.insert(Name.str()).second)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001727 llvm_unreachable("Already saw this mangling before?");
1728 }
1729#endif
1730 }
1731
Justin Lebar562914e2016-10-10 16:26:29 +00001732 const std::unique_ptr<VPtrInfo> *VFPtrI = std::find_if(
1733 VFPtrs.begin(), VFPtrs.end(), [&](const std::unique_ptr<VPtrInfo>& VPI) {
David Majnemera03849b2015-03-18 22:04:43 +00001734 return VPI->FullOffsetInMDC == VPtrOffset;
1735 });
1736 if (VFPtrI == VFPtrs.end()) {
1737 VFTablesMap[ID] = nullptr;
1738 return nullptr;
1739 }
Justin Lebar562914e2016-10-10 16:26:29 +00001740 const std::unique_ptr<VPtrInfo> &VFPtr = *VFPtrI;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001741
David Majnemera03849b2015-03-18 22:04:43 +00001742 SmallString<256> VFTableName;
Justin Lebar562914e2016-10-10 16:26:29 +00001743 mangleVFTableName(getMangleContext(), RD, *VFPtr, VFTableName);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001744
David Majnemer2d8b2002016-02-11 17:49:28 +00001745 // Classes marked __declspec(dllimport) need vftables generated on the
1746 // import-side in order to support features like constexpr. No other
1747 // translation unit relies on the emission of the local vftable, translation
1748 // units are expected to generate them as needed.
1749 //
1750 // Because of this unique behavior, we maintain this logic here instead of
1751 // getVTableLinkage.
1752 llvm::GlobalValue::LinkageTypes VFTableLinkage =
1753 RD->hasAttr<DLLImportAttr>() ? llvm::GlobalValue::LinkOnceODRLinkage
1754 : CGM.getVTableLinkage(RD);
David Majnemera03849b2015-03-18 22:04:43 +00001755 bool VFTableComesFromAnotherTU =
1756 llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) ||
1757 llvm::GlobalValue::isExternalLinkage(VFTableLinkage);
1758 bool VTableAliasIsRequred =
1759 !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData;
David Majnemerbb848712014-07-01 22:37:08 +00001760
David Majnemera03849b2015-03-18 22:04:43 +00001761 if (llvm::GlobalValue *VFTable =
1762 CGM.getModule().getNamedGlobal(VFTableName)) {
1763 VFTablesMap[ID] = VFTable;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001764 VTable = VTableAliasIsRequred
1765 ? cast<llvm::GlobalVariable>(
1766 cast<llvm::GlobalAlias>(VFTable)->getBaseObject())
1767 : cast<llvm::GlobalVariable>(VFTable);
1768 return VTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001769 }
1770
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001771 const VTableLayout &VTLayout =
1772 VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC);
David Majnemera03849b2015-03-18 22:04:43 +00001773 llvm::GlobalValue::LinkageTypes VTableLinkage =
1774 VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage;
1775
1776 StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str();
1777
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001778 llvm::Type *VTableType = CGM.getVTables().getVTableType(VTLayout);
David Majnemera03849b2015-03-18 22:04:43 +00001779
1780 // Create a backing variable for the contents of VTable. The VTable may
1781 // or may not include space for a pointer to RTTI data.
1782 llvm::GlobalValue *VFTable;
1783 VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType,
1784 /*isConstant=*/true, VTableLinkage,
1785 /*Initializer=*/nullptr, VTableName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001786 VTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001787
1788 llvm::Comdat *C = nullptr;
1789 if (!VFTableComesFromAnotherTU &&
1790 (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) ||
1791 (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) &&
1792 VTableAliasIsRequred)))
1793 C = CGM.getModule().getOrInsertComdat(VFTableName.str());
1794
1795 // Only insert a pointer into the VFTable for RTTI data if we are not
1796 // importing it. We never reference the RTTI data directly so there is no
1797 // need to make room for it.
1798 if (VTableAliasIsRequred) {
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001799 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.Int32Ty, 0),
1800 llvm::ConstantInt::get(CGM.Int32Ty, 0),
1801 llvm::ConstantInt::get(CGM.Int32Ty, 1)};
David Majnemera03849b2015-03-18 22:04:43 +00001802 // Create a GEP which points just after the first entry in the VFTable,
1803 // this should be the location of the first virtual method.
David Blaikiee3b172a2015-04-02 18:55:21 +00001804 llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr(
1805 VTable->getValueType(), VTable, GEPIndices);
David Majnemera03849b2015-03-18 22:04:43 +00001806 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) {
1807 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1808 if (C)
1809 C->setSelectionKind(llvm::Comdat::Largest);
1810 }
David Blaikie2a791d72015-09-14 18:38:22 +00001811 VFTable = llvm::GlobalAlias::create(CGM.Int8PtrTy,
1812 /*AddressSpace=*/0, VFTableLinkage,
1813 VFTableName.str(), VTableGEP,
1814 &CGM.getModule());
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001815 VFTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001816 } else {
1817 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1818 // be referencing any RTTI data.
1819 // The GlobalVariable will end up being an appropriate definition of the
1820 // VFTable.
1821 VFTable = VTable;
1822 }
1823 if (C)
1824 VTable->setComdat(C);
1825
David Majnemer2d8b2002016-02-11 17:49:28 +00001826 if (RD->hasAttr<DLLExportAttr>())
David Majnemera03849b2015-03-18 22:04:43 +00001827 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1828
1829 VFTablesMap[ID] = VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001830 return VTable;
1831}
1832
John McCall9831b842018-02-06 18:52:44 +00001833CGCallee MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1834 GlobalDecl GD,
1835 Address This,
1836 llvm::Type *Ty,
1837 SourceLocation Loc) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001838 CGBuilderTy &Builder = CGF.Builder;
1839
1840 Ty = Ty->getPointerTo()->getPointerTo();
John McCall7f416cc2015-09-08 08:05:57 +00001841 Address VPtr =
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001842 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001843
1844 auto *MethodDecl = cast<CXXMethodDecl>(GD.getDecl());
1845 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty, MethodDecl->getParent());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001846
David Majnemer07c915e2016-10-27 17:11:51 +00001847 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Reid Klecknercbec0262018-04-02 20:00:39 +00001848 MethodVFTableLocation ML = VFTContext.getMethodVFTableLocation(GD);
David Majnemer07c915e2016-10-27 17:11:51 +00001849
1850 // Compute the identity of the most derived class whose virtual table is
1851 // located at the MethodVFTableLocation ML.
1852 auto getObjectWithVPtr = [&] {
1853 return llvm::find_if(VFTContext.getVFPtrOffsets(
1854 ML.VBase ? ML.VBase : MethodDecl->getParent()),
1855 [&](const std::unique_ptr<VPtrInfo> &Info) {
1856 return Info->FullOffsetInMDC == ML.VFPtrOffset;
1857 })
1858 ->get()
1859 ->ObjectWithVPtr;
1860 };
Peter Collingbourned9546012015-06-19 02:30:43 +00001861
John McCall9831b842018-02-06 18:52:44 +00001862 llvm::Value *VFunc;
1863 if (CGF.ShouldEmitVTableTypeCheckedLoad(MethodDecl->getParent())) {
1864 VFunc = CGF.EmitVTableTypeCheckedLoad(
David Majnemer07c915e2016-10-27 17:11:51 +00001865 getObjectWithVPtr(), VTable,
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001866 ML.Index * CGM.getContext().getTargetInfo().getPointerWidth(0) / 8);
John McCall9831b842018-02-06 18:52:44 +00001867 } else {
1868 if (CGM.getCodeGenOpts().PrepareForLTO)
1869 CGF.EmitTypeMetadataCodeForVCall(getObjectWithVPtr(), VTable, Loc);
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001870
John McCall9831b842018-02-06 18:52:44 +00001871 llvm::Value *VFuncPtr =
1872 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1873 VFunc = Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
1874 }
John McCallb92ab1a2016-10-26 23:46:34 +00001875
Reid Kleckner138ab492018-05-17 18:12:18 +00001876 CGCallee Callee(MethodDecl->getCanonicalDecl(), VFunc);
John McCall9831b842018-02-06 18:52:44 +00001877 return Callee;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001878}
1879
David Majnemer0c0b6d92014-10-31 20:09:12 +00001880llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1881 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +00001882 Address This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001883 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001884 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1885
1886 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001887 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001888 GlobalDecl GD(Dtor, Dtor_Deleting);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001889 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1890 Dtor, StructorType::Deleting);
George Burgess IV00f70bd2018-03-01 05:43:23 +00001891 llvm::FunctionType *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Peter Collingbourneea211002018-02-05 23:09:13 +00001892 CGCallee Callee = CGCallee::forVirtual(CE, GD, This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001893
David Majnemer9ced3dd2015-03-14 23:44:48 +00001894 ASTContext &Context = getContext();
Nico Weber0a029922015-01-12 21:24:10 +00001895 llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1896 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1897 DtorType == Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001898
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001899 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001900 RValue RV =
1901 CGF.EmitCXXDestructorCall(Dtor, Callee, This.getPointer(), ImplicitParam,
1902 Context.IntTy, CE, StructorType::Deleting);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001903 return RV.getScalarVal();
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001904}
1905
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001906const VBTableGlobals &
1907MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001908 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001909 // easier than caching each vbtable individually.
1910 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1911 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001912 std::tie(Entry, Added) =
1913 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001914 VBTableGlobals &VBGlobals = Entry->second;
1915 if (!Added)
1916 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001917
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001918 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1919 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001920
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001921 // Cache the globals for all vbtables so we don't have to recompute the
1922 // mangled names.
1923 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001924 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1925 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001926 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001927 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001928 }
1929
1930 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001931}
1932
Reid Klecknercbec0262018-04-02 20:00:39 +00001933llvm::Function *
1934MicrosoftCXXABI::EmitVirtualMemPtrThunk(const CXXMethodDecl *MD,
1935 const MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001936 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1937 "can't form pointers to ctors or virtual dtors");
1938
Reid Klecknere4a52202014-02-21 02:27:32 +00001939 // Calculate the mangled name.
1940 SmallString<256> ThunkName;
1941 llvm::raw_svector_ostream Out(ThunkName);
Reid Klecknercbec0262018-04-02 20:00:39 +00001942 getMangleContext().mangleVirtualMemPtrThunk(MD, ML, Out);
Reid Klecknere4a52202014-02-21 02:27:32 +00001943
Hans Wennborg88497d62013-11-15 17:24:45 +00001944 // If the thunk has been generated previously, just return it.
1945 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1946 return cast<llvm::Function>(GV);
1947
1948 // Create the llvm::Function.
Reid Kleckner399d96e2018-04-02 20:20:33 +00001949 const CGFunctionInfo &FnInfo =
1950 CGM.getTypes().arrangeUnprototypedMustTailThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00001951 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1952 llvm::Function *ThunkFn =
1953 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1954 ThunkName.str(), &CGM.getModule());
1955 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1956
Hans Wennborg88497d62013-11-15 17:24:45 +00001957 ThunkFn->setLinkage(MD->isExternallyVisible()
1958 ? llvm::GlobalValue::LinkOnceODRLinkage
1959 : llvm::GlobalValue::InternalLinkage);
David Majnemer8c9cdb62015-01-21 01:21:31 +00001960 if (MD->isExternallyVisible())
1961 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
Hans Wennborg88497d62013-11-15 17:24:45 +00001962
1963 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1964 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1965
Reid Kleckner9da94482015-01-21 22:18:17 +00001966 // Add the "thunk" attribute so that LLVM knows that the return type is
1967 // meaningless. These thunks can be used to call functions with differing
1968 // return types, and the caller is required to cast the prototype
1969 // appropriately to extract the correct value.
1970 ThunkFn->addFnAttr("thunk");
1971
Reid Klecknerb9538a62014-08-15 18:12:40 +00001972 // These thunks can be compared, so they are not unnamed.
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001973 ThunkFn->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::None);
Reid Klecknerb9538a62014-08-15 18:12:40 +00001974
Hans Wennborg88497d62013-11-15 17:24:45 +00001975 // Start codegen.
1976 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00001977 CGF.CurGD = GlobalDecl(MD);
1978 CGF.CurFuncIsThunk = true;
1979
1980 // Build FunctionArgs, but only include the implicit 'this' parameter
1981 // declaration.
1982 FunctionArgList FunctionArgs;
1983 buildThisParam(CGF, FunctionArgs);
1984
1985 // Start defining the function.
1986 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
1987 FunctionArgs, MD->getLocation(), SourceLocation());
Reid Kleckner06239e42017-11-16 19:09:36 +00001988 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
Hans Wennborg88497d62013-11-15 17:24:45 +00001989
Reid Klecknere4a52202014-02-21 02:27:32 +00001990 // Load the vfptr and then callee from the vftable. The callee should have
1991 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00001992 llvm::Value *VTable = CGF.GetVTablePtr(
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001993 getThisAddress(CGF), ThunkTy->getPointerTo()->getPointerTo(), MD->getParent());
1994
Reid Klecknere4a52202014-02-21 02:27:32 +00001995 llvm::Value *VFuncPtr =
1996 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
John McCall7f416cc2015-09-08 08:05:57 +00001997 llvm::Value *Callee =
1998 CGF.Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
Hans Wennborg88497d62013-11-15 17:24:45 +00001999
Reid Klecknerc3473512014-08-29 21:43:29 +00002000 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee);
Hans Wennborg88497d62013-11-15 17:24:45 +00002001
2002 return ThunkFn;
2003}
2004
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002005void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002006 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
2007 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00002008 const std::unique_ptr<VPtrInfo>& VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002009 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
David Majnemer129f4172015-02-02 10:22:20 +00002010 if (GV->isDeclaration())
2011 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00002012 }
2013}
2014
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002015llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002016MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002017 llvm::GlobalVariable::LinkageTypes Linkage) {
2018 SmallString<256> OutName;
2019 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00002020 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002021 StringRef Name = OutName.str();
2022
2023 llvm::ArrayType *VBTableType =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002024 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ObjectWithVPtr->getNumVBases());
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002025
2026 assert(!CGM.getModule().getNamedGlobal(Name) &&
2027 "vbtable with this name already exists: mangling bug?");
2028 llvm::GlobalVariable *GV =
2029 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00002030 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Hans Wennborg853ae942014-05-30 16:59:42 +00002031
2032 if (RD->hasAttr<DLLImportAttr>())
2033 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
2034 else if (RD->hasAttr<DLLExportAttr>())
2035 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
2036
David Majnemer129f4172015-02-02 10:22:20 +00002037 if (!GV->hasExternalLinkage())
2038 emitVBTableDefinition(VBT, RD, GV);
2039
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002040 return GV;
2041}
2042
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002043void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002044 const CXXRecordDecl *RD,
2045 llvm::GlobalVariable *GV) const {
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002046 const CXXRecordDecl *ObjectWithVPtr = VBT.ObjectWithVPtr;
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002047
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002048 assert(RD->getNumVBases() && ObjectWithVPtr->getNumVBases() &&
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002049 "should only emit vbtables for classes with vbtables");
2050
2051 const ASTRecordLayout &BaseLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002052 getContext().getASTRecordLayout(VBT.IntroducingObject);
David Majnemer9ced3dd2015-03-14 23:44:48 +00002053 const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002054
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002055 SmallVector<llvm::Constant *, 4> Offsets(1 + ObjectWithVPtr->getNumVBases(),
Craig Topper8a13c412014-05-21 05:09:00 +00002056 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002057
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002058 // The offset from ObjectWithVPtr's vbptr to itself always leads.
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002059 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
2060 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
2061
2062 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002063 for (const auto &I : ObjectWithVPtr->vbases()) {
Aaron Ballman445a9392014-03-13 16:15:17 +00002064 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002065 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
2066 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00002067
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002068 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00002069 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002070 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00002071 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002072 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00002073 Offset -= CompleteVBPtrOffset;
2074
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002075 unsigned VBIndex = Context.getVBTableIndex(ObjectWithVPtr, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00002076 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002077 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
2078 }
2079
2080 assert(Offsets.size() ==
2081 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
2082 ->getElementType())->getNumElements());
2083 llvm::ArrayType *VBTableType =
2084 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
2085 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
2086 GV->setInitializer(Init);
David Majnemer46e39cc2016-02-22 17:22:08 +00002087
2088 if (RD->hasAttr<DLLImportAttr>())
2089 GV->setLinkage(llvm::GlobalVariable::AvailableExternallyLinkage);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002090}
2091
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002092llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002093 Address This,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002094 const ThisAdjustment &TA) {
2095 if (TA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002096 return This.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002097
John McCall7f416cc2015-09-08 08:05:57 +00002098 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002099
John McCall7f416cc2015-09-08 08:05:57 +00002100 llvm::Value *V;
2101 if (TA.Virtual.isEmpty()) {
2102 V = This.getPointer();
2103 } else {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002104 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
2105 // Adjust the this argument based on the vtordisp value.
John McCall7f416cc2015-09-08 08:05:57 +00002106 Address VtorDispPtr =
2107 CGF.Builder.CreateConstInBoundsByteGEP(This,
2108 CharUnits::fromQuantity(TA.Virtual.Microsoft.VtordispOffset));
2109 VtorDispPtr = CGF.Builder.CreateElementBitCast(VtorDispPtr, CGF.Int32Ty);
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002110 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
John McCall7f416cc2015-09-08 08:05:57 +00002111 V = CGF.Builder.CreateGEP(This.getPointer(),
2112 CGF.Builder.CreateNeg(VtorDisp));
2113
2114 // Unfortunately, having applied the vtordisp means that we no
2115 // longer really have a known alignment for the vbptr step.
2116 // We'll assume the vbptr is pointer-aligned.
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002117
2118 if (TA.Virtual.Microsoft.VBPtrOffset) {
2119 // If the final overrider is defined in a virtual base other than the one
2120 // that holds the vfptr, we have to use a vtordispex thunk which looks up
2121 // the vbtable of the derived class.
2122 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
2123 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
2124 llvm::Value *VBPtr;
2125 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002126 GetVBaseOffsetFromVBPtr(CGF, Address(V, CGF.getPointerAlign()),
2127 -TA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002128 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
2129 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2130 }
2131 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002132
2133 if (TA.NonVirtual) {
2134 // Non-virtual adjustment might result in a pointer outside the allocated
2135 // object, e.g. if the final overrider class is laid out after the virtual
2136 // base that declares a method in the most derived class.
2137 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
2138 }
2139
2140 // Don't need to bitcast back, the call CodeGen will handle this.
2141 return V;
2142}
2143
2144llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00002145MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002146 const ReturnAdjustment &RA) {
2147 if (RA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002148 return Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002149
John McCall7f416cc2015-09-08 08:05:57 +00002150 auto OrigTy = Ret.getType();
2151 Ret = CGF.Builder.CreateElementBitCast(Ret, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002152
John McCall7f416cc2015-09-08 08:05:57 +00002153 llvm::Value *V = Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002154 if (RA.Virtual.Microsoft.VBIndex) {
2155 assert(RA.Virtual.Microsoft.VBIndex > 0);
John McCall7f416cc2015-09-08 08:05:57 +00002156 int32_t IntSize = CGF.getIntSize().getQuantity();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002157 llvm::Value *VBPtr;
2158 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002159 GetVBaseOffsetFromVBPtr(CGF, Ret, RA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002160 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
2161 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2162 }
2163
2164 if (RA.NonVirtual)
David Blaikiefb901c7a2015-04-04 15:12:29 +00002165 V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002166
2167 // Cast back to the original type.
John McCall7f416cc2015-09-08 08:05:57 +00002168 return CGF.Builder.CreateBitCast(V, OrigTy);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002169}
2170
John McCallb91cd662012-05-01 05:23:51 +00002171bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
2172 QualType elementType) {
2173 // Microsoft seems to completely ignore the possibility of a
2174 // two-argument usual deallocation function.
2175 return elementType.isDestructedType();
2176}
2177
2178bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
2179 // Microsoft seems to completely ignore the possibility of a
2180 // two-argument usual deallocation function.
2181 return expr->getAllocatedType().isDestructedType();
2182}
2183
2184CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
2185 // The array cookie is always a size_t; we then pad that out to the
2186 // alignment of the element type.
2187 ASTContext &Ctx = getContext();
2188 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
2189 Ctx.getTypeAlignInChars(type));
2190}
2191
2192llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002193 Address allocPtr,
John McCallb91cd662012-05-01 05:23:51 +00002194 CharUnits cookieSize) {
John McCall7f416cc2015-09-08 08:05:57 +00002195 Address numElementsPtr =
2196 CGF.Builder.CreateElementBitCast(allocPtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002197 return CGF.Builder.CreateLoad(numElementsPtr);
2198}
2199
John McCall7f416cc2015-09-08 08:05:57 +00002200Address MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
2201 Address newPtr,
2202 llvm::Value *numElements,
2203 const CXXNewExpr *expr,
2204 QualType elementType) {
John McCallb91cd662012-05-01 05:23:51 +00002205 assert(requiresArrayCookie(expr));
2206
2207 // The size of the cookie.
2208 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
2209
2210 // Compute an offset to the cookie.
John McCall7f416cc2015-09-08 08:05:57 +00002211 Address cookiePtr = newPtr;
John McCallb91cd662012-05-01 05:23:51 +00002212
2213 // Write the number of elements into the appropriate slot.
John McCall7f416cc2015-09-08 08:05:57 +00002214 Address numElementsPtr
2215 = CGF.Builder.CreateElementBitCast(cookiePtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002216 CGF.Builder.CreateStore(numElements, numElementsPtr);
2217
2218 // Finally, compute a pointer to the actual data buffer by skipping
2219 // over the cookie completely.
John McCall7f416cc2015-09-08 08:05:57 +00002220 return CGF.Builder.CreateConstInBoundsByteGEP(newPtr, cookieSize);
John McCallb91cd662012-05-01 05:23:51 +00002221}
2222
David Majnemerb3341ea2014-10-05 05:05:40 +00002223static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
2224 llvm::Constant *Dtor,
2225 llvm::Constant *Addr) {
2226 // Create a function which calls the destructor.
2227 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
2228
2229 // extern "C" int __tlregdtor(void (*f)(void));
2230 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
2231 CGF.IntTy, DtorStub->getType(), /*IsVarArg=*/false);
2232
Reid Klecknerde864822017-03-21 16:57:30 +00002233 llvm::Constant *TLRegDtor = CGF.CGM.CreateRuntimeFunction(
2234 TLRegDtorTy, "__tlregdtor", llvm::AttributeList(), /*Local=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002235 if (llvm::Function *TLRegDtorFn = dyn_cast<llvm::Function>(TLRegDtor))
2236 TLRegDtorFn->setDoesNotThrow();
2237
2238 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
2239}
2240
2241void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
2242 llvm::Constant *Dtor,
2243 llvm::Constant *Addr) {
2244 if (D.getTLSKind())
2245 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
2246
2247 // The default behavior is to use atexit.
2248 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
2249}
2250
2251void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +00002252 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +00002253 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +00002254 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) {
David Majnemercb60a432016-09-12 02:51:43 +00002255 if (CXXThreadLocalInits.empty())
2256 return;
2257
2258 CGM.AppendLinkerOptions(CGM.getTarget().getTriple().getArch() ==
2259 llvm::Triple::x86
2260 ? "/include:___dyn_tls_init@12"
2261 : "/include:__dyn_tls_init");
2262
David Majnemerb3341ea2014-10-05 05:05:40 +00002263 // This will create a GV in the .CRT$XDU section. It will point to our
2264 // initialization function. The CRT will call all of these function
2265 // pointers at start-up time and, eventually, at thread-creation time.
2266 auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
2267 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
2268 CGM.getModule(), InitFunc->getType(), /*IsConstant=*/true,
2269 llvm::GlobalVariable::InternalLinkage, InitFunc,
2270 Twine(InitFunc->getName(), "$initializer$"));
2271 InitFuncPtr->setSection(".CRT$XDU");
2272 // This variable has discardable linkage, we have to add it to @llvm.used to
2273 // ensure it won't get discarded.
2274 CGM.addUsedGlobal(InitFuncPtr);
2275 return InitFuncPtr;
2276 };
2277
2278 std::vector<llvm::Function *> NonComdatInits;
2279 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
Richard Smith5a99c492015-12-01 01:10:48 +00002280 llvm::GlobalVariable *GV = cast<llvm::GlobalVariable>(
2281 CGM.GetGlobalValue(CGM.getMangledName(CXXThreadLocalInitVars[I])));
David Majnemerb3341ea2014-10-05 05:05:40 +00002282 llvm::Function *F = CXXThreadLocalInits[I];
2283
2284 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002285 if (llvm::Comdat *C = GV->getComdat())
David Majnemerb3341ea2014-10-05 05:05:40 +00002286 AddToXDU(F)->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002287 else
David Majnemerb3341ea2014-10-05 05:05:40 +00002288 NonComdatInits.push_back(F);
David Majnemerb3341ea2014-10-05 05:05:40 +00002289 }
2290
2291 if (!NonComdatInits.empty()) {
2292 llvm::FunctionType *FTy =
2293 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002294 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +00002295 FTy, "__tls_init", CGM.getTypes().arrangeNullaryFunction(),
2296 SourceLocation(), /*TLS=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002297 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2298
2299 AddToXDU(InitFunc);
2300 }
2301}
2302
2303LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2304 const VarDecl *VD,
2305 QualType LValType) {
2306 CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2307 return LValue();
2308}
2309
John McCall7f416cc2015-09-08 08:05:57 +00002310static ConstantAddress getInitThreadEpochPtr(CodeGenModule &CGM) {
David Majnemer8354eee2015-05-07 06:15:46 +00002311 StringRef VarName("_Init_thread_epoch");
John McCall7f416cc2015-09-08 08:05:57 +00002312 CharUnits Align = CGM.getIntAlign();
David Majnemer8354eee2015-05-07 06:15:46 +00002313 if (auto *GV = CGM.getModule().getNamedGlobal(VarName))
John McCall7f416cc2015-09-08 08:05:57 +00002314 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002315 auto *GV = new llvm::GlobalVariable(
2316 CGM.getModule(), CGM.IntTy,
2317 /*Constant=*/false, llvm::GlobalVariable::ExternalLinkage,
2318 /*Initializer=*/nullptr, VarName,
2319 /*InsertBefore=*/nullptr, llvm::GlobalVariable::GeneralDynamicTLSModel);
John McCall7f416cc2015-09-08 08:05:57 +00002320 GV->setAlignment(Align.getQuantity());
2321 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002322}
2323
2324static llvm::Constant *getInitThreadHeaderFn(CodeGenModule &CGM) {
2325 llvm::FunctionType *FTy =
2326 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2327 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2328 return CGM.CreateRuntimeFunction(
2329 FTy, "_Init_thread_header",
Reid Klecknerde864822017-03-21 16:57:30 +00002330 llvm::AttributeList::get(CGM.getLLVMContext(),
2331 llvm::AttributeList::FunctionIndex,
2332 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002333 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002334}
2335
2336static llvm::Constant *getInitThreadFooterFn(CodeGenModule &CGM) {
2337 llvm::FunctionType *FTy =
2338 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2339 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2340 return CGM.CreateRuntimeFunction(
2341 FTy, "_Init_thread_footer",
Reid Klecknerde864822017-03-21 16:57:30 +00002342 llvm::AttributeList::get(CGM.getLLVMContext(),
2343 llvm::AttributeList::FunctionIndex,
2344 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002345 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002346}
2347
2348static llvm::Constant *getInitThreadAbortFn(CodeGenModule &CGM) {
2349 llvm::FunctionType *FTy =
2350 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2351 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2352 return CGM.CreateRuntimeFunction(
2353 FTy, "_Init_thread_abort",
Reid Klecknerde864822017-03-21 16:57:30 +00002354 llvm::AttributeList::get(CGM.getLLVMContext(),
2355 llvm::AttributeList::FunctionIndex,
2356 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002357 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002358}
2359
2360namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002361struct ResetGuardBit final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002362 Address Guard;
David Majnemer8354eee2015-05-07 06:15:46 +00002363 unsigned GuardNum;
John McCall7f416cc2015-09-08 08:05:57 +00002364 ResetGuardBit(Address Guard, unsigned GuardNum)
David Majnemer8354eee2015-05-07 06:15:46 +00002365 : Guard(Guard), GuardNum(GuardNum) {}
2366
2367 void Emit(CodeGenFunction &CGF, Flags flags) override {
2368 // Reset the bit in the mask so that the static variable may be
2369 // reinitialized.
2370 CGBuilderTy &Builder = CGF.Builder;
2371 llvm::LoadInst *LI = Builder.CreateLoad(Guard);
2372 llvm::ConstantInt *Mask =
Reid Klecknerd16cebe2016-02-10 19:09:15 +00002373 llvm::ConstantInt::get(CGF.IntTy, ~(1ULL << GuardNum));
David Majnemer8354eee2015-05-07 06:15:46 +00002374 Builder.CreateStore(Builder.CreateAnd(LI, Mask), Guard);
2375 }
2376};
2377
David Blaikie7e70d682015-08-18 22:40:54 +00002378struct CallInitThreadAbort final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002379 llvm::Value *Guard;
2380 CallInitThreadAbort(Address Guard) : Guard(Guard.getPointer()) {}
David Majnemer8354eee2015-05-07 06:15:46 +00002381
2382 void Emit(CodeGenFunction &CGF, Flags flags) override {
2383 // Calling _Init_thread_abort will reset the guard's state.
2384 CGF.EmitNounwindRuntimeCall(getInitThreadAbortFn(CGF.CGM), Guard);
2385 }
2386};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002387}
David Majnemer8354eee2015-05-07 06:15:46 +00002388
John McCallc84ed6a2012-05-01 06:13:13 +00002389void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00002390 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00002391 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00002392 // MSVC only uses guards for static locals.
2393 if (!D.isStaticLocal()) {
2394 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2395 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
Rafael Espindola77abc3a2015-01-16 16:04:45 +00002396 llvm::Function *F = CGF.CurFn;
2397 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2398 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
Reid Kleckner563f0e82014-05-23 21:13:45 +00002399 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2400 return;
2401 }
2402
David Majnemerec8e54b2015-05-07 21:19:06 +00002403 bool ThreadlocalStatic = D.getTLSKind();
2404 bool ThreadsafeStatic = getContext().getLangOpts().ThreadsafeStatics;
2405
2406 // Thread-safe static variables which aren't thread-specific have a
2407 // per-variable guard.
2408 bool HasPerVariableGuard = ThreadsafeStatic && !ThreadlocalStatic;
Richard Smithdbf74ba2013-04-14 23:01:42 +00002409
Reid Klecknerd8110b62013-09-10 20:14:30 +00002410 CGBuilderTy &Builder = CGF.Builder;
2411 llvm::IntegerType *GuardTy = CGF.Int32Ty;
2412 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
John McCall7f416cc2015-09-08 08:05:57 +00002413 CharUnits GuardAlign = CharUnits::fromQuantity(4);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002414
2415 // Get the guard variable for this function if we have one already.
David Majnemerec8e54b2015-05-07 21:19:06 +00002416 GuardInfo *GI = nullptr;
2417 if (ThreadlocalStatic)
2418 GI = &ThreadLocalGuardVariableMap[D.getDeclContext()];
2419 else if (!ThreadsafeStatic)
2420 GI = &GuardVariableMap[D.getDeclContext()];
2421
2422 llvm::GlobalVariable *GuardVar = GI ? GI->Guard : nullptr;
David Majnemer8354eee2015-05-07 06:15:46 +00002423 unsigned GuardNum;
David Majnemerec8e54b2015-05-07 21:19:06 +00002424 if (D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002425 // Externally visible variables have to be numbered in Sema to properly
2426 // handle unreachable VarDecls.
David Majnemer8354eee2015-05-07 06:15:46 +00002427 GuardNum = getContext().getStaticLocalNumber(&D);
2428 assert(GuardNum > 0);
2429 GuardNum--;
2430 } else if (HasPerVariableGuard) {
2431 GuardNum = ThreadSafeGuardNumMap[D.getDeclContext()]++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002432 } else {
2433 // Non-externally visible variables are numbered here in CodeGen.
David Majnemer8354eee2015-05-07 06:15:46 +00002434 GuardNum = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002435 }
2436
David Majnemer8354eee2015-05-07 06:15:46 +00002437 if (!HasPerVariableGuard && GuardNum >= 32) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002438 if (D.isExternallyVisible())
2439 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
David Majnemer8354eee2015-05-07 06:15:46 +00002440 GuardNum %= 32;
2441 GuardVar = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002442 }
2443
David Majnemer8354eee2015-05-07 06:15:46 +00002444 if (!GuardVar) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002445 // Mangle the name for the guard.
2446 SmallString<256> GuardName;
2447 {
2448 llvm::raw_svector_ostream Out(GuardName);
David Majnemer8354eee2015-05-07 06:15:46 +00002449 if (HasPerVariableGuard)
2450 getMangleContext().mangleThreadSafeStaticGuardVariable(&D, GuardNum,
2451 Out);
2452 else
2453 getMangleContext().mangleStaticGuardVariable(&D, Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002454 }
2455
Hans Wennborgef2272c2014-06-18 15:55:13 +00002456 // Create the guard variable with a zero-initializer. Just absorb linkage,
2457 // visibility and dll storage class from the guarded variable.
David Majnemer8354eee2015-05-07 06:15:46 +00002458 GuardVar =
2459 new llvm::GlobalVariable(CGM.getModule(), GuardTy, /*isConstant=*/false,
Reid Klecknere9591b32014-04-23 18:22:11 +00002460 GV->getLinkage(), Zero, GuardName.str());
David Majnemer8354eee2015-05-07 06:15:46 +00002461 GuardVar->setVisibility(GV->getVisibility());
2462 GuardVar->setDLLStorageClass(GV->getDLLStorageClass());
John McCall7f416cc2015-09-08 08:05:57 +00002463 GuardVar->setAlignment(GuardAlign.getQuantity());
David Majnemer8354eee2015-05-07 06:15:46 +00002464 if (GuardVar->isWeakForLinker())
2465 GuardVar->setComdat(
2466 CGM.getModule().getOrInsertComdat(GuardVar->getName()));
2467 if (D.getTLSKind())
2468 GuardVar->setThreadLocal(true);
2469 if (GI && !HasPerVariableGuard)
2470 GI->Guard = GuardVar;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002471 }
2472
John McCall7f416cc2015-09-08 08:05:57 +00002473 ConstantAddress GuardAddr(GuardVar, GuardAlign);
2474
David Majnemer8354eee2015-05-07 06:15:46 +00002475 assert(GuardVar->getLinkage() == GV->getLinkage() &&
2476 "static local from the same function had different linkage");
Reid Klecknerd8110b62013-09-10 20:14:30 +00002477
David Majnemer8354eee2015-05-07 06:15:46 +00002478 if (!HasPerVariableGuard) {
2479 // Pseudo code for the test:
2480 // if (!(GuardVar & MyGuardBit)) {
2481 // GuardVar |= MyGuardBit;
2482 // ... initialize the object ...;
2483 // }
Reid Klecknerd8110b62013-09-10 20:14:30 +00002484
David Majnemer8354eee2015-05-07 06:15:46 +00002485 // Test our bit from the guard variable.
Aaron Ballmanabd466e2016-03-30 21:33:34 +00002486 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1ULL << GuardNum);
John McCall7f416cc2015-09-08 08:05:57 +00002487 llvm::LoadInst *LI = Builder.CreateLoad(GuardAddr);
Richard Smithae8d62c2017-07-26 22:01:09 +00002488 llvm::Value *NeedsInit =
2489 Builder.CreateICmpEQ(Builder.CreateAnd(LI, Bit), Zero);
David Majnemer8354eee2015-05-07 06:15:46 +00002490 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2491 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002492 CGF.EmitCXXGuardedInitBranch(NeedsInit, InitBlock, EndBlock,
2493 CodeGenFunction::GuardKind::VariableGuard, &D);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002494
David Majnemer8354eee2015-05-07 06:15:46 +00002495 // Set our bit in the guard variable and emit the initializer and add a global
2496 // destructor if appropriate.
2497 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002498 Builder.CreateStore(Builder.CreateOr(LI, Bit), GuardAddr);
2499 CGF.EHStack.pushCleanup<ResetGuardBit>(EHCleanup, GuardAddr, GuardNum);
David Majnemer8354eee2015-05-07 06:15:46 +00002500 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2501 CGF.PopCleanupBlock();
2502 Builder.CreateBr(EndBlock);
2503
2504 // Continue.
2505 CGF.EmitBlock(EndBlock);
2506 } else {
2507 // Pseudo code for the test:
2508 // if (TSS > _Init_thread_epoch) {
2509 // _Init_thread_header(&TSS);
2510 // if (TSS == -1) {
2511 // ... initialize the object ...;
2512 // _Init_thread_footer(&TSS);
2513 // }
2514 // }
2515 //
2516 // The algorithm is almost identical to what can be found in the appendix
2517 // found in N2325.
2518
David Majnemer8354eee2015-05-07 06:15:46 +00002519 // This BasicBLock determines whether or not we have any work to do.
John McCall7f416cc2015-09-08 08:05:57 +00002520 llvm::LoadInst *FirstGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002521 FirstGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2522 llvm::LoadInst *InitThreadEpoch =
2523 Builder.CreateLoad(getInitThreadEpochPtr(CGM));
2524 llvm::Value *IsUninitialized =
2525 Builder.CreateICmpSGT(FirstGuardLoad, InitThreadEpoch);
2526 llvm::BasicBlock *AttemptInitBlock = CGF.createBasicBlock("init.attempt");
2527 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002528 CGF.EmitCXXGuardedInitBranch(IsUninitialized, AttemptInitBlock, EndBlock,
2529 CodeGenFunction::GuardKind::VariableGuard, &D);
David Majnemer8354eee2015-05-07 06:15:46 +00002530
2531 // This BasicBlock attempts to determine whether or not this thread is
2532 // responsible for doing the initialization.
2533 CGF.EmitBlock(AttemptInitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002534 CGF.EmitNounwindRuntimeCall(getInitThreadHeaderFn(CGM),
2535 GuardAddr.getPointer());
2536 llvm::LoadInst *SecondGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002537 SecondGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2538 llvm::Value *ShouldDoInit =
2539 Builder.CreateICmpEQ(SecondGuardLoad, getAllOnesInt());
2540 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2541 Builder.CreateCondBr(ShouldDoInit, InitBlock, EndBlock);
2542
2543 // Ok, we ended up getting selected as the initializing thread.
2544 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002545 CGF.EHStack.pushCleanup<CallInitThreadAbort>(EHCleanup, GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002546 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2547 CGF.PopCleanupBlock();
John McCall7f416cc2015-09-08 08:05:57 +00002548 CGF.EmitNounwindRuntimeCall(getInitThreadFooterFn(CGM),
2549 GuardAddr.getPointer());
David Majnemer8354eee2015-05-07 06:15:46 +00002550 Builder.CreateBr(EndBlock);
2551
2552 CGF.EmitBlock(EndBlock);
2553 }
John McCallc84ed6a2012-05-01 06:13:13 +00002554}
2555
Reid Kleckner2341ae32013-04-11 18:13:19 +00002556bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2557 // Null-ness for function memptrs only depends on the first field, which is
2558 // the function pointer. The rest don't matter, so we can zero initialize.
2559 if (MPT->isMemberFunctionPointer())
2560 return true;
2561
2562 // The virtual base adjustment field is always -1 for null, so if we have one
2563 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
2564 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002565 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2566 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002567 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
2568 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00002569}
2570
2571llvm::Type *
2572MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002573 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2574 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002575 llvm::SmallVector<llvm::Type *, 4> fields;
2576 if (MPT->isMemberFunctionPointer())
2577 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
2578 else
2579 fields.push_back(CGM.IntTy); // FieldOffset
2580
Reid Kleckner96f8f932014-02-05 17:27:08 +00002581 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2582 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002583 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002584 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002585 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002586 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002587 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
2588
2589 if (fields.size() == 1)
2590 return fields[0];
2591 return llvm::StructType::get(CGM.getLLVMContext(), fields);
2592}
2593
2594void MicrosoftCXXABI::
2595GetNullMemberPointerFields(const MemberPointerType *MPT,
2596 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2597 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00002598 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2599 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002600 if (MPT->isMemberFunctionPointer()) {
2601 // FunctionPointerOrVirtualThunk
2602 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2603 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00002604 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00002605 fields.push_back(getZeroInt()); // FieldOffset
2606 else
2607 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00002608 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00002609
Reid Kleckner96f8f932014-02-05 17:27:08 +00002610 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2611 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002612 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002613 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002614 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002615 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002616 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002617}
2618
2619llvm::Constant *
2620MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002621 llvm::SmallVector<llvm::Constant *, 4> fields;
2622 GetNullMemberPointerFields(MPT, fields);
2623 if (fields.size() == 1)
2624 return fields[0];
2625 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2626 assert(Res->getType() == ConvertMemberPointerType(MPT));
2627 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002628}
2629
2630llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002631MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2632 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00002633 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +00002634 CharUnits NonVirtualBaseAdjustment,
2635 unsigned VBTableIndex) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002636 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002637
2638 // Single inheritance class member pointer are represented as scalars instead
2639 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002640 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002641 return FirstField;
2642
Reid Kleckner2341ae32013-04-11 18:13:19 +00002643 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002644 fields.push_back(FirstField);
2645
Reid Kleckner96f8f932014-02-05 17:27:08 +00002646 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002647 fields.push_back(llvm::ConstantInt::get(
2648 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002649
Reid Kleckner96f8f932014-02-05 17:27:08 +00002650 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00002651 CharUnits Offs = CharUnits::Zero();
David Majnemerc1709d32015-06-23 07:31:11 +00002652 if (VBTableIndex)
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002653 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00002654 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00002655 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002656
2657 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002658 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
David Majnemere60813f2015-05-10 21:48:08 +00002659 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, VBTableIndex));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002660
Reid Kleckner2341ae32013-04-11 18:13:19 +00002661 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002662}
2663
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002664llvm::Constant *
2665MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2666 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002667 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerc1709d32015-06-23 07:31:11 +00002668 if (RD->getMSInheritanceModel() ==
2669 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002670 offset -= getContext().getOffsetOfBaseWithVBPtr(RD);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002671 llvm::Constant *FirstField =
2672 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00002673 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002674 CharUnits::Zero(), /*VBTableIndex=*/0);
Reid Kleckner452abac2013-05-09 21:01:17 +00002675}
2676
Reid Kleckner452abac2013-05-09 21:01:17 +00002677llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2678 QualType MPType) {
David Majnemer5ca193c2015-06-23 07:31:07 +00002679 const MemberPointerType *DstTy = MPType->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002680 const ValueDecl *MPD = MP.getMemberPointerDecl();
2681 if (!MPD)
David Majnemer5ca193c2015-06-23 07:31:07 +00002682 return EmitNullMemberPointer(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002683
David Majnemer5ca193c2015-06-23 07:31:07 +00002684 ASTContext &Ctx = getContext();
2685 ArrayRef<const CXXRecordDecl *> MemberPointerPath = MP.getMemberPointerPath();
Reid Kleckner452abac2013-05-09 21:01:17 +00002686
David Majnemer5ca193c2015-06-23 07:31:07 +00002687 llvm::Constant *C;
2688 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) {
2689 C = EmitMemberFunctionPointer(MD);
2690 } else {
2691 CharUnits FieldOffset = Ctx.toCharUnitsFromBits(Ctx.getFieldOffset(MPD));
2692 C = EmitMemberDataPointer(DstTy, FieldOffset);
2693 }
Reid Kleckner452abac2013-05-09 21:01:17 +00002694
David Majnemer5ca193c2015-06-23 07:31:07 +00002695 if (!MemberPointerPath.empty()) {
2696 const CXXRecordDecl *SrcRD = cast<CXXRecordDecl>(MPD->getDeclContext());
2697 const Type *SrcRecTy = Ctx.getTypeDeclType(SrcRD).getTypePtr();
2698 const MemberPointerType *SrcTy =
2699 Ctx.getMemberPointerType(DstTy->getPointeeType(), SrcRecTy)
2700 ->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002701
David Majnemer5ca193c2015-06-23 07:31:07 +00002702 bool DerivedMember = MP.isMemberPointerToDerivedMember();
2703 SmallVector<const CXXBaseSpecifier *, 4> DerivedToBasePath;
2704 const CXXRecordDecl *PrevRD = SrcRD;
2705 for (const CXXRecordDecl *PathElem : MemberPointerPath) {
2706 const CXXRecordDecl *Base = nullptr;
2707 const CXXRecordDecl *Derived = nullptr;
2708 if (DerivedMember) {
2709 Base = PathElem;
2710 Derived = PrevRD;
2711 } else {
2712 Base = PrevRD;
2713 Derived = PathElem;
2714 }
2715 for (const CXXBaseSpecifier &BS : Derived->bases())
2716 if (BS.getType()->getAsCXXRecordDecl()->getCanonicalDecl() ==
2717 Base->getCanonicalDecl())
2718 DerivedToBasePath.push_back(&BS);
2719 PrevRD = PathElem;
2720 }
2721 assert(DerivedToBasePath.size() == MemberPointerPath.size());
2722
2723 CastKind CK = DerivedMember ? CK_DerivedToBaseMemberPointer
2724 : CK_BaseToDerivedMemberPointer;
2725 C = EmitMemberPointerConversion(SrcTy, DstTy, CK, DerivedToBasePath.begin(),
2726 DerivedToBasePath.end(), C);
2727 }
2728 return C;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002729}
2730
2731llvm::Constant *
David Majnemer5ca193c2015-06-23 07:31:07 +00002732MicrosoftCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002733 assert(MD->isInstance() && "Member function must not be static!");
David Majnemer5ca193c2015-06-23 07:31:07 +00002734
David Majnemer5ca193c2015-06-23 07:31:07 +00002735 CharUnits NonVirtualBaseAdjustment = CharUnits::Zero();
Reid Kleckner26fc5312018-05-31 18:42:29 +00002736 const CXXRecordDecl *RD = MD->getParent()->getMostRecentNonInjectedDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002737 CodeGenTypes &Types = CGM.getTypes();
2738
David Majnemere60813f2015-05-10 21:48:08 +00002739 unsigned VBTableIndex = 0;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002740 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00002741 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00002742 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002743 llvm::Type *Ty;
2744 // Check whether the function has a computable LLVM signature.
2745 if (Types.isFuncTypeConvertible(FPT)) {
2746 // The function has a computable LLVM signature; use the correct type.
2747 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2748 } else {
2749 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2750 // function type is incomplete.
2751 Ty = CGM.PtrDiffTy;
2752 }
2753 FirstField = CGM.GetAddrOfFunction(MD, Ty);
Hans Wennborg88497d62013-11-15 17:24:45 +00002754 } else {
David Majnemere0e228a2015-06-11 08:12:44 +00002755 auto &VTableContext = CGM.getMicrosoftVTableContext();
Reid Klecknercbec0262018-04-02 20:00:39 +00002756 MethodVFTableLocation ML = VTableContext.getMethodVFTableLocation(MD);
David Majnemerc1709d32015-06-23 07:31:11 +00002757 FirstField = EmitVirtualMemPtrThunk(MD, ML);
David Majnemere0e228a2015-06-11 08:12:44 +00002758 // Include the vfptr adjustment if the method is in a non-primary vftable.
2759 NonVirtualBaseAdjustment += ML.VFPtrOffset;
2760 if (ML.VBase)
2761 VBTableIndex = VTableContext.getVBTableIndex(RD, ML.VBase) * 4;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002762 }
2763
David Majnemerc1709d32015-06-23 07:31:11 +00002764 if (VBTableIndex == 0 &&
2765 RD->getMSInheritanceModel() ==
2766 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002767 NonVirtualBaseAdjustment -= getContext().getOffsetOfBaseWithVBPtr(RD);
David Majnemerc1709d32015-06-23 07:31:11 +00002768
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002769 // The rest of the fields are common with data member pointers.
David Majnemerc1709d32015-06-23 07:31:11 +00002770 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002771 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002772 NonVirtualBaseAdjustment, VBTableIndex);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002773}
2774
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002775/// Member pointers are the same if they're either bitwise identical *or* both
2776/// null. Null-ness for function members is determined by the first field,
2777/// while for data member pointers we must compare all fields.
2778llvm::Value *
2779MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2780 llvm::Value *L,
2781 llvm::Value *R,
2782 const MemberPointerType *MPT,
2783 bool Inequality) {
2784 CGBuilderTy &Builder = CGF.Builder;
2785
2786 // Handle != comparisons by switching the sense of all boolean operations.
2787 llvm::ICmpInst::Predicate Eq;
2788 llvm::Instruction::BinaryOps And, Or;
2789 if (Inequality) {
2790 Eq = llvm::ICmpInst::ICMP_NE;
2791 And = llvm::Instruction::Or;
2792 Or = llvm::Instruction::And;
2793 } else {
2794 Eq = llvm::ICmpInst::ICMP_EQ;
2795 And = llvm::Instruction::And;
2796 Or = llvm::Instruction::Or;
2797 }
2798
2799 // If this is a single field member pointer (single inheritance), this is a
2800 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002801 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2802 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002803 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2804 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002805 return Builder.CreateICmp(Eq, L, R);
2806
2807 // Compare the first field.
2808 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2809 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2810 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2811
2812 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002813 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002814 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2815 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2816 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2817 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2818 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2819 if (Res)
2820 Res = Builder.CreateBinOp(And, Res, Cmp);
2821 else
2822 Res = Cmp;
2823 }
2824
2825 // Check if the first field is 0 if this is a function pointer.
2826 if (MPT->isMemberFunctionPointer()) {
2827 // (l1 == r1 && ...) || l0 == 0
2828 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2829 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2830 Res = Builder.CreateBinOp(Or, Res, IsZero);
2831 }
2832
2833 // Combine the comparison of the first field, which must always be true for
2834 // this comparison to succeeed.
2835 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2836}
2837
Reid Kleckner407e8b62013-03-22 19:02:54 +00002838llvm::Value *
2839MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2840 llvm::Value *MemPtr,
2841 const MemberPointerType *MPT) {
2842 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002843 llvm::SmallVector<llvm::Constant *, 4> fields;
2844 // We only need one field for member functions.
2845 if (MPT->isMemberFunctionPointer())
2846 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2847 else
2848 GetNullMemberPointerFields(MPT, fields);
2849 assert(!fields.empty());
2850 llvm::Value *FirstField = MemPtr;
2851 if (MemPtr->getType()->isStructTy())
2852 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2853 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002854
Reid Kleckner2341ae32013-04-11 18:13:19 +00002855 // For function member pointers, we only need to test the function pointer
2856 // field. The other fields if any can be garbage.
2857 if (MPT->isMemberFunctionPointer())
2858 return Res;
2859
2860 // Otherwise, emit a series of compares and combine the results.
2861 for (int I = 1, E = fields.size(); I < E; ++I) {
2862 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2863 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002864 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002865 }
2866 return Res;
2867}
2868
Reid Kleckner452abac2013-05-09 21:01:17 +00002869bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2870 llvm::Constant *Val) {
2871 // Function pointers are null if the pointer in the first field is null.
2872 if (MPT->isMemberFunctionPointer()) {
2873 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2874 Val->getAggregateElement(0U) : Val;
2875 return FirstField->isNullValue();
2876 }
2877
2878 // If it's not a function pointer and it's zero initializable, we can easily
2879 // check zero.
2880 if (isZeroInitializable(MPT) && Val->isNullValue())
2881 return true;
2882
2883 // Otherwise, break down all the fields for comparison. Hopefully these
2884 // little Constants are reused, while a big null struct might not be.
2885 llvm::SmallVector<llvm::Constant *, 4> Fields;
2886 GetNullMemberPointerFields(MPT, Fields);
2887 if (Fields.size() == 1) {
2888 assert(Val->getType()->isIntegerTy());
2889 return Val == Fields[0];
2890 }
2891
2892 unsigned I, E;
2893 for (I = 0, E = Fields.size(); I != E; ++I) {
2894 if (Val->getAggregateElement(I) != Fields[I])
2895 break;
2896 }
2897 return I == E;
2898}
2899
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002900llvm::Value *
2901MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002902 Address This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002903 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002904 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002905 llvm::Value **VBPtrOut) {
2906 CGBuilderTy &Builder = CGF.Builder;
2907 // Load the vbtable pointer from the vbptr in the instance.
John McCall7f416cc2015-09-08 08:05:57 +00002908 This = Builder.CreateElementBitCast(This, CGM.Int8Ty);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002909 llvm::Value *VBPtr =
John McCall7f416cc2015-09-08 08:05:57 +00002910 Builder.CreateInBoundsGEP(This.getPointer(), VBPtrOffset, "vbptr");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002911 if (VBPtrOut) *VBPtrOut = VBPtr;
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002912 VBPtr = Builder.CreateBitCast(VBPtr,
John McCall7f416cc2015-09-08 08:05:57 +00002913 CGM.Int32Ty->getPointerTo(0)->getPointerTo(This.getAddressSpace()));
2914
2915 CharUnits VBPtrAlign;
2916 if (auto CI = dyn_cast<llvm::ConstantInt>(VBPtrOffset)) {
2917 VBPtrAlign = This.getAlignment().alignmentAtOffset(
2918 CharUnits::fromQuantity(CI->getSExtValue()));
2919 } else {
2920 VBPtrAlign = CGF.getPointerAlign();
2921 }
2922
2923 llvm::Value *VBTable = Builder.CreateAlignedLoad(VBPtr, VBPtrAlign, "vbtable");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002924
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002925 // Translate from byte offset to table index. It improves analyzability.
2926 llvm::Value *VBTableIndex = Builder.CreateAShr(
2927 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
2928 "vbtindex", /*isExact=*/true);
2929
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002930 // Load an i32 offset from the vb-table.
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002931 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002932 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
John McCall7f416cc2015-09-08 08:05:57 +00002933 return Builder.CreateAlignedLoad(VBaseOffs, CharUnits::fromQuantity(4),
2934 "vbase_offs");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002935}
2936
Reid Kleckner2341ae32013-04-11 18:13:19 +00002937// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2938// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002939llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2940 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
John McCall7f416cc2015-09-08 08:05:57 +00002941 Address Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002942 CGBuilderTy &Builder = CGF.Builder;
John McCall7f416cc2015-09-08 08:05:57 +00002943 Base = Builder.CreateElementBitCast(Base, CGM.Int8Ty);
Craig Topper8a13c412014-05-21 05:09:00 +00002944 llvm::BasicBlock *OriginalBB = nullptr;
2945 llvm::BasicBlock *SkipAdjustBB = nullptr;
2946 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002947
2948 // In the unspecified inheritance model, there might not be a vbtable at all,
2949 // in which case we need to skip the virtual base lookup. If there is a
2950 // vbtable, the first entry is a no-op entry that gives back the original
2951 // base, so look for a virtual base adjustment offset of zero.
2952 if (VBPtrOffset) {
2953 OriginalBB = Builder.GetInsertBlock();
2954 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2955 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2956 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002957 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002958 "memptr.is_vbase");
2959 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2960 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002961 }
2962
Reid Kleckner2341ae32013-04-11 18:13:19 +00002963 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
2964 // know the vbptr offset.
2965 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002966 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00002967 if (!RD->hasDefinition()) {
2968 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
2969 unsigned DiagID = Diags.getCustomDiagID(
2970 DiagnosticsEngine::Error,
2971 "member pointer representation requires a "
2972 "complete class type for %0 to perform this expression");
2973 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
2974 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002975 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002976 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
2977 }
Craig Topper8a13c412014-05-21 05:09:00 +00002978 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002979 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002980 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002981 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
2982
2983 // Merge control flow with the case where we didn't have to adjust.
2984 if (VBaseAdjustBB) {
2985 Builder.CreateBr(SkipAdjustBB);
2986 CGF.EmitBlock(SkipAdjustBB);
2987 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
John McCall7f416cc2015-09-08 08:05:57 +00002988 Phi->addIncoming(Base.getPointer(), OriginalBB);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002989 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
2990 return Phi;
2991 }
2992 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002993}
2994
David Majnemer2b0d66d2014-02-20 23:22:07 +00002995llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
John McCall7f416cc2015-09-08 08:05:57 +00002996 CodeGenFunction &CGF, const Expr *E, Address Base, llvm::Value *MemPtr,
David Majnemer2b0d66d2014-02-20 23:22:07 +00002997 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002998 assert(MPT->isMemberDataPointer());
John McCall7f416cc2015-09-08 08:05:57 +00002999 unsigned AS = Base.getAddressSpace();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003000 llvm::Type *PType =
3001 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
3002 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003003 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
3004 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003005
Reid Kleckner2341ae32013-04-11 18:13:19 +00003006 // Extract the fields we need, regardless of model. We'll apply them if we
3007 // have them.
3008 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003009 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3010 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003011 if (MemPtr->getType()->isStructTy()) {
3012 // We need to extract values.
3013 unsigned I = 0;
3014 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003015 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003016 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003017 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003018 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00003019 }
3020
John McCall7f416cc2015-09-08 08:05:57 +00003021 llvm::Value *Addr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003022 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003023 Addr = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00003024 VBPtrOffset);
John McCall7f416cc2015-09-08 08:05:57 +00003025 } else {
3026 Addr = Base.getPointer();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003027 }
Reid Klecknerae945122013-12-05 22:44:07 +00003028
3029 // Cast to char*.
John McCall7f416cc2015-09-08 08:05:57 +00003030 Addr = Builder.CreateBitCast(Addr, CGF.Int8Ty->getPointerTo(AS));
Reid Klecknerae945122013-12-05 22:44:07 +00003031
3032 // Apply the offset, which we assume is non-null.
John McCall7f416cc2015-09-08 08:05:57 +00003033 Addr = Builder.CreateInBoundsGEP(Addr, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00003034
3035 // Cast the address to the appropriate pointer type, adopting the address
3036 // space of the base pointer.
3037 return Builder.CreateBitCast(Addr, PType);
3038}
3039
Reid Kleckner452abac2013-05-09 21:01:17 +00003040llvm::Value *
3041MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
3042 const CastExpr *E,
3043 llvm::Value *Src) {
3044 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
3045 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
3046 E->getCastKind() == CK_ReinterpretMemberPointer);
3047
3048 // Use constant emission if we can.
3049 if (isa<llvm::Constant>(Src))
3050 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
3051
3052 // We may be adding or dropping fields from the member pointer, so we need
3053 // both types and the inheritance models of both records.
3054 const MemberPointerType *SrcTy =
3055 E->getSubExpr()->getType()->castAs<MemberPointerType>();
3056 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003057 bool IsFunc = SrcTy->isMemberFunctionPointer();
3058
3059 // If the classes use the same null representation, reinterpret_cast is a nop.
3060 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003061 if (IsReinterpret && IsFunc)
3062 return Src;
3063
3064 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3065 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3066 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00003067 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00003068 return Src;
3069
3070 CGBuilderTy &Builder = CGF.Builder;
3071
3072 // Branch past the conversion if Src is null.
3073 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
3074 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
3075
3076 // C++ 5.2.10p9: The null member pointer value is converted to the null member
3077 // pointer value of the destination type.
3078 if (IsReinterpret) {
3079 // For reinterpret casts, sema ensures that src and dst are both functions
3080 // or data and have the same size, which means the LLVM types should match.
3081 assert(Src->getType() == DstNull->getType());
3082 return Builder.CreateSelect(IsNotNull, Src, DstNull);
3083 }
3084
3085 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
3086 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
3087 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
3088 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
3089 CGF.EmitBlock(ConvertBB);
3090
David Majnemer0d9ad682015-06-29 00:06:50 +00003091 llvm::Value *Dst = EmitNonNullMemberPointerConversion(
3092 SrcTy, DstTy, E->getCastKind(), E->path_begin(), E->path_end(), Src,
3093 Builder);
3094
3095 Builder.CreateBr(ContinueBB);
3096
3097 // In the continuation, choose between DstNull and Dst.
3098 CGF.EmitBlock(ContinueBB);
3099 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
3100 Phi->addIncoming(DstNull, OriginalBB);
3101 Phi->addIncoming(Dst, ConvertBB);
3102 return Phi;
3103}
3104
3105llvm::Value *MicrosoftCXXABI::EmitNonNullMemberPointerConversion(
3106 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3107 CastExpr::path_const_iterator PathBegin,
3108 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
3109 CGBuilderTy &Builder) {
3110 const CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3111 const CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3112 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
3113 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
3114 bool IsFunc = SrcTy->isMemberFunctionPointer();
3115 bool IsConstant = isa<llvm::Constant>(Src);
3116
Reid Kleckner452abac2013-05-09 21:01:17 +00003117 // Decompose src.
3118 llvm::Value *FirstField = Src;
David Majnemerc1709d32015-06-23 07:31:11 +00003119 llvm::Value *NonVirtualBaseAdjustment = getZeroInt();
3120 llvm::Value *VirtualBaseAdjustmentOffset = getZeroInt();
3121 llvm::Value *VBPtrOffset = getZeroInt();
Reid Kleckner96f8f932014-02-05 17:27:08 +00003122 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003123 // We need to extract values.
3124 unsigned I = 0;
3125 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003126 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003127 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003128 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003129 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003130 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003131 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
3132 }
3133
David Majnemer0d9ad682015-06-29 00:06:50 +00003134 bool IsDerivedToBase = (CK == CK_DerivedToBaseMemberPointer);
David Majnemerc1709d32015-06-23 07:31:11 +00003135 const MemberPointerType *DerivedTy = IsDerivedToBase ? SrcTy : DstTy;
3136 const CXXRecordDecl *DerivedClass = DerivedTy->getMostRecentCXXRecordDecl();
3137
Reid Kleckner452abac2013-05-09 21:01:17 +00003138 // For data pointers, we adjust the field offset directly. For functions, we
3139 // have a separate field.
David Majnemerc1709d32015-06-23 07:31:11 +00003140 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
3141
3142 // The virtual inheritance model has a quirk: the virtual base table is always
3143 // referenced when dereferencing a member pointer even if the member pointer
3144 // is non-virtual. This is accounted for by adjusting the non-virtual offset
3145 // to point backwards to the top of the MDC from the first VBase. Undo this
3146 // adjustment to normalize the member pointer.
3147 llvm::Value *SrcVBIndexEqZero =
3148 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3149 if (SrcInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3150 if (int64_t SrcOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003151 getContext().getOffsetOfBaseWithVBPtr(SrcRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003152 llvm::Value *UndoSrcAdjustment = Builder.CreateSelect(
3153 SrcVBIndexEqZero,
3154 llvm::ConstantInt::get(CGM.IntTy, SrcOffsetToFirstVBase),
3155 getZeroInt());
3156 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, UndoSrcAdjustment);
3157 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003158 }
3159
David Majnemerc1709d32015-06-23 07:31:11 +00003160 // A non-zero vbindex implies that we are dealing with a source member in a
3161 // floating virtual base in addition to some non-virtual offset. If the
3162 // vbindex is zero, we are dealing with a source that exists in a non-virtual,
3163 // fixed, base. The difference between these two cases is that the vbindex +
3164 // nvoffset *always* point to the member regardless of what context they are
3165 // evaluated in so long as the vbindex is adjusted. A member inside a fixed
3166 // base requires explicit nv adjustment.
3167 llvm::Constant *BaseClassOffset = llvm::ConstantInt::get(
David Majnemer0d9ad682015-06-29 00:06:50 +00003168 CGM.IntTy,
3169 CGM.computeNonVirtualBaseClassOffset(DerivedClass, PathBegin, PathEnd)
3170 .getQuantity());
David Majnemerc1709d32015-06-23 07:31:11 +00003171
3172 llvm::Value *NVDisp;
3173 if (IsDerivedToBase)
3174 NVDisp = Builder.CreateNSWSub(NVAdjustField, BaseClassOffset, "adj");
3175 else
3176 NVDisp = Builder.CreateNSWAdd(NVAdjustField, BaseClassOffset, "adj");
3177
3178 NVAdjustField = Builder.CreateSelect(SrcVBIndexEqZero, NVDisp, getZeroInt());
3179
3180 // Update the vbindex to an appropriate value in the destination because
3181 // SrcRD's vbtable might not be a strict prefix of the one in DstRD.
3182 llvm::Value *DstVBIndexEqZero = SrcVBIndexEqZero;
3183 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance) &&
3184 MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance)) {
3185 if (llvm::GlobalVariable *VDispMap =
3186 getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) {
3187 llvm::Value *VBIndex = Builder.CreateExactUDiv(
3188 VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003189 if (IsConstant) {
3190 llvm::Constant *Mapping = VDispMap->getInitializer();
3191 VirtualBaseAdjustmentOffset =
3192 Mapping->getAggregateElement(cast<llvm::Constant>(VBIndex));
3193 } else {
3194 llvm::Value *Idxs[] = {getZeroInt(), VBIndex};
3195 VirtualBaseAdjustmentOffset =
John McCall7f416cc2015-09-08 08:05:57 +00003196 Builder.CreateAlignedLoad(Builder.CreateInBoundsGEP(VDispMap, Idxs),
3197 CharUnits::fromQuantity(4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003198 }
David Majnemerc1709d32015-06-23 07:31:11 +00003199
3200 DstVBIndexEqZero =
3201 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3202 }
3203 }
3204
3205 // Set the VBPtrOffset to zero if the vbindex is zero. Otherwise, initialize
3206 // it to the offset of the vbptr.
3207 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance)) {
3208 llvm::Value *DstVBPtrOffset = llvm::ConstantInt::get(
3209 CGM.IntTy,
3210 getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity());
3211 VBPtrOffset =
3212 Builder.CreateSelect(DstVBIndexEqZero, getZeroInt(), DstVBPtrOffset);
3213 }
3214
3215 // Likewise, apply a similar adjustment so that dereferencing the member
3216 // pointer correctly accounts for the distance between the start of the first
3217 // virtual base and the top of the MDC.
3218 if (DstInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3219 if (int64_t DstOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003220 getContext().getOffsetOfBaseWithVBPtr(DstRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003221 llvm::Value *DoDstAdjustment = Builder.CreateSelect(
3222 DstVBIndexEqZero,
3223 llvm::ConstantInt::get(CGM.IntTy, DstOffsetToFirstVBase),
3224 getZeroInt());
3225 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, DoDstAdjustment);
3226 }
3227 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003228
3229 // Recompose dst from the null struct and the adjusted fields from src.
3230 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00003231 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003232 Dst = FirstField;
3233 } else {
David Majnemer0d9ad682015-06-29 00:06:50 +00003234 Dst = llvm::UndefValue::get(ConvertMemberPointerType(DstTy));
Reid Kleckner452abac2013-05-09 21:01:17 +00003235 unsigned Idx = 0;
3236 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003237 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003238 Dst = Builder.CreateInsertValue(Dst, NonVirtualBaseAdjustment, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003239 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003240 Dst = Builder.CreateInsertValue(Dst, VBPtrOffset, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003241 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003242 Dst = Builder.CreateInsertValue(Dst, VirtualBaseAdjustmentOffset, Idx++);
Reid Kleckner452abac2013-05-09 21:01:17 +00003243 }
David Majnemer0d9ad682015-06-29 00:06:50 +00003244 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003245}
3246
3247llvm::Constant *
3248MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
3249 llvm::Constant *Src) {
3250 const MemberPointerType *SrcTy =
David Majnemer5ca193c2015-06-23 07:31:07 +00003251 E->getSubExpr()->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003252 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3253
David Majnemer5ca193c2015-06-23 07:31:07 +00003254 CastKind CK = E->getCastKind();
3255
3256 return EmitMemberPointerConversion(SrcTy, DstTy, CK, E->path_begin(),
3257 E->path_end(), Src);
3258}
3259
3260llvm::Constant *MicrosoftCXXABI::EmitMemberPointerConversion(
3261 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3262 CastExpr::path_const_iterator PathBegin,
3263 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src) {
3264 assert(CK == CK_DerivedToBaseMemberPointer ||
3265 CK == CK_BaseToDerivedMemberPointer ||
3266 CK == CK_ReinterpretMemberPointer);
Reid Kleckner452abac2013-05-09 21:01:17 +00003267 // If src is null, emit a new null for dst. We can't return src because dst
3268 // might have a new representation.
3269 if (MemberPointerConstantIsNull(SrcTy, Src))
3270 return EmitNullMemberPointer(DstTy);
3271
3272 // We don't need to do anything for reinterpret_casts of non-null member
3273 // pointers. We should only get here when the two type representations have
3274 // the same size.
David Majnemer5ca193c2015-06-23 07:31:07 +00003275 if (CK == CK_ReinterpretMemberPointer)
Reid Kleckner452abac2013-05-09 21:01:17 +00003276 return Src;
3277
John McCall7f416cc2015-09-08 08:05:57 +00003278 CGBuilderTy Builder(CGM, CGM.getLLVMContext());
David Majnemer0d9ad682015-06-29 00:06:50 +00003279 auto *Dst = cast<llvm::Constant>(EmitNonNullMemberPointerConversion(
3280 SrcTy, DstTy, CK, PathBegin, PathEnd, Src, Builder));
Reid Kleckner452abac2013-05-09 21:01:17 +00003281
David Majnemer0d9ad682015-06-29 00:06:50 +00003282 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003283}
3284
John McCallb92ab1a2016-10-26 23:46:34 +00003285CGCallee MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
John McCall7f416cc2015-09-08 08:05:57 +00003286 CodeGenFunction &CGF, const Expr *E, Address This,
3287 llvm::Value *&ThisPtrForCall, llvm::Value *MemPtr,
3288 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003289 assert(MPT->isMemberFunctionPointer());
3290 const FunctionProtoType *FPT =
3291 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00003292 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003293 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(
3294 CGM.getTypes().arrangeCXXMethodType(RD, FPT, /*FD=*/nullptr));
Reid Kleckner2341ae32013-04-11 18:13:19 +00003295 CGBuilderTy &Builder = CGF.Builder;
3296
David Majnemer1cdd96d2014-01-17 09:01:00 +00003297 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003298
3299 // Extract the fields we need, regardless of model. We'll apply them if we
3300 // have them.
3301 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003302 llvm::Value *NonVirtualBaseAdjustment = nullptr;
3303 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3304 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003305 if (MemPtr->getType()->isStructTy()) {
3306 // We need to extract values.
3307 unsigned I = 0;
3308 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003309 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003310 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003311 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00003312 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003313 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003314 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3315 }
3316
3317 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003318 ThisPtrForCall = AdjustVirtualBase(CGF, E, RD, This,
3319 VirtualBaseAdjustmentOffset, VBPtrOffset);
3320 } else {
3321 ThisPtrForCall = This.getPointer();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003322 }
3323
3324 if (NonVirtualBaseAdjustment) {
3325 // Apply the adjustment and cast back to the original struct type.
John McCall7f416cc2015-09-08 08:05:57 +00003326 llvm::Value *Ptr = Builder.CreateBitCast(ThisPtrForCall, CGF.Int8PtrTy);
Reid Kleckner2341ae32013-04-11 18:13:19 +00003327 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
John McCall7f416cc2015-09-08 08:05:57 +00003328 ThisPtrForCall = Builder.CreateBitCast(Ptr, ThisPtrForCall->getType(),
3329 "this.adjusted");
Reid Kleckner2341ae32013-04-11 18:13:19 +00003330 }
3331
John McCallb92ab1a2016-10-26 23:46:34 +00003332 FunctionPointer =
3333 Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
3334 CGCallee Callee(FPT, FunctionPointer);
3335 return Callee;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003336}
3337
Charles Davis53c59df2010-08-16 03:33:14 +00003338CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00003339 return new MicrosoftCXXABI(CGM);
3340}
David Majnemere2cb8d12014-07-07 06:20:47 +00003341
3342// MS RTTI Overview:
3343// The run time type information emitted by cl.exe contains 5 distinct types of
3344// structures. Many of them reference each other.
3345//
3346// TypeInfo: Static classes that are returned by typeid.
3347//
3348// CompleteObjectLocator: Referenced by vftables. They contain information
3349// required for dynamic casting, including OffsetFromTop. They also contain
3350// a reference to the TypeInfo for the type and a reference to the
3351// CompleteHierarchyDescriptor for the type.
3352//
3353// ClassHieararchyDescriptor: Contains information about a class hierarchy.
3354// Used during dynamic_cast to walk a class hierarchy. References a base
3355// class array and the size of said array.
3356//
3357// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
3358// somewhat of a misnomer because the most derived class is also in the list
3359// as well as multiple copies of virtual bases (if they occur multiple times
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003360// in the hierarchy.) The BaseClassArray contains one BaseClassDescriptor for
David Majnemere2cb8d12014-07-07 06:20:47 +00003361// every path in the hierarchy, in pre-order depth first order. Note, we do
3362// not declare a specific llvm type for BaseClassArray, it's merely an array
3363// of BaseClassDescriptor pointers.
3364//
3365// BaseClassDescriptor: Contains information about a class in a class hierarchy.
3366// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
3367// BaseClassArray is. It contains information about a class within a
3368// hierarchy such as: is this base is ambiguous and what is its offset in the
3369// vbtable. The names of the BaseClassDescriptors have all of their fields
3370// mangled into them so they can be aggressively deduplicated by the linker.
3371
David Majnemere2cb8d12014-07-07 06:20:47 +00003372static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
Reid Klecknerfb931542018-03-16 20:36:49 +00003373 StringRef MangledName("??_7type_info@@6B@");
David Majnemere2cb8d12014-07-07 06:20:47 +00003374 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
3375 return VTable;
3376 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
3377 /*Constant=*/true,
3378 llvm::GlobalVariable::ExternalLinkage,
3379 /*Initializer=*/nullptr, MangledName);
3380}
3381
3382namespace {
3383
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003384/// A Helper struct that stores information about a class in a class
David Majnemere2cb8d12014-07-07 06:20:47 +00003385/// hierarchy. The information stored in these structs struct is used during
3386/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
3387// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
3388// implicit depth first pre-order tree connectivity. getFirstChild and
3389// getNextSibling allow us to walk the tree efficiently.
3390struct MSRTTIClass {
3391 enum {
3392 IsPrivateOnPath = 1 | 8,
3393 IsAmbiguous = 2,
3394 IsPrivate = 4,
3395 IsVirtual = 16,
3396 HasHierarchyDescriptor = 64
3397 };
3398 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
3399 uint32_t initialize(const MSRTTIClass *Parent,
3400 const CXXBaseSpecifier *Specifier);
3401
3402 MSRTTIClass *getFirstChild() { return this + 1; }
3403 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
3404 return Child + 1 + Child->NumBases;
3405 }
3406
3407 const CXXRecordDecl *RD, *VirtualRoot;
3408 uint32_t Flags, NumBases, OffsetInVBase;
3409};
3410
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003411/// Recursively initialize the base class array.
David Majnemere2cb8d12014-07-07 06:20:47 +00003412uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
3413 const CXXBaseSpecifier *Specifier) {
3414 Flags = HasHierarchyDescriptor;
3415 if (!Parent) {
3416 VirtualRoot = nullptr;
3417 OffsetInVBase = 0;
3418 } else {
3419 if (Specifier->getAccessSpecifier() != AS_public)
3420 Flags |= IsPrivate | IsPrivateOnPath;
3421 if (Specifier->isVirtual()) {
3422 Flags |= IsVirtual;
3423 VirtualRoot = RD;
3424 OffsetInVBase = 0;
3425 } else {
3426 if (Parent->Flags & IsPrivateOnPath)
3427 Flags |= IsPrivateOnPath;
3428 VirtualRoot = Parent->VirtualRoot;
3429 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
3430 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
3431 }
3432 }
3433 NumBases = 0;
3434 MSRTTIClass *Child = getFirstChild();
3435 for (const CXXBaseSpecifier &Base : RD->bases()) {
3436 NumBases += Child->initialize(this, &Base) + 1;
3437 Child = getNextChild(Child);
3438 }
3439 return NumBases;
3440}
3441
3442static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
3443 switch (Ty->getLinkage()) {
3444 case NoLinkage:
3445 case InternalLinkage:
3446 case UniqueExternalLinkage:
3447 return llvm::GlobalValue::InternalLinkage;
3448
3449 case VisibleNoLinkage:
Richard Smith1283e982017-07-07 20:04:28 +00003450 case ModuleInternalLinkage:
3451 case ModuleLinkage:
David Majnemere2cb8d12014-07-07 06:20:47 +00003452 case ExternalLinkage:
3453 return llvm::GlobalValue::LinkOnceODRLinkage;
3454 }
3455 llvm_unreachable("Invalid linkage!");
3456}
3457
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003458/// An ephemeral helper class for building MS RTTI types. It caches some
David Majnemere2cb8d12014-07-07 06:20:47 +00003459/// calls to the module and information about the most derived class in a
3460/// hierarchy.
3461struct MSRTTIBuilder {
3462 enum {
3463 HasBranchingHierarchy = 1,
3464 HasVirtualBranchingHierarchy = 2,
3465 HasAmbiguousBases = 4
3466 };
3467
David Majnemer611cdb92014-07-07 08:09:15 +00003468 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
3469 : CGM(ABI.CGM), Context(CGM.getContext()),
3470 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00003471 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003472 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00003473
3474 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
3475 llvm::GlobalVariable *
3476 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
3477 llvm::GlobalVariable *getClassHierarchyDescriptor();
Justin Lebar562914e2016-10-10 16:26:29 +00003478 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo &Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003479
3480 CodeGenModule &CGM;
3481 ASTContext &Context;
3482 llvm::LLVMContext &VMContext;
3483 llvm::Module &Module;
3484 const CXXRecordDecl *RD;
3485 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00003486 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00003487};
3488
3489} // namespace
3490
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003491/// Recursively serializes a class hierarchy in pre-order depth first
David Majnemere2cb8d12014-07-07 06:20:47 +00003492/// order.
3493static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
3494 const CXXRecordDecl *RD) {
3495 Classes.push_back(MSRTTIClass(RD));
3496 for (const CXXBaseSpecifier &Base : RD->bases())
3497 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
3498}
3499
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003500/// Find ambiguity among base classes.
David Majnemere2cb8d12014-07-07 06:20:47 +00003501static void
3502detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
3503 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
3504 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
3505 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
3506 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
3507 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
David Blaikie82e95a32014-11-19 07:49:47 +00003508 !VirtualBases.insert(Class->RD).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003509 Class = MSRTTIClass::getNextChild(Class);
3510 continue;
3511 }
David Blaikie82e95a32014-11-19 07:49:47 +00003512 if (!UniqueBases.insert(Class->RD).second)
David Majnemere2cb8d12014-07-07 06:20:47 +00003513 AmbiguousBases.insert(Class->RD);
3514 Class++;
3515 }
3516 if (AmbiguousBases.empty())
3517 return;
3518 for (MSRTTIClass &Class : Classes)
3519 if (AmbiguousBases.count(Class.RD))
3520 Class.Flags |= MSRTTIClass::IsAmbiguous;
3521}
3522
3523llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
3524 SmallString<256> MangledName;
3525 {
3526 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003527 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003528 }
3529
3530 // Check to see if we've already declared this ClassHierarchyDescriptor.
3531 if (auto CHD = Module.getNamedGlobal(MangledName))
3532 return CHD;
3533
3534 // Serialize the class hierarchy and initialize the CHD Fields.
3535 SmallVector<MSRTTIClass, 8> Classes;
3536 serializeClassHierarchy(Classes, RD);
3537 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3538 detectAmbiguousBases(Classes);
3539 int Flags = 0;
3540 for (auto Class : Classes) {
3541 if (Class.RD->getNumBases() > 1)
3542 Flags |= HasBranchingHierarchy;
3543 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
3544 // believe the field isn't actually used.
3545 if (Class.Flags & MSRTTIClass::IsAmbiguous)
3546 Flags |= HasAmbiguousBases;
3547 }
3548 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
3549 Flags |= HasVirtualBranchingHierarchy;
3550 // These gep indices are used to get the address of the first element of the
3551 // base class array.
3552 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
3553 llvm::ConstantInt::get(CGM.IntTy, 0)};
3554
3555 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00003556 auto Type = ABI.getClassHierarchyDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003557 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3558 /*Initializer=*/nullptr,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003559 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003560 if (CHD->isWeakForLinker())
3561 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003562
David Blaikiee3b172a2015-04-02 18:55:21 +00003563 auto *Bases = getBaseClassArray(Classes);
3564
David Majnemere2cb8d12014-07-07 06:20:47 +00003565 // Initialize the base class ClassHierarchyDescriptor.
3566 llvm::Constant *Fields[] = {
Saleem Abdulrasoola9e14502017-01-01 19:16:02 +00003567 llvm::ConstantInt::get(CGM.IntTy, 0), // reserved by the runtime
David Majnemer611cdb92014-07-07 08:09:15 +00003568 llvm::ConstantInt::get(CGM.IntTy, Flags),
3569 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
3570 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00003571 Bases->getValueType(), Bases,
David Majnemer611cdb92014-07-07 08:09:15 +00003572 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00003573 };
3574 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3575 return CHD;
3576}
3577
3578llvm::GlobalVariable *
3579MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3580 SmallString<256> MangledName;
3581 {
3582 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003583 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003584 }
3585
3586 // Forward-declare the base class array.
3587 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3588 // mode) bytes of padding. We provide a pointer sized amount of padding by
3589 // adding +1 to Classes.size(). The sections have pointer alignment and are
3590 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00003591 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00003592 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00003593 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
David Majnemer7c237072015-03-05 00:46:22 +00003594 auto *BCA =
3595 new llvm::GlobalVariable(Module, ArrType,
3596 /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003597 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003598 if (BCA->isWeakForLinker())
3599 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003600
3601 // Initialize the BaseClassArray.
3602 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3603 for (MSRTTIClass &Class : Classes)
3604 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00003605 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00003606 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00003607 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00003608 return BCA;
3609}
3610
3611llvm::GlobalVariable *
3612MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3613 // Compute the fields for the BaseClassDescriptor. They are computed up front
3614 // because they are mangled into the name of the object.
3615 uint32_t OffsetInVBTable = 0;
3616 int32_t VBPtrOffset = -1;
3617 if (Class.VirtualRoot) {
3618 auto &VTableContext = CGM.getMicrosoftVTableContext();
3619 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3620 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3621 }
3622
3623 SmallString<256> MangledName;
3624 {
3625 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003626 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3627 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3628 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003629 }
3630
David Majnemer26a90f82014-07-07 15:29:10 +00003631 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00003632 if (auto BCD = Module.getNamedGlobal(MangledName))
3633 return BCD;
3634
3635 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00003636 auto Type = ABI.getBaseClassDescriptorType();
David Majnemer7c237072015-03-05 00:46:22 +00003637 auto BCD =
3638 new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003639 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003640 if (BCD->isWeakForLinker())
3641 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003642
3643 // Initialize the BaseClassDescriptor.
3644 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003645 ABI.getImageRelativeConstant(
David Majnemer443250f2015-03-17 20:35:00 +00003646 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003647 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3648 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3649 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3650 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3651 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3652 ABI.getImageRelativeConstant(
3653 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00003654 };
3655 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3656 return BCD;
3657}
3658
3659llvm::GlobalVariable *
Justin Lebar562914e2016-10-10 16:26:29 +00003660MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo &Info) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003661 SmallString<256> MangledName;
3662 {
3663 llvm::raw_svector_ostream Out(MangledName);
Justin Lebar562914e2016-10-10 16:26:29 +00003664 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info.MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003665 }
3666
3667 // Check to see if we've already computed this complete object locator.
3668 if (auto COL = Module.getNamedGlobal(MangledName))
3669 return COL;
3670
3671 // Compute the fields of the complete object locator.
Justin Lebar562914e2016-10-10 16:26:29 +00003672 int OffsetToTop = Info.FullOffsetInMDC.getQuantity();
David Majnemere2cb8d12014-07-07 06:20:47 +00003673 int VFPtrOffset = 0;
3674 // The offset includes the vtordisp if one exists.
Justin Lebar562914e2016-10-10 16:26:29 +00003675 if (const CXXRecordDecl *VBase = Info.getVBaseWithVPtr())
David Majnemere2cb8d12014-07-07 06:20:47 +00003676 if (Context.getASTRecordLayout(RD)
3677 .getVBaseOffsetsMap()
3678 .find(VBase)
3679 ->second.hasVtorDisp())
Justin Lebar562914e2016-10-10 16:26:29 +00003680 VFPtrOffset = Info.NonVirtualOffset.getQuantity() + 4;
David Majnemere2cb8d12014-07-07 06:20:47 +00003681
3682 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00003683 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003684 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003685 /*Initializer=*/nullptr, MangledName);
David Majnemere2cb8d12014-07-07 06:20:47 +00003686
3687 // Initialize the CompleteObjectLocator.
3688 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003689 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3690 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3691 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3692 ABI.getImageRelativeConstant(
3693 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3694 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3695 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00003696 };
3697 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00003698 if (!ABI.isImageRelative())
3699 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00003700 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
Rafael Espindola654542a2015-01-16 19:23:42 +00003701 if (COL->isWeakForLinker())
3702 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003703 return COL;
3704}
3705
David Majnemerad803d42015-03-15 07:10:01 +00003706static QualType decomposeTypeForEH(ASTContext &Context, QualType T,
David Majnemer526793d2016-07-12 04:42:50 +00003707 bool &IsConst, bool &IsVolatile,
3708 bool &IsUnaligned) {
David Majnemerad803d42015-03-15 07:10:01 +00003709 T = Context.getExceptionObjectType(T);
3710
3711 // C++14 [except.handle]p3:
3712 // A handler is a match for an exception object of type E if [...]
3713 // - the handler is of type cv T or const T& where T is a pointer type and
3714 // E is a pointer type that can be converted to T by [...]
3715 // - a qualification conversion
3716 IsConst = false;
3717 IsVolatile = false;
David Majnemer526793d2016-07-12 04:42:50 +00003718 IsUnaligned = false;
David Majnemerad803d42015-03-15 07:10:01 +00003719 QualType PointeeType = T->getPointeeType();
3720 if (!PointeeType.isNull()) {
3721 IsConst = PointeeType.isConstQualified();
3722 IsVolatile = PointeeType.isVolatileQualified();
David Majnemer526793d2016-07-12 04:42:50 +00003723 IsUnaligned = PointeeType.getQualifiers().hasUnaligned();
David Majnemerad803d42015-03-15 07:10:01 +00003724 }
3725
3726 // Member pointer types like "const int A::*" are represented by having RTTI
3727 // for "int A::*" and separately storing the const qualifier.
3728 if (const auto *MPTy = T->getAs<MemberPointerType>())
3729 T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(),
3730 MPTy->getClass());
3731
3732 // Pointer types like "const int * const *" are represented by having RTTI
3733 // for "const int **" and separately storing the const qualifier.
3734 if (T->isPointerType())
3735 T = Context.getPointerType(PointeeType.getUnqualifiedType());
3736
3737 return T;
3738}
3739
Reid Kleckner10aa7702015-09-16 20:15:55 +00003740CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +00003741MicrosoftCXXABI::getAddrOfCXXCatchHandlerType(QualType Type,
3742 QualType CatchHandlerType) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003743 // TypeDescriptors for exceptions never have qualified pointer types,
Simon Pilgrim2c518802017-03-30 14:13:19 +00003744 // qualifiers are stored separately in order to support qualification
David Majnemer443250f2015-03-17 20:35:00 +00003745 // conversions.
David Majnemer526793d2016-07-12 04:42:50 +00003746 bool IsConst, IsVolatile, IsUnaligned;
3747 Type =
3748 decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile, IsUnaligned);
David Majnemer443250f2015-03-17 20:35:00 +00003749
David Majnemer5f0dd612015-03-17 20:35:05 +00003750 bool IsReference = CatchHandlerType->isReferenceType();
3751
David Majnemer5f0dd612015-03-17 20:35:05 +00003752 uint32_t Flags = 0;
3753 if (IsConst)
3754 Flags |= 1;
3755 if (IsVolatile)
3756 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00003757 if (IsUnaligned)
3758 Flags |= 4;
David Majnemer5f0dd612015-03-17 20:35:05 +00003759 if (IsReference)
3760 Flags |= 8;
3761
Reid Kleckner10aa7702015-09-16 20:15:55 +00003762 return CatchTypeInfo{getAddrOfRTTIDescriptor(Type)->stripPointerCasts(),
3763 Flags};
David Majnemer443250f2015-03-17 20:35:00 +00003764}
3765
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003766/// Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
David Majnemere2cb8d12014-07-07 06:20:47 +00003767/// llvm::GlobalVariable * because different type descriptors have different
3768/// types, and need to be abstracted. They are abstracting by casting the
3769/// address to an Int8PtrTy.
David Majnemer443250f2015-03-17 20:35:00 +00003770llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003771 SmallString<256> MangledName;
David Majnemere2cb8d12014-07-07 06:20:47 +00003772 {
3773 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003774 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003775 }
3776
3777 // Check to see if we've already declared this TypeDescriptor.
3778 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3779 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3780
Piotr Padlewskid3b1cbd2017-06-01 08:04:05 +00003781 // Note for the future: If we would ever like to do deferred emission of
3782 // RTTI, check if emitting vtables opportunistically need any adjustment.
3783
David Majnemere2cb8d12014-07-07 06:20:47 +00003784 // Compute the fields for the TypeDescriptor.
David Majnemer5f0dd612015-03-17 20:35:05 +00003785 SmallString<256> TypeInfoString;
David Majnemere2cb8d12014-07-07 06:20:47 +00003786 {
3787 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00003788 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003789 }
3790
3791 // Declare and initialize the TypeDescriptor.
3792 llvm::Constant *Fields[] = {
3793 getTypeInfoVTable(CGM), // VFPtr
3794 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3795 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3796 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00003797 getTypeDescriptorType(TypeInfoString);
Rafael Espindola654542a2015-01-16 19:23:42 +00003798 auto *Var = new llvm::GlobalVariable(
3799 CGM.getModule(), TypeDescriptorType, /*Constant=*/false,
3800 getLinkageForRTTI(Type),
3801 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
Yaron Keren2c07cc72015-12-01 08:14:39 +00003802 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003803 if (Var->isWeakForLinker())
3804 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3805 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003806}
3807
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003808/// Gets or a creates a Microsoft CompleteObjectLocator.
David Majnemere2cb8d12014-07-07 06:20:47 +00003809llvm::GlobalVariable *
3810MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
Justin Lebar562914e2016-10-10 16:26:29 +00003811 const VPtrInfo &Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00003812 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003813}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003814
3815static void emitCXXConstructor(CodeGenModule &CGM,
3816 const CXXConstructorDecl *ctor,
3817 StructorType ctorType) {
Rafael Espindolad48b51b2014-09-15 19:24:44 +00003818 // There are no constructor variants, always emit the complete destructor.
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003819 llvm::Function *Fn = CGM.codegenCXXStructor(ctor, StructorType::Complete);
3820 CGM.maybeSetTrivialComdat(*ctor, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003821}
3822
3823static void emitCXXDestructor(CodeGenModule &CGM, const CXXDestructorDecl *dtor,
3824 StructorType dtorType) {
Reid Klecknerae9b0702018-03-16 19:40:50 +00003825 // Emit the base destructor if the base and complete (vbase) destructors are
3826 // equivalent. This effectively implements -mconstructor-aliases as part of
3827 // the ABI.
3828 if (dtorType == StructorType::Complete &&
3829 dtor->getParent()->getNumVBases() == 0)
3830 dtorType = StructorType::Base;
Rafael Espindola91f68b42014-09-15 19:20:10 +00003831
3832 // The base destructor is equivalent to the base destructor of its
3833 // base class if there is exactly one non-virtual base class with a
3834 // non-trivial destructor, there are no fields with a non-trivial
3835 // destructor, and the body of the destructor is trivial.
3836 if (dtorType == StructorType::Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
3837 return;
3838
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003839 llvm::Function *Fn = CGM.codegenCXXStructor(dtor, dtorType);
Rafael Espindolad3e04692015-01-17 01:47:39 +00003840 if (Fn->isWeakForLinker())
3841 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003842}
3843
3844void MicrosoftCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3845 StructorType Type) {
3846 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
3847 emitCXXConstructor(CGM, CD, Type);
3848 return;
3849 }
3850 emitCXXDestructor(CGM, cast<CXXDestructorDecl>(MD), Type);
3851}
David Majnemer7c237072015-03-05 00:46:22 +00003852
David Majnemerdfa6d202015-03-11 18:36:39 +00003853llvm::Function *
David Majnemer37fd66e2015-03-13 22:36:55 +00003854MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
3855 CXXCtorType CT) {
3856 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
3857
David Majnemerdfa6d202015-03-11 18:36:39 +00003858 // Calculate the mangled name.
3859 SmallString<256> ThunkName;
3860 llvm::raw_svector_ostream Out(ThunkName);
David Majnemer37fd66e2015-03-13 22:36:55 +00003861 getMangleContext().mangleCXXCtor(CD, CT, Out);
David Majnemerdfa6d202015-03-11 18:36:39 +00003862
3863 // If the thunk has been generated previously, just return it.
3864 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
3865 return cast<llvm::Function>(GV);
3866
3867 // Create the llvm::Function.
David Majnemer37fd66e2015-03-13 22:36:55 +00003868 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT);
David Majnemerdfa6d202015-03-11 18:36:39 +00003869 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
3870 const CXXRecordDecl *RD = CD->getParent();
3871 QualType RecordTy = getContext().getRecordType(RD);
3872 llvm::Function *ThunkFn = llvm::Function::Create(
3873 ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule());
Reid Klecknerbba3cb92015-03-17 19:00:50 +00003874 ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>(
3875 FnInfo.getEffectiveCallingConvention()));
David Majnemer63aa2fb2015-06-30 21:23:51 +00003876 if (ThunkFn->isWeakForLinker())
3877 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
David Majnemer37fd66e2015-03-13 22:36:55 +00003878 bool IsCopy = CT == Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003879
3880 // Start codegen.
3881 CodeGenFunction CGF(CGM);
3882 CGF.CurGD = GlobalDecl(CD, Ctor_Complete);
3883
3884 // Build FunctionArgs.
3885 FunctionArgList FunctionArgs;
3886
David Majnemer37fd66e2015-03-13 22:36:55 +00003887 // A constructor always starts with a 'this' pointer as its first argument.
David Majnemerdfa6d202015-03-11 18:36:39 +00003888 buildThisParam(CGF, FunctionArgs);
3889
3890 // Following the 'this' pointer is a reference to the source object that we
3891 // are copying from.
3892 ImplicitParamDecl SrcParam(
Alexey Bataev56223232017-06-09 13:40:18 +00003893 getContext(), /*DC=*/nullptr, SourceLocation(),
3894 &getContext().Idents.get("src"),
David Majnemerdfa6d202015-03-11 18:36:39 +00003895 getContext().getLValueReferenceType(RecordTy,
Alexey Bataev56223232017-06-09 13:40:18 +00003896 /*SpelledAsLValue=*/true),
3897 ImplicitParamDecl::Other);
David Majnemer37fd66e2015-03-13 22:36:55 +00003898 if (IsCopy)
3899 FunctionArgs.push_back(&SrcParam);
David Majnemerdfa6d202015-03-11 18:36:39 +00003900
David Majnemer37fd66e2015-03-13 22:36:55 +00003901 // Constructors for classes which utilize virtual bases have an additional
3902 // parameter which indicates whether or not it is being delegated to by a more
3903 // derived constructor.
Alexey Bataev56223232017-06-09 13:40:18 +00003904 ImplicitParamDecl IsMostDerived(getContext(), /*DC=*/nullptr,
3905 SourceLocation(),
David Majnemerdfa6d202015-03-11 18:36:39 +00003906 &getContext().Idents.get("is_most_derived"),
Alexey Bataev56223232017-06-09 13:40:18 +00003907 getContext().IntTy, ImplicitParamDecl::Other);
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003908 // Only add the parameter to the list if the class has virtual bases.
David Majnemerdfa6d202015-03-11 18:36:39 +00003909 if (RD->getNumVBases() > 0)
3910 FunctionArgs.push_back(&IsMostDerived);
3911
3912 // Start defining the function.
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003913 auto NL = ApplyDebugLocation::CreateEmpty(CGF);
David Majnemerdfa6d202015-03-11 18:36:39 +00003914 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
3915 FunctionArgs, CD->getLocation(), SourceLocation());
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003916 // Create a scope with an artificial location for the body of this function.
3917 auto AL = ApplyDebugLocation::CreateArtificial(CGF);
Reid Kleckner06239e42017-11-16 19:09:36 +00003918 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
David Majnemerdfa6d202015-03-11 18:36:39 +00003919 llvm::Value *This = getThisValue(CGF);
3920
3921 llvm::Value *SrcVal =
David Majnemer37fd66e2015-03-13 22:36:55 +00003922 IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src")
3923 : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003924
3925 CallArgList Args;
3926
3927 // Push the this ptr.
3928 Args.add(RValue::get(This), CD->getThisType(getContext()));
3929
3930 // Push the src ptr.
David Majnemer37fd66e2015-03-13 22:36:55 +00003931 if (SrcVal)
3932 Args.add(RValue::get(SrcVal), SrcParam.getType());
David Majnemerdfa6d202015-03-11 18:36:39 +00003933
3934 // Add the rest of the default arguments.
Reid Klecknerc01ee752016-11-23 16:51:30 +00003935 SmallVector<const Stmt *, 4> ArgVec;
3936 ArrayRef<ParmVarDecl *> params = CD->parameters().drop_front(IsCopy ? 1 : 0);
3937 for (const ParmVarDecl *PD : params) {
3938 assert(PD->hasDefaultArg() && "ctor closure lacks default args");
3939 ArgVec.push_back(PD->getDefaultArg());
Reid Kleckner93f661a2015-03-17 21:51:43 +00003940 }
David Majnemerdfa6d202015-03-11 18:36:39 +00003941
3942 CodeGenFunction::RunCleanupsScope Cleanups(CGF);
3943
3944 const auto *FPT = CD->getType()->castAs<FunctionProtoType>();
David Blaikief05779e2015-07-21 18:37:18 +00003945 CGF.EmitCallArgs(Args, FPT, llvm::makeArrayRef(ArgVec), CD, IsCopy ? 1 : 0);
David Majnemerdfa6d202015-03-11 18:36:39 +00003946
3947 // Insert any ABI-specific implicit constructor arguments.
George Burgess IVf203dbf2017-02-22 20:28:02 +00003948 AddedStructorArgs ExtraArgs =
3949 addImplicitConstructorArgs(CGF, CD, Ctor_Complete,
3950 /*ForVirtualBase=*/false,
3951 /*Delegating=*/false, Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00003952 // Call the destructor with our arguments.
John McCallb92ab1a2016-10-26 23:46:34 +00003953 llvm::Constant *CalleePtr =
3954 CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3955 CGCallee Callee = CGCallee::forDirect(CalleePtr, CD);
David Majnemerdfa6d202015-03-11 18:36:39 +00003956 const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall(
George Burgess IVd0a9e802017-02-23 22:07:35 +00003957 Args, CD, Ctor_Complete, ExtraArgs.Prefix, ExtraArgs.Suffix);
John McCallb92ab1a2016-10-26 23:46:34 +00003958 CGF.EmitCall(CalleeInfo, Callee, ReturnValueSlot(), Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00003959
3960 Cleanups.ForceCleanup();
3961
3962 // Emit the ret instruction, remove any temporary instructions created for the
3963 // aid of CodeGen.
3964 CGF.FinishFunction(SourceLocation());
3965
3966 return ThunkFn;
3967}
3968
David Majnemer7c237072015-03-05 00:46:22 +00003969llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
3970 uint32_t NVOffset,
3971 int32_t VBPtrOffset,
3972 uint32_t VBIndex) {
3973 assert(!T->isReferenceType());
3974
David Majnemere7a818f2015-03-06 18:53:55 +00003975 CXXRecordDecl *RD = T->getAsCXXRecordDecl();
3976 const CXXConstructorDecl *CD =
3977 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003978 CXXCtorType CT = Ctor_Complete;
David Majnemer37fd66e2015-03-13 22:36:55 +00003979 if (CD)
3980 if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1)
David Majnemerdfa6d202015-03-11 18:36:39 +00003981 CT = Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003982
David Majnemer7c237072015-03-05 00:46:22 +00003983 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
3984 SmallString<256> MangledName;
3985 {
3986 llvm::raw_svector_ostream Out(MangledName);
David Majnemerdfa6d202015-03-11 18:36:39 +00003987 getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +00003988 VBPtrOffset, VBIndex, Out);
David Majnemer7c237072015-03-05 00:46:22 +00003989 }
3990 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3991 return getImageRelativeConstant(GV);
3992
David Majnemerdfa6d202015-03-11 18:36:39 +00003993 // The TypeDescriptor is used by the runtime to determine if a catch handler
David Majnemer7c237072015-03-05 00:46:22 +00003994 // is appropriate for the exception object.
David Majnemer443250f2015-03-17 20:35:00 +00003995 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
David Majnemer7c237072015-03-05 00:46:22 +00003996
3997 // The runtime is responsible for calling the copy constructor if the
3998 // exception is caught by value.
David Majnemerdfa6d202015-03-11 18:36:39 +00003999 llvm::Constant *CopyCtor;
4000 if (CD) {
4001 if (CT == Ctor_CopyingClosure)
David Majnemer37fd66e2015-03-13 22:36:55 +00004002 CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure);
David Majnemerdfa6d202015-03-11 18:36:39 +00004003 else
4004 CopyCtor = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
4005
4006 CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy);
4007 } else {
4008 CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4009 }
David Majnemere7a818f2015-03-06 18:53:55 +00004010 CopyCtor = getImageRelativeConstant(CopyCtor);
David Majnemer7c237072015-03-05 00:46:22 +00004011
David Majnemere7a818f2015-03-06 18:53:55 +00004012 bool IsScalar = !RD;
David Majnemer7c237072015-03-05 00:46:22 +00004013 bool HasVirtualBases = false;
4014 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
David Majnemer7c237072015-03-05 00:46:22 +00004015 QualType PointeeType = T;
4016 if (T->isPointerType())
4017 PointeeType = T->getPointeeType();
4018 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
4019 HasVirtualBases = RD->getNumVBases() > 0;
4020 if (IdentifierInfo *II = RD->getIdentifier())
4021 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
4022 }
4023
4024 // Encode the relevant CatchableType properties into the Flags bitfield.
4025 // FIXME: Figure out how bits 2 or 8 can get set.
4026 uint32_t Flags = 0;
4027 if (IsScalar)
4028 Flags |= 1;
4029 if (HasVirtualBases)
4030 Flags |= 4;
4031 if (IsStdBadAlloc)
4032 Flags |= 16;
4033
4034 llvm::Constant *Fields[] = {
4035 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4036 TD, // TypeDescriptor
4037 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment
4038 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
4039 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex
4040 llvm::ConstantInt::get(CGM.IntTy, Size), // Size
4041 CopyCtor // CopyCtor
4042 };
4043 llvm::StructType *CTType = getCatchableTypeType();
4044 auto *GV = new llvm::GlobalVariable(
4045 CGM.getModule(), CTType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004046 llvm::ConstantStruct::get(CTType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004047 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004048 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004049 if (GV->isWeakForLinker())
4050 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004051 return getImageRelativeConstant(GV);
4052}
4053
4054llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
4055 assert(!T->isReferenceType());
4056
4057 // See if we've already generated a CatchableTypeArray for this type before.
4058 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
4059 if (CTA)
4060 return CTA;
4061
4062 // Ensure that we don't have duplicate entries in our CatchableTypeArray by
4063 // using a SmallSetVector. Duplicates may arise due to virtual bases
4064 // occurring more than once in the hierarchy.
4065 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
4066
4067 // C++14 [except.handle]p3:
4068 // A handler is a match for an exception object of type E if [...]
4069 // - the handler is of type cv T or cv T& and T is an unambiguous public
4070 // base class of E, or
4071 // - the handler is of type cv T or const T& where T is a pointer type and
4072 // E is a pointer type that can be converted to T by [...]
4073 // - a standard pointer conversion (4.10) not involving conversions to
4074 // pointers to private or protected or ambiguous classes
4075 const CXXRecordDecl *MostDerivedClass = nullptr;
4076 bool IsPointer = T->isPointerType();
4077 if (IsPointer)
4078 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
4079 else
4080 MostDerivedClass = T->getAsCXXRecordDecl();
4081
4082 // Collect all the unambiguous public bases of the MostDerivedClass.
4083 if (MostDerivedClass) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00004084 const ASTContext &Context = getContext();
David Majnemer7c237072015-03-05 00:46:22 +00004085 const ASTRecordLayout &MostDerivedLayout =
4086 Context.getASTRecordLayout(MostDerivedClass);
4087 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
4088 SmallVector<MSRTTIClass, 8> Classes;
4089 serializeClassHierarchy(Classes, MostDerivedClass);
4090 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
4091 detectAmbiguousBases(Classes);
4092 for (const MSRTTIClass &Class : Classes) {
4093 // Skip any ambiguous or private bases.
4094 if (Class.Flags &
4095 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
4096 continue;
4097 // Write down how to convert from a derived pointer to a base pointer.
4098 uint32_t OffsetInVBTable = 0;
4099 int32_t VBPtrOffset = -1;
4100 if (Class.VirtualRoot) {
4101 OffsetInVBTable =
4102 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
4103 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
4104 }
4105
4106 // Turn our record back into a pointer if the exception object is a
4107 // pointer.
4108 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
4109 if (IsPointer)
4110 RTTITy = Context.getPointerType(RTTITy);
4111 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
4112 VBPtrOffset, OffsetInVBTable));
4113 }
4114 }
4115
4116 // C++14 [except.handle]p3:
4117 // A handler is a match for an exception object of type E if
4118 // - The handler is of type cv T or cv T& and E and T are the same type
4119 // (ignoring the top-level cv-qualifiers)
4120 CatchableTypes.insert(getCatchableType(T));
4121
4122 // C++14 [except.handle]p3:
4123 // A handler is a match for an exception object of type E if
4124 // - the handler is of type cv T or const T& where T is a pointer type and
4125 // E is a pointer type that can be converted to T by [...]
4126 // - a standard pointer conversion (4.10) not involving conversions to
4127 // pointers to private or protected or ambiguous classes
4128 //
David Majnemerf205f532015-04-04 05:37:48 +00004129 // C++14 [conv.ptr]p2:
4130 // A prvalue of type "pointer to cv T," where T is an object type, can be
4131 // converted to a prvalue of type "pointer to cv void".
4132 if (IsPointer && T->getPointeeType()->isObjectType())
David Majnemer7c237072015-03-05 00:46:22 +00004133 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4134
David Majnemera1aea9a2015-03-12 17:44:49 +00004135 // C++14 [except.handle]p3:
4136 // A handler is a match for an exception object of type E if [...]
4137 // - the handler is of type cv T or const T& where T is a pointer or
4138 // pointer to member type and E is std::nullptr_t.
4139 //
4140 // We cannot possibly list all possible pointer types here, making this
4141 // implementation incompatible with the standard. However, MSVC includes an
4142 // entry for pointer-to-void in this case. Let's do the same.
4143 if (T->isNullPtrType())
4144 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4145
David Majnemer7c237072015-03-05 00:46:22 +00004146 uint32_t NumEntries = CatchableTypes.size();
4147 llvm::Type *CTType =
4148 getImageRelativeType(getCatchableTypeType()->getPointerTo());
4149 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
4150 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
4151 llvm::Constant *Fields[] = {
4152 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries
4153 llvm::ConstantArray::get(
4154 AT, llvm::makeArrayRef(CatchableTypes.begin(),
4155 CatchableTypes.end())) // CatchableTypes
4156 };
4157 SmallString<256> MangledName;
4158 {
4159 llvm::raw_svector_ostream Out(MangledName);
4160 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
4161 }
4162 CTA = new llvm::GlobalVariable(
4163 CGM.getModule(), CTAType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004164 llvm::ConstantStruct::get(CTAType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004165 CTA->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004166 CTA->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004167 if (CTA->isWeakForLinker())
4168 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004169 return CTA;
4170}
4171
4172llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
David Majnemer526793d2016-07-12 04:42:50 +00004173 bool IsConst, IsVolatile, IsUnaligned;
4174 T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile, IsUnaligned);
David Majnemer7c237072015-03-05 00:46:22 +00004175
4176 // The CatchableTypeArray enumerates the various (CV-unqualified) types that
4177 // the exception object may be caught as.
4178 llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
4179 // The first field in a CatchableTypeArray is the number of CatchableTypes.
4180 // This is used as a component of the mangled name which means that we need to
4181 // know what it is in order to see if we have previously generated the
4182 // ThrowInfo.
4183 uint32_t NumEntries =
4184 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
4185 ->getLimitedValue();
4186
4187 SmallString<256> MangledName;
4188 {
4189 llvm::raw_svector_ostream Out(MangledName);
David Majnemer526793d2016-07-12 04:42:50 +00004190 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, IsUnaligned,
4191 NumEntries, Out);
David Majnemer7c237072015-03-05 00:46:22 +00004192 }
4193
4194 // Reuse a previously generated ThrowInfo if we have generated an appropriate
4195 // one before.
4196 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4197 return GV;
4198
4199 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
4200 // be at least as CV qualified. Encode this requirement into the Flags
4201 // bitfield.
4202 uint32_t Flags = 0;
4203 if (IsConst)
4204 Flags |= 1;
4205 if (IsVolatile)
4206 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00004207 if (IsUnaligned)
4208 Flags |= 4;
David Majnemer7c237072015-03-05 00:46:22 +00004209
4210 // The cleanup-function (a destructor) must be called when the exception
4211 // object's lifetime ends.
4212 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4213 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
4214 if (CXXDestructorDecl *DtorD = RD->getDestructor())
4215 if (!DtorD->isTrivial())
4216 CleanupFn = llvm::ConstantExpr::getBitCast(
4217 CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete),
4218 CGM.Int8PtrTy);
4219 // This is unused as far as we can tell, initialize it to null.
4220 llvm::Constant *ForwardCompat =
4221 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
4222 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
4223 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
4224 llvm::StructType *TIType = getThrowInfoType();
4225 llvm::Constant *Fields[] = {
4226 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4227 getImageRelativeConstant(CleanupFn), // CleanupFn
4228 ForwardCompat, // ForwardCompat
4229 PointerToCatchableTypes // CatchableTypeArray
4230 };
4231 auto *GV = new llvm::GlobalVariable(
4232 CGM.getModule(), TIType, /*Constant=*/true, getLinkageForRTTI(T),
4233 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004234 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004235 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004236 if (GV->isWeakForLinker())
4237 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004238 return GV;
4239}
4240
4241void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
4242 const Expr *SubExpr = E->getSubExpr();
4243 QualType ThrowType = SubExpr->getType();
4244 // The exception object lives on the stack and it's address is passed to the
4245 // runtime function.
John McCall7f416cc2015-09-08 08:05:57 +00004246 Address AI = CGF.CreateMemTemp(ThrowType);
David Majnemer7c237072015-03-05 00:46:22 +00004247 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
4248 /*IsInit=*/true);
4249
4250 // The so-called ThrowInfo is used to describe how the exception object may be
4251 // caught.
4252 llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
4253
4254 // Call into the runtime to throw the exception.
John McCall7f416cc2015-09-08 08:05:57 +00004255 llvm::Value *Args[] = {
4256 CGF.Builder.CreateBitCast(AI.getPointer(), CGM.Int8PtrTy),
4257 TI
4258 };
David Majnemer7c237072015-03-05 00:46:22 +00004259 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
4260}
Peter Collingbourne60108802017-12-13 21:53:04 +00004261
4262std::pair<llvm::Value *, const CXXRecordDecl *>
4263MicrosoftCXXABI::LoadVTablePtr(CodeGenFunction &CGF, Address This,
4264 const CXXRecordDecl *RD) {
4265 std::tie(This, std::ignore, RD) =
4266 performBaseAdjustment(CGF, This, QualType(RD->getTypeForDecl(), 0));
4267 return {CGF.GetVTablePtr(This, CGM.Int8PtrTy, RD), RD};
4268}