blob: d48dfbf0909667a4ddd81c0ce733ccceab880abd [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
Craig Topper4f12f102014-03-12 06:41:41 +0000219 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000220
Craig Topper4f12f102014-03-12 06:41:41 +0000221 const CXXRecordDecl *
222 getThisArgumentTypeForMethod(const CXXMethodDecl *MD) override {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000223 MD = MD->getCanonicalDecl();
224 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD)) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000225 MicrosoftVTableContext::MethodVFTableLocation ML =
226 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000227 // The vbases might be ordered differently in the final overrider object
228 // and the complete object, so the "this" argument may sometimes point to
229 // memory that has no particular type (e.g. past the complete object).
230 // In this case, we just use a generic pointer type.
231 // FIXME: might want to have a more precise type in the non-virtual
232 // multiple inheritance case.
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +0000233 if (ML.VBase || !ML.VFPtrOffset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000234 return nullptr;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000235 }
236 return MD->getParent();
237 }
238
John McCall7f416cc2015-09-08 08:05:57 +0000239 Address
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000240 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD,
John McCall7f416cc2015-09-08 08:05:57 +0000241 Address This,
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000242 bool VirtualCall) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000243
Reid Kleckner89077a12013-12-17 19:46:40 +0000244 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000245 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000246
Craig Topper4f12f102014-03-12 06:41:41 +0000247 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall29036752011-01-27 02:46:02 +0000248
George Burgess IVf203dbf2017-02-22 20:28:02 +0000249 AddedStructorArgs
250 addImplicitConstructorArgs(CodeGenFunction &CGF, const CXXConstructorDecl *D,
251 CXXCtorType Type, bool ForVirtualBase,
252 bool Delegating, CallArgList &Args) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000253
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000254 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
255 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +0000256 bool Delegating, Address This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000257
Justin Lebar562914e2016-10-10 16:26:29 +0000258 void emitVTableTypeMetadata(const VPtrInfo &Info, const CXXRecordDecl *RD,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +0000259 llvm::GlobalVariable *VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +0000260
Craig Topper4f12f102014-03-12 06:41:41 +0000261 void emitVTableDefinitions(CodeGenVTables &CGVT,
262 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000263
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000264 bool isVirtualOffsetNeededForVTableField(CodeGenFunction &CGF,
265 CodeGenFunction::VPtr Vptr) override;
266
267 /// Don't initialize vptrs if dynamic class
268 /// is marked with with the 'novtable' attribute.
269 bool doStructorsInitializeVPtrs(const CXXRecordDecl *VTableClass) override {
270 return !VTableClass->hasAttr<MSNoVTableAttr>();
271 }
272
273 llvm::Constant *
274 getVTableAddressPoint(BaseSubobject Base,
275 const CXXRecordDecl *VTableClass) override;
276
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000277 llvm::Value *getVTableAddressPointInStructor(
278 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000279 BaseSubobject Base, const CXXRecordDecl *NearestVBase) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000280
281 llvm::Constant *
282 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000283 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000284
285 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000286 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000287
John McCall9831b842018-02-06 18:52:44 +0000288 CGCallee getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
289 Address This, llvm::Type *Ty,
290 SourceLocation Loc) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000291
David Majnemer0c0b6d92014-10-31 20:09:12 +0000292 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF,
293 const CXXDestructorDecl *Dtor,
294 CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +0000295 Address This,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000296 const CXXMemberCallExpr *CE) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000297
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000298 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000299 CallArgList &CallArgs) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000300 assert(GD.getDtorType() == Dtor_Deleting &&
301 "Only deleting destructor thunks are available in this ABI");
302 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)),
David Majnemer9ced3dd2015-03-14 23:44:48 +0000303 getContext().IntTy);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000304 }
305
Craig Topper4f12f102014-03-12 06:41:41 +0000306 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000307
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000308 llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000309 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000310 llvm::GlobalVariable::LinkageTypes Linkage);
311
David Majnemerc1709d32015-06-23 07:31:11 +0000312 llvm::GlobalVariable *
313 getAddrOfVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
314 const CXXRecordDecl *DstRD) {
315 SmallString<256> OutName;
316 llvm::raw_svector_ostream Out(OutName);
317 getMangleContext().mangleCXXVirtualDisplacementMap(SrcRD, DstRD, Out);
David Majnemerc1709d32015-06-23 07:31:11 +0000318 StringRef MangledName = OutName.str();
319
320 if (auto *VDispMap = CGM.getModule().getNamedGlobal(MangledName))
321 return VDispMap;
322
323 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
324 unsigned NumEntries = 1 + SrcRD->getNumVBases();
325 SmallVector<llvm::Constant *, 4> Map(NumEntries,
326 llvm::UndefValue::get(CGM.IntTy));
327 Map[0] = llvm::ConstantInt::get(CGM.IntTy, 0);
328 bool AnyDifferent = false;
329 for (const auto &I : SrcRD->vbases()) {
330 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
331 if (!DstRD->isVirtuallyDerivedFrom(VBase))
332 continue;
333
334 unsigned SrcVBIndex = VTContext.getVBTableIndex(SrcRD, VBase);
335 unsigned DstVBIndex = VTContext.getVBTableIndex(DstRD, VBase);
336 Map[SrcVBIndex] = llvm::ConstantInt::get(CGM.IntTy, DstVBIndex * 4);
337 AnyDifferent |= SrcVBIndex != DstVBIndex;
338 }
339 // This map would be useless, don't use it.
340 if (!AnyDifferent)
341 return nullptr;
342
343 llvm::ArrayType *VDispMapTy = llvm::ArrayType::get(CGM.IntTy, Map.size());
344 llvm::Constant *Init = llvm::ConstantArray::get(VDispMapTy, Map);
345 llvm::GlobalValue::LinkageTypes Linkage =
346 SrcRD->isExternallyVisible() && DstRD->isExternallyVisible()
347 ? llvm::GlobalValue::LinkOnceODRLinkage
348 : llvm::GlobalValue::InternalLinkage;
349 auto *VDispMap = new llvm::GlobalVariable(
350 CGM.getModule(), VDispMapTy, /*Constant=*/true, Linkage,
351 /*Initializer=*/Init, MangledName);
352 return VDispMap;
353 }
354
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000355 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000356 llvm::GlobalVariable *GV) const;
357
Hans Wennborgc94391d2014-06-06 20:04:01 +0000358 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
359 GlobalDecl GD, bool ReturnAdjustment) override {
Hans Wennborgc94391d2014-06-06 20:04:01 +0000360 GVALinkage Linkage =
361 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
362
363 if (Linkage == GVA_Internal)
364 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
365 else if (ReturnAdjustment)
366 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
367 else
368 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000369 }
370
Rafael Espindolab7350042018-03-01 00:35:47 +0000371 bool exportThunk() override { return false; }
372
John McCall7f416cc2015-09-08 08:05:57 +0000373 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000374 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000375
John McCall7f416cc2015-09-08 08:05:57 +0000376 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000377 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000378
David Majnemerb3341ea2014-10-05 05:05:40 +0000379 void EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +0000380 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +0000381 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +0000382 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000383
384 bool usesThreadWrapperFunction() const override { return false; }
385 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
386 QualType LValType) override;
387
John McCallc84ed6a2012-05-01 06:13:13 +0000388 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
389 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000390 bool PerformInit) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000391 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
392 llvm::Constant *Dtor, llvm::Constant *Addr) override;
John McCallc84ed6a2012-05-01 06:13:13 +0000393
John McCall29036752011-01-27 02:46:02 +0000394 // ==== Notes on array cookies =========
395 //
396 // MSVC seems to only use cookies when the class has a destructor; a
397 // two-argument usual array deallocation function isn't sufficient.
398 //
399 // For example, this code prints "100" and "1":
400 // struct A {
401 // char x;
402 // void *operator new[](size_t sz) {
403 // printf("%u\n", sz);
404 // return malloc(sz);
405 // }
406 // void operator delete[](void *p, size_t sz) {
407 // printf("%u\n", sz);
408 // free(p);
409 // }
410 // };
411 // int main() {
412 // A *p = new A[100];
413 // delete[] p;
414 // }
415 // Whereas it prints "104" and "104" if you give A a destructor.
John McCallb91cd662012-05-01 05:23:51 +0000416
Craig Topper4f12f102014-03-12 06:41:41 +0000417 bool requiresArrayCookie(const CXXDeleteExpr *expr,
418 QualType elementType) override;
419 bool requiresArrayCookie(const CXXNewExpr *expr) override;
420 CharUnits getArrayCookieSizeImpl(QualType type) override;
John McCall7f416cc2015-09-08 08:05:57 +0000421 Address InitializeArrayCookie(CodeGenFunction &CGF,
422 Address NewPtr,
423 llvm::Value *NumElements,
424 const CXXNewExpr *expr,
425 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000426 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000427 Address allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000428 CharUnits cookieSize) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000429
David Majnemer611cdb92014-07-07 08:09:15 +0000430 friend struct MSRTTIBuilder;
431
432 bool isImageRelative() const {
433 return CGM.getTarget().getPointerWidth(/*AddressSpace=*/0) == 64;
434 }
435
436 // 5 routines for constructing the llvm types for MS RTTI structs.
437 llvm::StructType *getTypeDescriptorType(StringRef TypeInfoString) {
438 llvm::SmallString<32> TDTypeName("rtti.TypeDescriptor");
439 TDTypeName += llvm::utostr(TypeInfoString.size());
440 llvm::StructType *&TypeDescriptorType =
441 TypeDescriptorTypeMap[TypeInfoString.size()];
442 if (TypeDescriptorType)
443 return TypeDescriptorType;
444 llvm::Type *FieldTypes[] = {
445 CGM.Int8PtrPtrTy,
446 CGM.Int8PtrTy,
447 llvm::ArrayType::get(CGM.Int8Ty, TypeInfoString.size() + 1)};
448 TypeDescriptorType =
449 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, TDTypeName);
450 return TypeDescriptorType;
451 }
452
453 llvm::Type *getImageRelativeType(llvm::Type *PtrType) {
454 if (!isImageRelative())
455 return PtrType;
456 return CGM.IntTy;
457 }
458
459 llvm::StructType *getBaseClassDescriptorType() {
460 if (BaseClassDescriptorType)
461 return BaseClassDescriptorType;
462 llvm::Type *FieldTypes[] = {
463 getImageRelativeType(CGM.Int8PtrTy),
464 CGM.IntTy,
465 CGM.IntTy,
466 CGM.IntTy,
467 CGM.IntTy,
468 CGM.IntTy,
469 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
470 };
471 BaseClassDescriptorType = llvm::StructType::create(
472 CGM.getLLVMContext(), FieldTypes, "rtti.BaseClassDescriptor");
473 return BaseClassDescriptorType;
474 }
475
476 llvm::StructType *getClassHierarchyDescriptorType() {
477 if (ClassHierarchyDescriptorType)
478 return ClassHierarchyDescriptorType;
479 // Forward-declare RTTIClassHierarchyDescriptor to break a cycle.
480 ClassHierarchyDescriptorType = llvm::StructType::create(
481 CGM.getLLVMContext(), "rtti.ClassHierarchyDescriptor");
482 llvm::Type *FieldTypes[] = {
483 CGM.IntTy,
484 CGM.IntTy,
485 CGM.IntTy,
486 getImageRelativeType(
487 getBaseClassDescriptorType()->getPointerTo()->getPointerTo()),
488 };
489 ClassHierarchyDescriptorType->setBody(FieldTypes);
490 return ClassHierarchyDescriptorType;
491 }
492
493 llvm::StructType *getCompleteObjectLocatorType() {
494 if (CompleteObjectLocatorType)
495 return CompleteObjectLocatorType;
496 CompleteObjectLocatorType = llvm::StructType::create(
497 CGM.getLLVMContext(), "rtti.CompleteObjectLocator");
498 llvm::Type *FieldTypes[] = {
499 CGM.IntTy,
500 CGM.IntTy,
501 CGM.IntTy,
502 getImageRelativeType(CGM.Int8PtrTy),
503 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
504 getImageRelativeType(CompleteObjectLocatorType),
505 };
506 llvm::ArrayRef<llvm::Type *> FieldTypesRef(FieldTypes);
507 if (!isImageRelative())
508 FieldTypesRef = FieldTypesRef.drop_back();
509 CompleteObjectLocatorType->setBody(FieldTypesRef);
510 return CompleteObjectLocatorType;
511 }
512
513 llvm::GlobalVariable *getImageBase() {
514 StringRef Name = "__ImageBase";
515 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name))
516 return GV;
517
518 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8Ty,
519 /*isConstant=*/true,
520 llvm::GlobalValue::ExternalLinkage,
521 /*Initializer=*/nullptr, Name);
522 }
523
524 llvm::Constant *getImageRelativeConstant(llvm::Constant *PtrVal) {
525 if (!isImageRelative())
526 return PtrVal;
527
David Majnemer7c237072015-03-05 00:46:22 +0000528 if (PtrVal->isNullValue())
529 return llvm::Constant::getNullValue(CGM.IntTy);
530
David Majnemer611cdb92014-07-07 08:09:15 +0000531 llvm::Constant *ImageBaseAsInt =
532 llvm::ConstantExpr::getPtrToInt(getImageBase(), CGM.IntPtrTy);
533 llvm::Constant *PtrValAsInt =
534 llvm::ConstantExpr::getPtrToInt(PtrVal, CGM.IntPtrTy);
535 llvm::Constant *Diff =
536 llvm::ConstantExpr::getSub(PtrValAsInt, ImageBaseAsInt,
537 /*HasNUW=*/true, /*HasNSW=*/true);
538 return llvm::ConstantExpr::getTrunc(Diff, CGM.IntTy);
539 }
540
Reid Kleckner407e8b62013-03-22 19:02:54 +0000541private:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000542 MicrosoftMangleContext &getMangleContext() {
543 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext());
544 }
545
Reid Kleckner2341ae32013-04-11 18:13:19 +0000546 llvm::Constant *getZeroInt() {
547 return llvm::ConstantInt::get(CGM.IntTy, 0);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000548 }
549
Reid Kleckner2341ae32013-04-11 18:13:19 +0000550 llvm::Constant *getAllOnesInt() {
551 return llvm::Constant::getAllOnesValue(CGM.IntTy);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000552 }
553
Reid Kleckner0358cbf2016-07-01 02:41:25 +0000554 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) override;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000555
Reid Kleckner2341ae32013-04-11 18:13:19 +0000556 void
557 GetNullMemberPointerFields(const MemberPointerType *MPT,
558 llvm::SmallVectorImpl<llvm::Constant *> &fields);
559
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000560 /// \brief Shared code for virtual base adjustment. Returns the offset from
561 /// the vbptr to the virtual base. Optionally returns the address of the
562 /// vbptr itself.
563 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000564 Address Base,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000565 llvm::Value *VBPtrOffset,
566 llvm::Value *VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000567 llvm::Value **VBPtr = nullptr);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000568
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000569 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000570 Address Base,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000571 int32_t VBPtrOffset,
572 int32_t VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000573 llvm::Value **VBPtr = nullptr) {
Reid Kleckner0ba8ba42014-10-22 17:26:00 +0000574 assert(VBTableOffset % 4 == 0 && "should be byte offset into table of i32s");
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000575 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
576 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset);
577 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr);
578 }
579
Peter Collingbourne60108802017-12-13 21:53:04 +0000580 std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000581 performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000582 QualType SrcRecordTy);
583
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000584 /// \brief Performs a full virtual base adjustment. Used to dereference
585 /// pointers to members of virtual bases.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000586 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000587 const CXXRecordDecl *RD, Address Base,
Reid Kleckner2341ae32013-04-11 18:13:19 +0000588 llvm::Value *VirtualBaseAdjustmentOffset,
589 llvm::Value *VBPtrOffset /* optional */);
590
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000591 /// \brief Emits a full member pointer with the fields common to data and
592 /// function member pointers.
593 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField,
594 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +0000595 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +0000596 CharUnits NonVirtualBaseAdjustment,
597 unsigned VBTableIndex);
Reid Kleckner452abac2013-05-09 21:01:17 +0000598
Reid Kleckner452abac2013-05-09 21:01:17 +0000599 bool MemberPointerConstantIsNull(const MemberPointerType *MPT,
600 llvm::Constant *MP);
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000601
Reid Kleckner7810af02013-06-19 15:20:38 +0000602 /// \brief - Initialize all vbptrs of 'this' with RD as the complete type.
603 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
604
605 /// \brief Caching wrapper around VBTableBuilder::enumerateVBTables().
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000606 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000607
Hans Wennborg88497d62013-11-15 17:24:45 +0000608 /// \brief Generate a thunk for calling a virtual member function MD.
Reid Klecknere4a52202014-02-21 02:27:32 +0000609 llvm::Function *EmitVirtualMemPtrThunk(
610 const CXXMethodDecl *MD,
611 const MicrosoftVTableContext::MethodVFTableLocation &ML);
Hans Wennborg88497d62013-11-15 17:24:45 +0000612
Reid Kleckner407e8b62013-03-22 19:02:54 +0000613public:
Craig Topper4f12f102014-03-12 06:41:41 +0000614 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000615
Craig Topper4f12f102014-03-12 06:41:41 +0000616 bool isZeroInitializable(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000617
David Majnemerb3e56542014-08-07 22:56:13 +0000618 bool isMemberPointerConvertible(const MemberPointerType *MPT) const override {
619 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemer99281062014-09-18 22:05:54 +0000620 return RD->hasAttr<MSInheritanceAttr>();
621 }
622
Craig Topper4f12f102014-03-12 06:41:41 +0000623 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000624
Craig Topper4f12f102014-03-12 06:41:41 +0000625 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
626 CharUnits offset) override;
David Majnemere2be95b2015-06-23 07:31:01 +0000627 llvm::Constant *EmitMemberFunctionPointer(const CXXMethodDecl *MD) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000628 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000629
Craig Topper4f12f102014-03-12 06:41:41 +0000630 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
631 llvm::Value *L,
632 llvm::Value *R,
633 const MemberPointerType *MPT,
634 bool Inequality) override;
Reid Kleckner700c3ee2013-04-30 20:15:14 +0000635
Craig Topper4f12f102014-03-12 06:41:41 +0000636 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
637 llvm::Value *MemPtr,
638 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000639
Craig Topper4f12f102014-03-12 06:41:41 +0000640 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000641 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000642 Address Base, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000643 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000644
David Majnemer0d9ad682015-06-29 00:06:50 +0000645 llvm::Value *EmitNonNullMemberPointerConversion(
646 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
647 CastKind CK, CastExpr::path_const_iterator PathBegin,
648 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
649 CGBuilderTy &Builder);
650
Craig Topper4f12f102014-03-12 06:41:41 +0000651 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
652 const CastExpr *E,
653 llvm::Value *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000654
Craig Topper4f12f102014-03-12 06:41:41 +0000655 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
656 llvm::Constant *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000657
David Majnemer5ca193c2015-06-23 07:31:07 +0000658 llvm::Constant *EmitMemberPointerConversion(
659 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
660 CastKind CK, CastExpr::path_const_iterator PathBegin,
661 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src);
662
John McCallb92ab1a2016-10-26 23:46:34 +0000663 CGCallee
David Majnemer2b0d66d2014-02-20 23:22:07 +0000664 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000665 Address This, llvm::Value *&ThisPtrForCall,
666 llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000667 const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000668
Rafael Espindola91f68b42014-09-15 19:20:10 +0000669 void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) override;
670
David Majnemer7c237072015-03-05 00:46:22 +0000671 llvm::StructType *getCatchableTypeType() {
672 if (CatchableTypeType)
673 return CatchableTypeType;
674 llvm::Type *FieldTypes[] = {
675 CGM.IntTy, // Flags
676 getImageRelativeType(CGM.Int8PtrTy), // TypeDescriptor
677 CGM.IntTy, // NonVirtualAdjustment
678 CGM.IntTy, // OffsetToVBPtr
679 CGM.IntTy, // VBTableIndex
680 CGM.IntTy, // Size
681 getImageRelativeType(CGM.Int8PtrTy) // CopyCtor
682 };
683 CatchableTypeType = llvm::StructType::create(
684 CGM.getLLVMContext(), FieldTypes, "eh.CatchableType");
685 return CatchableTypeType;
686 }
687
688 llvm::StructType *getCatchableTypeArrayType(uint32_t NumEntries) {
689 llvm::StructType *&CatchableTypeArrayType =
690 CatchableTypeArrayTypeMap[NumEntries];
691 if (CatchableTypeArrayType)
692 return CatchableTypeArrayType;
693
694 llvm::SmallString<23> CTATypeName("eh.CatchableTypeArray.");
695 CTATypeName += llvm::utostr(NumEntries);
696 llvm::Type *CTType =
697 getImageRelativeType(getCatchableTypeType()->getPointerTo());
698 llvm::Type *FieldTypes[] = {
699 CGM.IntTy, // NumEntries
700 llvm::ArrayType::get(CTType, NumEntries) // CatchableTypes
701 };
702 CatchableTypeArrayType =
703 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, CTATypeName);
704 return CatchableTypeArrayType;
705 }
706
707 llvm::StructType *getThrowInfoType() {
708 if (ThrowInfoType)
709 return ThrowInfoType;
710 llvm::Type *FieldTypes[] = {
711 CGM.IntTy, // Flags
712 getImageRelativeType(CGM.Int8PtrTy), // CleanupFn
713 getImageRelativeType(CGM.Int8PtrTy), // ForwardCompat
714 getImageRelativeType(CGM.Int8PtrTy) // CatchableTypeArray
715 };
716 ThrowInfoType = llvm::StructType::create(CGM.getLLVMContext(), FieldTypes,
717 "eh.ThrowInfo");
718 return ThrowInfoType;
719 }
720
721 llvm::Constant *getThrowFn() {
722 // _CxxThrowException is passed an exception object and a ThrowInfo object
723 // which describes the exception.
724 llvm::Type *Args[] = {CGM.Int8PtrTy, getThrowInfoType()->getPointerTo()};
725 llvm::FunctionType *FTy =
726 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
727 auto *Fn = cast<llvm::Function>(
728 CGM.CreateRuntimeFunction(FTy, "_CxxThrowException"));
729 // _CxxThrowException is stdcall on 32-bit x86 platforms.
730 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::x86)
731 Fn->setCallingConv(llvm::CallingConv::X86_StdCall);
732 return Fn;
733 }
734
David Majnemer37fd66e2015-03-13 22:36:55 +0000735 llvm::Function *getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
736 CXXCtorType CT);
David Majnemerdfa6d202015-03-11 18:36:39 +0000737
David Majnemer7c237072015-03-05 00:46:22 +0000738 llvm::Constant *getCatchableType(QualType T,
739 uint32_t NVOffset = 0,
740 int32_t VBPtrOffset = -1,
741 uint32_t VBIndex = 0);
742
743 llvm::GlobalVariable *getCatchableTypeArray(QualType T);
744
David Majnemerba3e5ec2015-03-13 18:26:17 +0000745 llvm::GlobalVariable *getThrowInfo(QualType T) override;
David Majnemer7c237072015-03-05 00:46:22 +0000746
Peter Collingbourne60108802017-12-13 21:53:04 +0000747 std::pair<llvm::Value *, const CXXRecordDecl *>
748 LoadVTablePtr(CodeGenFunction &CGF, Address This,
749 const CXXRecordDecl *RD) override;
750
Reid Kleckner7810af02013-06-19 15:20:38 +0000751private:
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000752 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy;
David Majnemerd905da42014-07-01 20:30:31 +0000753 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy;
754 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000755 /// \brief All the vftables that have been referenced.
756 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000757 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000758
759 /// \brief This set holds the record decls we've deferred vtable emission for.
760 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
761
762
763 /// \brief All the vbtables which have been referenced.
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000764 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap;
Reid Klecknerd8110b62013-09-10 20:14:30 +0000765
766 /// Info on the global variable used to guard initialization of static locals.
767 /// The BitIndex field is only used for externally invisible declarations.
768 struct GuardInfo {
Craig Topper8a13c412014-05-21 05:09:00 +0000769 GuardInfo() : Guard(nullptr), BitIndex(0) {}
Reid Klecknerd8110b62013-09-10 20:14:30 +0000770 llvm::GlobalVariable *Guard;
771 unsigned BitIndex;
772 };
773
774 /// Map from DeclContext to the current guard variable. We assume that the
775 /// AST is visited in source code order.
776 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap;
David Majnemerec8e54b2015-05-07 21:19:06 +0000777 llvm::DenseMap<const DeclContext *, GuardInfo> ThreadLocalGuardVariableMap;
David Majnemer8354eee2015-05-07 06:15:46 +0000778 llvm::DenseMap<const DeclContext *, unsigned> ThreadSafeGuardNumMap;
David Majnemer611cdb92014-07-07 08:09:15 +0000779
780 llvm::DenseMap<size_t, llvm::StructType *> TypeDescriptorTypeMap;
781 llvm::StructType *BaseClassDescriptorType;
782 llvm::StructType *ClassHierarchyDescriptorType;
783 llvm::StructType *CompleteObjectLocatorType;
David Majnemer7c237072015-03-05 00:46:22 +0000784
785 llvm::DenseMap<QualType, llvm::GlobalVariable *> CatchableTypeArrays;
786
787 llvm::StructType *CatchableTypeType;
788 llvm::DenseMap<uint32_t, llvm::StructType *> CatchableTypeArrayTypeMap;
789 llvm::StructType *ThrowInfoType;
Charles Davis74ce8592010-06-09 23:25:41 +0000790};
791
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000792}
Charles Davis74ce8592010-06-09 23:25:41 +0000793
Reid Klecknere39ee212014-05-03 00:33:28 +0000794CGCXXABI::RecordArgABI
795MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const {
796 switch (CGM.getTarget().getTriple().getArch()) {
797 default:
798 // FIXME: Implement for other architectures.
799 return RAA_Default;
800
Reid Kleckner44051e62016-08-25 18:23:28 +0000801 case llvm::Triple::thumb:
802 // Use the simple Itanium rules for now.
803 // FIXME: This is incompatible with MSVC for arguments with a dtor and no
804 // copy ctor.
805 return !canCopyArgument(RD) ? RAA_Indirect : RAA_Default;
806
Reid Klecknere39ee212014-05-03 00:33:28 +0000807 case llvm::Triple::x86:
Reid Klecknercf87e102014-05-14 16:02:09 +0000808 // All record arguments are passed in memory on x86. Decide whether to
809 // construct the object directly in argument memory, or to construct the
810 // argument elsewhere and copy the bytes during the call.
811
812 // If C++ prohibits us from making a copy, construct the arguments directly
813 // into argument memory.
814 if (!canCopyArgument(RD))
Reid Klecknere39ee212014-05-03 00:33:28 +0000815 return RAA_DirectInMemory;
Reid Klecknercf87e102014-05-14 16:02:09 +0000816
817 // Otherwise, construct the argument into a temporary and copy the bytes
818 // into the outgoing argument memory.
Reid Klecknere39ee212014-05-03 00:33:28 +0000819 return RAA_Default;
820
821 case llvm::Triple::x86_64:
Akira Hatanaka02914dc2018-02-05 20:23:22 +0000822 bool CopyCtorIsTrivial = false, CopyCtorIsTrivialForCall = false;
823 bool DtorIsTrivialForCall = false;
Reid Klecknercf87e102014-05-14 16:02:09 +0000824
Richard Smith96cd6712017-08-16 01:49:53 +0000825 // If a class has at least one non-deleted, trivial copy constructor, it
826 // is passed according to the C ABI. Otherwise, it is passed indirectly.
827 //
828 // Note: This permits classes with non-trivial copy or move ctors to be
829 // passed in registers, so long as they *also* have a trivial copy ctor,
830 // which is non-conforming.
831 if (RD->needsImplicitCopyConstructor()) {
Akira Hatanaka02914dc2018-02-05 20:23:22 +0000832 if (!RD->defaultedCopyConstructorIsDeleted()) {
833 if (RD->hasTrivialCopyConstructor())
834 CopyCtorIsTrivial = true;
835 if (RD->hasTrivialCopyConstructorForCall())
836 CopyCtorIsTrivialForCall = true;
837 }
Richard Smith96cd6712017-08-16 01:49:53 +0000838 } else {
Richard Smith96cd6712017-08-16 01:49:53 +0000839 for (const CXXConstructorDecl *CD : RD->ctors()) {
Akira Hatanaka02914dc2018-02-05 20:23:22 +0000840 if (CD->isCopyConstructor() && !CD->isDeleted()) {
841 if (CD->isTrivial())
842 CopyCtorIsTrivial = true;
843 if (CD->isTrivialForCall())
844 CopyCtorIsTrivialForCall = true;
Richard Smith96cd6712017-08-16 01:49:53 +0000845 }
Reid Klecknercf87e102014-05-14 16:02:09 +0000846 }
847 }
848
Akira Hatanaka02914dc2018-02-05 20:23:22 +0000849 if (RD->needsImplicitDestructor()) {
850 if (!RD->defaultedDestructorIsDeleted() &&
851 RD->hasTrivialDestructorForCall())
852 DtorIsTrivialForCall = true;
853 } else if (const auto *D = RD->getDestructor()) {
854 if (!D->isDeleted() && D->isTrivialForCall())
855 DtorIsTrivialForCall = true;
856 }
857
858 // If the copy ctor and dtor are both trivial-for-calls, pass direct.
859 if (CopyCtorIsTrivialForCall && DtorIsTrivialForCall)
860 return RAA_Default;
861
862 // If a class has a destructor, we'd really like to pass it indirectly
863 // because it allows us to elide copies. Unfortunately, MSVC makes that
864 // impossible for small types, which it will pass in a single register or
865 // stack slot. Most objects with dtors are large-ish, so handle that early.
866 // We can't call out all large objects as being indirect because there are
867 // multiple x64 calling conventions and the C++ ABI code shouldn't dictate
868 // how we pass large POD types.
869
870 // Note: This permits small classes with nontrivial destructors to be
871 // passed in registers, which is non-conforming.
872 if (CopyCtorIsTrivial &&
873 getContext().getTypeSize(RD->getTypeForDecl()) <= 64)
874 return RAA_Default;
Peter Collingbourne120eb542016-11-22 00:21:43 +0000875 return RAA_Indirect;
Reid Klecknere39ee212014-05-03 00:33:28 +0000876 }
877
878 llvm_unreachable("invalid enum");
879}
880
David Majnemer08681372014-11-01 07:37:17 +0000881void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
882 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000883 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +0000884 QualType ElementType,
885 const CXXDestructorDecl *Dtor) {
David Majnemer0c0b6d92014-10-31 20:09:12 +0000886 // FIXME: Provide a source location here even though there's no
887 // CXXMemberCallExpr for dtor call.
David Majnemer08681372014-11-01 07:37:17 +0000888 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000889 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
890 llvm::Value *MDThis =
891 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr);
892 if (UseGlobalDelete)
David Majnemer08681372014-11-01 07:37:17 +0000893 CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType);
John McCall82fb8922012-09-25 10:10:39 +0000894}
895
David Majnemer442d0a22014-11-25 07:20:20 +0000896void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
David Majnemer7c237072015-03-05 00:46:22 +0000897 llvm::Value *Args[] = {
898 llvm::ConstantPointerNull::get(CGM.Int8PtrTy),
899 llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())};
900 auto *Fn = getThrowFn();
David Majnemer442d0a22014-11-25 07:20:20 +0000901 if (isNoReturn)
902 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args);
903 else
904 CGF.EmitRuntimeCallOrInvoke(Fn, Args);
905}
906
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000907namespace {
Reid Kleckner129552b2015-10-08 01:13:52 +0000908struct CatchRetScope final : EHScopeStack::Cleanup {
David Majnemere888a2f2015-08-15 03:21:08 +0000909 llvm::CatchPadInst *CPI;
910
Reid Kleckner129552b2015-10-08 01:13:52 +0000911 CatchRetScope(llvm::CatchPadInst *CPI) : CPI(CPI) {}
David Majnemere888a2f2015-08-15 03:21:08 +0000912
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000913 void Emit(CodeGenFunction &CGF, Flags flags) override {
Reid Kleckner129552b2015-10-08 01:13:52 +0000914 llvm::BasicBlock *BB = CGF.createBasicBlock("catchret.dest");
915 CGF.Builder.CreateCatchRet(CPI, BB);
916 CGF.EmitBlock(BB);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000917 }
918};
919}
920
921void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF,
922 const CXXCatchStmt *S) {
923 // In the MS ABI, the runtime handles the copy, and the catch handler is
924 // responsible for destruction.
925 VarDecl *CatchParam = S->getExceptionDecl();
David Majnemer4e52d6f2015-12-12 05:39:21 +0000926 llvm::BasicBlock *CatchPadBB = CGF.Builder.GetInsertBlock();
Reid Kleckner129552b2015-10-08 01:13:52 +0000927 llvm::CatchPadInst *CPI =
928 cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
David Majnemer4e52d6f2015-12-12 05:39:21 +0000929 CGF.CurrentFuncletPad = CPI;
Reid Kleckner129552b2015-10-08 01:13:52 +0000930
Reid Kleckner67cf0352015-04-07 00:09:59 +0000931 // If this is a catch-all or the catch parameter is unnamed, we don't need to
932 // emit an alloca to the object.
933 if (!CatchParam || !CatchParam->getDeclName()) {
Reid Kleckner129552b2015-10-08 01:13:52 +0000934 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000935 return;
936 }
937
938 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
Reid Kleckner129552b2015-10-08 01:13:52 +0000939 CPI->setArgOperand(2, var.getObjectAddress(CGF).getPointer());
940 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000941 CGF.EmitAutoVarCleanups(var);
942}
943
John McCall7f416cc2015-09-08 08:05:57 +0000944/// We need to perform a generic polymorphic operation (like a typeid
945/// or a cast), which requires an object with a vfptr. Adjust the
946/// address to point to an object with a vfptr.
Peter Collingbourne60108802017-12-13 21:53:04 +0000947std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000948MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000949 QualType SrcRecordTy) {
David Majnemer1162d252014-06-22 19:05:33 +0000950 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
951 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
David Majnemer9ced3dd2015-03-14 23:44:48 +0000952 const ASTContext &Context = getContext();
David Majnemer1162d252014-06-22 19:05:33 +0000953
John McCall7f416cc2015-09-08 08:05:57 +0000954 // If the class itself has a vfptr, great. This check implicitly
955 // covers non-virtual base subobjects: a class with its own virtual
956 // functions would be a candidate to be a primary base.
David Majnemer5bc883f2015-02-27 02:38:02 +0000957 if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
Peter Collingbourne60108802017-12-13 21:53:04 +0000958 return std::make_tuple(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0),
959 SrcDecl);
David Majnemer1162d252014-06-22 19:05:33 +0000960
John McCall7f416cc2015-09-08 08:05:57 +0000961 // Okay, one of the vbases must have a vfptr, or else this isn't
962 // actually a polymorphic class.
963 const CXXRecordDecl *PolymorphicBase = nullptr;
964 for (auto &Base : SrcDecl->vbases()) {
965 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
966 if (Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr()) {
967 PolymorphicBase = BaseDecl;
968 break;
969 }
970 }
971 assert(PolymorphicBase && "polymorphic class has no apparent vfptr?");
972
973 llvm::Value *Offset =
974 GetVirtualBaseClassOffset(CGF, Value, SrcDecl, PolymorphicBase);
975 llvm::Value *Ptr = CGF.Builder.CreateInBoundsGEP(Value.getPointer(), Offset);
John McCall7f416cc2015-09-08 08:05:57 +0000976 CharUnits VBaseAlign =
977 CGF.CGM.getVBaseAlignment(Value.getAlignment(), SrcDecl, PolymorphicBase);
Peter Collingbourne60108802017-12-13 21:53:04 +0000978 return std::make_tuple(Address(Ptr, VBaseAlign), Offset, PolymorphicBase);
David Majnemer1162d252014-06-22 19:05:33 +0000979}
980
981bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
982 QualType SrcRecordTy) {
983 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
984 return IsDeref &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000985 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000986}
987
988static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF,
989 llvm::Value *Argument) {
990 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
991 llvm::FunctionType *FTy =
992 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
993 llvm::Value *Args[] = {Argument};
994 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
995 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
996}
997
998void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
999 llvm::CallSite Call =
1000 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
1001 Call.setDoesNotReturn();
1002 CGF.Builder.CreateUnreachable();
1003}
1004
1005llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
1006 QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +00001007 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +00001008 llvm::Type *StdTypeInfoPtrTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +00001009 std::tie(ThisPtr, std::ignore, std::ignore) =
David Majnemer17755352016-07-09 19:26:25 +00001010 performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +00001011 auto Typeid = emitRTtypeidCall(CGF, ThisPtr.getPointer()).getInstruction();
1012 return CGF.Builder.CreateBitCast(Typeid, StdTypeInfoPtrTy);
David Majnemer1162d252014-06-22 19:05:33 +00001013}
1014
1015bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
1016 QualType SrcRecordTy) {
1017 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
1018 return SrcIsPtr &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001019 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +00001020}
1021
1022llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
John McCall7f416cc2015-09-08 08:05:57 +00001023 CodeGenFunction &CGF, Address This, QualType SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00001024 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
1025 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
1026
1027 llvm::Value *SrcRTTI =
1028 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
1029 llvm::Value *DestRTTI =
1030 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
1031
1032 llvm::Value *Offset;
Peter Collingbourne60108802017-12-13 21:53:04 +00001033 std::tie(This, Offset, std::ignore) =
1034 performBaseAdjustment(CGF, This, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +00001035 llvm::Value *ThisPtr = This.getPointer();
David Majnemer17755352016-07-09 19:26:25 +00001036 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
David Majnemer1162d252014-06-22 19:05:33 +00001037
1038 // PVOID __RTDynamicCast(
1039 // PVOID inptr,
1040 // LONG VfDelta,
1041 // PVOID SrcType,
1042 // PVOID TargetType,
1043 // BOOL isReference)
1044 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
1045 CGF.Int8PtrTy, CGF.Int32Ty};
1046 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1047 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1048 "__RTDynamicCast");
1049 llvm::Value *Args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001050 ThisPtr, Offset, SrcRTTI, DestRTTI,
David Majnemer1162d252014-06-22 19:05:33 +00001051 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
John McCall7f416cc2015-09-08 08:05:57 +00001052 ThisPtr = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction();
1053 return CGF.Builder.CreateBitCast(ThisPtr, DestLTy);
David Majnemer1162d252014-06-22 19:05:33 +00001054}
1055
1056llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00001057MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +00001058 QualType SrcRecordTy,
1059 QualType DestTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +00001060 std::tie(Value, std::ignore, std::ignore) =
1061 performBaseAdjustment(CGF, Value, SrcRecordTy);
David Majnemer1162d252014-06-22 19:05:33 +00001062
1063 // PVOID __RTCastToVoid(
1064 // PVOID inptr)
1065 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
1066 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1067 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1068 "__RTCastToVoid");
John McCall7f416cc2015-09-08 08:05:57 +00001069 llvm::Value *Args[] = {Value.getPointer()};
David Majnemer1162d252014-06-22 19:05:33 +00001070 return CGF.EmitRuntimeCall(Function, Args);
1071}
1072
1073bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
1074 return false;
1075}
1076
David Majnemerca32f932014-09-01 18:50:02 +00001077llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
John McCall7f416cc2015-09-08 08:05:57 +00001078 CodeGenFunction &CGF, Address This, const CXXRecordDecl *ClassDecl,
David Majnemerca32f932014-09-01 18:50:02 +00001079 const CXXRecordDecl *BaseClassDecl) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001080 const ASTContext &Context = getContext();
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00001081 int64_t VBPtrChars =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001082 Context.getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001083 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
David Majnemer9ced3dd2015-03-14 23:44:48 +00001084 CharUnits IntSize = Context.getTypeSizeInChars(Context.IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001085 CharUnits VBTableChars =
1086 IntSize *
1087 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001088 llvm::Value *VBTableOffset =
David Majnemerca32f932014-09-01 18:50:02 +00001089 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001090
1091 llvm::Value *VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001092 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001093 VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001094 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001095 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
1096}
1097
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001098bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
1099 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +00001100}
1101
David Majnemer0c0b6d92014-10-31 20:09:12 +00001102static bool isDeletingDtor(GlobalDecl GD) {
1103 return isa<CXXDestructorDecl>(GD.getDecl()) &&
1104 GD.getDtorType() == Dtor_Deleting;
1105}
1106
1107bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const {
1108 return isDeletingDtor(GD);
1109}
1110
Reid Kleckner40ca9132014-05-13 22:05:45 +00001111bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
1112 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
1113 if (!RD)
1114 return false;
1115
John McCall7f416cc2015-09-08 08:05:57 +00001116 CharUnits Align = CGM.getContext().getTypeAlignInChars(FI.getReturnType());
Reid Kleckner40ca9132014-05-13 22:05:45 +00001117 if (FI.isInstanceMethod()) {
1118 // If it's an instance method, aggregates are always returned indirectly via
1119 // the second parameter.
John McCall7f416cc2015-09-08 08:05:57 +00001120 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001121 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod());
1122 return true;
1123 } else if (!RD->isPOD()) {
1124 // If it's a free function, non-POD types are returned indirectly.
John McCall7f416cc2015-09-08 08:05:57 +00001125 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001126 return true;
1127 }
1128
1129 // Otherwise, use the C ABI rules.
1130 return false;
1131}
1132
Reid Kleckner7810af02013-06-19 15:20:38 +00001133llvm::BasicBlock *
1134MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
1135 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001136 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1137 assert(IsMostDerivedClass &&
1138 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +00001139 llvm::Value *IsCompleteObject =
1140 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001141
1142 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
1143 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
1144 CGF.Builder.CreateCondBr(IsCompleteObject,
1145 CallVbaseCtorsBB, SkipVbaseCtorsBB);
1146
1147 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +00001148
1149 // Fill in the vbtable pointers here.
1150 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001151
1152 // CGF will put the base ctor calls in this basic block for us later.
1153
1154 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +00001155}
1156
Erich Keane13c7ec52016-12-07 00:21:45 +00001157llvm::BasicBlock *
1158MicrosoftCXXABI::EmitDtorCompleteObjectHandler(CodeGenFunction &CGF) {
1159 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1160 assert(IsMostDerivedClass &&
1161 "ctor for a class with virtual bases must have an implicit parameter");
1162 llvm::Value *IsCompleteObject =
1163 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
1164
1165 llvm::BasicBlock *CallVbaseDtorsBB = CGF.createBasicBlock("Dtor.dtor_vbases");
1166 llvm::BasicBlock *SkipVbaseDtorsBB = CGF.createBasicBlock("Dtor.skip_vbases");
1167 CGF.Builder.CreateCondBr(IsCompleteObject,
1168 CallVbaseDtorsBB, SkipVbaseDtorsBB);
1169
1170 CGF.EmitBlock(CallVbaseDtorsBB);
1171 // CGF will put the base dtor calls in this basic block for us later.
1172
1173 return SkipVbaseDtorsBB;
1174}
1175
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001176void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
1177 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
1178 // In most cases, an override for a vbase virtual method can adjust
1179 // the "this" parameter by applying a constant offset.
1180 // However, this is not enough while a constructor or a destructor of some
1181 // class X is being executed if all the following conditions are met:
1182 // - X has virtual bases, (1)
1183 // - X overrides a virtual method M of a vbase Y, (2)
1184 // - X itself is a vbase of the most derived class.
1185 //
1186 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
1187 // which holds the extra amount of "this" adjustment we must do when we use
1188 // the X vftables (i.e. during X ctor or dtor).
1189 // Outside the ctors and dtors, the values of vtorDisps are zero.
1190
1191 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
1192 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
1193 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
1194 CGBuilderTy &Builder = CGF.Builder;
1195
John McCall7f416cc2015-09-08 08:05:57 +00001196 unsigned AS = getThisAddress(CGF).getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +00001197 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001198
Nico Weber91af2742018-03-07 23:15:20 +00001199 for (const CXXBaseSpecifier &S : RD->vbases()) {
1200 const CXXRecordDecl *VBase = S.getType()->getAsCXXRecordDecl();
1201 auto I = VBaseMap.find(VBase);
1202 assert(I != VBaseMap.end());
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001203 if (!I->second.hasVtorDisp())
1204 continue;
1205
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +00001206 llvm::Value *VBaseOffset =
Nico Weber91af2742018-03-07 23:15:20 +00001207 GetVirtualBaseClassOffset(CGF, getThisAddress(CGF), RD, VBase);
1208 uint64_t ConstantVBaseOffset = I->second.VBaseOffset.getQuantity();
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001209
1210 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
1211 llvm::Value *VtorDispValue = Builder.CreateSub(
David Majnemer17755352016-07-09 19:26:25 +00001212 VBaseOffset, llvm::ConstantInt::get(CGM.PtrDiffTy, ConstantVBaseOffset),
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001213 "vtordisp.value");
David Majnemer17755352016-07-09 19:26:25 +00001214 VtorDispValue = Builder.CreateTruncOrBitCast(VtorDispValue, CGF.Int32Ty);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001215
1216 if (!Int8This)
1217 Int8This = Builder.CreateBitCast(getThisValue(CGF),
1218 CGF.Int8Ty->getPointerTo(AS));
1219 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
1220 // vtorDisp is always the 32-bits before the vbase in the class layout.
1221 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
1222 VtorDispPtr = Builder.CreateBitCast(
1223 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
1224
John McCall7f416cc2015-09-08 08:05:57 +00001225 Builder.CreateAlignedStore(VtorDispValue, VtorDispPtr,
1226 CharUnits::fromQuantity(4));
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001227 }
1228}
1229
David Majnemer37fd66e2015-03-13 22:36:55 +00001230static bool hasDefaultCXXMethodCC(ASTContext &Context,
1231 const CXXMethodDecl *MD) {
1232 CallingConv ExpectedCallingConv = Context.getDefaultCallingConvention(
1233 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1234 CallingConv ActualCallingConv =
1235 MD->getType()->getAs<FunctionProtoType>()->getCallConv();
1236 return ExpectedCallingConv == ActualCallingConv;
1237}
1238
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001239void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1240 // There's only one constructor type in this ABI.
1241 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
David Majnemer37fd66e2015-03-13 22:36:55 +00001242
1243 // Exported default constructors either have a simple call-site where they use
1244 // the typical calling convention and have a single 'this' pointer for an
1245 // argument -or- they get a wrapper function which appropriately thunks to the
1246 // real default constructor. This thunk is the default constructor closure.
1247 if (D->hasAttr<DLLExportAttr>() && D->isDefaultConstructor())
1248 if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) {
1249 llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure);
1250 Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage);
Rafael Espindolab7350042018-03-01 00:35:47 +00001251 CGM.setGVProperties(Fn, D);
David Majnemer37fd66e2015-03-13 22:36:55 +00001252 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001253}
1254
Reid Kleckner7810af02013-06-19 15:20:38 +00001255void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1256 const CXXRecordDecl *RD) {
John McCall7f416cc2015-09-08 08:05:57 +00001257 Address This = getThisAddress(CGF);
1258 This = CGF.Builder.CreateElementBitCast(This, CGM.Int8Ty, "this.int8");
David Majnemer9ced3dd2015-03-14 23:44:48 +00001259 const ASTContext &Context = getContext();
1260 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001261
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001262 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1263 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00001264 const std::unique_ptr<VPtrInfo> &VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001265 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +00001266 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001267 Context.getASTRecordLayout(VBT->IntroducingObject);
Reid Kleckner5f080942014-01-03 23:42:00 +00001268 CharUnits Offs = VBT->NonVirtualOffset;
1269 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001270 if (VBT->getVBaseWithVPtr())
1271 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
John McCall7f416cc2015-09-08 08:05:57 +00001272 Address VBPtr = CGF.Builder.CreateConstInBoundsByteGEP(This, Offs);
David Blaikie1ed728c2015-04-05 22:45:47 +00001273 llvm::Value *GVPtr =
1274 CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001275 VBPtr = CGF.Builder.CreateElementBitCast(VBPtr, GVPtr->getType(),
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001276 "vbptr." + VBT->ObjectWithVPtr->getName());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001277 CGF.Builder.CreateStore(GVPtr, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +00001278 }
1279}
1280
George Burgess IVf203dbf2017-02-22 20:28:02 +00001281CGCXXABI::AddedStructorArgs
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001282MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001283 SmallVectorImpl<CanQualType> &ArgTys) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001284 AddedStructorArgs Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001285 // TODO: 'for base' flag
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001286 if (T == StructorType::Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001287 // The scalar deleting destructor takes an implicit int parameter.
David Majnemer9ced3dd2015-03-14 23:44:48 +00001288 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001289 ++Added.Suffix;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001290 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001291 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
1292 if (!CD)
George Burgess IVf203dbf2017-02-22 20:28:02 +00001293 return Added;
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001294
1295 // All parameters are already in place except is_most_derived, which goes
1296 // after 'this' if it's variadic and last if it's not.
1297
1298 const CXXRecordDecl *Class = CD->getParent();
1299 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1300 if (Class->getNumVBases()) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001301 if (FPT->isVariadic()) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001302 ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001303 ++Added.Prefix;
1304 } else {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001305 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001306 ++Added.Suffix;
1307 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001308 }
George Burgess IVf203dbf2017-02-22 20:28:02 +00001309
1310 return Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001311}
1312
Reid Klecknere7de47e2013-07-22 13:51:44 +00001313void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1314 // The TU defining a dtor is only guaranteed to emit a base destructor. All
1315 // other destructor variants are delegating thunks.
1316 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1317}
1318
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001319CharUnits
1320MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001321 GD = GD.getCanonicalDecl();
1322 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001323
1324 GlobalDecl LookupGD = GD;
1325 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1326 // Complete destructors take a pointer to the complete object as a
1327 // parameter, thus don't need this adjustment.
1328 if (GD.getDtorType() == Dtor_Complete)
1329 return CharUnits();
1330
1331 // There's no Dtor_Base in vftable but it shares the this adjustment with
1332 // the deleting one, so look it up instead.
1333 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1334 }
1335
1336 MicrosoftVTableContext::MethodVFTableLocation ML =
1337 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
1338 CharUnits Adjustment = ML.VFPtrOffset;
1339
1340 // Normal virtual instance methods need to adjust from the vfptr that first
1341 // defined the virtual method to the virtual base subobject, but destructors
1342 // do not. The vector deleting destructor thunk applies this adjustment for
1343 // us if necessary.
1344 if (isa<CXXDestructorDecl>(MD))
1345 Adjustment = CharUnits::Zero();
1346
1347 if (ML.VBase) {
1348 const ASTRecordLayout &DerivedLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001349 getContext().getASTRecordLayout(MD->getParent());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001350 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1351 }
1352
1353 return Adjustment;
1354}
1355
John McCall7f416cc2015-09-08 08:05:57 +00001356Address MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1357 CodeGenFunction &CGF, GlobalDecl GD, Address This,
1358 bool VirtualCall) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001359 if (!VirtualCall) {
1360 // If the call of a virtual function is not virtual, we just have to
1361 // compensate for the adjustment the virtual function does in its prologue.
1362 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1363 if (Adjustment.isZero())
1364 return This;
1365
John McCall7f416cc2015-09-08 08:05:57 +00001366 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001367 assert(Adjustment.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001368 return CGF.Builder.CreateConstByteGEP(This, Adjustment);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001369 }
1370
1371 GD = GD.getCanonicalDecl();
1372 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001373
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001374 GlobalDecl LookupGD = GD;
1375 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1376 // Complete dtors take a pointer to the complete object,
1377 // thus don't need adjustment.
1378 if (GD.getDtorType() == Dtor_Complete)
1379 return This;
1380
1381 // There's only Dtor_Deleting in vftable but it shares the this adjustment
1382 // with the base one, so look up the deleting one instead.
1383 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1384 }
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001385 MicrosoftVTableContext::MethodVFTableLocation ML =
1386 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001387
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001388 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001389
1390 // Base destructors expect 'this' to point to the beginning of the base
1391 // subobject, not the first vfptr that happens to contain the virtual dtor.
1392 // However, we still need to apply the virtual base adjustment.
1393 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1394 StaticOffset = CharUnits::Zero();
1395
John McCall7f416cc2015-09-08 08:05:57 +00001396 Address Result = This;
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001397 if (ML.VBase) {
John McCall7f416cc2015-09-08 08:05:57 +00001398 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
1399
1400 const CXXRecordDecl *Derived = MD->getParent();
1401 const CXXRecordDecl *VBase = ML.VBase;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001402 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00001403 GetVirtualBaseClassOffset(CGF, Result, Derived, VBase);
1404 llvm::Value *VBasePtr =
1405 CGF.Builder.CreateInBoundsGEP(Result.getPointer(), VBaseOffset);
1406 CharUnits VBaseAlign =
1407 CGF.CGM.getVBaseAlignment(Result.getAlignment(), Derived, VBase);
1408 Result = Address(VBasePtr, VBaseAlign);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001409 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001410 if (!StaticOffset.isZero()) {
1411 assert(StaticOffset.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001412 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001413 if (ML.VBase) {
1414 // Non-virtual adjustment might result in a pointer outside the allocated
1415 // object, e.g. if the final overrider class is laid out after the virtual
1416 // base that declares a method in the most derived class.
1417 // FIXME: Update the code that emits this adjustment in thunks prologues.
John McCall7f416cc2015-09-08 08:05:57 +00001418 Result = CGF.Builder.CreateConstByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001419 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001420 Result = CGF.Builder.CreateConstInBoundsByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001421 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001422 }
John McCall7f416cc2015-09-08 08:05:57 +00001423 return Result;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001424}
1425
Reid Kleckner89077a12013-12-17 19:46:40 +00001426void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1427 QualType &ResTy,
1428 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001429 ASTContext &Context = getContext();
1430 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001431 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001432 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
Alexey Bataev56223232017-06-09 13:40:18 +00001433 auto *IsMostDerived = ImplicitParamDecl::Create(
1434 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1435 &Context.Idents.get("is_most_derived"), Context.IntTy,
1436 ImplicitParamDecl::Other);
Reid Kleckner89077a12013-12-17 19:46:40 +00001437 // The 'most_derived' parameter goes second if the ctor is variadic and last
1438 // if it's not. Dtors can't be variadic.
1439 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1440 if (FPT->isVariadic())
1441 Params.insert(Params.begin() + 1, IsMostDerived);
1442 else
1443 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001444 getStructorImplicitParamDecl(CGF) = IsMostDerived;
David Majnemer0c0b6d92014-10-31 20:09:12 +00001445 } else if (isDeletingDtor(CGF.CurGD)) {
Alexey Bataev56223232017-06-09 13:40:18 +00001446 auto *ShouldDelete = ImplicitParamDecl::Create(
1447 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1448 &Context.Idents.get("should_call_delete"), Context.IntTy,
1449 ImplicitParamDecl::Other);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001450 Params.push_back(ShouldDelete);
1451 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1452 }
John McCall0f999f32012-09-25 08:00:39 +00001453}
1454
1455void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
Justin Lebared4f1722016-07-27 22:04:24 +00001456 // Naked functions have no prolog.
1457 if (CGF.CurFuncDecl && CGF.CurFuncDecl->hasAttr<NakedAttr>())
1458 return;
1459
Reid Kleckner06239e42017-11-16 19:09:36 +00001460 // Overridden virtual methods of non-primary bases need to adjust the incoming
1461 // 'this' pointer in the prologue. In this hierarchy, C::b will subtract
1462 // sizeof(void*) to adjust from B* to C*:
1463 // struct A { virtual void a(); };
1464 // struct B { virtual void b(); };
1465 // struct C : A, B { virtual void b(); };
1466 //
1467 // Leave the value stored in the 'this' alloca unadjusted, so that the
1468 // debugger sees the unadjusted value. Microsoft debuggers require this, and
1469 // will apply the ThisAdjustment in the method type information.
1470 // FIXME: Do something better for DWARF debuggers, which won't expect this,
1471 // without making our codegen depend on debug info settings.
1472 llvm::Value *This = loadIncomingCXXThis(CGF);
1473 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1474 if (!CGF.CurFuncIsThunk && MD->isVirtual()) {
1475 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(CGF.CurGD);
1476 if (!Adjustment.isZero()) {
1477 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1478 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1479 *thisTy = This->getType();
1480 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1481 assert(Adjustment.isPositive());
1482 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
1483 -Adjustment.getQuantity());
1484 This = CGF.Builder.CreateBitCast(This, thisTy, "this.adjusted");
1485 }
1486 }
1487 setCXXABIThisValue(CGF, This);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001488
Reid Kleckner06239e42017-11-16 19:09:36 +00001489 // If this is a function that the ABI specifies returns 'this', initialize
1490 // the return slot to 'this' at the start of the function.
1491 //
1492 // Unlike the setting of return types, this is done within the ABI
1493 // implementation instead of by clients of CGCXXABI because:
1494 // 1) getThisValue is currently protected
1495 // 2) in theory, an ABI could implement 'this' returns some other way;
1496 // HasThisReturn only specifies a contract, not the implementation
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001497 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001498 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001499 else if (hasMostDerivedReturn(CGF.CurGD))
1500 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1501 CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001502
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001503 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1504 assert(getStructorImplicitParamDecl(CGF) &&
1505 "no implicit parameter for a constructor with virtual bases?");
1506 getStructorImplicitParamValue(CGF)
1507 = CGF.Builder.CreateLoad(
1508 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1509 "is_most_derived");
1510 }
1511
David Majnemer0c0b6d92014-10-31 20:09:12 +00001512 if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001513 assert(getStructorImplicitParamDecl(CGF) &&
1514 "no implicit parameter for a deleting destructor?");
1515 getStructorImplicitParamValue(CGF)
1516 = CGF.Builder.CreateLoad(
1517 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1518 "should_call_delete");
1519 }
John McCall0f999f32012-09-25 08:00:39 +00001520}
1521
George Burgess IVf203dbf2017-02-22 20:28:02 +00001522CGCXXABI::AddedStructorArgs MicrosoftCXXABI::addImplicitConstructorArgs(
Reid Kleckner89077a12013-12-17 19:46:40 +00001523 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1524 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001525 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001526
Reid Kleckner89077a12013-12-17 19:46:40 +00001527 // Check if we need a 'most_derived' parameter.
1528 if (!D->getParent()->getNumVBases())
George Burgess IVf203dbf2017-02-22 20:28:02 +00001529 return AddedStructorArgs{};
Reid Kleckner89077a12013-12-17 19:46:40 +00001530
1531 // Add the 'most_derived' argument second if we are variadic or last if not.
1532 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
David Majnemer833b91e2016-05-13 20:05:09 +00001533 llvm::Value *MostDerivedArg;
1534 if (Delegating) {
1535 MostDerivedArg = getStructorImplicitParamValue(CGF);
1536 } else {
1537 MostDerivedArg = llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001538 }
David Majnemer833b91e2016-05-13 20:05:09 +00001539 RValue RV = RValue::get(MostDerivedArg);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001540 if (FPT->isVariadic()) {
Yaxun Liu06dd8112018-03-07 21:45:40 +00001541 Args.insert(Args.begin() + 1, CallArg(RV, getContext().IntTy));
George Burgess IVf203dbf2017-02-22 20:28:02 +00001542 return AddedStructorArgs::prefix(1);
1543 }
1544 Args.add(RV, getContext().IntTy);
1545 return AddedStructorArgs::suffix(1);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001546}
1547
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001548void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1549 const CXXDestructorDecl *DD,
1550 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +00001551 bool Delegating, Address This) {
John McCallb92ab1a2016-10-26 23:46:34 +00001552 CGCallee Callee = CGCallee::forDirect(
1553 CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type)),
1554 DD);
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001555
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001556 if (DD->isVirtual()) {
1557 assert(Type != CXXDtorType::Dtor_Deleting &&
1558 "The deleting destructor should only be called via a virtual call");
1559 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1560 This, false);
1561 }
Erich Keane13c7ec52016-12-07 00:21:45 +00001562
1563 llvm::BasicBlock *BaseDtorEndBB = nullptr;
1564 if (ForVirtualBase && isa<CXXConstructorDecl>(CGF.CurCodeDecl)) {
1565 BaseDtorEndBB = EmitDtorCompleteObjectHandler(CGF);
1566 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001567
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001568 CGF.EmitCXXDestructorCall(DD, Callee, This.getPointer(),
1569 /*ImplicitParam=*/nullptr,
1570 /*ImplicitParamTy=*/QualType(), nullptr,
1571 getFromDtorType(Type));
Erich Keane13c7ec52016-12-07 00:21:45 +00001572 if (BaseDtorEndBB) {
1573 // Complete object handler should continue to be the remaining
1574 CGF.Builder.CreateBr(BaseDtorEndBB);
1575 CGF.EmitBlock(BaseDtorEndBB);
1576 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001577}
1578
Justin Lebar562914e2016-10-10 16:26:29 +00001579void MicrosoftCXXABI::emitVTableTypeMetadata(const VPtrInfo &Info,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001580 const CXXRecordDecl *RD,
1581 llvm::GlobalVariable *VTable) {
Peter Collingbourne1e1475a2017-01-18 23:55:27 +00001582 if (!CGM.getCodeGenOpts().LTOUnit)
Peter Collingbourned9546012015-06-19 02:30:43 +00001583 return;
1584
Peter Collingbournee5706442015-07-09 19:56:14 +00001585 // The location of the first virtual function pointer in the virtual table,
1586 // aka the "address point" on Itanium. This is at offset 0 if RTTI is
1587 // disabled, or sizeof(void*) if RTTI is enabled.
1588 CharUnits AddressPoint =
1589 getContext().getLangOpts().RTTIData
1590 ? getContext().toCharUnitsFromBits(
1591 getContext().getTargetInfo().getPointerWidth(0))
1592 : CharUnits::Zero();
Peter Collingbourned9546012015-06-19 02:30:43 +00001593
Justin Lebar562914e2016-10-10 16:26:29 +00001594 if (Info.PathToIntroducingObject.empty()) {
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001595 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001596 return;
1597 }
1598
1599 // Add a bitset entry for the least derived base belonging to this vftable.
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001600 CGM.AddVTableTypeMetadata(VTable, AddressPoint,
Justin Lebar562914e2016-10-10 16:26:29 +00001601 Info.PathToIntroducingObject.back());
Peter Collingbourned9546012015-06-19 02:30:43 +00001602
1603 // Add a bitset entry for each derived class that is laid out at the same
1604 // offset as the least derived base.
Justin Lebar562914e2016-10-10 16:26:29 +00001605 for (unsigned I = Info.PathToIntroducingObject.size() - 1; I != 0; --I) {
1606 const CXXRecordDecl *DerivedRD = Info.PathToIntroducingObject[I - 1];
1607 const CXXRecordDecl *BaseRD = Info.PathToIntroducingObject[I];
Peter Collingbourned9546012015-06-19 02:30:43 +00001608
1609 const ASTRecordLayout &Layout =
1610 getContext().getASTRecordLayout(DerivedRD);
1611 CharUnits Offset;
1612 auto VBI = Layout.getVBaseOffsetsMap().find(BaseRD);
1613 if (VBI == Layout.getVBaseOffsetsMap().end())
1614 Offset = Layout.getBaseClassOffset(BaseRD);
1615 else
1616 Offset = VBI->second.VBaseOffset;
1617 if (!Offset.isZero())
1618 return;
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001619 CGM.AddVTableTypeMetadata(VTable, AddressPoint, DerivedRD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001620 }
1621
1622 // Finally do the same for the most derived class.
Justin Lebar562914e2016-10-10 16:26:29 +00001623 if (Info.FullOffsetInMDC.isZero())
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001624 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001625}
1626
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001627void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1628 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001629 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001630 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001631
Justin Lebar562914e2016-10-10 16:26:29 +00001632 for (const std::unique_ptr<VPtrInfo>& Info : VFPtrs) {
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001633 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001634 if (VTable->hasInitializer())
1635 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001636
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001637 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001638 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
David Majnemer470ee612016-02-09 17:27:52 +00001639
1640 llvm::Constant *RTTI = nullptr;
1641 if (any_of(VTLayout.vtable_components(),
1642 [](const VTableComponent &VTC) { return VTC.isRTTIKind(); }))
Justin Lebar562914e2016-10-10 16:26:29 +00001643 RTTI = getMSCompleteObjectLocator(RD, *Info);
David Majnemer470ee612016-02-09 17:27:52 +00001644
John McCall9c6cb762016-11-28 22:18:33 +00001645 ConstantInitBuilder Builder(CGM);
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001646 auto Components = Builder.beginStruct();
John McCall9c6cb762016-11-28 22:18:33 +00001647 CGVT.createVTableInitializer(Components, VTLayout, RTTI);
1648 Components.finishAndSetAsInitializer(VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +00001649
Justin Lebar562914e2016-10-10 16:26:29 +00001650 emitVTableTypeMetadata(*Info, RD, VTable);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001651 }
1652}
1653
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001654bool MicrosoftCXXABI::isVirtualOffsetNeededForVTableField(
1655 CodeGenFunction &CGF, CodeGenFunction::VPtr Vptr) {
1656 return Vptr.NearestVBase != nullptr;
1657}
1658
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001659llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1660 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001661 const CXXRecordDecl *NearestVBase) {
1662 llvm::Constant *VTableAddressPoint = getVTableAddressPoint(Base, VTableClass);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001663 if (!VTableAddressPoint) {
1664 assert(Base.getBase()->getNumVBases() &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001665 !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001666 }
1667 return VTableAddressPoint;
1668}
1669
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001670static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Justin Lebar562914e2016-10-10 16:26:29 +00001671 const CXXRecordDecl *RD, const VPtrInfo &VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001672 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001673 llvm::raw_svector_ostream Out(Name);
Justin Lebar562914e2016-10-10 16:26:29 +00001674 MangleContext.mangleCXXVFTable(RD, VFPtr.MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001675}
1676
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001677llvm::Constant *
1678MicrosoftCXXABI::getVTableAddressPoint(BaseSubobject Base,
1679 const CXXRecordDecl *VTableClass) {
Piotr Padlewski4bed31b2015-09-10 20:18:30 +00001680 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1681 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001682 return VFTablesMap[ID];
1683}
1684
1685llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1686 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1687 llvm::Constant *VFTable = getVTableAddressPoint(Base, VTableClass);
David Majnemerd905da42014-07-01 20:30:31 +00001688 assert(VFTable && "Couldn't find a vftable for the given base?");
1689 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001690}
1691
1692llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1693 CharUnits VPtrOffset) {
1694 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1695 // shouldn't be used in the given record type. We want to cache this result in
1696 // VFTablesMap, thus a simple zero check is not sufficient.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001697
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001698 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001699 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001700 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001701 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001702 if (!Inserted)
1703 return I->second;
1704
1705 llvm::GlobalVariable *&VTable = I->second;
1706
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001707 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001708 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001709
David Blaikie82e95a32014-11-19 07:49:47 +00001710 if (DeferredVFTables.insert(RD).second) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001711 // We haven't processed this record type before.
Eric Christopherd160c502016-01-29 01:35:53 +00001712 // Queue up this vtable for possible deferred emission.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001713 CGM.addDeferredVTable(RD);
1714
1715#ifndef NDEBUG
1716 // Create all the vftables at once in order to make sure each vftable has
1717 // a unique mangled name.
1718 llvm::StringSet<> ObservedMangledNames;
1719 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1720 SmallString<256> Name;
Justin Lebar562914e2016-10-10 16:26:29 +00001721 mangleVFTableName(getMangleContext(), RD, *VFPtrs[J], Name);
David Blaikie61b86d42014-11-19 02:56:13 +00001722 if (!ObservedMangledNames.insert(Name.str()).second)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001723 llvm_unreachable("Already saw this mangling before?");
1724 }
1725#endif
1726 }
1727
Justin Lebar562914e2016-10-10 16:26:29 +00001728 const std::unique_ptr<VPtrInfo> *VFPtrI = std::find_if(
1729 VFPtrs.begin(), VFPtrs.end(), [&](const std::unique_ptr<VPtrInfo>& VPI) {
David Majnemera03849b2015-03-18 22:04:43 +00001730 return VPI->FullOffsetInMDC == VPtrOffset;
1731 });
1732 if (VFPtrI == VFPtrs.end()) {
1733 VFTablesMap[ID] = nullptr;
1734 return nullptr;
1735 }
Justin Lebar562914e2016-10-10 16:26:29 +00001736 const std::unique_ptr<VPtrInfo> &VFPtr = *VFPtrI;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001737
David Majnemera03849b2015-03-18 22:04:43 +00001738 SmallString<256> VFTableName;
Justin Lebar562914e2016-10-10 16:26:29 +00001739 mangleVFTableName(getMangleContext(), RD, *VFPtr, VFTableName);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001740
David Majnemer2d8b2002016-02-11 17:49:28 +00001741 // Classes marked __declspec(dllimport) need vftables generated on the
1742 // import-side in order to support features like constexpr. No other
1743 // translation unit relies on the emission of the local vftable, translation
1744 // units are expected to generate them as needed.
1745 //
1746 // Because of this unique behavior, we maintain this logic here instead of
1747 // getVTableLinkage.
1748 llvm::GlobalValue::LinkageTypes VFTableLinkage =
1749 RD->hasAttr<DLLImportAttr>() ? llvm::GlobalValue::LinkOnceODRLinkage
1750 : CGM.getVTableLinkage(RD);
David Majnemera03849b2015-03-18 22:04:43 +00001751 bool VFTableComesFromAnotherTU =
1752 llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) ||
1753 llvm::GlobalValue::isExternalLinkage(VFTableLinkage);
1754 bool VTableAliasIsRequred =
1755 !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData;
David Majnemerbb848712014-07-01 22:37:08 +00001756
David Majnemera03849b2015-03-18 22:04:43 +00001757 if (llvm::GlobalValue *VFTable =
1758 CGM.getModule().getNamedGlobal(VFTableName)) {
1759 VFTablesMap[ID] = VFTable;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001760 VTable = VTableAliasIsRequred
1761 ? cast<llvm::GlobalVariable>(
1762 cast<llvm::GlobalAlias>(VFTable)->getBaseObject())
1763 : cast<llvm::GlobalVariable>(VFTable);
1764 return VTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001765 }
1766
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001767 const VTableLayout &VTLayout =
1768 VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC);
David Majnemera03849b2015-03-18 22:04:43 +00001769 llvm::GlobalValue::LinkageTypes VTableLinkage =
1770 VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage;
1771
1772 StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str();
1773
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001774 llvm::Type *VTableType = CGM.getVTables().getVTableType(VTLayout);
David Majnemera03849b2015-03-18 22:04:43 +00001775
1776 // Create a backing variable for the contents of VTable. The VTable may
1777 // or may not include space for a pointer to RTTI data.
1778 llvm::GlobalValue *VFTable;
1779 VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType,
1780 /*isConstant=*/true, VTableLinkage,
1781 /*Initializer=*/nullptr, VTableName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001782 VTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001783
1784 llvm::Comdat *C = nullptr;
1785 if (!VFTableComesFromAnotherTU &&
1786 (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) ||
1787 (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) &&
1788 VTableAliasIsRequred)))
1789 C = CGM.getModule().getOrInsertComdat(VFTableName.str());
1790
1791 // Only insert a pointer into the VFTable for RTTI data if we are not
1792 // importing it. We never reference the RTTI data directly so there is no
1793 // need to make room for it.
1794 if (VTableAliasIsRequred) {
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001795 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.Int32Ty, 0),
1796 llvm::ConstantInt::get(CGM.Int32Ty, 0),
1797 llvm::ConstantInt::get(CGM.Int32Ty, 1)};
David Majnemera03849b2015-03-18 22:04:43 +00001798 // Create a GEP which points just after the first entry in the VFTable,
1799 // this should be the location of the first virtual method.
David Blaikiee3b172a2015-04-02 18:55:21 +00001800 llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr(
1801 VTable->getValueType(), VTable, GEPIndices);
David Majnemera03849b2015-03-18 22:04:43 +00001802 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) {
1803 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1804 if (C)
1805 C->setSelectionKind(llvm::Comdat::Largest);
1806 }
David Blaikie2a791d72015-09-14 18:38:22 +00001807 VFTable = llvm::GlobalAlias::create(CGM.Int8PtrTy,
1808 /*AddressSpace=*/0, VFTableLinkage,
1809 VFTableName.str(), VTableGEP,
1810 &CGM.getModule());
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001811 VFTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001812 } else {
1813 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1814 // be referencing any RTTI data.
1815 // The GlobalVariable will end up being an appropriate definition of the
1816 // VFTable.
1817 VFTable = VTable;
1818 }
1819 if (C)
1820 VTable->setComdat(C);
1821
David Majnemer2d8b2002016-02-11 17:49:28 +00001822 if (RD->hasAttr<DLLExportAttr>())
David Majnemera03849b2015-03-18 22:04:43 +00001823 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1824
1825 VFTablesMap[ID] = VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001826 return VTable;
1827}
1828
John McCall9831b842018-02-06 18:52:44 +00001829CGCallee MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1830 GlobalDecl GD,
1831 Address This,
1832 llvm::Type *Ty,
1833 SourceLocation Loc) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001834 GD = GD.getCanonicalDecl();
1835 CGBuilderTy &Builder = CGF.Builder;
1836
1837 Ty = Ty->getPointerTo()->getPointerTo();
John McCall7f416cc2015-09-08 08:05:57 +00001838 Address VPtr =
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001839 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001840
1841 auto *MethodDecl = cast<CXXMethodDecl>(GD.getDecl());
1842 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty, MethodDecl->getParent());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001843
David Majnemer07c915e2016-10-27 17:11:51 +00001844 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001845 MicrosoftVTableContext::MethodVFTableLocation ML =
David Majnemer07c915e2016-10-27 17:11:51 +00001846 VFTContext.getMethodVFTableLocation(GD);
1847
1848 // Compute the identity of the most derived class whose virtual table is
1849 // located at the MethodVFTableLocation ML.
1850 auto getObjectWithVPtr = [&] {
1851 return llvm::find_if(VFTContext.getVFPtrOffsets(
1852 ML.VBase ? ML.VBase : MethodDecl->getParent()),
1853 [&](const std::unique_ptr<VPtrInfo> &Info) {
1854 return Info->FullOffsetInMDC == ML.VFPtrOffset;
1855 })
1856 ->get()
1857 ->ObjectWithVPtr;
1858 };
Peter Collingbourned9546012015-06-19 02:30:43 +00001859
John McCall9831b842018-02-06 18:52:44 +00001860 llvm::Value *VFunc;
1861 if (CGF.ShouldEmitVTableTypeCheckedLoad(MethodDecl->getParent())) {
1862 VFunc = CGF.EmitVTableTypeCheckedLoad(
David Majnemer07c915e2016-10-27 17:11:51 +00001863 getObjectWithVPtr(), VTable,
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001864 ML.Index * CGM.getContext().getTargetInfo().getPointerWidth(0) / 8);
John McCall9831b842018-02-06 18:52:44 +00001865 } else {
1866 if (CGM.getCodeGenOpts().PrepareForLTO)
1867 CGF.EmitTypeMetadataCodeForVCall(getObjectWithVPtr(), VTable, Loc);
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001868
John McCall9831b842018-02-06 18:52:44 +00001869 llvm::Value *VFuncPtr =
1870 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1871 VFunc = Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
1872 }
John McCallb92ab1a2016-10-26 23:46:34 +00001873
John McCall9831b842018-02-06 18:52:44 +00001874 CGCallee Callee(MethodDecl, VFunc);
1875 return Callee;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001876}
1877
David Majnemer0c0b6d92014-10-31 20:09:12 +00001878llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1879 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +00001880 Address This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001881 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001882 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1883
1884 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001885 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001886 GlobalDecl GD(Dtor, Dtor_Deleting);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001887 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1888 Dtor, StructorType::Deleting);
George Burgess IV00f70bd2018-03-01 05:43:23 +00001889 llvm::FunctionType *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Peter Collingbourneea211002018-02-05 23:09:13 +00001890 CGCallee Callee = CGCallee::forVirtual(CE, GD, This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001891
David Majnemer9ced3dd2015-03-14 23:44:48 +00001892 ASTContext &Context = getContext();
Nico Weber0a029922015-01-12 21:24:10 +00001893 llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1894 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1895 DtorType == Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001896
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001897 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001898 RValue RV =
1899 CGF.EmitCXXDestructorCall(Dtor, Callee, This.getPointer(), ImplicitParam,
1900 Context.IntTy, CE, StructorType::Deleting);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001901 return RV.getScalarVal();
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001902}
1903
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001904const VBTableGlobals &
1905MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001906 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001907 // easier than caching each vbtable individually.
1908 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1909 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001910 std::tie(Entry, Added) =
1911 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001912 VBTableGlobals &VBGlobals = Entry->second;
1913 if (!Added)
1914 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001915
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001916 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1917 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001918
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001919 // Cache the globals for all vbtables so we don't have to recompute the
1920 // mangled names.
1921 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001922 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1923 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001924 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001925 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001926 }
1927
1928 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001929}
1930
Reid Klecknere4a52202014-02-21 02:27:32 +00001931llvm::Function *MicrosoftCXXABI::EmitVirtualMemPtrThunk(
1932 const CXXMethodDecl *MD,
1933 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001934 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1935 "can't form pointers to ctors or virtual dtors");
1936
Reid Klecknere4a52202014-02-21 02:27:32 +00001937 // Calculate the mangled name.
1938 SmallString<256> ThunkName;
1939 llvm::raw_svector_ostream Out(ThunkName);
1940 getMangleContext().mangleVirtualMemPtrThunk(MD, Out);
Reid Klecknere4a52202014-02-21 02:27:32 +00001941
Hans Wennborg88497d62013-11-15 17:24:45 +00001942 // If the thunk has been generated previously, just return it.
1943 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1944 return cast<llvm::Function>(GV);
1945
1946 // Create the llvm::Function.
Reid Klecknerc3473512014-08-29 21:43:29 +00001947 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSMemberPointerThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00001948 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1949 llvm::Function *ThunkFn =
1950 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1951 ThunkName.str(), &CGM.getModule());
1952 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1953
Hans Wennborg88497d62013-11-15 17:24:45 +00001954 ThunkFn->setLinkage(MD->isExternallyVisible()
1955 ? llvm::GlobalValue::LinkOnceODRLinkage
1956 : llvm::GlobalValue::InternalLinkage);
David Majnemer8c9cdb62015-01-21 01:21:31 +00001957 if (MD->isExternallyVisible())
1958 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
Hans Wennborg88497d62013-11-15 17:24:45 +00001959
1960 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1961 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1962
Reid Kleckner9da94482015-01-21 22:18:17 +00001963 // Add the "thunk" attribute so that LLVM knows that the return type is
1964 // meaningless. These thunks can be used to call functions with differing
1965 // return types, and the caller is required to cast the prototype
1966 // appropriately to extract the correct value.
1967 ThunkFn->addFnAttr("thunk");
1968
Reid Klecknerb9538a62014-08-15 18:12:40 +00001969 // These thunks can be compared, so they are not unnamed.
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001970 ThunkFn->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::None);
Reid Klecknerb9538a62014-08-15 18:12:40 +00001971
Hans Wennborg88497d62013-11-15 17:24:45 +00001972 // Start codegen.
1973 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00001974 CGF.CurGD = GlobalDecl(MD);
1975 CGF.CurFuncIsThunk = true;
1976
1977 // Build FunctionArgs, but only include the implicit 'this' parameter
1978 // declaration.
1979 FunctionArgList FunctionArgs;
1980 buildThisParam(CGF, FunctionArgs);
1981
1982 // Start defining the function.
1983 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
1984 FunctionArgs, MD->getLocation(), SourceLocation());
Reid Kleckner06239e42017-11-16 19:09:36 +00001985 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
Hans Wennborg88497d62013-11-15 17:24:45 +00001986
Reid Klecknere4a52202014-02-21 02:27:32 +00001987 // Load the vfptr and then callee from the vftable. The callee should have
1988 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00001989 llvm::Value *VTable = CGF.GetVTablePtr(
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001990 getThisAddress(CGF), ThunkTy->getPointerTo()->getPointerTo(), MD->getParent());
1991
Reid Klecknere4a52202014-02-21 02:27:32 +00001992 llvm::Value *VFuncPtr =
1993 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
John McCall7f416cc2015-09-08 08:05:57 +00001994 llvm::Value *Callee =
1995 CGF.Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
Hans Wennborg88497d62013-11-15 17:24:45 +00001996
Reid Klecknerc3473512014-08-29 21:43:29 +00001997 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee);
Hans Wennborg88497d62013-11-15 17:24:45 +00001998
1999 return ThunkFn;
2000}
2001
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002002void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002003 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
2004 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00002005 const std::unique_ptr<VPtrInfo>& VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002006 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
David Majnemer129f4172015-02-02 10:22:20 +00002007 if (GV->isDeclaration())
2008 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00002009 }
2010}
2011
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002012llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002013MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002014 llvm::GlobalVariable::LinkageTypes Linkage) {
2015 SmallString<256> OutName;
2016 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00002017 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002018 StringRef Name = OutName.str();
2019
2020 llvm::ArrayType *VBTableType =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002021 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ObjectWithVPtr->getNumVBases());
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002022
2023 assert(!CGM.getModule().getNamedGlobal(Name) &&
2024 "vbtable with this name already exists: mangling bug?");
2025 llvm::GlobalVariable *GV =
2026 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00002027 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Hans Wennborg853ae942014-05-30 16:59:42 +00002028
2029 if (RD->hasAttr<DLLImportAttr>())
2030 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
2031 else if (RD->hasAttr<DLLExportAttr>())
2032 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
2033
David Majnemer129f4172015-02-02 10:22:20 +00002034 if (!GV->hasExternalLinkage())
2035 emitVBTableDefinition(VBT, RD, GV);
2036
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002037 return GV;
2038}
2039
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002040void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002041 const CXXRecordDecl *RD,
2042 llvm::GlobalVariable *GV) const {
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002043 const CXXRecordDecl *ObjectWithVPtr = VBT.ObjectWithVPtr;
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002044
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002045 assert(RD->getNumVBases() && ObjectWithVPtr->getNumVBases() &&
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002046 "should only emit vbtables for classes with vbtables");
2047
2048 const ASTRecordLayout &BaseLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002049 getContext().getASTRecordLayout(VBT.IntroducingObject);
David Majnemer9ced3dd2015-03-14 23:44:48 +00002050 const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002051
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002052 SmallVector<llvm::Constant *, 4> Offsets(1 + ObjectWithVPtr->getNumVBases(),
Craig Topper8a13c412014-05-21 05:09:00 +00002053 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002054
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002055 // The offset from ObjectWithVPtr's vbptr to itself always leads.
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002056 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
2057 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
2058
2059 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002060 for (const auto &I : ObjectWithVPtr->vbases()) {
Aaron Ballman445a9392014-03-13 16:15:17 +00002061 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002062 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
2063 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00002064
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002065 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00002066 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002067 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00002068 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002069 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00002070 Offset -= CompleteVBPtrOffset;
2071
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002072 unsigned VBIndex = Context.getVBTableIndex(ObjectWithVPtr, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00002073 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002074 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
2075 }
2076
2077 assert(Offsets.size() ==
2078 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
2079 ->getElementType())->getNumElements());
2080 llvm::ArrayType *VBTableType =
2081 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
2082 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
2083 GV->setInitializer(Init);
David Majnemer46e39cc2016-02-22 17:22:08 +00002084
2085 if (RD->hasAttr<DLLImportAttr>())
2086 GV->setLinkage(llvm::GlobalVariable::AvailableExternallyLinkage);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002087}
2088
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002089llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002090 Address This,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002091 const ThisAdjustment &TA) {
2092 if (TA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002093 return This.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002094
John McCall7f416cc2015-09-08 08:05:57 +00002095 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002096
John McCall7f416cc2015-09-08 08:05:57 +00002097 llvm::Value *V;
2098 if (TA.Virtual.isEmpty()) {
2099 V = This.getPointer();
2100 } else {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002101 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
2102 // Adjust the this argument based on the vtordisp value.
John McCall7f416cc2015-09-08 08:05:57 +00002103 Address VtorDispPtr =
2104 CGF.Builder.CreateConstInBoundsByteGEP(This,
2105 CharUnits::fromQuantity(TA.Virtual.Microsoft.VtordispOffset));
2106 VtorDispPtr = CGF.Builder.CreateElementBitCast(VtorDispPtr, CGF.Int32Ty);
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002107 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
John McCall7f416cc2015-09-08 08:05:57 +00002108 V = CGF.Builder.CreateGEP(This.getPointer(),
2109 CGF.Builder.CreateNeg(VtorDisp));
2110
2111 // Unfortunately, having applied the vtordisp means that we no
2112 // longer really have a known alignment for the vbptr step.
2113 // We'll assume the vbptr is pointer-aligned.
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002114
2115 if (TA.Virtual.Microsoft.VBPtrOffset) {
2116 // If the final overrider is defined in a virtual base other than the one
2117 // that holds the vfptr, we have to use a vtordispex thunk which looks up
2118 // the vbtable of the derived class.
2119 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
2120 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
2121 llvm::Value *VBPtr;
2122 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002123 GetVBaseOffsetFromVBPtr(CGF, Address(V, CGF.getPointerAlign()),
2124 -TA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002125 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
2126 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2127 }
2128 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002129
2130 if (TA.NonVirtual) {
2131 // Non-virtual adjustment might result in a pointer outside the allocated
2132 // object, e.g. if the final overrider class is laid out after the virtual
2133 // base that declares a method in the most derived class.
2134 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
2135 }
2136
2137 // Don't need to bitcast back, the call CodeGen will handle this.
2138 return V;
2139}
2140
2141llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00002142MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002143 const ReturnAdjustment &RA) {
2144 if (RA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002145 return Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002146
John McCall7f416cc2015-09-08 08:05:57 +00002147 auto OrigTy = Ret.getType();
2148 Ret = CGF.Builder.CreateElementBitCast(Ret, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002149
John McCall7f416cc2015-09-08 08:05:57 +00002150 llvm::Value *V = Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002151 if (RA.Virtual.Microsoft.VBIndex) {
2152 assert(RA.Virtual.Microsoft.VBIndex > 0);
John McCall7f416cc2015-09-08 08:05:57 +00002153 int32_t IntSize = CGF.getIntSize().getQuantity();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002154 llvm::Value *VBPtr;
2155 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002156 GetVBaseOffsetFromVBPtr(CGF, Ret, RA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002157 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
2158 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2159 }
2160
2161 if (RA.NonVirtual)
David Blaikiefb901c7a2015-04-04 15:12:29 +00002162 V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002163
2164 // Cast back to the original type.
John McCall7f416cc2015-09-08 08:05:57 +00002165 return CGF.Builder.CreateBitCast(V, OrigTy);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002166}
2167
John McCallb91cd662012-05-01 05:23:51 +00002168bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
2169 QualType elementType) {
2170 // Microsoft seems to completely ignore the possibility of a
2171 // two-argument usual deallocation function.
2172 return elementType.isDestructedType();
2173}
2174
2175bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
2176 // Microsoft seems to completely ignore the possibility of a
2177 // two-argument usual deallocation function.
2178 return expr->getAllocatedType().isDestructedType();
2179}
2180
2181CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
2182 // The array cookie is always a size_t; we then pad that out to the
2183 // alignment of the element type.
2184 ASTContext &Ctx = getContext();
2185 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
2186 Ctx.getTypeAlignInChars(type));
2187}
2188
2189llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002190 Address allocPtr,
John McCallb91cd662012-05-01 05:23:51 +00002191 CharUnits cookieSize) {
John McCall7f416cc2015-09-08 08:05:57 +00002192 Address numElementsPtr =
2193 CGF.Builder.CreateElementBitCast(allocPtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002194 return CGF.Builder.CreateLoad(numElementsPtr);
2195}
2196
John McCall7f416cc2015-09-08 08:05:57 +00002197Address MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
2198 Address newPtr,
2199 llvm::Value *numElements,
2200 const CXXNewExpr *expr,
2201 QualType elementType) {
John McCallb91cd662012-05-01 05:23:51 +00002202 assert(requiresArrayCookie(expr));
2203
2204 // The size of the cookie.
2205 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
2206
2207 // Compute an offset to the cookie.
John McCall7f416cc2015-09-08 08:05:57 +00002208 Address cookiePtr = newPtr;
John McCallb91cd662012-05-01 05:23:51 +00002209
2210 // Write the number of elements into the appropriate slot.
John McCall7f416cc2015-09-08 08:05:57 +00002211 Address numElementsPtr
2212 = CGF.Builder.CreateElementBitCast(cookiePtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002213 CGF.Builder.CreateStore(numElements, numElementsPtr);
2214
2215 // Finally, compute a pointer to the actual data buffer by skipping
2216 // over the cookie completely.
John McCall7f416cc2015-09-08 08:05:57 +00002217 return CGF.Builder.CreateConstInBoundsByteGEP(newPtr, cookieSize);
John McCallb91cd662012-05-01 05:23:51 +00002218}
2219
David Majnemerb3341ea2014-10-05 05:05:40 +00002220static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
2221 llvm::Constant *Dtor,
2222 llvm::Constant *Addr) {
2223 // Create a function which calls the destructor.
2224 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
2225
2226 // extern "C" int __tlregdtor(void (*f)(void));
2227 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
2228 CGF.IntTy, DtorStub->getType(), /*IsVarArg=*/false);
2229
Reid Klecknerde864822017-03-21 16:57:30 +00002230 llvm::Constant *TLRegDtor = CGF.CGM.CreateRuntimeFunction(
2231 TLRegDtorTy, "__tlregdtor", llvm::AttributeList(), /*Local=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002232 if (llvm::Function *TLRegDtorFn = dyn_cast<llvm::Function>(TLRegDtor))
2233 TLRegDtorFn->setDoesNotThrow();
2234
2235 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
2236}
2237
2238void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
2239 llvm::Constant *Dtor,
2240 llvm::Constant *Addr) {
2241 if (D.getTLSKind())
2242 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
2243
2244 // The default behavior is to use atexit.
2245 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
2246}
2247
2248void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +00002249 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +00002250 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +00002251 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) {
David Majnemercb60a432016-09-12 02:51:43 +00002252 if (CXXThreadLocalInits.empty())
2253 return;
2254
2255 CGM.AppendLinkerOptions(CGM.getTarget().getTriple().getArch() ==
2256 llvm::Triple::x86
2257 ? "/include:___dyn_tls_init@12"
2258 : "/include:__dyn_tls_init");
2259
David Majnemerb3341ea2014-10-05 05:05:40 +00002260 // This will create a GV in the .CRT$XDU section. It will point to our
2261 // initialization function. The CRT will call all of these function
2262 // pointers at start-up time and, eventually, at thread-creation time.
2263 auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
2264 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
2265 CGM.getModule(), InitFunc->getType(), /*IsConstant=*/true,
2266 llvm::GlobalVariable::InternalLinkage, InitFunc,
2267 Twine(InitFunc->getName(), "$initializer$"));
2268 InitFuncPtr->setSection(".CRT$XDU");
2269 // This variable has discardable linkage, we have to add it to @llvm.used to
2270 // ensure it won't get discarded.
2271 CGM.addUsedGlobal(InitFuncPtr);
2272 return InitFuncPtr;
2273 };
2274
2275 std::vector<llvm::Function *> NonComdatInits;
2276 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
Richard Smith5a99c492015-12-01 01:10:48 +00002277 llvm::GlobalVariable *GV = cast<llvm::GlobalVariable>(
2278 CGM.GetGlobalValue(CGM.getMangledName(CXXThreadLocalInitVars[I])));
David Majnemerb3341ea2014-10-05 05:05:40 +00002279 llvm::Function *F = CXXThreadLocalInits[I];
2280
2281 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002282 if (llvm::Comdat *C = GV->getComdat())
David Majnemerb3341ea2014-10-05 05:05:40 +00002283 AddToXDU(F)->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002284 else
David Majnemerb3341ea2014-10-05 05:05:40 +00002285 NonComdatInits.push_back(F);
David Majnemerb3341ea2014-10-05 05:05:40 +00002286 }
2287
2288 if (!NonComdatInits.empty()) {
2289 llvm::FunctionType *FTy =
2290 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002291 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +00002292 FTy, "__tls_init", CGM.getTypes().arrangeNullaryFunction(),
2293 SourceLocation(), /*TLS=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002294 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2295
2296 AddToXDU(InitFunc);
2297 }
2298}
2299
2300LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2301 const VarDecl *VD,
2302 QualType LValType) {
2303 CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2304 return LValue();
2305}
2306
John McCall7f416cc2015-09-08 08:05:57 +00002307static ConstantAddress getInitThreadEpochPtr(CodeGenModule &CGM) {
David Majnemer8354eee2015-05-07 06:15:46 +00002308 StringRef VarName("_Init_thread_epoch");
John McCall7f416cc2015-09-08 08:05:57 +00002309 CharUnits Align = CGM.getIntAlign();
David Majnemer8354eee2015-05-07 06:15:46 +00002310 if (auto *GV = CGM.getModule().getNamedGlobal(VarName))
John McCall7f416cc2015-09-08 08:05:57 +00002311 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002312 auto *GV = new llvm::GlobalVariable(
2313 CGM.getModule(), CGM.IntTy,
2314 /*Constant=*/false, llvm::GlobalVariable::ExternalLinkage,
2315 /*Initializer=*/nullptr, VarName,
2316 /*InsertBefore=*/nullptr, llvm::GlobalVariable::GeneralDynamicTLSModel);
John McCall7f416cc2015-09-08 08:05:57 +00002317 GV->setAlignment(Align.getQuantity());
2318 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002319}
2320
2321static llvm::Constant *getInitThreadHeaderFn(CodeGenModule &CGM) {
2322 llvm::FunctionType *FTy =
2323 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2324 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2325 return CGM.CreateRuntimeFunction(
2326 FTy, "_Init_thread_header",
Reid Klecknerde864822017-03-21 16:57:30 +00002327 llvm::AttributeList::get(CGM.getLLVMContext(),
2328 llvm::AttributeList::FunctionIndex,
2329 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002330 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002331}
2332
2333static llvm::Constant *getInitThreadFooterFn(CodeGenModule &CGM) {
2334 llvm::FunctionType *FTy =
2335 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2336 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2337 return CGM.CreateRuntimeFunction(
2338 FTy, "_Init_thread_footer",
Reid Klecknerde864822017-03-21 16:57:30 +00002339 llvm::AttributeList::get(CGM.getLLVMContext(),
2340 llvm::AttributeList::FunctionIndex,
2341 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002342 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002343}
2344
2345static llvm::Constant *getInitThreadAbortFn(CodeGenModule &CGM) {
2346 llvm::FunctionType *FTy =
2347 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2348 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2349 return CGM.CreateRuntimeFunction(
2350 FTy, "_Init_thread_abort",
Reid Klecknerde864822017-03-21 16:57:30 +00002351 llvm::AttributeList::get(CGM.getLLVMContext(),
2352 llvm::AttributeList::FunctionIndex,
2353 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002354 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002355}
2356
2357namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002358struct ResetGuardBit final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002359 Address Guard;
David Majnemer8354eee2015-05-07 06:15:46 +00002360 unsigned GuardNum;
John McCall7f416cc2015-09-08 08:05:57 +00002361 ResetGuardBit(Address Guard, unsigned GuardNum)
David Majnemer8354eee2015-05-07 06:15:46 +00002362 : Guard(Guard), GuardNum(GuardNum) {}
2363
2364 void Emit(CodeGenFunction &CGF, Flags flags) override {
2365 // Reset the bit in the mask so that the static variable may be
2366 // reinitialized.
2367 CGBuilderTy &Builder = CGF.Builder;
2368 llvm::LoadInst *LI = Builder.CreateLoad(Guard);
2369 llvm::ConstantInt *Mask =
Reid Klecknerd16cebe2016-02-10 19:09:15 +00002370 llvm::ConstantInt::get(CGF.IntTy, ~(1ULL << GuardNum));
David Majnemer8354eee2015-05-07 06:15:46 +00002371 Builder.CreateStore(Builder.CreateAnd(LI, Mask), Guard);
2372 }
2373};
2374
David Blaikie7e70d682015-08-18 22:40:54 +00002375struct CallInitThreadAbort final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002376 llvm::Value *Guard;
2377 CallInitThreadAbort(Address Guard) : Guard(Guard.getPointer()) {}
David Majnemer8354eee2015-05-07 06:15:46 +00002378
2379 void Emit(CodeGenFunction &CGF, Flags flags) override {
2380 // Calling _Init_thread_abort will reset the guard's state.
2381 CGF.EmitNounwindRuntimeCall(getInitThreadAbortFn(CGF.CGM), Guard);
2382 }
2383};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002384}
David Majnemer8354eee2015-05-07 06:15:46 +00002385
John McCallc84ed6a2012-05-01 06:13:13 +00002386void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00002387 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00002388 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00002389 // MSVC only uses guards for static locals.
2390 if (!D.isStaticLocal()) {
2391 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2392 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
Rafael Espindola77abc3a2015-01-16 16:04:45 +00002393 llvm::Function *F = CGF.CurFn;
2394 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2395 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
Reid Kleckner563f0e82014-05-23 21:13:45 +00002396 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2397 return;
2398 }
2399
David Majnemerec8e54b2015-05-07 21:19:06 +00002400 bool ThreadlocalStatic = D.getTLSKind();
2401 bool ThreadsafeStatic = getContext().getLangOpts().ThreadsafeStatics;
2402
2403 // Thread-safe static variables which aren't thread-specific have a
2404 // per-variable guard.
2405 bool HasPerVariableGuard = ThreadsafeStatic && !ThreadlocalStatic;
Richard Smithdbf74ba2013-04-14 23:01:42 +00002406
Reid Klecknerd8110b62013-09-10 20:14:30 +00002407 CGBuilderTy &Builder = CGF.Builder;
2408 llvm::IntegerType *GuardTy = CGF.Int32Ty;
2409 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
John McCall7f416cc2015-09-08 08:05:57 +00002410 CharUnits GuardAlign = CharUnits::fromQuantity(4);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002411
2412 // Get the guard variable for this function if we have one already.
David Majnemerec8e54b2015-05-07 21:19:06 +00002413 GuardInfo *GI = nullptr;
2414 if (ThreadlocalStatic)
2415 GI = &ThreadLocalGuardVariableMap[D.getDeclContext()];
2416 else if (!ThreadsafeStatic)
2417 GI = &GuardVariableMap[D.getDeclContext()];
2418
2419 llvm::GlobalVariable *GuardVar = GI ? GI->Guard : nullptr;
David Majnemer8354eee2015-05-07 06:15:46 +00002420 unsigned GuardNum;
David Majnemerec8e54b2015-05-07 21:19:06 +00002421 if (D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002422 // Externally visible variables have to be numbered in Sema to properly
2423 // handle unreachable VarDecls.
David Majnemer8354eee2015-05-07 06:15:46 +00002424 GuardNum = getContext().getStaticLocalNumber(&D);
2425 assert(GuardNum > 0);
2426 GuardNum--;
2427 } else if (HasPerVariableGuard) {
2428 GuardNum = ThreadSafeGuardNumMap[D.getDeclContext()]++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002429 } else {
2430 // Non-externally visible variables are numbered here in CodeGen.
David Majnemer8354eee2015-05-07 06:15:46 +00002431 GuardNum = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002432 }
2433
David Majnemer8354eee2015-05-07 06:15:46 +00002434 if (!HasPerVariableGuard && GuardNum >= 32) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002435 if (D.isExternallyVisible())
2436 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
David Majnemer8354eee2015-05-07 06:15:46 +00002437 GuardNum %= 32;
2438 GuardVar = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002439 }
2440
David Majnemer8354eee2015-05-07 06:15:46 +00002441 if (!GuardVar) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002442 // Mangle the name for the guard.
2443 SmallString<256> GuardName;
2444 {
2445 llvm::raw_svector_ostream Out(GuardName);
David Majnemer8354eee2015-05-07 06:15:46 +00002446 if (HasPerVariableGuard)
2447 getMangleContext().mangleThreadSafeStaticGuardVariable(&D, GuardNum,
2448 Out);
2449 else
2450 getMangleContext().mangleStaticGuardVariable(&D, Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002451 }
2452
Hans Wennborgef2272c2014-06-18 15:55:13 +00002453 // Create the guard variable with a zero-initializer. Just absorb linkage,
2454 // visibility and dll storage class from the guarded variable.
David Majnemer8354eee2015-05-07 06:15:46 +00002455 GuardVar =
2456 new llvm::GlobalVariable(CGM.getModule(), GuardTy, /*isConstant=*/false,
Reid Klecknere9591b32014-04-23 18:22:11 +00002457 GV->getLinkage(), Zero, GuardName.str());
David Majnemer8354eee2015-05-07 06:15:46 +00002458 GuardVar->setVisibility(GV->getVisibility());
2459 GuardVar->setDLLStorageClass(GV->getDLLStorageClass());
John McCall7f416cc2015-09-08 08:05:57 +00002460 GuardVar->setAlignment(GuardAlign.getQuantity());
David Majnemer8354eee2015-05-07 06:15:46 +00002461 if (GuardVar->isWeakForLinker())
2462 GuardVar->setComdat(
2463 CGM.getModule().getOrInsertComdat(GuardVar->getName()));
2464 if (D.getTLSKind())
2465 GuardVar->setThreadLocal(true);
2466 if (GI && !HasPerVariableGuard)
2467 GI->Guard = GuardVar;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002468 }
2469
John McCall7f416cc2015-09-08 08:05:57 +00002470 ConstantAddress GuardAddr(GuardVar, GuardAlign);
2471
David Majnemer8354eee2015-05-07 06:15:46 +00002472 assert(GuardVar->getLinkage() == GV->getLinkage() &&
2473 "static local from the same function had different linkage");
Reid Klecknerd8110b62013-09-10 20:14:30 +00002474
David Majnemer8354eee2015-05-07 06:15:46 +00002475 if (!HasPerVariableGuard) {
2476 // Pseudo code for the test:
2477 // if (!(GuardVar & MyGuardBit)) {
2478 // GuardVar |= MyGuardBit;
2479 // ... initialize the object ...;
2480 // }
Reid Klecknerd8110b62013-09-10 20:14:30 +00002481
David Majnemer8354eee2015-05-07 06:15:46 +00002482 // Test our bit from the guard variable.
Aaron Ballmanabd466e2016-03-30 21:33:34 +00002483 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1ULL << GuardNum);
John McCall7f416cc2015-09-08 08:05:57 +00002484 llvm::LoadInst *LI = Builder.CreateLoad(GuardAddr);
Richard Smithae8d62c2017-07-26 22:01:09 +00002485 llvm::Value *NeedsInit =
2486 Builder.CreateICmpEQ(Builder.CreateAnd(LI, Bit), Zero);
David Majnemer8354eee2015-05-07 06:15:46 +00002487 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2488 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002489 CGF.EmitCXXGuardedInitBranch(NeedsInit, InitBlock, EndBlock,
2490 CodeGenFunction::GuardKind::VariableGuard, &D);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002491
David Majnemer8354eee2015-05-07 06:15:46 +00002492 // Set our bit in the guard variable and emit the initializer and add a global
2493 // destructor if appropriate.
2494 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002495 Builder.CreateStore(Builder.CreateOr(LI, Bit), GuardAddr);
2496 CGF.EHStack.pushCleanup<ResetGuardBit>(EHCleanup, GuardAddr, GuardNum);
David Majnemer8354eee2015-05-07 06:15:46 +00002497 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2498 CGF.PopCleanupBlock();
2499 Builder.CreateBr(EndBlock);
2500
2501 // Continue.
2502 CGF.EmitBlock(EndBlock);
2503 } else {
2504 // Pseudo code for the test:
2505 // if (TSS > _Init_thread_epoch) {
2506 // _Init_thread_header(&TSS);
2507 // if (TSS == -1) {
2508 // ... initialize the object ...;
2509 // _Init_thread_footer(&TSS);
2510 // }
2511 // }
2512 //
2513 // The algorithm is almost identical to what can be found in the appendix
2514 // found in N2325.
2515
David Majnemer8354eee2015-05-07 06:15:46 +00002516 // This BasicBLock determines whether or not we have any work to do.
John McCall7f416cc2015-09-08 08:05:57 +00002517 llvm::LoadInst *FirstGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002518 FirstGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2519 llvm::LoadInst *InitThreadEpoch =
2520 Builder.CreateLoad(getInitThreadEpochPtr(CGM));
2521 llvm::Value *IsUninitialized =
2522 Builder.CreateICmpSGT(FirstGuardLoad, InitThreadEpoch);
2523 llvm::BasicBlock *AttemptInitBlock = CGF.createBasicBlock("init.attempt");
2524 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002525 CGF.EmitCXXGuardedInitBranch(IsUninitialized, AttemptInitBlock, EndBlock,
2526 CodeGenFunction::GuardKind::VariableGuard, &D);
David Majnemer8354eee2015-05-07 06:15:46 +00002527
2528 // This BasicBlock attempts to determine whether or not this thread is
2529 // responsible for doing the initialization.
2530 CGF.EmitBlock(AttemptInitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002531 CGF.EmitNounwindRuntimeCall(getInitThreadHeaderFn(CGM),
2532 GuardAddr.getPointer());
2533 llvm::LoadInst *SecondGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002534 SecondGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2535 llvm::Value *ShouldDoInit =
2536 Builder.CreateICmpEQ(SecondGuardLoad, getAllOnesInt());
2537 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2538 Builder.CreateCondBr(ShouldDoInit, InitBlock, EndBlock);
2539
2540 // Ok, we ended up getting selected as the initializing thread.
2541 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002542 CGF.EHStack.pushCleanup<CallInitThreadAbort>(EHCleanup, GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002543 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2544 CGF.PopCleanupBlock();
John McCall7f416cc2015-09-08 08:05:57 +00002545 CGF.EmitNounwindRuntimeCall(getInitThreadFooterFn(CGM),
2546 GuardAddr.getPointer());
David Majnemer8354eee2015-05-07 06:15:46 +00002547 Builder.CreateBr(EndBlock);
2548
2549 CGF.EmitBlock(EndBlock);
2550 }
John McCallc84ed6a2012-05-01 06:13:13 +00002551}
2552
Reid Kleckner2341ae32013-04-11 18:13:19 +00002553bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2554 // Null-ness for function memptrs only depends on the first field, which is
2555 // the function pointer. The rest don't matter, so we can zero initialize.
2556 if (MPT->isMemberFunctionPointer())
2557 return true;
2558
2559 // The virtual base adjustment field is always -1 for null, so if we have one
2560 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
2561 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002562 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2563 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002564 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
2565 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00002566}
2567
2568llvm::Type *
2569MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002570 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2571 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002572 llvm::SmallVector<llvm::Type *, 4> fields;
2573 if (MPT->isMemberFunctionPointer())
2574 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
2575 else
2576 fields.push_back(CGM.IntTy); // FieldOffset
2577
Reid Kleckner96f8f932014-02-05 17:27:08 +00002578 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2579 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002580 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002581 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002582 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002583 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002584 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
2585
2586 if (fields.size() == 1)
2587 return fields[0];
2588 return llvm::StructType::get(CGM.getLLVMContext(), fields);
2589}
2590
2591void MicrosoftCXXABI::
2592GetNullMemberPointerFields(const MemberPointerType *MPT,
2593 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2594 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00002595 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2596 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002597 if (MPT->isMemberFunctionPointer()) {
2598 // FunctionPointerOrVirtualThunk
2599 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2600 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00002601 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00002602 fields.push_back(getZeroInt()); // FieldOffset
2603 else
2604 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00002605 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00002606
Reid Kleckner96f8f932014-02-05 17:27:08 +00002607 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2608 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002609 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002610 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002611 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002612 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002613 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002614}
2615
2616llvm::Constant *
2617MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002618 llvm::SmallVector<llvm::Constant *, 4> fields;
2619 GetNullMemberPointerFields(MPT, fields);
2620 if (fields.size() == 1)
2621 return fields[0];
2622 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2623 assert(Res->getType() == ConvertMemberPointerType(MPT));
2624 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002625}
2626
2627llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002628MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2629 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00002630 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +00002631 CharUnits NonVirtualBaseAdjustment,
2632 unsigned VBTableIndex) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002633 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002634
2635 // Single inheritance class member pointer are represented as scalars instead
2636 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002637 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002638 return FirstField;
2639
Reid Kleckner2341ae32013-04-11 18:13:19 +00002640 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002641 fields.push_back(FirstField);
2642
Reid Kleckner96f8f932014-02-05 17:27:08 +00002643 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002644 fields.push_back(llvm::ConstantInt::get(
2645 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002646
Reid Kleckner96f8f932014-02-05 17:27:08 +00002647 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00002648 CharUnits Offs = CharUnits::Zero();
David Majnemerc1709d32015-06-23 07:31:11 +00002649 if (VBTableIndex)
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002650 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00002651 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00002652 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002653
2654 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002655 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
David Majnemere60813f2015-05-10 21:48:08 +00002656 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, VBTableIndex));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002657
Reid Kleckner2341ae32013-04-11 18:13:19 +00002658 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002659}
2660
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002661llvm::Constant *
2662MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2663 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002664 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerc1709d32015-06-23 07:31:11 +00002665 if (RD->getMSInheritanceModel() ==
2666 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002667 offset -= getContext().getOffsetOfBaseWithVBPtr(RD);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002668 llvm::Constant *FirstField =
2669 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00002670 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002671 CharUnits::Zero(), /*VBTableIndex=*/0);
Reid Kleckner452abac2013-05-09 21:01:17 +00002672}
2673
Reid Kleckner452abac2013-05-09 21:01:17 +00002674llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2675 QualType MPType) {
David Majnemer5ca193c2015-06-23 07:31:07 +00002676 const MemberPointerType *DstTy = MPType->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002677 const ValueDecl *MPD = MP.getMemberPointerDecl();
2678 if (!MPD)
David Majnemer5ca193c2015-06-23 07:31:07 +00002679 return EmitNullMemberPointer(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002680
David Majnemer5ca193c2015-06-23 07:31:07 +00002681 ASTContext &Ctx = getContext();
2682 ArrayRef<const CXXRecordDecl *> MemberPointerPath = MP.getMemberPointerPath();
Reid Kleckner452abac2013-05-09 21:01:17 +00002683
David Majnemer5ca193c2015-06-23 07:31:07 +00002684 llvm::Constant *C;
2685 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) {
2686 C = EmitMemberFunctionPointer(MD);
2687 } else {
2688 CharUnits FieldOffset = Ctx.toCharUnitsFromBits(Ctx.getFieldOffset(MPD));
2689 C = EmitMemberDataPointer(DstTy, FieldOffset);
2690 }
Reid Kleckner452abac2013-05-09 21:01:17 +00002691
David Majnemer5ca193c2015-06-23 07:31:07 +00002692 if (!MemberPointerPath.empty()) {
2693 const CXXRecordDecl *SrcRD = cast<CXXRecordDecl>(MPD->getDeclContext());
2694 const Type *SrcRecTy = Ctx.getTypeDeclType(SrcRD).getTypePtr();
2695 const MemberPointerType *SrcTy =
2696 Ctx.getMemberPointerType(DstTy->getPointeeType(), SrcRecTy)
2697 ->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002698
David Majnemer5ca193c2015-06-23 07:31:07 +00002699 bool DerivedMember = MP.isMemberPointerToDerivedMember();
2700 SmallVector<const CXXBaseSpecifier *, 4> DerivedToBasePath;
2701 const CXXRecordDecl *PrevRD = SrcRD;
2702 for (const CXXRecordDecl *PathElem : MemberPointerPath) {
2703 const CXXRecordDecl *Base = nullptr;
2704 const CXXRecordDecl *Derived = nullptr;
2705 if (DerivedMember) {
2706 Base = PathElem;
2707 Derived = PrevRD;
2708 } else {
2709 Base = PrevRD;
2710 Derived = PathElem;
2711 }
2712 for (const CXXBaseSpecifier &BS : Derived->bases())
2713 if (BS.getType()->getAsCXXRecordDecl()->getCanonicalDecl() ==
2714 Base->getCanonicalDecl())
2715 DerivedToBasePath.push_back(&BS);
2716 PrevRD = PathElem;
2717 }
2718 assert(DerivedToBasePath.size() == MemberPointerPath.size());
2719
2720 CastKind CK = DerivedMember ? CK_DerivedToBaseMemberPointer
2721 : CK_BaseToDerivedMemberPointer;
2722 C = EmitMemberPointerConversion(SrcTy, DstTy, CK, DerivedToBasePath.begin(),
2723 DerivedToBasePath.end(), C);
2724 }
2725 return C;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002726}
2727
2728llvm::Constant *
David Majnemer5ca193c2015-06-23 07:31:07 +00002729MicrosoftCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002730 assert(MD->isInstance() && "Member function must not be static!");
David Majnemer5ca193c2015-06-23 07:31:07 +00002731
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002732 MD = MD->getCanonicalDecl();
David Majnemer5ca193c2015-06-23 07:31:07 +00002733 CharUnits NonVirtualBaseAdjustment = CharUnits::Zero();
2734 const CXXRecordDecl *RD = MD->getParent()->getMostRecentDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002735 CodeGenTypes &Types = CGM.getTypes();
2736
David Majnemere60813f2015-05-10 21:48:08 +00002737 unsigned VBTableIndex = 0;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002738 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00002739 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00002740 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002741 llvm::Type *Ty;
2742 // Check whether the function has a computable LLVM signature.
2743 if (Types.isFuncTypeConvertible(FPT)) {
2744 // The function has a computable LLVM signature; use the correct type.
2745 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2746 } else {
2747 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2748 // function type is incomplete.
2749 Ty = CGM.PtrDiffTy;
2750 }
2751 FirstField = CGM.GetAddrOfFunction(MD, Ty);
Hans Wennborg88497d62013-11-15 17:24:45 +00002752 } else {
David Majnemere0e228a2015-06-11 08:12:44 +00002753 auto &VTableContext = CGM.getMicrosoftVTableContext();
2754 MicrosoftVTableContext::MethodVFTableLocation ML =
2755 VTableContext.getMethodVFTableLocation(MD);
David Majnemerc1709d32015-06-23 07:31:11 +00002756 FirstField = EmitVirtualMemPtrThunk(MD, ML);
David Majnemere0e228a2015-06-11 08:12:44 +00002757 // Include the vfptr adjustment if the method is in a non-primary vftable.
2758 NonVirtualBaseAdjustment += ML.VFPtrOffset;
2759 if (ML.VBase)
2760 VBTableIndex = VTableContext.getVBTableIndex(RD, ML.VBase) * 4;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002761 }
2762
David Majnemerc1709d32015-06-23 07:31:11 +00002763 if (VBTableIndex == 0 &&
2764 RD->getMSInheritanceModel() ==
2765 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002766 NonVirtualBaseAdjustment -= getContext().getOffsetOfBaseWithVBPtr(RD);
David Majnemerc1709d32015-06-23 07:31:11 +00002767
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002768 // The rest of the fields are common with data member pointers.
David Majnemerc1709d32015-06-23 07:31:11 +00002769 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002770 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002771 NonVirtualBaseAdjustment, VBTableIndex);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002772}
2773
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002774/// Member pointers are the same if they're either bitwise identical *or* both
2775/// null. Null-ness for function members is determined by the first field,
2776/// while for data member pointers we must compare all fields.
2777llvm::Value *
2778MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2779 llvm::Value *L,
2780 llvm::Value *R,
2781 const MemberPointerType *MPT,
2782 bool Inequality) {
2783 CGBuilderTy &Builder = CGF.Builder;
2784
2785 // Handle != comparisons by switching the sense of all boolean operations.
2786 llvm::ICmpInst::Predicate Eq;
2787 llvm::Instruction::BinaryOps And, Or;
2788 if (Inequality) {
2789 Eq = llvm::ICmpInst::ICMP_NE;
2790 And = llvm::Instruction::Or;
2791 Or = llvm::Instruction::And;
2792 } else {
2793 Eq = llvm::ICmpInst::ICMP_EQ;
2794 And = llvm::Instruction::And;
2795 Or = llvm::Instruction::Or;
2796 }
2797
2798 // If this is a single field member pointer (single inheritance), this is a
2799 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002800 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2801 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002802 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2803 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002804 return Builder.CreateICmp(Eq, L, R);
2805
2806 // Compare the first field.
2807 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2808 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2809 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2810
2811 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002812 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002813 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2814 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2815 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2816 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2817 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2818 if (Res)
2819 Res = Builder.CreateBinOp(And, Res, Cmp);
2820 else
2821 Res = Cmp;
2822 }
2823
2824 // Check if the first field is 0 if this is a function pointer.
2825 if (MPT->isMemberFunctionPointer()) {
2826 // (l1 == r1 && ...) || l0 == 0
2827 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2828 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2829 Res = Builder.CreateBinOp(Or, Res, IsZero);
2830 }
2831
2832 // Combine the comparison of the first field, which must always be true for
2833 // this comparison to succeeed.
2834 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2835}
2836
Reid Kleckner407e8b62013-03-22 19:02:54 +00002837llvm::Value *
2838MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2839 llvm::Value *MemPtr,
2840 const MemberPointerType *MPT) {
2841 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002842 llvm::SmallVector<llvm::Constant *, 4> fields;
2843 // We only need one field for member functions.
2844 if (MPT->isMemberFunctionPointer())
2845 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2846 else
2847 GetNullMemberPointerFields(MPT, fields);
2848 assert(!fields.empty());
2849 llvm::Value *FirstField = MemPtr;
2850 if (MemPtr->getType()->isStructTy())
2851 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2852 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002853
Reid Kleckner2341ae32013-04-11 18:13:19 +00002854 // For function member pointers, we only need to test the function pointer
2855 // field. The other fields if any can be garbage.
2856 if (MPT->isMemberFunctionPointer())
2857 return Res;
2858
2859 // Otherwise, emit a series of compares and combine the results.
2860 for (int I = 1, E = fields.size(); I < E; ++I) {
2861 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2862 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002863 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002864 }
2865 return Res;
2866}
2867
Reid Kleckner452abac2013-05-09 21:01:17 +00002868bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2869 llvm::Constant *Val) {
2870 // Function pointers are null if the pointer in the first field is null.
2871 if (MPT->isMemberFunctionPointer()) {
2872 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2873 Val->getAggregateElement(0U) : Val;
2874 return FirstField->isNullValue();
2875 }
2876
2877 // If it's not a function pointer and it's zero initializable, we can easily
2878 // check zero.
2879 if (isZeroInitializable(MPT) && Val->isNullValue())
2880 return true;
2881
2882 // Otherwise, break down all the fields for comparison. Hopefully these
2883 // little Constants are reused, while a big null struct might not be.
2884 llvm::SmallVector<llvm::Constant *, 4> Fields;
2885 GetNullMemberPointerFields(MPT, Fields);
2886 if (Fields.size() == 1) {
2887 assert(Val->getType()->isIntegerTy());
2888 return Val == Fields[0];
2889 }
2890
2891 unsigned I, E;
2892 for (I = 0, E = Fields.size(); I != E; ++I) {
2893 if (Val->getAggregateElement(I) != Fields[I])
2894 break;
2895 }
2896 return I == E;
2897}
2898
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002899llvm::Value *
2900MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002901 Address This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002902 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002903 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002904 llvm::Value **VBPtrOut) {
2905 CGBuilderTy &Builder = CGF.Builder;
2906 // Load the vbtable pointer from the vbptr in the instance.
John McCall7f416cc2015-09-08 08:05:57 +00002907 This = Builder.CreateElementBitCast(This, CGM.Int8Ty);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002908 llvm::Value *VBPtr =
John McCall7f416cc2015-09-08 08:05:57 +00002909 Builder.CreateInBoundsGEP(This.getPointer(), VBPtrOffset, "vbptr");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002910 if (VBPtrOut) *VBPtrOut = VBPtr;
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002911 VBPtr = Builder.CreateBitCast(VBPtr,
John McCall7f416cc2015-09-08 08:05:57 +00002912 CGM.Int32Ty->getPointerTo(0)->getPointerTo(This.getAddressSpace()));
2913
2914 CharUnits VBPtrAlign;
2915 if (auto CI = dyn_cast<llvm::ConstantInt>(VBPtrOffset)) {
2916 VBPtrAlign = This.getAlignment().alignmentAtOffset(
2917 CharUnits::fromQuantity(CI->getSExtValue()));
2918 } else {
2919 VBPtrAlign = CGF.getPointerAlign();
2920 }
2921
2922 llvm::Value *VBTable = Builder.CreateAlignedLoad(VBPtr, VBPtrAlign, "vbtable");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002923
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002924 // Translate from byte offset to table index. It improves analyzability.
2925 llvm::Value *VBTableIndex = Builder.CreateAShr(
2926 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
2927 "vbtindex", /*isExact=*/true);
2928
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002929 // Load an i32 offset from the vb-table.
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002930 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002931 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
John McCall7f416cc2015-09-08 08:05:57 +00002932 return Builder.CreateAlignedLoad(VBaseOffs, CharUnits::fromQuantity(4),
2933 "vbase_offs");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002934}
2935
Reid Kleckner2341ae32013-04-11 18:13:19 +00002936// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2937// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002938llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2939 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
John McCall7f416cc2015-09-08 08:05:57 +00002940 Address Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002941 CGBuilderTy &Builder = CGF.Builder;
John McCall7f416cc2015-09-08 08:05:57 +00002942 Base = Builder.CreateElementBitCast(Base, CGM.Int8Ty);
Craig Topper8a13c412014-05-21 05:09:00 +00002943 llvm::BasicBlock *OriginalBB = nullptr;
2944 llvm::BasicBlock *SkipAdjustBB = nullptr;
2945 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002946
2947 // In the unspecified inheritance model, there might not be a vbtable at all,
2948 // in which case we need to skip the virtual base lookup. If there is a
2949 // vbtable, the first entry is a no-op entry that gives back the original
2950 // base, so look for a virtual base adjustment offset of zero.
2951 if (VBPtrOffset) {
2952 OriginalBB = Builder.GetInsertBlock();
2953 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2954 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2955 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002956 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002957 "memptr.is_vbase");
2958 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2959 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002960 }
2961
Reid Kleckner2341ae32013-04-11 18:13:19 +00002962 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
2963 // know the vbptr offset.
2964 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002965 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00002966 if (!RD->hasDefinition()) {
2967 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
2968 unsigned DiagID = Diags.getCustomDiagID(
2969 DiagnosticsEngine::Error,
2970 "member pointer representation requires a "
2971 "complete class type for %0 to perform this expression");
2972 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
2973 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002974 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002975 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
2976 }
Craig Topper8a13c412014-05-21 05:09:00 +00002977 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002978 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002979 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002980 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
2981
2982 // Merge control flow with the case where we didn't have to adjust.
2983 if (VBaseAdjustBB) {
2984 Builder.CreateBr(SkipAdjustBB);
2985 CGF.EmitBlock(SkipAdjustBB);
2986 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
John McCall7f416cc2015-09-08 08:05:57 +00002987 Phi->addIncoming(Base.getPointer(), OriginalBB);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002988 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
2989 return Phi;
2990 }
2991 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002992}
2993
David Majnemer2b0d66d2014-02-20 23:22:07 +00002994llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
John McCall7f416cc2015-09-08 08:05:57 +00002995 CodeGenFunction &CGF, const Expr *E, Address Base, llvm::Value *MemPtr,
David Majnemer2b0d66d2014-02-20 23:22:07 +00002996 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002997 assert(MPT->isMemberDataPointer());
John McCall7f416cc2015-09-08 08:05:57 +00002998 unsigned AS = Base.getAddressSpace();
Reid Kleckner407e8b62013-03-22 19:02:54 +00002999 llvm::Type *PType =
3000 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
3001 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003002 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
3003 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003004
Reid Kleckner2341ae32013-04-11 18:13:19 +00003005 // Extract the fields we need, regardless of model. We'll apply them if we
3006 // have them.
3007 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003008 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3009 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003010 if (MemPtr->getType()->isStructTy()) {
3011 // We need to extract values.
3012 unsigned I = 0;
3013 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003014 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003015 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003016 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003017 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00003018 }
3019
John McCall7f416cc2015-09-08 08:05:57 +00003020 llvm::Value *Addr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003021 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003022 Addr = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00003023 VBPtrOffset);
John McCall7f416cc2015-09-08 08:05:57 +00003024 } else {
3025 Addr = Base.getPointer();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003026 }
Reid Klecknerae945122013-12-05 22:44:07 +00003027
3028 // Cast to char*.
John McCall7f416cc2015-09-08 08:05:57 +00003029 Addr = Builder.CreateBitCast(Addr, CGF.Int8Ty->getPointerTo(AS));
Reid Klecknerae945122013-12-05 22:44:07 +00003030
3031 // Apply the offset, which we assume is non-null.
John McCall7f416cc2015-09-08 08:05:57 +00003032 Addr = Builder.CreateInBoundsGEP(Addr, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00003033
3034 // Cast the address to the appropriate pointer type, adopting the address
3035 // space of the base pointer.
3036 return Builder.CreateBitCast(Addr, PType);
3037}
3038
Reid Kleckner452abac2013-05-09 21:01:17 +00003039llvm::Value *
3040MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
3041 const CastExpr *E,
3042 llvm::Value *Src) {
3043 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
3044 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
3045 E->getCastKind() == CK_ReinterpretMemberPointer);
3046
3047 // Use constant emission if we can.
3048 if (isa<llvm::Constant>(Src))
3049 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
3050
3051 // We may be adding or dropping fields from the member pointer, so we need
3052 // both types and the inheritance models of both records.
3053 const MemberPointerType *SrcTy =
3054 E->getSubExpr()->getType()->castAs<MemberPointerType>();
3055 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003056 bool IsFunc = SrcTy->isMemberFunctionPointer();
3057
3058 // If the classes use the same null representation, reinterpret_cast is a nop.
3059 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003060 if (IsReinterpret && IsFunc)
3061 return Src;
3062
3063 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3064 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3065 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00003066 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00003067 return Src;
3068
3069 CGBuilderTy &Builder = CGF.Builder;
3070
3071 // Branch past the conversion if Src is null.
3072 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
3073 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
3074
3075 // C++ 5.2.10p9: The null member pointer value is converted to the null member
3076 // pointer value of the destination type.
3077 if (IsReinterpret) {
3078 // For reinterpret casts, sema ensures that src and dst are both functions
3079 // or data and have the same size, which means the LLVM types should match.
3080 assert(Src->getType() == DstNull->getType());
3081 return Builder.CreateSelect(IsNotNull, Src, DstNull);
3082 }
3083
3084 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
3085 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
3086 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
3087 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
3088 CGF.EmitBlock(ConvertBB);
3089
David Majnemer0d9ad682015-06-29 00:06:50 +00003090 llvm::Value *Dst = EmitNonNullMemberPointerConversion(
3091 SrcTy, DstTy, E->getCastKind(), E->path_begin(), E->path_end(), Src,
3092 Builder);
3093
3094 Builder.CreateBr(ContinueBB);
3095
3096 // In the continuation, choose between DstNull and Dst.
3097 CGF.EmitBlock(ContinueBB);
3098 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
3099 Phi->addIncoming(DstNull, OriginalBB);
3100 Phi->addIncoming(Dst, ConvertBB);
3101 return Phi;
3102}
3103
3104llvm::Value *MicrosoftCXXABI::EmitNonNullMemberPointerConversion(
3105 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3106 CastExpr::path_const_iterator PathBegin,
3107 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
3108 CGBuilderTy &Builder) {
3109 const CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3110 const CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3111 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
3112 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
3113 bool IsFunc = SrcTy->isMemberFunctionPointer();
3114 bool IsConstant = isa<llvm::Constant>(Src);
3115
Reid Kleckner452abac2013-05-09 21:01:17 +00003116 // Decompose src.
3117 llvm::Value *FirstField = Src;
David Majnemerc1709d32015-06-23 07:31:11 +00003118 llvm::Value *NonVirtualBaseAdjustment = getZeroInt();
3119 llvm::Value *VirtualBaseAdjustmentOffset = getZeroInt();
3120 llvm::Value *VBPtrOffset = getZeroInt();
Reid Kleckner96f8f932014-02-05 17:27:08 +00003121 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003122 // We need to extract values.
3123 unsigned I = 0;
3124 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003125 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003126 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003127 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003128 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003129 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003130 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
3131 }
3132
David Majnemer0d9ad682015-06-29 00:06:50 +00003133 bool IsDerivedToBase = (CK == CK_DerivedToBaseMemberPointer);
David Majnemerc1709d32015-06-23 07:31:11 +00003134 const MemberPointerType *DerivedTy = IsDerivedToBase ? SrcTy : DstTy;
3135 const CXXRecordDecl *DerivedClass = DerivedTy->getMostRecentCXXRecordDecl();
3136
Reid Kleckner452abac2013-05-09 21:01:17 +00003137 // For data pointers, we adjust the field offset directly. For functions, we
3138 // have a separate field.
David Majnemerc1709d32015-06-23 07:31:11 +00003139 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
3140
3141 // The virtual inheritance model has a quirk: the virtual base table is always
3142 // referenced when dereferencing a member pointer even if the member pointer
3143 // is non-virtual. This is accounted for by adjusting the non-virtual offset
3144 // to point backwards to the top of the MDC from the first VBase. Undo this
3145 // adjustment to normalize the member pointer.
3146 llvm::Value *SrcVBIndexEqZero =
3147 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3148 if (SrcInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3149 if (int64_t SrcOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003150 getContext().getOffsetOfBaseWithVBPtr(SrcRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003151 llvm::Value *UndoSrcAdjustment = Builder.CreateSelect(
3152 SrcVBIndexEqZero,
3153 llvm::ConstantInt::get(CGM.IntTy, SrcOffsetToFirstVBase),
3154 getZeroInt());
3155 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, UndoSrcAdjustment);
3156 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003157 }
3158
David Majnemerc1709d32015-06-23 07:31:11 +00003159 // A non-zero vbindex implies that we are dealing with a source member in a
3160 // floating virtual base in addition to some non-virtual offset. If the
3161 // vbindex is zero, we are dealing with a source that exists in a non-virtual,
3162 // fixed, base. The difference between these two cases is that the vbindex +
3163 // nvoffset *always* point to the member regardless of what context they are
3164 // evaluated in so long as the vbindex is adjusted. A member inside a fixed
3165 // base requires explicit nv adjustment.
3166 llvm::Constant *BaseClassOffset = llvm::ConstantInt::get(
David Majnemer0d9ad682015-06-29 00:06:50 +00003167 CGM.IntTy,
3168 CGM.computeNonVirtualBaseClassOffset(DerivedClass, PathBegin, PathEnd)
3169 .getQuantity());
David Majnemerc1709d32015-06-23 07:31:11 +00003170
3171 llvm::Value *NVDisp;
3172 if (IsDerivedToBase)
3173 NVDisp = Builder.CreateNSWSub(NVAdjustField, BaseClassOffset, "adj");
3174 else
3175 NVDisp = Builder.CreateNSWAdd(NVAdjustField, BaseClassOffset, "adj");
3176
3177 NVAdjustField = Builder.CreateSelect(SrcVBIndexEqZero, NVDisp, getZeroInt());
3178
3179 // Update the vbindex to an appropriate value in the destination because
3180 // SrcRD's vbtable might not be a strict prefix of the one in DstRD.
3181 llvm::Value *DstVBIndexEqZero = SrcVBIndexEqZero;
3182 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance) &&
3183 MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance)) {
3184 if (llvm::GlobalVariable *VDispMap =
3185 getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) {
3186 llvm::Value *VBIndex = Builder.CreateExactUDiv(
3187 VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003188 if (IsConstant) {
3189 llvm::Constant *Mapping = VDispMap->getInitializer();
3190 VirtualBaseAdjustmentOffset =
3191 Mapping->getAggregateElement(cast<llvm::Constant>(VBIndex));
3192 } else {
3193 llvm::Value *Idxs[] = {getZeroInt(), VBIndex};
3194 VirtualBaseAdjustmentOffset =
John McCall7f416cc2015-09-08 08:05:57 +00003195 Builder.CreateAlignedLoad(Builder.CreateInBoundsGEP(VDispMap, Idxs),
3196 CharUnits::fromQuantity(4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003197 }
David Majnemerc1709d32015-06-23 07:31:11 +00003198
3199 DstVBIndexEqZero =
3200 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3201 }
3202 }
3203
3204 // Set the VBPtrOffset to zero if the vbindex is zero. Otherwise, initialize
3205 // it to the offset of the vbptr.
3206 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance)) {
3207 llvm::Value *DstVBPtrOffset = llvm::ConstantInt::get(
3208 CGM.IntTy,
3209 getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity());
3210 VBPtrOffset =
3211 Builder.CreateSelect(DstVBIndexEqZero, getZeroInt(), DstVBPtrOffset);
3212 }
3213
3214 // Likewise, apply a similar adjustment so that dereferencing the member
3215 // pointer correctly accounts for the distance between the start of the first
3216 // virtual base and the top of the MDC.
3217 if (DstInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3218 if (int64_t DstOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003219 getContext().getOffsetOfBaseWithVBPtr(DstRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003220 llvm::Value *DoDstAdjustment = Builder.CreateSelect(
3221 DstVBIndexEqZero,
3222 llvm::ConstantInt::get(CGM.IntTy, DstOffsetToFirstVBase),
3223 getZeroInt());
3224 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, DoDstAdjustment);
3225 }
3226 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003227
3228 // Recompose dst from the null struct and the adjusted fields from src.
3229 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00003230 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003231 Dst = FirstField;
3232 } else {
David Majnemer0d9ad682015-06-29 00:06:50 +00003233 Dst = llvm::UndefValue::get(ConvertMemberPointerType(DstTy));
Reid Kleckner452abac2013-05-09 21:01:17 +00003234 unsigned Idx = 0;
3235 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003236 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003237 Dst = Builder.CreateInsertValue(Dst, NonVirtualBaseAdjustment, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003238 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003239 Dst = Builder.CreateInsertValue(Dst, VBPtrOffset, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003240 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003241 Dst = Builder.CreateInsertValue(Dst, VirtualBaseAdjustmentOffset, Idx++);
Reid Kleckner452abac2013-05-09 21:01:17 +00003242 }
David Majnemer0d9ad682015-06-29 00:06:50 +00003243 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003244}
3245
3246llvm::Constant *
3247MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
3248 llvm::Constant *Src) {
3249 const MemberPointerType *SrcTy =
David Majnemer5ca193c2015-06-23 07:31:07 +00003250 E->getSubExpr()->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003251 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3252
David Majnemer5ca193c2015-06-23 07:31:07 +00003253 CastKind CK = E->getCastKind();
3254
3255 return EmitMemberPointerConversion(SrcTy, DstTy, CK, E->path_begin(),
3256 E->path_end(), Src);
3257}
3258
3259llvm::Constant *MicrosoftCXXABI::EmitMemberPointerConversion(
3260 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3261 CastExpr::path_const_iterator PathBegin,
3262 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src) {
3263 assert(CK == CK_DerivedToBaseMemberPointer ||
3264 CK == CK_BaseToDerivedMemberPointer ||
3265 CK == CK_ReinterpretMemberPointer);
Reid Kleckner452abac2013-05-09 21:01:17 +00003266 // If src is null, emit a new null for dst. We can't return src because dst
3267 // might have a new representation.
3268 if (MemberPointerConstantIsNull(SrcTy, Src))
3269 return EmitNullMemberPointer(DstTy);
3270
3271 // We don't need to do anything for reinterpret_casts of non-null member
3272 // pointers. We should only get here when the two type representations have
3273 // the same size.
David Majnemer5ca193c2015-06-23 07:31:07 +00003274 if (CK == CK_ReinterpretMemberPointer)
Reid Kleckner452abac2013-05-09 21:01:17 +00003275 return Src;
3276
John McCall7f416cc2015-09-08 08:05:57 +00003277 CGBuilderTy Builder(CGM, CGM.getLLVMContext());
David Majnemer0d9ad682015-06-29 00:06:50 +00003278 auto *Dst = cast<llvm::Constant>(EmitNonNullMemberPointerConversion(
3279 SrcTy, DstTy, CK, PathBegin, PathEnd, Src, Builder));
Reid Kleckner452abac2013-05-09 21:01:17 +00003280
David Majnemer0d9ad682015-06-29 00:06:50 +00003281 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003282}
3283
John McCallb92ab1a2016-10-26 23:46:34 +00003284CGCallee MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
John McCall7f416cc2015-09-08 08:05:57 +00003285 CodeGenFunction &CGF, const Expr *E, Address This,
3286 llvm::Value *&ThisPtrForCall, llvm::Value *MemPtr,
3287 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003288 assert(MPT->isMemberFunctionPointer());
3289 const FunctionProtoType *FPT =
3290 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00003291 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003292 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(
3293 CGM.getTypes().arrangeCXXMethodType(RD, FPT, /*FD=*/nullptr));
Reid Kleckner2341ae32013-04-11 18:13:19 +00003294 CGBuilderTy &Builder = CGF.Builder;
3295
David Majnemer1cdd96d2014-01-17 09:01:00 +00003296 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003297
3298 // Extract the fields we need, regardless of model. We'll apply them if we
3299 // have them.
3300 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003301 llvm::Value *NonVirtualBaseAdjustment = nullptr;
3302 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3303 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003304 if (MemPtr->getType()->isStructTy()) {
3305 // We need to extract values.
3306 unsigned I = 0;
3307 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003308 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003309 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003310 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00003311 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003312 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003313 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3314 }
3315
3316 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003317 ThisPtrForCall = AdjustVirtualBase(CGF, E, RD, This,
3318 VirtualBaseAdjustmentOffset, VBPtrOffset);
3319 } else {
3320 ThisPtrForCall = This.getPointer();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003321 }
3322
3323 if (NonVirtualBaseAdjustment) {
3324 // Apply the adjustment and cast back to the original struct type.
John McCall7f416cc2015-09-08 08:05:57 +00003325 llvm::Value *Ptr = Builder.CreateBitCast(ThisPtrForCall, CGF.Int8PtrTy);
Reid Kleckner2341ae32013-04-11 18:13:19 +00003326 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
John McCall7f416cc2015-09-08 08:05:57 +00003327 ThisPtrForCall = Builder.CreateBitCast(Ptr, ThisPtrForCall->getType(),
3328 "this.adjusted");
Reid Kleckner2341ae32013-04-11 18:13:19 +00003329 }
3330
John McCallb92ab1a2016-10-26 23:46:34 +00003331 FunctionPointer =
3332 Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
3333 CGCallee Callee(FPT, FunctionPointer);
3334 return Callee;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003335}
3336
Charles Davis53c59df2010-08-16 03:33:14 +00003337CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00003338 return new MicrosoftCXXABI(CGM);
3339}
David Majnemere2cb8d12014-07-07 06:20:47 +00003340
3341// MS RTTI Overview:
3342// The run time type information emitted by cl.exe contains 5 distinct types of
3343// structures. Many of them reference each other.
3344//
3345// TypeInfo: Static classes that are returned by typeid.
3346//
3347// CompleteObjectLocator: Referenced by vftables. They contain information
3348// required for dynamic casting, including OffsetFromTop. They also contain
3349// a reference to the TypeInfo for the type and a reference to the
3350// CompleteHierarchyDescriptor for the type.
3351//
3352// ClassHieararchyDescriptor: Contains information about a class hierarchy.
3353// Used during dynamic_cast to walk a class hierarchy. References a base
3354// class array and the size of said array.
3355//
3356// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
3357// somewhat of a misnomer because the most derived class is also in the list
3358// as well as multiple copies of virtual bases (if they occur multiple times
3359// in the hiearchy.) The BaseClassArray contains one BaseClassDescriptor for
3360// every path in the hierarchy, in pre-order depth first order. Note, we do
3361// not declare a specific llvm type for BaseClassArray, it's merely an array
3362// of BaseClassDescriptor pointers.
3363//
3364// BaseClassDescriptor: Contains information about a class in a class hierarchy.
3365// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
3366// BaseClassArray is. It contains information about a class within a
3367// hierarchy such as: is this base is ambiguous and what is its offset in the
3368// vbtable. The names of the BaseClassDescriptors have all of their fields
3369// mangled into them so they can be aggressively deduplicated by the linker.
3370
David Majnemere2cb8d12014-07-07 06:20:47 +00003371static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
3372 StringRef MangledName("\01??_7type_info@@6B@");
3373 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
3374 return VTable;
3375 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
3376 /*Constant=*/true,
3377 llvm::GlobalVariable::ExternalLinkage,
3378 /*Initializer=*/nullptr, MangledName);
3379}
3380
3381namespace {
3382
3383/// \brief A Helper struct that stores information about a class in a class
3384/// hierarchy. The information stored in these structs struct is used during
3385/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
3386// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
3387// implicit depth first pre-order tree connectivity. getFirstChild and
3388// getNextSibling allow us to walk the tree efficiently.
3389struct MSRTTIClass {
3390 enum {
3391 IsPrivateOnPath = 1 | 8,
3392 IsAmbiguous = 2,
3393 IsPrivate = 4,
3394 IsVirtual = 16,
3395 HasHierarchyDescriptor = 64
3396 };
3397 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
3398 uint32_t initialize(const MSRTTIClass *Parent,
3399 const CXXBaseSpecifier *Specifier);
3400
3401 MSRTTIClass *getFirstChild() { return this + 1; }
3402 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
3403 return Child + 1 + Child->NumBases;
3404 }
3405
3406 const CXXRecordDecl *RD, *VirtualRoot;
3407 uint32_t Flags, NumBases, OffsetInVBase;
3408};
3409
3410/// \brief Recursively initialize the base class array.
3411uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
3412 const CXXBaseSpecifier *Specifier) {
3413 Flags = HasHierarchyDescriptor;
3414 if (!Parent) {
3415 VirtualRoot = nullptr;
3416 OffsetInVBase = 0;
3417 } else {
3418 if (Specifier->getAccessSpecifier() != AS_public)
3419 Flags |= IsPrivate | IsPrivateOnPath;
3420 if (Specifier->isVirtual()) {
3421 Flags |= IsVirtual;
3422 VirtualRoot = RD;
3423 OffsetInVBase = 0;
3424 } else {
3425 if (Parent->Flags & IsPrivateOnPath)
3426 Flags |= IsPrivateOnPath;
3427 VirtualRoot = Parent->VirtualRoot;
3428 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
3429 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
3430 }
3431 }
3432 NumBases = 0;
3433 MSRTTIClass *Child = getFirstChild();
3434 for (const CXXBaseSpecifier &Base : RD->bases()) {
3435 NumBases += Child->initialize(this, &Base) + 1;
3436 Child = getNextChild(Child);
3437 }
3438 return NumBases;
3439}
3440
3441static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
3442 switch (Ty->getLinkage()) {
3443 case NoLinkage:
3444 case InternalLinkage:
3445 case UniqueExternalLinkage:
3446 return llvm::GlobalValue::InternalLinkage;
3447
3448 case VisibleNoLinkage:
Richard Smith1283e982017-07-07 20:04:28 +00003449 case ModuleInternalLinkage:
3450 case ModuleLinkage:
David Majnemere2cb8d12014-07-07 06:20:47 +00003451 case ExternalLinkage:
3452 return llvm::GlobalValue::LinkOnceODRLinkage;
3453 }
3454 llvm_unreachable("Invalid linkage!");
3455}
3456
3457/// \brief An ephemeral helper class for building MS RTTI types. It caches some
3458/// calls to the module and information about the most derived class in a
3459/// hierarchy.
3460struct MSRTTIBuilder {
3461 enum {
3462 HasBranchingHierarchy = 1,
3463 HasVirtualBranchingHierarchy = 2,
3464 HasAmbiguousBases = 4
3465 };
3466
David Majnemer611cdb92014-07-07 08:09:15 +00003467 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
3468 : CGM(ABI.CGM), Context(CGM.getContext()),
3469 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00003470 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003471 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00003472
3473 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
3474 llvm::GlobalVariable *
3475 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
3476 llvm::GlobalVariable *getClassHierarchyDescriptor();
Justin Lebar562914e2016-10-10 16:26:29 +00003477 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo &Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003478
3479 CodeGenModule &CGM;
3480 ASTContext &Context;
3481 llvm::LLVMContext &VMContext;
3482 llvm::Module &Module;
3483 const CXXRecordDecl *RD;
3484 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00003485 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00003486};
3487
3488} // namespace
3489
3490/// \brief Recursively serializes a class hierarchy in pre-order depth first
3491/// order.
3492static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
3493 const CXXRecordDecl *RD) {
3494 Classes.push_back(MSRTTIClass(RD));
3495 for (const CXXBaseSpecifier &Base : RD->bases())
3496 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
3497}
3498
3499/// \brief Find ambiguity among base classes.
3500static void
3501detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
3502 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
3503 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
3504 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
3505 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
3506 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
David Blaikie82e95a32014-11-19 07:49:47 +00003507 !VirtualBases.insert(Class->RD).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003508 Class = MSRTTIClass::getNextChild(Class);
3509 continue;
3510 }
David Blaikie82e95a32014-11-19 07:49:47 +00003511 if (!UniqueBases.insert(Class->RD).second)
David Majnemere2cb8d12014-07-07 06:20:47 +00003512 AmbiguousBases.insert(Class->RD);
3513 Class++;
3514 }
3515 if (AmbiguousBases.empty())
3516 return;
3517 for (MSRTTIClass &Class : Classes)
3518 if (AmbiguousBases.count(Class.RD))
3519 Class.Flags |= MSRTTIClass::IsAmbiguous;
3520}
3521
3522llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
3523 SmallString<256> MangledName;
3524 {
3525 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003526 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003527 }
3528
3529 // Check to see if we've already declared this ClassHierarchyDescriptor.
3530 if (auto CHD = Module.getNamedGlobal(MangledName))
3531 return CHD;
3532
3533 // Serialize the class hierarchy and initialize the CHD Fields.
3534 SmallVector<MSRTTIClass, 8> Classes;
3535 serializeClassHierarchy(Classes, RD);
3536 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3537 detectAmbiguousBases(Classes);
3538 int Flags = 0;
3539 for (auto Class : Classes) {
3540 if (Class.RD->getNumBases() > 1)
3541 Flags |= HasBranchingHierarchy;
3542 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
3543 // believe the field isn't actually used.
3544 if (Class.Flags & MSRTTIClass::IsAmbiguous)
3545 Flags |= HasAmbiguousBases;
3546 }
3547 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
3548 Flags |= HasVirtualBranchingHierarchy;
3549 // These gep indices are used to get the address of the first element of the
3550 // base class array.
3551 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
3552 llvm::ConstantInt::get(CGM.IntTy, 0)};
3553
3554 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00003555 auto Type = ABI.getClassHierarchyDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003556 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3557 /*Initializer=*/nullptr,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003558 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003559 if (CHD->isWeakForLinker())
3560 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003561
David Blaikiee3b172a2015-04-02 18:55:21 +00003562 auto *Bases = getBaseClassArray(Classes);
3563
David Majnemere2cb8d12014-07-07 06:20:47 +00003564 // Initialize the base class ClassHierarchyDescriptor.
3565 llvm::Constant *Fields[] = {
Saleem Abdulrasoola9e14502017-01-01 19:16:02 +00003566 llvm::ConstantInt::get(CGM.IntTy, 0), // reserved by the runtime
David Majnemer611cdb92014-07-07 08:09:15 +00003567 llvm::ConstantInt::get(CGM.IntTy, Flags),
3568 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
3569 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00003570 Bases->getValueType(), Bases,
David Majnemer611cdb92014-07-07 08:09:15 +00003571 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00003572 };
3573 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3574 return CHD;
3575}
3576
3577llvm::GlobalVariable *
3578MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3579 SmallString<256> MangledName;
3580 {
3581 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003582 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003583 }
3584
3585 // Forward-declare the base class array.
3586 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3587 // mode) bytes of padding. We provide a pointer sized amount of padding by
3588 // adding +1 to Classes.size(). The sections have pointer alignment and are
3589 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00003590 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00003591 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00003592 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
David Majnemer7c237072015-03-05 00:46:22 +00003593 auto *BCA =
3594 new llvm::GlobalVariable(Module, ArrType,
3595 /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003596 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003597 if (BCA->isWeakForLinker())
3598 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003599
3600 // Initialize the BaseClassArray.
3601 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3602 for (MSRTTIClass &Class : Classes)
3603 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00003604 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00003605 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00003606 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00003607 return BCA;
3608}
3609
3610llvm::GlobalVariable *
3611MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3612 // Compute the fields for the BaseClassDescriptor. They are computed up front
3613 // because they are mangled into the name of the object.
3614 uint32_t OffsetInVBTable = 0;
3615 int32_t VBPtrOffset = -1;
3616 if (Class.VirtualRoot) {
3617 auto &VTableContext = CGM.getMicrosoftVTableContext();
3618 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3619 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3620 }
3621
3622 SmallString<256> MangledName;
3623 {
3624 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003625 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3626 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3627 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003628 }
3629
David Majnemer26a90f82014-07-07 15:29:10 +00003630 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00003631 if (auto BCD = Module.getNamedGlobal(MangledName))
3632 return BCD;
3633
3634 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00003635 auto Type = ABI.getBaseClassDescriptorType();
David Majnemer7c237072015-03-05 00:46:22 +00003636 auto BCD =
3637 new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003638 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003639 if (BCD->isWeakForLinker())
3640 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003641
3642 // Initialize the BaseClassDescriptor.
3643 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003644 ABI.getImageRelativeConstant(
David Majnemer443250f2015-03-17 20:35:00 +00003645 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003646 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3647 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3648 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3649 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3650 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3651 ABI.getImageRelativeConstant(
3652 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00003653 };
3654 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3655 return BCD;
3656}
3657
3658llvm::GlobalVariable *
Justin Lebar562914e2016-10-10 16:26:29 +00003659MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo &Info) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003660 SmallString<256> MangledName;
3661 {
3662 llvm::raw_svector_ostream Out(MangledName);
Justin Lebar562914e2016-10-10 16:26:29 +00003663 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info.MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003664 }
3665
3666 // Check to see if we've already computed this complete object locator.
3667 if (auto COL = Module.getNamedGlobal(MangledName))
3668 return COL;
3669
3670 // Compute the fields of the complete object locator.
Justin Lebar562914e2016-10-10 16:26:29 +00003671 int OffsetToTop = Info.FullOffsetInMDC.getQuantity();
David Majnemere2cb8d12014-07-07 06:20:47 +00003672 int VFPtrOffset = 0;
3673 // The offset includes the vtordisp if one exists.
Justin Lebar562914e2016-10-10 16:26:29 +00003674 if (const CXXRecordDecl *VBase = Info.getVBaseWithVPtr())
David Majnemere2cb8d12014-07-07 06:20:47 +00003675 if (Context.getASTRecordLayout(RD)
3676 .getVBaseOffsetsMap()
3677 .find(VBase)
3678 ->second.hasVtorDisp())
Justin Lebar562914e2016-10-10 16:26:29 +00003679 VFPtrOffset = Info.NonVirtualOffset.getQuantity() + 4;
David Majnemere2cb8d12014-07-07 06:20:47 +00003680
3681 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00003682 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003683 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003684 /*Initializer=*/nullptr, MangledName);
David Majnemere2cb8d12014-07-07 06:20:47 +00003685
3686 // Initialize the CompleteObjectLocator.
3687 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003688 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3689 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3690 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3691 ABI.getImageRelativeConstant(
3692 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3693 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3694 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00003695 };
3696 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00003697 if (!ABI.isImageRelative())
3698 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00003699 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
Rafael Espindola654542a2015-01-16 19:23:42 +00003700 if (COL->isWeakForLinker())
3701 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003702 return COL;
3703}
3704
David Majnemerad803d42015-03-15 07:10:01 +00003705static QualType decomposeTypeForEH(ASTContext &Context, QualType T,
David Majnemer526793d2016-07-12 04:42:50 +00003706 bool &IsConst, bool &IsVolatile,
3707 bool &IsUnaligned) {
David Majnemerad803d42015-03-15 07:10:01 +00003708 T = Context.getExceptionObjectType(T);
3709
3710 // C++14 [except.handle]p3:
3711 // A handler is a match for an exception object of type E if [...]
3712 // - the handler is of type cv T or const T& where T is a pointer type and
3713 // E is a pointer type that can be converted to T by [...]
3714 // - a qualification conversion
3715 IsConst = false;
3716 IsVolatile = false;
David Majnemer526793d2016-07-12 04:42:50 +00003717 IsUnaligned = false;
David Majnemerad803d42015-03-15 07:10:01 +00003718 QualType PointeeType = T->getPointeeType();
3719 if (!PointeeType.isNull()) {
3720 IsConst = PointeeType.isConstQualified();
3721 IsVolatile = PointeeType.isVolatileQualified();
David Majnemer526793d2016-07-12 04:42:50 +00003722 IsUnaligned = PointeeType.getQualifiers().hasUnaligned();
David Majnemerad803d42015-03-15 07:10:01 +00003723 }
3724
3725 // Member pointer types like "const int A::*" are represented by having RTTI
3726 // for "int A::*" and separately storing the const qualifier.
3727 if (const auto *MPTy = T->getAs<MemberPointerType>())
3728 T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(),
3729 MPTy->getClass());
3730
3731 // Pointer types like "const int * const *" are represented by having RTTI
3732 // for "const int **" and separately storing the const qualifier.
3733 if (T->isPointerType())
3734 T = Context.getPointerType(PointeeType.getUnqualifiedType());
3735
3736 return T;
3737}
3738
Reid Kleckner10aa7702015-09-16 20:15:55 +00003739CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +00003740MicrosoftCXXABI::getAddrOfCXXCatchHandlerType(QualType Type,
3741 QualType CatchHandlerType) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003742 // TypeDescriptors for exceptions never have qualified pointer types,
Simon Pilgrim2c518802017-03-30 14:13:19 +00003743 // qualifiers are stored separately in order to support qualification
David Majnemer443250f2015-03-17 20:35:00 +00003744 // conversions.
David Majnemer526793d2016-07-12 04:42:50 +00003745 bool IsConst, IsVolatile, IsUnaligned;
3746 Type =
3747 decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile, IsUnaligned);
David Majnemer443250f2015-03-17 20:35:00 +00003748
David Majnemer5f0dd612015-03-17 20:35:05 +00003749 bool IsReference = CatchHandlerType->isReferenceType();
3750
David Majnemer5f0dd612015-03-17 20:35:05 +00003751 uint32_t Flags = 0;
3752 if (IsConst)
3753 Flags |= 1;
3754 if (IsVolatile)
3755 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00003756 if (IsUnaligned)
3757 Flags |= 4;
David Majnemer5f0dd612015-03-17 20:35:05 +00003758 if (IsReference)
3759 Flags |= 8;
3760
Reid Kleckner10aa7702015-09-16 20:15:55 +00003761 return CatchTypeInfo{getAddrOfRTTIDescriptor(Type)->stripPointerCasts(),
3762 Flags};
David Majnemer443250f2015-03-17 20:35:00 +00003763}
3764
David Majnemere2cb8d12014-07-07 06:20:47 +00003765/// \brief Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
3766/// llvm::GlobalVariable * because different type descriptors have different
3767/// types, and need to be abstracted. They are abstracting by casting the
3768/// address to an Int8PtrTy.
David Majnemer443250f2015-03-17 20:35:00 +00003769llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003770 SmallString<256> MangledName;
David Majnemere2cb8d12014-07-07 06:20:47 +00003771 {
3772 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003773 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003774 }
3775
3776 // Check to see if we've already declared this TypeDescriptor.
3777 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3778 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3779
Piotr Padlewskid3b1cbd2017-06-01 08:04:05 +00003780 // Note for the future: If we would ever like to do deferred emission of
3781 // RTTI, check if emitting vtables opportunistically need any adjustment.
3782
David Majnemere2cb8d12014-07-07 06:20:47 +00003783 // Compute the fields for the TypeDescriptor.
David Majnemer5f0dd612015-03-17 20:35:05 +00003784 SmallString<256> TypeInfoString;
David Majnemere2cb8d12014-07-07 06:20:47 +00003785 {
3786 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00003787 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003788 }
3789
3790 // Declare and initialize the TypeDescriptor.
3791 llvm::Constant *Fields[] = {
3792 getTypeInfoVTable(CGM), // VFPtr
3793 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3794 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3795 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00003796 getTypeDescriptorType(TypeInfoString);
Rafael Espindola654542a2015-01-16 19:23:42 +00003797 auto *Var = new llvm::GlobalVariable(
3798 CGM.getModule(), TypeDescriptorType, /*Constant=*/false,
3799 getLinkageForRTTI(Type),
3800 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
Yaron Keren2c07cc72015-12-01 08:14:39 +00003801 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003802 if (Var->isWeakForLinker())
3803 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3804 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003805}
3806
3807/// \brief Gets or a creates a Microsoft CompleteObjectLocator.
3808llvm::GlobalVariable *
3809MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
Justin Lebar562914e2016-10-10 16:26:29 +00003810 const VPtrInfo &Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00003811 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003812}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003813
3814static void emitCXXConstructor(CodeGenModule &CGM,
3815 const CXXConstructorDecl *ctor,
3816 StructorType ctorType) {
Rafael Espindolad48b51b2014-09-15 19:24:44 +00003817 // There are no constructor variants, always emit the complete destructor.
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003818 llvm::Function *Fn = CGM.codegenCXXStructor(ctor, StructorType::Complete);
3819 CGM.maybeSetTrivialComdat(*ctor, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003820}
3821
3822static void emitCXXDestructor(CodeGenModule &CGM, const CXXDestructorDecl *dtor,
3823 StructorType dtorType) {
3824 // The complete destructor is equivalent to the base destructor for
3825 // classes with no virtual bases, so try to emit it as an alias.
3826 if (!dtor->getParent()->getNumVBases() &&
3827 (dtorType == StructorType::Complete || dtorType == StructorType::Base)) {
3828 bool ProducedAlias = !CGM.TryEmitDefinitionAsAlias(
Reid Kleckner3da37e02017-10-13 00:53:02 +00003829 GlobalDecl(dtor, Dtor_Complete), GlobalDecl(dtor, Dtor_Base));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003830 if (ProducedAlias) {
3831 if (dtorType == StructorType::Complete)
3832 return;
3833 if (dtor->isVirtual())
3834 CGM.getVTables().EmitThunks(GlobalDecl(dtor, Dtor_Complete));
3835 }
3836 }
3837
3838 // The base destructor is equivalent to the base destructor of its
3839 // base class if there is exactly one non-virtual base class with a
3840 // non-trivial destructor, there are no fields with a non-trivial
3841 // destructor, and the body of the destructor is trivial.
3842 if (dtorType == StructorType::Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
3843 return;
3844
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003845 llvm::Function *Fn = CGM.codegenCXXStructor(dtor, dtorType);
Rafael Espindolad3e04692015-01-17 01:47:39 +00003846 if (Fn->isWeakForLinker())
3847 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003848}
3849
3850void MicrosoftCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3851 StructorType Type) {
3852 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
3853 emitCXXConstructor(CGM, CD, Type);
3854 return;
3855 }
3856 emitCXXDestructor(CGM, cast<CXXDestructorDecl>(MD), Type);
3857}
David Majnemer7c237072015-03-05 00:46:22 +00003858
David Majnemerdfa6d202015-03-11 18:36:39 +00003859llvm::Function *
David Majnemer37fd66e2015-03-13 22:36:55 +00003860MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
3861 CXXCtorType CT) {
3862 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
3863
David Majnemerdfa6d202015-03-11 18:36:39 +00003864 // Calculate the mangled name.
3865 SmallString<256> ThunkName;
3866 llvm::raw_svector_ostream Out(ThunkName);
David Majnemer37fd66e2015-03-13 22:36:55 +00003867 getMangleContext().mangleCXXCtor(CD, CT, Out);
David Majnemerdfa6d202015-03-11 18:36:39 +00003868
3869 // If the thunk has been generated previously, just return it.
3870 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
3871 return cast<llvm::Function>(GV);
3872
3873 // Create the llvm::Function.
David Majnemer37fd66e2015-03-13 22:36:55 +00003874 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT);
David Majnemerdfa6d202015-03-11 18:36:39 +00003875 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
3876 const CXXRecordDecl *RD = CD->getParent();
3877 QualType RecordTy = getContext().getRecordType(RD);
3878 llvm::Function *ThunkFn = llvm::Function::Create(
3879 ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule());
Reid Klecknerbba3cb92015-03-17 19:00:50 +00003880 ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>(
3881 FnInfo.getEffectiveCallingConvention()));
David Majnemer63aa2fb2015-06-30 21:23:51 +00003882 if (ThunkFn->isWeakForLinker())
3883 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
David Majnemer37fd66e2015-03-13 22:36:55 +00003884 bool IsCopy = CT == Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003885
3886 // Start codegen.
3887 CodeGenFunction CGF(CGM);
3888 CGF.CurGD = GlobalDecl(CD, Ctor_Complete);
3889
3890 // Build FunctionArgs.
3891 FunctionArgList FunctionArgs;
3892
David Majnemer37fd66e2015-03-13 22:36:55 +00003893 // A constructor always starts with a 'this' pointer as its first argument.
David Majnemerdfa6d202015-03-11 18:36:39 +00003894 buildThisParam(CGF, FunctionArgs);
3895
3896 // Following the 'this' pointer is a reference to the source object that we
3897 // are copying from.
3898 ImplicitParamDecl SrcParam(
Alexey Bataev56223232017-06-09 13:40:18 +00003899 getContext(), /*DC=*/nullptr, SourceLocation(),
3900 &getContext().Idents.get("src"),
David Majnemerdfa6d202015-03-11 18:36:39 +00003901 getContext().getLValueReferenceType(RecordTy,
Alexey Bataev56223232017-06-09 13:40:18 +00003902 /*SpelledAsLValue=*/true),
3903 ImplicitParamDecl::Other);
David Majnemer37fd66e2015-03-13 22:36:55 +00003904 if (IsCopy)
3905 FunctionArgs.push_back(&SrcParam);
David Majnemerdfa6d202015-03-11 18:36:39 +00003906
David Majnemer37fd66e2015-03-13 22:36:55 +00003907 // Constructors for classes which utilize virtual bases have an additional
3908 // parameter which indicates whether or not it is being delegated to by a more
3909 // derived constructor.
Alexey Bataev56223232017-06-09 13:40:18 +00003910 ImplicitParamDecl IsMostDerived(getContext(), /*DC=*/nullptr,
3911 SourceLocation(),
David Majnemerdfa6d202015-03-11 18:36:39 +00003912 &getContext().Idents.get("is_most_derived"),
Alexey Bataev56223232017-06-09 13:40:18 +00003913 getContext().IntTy, ImplicitParamDecl::Other);
David Majnemerdfa6d202015-03-11 18:36:39 +00003914 // Only add the parameter to the list if thie class has virtual bases.
3915 if (RD->getNumVBases() > 0)
3916 FunctionArgs.push_back(&IsMostDerived);
3917
3918 // Start defining the function.
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003919 auto NL = ApplyDebugLocation::CreateEmpty(CGF);
David Majnemerdfa6d202015-03-11 18:36:39 +00003920 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
3921 FunctionArgs, CD->getLocation(), SourceLocation());
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003922 // Create a scope with an artificial location for the body of this function.
3923 auto AL = ApplyDebugLocation::CreateArtificial(CGF);
Reid Kleckner06239e42017-11-16 19:09:36 +00003924 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
David Majnemerdfa6d202015-03-11 18:36:39 +00003925 llvm::Value *This = getThisValue(CGF);
3926
3927 llvm::Value *SrcVal =
David Majnemer37fd66e2015-03-13 22:36:55 +00003928 IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src")
3929 : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003930
3931 CallArgList Args;
3932
3933 // Push the this ptr.
3934 Args.add(RValue::get(This), CD->getThisType(getContext()));
3935
3936 // Push the src ptr.
David Majnemer37fd66e2015-03-13 22:36:55 +00003937 if (SrcVal)
3938 Args.add(RValue::get(SrcVal), SrcParam.getType());
David Majnemerdfa6d202015-03-11 18:36:39 +00003939
3940 // Add the rest of the default arguments.
Reid Klecknerc01ee752016-11-23 16:51:30 +00003941 SmallVector<const Stmt *, 4> ArgVec;
3942 ArrayRef<ParmVarDecl *> params = CD->parameters().drop_front(IsCopy ? 1 : 0);
3943 for (const ParmVarDecl *PD : params) {
3944 assert(PD->hasDefaultArg() && "ctor closure lacks default args");
3945 ArgVec.push_back(PD->getDefaultArg());
Reid Kleckner93f661a2015-03-17 21:51:43 +00003946 }
David Majnemerdfa6d202015-03-11 18:36:39 +00003947
3948 CodeGenFunction::RunCleanupsScope Cleanups(CGF);
3949
3950 const auto *FPT = CD->getType()->castAs<FunctionProtoType>();
David Blaikief05779e2015-07-21 18:37:18 +00003951 CGF.EmitCallArgs(Args, FPT, llvm::makeArrayRef(ArgVec), CD, IsCopy ? 1 : 0);
David Majnemerdfa6d202015-03-11 18:36:39 +00003952
3953 // Insert any ABI-specific implicit constructor arguments.
George Burgess IVf203dbf2017-02-22 20:28:02 +00003954 AddedStructorArgs ExtraArgs =
3955 addImplicitConstructorArgs(CGF, CD, Ctor_Complete,
3956 /*ForVirtualBase=*/false,
3957 /*Delegating=*/false, Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00003958 // Call the destructor with our arguments.
John McCallb92ab1a2016-10-26 23:46:34 +00003959 llvm::Constant *CalleePtr =
3960 CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3961 CGCallee Callee = CGCallee::forDirect(CalleePtr, CD);
David Majnemerdfa6d202015-03-11 18:36:39 +00003962 const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall(
George Burgess IVd0a9e802017-02-23 22:07:35 +00003963 Args, CD, Ctor_Complete, ExtraArgs.Prefix, ExtraArgs.Suffix);
John McCallb92ab1a2016-10-26 23:46:34 +00003964 CGF.EmitCall(CalleeInfo, Callee, ReturnValueSlot(), Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00003965
3966 Cleanups.ForceCleanup();
3967
3968 // Emit the ret instruction, remove any temporary instructions created for the
3969 // aid of CodeGen.
3970 CGF.FinishFunction(SourceLocation());
3971
3972 return ThunkFn;
3973}
3974
David Majnemer7c237072015-03-05 00:46:22 +00003975llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
3976 uint32_t NVOffset,
3977 int32_t VBPtrOffset,
3978 uint32_t VBIndex) {
3979 assert(!T->isReferenceType());
3980
David Majnemere7a818f2015-03-06 18:53:55 +00003981 CXXRecordDecl *RD = T->getAsCXXRecordDecl();
3982 const CXXConstructorDecl *CD =
3983 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003984 CXXCtorType CT = Ctor_Complete;
David Majnemer37fd66e2015-03-13 22:36:55 +00003985 if (CD)
3986 if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1)
David Majnemerdfa6d202015-03-11 18:36:39 +00003987 CT = Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003988
David Majnemer7c237072015-03-05 00:46:22 +00003989 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
3990 SmallString<256> MangledName;
3991 {
3992 llvm::raw_svector_ostream Out(MangledName);
David Majnemerdfa6d202015-03-11 18:36:39 +00003993 getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +00003994 VBPtrOffset, VBIndex, Out);
David Majnemer7c237072015-03-05 00:46:22 +00003995 }
3996 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3997 return getImageRelativeConstant(GV);
3998
David Majnemerdfa6d202015-03-11 18:36:39 +00003999 // The TypeDescriptor is used by the runtime to determine if a catch handler
David Majnemer7c237072015-03-05 00:46:22 +00004000 // is appropriate for the exception object.
David Majnemer443250f2015-03-17 20:35:00 +00004001 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
David Majnemer7c237072015-03-05 00:46:22 +00004002
4003 // The runtime is responsible for calling the copy constructor if the
4004 // exception is caught by value.
David Majnemerdfa6d202015-03-11 18:36:39 +00004005 llvm::Constant *CopyCtor;
4006 if (CD) {
4007 if (CT == Ctor_CopyingClosure)
David Majnemer37fd66e2015-03-13 22:36:55 +00004008 CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure);
David Majnemerdfa6d202015-03-11 18:36:39 +00004009 else
4010 CopyCtor = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
4011
4012 CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy);
4013 } else {
4014 CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4015 }
David Majnemere7a818f2015-03-06 18:53:55 +00004016 CopyCtor = getImageRelativeConstant(CopyCtor);
David Majnemer7c237072015-03-05 00:46:22 +00004017
David Majnemere7a818f2015-03-06 18:53:55 +00004018 bool IsScalar = !RD;
David Majnemer7c237072015-03-05 00:46:22 +00004019 bool HasVirtualBases = false;
4020 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
David Majnemer7c237072015-03-05 00:46:22 +00004021 QualType PointeeType = T;
4022 if (T->isPointerType())
4023 PointeeType = T->getPointeeType();
4024 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
4025 HasVirtualBases = RD->getNumVBases() > 0;
4026 if (IdentifierInfo *II = RD->getIdentifier())
4027 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
4028 }
4029
4030 // Encode the relevant CatchableType properties into the Flags bitfield.
4031 // FIXME: Figure out how bits 2 or 8 can get set.
4032 uint32_t Flags = 0;
4033 if (IsScalar)
4034 Flags |= 1;
4035 if (HasVirtualBases)
4036 Flags |= 4;
4037 if (IsStdBadAlloc)
4038 Flags |= 16;
4039
4040 llvm::Constant *Fields[] = {
4041 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4042 TD, // TypeDescriptor
4043 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment
4044 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
4045 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex
4046 llvm::ConstantInt::get(CGM.IntTy, Size), // Size
4047 CopyCtor // CopyCtor
4048 };
4049 llvm::StructType *CTType = getCatchableTypeType();
4050 auto *GV = new llvm::GlobalVariable(
4051 CGM.getModule(), CTType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004052 llvm::ConstantStruct::get(CTType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004053 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004054 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004055 if (GV->isWeakForLinker())
4056 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004057 return getImageRelativeConstant(GV);
4058}
4059
4060llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
4061 assert(!T->isReferenceType());
4062
4063 // See if we've already generated a CatchableTypeArray for this type before.
4064 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
4065 if (CTA)
4066 return CTA;
4067
4068 // Ensure that we don't have duplicate entries in our CatchableTypeArray by
4069 // using a SmallSetVector. Duplicates may arise due to virtual bases
4070 // occurring more than once in the hierarchy.
4071 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
4072
4073 // C++14 [except.handle]p3:
4074 // A handler is a match for an exception object of type E if [...]
4075 // - the handler is of type cv T or cv T& and T is an unambiguous public
4076 // base class of E, or
4077 // - the handler is of type cv T or const T& where T is a pointer type and
4078 // E is a pointer type that can be converted to T by [...]
4079 // - a standard pointer conversion (4.10) not involving conversions to
4080 // pointers to private or protected or ambiguous classes
4081 const CXXRecordDecl *MostDerivedClass = nullptr;
4082 bool IsPointer = T->isPointerType();
4083 if (IsPointer)
4084 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
4085 else
4086 MostDerivedClass = T->getAsCXXRecordDecl();
4087
4088 // Collect all the unambiguous public bases of the MostDerivedClass.
4089 if (MostDerivedClass) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00004090 const ASTContext &Context = getContext();
David Majnemer7c237072015-03-05 00:46:22 +00004091 const ASTRecordLayout &MostDerivedLayout =
4092 Context.getASTRecordLayout(MostDerivedClass);
4093 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
4094 SmallVector<MSRTTIClass, 8> Classes;
4095 serializeClassHierarchy(Classes, MostDerivedClass);
4096 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
4097 detectAmbiguousBases(Classes);
4098 for (const MSRTTIClass &Class : Classes) {
4099 // Skip any ambiguous or private bases.
4100 if (Class.Flags &
4101 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
4102 continue;
4103 // Write down how to convert from a derived pointer to a base pointer.
4104 uint32_t OffsetInVBTable = 0;
4105 int32_t VBPtrOffset = -1;
4106 if (Class.VirtualRoot) {
4107 OffsetInVBTable =
4108 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
4109 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
4110 }
4111
4112 // Turn our record back into a pointer if the exception object is a
4113 // pointer.
4114 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
4115 if (IsPointer)
4116 RTTITy = Context.getPointerType(RTTITy);
4117 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
4118 VBPtrOffset, OffsetInVBTable));
4119 }
4120 }
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 cv T& and E and T are the same type
4125 // (ignoring the top-level cv-qualifiers)
4126 CatchableTypes.insert(getCatchableType(T));
4127
4128 // C++14 [except.handle]p3:
4129 // A handler is a match for an exception object of type E if
4130 // - the handler is of type cv T or const T& where T is a pointer type and
4131 // E is a pointer type that can be converted to T by [...]
4132 // - a standard pointer conversion (4.10) not involving conversions to
4133 // pointers to private or protected or ambiguous classes
4134 //
David Majnemerf205f532015-04-04 05:37:48 +00004135 // C++14 [conv.ptr]p2:
4136 // A prvalue of type "pointer to cv T," where T is an object type, can be
4137 // converted to a prvalue of type "pointer to cv void".
4138 if (IsPointer && T->getPointeeType()->isObjectType())
David Majnemer7c237072015-03-05 00:46:22 +00004139 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4140
David Majnemera1aea9a2015-03-12 17:44:49 +00004141 // C++14 [except.handle]p3:
4142 // A handler is a match for an exception object of type E if [...]
4143 // - the handler is of type cv T or const T& where T is a pointer or
4144 // pointer to member type and E is std::nullptr_t.
4145 //
4146 // We cannot possibly list all possible pointer types here, making this
4147 // implementation incompatible with the standard. However, MSVC includes an
4148 // entry for pointer-to-void in this case. Let's do the same.
4149 if (T->isNullPtrType())
4150 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4151
David Majnemer7c237072015-03-05 00:46:22 +00004152 uint32_t NumEntries = CatchableTypes.size();
4153 llvm::Type *CTType =
4154 getImageRelativeType(getCatchableTypeType()->getPointerTo());
4155 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
4156 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
4157 llvm::Constant *Fields[] = {
4158 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries
4159 llvm::ConstantArray::get(
4160 AT, llvm::makeArrayRef(CatchableTypes.begin(),
4161 CatchableTypes.end())) // CatchableTypes
4162 };
4163 SmallString<256> MangledName;
4164 {
4165 llvm::raw_svector_ostream Out(MangledName);
4166 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
4167 }
4168 CTA = new llvm::GlobalVariable(
4169 CGM.getModule(), CTAType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004170 llvm::ConstantStruct::get(CTAType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004171 CTA->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004172 CTA->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004173 if (CTA->isWeakForLinker())
4174 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004175 return CTA;
4176}
4177
4178llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
David Majnemer526793d2016-07-12 04:42:50 +00004179 bool IsConst, IsVolatile, IsUnaligned;
4180 T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile, IsUnaligned);
David Majnemer7c237072015-03-05 00:46:22 +00004181
4182 // The CatchableTypeArray enumerates the various (CV-unqualified) types that
4183 // the exception object may be caught as.
4184 llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
4185 // The first field in a CatchableTypeArray is the number of CatchableTypes.
4186 // This is used as a component of the mangled name which means that we need to
4187 // know what it is in order to see if we have previously generated the
4188 // ThrowInfo.
4189 uint32_t NumEntries =
4190 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
4191 ->getLimitedValue();
4192
4193 SmallString<256> MangledName;
4194 {
4195 llvm::raw_svector_ostream Out(MangledName);
David Majnemer526793d2016-07-12 04:42:50 +00004196 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, IsUnaligned,
4197 NumEntries, Out);
David Majnemer7c237072015-03-05 00:46:22 +00004198 }
4199
4200 // Reuse a previously generated ThrowInfo if we have generated an appropriate
4201 // one before.
4202 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4203 return GV;
4204
4205 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
4206 // be at least as CV qualified. Encode this requirement into the Flags
4207 // bitfield.
4208 uint32_t Flags = 0;
4209 if (IsConst)
4210 Flags |= 1;
4211 if (IsVolatile)
4212 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00004213 if (IsUnaligned)
4214 Flags |= 4;
David Majnemer7c237072015-03-05 00:46:22 +00004215
4216 // The cleanup-function (a destructor) must be called when the exception
4217 // object's lifetime ends.
4218 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4219 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
4220 if (CXXDestructorDecl *DtorD = RD->getDestructor())
4221 if (!DtorD->isTrivial())
4222 CleanupFn = llvm::ConstantExpr::getBitCast(
4223 CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete),
4224 CGM.Int8PtrTy);
4225 // This is unused as far as we can tell, initialize it to null.
4226 llvm::Constant *ForwardCompat =
4227 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
4228 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
4229 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
4230 llvm::StructType *TIType = getThrowInfoType();
4231 llvm::Constant *Fields[] = {
4232 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4233 getImageRelativeConstant(CleanupFn), // CleanupFn
4234 ForwardCompat, // ForwardCompat
4235 PointerToCatchableTypes // CatchableTypeArray
4236 };
4237 auto *GV = new llvm::GlobalVariable(
4238 CGM.getModule(), TIType, /*Constant=*/true, getLinkageForRTTI(T),
4239 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004240 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004241 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004242 if (GV->isWeakForLinker())
4243 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004244 return GV;
4245}
4246
4247void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
4248 const Expr *SubExpr = E->getSubExpr();
4249 QualType ThrowType = SubExpr->getType();
4250 // The exception object lives on the stack and it's address is passed to the
4251 // runtime function.
John McCall7f416cc2015-09-08 08:05:57 +00004252 Address AI = CGF.CreateMemTemp(ThrowType);
David Majnemer7c237072015-03-05 00:46:22 +00004253 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
4254 /*IsInit=*/true);
4255
4256 // The so-called ThrowInfo is used to describe how the exception object may be
4257 // caught.
4258 llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
4259
4260 // Call into the runtime to throw the exception.
John McCall7f416cc2015-09-08 08:05:57 +00004261 llvm::Value *Args[] = {
4262 CGF.Builder.CreateBitCast(AI.getPointer(), CGM.Int8PtrTy),
4263 TI
4264 };
David Majnemer7c237072015-03-05 00:46:22 +00004265 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
4266}
Peter Collingbourne60108802017-12-13 21:53:04 +00004267
4268std::pair<llvm::Value *, const CXXRecordDecl *>
4269MicrosoftCXXABI::LoadVTablePtr(CodeGenFunction &CGF, Address This,
4270 const CXXRecordDecl *RD) {
4271 std::tie(This, std::ignore, RD) =
4272 performBaseAdjustment(CGF, This, QualType(RD->getTypeForDecl(), 0));
4273 return {CGF.GetVTablePtr(This, CGM.Int8PtrTy, RD), RD};
4274}