blob: ffb3681c2585a62155662ee9396ea0ab82724dbc [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 McCallb92ab1a2016-10-26 23:46:34 +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 Wennborg853ae942014-05-30 16:59:42 +0000360 // Never dllimport/dllexport thunks.
361 Thunk->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
Hans Wennborgc94391d2014-06-06 20:04:01 +0000362
363 GVALinkage Linkage =
364 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
365
366 if (Linkage == GVA_Internal)
367 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
368 else if (ReturnAdjustment)
369 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
370 else
371 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000372 }
373
John McCall7f416cc2015-09-08 08:05:57 +0000374 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000375 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000376
John McCall7f416cc2015-09-08 08:05:57 +0000377 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000378 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000379
David Majnemerb3341ea2014-10-05 05:05:40 +0000380 void EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +0000381 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +0000382 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +0000383 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000384
385 bool usesThreadWrapperFunction() const override { return false; }
386 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
387 QualType LValType) override;
388
John McCallc84ed6a2012-05-01 06:13:13 +0000389 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
390 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000391 bool PerformInit) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000392 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
393 llvm::Constant *Dtor, llvm::Constant *Addr) override;
John McCallc84ed6a2012-05-01 06:13:13 +0000394
John McCall29036752011-01-27 02:46:02 +0000395 // ==== Notes on array cookies =========
396 //
397 // MSVC seems to only use cookies when the class has a destructor; a
398 // two-argument usual array deallocation function isn't sufficient.
399 //
400 // For example, this code prints "100" and "1":
401 // struct A {
402 // char x;
403 // void *operator new[](size_t sz) {
404 // printf("%u\n", sz);
405 // return malloc(sz);
406 // }
407 // void operator delete[](void *p, size_t sz) {
408 // printf("%u\n", sz);
409 // free(p);
410 // }
411 // };
412 // int main() {
413 // A *p = new A[100];
414 // delete[] p;
415 // }
416 // Whereas it prints "104" and "104" if you give A a destructor.
John McCallb91cd662012-05-01 05:23:51 +0000417
Craig Topper4f12f102014-03-12 06:41:41 +0000418 bool requiresArrayCookie(const CXXDeleteExpr *expr,
419 QualType elementType) override;
420 bool requiresArrayCookie(const CXXNewExpr *expr) override;
421 CharUnits getArrayCookieSizeImpl(QualType type) override;
John McCall7f416cc2015-09-08 08:05:57 +0000422 Address InitializeArrayCookie(CodeGenFunction &CGF,
423 Address NewPtr,
424 llvm::Value *NumElements,
425 const CXXNewExpr *expr,
426 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000427 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000428 Address allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000429 CharUnits cookieSize) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000430
David Majnemer611cdb92014-07-07 08:09:15 +0000431 friend struct MSRTTIBuilder;
432
433 bool isImageRelative() const {
434 return CGM.getTarget().getPointerWidth(/*AddressSpace=*/0) == 64;
435 }
436
437 // 5 routines for constructing the llvm types for MS RTTI structs.
438 llvm::StructType *getTypeDescriptorType(StringRef TypeInfoString) {
439 llvm::SmallString<32> TDTypeName("rtti.TypeDescriptor");
440 TDTypeName += llvm::utostr(TypeInfoString.size());
441 llvm::StructType *&TypeDescriptorType =
442 TypeDescriptorTypeMap[TypeInfoString.size()];
443 if (TypeDescriptorType)
444 return TypeDescriptorType;
445 llvm::Type *FieldTypes[] = {
446 CGM.Int8PtrPtrTy,
447 CGM.Int8PtrTy,
448 llvm::ArrayType::get(CGM.Int8Ty, TypeInfoString.size() + 1)};
449 TypeDescriptorType =
450 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, TDTypeName);
451 return TypeDescriptorType;
452 }
453
454 llvm::Type *getImageRelativeType(llvm::Type *PtrType) {
455 if (!isImageRelative())
456 return PtrType;
457 return CGM.IntTy;
458 }
459
460 llvm::StructType *getBaseClassDescriptorType() {
461 if (BaseClassDescriptorType)
462 return BaseClassDescriptorType;
463 llvm::Type *FieldTypes[] = {
464 getImageRelativeType(CGM.Int8PtrTy),
465 CGM.IntTy,
466 CGM.IntTy,
467 CGM.IntTy,
468 CGM.IntTy,
469 CGM.IntTy,
470 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
471 };
472 BaseClassDescriptorType = llvm::StructType::create(
473 CGM.getLLVMContext(), FieldTypes, "rtti.BaseClassDescriptor");
474 return BaseClassDescriptorType;
475 }
476
477 llvm::StructType *getClassHierarchyDescriptorType() {
478 if (ClassHierarchyDescriptorType)
479 return ClassHierarchyDescriptorType;
480 // Forward-declare RTTIClassHierarchyDescriptor to break a cycle.
481 ClassHierarchyDescriptorType = llvm::StructType::create(
482 CGM.getLLVMContext(), "rtti.ClassHierarchyDescriptor");
483 llvm::Type *FieldTypes[] = {
484 CGM.IntTy,
485 CGM.IntTy,
486 CGM.IntTy,
487 getImageRelativeType(
488 getBaseClassDescriptorType()->getPointerTo()->getPointerTo()),
489 };
490 ClassHierarchyDescriptorType->setBody(FieldTypes);
491 return ClassHierarchyDescriptorType;
492 }
493
494 llvm::StructType *getCompleteObjectLocatorType() {
495 if (CompleteObjectLocatorType)
496 return CompleteObjectLocatorType;
497 CompleteObjectLocatorType = llvm::StructType::create(
498 CGM.getLLVMContext(), "rtti.CompleteObjectLocator");
499 llvm::Type *FieldTypes[] = {
500 CGM.IntTy,
501 CGM.IntTy,
502 CGM.IntTy,
503 getImageRelativeType(CGM.Int8PtrTy),
504 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
505 getImageRelativeType(CompleteObjectLocatorType),
506 };
507 llvm::ArrayRef<llvm::Type *> FieldTypesRef(FieldTypes);
508 if (!isImageRelative())
509 FieldTypesRef = FieldTypesRef.drop_back();
510 CompleteObjectLocatorType->setBody(FieldTypesRef);
511 return CompleteObjectLocatorType;
512 }
513
514 llvm::GlobalVariable *getImageBase() {
515 StringRef Name = "__ImageBase";
516 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name))
517 return GV;
518
519 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8Ty,
520 /*isConstant=*/true,
521 llvm::GlobalValue::ExternalLinkage,
522 /*Initializer=*/nullptr, Name);
523 }
524
525 llvm::Constant *getImageRelativeConstant(llvm::Constant *PtrVal) {
526 if (!isImageRelative())
527 return PtrVal;
528
David Majnemer7c237072015-03-05 00:46:22 +0000529 if (PtrVal->isNullValue())
530 return llvm::Constant::getNullValue(CGM.IntTy);
531
David Majnemer611cdb92014-07-07 08:09:15 +0000532 llvm::Constant *ImageBaseAsInt =
533 llvm::ConstantExpr::getPtrToInt(getImageBase(), CGM.IntPtrTy);
534 llvm::Constant *PtrValAsInt =
535 llvm::ConstantExpr::getPtrToInt(PtrVal, CGM.IntPtrTy);
536 llvm::Constant *Diff =
537 llvm::ConstantExpr::getSub(PtrValAsInt, ImageBaseAsInt,
538 /*HasNUW=*/true, /*HasNSW=*/true);
539 return llvm::ConstantExpr::getTrunc(Diff, CGM.IntTy);
540 }
541
Reid Kleckner407e8b62013-03-22 19:02:54 +0000542private:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000543 MicrosoftMangleContext &getMangleContext() {
544 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext());
545 }
546
Reid Kleckner2341ae32013-04-11 18:13:19 +0000547 llvm::Constant *getZeroInt() {
548 return llvm::ConstantInt::get(CGM.IntTy, 0);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000549 }
550
Reid Kleckner2341ae32013-04-11 18:13:19 +0000551 llvm::Constant *getAllOnesInt() {
552 return llvm::Constant::getAllOnesValue(CGM.IntTy);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000553 }
554
Reid Kleckner0358cbf2016-07-01 02:41:25 +0000555 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) override;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000556
Reid Kleckner2341ae32013-04-11 18:13:19 +0000557 void
558 GetNullMemberPointerFields(const MemberPointerType *MPT,
559 llvm::SmallVectorImpl<llvm::Constant *> &fields);
560
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000561 /// \brief Shared code for virtual base adjustment. Returns the offset from
562 /// the vbptr to the virtual base. Optionally returns the address of the
563 /// vbptr itself.
564 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000565 Address Base,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000566 llvm::Value *VBPtrOffset,
567 llvm::Value *VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000568 llvm::Value **VBPtr = nullptr);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000569
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000570 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000571 Address Base,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000572 int32_t VBPtrOffset,
573 int32_t VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000574 llvm::Value **VBPtr = nullptr) {
Reid Kleckner0ba8ba42014-10-22 17:26:00 +0000575 assert(VBTableOffset % 4 == 0 && "should be byte offset into table of i32s");
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000576 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
577 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset);
578 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr);
579 }
580
Peter Collingbourne60108802017-12-13 21:53:04 +0000581 std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000582 performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000583 QualType SrcRecordTy);
584
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000585 /// \brief Performs a full virtual base adjustment. Used to dereference
586 /// pointers to members of virtual bases.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000587 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000588 const CXXRecordDecl *RD, Address Base,
Reid Kleckner2341ae32013-04-11 18:13:19 +0000589 llvm::Value *VirtualBaseAdjustmentOffset,
590 llvm::Value *VBPtrOffset /* optional */);
591
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000592 /// \brief Emits a full member pointer with the fields common to data and
593 /// function member pointers.
594 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField,
595 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +0000596 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +0000597 CharUnits NonVirtualBaseAdjustment,
598 unsigned VBTableIndex);
Reid Kleckner452abac2013-05-09 21:01:17 +0000599
Reid Kleckner452abac2013-05-09 21:01:17 +0000600 bool MemberPointerConstantIsNull(const MemberPointerType *MPT,
601 llvm::Constant *MP);
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000602
Reid Kleckner7810af02013-06-19 15:20:38 +0000603 /// \brief - Initialize all vbptrs of 'this' with RD as the complete type.
604 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
605
606 /// \brief Caching wrapper around VBTableBuilder::enumerateVBTables().
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000607 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000608
Hans Wennborg88497d62013-11-15 17:24:45 +0000609 /// \brief Generate a thunk for calling a virtual member function MD.
Reid Klecknere4a52202014-02-21 02:27:32 +0000610 llvm::Function *EmitVirtualMemPtrThunk(
611 const CXXMethodDecl *MD,
612 const MicrosoftVTableContext::MethodVFTableLocation &ML);
Hans Wennborg88497d62013-11-15 17:24:45 +0000613
Reid Kleckner407e8b62013-03-22 19:02:54 +0000614public:
Craig Topper4f12f102014-03-12 06:41:41 +0000615 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000616
Craig Topper4f12f102014-03-12 06:41:41 +0000617 bool isZeroInitializable(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000618
David Majnemerb3e56542014-08-07 22:56:13 +0000619 bool isMemberPointerConvertible(const MemberPointerType *MPT) const override {
620 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemer99281062014-09-18 22:05:54 +0000621 return RD->hasAttr<MSInheritanceAttr>();
622 }
623
Craig Topper4f12f102014-03-12 06:41:41 +0000624 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000625
Craig Topper4f12f102014-03-12 06:41:41 +0000626 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
627 CharUnits offset) override;
David Majnemere2be95b2015-06-23 07:31:01 +0000628 llvm::Constant *EmitMemberFunctionPointer(const CXXMethodDecl *MD) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000629 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000630
Craig Topper4f12f102014-03-12 06:41:41 +0000631 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
632 llvm::Value *L,
633 llvm::Value *R,
634 const MemberPointerType *MPT,
635 bool Inequality) override;
Reid Kleckner700c3ee2013-04-30 20:15:14 +0000636
Craig Topper4f12f102014-03-12 06:41:41 +0000637 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
638 llvm::Value *MemPtr,
639 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000640
Craig Topper4f12f102014-03-12 06:41:41 +0000641 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000642 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000643 Address Base, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000644 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000645
David Majnemer0d9ad682015-06-29 00:06:50 +0000646 llvm::Value *EmitNonNullMemberPointerConversion(
647 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
648 CastKind CK, CastExpr::path_const_iterator PathBegin,
649 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
650 CGBuilderTy &Builder);
651
Craig Topper4f12f102014-03-12 06:41:41 +0000652 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
653 const CastExpr *E,
654 llvm::Value *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000655
Craig Topper4f12f102014-03-12 06:41:41 +0000656 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
657 llvm::Constant *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000658
David Majnemer5ca193c2015-06-23 07:31:07 +0000659 llvm::Constant *EmitMemberPointerConversion(
660 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
661 CastKind CK, CastExpr::path_const_iterator PathBegin,
662 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src);
663
John McCallb92ab1a2016-10-26 23:46:34 +0000664 CGCallee
David Majnemer2b0d66d2014-02-20 23:22:07 +0000665 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000666 Address This, llvm::Value *&ThisPtrForCall,
667 llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000668 const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000669
Rafael Espindola91f68b42014-09-15 19:20:10 +0000670 void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) override;
671
David Majnemer7c237072015-03-05 00:46:22 +0000672 llvm::StructType *getCatchableTypeType() {
673 if (CatchableTypeType)
674 return CatchableTypeType;
675 llvm::Type *FieldTypes[] = {
676 CGM.IntTy, // Flags
677 getImageRelativeType(CGM.Int8PtrTy), // TypeDescriptor
678 CGM.IntTy, // NonVirtualAdjustment
679 CGM.IntTy, // OffsetToVBPtr
680 CGM.IntTy, // VBTableIndex
681 CGM.IntTy, // Size
682 getImageRelativeType(CGM.Int8PtrTy) // CopyCtor
683 };
684 CatchableTypeType = llvm::StructType::create(
685 CGM.getLLVMContext(), FieldTypes, "eh.CatchableType");
686 return CatchableTypeType;
687 }
688
689 llvm::StructType *getCatchableTypeArrayType(uint32_t NumEntries) {
690 llvm::StructType *&CatchableTypeArrayType =
691 CatchableTypeArrayTypeMap[NumEntries];
692 if (CatchableTypeArrayType)
693 return CatchableTypeArrayType;
694
695 llvm::SmallString<23> CTATypeName("eh.CatchableTypeArray.");
696 CTATypeName += llvm::utostr(NumEntries);
697 llvm::Type *CTType =
698 getImageRelativeType(getCatchableTypeType()->getPointerTo());
699 llvm::Type *FieldTypes[] = {
700 CGM.IntTy, // NumEntries
701 llvm::ArrayType::get(CTType, NumEntries) // CatchableTypes
702 };
703 CatchableTypeArrayType =
704 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, CTATypeName);
705 return CatchableTypeArrayType;
706 }
707
708 llvm::StructType *getThrowInfoType() {
709 if (ThrowInfoType)
710 return ThrowInfoType;
711 llvm::Type *FieldTypes[] = {
712 CGM.IntTy, // Flags
713 getImageRelativeType(CGM.Int8PtrTy), // CleanupFn
714 getImageRelativeType(CGM.Int8PtrTy), // ForwardCompat
715 getImageRelativeType(CGM.Int8PtrTy) // CatchableTypeArray
716 };
717 ThrowInfoType = llvm::StructType::create(CGM.getLLVMContext(), FieldTypes,
718 "eh.ThrowInfo");
719 return ThrowInfoType;
720 }
721
722 llvm::Constant *getThrowFn() {
723 // _CxxThrowException is passed an exception object and a ThrowInfo object
724 // which describes the exception.
725 llvm::Type *Args[] = {CGM.Int8PtrTy, getThrowInfoType()->getPointerTo()};
726 llvm::FunctionType *FTy =
727 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
728 auto *Fn = cast<llvm::Function>(
729 CGM.CreateRuntimeFunction(FTy, "_CxxThrowException"));
730 // _CxxThrowException is stdcall on 32-bit x86 platforms.
731 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::x86)
732 Fn->setCallingConv(llvm::CallingConv::X86_StdCall);
733 return Fn;
734 }
735
David Majnemer37fd66e2015-03-13 22:36:55 +0000736 llvm::Function *getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
737 CXXCtorType CT);
David Majnemerdfa6d202015-03-11 18:36:39 +0000738
David Majnemer7c237072015-03-05 00:46:22 +0000739 llvm::Constant *getCatchableType(QualType T,
740 uint32_t NVOffset = 0,
741 int32_t VBPtrOffset = -1,
742 uint32_t VBIndex = 0);
743
744 llvm::GlobalVariable *getCatchableTypeArray(QualType T);
745
David Majnemerba3e5ec2015-03-13 18:26:17 +0000746 llvm::GlobalVariable *getThrowInfo(QualType T) override;
David Majnemer7c237072015-03-05 00:46:22 +0000747
Peter Collingbourne60108802017-12-13 21:53:04 +0000748 std::pair<llvm::Value *, const CXXRecordDecl *>
749 LoadVTablePtr(CodeGenFunction &CGF, Address This,
750 const CXXRecordDecl *RD) override;
751
Reid Kleckner7810af02013-06-19 15:20:38 +0000752private:
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000753 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy;
David Majnemerd905da42014-07-01 20:30:31 +0000754 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy;
755 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000756 /// \brief All the vftables that have been referenced.
757 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000758 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000759
760 /// \brief This set holds the record decls we've deferred vtable emission for.
761 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
762
763
764 /// \brief All the vbtables which have been referenced.
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000765 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap;
Reid Klecknerd8110b62013-09-10 20:14:30 +0000766
767 /// Info on the global variable used to guard initialization of static locals.
768 /// The BitIndex field is only used for externally invisible declarations.
769 struct GuardInfo {
Craig Topper8a13c412014-05-21 05:09:00 +0000770 GuardInfo() : Guard(nullptr), BitIndex(0) {}
Reid Klecknerd8110b62013-09-10 20:14:30 +0000771 llvm::GlobalVariable *Guard;
772 unsigned BitIndex;
773 };
774
775 /// Map from DeclContext to the current guard variable. We assume that the
776 /// AST is visited in source code order.
777 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap;
David Majnemerec8e54b2015-05-07 21:19:06 +0000778 llvm::DenseMap<const DeclContext *, GuardInfo> ThreadLocalGuardVariableMap;
David Majnemer8354eee2015-05-07 06:15:46 +0000779 llvm::DenseMap<const DeclContext *, unsigned> ThreadSafeGuardNumMap;
David Majnemer611cdb92014-07-07 08:09:15 +0000780
781 llvm::DenseMap<size_t, llvm::StructType *> TypeDescriptorTypeMap;
782 llvm::StructType *BaseClassDescriptorType;
783 llvm::StructType *ClassHierarchyDescriptorType;
784 llvm::StructType *CompleteObjectLocatorType;
David Majnemer7c237072015-03-05 00:46:22 +0000785
786 llvm::DenseMap<QualType, llvm::GlobalVariable *> CatchableTypeArrays;
787
788 llvm::StructType *CatchableTypeType;
789 llvm::DenseMap<uint32_t, llvm::StructType *> CatchableTypeArrayTypeMap;
790 llvm::StructType *ThrowInfoType;
Charles Davis74ce8592010-06-09 23:25:41 +0000791};
792
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000793}
Charles Davis74ce8592010-06-09 23:25:41 +0000794
Reid Klecknere39ee212014-05-03 00:33:28 +0000795CGCXXABI::RecordArgABI
796MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const {
797 switch (CGM.getTarget().getTriple().getArch()) {
798 default:
799 // FIXME: Implement for other architectures.
800 return RAA_Default;
801
Reid Kleckner44051e62016-08-25 18:23:28 +0000802 case llvm::Triple::thumb:
803 // Use the simple Itanium rules for now.
804 // FIXME: This is incompatible with MSVC for arguments with a dtor and no
805 // copy ctor.
806 return !canCopyArgument(RD) ? RAA_Indirect : RAA_Default;
807
Reid Klecknere39ee212014-05-03 00:33:28 +0000808 case llvm::Triple::x86:
Reid Klecknercf87e102014-05-14 16:02:09 +0000809 // All record arguments are passed in memory on x86. Decide whether to
810 // construct the object directly in argument memory, or to construct the
811 // argument elsewhere and copy the bytes during the call.
812
813 // If C++ prohibits us from making a copy, construct the arguments directly
814 // into argument memory.
815 if (!canCopyArgument(RD))
Reid Klecknere39ee212014-05-03 00:33:28 +0000816 return RAA_DirectInMemory;
Reid Klecknercf87e102014-05-14 16:02:09 +0000817
818 // Otherwise, construct the argument into a temporary and copy the bytes
819 // into the outgoing argument memory.
Reid Klecknere39ee212014-05-03 00:33:28 +0000820 return RAA_Default;
821
822 case llvm::Triple::x86_64:
Richard Smith96cd6712017-08-16 01:49:53 +0000823 // If a class has a destructor, we'd really like to pass it indirectly
Reid Kleckner80944df2014-10-31 22:00:51 +0000824 // because it allows us to elide copies. Unfortunately, MSVC makes that
825 // impossible for small types, which it will pass in a single register or
826 // stack slot. Most objects with dtors are large-ish, so handle that early.
827 // We can't call out all large objects as being indirect because there are
828 // multiple x64 calling conventions and the C++ ABI code shouldn't dictate
829 // how we pass large POD types.
Richard Smith96cd6712017-08-16 01:49:53 +0000830 //
831 // Note: This permits small classes with nontrivial destructors to be
832 // passed in registers, which is non-conforming.
Reid Kleckner80944df2014-10-31 22:00:51 +0000833 if (RD->hasNonTrivialDestructor() &&
834 getContext().getTypeSize(RD->getTypeForDecl()) > 64)
Reid Klecknere39ee212014-05-03 00:33:28 +0000835 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000836
Richard Smith96cd6712017-08-16 01:49:53 +0000837 // If a class has at least one non-deleted, trivial copy constructor, it
838 // is passed according to the C ABI. Otherwise, it is passed indirectly.
839 //
840 // Note: This permits classes with non-trivial copy or move ctors to be
841 // passed in registers, so long as they *also* have a trivial copy ctor,
842 // which is non-conforming.
843 if (RD->needsImplicitCopyConstructor()) {
844 // If the copy ctor has not yet been declared, we can read its triviality
845 // off the AST.
846 if (!RD->defaultedCopyConstructorIsDeleted() &&
847 RD->hasTrivialCopyConstructor())
848 return RAA_Default;
849 } else {
850 // Otherwise, we need to find the copy constructor(s) and ask.
851 for (const CXXConstructorDecl *CD : RD->ctors()) {
852 if (CD->isCopyConstructor()) {
853 // We had at least one nondeleted trivial copy ctor. Return directly.
854 if (!CD->isDeleted() && CD->isTrivial())
855 return RAA_Default;
856 }
Reid Klecknercf87e102014-05-14 16:02:09 +0000857 }
858 }
859
Richard Smith96cd6712017-08-16 01:49:53 +0000860 // We have no trivial, non-deleted copy constructor.
Peter Collingbourne120eb542016-11-22 00:21:43 +0000861 return RAA_Indirect;
Reid Klecknere39ee212014-05-03 00:33:28 +0000862 }
863
864 llvm_unreachable("invalid enum");
865}
866
David Majnemer08681372014-11-01 07:37:17 +0000867void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
868 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000869 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +0000870 QualType ElementType,
871 const CXXDestructorDecl *Dtor) {
David Majnemer0c0b6d92014-10-31 20:09:12 +0000872 // FIXME: Provide a source location here even though there's no
873 // CXXMemberCallExpr for dtor call.
David Majnemer08681372014-11-01 07:37:17 +0000874 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000875 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
876 llvm::Value *MDThis =
877 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr);
878 if (UseGlobalDelete)
David Majnemer08681372014-11-01 07:37:17 +0000879 CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType);
John McCall82fb8922012-09-25 10:10:39 +0000880}
881
David Majnemer442d0a22014-11-25 07:20:20 +0000882void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
David Majnemer7c237072015-03-05 00:46:22 +0000883 llvm::Value *Args[] = {
884 llvm::ConstantPointerNull::get(CGM.Int8PtrTy),
885 llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())};
886 auto *Fn = getThrowFn();
David Majnemer442d0a22014-11-25 07:20:20 +0000887 if (isNoReturn)
888 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args);
889 else
890 CGF.EmitRuntimeCallOrInvoke(Fn, Args);
891}
892
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000893namespace {
Reid Kleckner129552b2015-10-08 01:13:52 +0000894struct CatchRetScope final : EHScopeStack::Cleanup {
David Majnemere888a2f2015-08-15 03:21:08 +0000895 llvm::CatchPadInst *CPI;
896
Reid Kleckner129552b2015-10-08 01:13:52 +0000897 CatchRetScope(llvm::CatchPadInst *CPI) : CPI(CPI) {}
David Majnemere888a2f2015-08-15 03:21:08 +0000898
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000899 void Emit(CodeGenFunction &CGF, Flags flags) override {
Reid Kleckner129552b2015-10-08 01:13:52 +0000900 llvm::BasicBlock *BB = CGF.createBasicBlock("catchret.dest");
901 CGF.Builder.CreateCatchRet(CPI, BB);
902 CGF.EmitBlock(BB);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000903 }
904};
905}
906
907void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF,
908 const CXXCatchStmt *S) {
909 // In the MS ABI, the runtime handles the copy, and the catch handler is
910 // responsible for destruction.
911 VarDecl *CatchParam = S->getExceptionDecl();
David Majnemer4e52d6f2015-12-12 05:39:21 +0000912 llvm::BasicBlock *CatchPadBB = CGF.Builder.GetInsertBlock();
Reid Kleckner129552b2015-10-08 01:13:52 +0000913 llvm::CatchPadInst *CPI =
914 cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
David Majnemer4e52d6f2015-12-12 05:39:21 +0000915 CGF.CurrentFuncletPad = CPI;
Reid Kleckner129552b2015-10-08 01:13:52 +0000916
Reid Kleckner67cf0352015-04-07 00:09:59 +0000917 // If this is a catch-all or the catch parameter is unnamed, we don't need to
918 // emit an alloca to the object.
919 if (!CatchParam || !CatchParam->getDeclName()) {
Reid Kleckner129552b2015-10-08 01:13:52 +0000920 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000921 return;
922 }
923
924 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
Reid Kleckner129552b2015-10-08 01:13:52 +0000925 CPI->setArgOperand(2, var.getObjectAddress(CGF).getPointer());
926 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000927 CGF.EmitAutoVarCleanups(var);
928}
929
John McCall7f416cc2015-09-08 08:05:57 +0000930/// We need to perform a generic polymorphic operation (like a typeid
931/// or a cast), which requires an object with a vfptr. Adjust the
932/// address to point to an object with a vfptr.
Peter Collingbourne60108802017-12-13 21:53:04 +0000933std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000934MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000935 QualType SrcRecordTy) {
David Majnemer1162d252014-06-22 19:05:33 +0000936 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
937 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
David Majnemer9ced3dd2015-03-14 23:44:48 +0000938 const ASTContext &Context = getContext();
David Majnemer1162d252014-06-22 19:05:33 +0000939
John McCall7f416cc2015-09-08 08:05:57 +0000940 // If the class itself has a vfptr, great. This check implicitly
941 // covers non-virtual base subobjects: a class with its own virtual
942 // functions would be a candidate to be a primary base.
David Majnemer5bc883f2015-02-27 02:38:02 +0000943 if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
Peter Collingbourne60108802017-12-13 21:53:04 +0000944 return std::make_tuple(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0),
945 SrcDecl);
David Majnemer1162d252014-06-22 19:05:33 +0000946
John McCall7f416cc2015-09-08 08:05:57 +0000947 // Okay, one of the vbases must have a vfptr, or else this isn't
948 // actually a polymorphic class.
949 const CXXRecordDecl *PolymorphicBase = nullptr;
950 for (auto &Base : SrcDecl->vbases()) {
951 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
952 if (Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr()) {
953 PolymorphicBase = BaseDecl;
954 break;
955 }
956 }
957 assert(PolymorphicBase && "polymorphic class has no apparent vfptr?");
958
959 llvm::Value *Offset =
960 GetVirtualBaseClassOffset(CGF, Value, SrcDecl, PolymorphicBase);
961 llvm::Value *Ptr = CGF.Builder.CreateInBoundsGEP(Value.getPointer(), Offset);
John McCall7f416cc2015-09-08 08:05:57 +0000962 CharUnits VBaseAlign =
963 CGF.CGM.getVBaseAlignment(Value.getAlignment(), SrcDecl, PolymorphicBase);
Peter Collingbourne60108802017-12-13 21:53:04 +0000964 return std::make_tuple(Address(Ptr, VBaseAlign), Offset, PolymorphicBase);
David Majnemer1162d252014-06-22 19:05:33 +0000965}
966
967bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
968 QualType SrcRecordTy) {
969 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
970 return IsDeref &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000971 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000972}
973
974static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF,
975 llvm::Value *Argument) {
976 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
977 llvm::FunctionType *FTy =
978 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
979 llvm::Value *Args[] = {Argument};
980 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
981 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
982}
983
984void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
985 llvm::CallSite Call =
986 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
987 Call.setDoesNotReturn();
988 CGF.Builder.CreateUnreachable();
989}
990
991llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
992 QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000993 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000994 llvm::Type *StdTypeInfoPtrTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +0000995 std::tie(ThisPtr, std::ignore, std::ignore) =
David Majnemer17755352016-07-09 19:26:25 +0000996 performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +0000997 auto Typeid = emitRTtypeidCall(CGF, ThisPtr.getPointer()).getInstruction();
998 return CGF.Builder.CreateBitCast(Typeid, StdTypeInfoPtrTy);
David Majnemer1162d252014-06-22 19:05:33 +0000999}
1000
1001bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
1002 QualType SrcRecordTy) {
1003 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
1004 return SrcIsPtr &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001005 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +00001006}
1007
1008llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
John McCall7f416cc2015-09-08 08:05:57 +00001009 CodeGenFunction &CGF, Address This, QualType SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00001010 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
1011 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
1012
1013 llvm::Value *SrcRTTI =
1014 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
1015 llvm::Value *DestRTTI =
1016 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
1017
1018 llvm::Value *Offset;
Peter Collingbourne60108802017-12-13 21:53:04 +00001019 std::tie(This, Offset, std::ignore) =
1020 performBaseAdjustment(CGF, This, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +00001021 llvm::Value *ThisPtr = This.getPointer();
David Majnemer17755352016-07-09 19:26:25 +00001022 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
David Majnemer1162d252014-06-22 19:05:33 +00001023
1024 // PVOID __RTDynamicCast(
1025 // PVOID inptr,
1026 // LONG VfDelta,
1027 // PVOID SrcType,
1028 // PVOID TargetType,
1029 // BOOL isReference)
1030 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
1031 CGF.Int8PtrTy, CGF.Int32Ty};
1032 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1033 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1034 "__RTDynamicCast");
1035 llvm::Value *Args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001036 ThisPtr, Offset, SrcRTTI, DestRTTI,
David Majnemer1162d252014-06-22 19:05:33 +00001037 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
John McCall7f416cc2015-09-08 08:05:57 +00001038 ThisPtr = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction();
1039 return CGF.Builder.CreateBitCast(ThisPtr, DestLTy);
David Majnemer1162d252014-06-22 19:05:33 +00001040}
1041
1042llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00001043MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +00001044 QualType SrcRecordTy,
1045 QualType DestTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +00001046 std::tie(Value, std::ignore, std::ignore) =
1047 performBaseAdjustment(CGF, Value, SrcRecordTy);
David Majnemer1162d252014-06-22 19:05:33 +00001048
1049 // PVOID __RTCastToVoid(
1050 // PVOID inptr)
1051 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
1052 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1053 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1054 "__RTCastToVoid");
John McCall7f416cc2015-09-08 08:05:57 +00001055 llvm::Value *Args[] = {Value.getPointer()};
David Majnemer1162d252014-06-22 19:05:33 +00001056 return CGF.EmitRuntimeCall(Function, Args);
1057}
1058
1059bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
1060 return false;
1061}
1062
David Majnemerca32f932014-09-01 18:50:02 +00001063llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
John McCall7f416cc2015-09-08 08:05:57 +00001064 CodeGenFunction &CGF, Address This, const CXXRecordDecl *ClassDecl,
David Majnemerca32f932014-09-01 18:50:02 +00001065 const CXXRecordDecl *BaseClassDecl) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001066 const ASTContext &Context = getContext();
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00001067 int64_t VBPtrChars =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001068 Context.getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001069 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
David Majnemer9ced3dd2015-03-14 23:44:48 +00001070 CharUnits IntSize = Context.getTypeSizeInChars(Context.IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001071 CharUnits VBTableChars =
1072 IntSize *
1073 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001074 llvm::Value *VBTableOffset =
David Majnemerca32f932014-09-01 18:50:02 +00001075 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001076
1077 llvm::Value *VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001078 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001079 VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001080 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001081 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
1082}
1083
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001084bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
1085 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +00001086}
1087
David Majnemer0c0b6d92014-10-31 20:09:12 +00001088static bool isDeletingDtor(GlobalDecl GD) {
1089 return isa<CXXDestructorDecl>(GD.getDecl()) &&
1090 GD.getDtorType() == Dtor_Deleting;
1091}
1092
1093bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const {
1094 return isDeletingDtor(GD);
1095}
1096
Reid Kleckner40ca9132014-05-13 22:05:45 +00001097bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
1098 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
1099 if (!RD)
1100 return false;
1101
John McCall7f416cc2015-09-08 08:05:57 +00001102 CharUnits Align = CGM.getContext().getTypeAlignInChars(FI.getReturnType());
Reid Kleckner40ca9132014-05-13 22:05:45 +00001103 if (FI.isInstanceMethod()) {
1104 // If it's an instance method, aggregates are always returned indirectly via
1105 // the second parameter.
John McCall7f416cc2015-09-08 08:05:57 +00001106 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001107 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod());
1108 return true;
1109 } else if (!RD->isPOD()) {
1110 // If it's a free function, non-POD types are returned indirectly.
John McCall7f416cc2015-09-08 08:05:57 +00001111 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001112 return true;
1113 }
1114
1115 // Otherwise, use the C ABI rules.
1116 return false;
1117}
1118
Reid Kleckner7810af02013-06-19 15:20:38 +00001119llvm::BasicBlock *
1120MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
1121 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001122 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1123 assert(IsMostDerivedClass &&
1124 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +00001125 llvm::Value *IsCompleteObject =
1126 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001127
1128 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
1129 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
1130 CGF.Builder.CreateCondBr(IsCompleteObject,
1131 CallVbaseCtorsBB, SkipVbaseCtorsBB);
1132
1133 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +00001134
1135 // Fill in the vbtable pointers here.
1136 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001137
1138 // CGF will put the base ctor calls in this basic block for us later.
1139
1140 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +00001141}
1142
Erich Keane13c7ec52016-12-07 00:21:45 +00001143llvm::BasicBlock *
1144MicrosoftCXXABI::EmitDtorCompleteObjectHandler(CodeGenFunction &CGF) {
1145 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1146 assert(IsMostDerivedClass &&
1147 "ctor for a class with virtual bases must have an implicit parameter");
1148 llvm::Value *IsCompleteObject =
1149 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
1150
1151 llvm::BasicBlock *CallVbaseDtorsBB = CGF.createBasicBlock("Dtor.dtor_vbases");
1152 llvm::BasicBlock *SkipVbaseDtorsBB = CGF.createBasicBlock("Dtor.skip_vbases");
1153 CGF.Builder.CreateCondBr(IsCompleteObject,
1154 CallVbaseDtorsBB, SkipVbaseDtorsBB);
1155
1156 CGF.EmitBlock(CallVbaseDtorsBB);
1157 // CGF will put the base dtor calls in this basic block for us later.
1158
1159 return SkipVbaseDtorsBB;
1160}
1161
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001162void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
1163 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
1164 // In most cases, an override for a vbase virtual method can adjust
1165 // the "this" parameter by applying a constant offset.
1166 // However, this is not enough while a constructor or a destructor of some
1167 // class X is being executed if all the following conditions are met:
1168 // - X has virtual bases, (1)
1169 // - X overrides a virtual method M of a vbase Y, (2)
1170 // - X itself is a vbase of the most derived class.
1171 //
1172 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
1173 // which holds the extra amount of "this" adjustment we must do when we use
1174 // the X vftables (i.e. during X ctor or dtor).
1175 // Outside the ctors and dtors, the values of vtorDisps are zero.
1176
1177 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
1178 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
1179 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
1180 CGBuilderTy &Builder = CGF.Builder;
1181
John McCall7f416cc2015-09-08 08:05:57 +00001182 unsigned AS = getThisAddress(CGF).getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +00001183 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001184
1185 for (VBOffsets::const_iterator I = VBaseMap.begin(), E = VBaseMap.end();
1186 I != E; ++I) {
1187 if (!I->second.hasVtorDisp())
1188 continue;
1189
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +00001190 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00001191 GetVirtualBaseClassOffset(CGF, getThisAddress(CGF), RD, I->first);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001192 uint64_t ConstantVBaseOffset =
1193 Layout.getVBaseClassOffset(I->first).getQuantity();
1194
1195 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
1196 llvm::Value *VtorDispValue = Builder.CreateSub(
David Majnemer17755352016-07-09 19:26:25 +00001197 VBaseOffset, llvm::ConstantInt::get(CGM.PtrDiffTy, ConstantVBaseOffset),
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001198 "vtordisp.value");
David Majnemer17755352016-07-09 19:26:25 +00001199 VtorDispValue = Builder.CreateTruncOrBitCast(VtorDispValue, CGF.Int32Ty);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001200
1201 if (!Int8This)
1202 Int8This = Builder.CreateBitCast(getThisValue(CGF),
1203 CGF.Int8Ty->getPointerTo(AS));
1204 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
1205 // vtorDisp is always the 32-bits before the vbase in the class layout.
1206 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
1207 VtorDispPtr = Builder.CreateBitCast(
1208 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
1209
John McCall7f416cc2015-09-08 08:05:57 +00001210 Builder.CreateAlignedStore(VtorDispValue, VtorDispPtr,
1211 CharUnits::fromQuantity(4));
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001212 }
1213}
1214
David Majnemer37fd66e2015-03-13 22:36:55 +00001215static bool hasDefaultCXXMethodCC(ASTContext &Context,
1216 const CXXMethodDecl *MD) {
1217 CallingConv ExpectedCallingConv = Context.getDefaultCallingConvention(
1218 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1219 CallingConv ActualCallingConv =
1220 MD->getType()->getAs<FunctionProtoType>()->getCallConv();
1221 return ExpectedCallingConv == ActualCallingConv;
1222}
1223
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001224void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1225 // There's only one constructor type in this ABI.
1226 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
David Majnemer37fd66e2015-03-13 22:36:55 +00001227
1228 // Exported default constructors either have a simple call-site where they use
1229 // the typical calling convention and have a single 'this' pointer for an
1230 // argument -or- they get a wrapper function which appropriately thunks to the
1231 // real default constructor. This thunk is the default constructor closure.
1232 if (D->hasAttr<DLLExportAttr>() && D->isDefaultConstructor())
1233 if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) {
1234 llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure);
1235 Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage);
1236 Fn->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1237 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001238}
1239
Reid Kleckner7810af02013-06-19 15:20:38 +00001240void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1241 const CXXRecordDecl *RD) {
John McCall7f416cc2015-09-08 08:05:57 +00001242 Address This = getThisAddress(CGF);
1243 This = CGF.Builder.CreateElementBitCast(This, CGM.Int8Ty, "this.int8");
David Majnemer9ced3dd2015-03-14 23:44:48 +00001244 const ASTContext &Context = getContext();
1245 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001246
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001247 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1248 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00001249 const std::unique_ptr<VPtrInfo> &VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001250 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +00001251 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001252 Context.getASTRecordLayout(VBT->IntroducingObject);
Reid Kleckner5f080942014-01-03 23:42:00 +00001253 CharUnits Offs = VBT->NonVirtualOffset;
1254 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001255 if (VBT->getVBaseWithVPtr())
1256 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
John McCall7f416cc2015-09-08 08:05:57 +00001257 Address VBPtr = CGF.Builder.CreateConstInBoundsByteGEP(This, Offs);
David Blaikie1ed728c2015-04-05 22:45:47 +00001258 llvm::Value *GVPtr =
1259 CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001260 VBPtr = CGF.Builder.CreateElementBitCast(VBPtr, GVPtr->getType(),
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001261 "vbptr." + VBT->ObjectWithVPtr->getName());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001262 CGF.Builder.CreateStore(GVPtr, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +00001263 }
1264}
1265
George Burgess IVf203dbf2017-02-22 20:28:02 +00001266CGCXXABI::AddedStructorArgs
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001267MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001268 SmallVectorImpl<CanQualType> &ArgTys) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001269 AddedStructorArgs Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001270 // TODO: 'for base' flag
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001271 if (T == StructorType::Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001272 // The scalar deleting destructor takes an implicit int parameter.
David Majnemer9ced3dd2015-03-14 23:44:48 +00001273 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001274 ++Added.Suffix;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001275 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001276 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
1277 if (!CD)
George Burgess IVf203dbf2017-02-22 20:28:02 +00001278 return Added;
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001279
1280 // All parameters are already in place except is_most_derived, which goes
1281 // after 'this' if it's variadic and last if it's not.
1282
1283 const CXXRecordDecl *Class = CD->getParent();
1284 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1285 if (Class->getNumVBases()) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001286 if (FPT->isVariadic()) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001287 ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001288 ++Added.Prefix;
1289 } else {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001290 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001291 ++Added.Suffix;
1292 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001293 }
George Burgess IVf203dbf2017-02-22 20:28:02 +00001294
1295 return Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001296}
1297
Reid Klecknere7de47e2013-07-22 13:51:44 +00001298void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1299 // The TU defining a dtor is only guaranteed to emit a base destructor. All
1300 // other destructor variants are delegating thunks.
1301 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1302}
1303
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001304CharUnits
1305MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001306 GD = GD.getCanonicalDecl();
1307 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001308
1309 GlobalDecl LookupGD = GD;
1310 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1311 // Complete destructors take a pointer to the complete object as a
1312 // parameter, thus don't need this adjustment.
1313 if (GD.getDtorType() == Dtor_Complete)
1314 return CharUnits();
1315
1316 // There's no Dtor_Base in vftable but it shares the this adjustment with
1317 // the deleting one, so look it up instead.
1318 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1319 }
1320
1321 MicrosoftVTableContext::MethodVFTableLocation ML =
1322 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
1323 CharUnits Adjustment = ML.VFPtrOffset;
1324
1325 // Normal virtual instance methods need to adjust from the vfptr that first
1326 // defined the virtual method to the virtual base subobject, but destructors
1327 // do not. The vector deleting destructor thunk applies this adjustment for
1328 // us if necessary.
1329 if (isa<CXXDestructorDecl>(MD))
1330 Adjustment = CharUnits::Zero();
1331
1332 if (ML.VBase) {
1333 const ASTRecordLayout &DerivedLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001334 getContext().getASTRecordLayout(MD->getParent());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001335 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1336 }
1337
1338 return Adjustment;
1339}
1340
John McCall7f416cc2015-09-08 08:05:57 +00001341Address MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1342 CodeGenFunction &CGF, GlobalDecl GD, Address This,
1343 bool VirtualCall) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001344 if (!VirtualCall) {
1345 // If the call of a virtual function is not virtual, we just have to
1346 // compensate for the adjustment the virtual function does in its prologue.
1347 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1348 if (Adjustment.isZero())
1349 return This;
1350
John McCall7f416cc2015-09-08 08:05:57 +00001351 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001352 assert(Adjustment.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001353 return CGF.Builder.CreateConstByteGEP(This, Adjustment);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001354 }
1355
1356 GD = GD.getCanonicalDecl();
1357 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001358
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001359 GlobalDecl LookupGD = GD;
1360 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1361 // Complete dtors take a pointer to the complete object,
1362 // thus don't need adjustment.
1363 if (GD.getDtorType() == Dtor_Complete)
1364 return This;
1365
1366 // There's only Dtor_Deleting in vftable but it shares the this adjustment
1367 // with the base one, so look up the deleting one instead.
1368 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1369 }
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001370 MicrosoftVTableContext::MethodVFTableLocation ML =
1371 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001372
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001373 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001374
1375 // Base destructors expect 'this' to point to the beginning of the base
1376 // subobject, not the first vfptr that happens to contain the virtual dtor.
1377 // However, we still need to apply the virtual base adjustment.
1378 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1379 StaticOffset = CharUnits::Zero();
1380
John McCall7f416cc2015-09-08 08:05:57 +00001381 Address Result = This;
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001382 if (ML.VBase) {
John McCall7f416cc2015-09-08 08:05:57 +00001383 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
1384
1385 const CXXRecordDecl *Derived = MD->getParent();
1386 const CXXRecordDecl *VBase = ML.VBase;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001387 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00001388 GetVirtualBaseClassOffset(CGF, Result, Derived, VBase);
1389 llvm::Value *VBasePtr =
1390 CGF.Builder.CreateInBoundsGEP(Result.getPointer(), VBaseOffset);
1391 CharUnits VBaseAlign =
1392 CGF.CGM.getVBaseAlignment(Result.getAlignment(), Derived, VBase);
1393 Result = Address(VBasePtr, VBaseAlign);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001394 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001395 if (!StaticOffset.isZero()) {
1396 assert(StaticOffset.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001397 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001398 if (ML.VBase) {
1399 // Non-virtual adjustment might result in a pointer outside the allocated
1400 // object, e.g. if the final overrider class is laid out after the virtual
1401 // base that declares a method in the most derived class.
1402 // FIXME: Update the code that emits this adjustment in thunks prologues.
John McCall7f416cc2015-09-08 08:05:57 +00001403 Result = CGF.Builder.CreateConstByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001404 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001405 Result = CGF.Builder.CreateConstInBoundsByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001406 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001407 }
John McCall7f416cc2015-09-08 08:05:57 +00001408 return Result;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001409}
1410
Reid Kleckner89077a12013-12-17 19:46:40 +00001411void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1412 QualType &ResTy,
1413 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001414 ASTContext &Context = getContext();
1415 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001416 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001417 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
Alexey Bataev56223232017-06-09 13:40:18 +00001418 auto *IsMostDerived = ImplicitParamDecl::Create(
1419 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1420 &Context.Idents.get("is_most_derived"), Context.IntTy,
1421 ImplicitParamDecl::Other);
Reid Kleckner89077a12013-12-17 19:46:40 +00001422 // The 'most_derived' parameter goes second if the ctor is variadic and last
1423 // if it's not. Dtors can't be variadic.
1424 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1425 if (FPT->isVariadic())
1426 Params.insert(Params.begin() + 1, IsMostDerived);
1427 else
1428 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001429 getStructorImplicitParamDecl(CGF) = IsMostDerived;
David Majnemer0c0b6d92014-10-31 20:09:12 +00001430 } else if (isDeletingDtor(CGF.CurGD)) {
Alexey Bataev56223232017-06-09 13:40:18 +00001431 auto *ShouldDelete = ImplicitParamDecl::Create(
1432 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1433 &Context.Idents.get("should_call_delete"), Context.IntTy,
1434 ImplicitParamDecl::Other);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001435 Params.push_back(ShouldDelete);
1436 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1437 }
John McCall0f999f32012-09-25 08:00:39 +00001438}
1439
1440void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
Justin Lebared4f1722016-07-27 22:04:24 +00001441 // Naked functions have no prolog.
1442 if (CGF.CurFuncDecl && CGF.CurFuncDecl->hasAttr<NakedAttr>())
1443 return;
1444
Reid Kleckner06239e42017-11-16 19:09:36 +00001445 // Overridden virtual methods of non-primary bases need to adjust the incoming
1446 // 'this' pointer in the prologue. In this hierarchy, C::b will subtract
1447 // sizeof(void*) to adjust from B* to C*:
1448 // struct A { virtual void a(); };
1449 // struct B { virtual void b(); };
1450 // struct C : A, B { virtual void b(); };
1451 //
1452 // Leave the value stored in the 'this' alloca unadjusted, so that the
1453 // debugger sees the unadjusted value. Microsoft debuggers require this, and
1454 // will apply the ThisAdjustment in the method type information.
1455 // FIXME: Do something better for DWARF debuggers, which won't expect this,
1456 // without making our codegen depend on debug info settings.
1457 llvm::Value *This = loadIncomingCXXThis(CGF);
1458 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1459 if (!CGF.CurFuncIsThunk && MD->isVirtual()) {
1460 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(CGF.CurGD);
1461 if (!Adjustment.isZero()) {
1462 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1463 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1464 *thisTy = This->getType();
1465 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1466 assert(Adjustment.isPositive());
1467 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
1468 -Adjustment.getQuantity());
1469 This = CGF.Builder.CreateBitCast(This, thisTy, "this.adjusted");
1470 }
1471 }
1472 setCXXABIThisValue(CGF, This);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001473
Reid Kleckner06239e42017-11-16 19:09:36 +00001474 // If this is a function that the ABI specifies returns 'this', initialize
1475 // the return slot to 'this' at the start of the function.
1476 //
1477 // Unlike the setting of return types, this is done within the ABI
1478 // implementation instead of by clients of CGCXXABI because:
1479 // 1) getThisValue is currently protected
1480 // 2) in theory, an ABI could implement 'this' returns some other way;
1481 // HasThisReturn only specifies a contract, not the implementation
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001482 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001483 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001484 else if (hasMostDerivedReturn(CGF.CurGD))
1485 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1486 CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001487
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001488 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1489 assert(getStructorImplicitParamDecl(CGF) &&
1490 "no implicit parameter for a constructor with virtual bases?");
1491 getStructorImplicitParamValue(CGF)
1492 = CGF.Builder.CreateLoad(
1493 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1494 "is_most_derived");
1495 }
1496
David Majnemer0c0b6d92014-10-31 20:09:12 +00001497 if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001498 assert(getStructorImplicitParamDecl(CGF) &&
1499 "no implicit parameter for a deleting destructor?");
1500 getStructorImplicitParamValue(CGF)
1501 = CGF.Builder.CreateLoad(
1502 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1503 "should_call_delete");
1504 }
John McCall0f999f32012-09-25 08:00:39 +00001505}
1506
George Burgess IVf203dbf2017-02-22 20:28:02 +00001507CGCXXABI::AddedStructorArgs MicrosoftCXXABI::addImplicitConstructorArgs(
Reid Kleckner89077a12013-12-17 19:46:40 +00001508 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1509 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001510 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001511
Reid Kleckner89077a12013-12-17 19:46:40 +00001512 // Check if we need a 'most_derived' parameter.
1513 if (!D->getParent()->getNumVBases())
George Burgess IVf203dbf2017-02-22 20:28:02 +00001514 return AddedStructorArgs{};
Reid Kleckner89077a12013-12-17 19:46:40 +00001515
1516 // Add the 'most_derived' argument second if we are variadic or last if not.
1517 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
David Majnemer833b91e2016-05-13 20:05:09 +00001518 llvm::Value *MostDerivedArg;
1519 if (Delegating) {
1520 MostDerivedArg = getStructorImplicitParamValue(CGF);
1521 } else {
1522 MostDerivedArg = llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001523 }
David Majnemer833b91e2016-05-13 20:05:09 +00001524 RValue RV = RValue::get(MostDerivedArg);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001525 if (FPT->isVariadic()) {
David Majnemer833b91e2016-05-13 20:05:09 +00001526 Args.insert(Args.begin() + 1,
1527 CallArg(RV, getContext().IntTy, /*needscopy=*/false));
George Burgess IVf203dbf2017-02-22 20:28:02 +00001528 return AddedStructorArgs::prefix(1);
1529 }
1530 Args.add(RV, getContext().IntTy);
1531 return AddedStructorArgs::suffix(1);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001532}
1533
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001534void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1535 const CXXDestructorDecl *DD,
1536 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +00001537 bool Delegating, Address This) {
John McCallb92ab1a2016-10-26 23:46:34 +00001538 CGCallee Callee = CGCallee::forDirect(
1539 CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type)),
1540 DD);
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001541
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001542 if (DD->isVirtual()) {
1543 assert(Type != CXXDtorType::Dtor_Deleting &&
1544 "The deleting destructor should only be called via a virtual call");
1545 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1546 This, false);
1547 }
Erich Keane13c7ec52016-12-07 00:21:45 +00001548
1549 llvm::BasicBlock *BaseDtorEndBB = nullptr;
1550 if (ForVirtualBase && isa<CXXConstructorDecl>(CGF.CurCodeDecl)) {
1551 BaseDtorEndBB = EmitDtorCompleteObjectHandler(CGF);
1552 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001553
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001554 CGF.EmitCXXDestructorCall(DD, Callee, This.getPointer(),
1555 /*ImplicitParam=*/nullptr,
1556 /*ImplicitParamTy=*/QualType(), nullptr,
1557 getFromDtorType(Type));
Erich Keane13c7ec52016-12-07 00:21:45 +00001558 if (BaseDtorEndBB) {
1559 // Complete object handler should continue to be the remaining
1560 CGF.Builder.CreateBr(BaseDtorEndBB);
1561 CGF.EmitBlock(BaseDtorEndBB);
1562 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001563}
1564
Justin Lebar562914e2016-10-10 16:26:29 +00001565void MicrosoftCXXABI::emitVTableTypeMetadata(const VPtrInfo &Info,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001566 const CXXRecordDecl *RD,
1567 llvm::GlobalVariable *VTable) {
Peter Collingbourne1e1475a2017-01-18 23:55:27 +00001568 if (!CGM.getCodeGenOpts().LTOUnit)
Peter Collingbourned9546012015-06-19 02:30:43 +00001569 return;
1570
Peter Collingbournee5706442015-07-09 19:56:14 +00001571 // The location of the first virtual function pointer in the virtual table,
1572 // aka the "address point" on Itanium. This is at offset 0 if RTTI is
1573 // disabled, or sizeof(void*) if RTTI is enabled.
1574 CharUnits AddressPoint =
1575 getContext().getLangOpts().RTTIData
1576 ? getContext().toCharUnitsFromBits(
1577 getContext().getTargetInfo().getPointerWidth(0))
1578 : CharUnits::Zero();
Peter Collingbourned9546012015-06-19 02:30:43 +00001579
Justin Lebar562914e2016-10-10 16:26:29 +00001580 if (Info.PathToIntroducingObject.empty()) {
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001581 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001582 return;
1583 }
1584
1585 // Add a bitset entry for the least derived base belonging to this vftable.
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001586 CGM.AddVTableTypeMetadata(VTable, AddressPoint,
Justin Lebar562914e2016-10-10 16:26:29 +00001587 Info.PathToIntroducingObject.back());
Peter Collingbourned9546012015-06-19 02:30:43 +00001588
1589 // Add a bitset entry for each derived class that is laid out at the same
1590 // offset as the least derived base.
Justin Lebar562914e2016-10-10 16:26:29 +00001591 for (unsigned I = Info.PathToIntroducingObject.size() - 1; I != 0; --I) {
1592 const CXXRecordDecl *DerivedRD = Info.PathToIntroducingObject[I - 1];
1593 const CXXRecordDecl *BaseRD = Info.PathToIntroducingObject[I];
Peter Collingbourned9546012015-06-19 02:30:43 +00001594
1595 const ASTRecordLayout &Layout =
1596 getContext().getASTRecordLayout(DerivedRD);
1597 CharUnits Offset;
1598 auto VBI = Layout.getVBaseOffsetsMap().find(BaseRD);
1599 if (VBI == Layout.getVBaseOffsetsMap().end())
1600 Offset = Layout.getBaseClassOffset(BaseRD);
1601 else
1602 Offset = VBI->second.VBaseOffset;
1603 if (!Offset.isZero())
1604 return;
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001605 CGM.AddVTableTypeMetadata(VTable, AddressPoint, DerivedRD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001606 }
1607
1608 // Finally do the same for the most derived class.
Justin Lebar562914e2016-10-10 16:26:29 +00001609 if (Info.FullOffsetInMDC.isZero())
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001610 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001611}
1612
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001613void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1614 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001615 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001616 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001617
Justin Lebar562914e2016-10-10 16:26:29 +00001618 for (const std::unique_ptr<VPtrInfo>& Info : VFPtrs) {
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001619 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001620 if (VTable->hasInitializer())
1621 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001622
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001623 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001624 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
David Majnemer470ee612016-02-09 17:27:52 +00001625
1626 llvm::Constant *RTTI = nullptr;
1627 if (any_of(VTLayout.vtable_components(),
1628 [](const VTableComponent &VTC) { return VTC.isRTTIKind(); }))
Justin Lebar562914e2016-10-10 16:26:29 +00001629 RTTI = getMSCompleteObjectLocator(RD, *Info);
David Majnemer470ee612016-02-09 17:27:52 +00001630
John McCall9c6cb762016-11-28 22:18:33 +00001631 ConstantInitBuilder Builder(CGM);
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001632 auto Components = Builder.beginStruct();
John McCall9c6cb762016-11-28 22:18:33 +00001633 CGVT.createVTableInitializer(Components, VTLayout, RTTI);
1634 Components.finishAndSetAsInitializer(VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +00001635
Justin Lebar562914e2016-10-10 16:26:29 +00001636 emitVTableTypeMetadata(*Info, RD, VTable);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001637 }
1638}
1639
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001640bool MicrosoftCXXABI::isVirtualOffsetNeededForVTableField(
1641 CodeGenFunction &CGF, CodeGenFunction::VPtr Vptr) {
1642 return Vptr.NearestVBase != nullptr;
1643}
1644
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001645llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1646 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001647 const CXXRecordDecl *NearestVBase) {
1648 llvm::Constant *VTableAddressPoint = getVTableAddressPoint(Base, VTableClass);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001649 if (!VTableAddressPoint) {
1650 assert(Base.getBase()->getNumVBases() &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001651 !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001652 }
1653 return VTableAddressPoint;
1654}
1655
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001656static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Justin Lebar562914e2016-10-10 16:26:29 +00001657 const CXXRecordDecl *RD, const VPtrInfo &VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001658 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001659 llvm::raw_svector_ostream Out(Name);
Justin Lebar562914e2016-10-10 16:26:29 +00001660 MangleContext.mangleCXXVFTable(RD, VFPtr.MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001661}
1662
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001663llvm::Constant *
1664MicrosoftCXXABI::getVTableAddressPoint(BaseSubobject Base,
1665 const CXXRecordDecl *VTableClass) {
Piotr Padlewski4bed31b2015-09-10 20:18:30 +00001666 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1667 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001668 return VFTablesMap[ID];
1669}
1670
1671llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1672 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1673 llvm::Constant *VFTable = getVTableAddressPoint(Base, VTableClass);
David Majnemerd905da42014-07-01 20:30:31 +00001674 assert(VFTable && "Couldn't find a vftable for the given base?");
1675 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001676}
1677
1678llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1679 CharUnits VPtrOffset) {
1680 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1681 // shouldn't be used in the given record type. We want to cache this result in
1682 // VFTablesMap, thus a simple zero check is not sufficient.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001683
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001684 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001685 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001686 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001687 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001688 if (!Inserted)
1689 return I->second;
1690
1691 llvm::GlobalVariable *&VTable = I->second;
1692
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001693 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001694 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001695
David Blaikie82e95a32014-11-19 07:49:47 +00001696 if (DeferredVFTables.insert(RD).second) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001697 // We haven't processed this record type before.
Eric Christopherd160c502016-01-29 01:35:53 +00001698 // Queue up this vtable for possible deferred emission.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001699 CGM.addDeferredVTable(RD);
1700
1701#ifndef NDEBUG
1702 // Create all the vftables at once in order to make sure each vftable has
1703 // a unique mangled name.
1704 llvm::StringSet<> ObservedMangledNames;
1705 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1706 SmallString<256> Name;
Justin Lebar562914e2016-10-10 16:26:29 +00001707 mangleVFTableName(getMangleContext(), RD, *VFPtrs[J], Name);
David Blaikie61b86d42014-11-19 02:56:13 +00001708 if (!ObservedMangledNames.insert(Name.str()).second)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001709 llvm_unreachable("Already saw this mangling before?");
1710 }
1711#endif
1712 }
1713
Justin Lebar562914e2016-10-10 16:26:29 +00001714 const std::unique_ptr<VPtrInfo> *VFPtrI = std::find_if(
1715 VFPtrs.begin(), VFPtrs.end(), [&](const std::unique_ptr<VPtrInfo>& VPI) {
David Majnemera03849b2015-03-18 22:04:43 +00001716 return VPI->FullOffsetInMDC == VPtrOffset;
1717 });
1718 if (VFPtrI == VFPtrs.end()) {
1719 VFTablesMap[ID] = nullptr;
1720 return nullptr;
1721 }
Justin Lebar562914e2016-10-10 16:26:29 +00001722 const std::unique_ptr<VPtrInfo> &VFPtr = *VFPtrI;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001723
David Majnemera03849b2015-03-18 22:04:43 +00001724 SmallString<256> VFTableName;
Justin Lebar562914e2016-10-10 16:26:29 +00001725 mangleVFTableName(getMangleContext(), RD, *VFPtr, VFTableName);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001726
David Majnemer2d8b2002016-02-11 17:49:28 +00001727 // Classes marked __declspec(dllimport) need vftables generated on the
1728 // import-side in order to support features like constexpr. No other
1729 // translation unit relies on the emission of the local vftable, translation
1730 // units are expected to generate them as needed.
1731 //
1732 // Because of this unique behavior, we maintain this logic here instead of
1733 // getVTableLinkage.
1734 llvm::GlobalValue::LinkageTypes VFTableLinkage =
1735 RD->hasAttr<DLLImportAttr>() ? llvm::GlobalValue::LinkOnceODRLinkage
1736 : CGM.getVTableLinkage(RD);
David Majnemera03849b2015-03-18 22:04:43 +00001737 bool VFTableComesFromAnotherTU =
1738 llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) ||
1739 llvm::GlobalValue::isExternalLinkage(VFTableLinkage);
1740 bool VTableAliasIsRequred =
1741 !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData;
David Majnemerbb848712014-07-01 22:37:08 +00001742
David Majnemera03849b2015-03-18 22:04:43 +00001743 if (llvm::GlobalValue *VFTable =
1744 CGM.getModule().getNamedGlobal(VFTableName)) {
1745 VFTablesMap[ID] = VFTable;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001746 VTable = VTableAliasIsRequred
1747 ? cast<llvm::GlobalVariable>(
1748 cast<llvm::GlobalAlias>(VFTable)->getBaseObject())
1749 : cast<llvm::GlobalVariable>(VFTable);
1750 return VTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001751 }
1752
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001753 const VTableLayout &VTLayout =
1754 VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC);
David Majnemera03849b2015-03-18 22:04:43 +00001755 llvm::GlobalValue::LinkageTypes VTableLinkage =
1756 VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage;
1757
1758 StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str();
1759
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001760 llvm::Type *VTableType = CGM.getVTables().getVTableType(VTLayout);
David Majnemera03849b2015-03-18 22:04:43 +00001761
1762 // Create a backing variable for the contents of VTable. The VTable may
1763 // or may not include space for a pointer to RTTI data.
1764 llvm::GlobalValue *VFTable;
1765 VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType,
1766 /*isConstant=*/true, VTableLinkage,
1767 /*Initializer=*/nullptr, VTableName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001768 VTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001769
1770 llvm::Comdat *C = nullptr;
1771 if (!VFTableComesFromAnotherTU &&
1772 (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) ||
1773 (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) &&
1774 VTableAliasIsRequred)))
1775 C = CGM.getModule().getOrInsertComdat(VFTableName.str());
1776
1777 // Only insert a pointer into the VFTable for RTTI data if we are not
1778 // importing it. We never reference the RTTI data directly so there is no
1779 // need to make room for it.
1780 if (VTableAliasIsRequred) {
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001781 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.Int32Ty, 0),
1782 llvm::ConstantInt::get(CGM.Int32Ty, 0),
1783 llvm::ConstantInt::get(CGM.Int32Ty, 1)};
David Majnemera03849b2015-03-18 22:04:43 +00001784 // Create a GEP which points just after the first entry in the VFTable,
1785 // this should be the location of the first virtual method.
David Blaikiee3b172a2015-04-02 18:55:21 +00001786 llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr(
1787 VTable->getValueType(), VTable, GEPIndices);
David Majnemera03849b2015-03-18 22:04:43 +00001788 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) {
1789 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1790 if (C)
1791 C->setSelectionKind(llvm::Comdat::Largest);
1792 }
David Blaikie2a791d72015-09-14 18:38:22 +00001793 VFTable = llvm::GlobalAlias::create(CGM.Int8PtrTy,
1794 /*AddressSpace=*/0, VFTableLinkage,
1795 VFTableName.str(), VTableGEP,
1796 &CGM.getModule());
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001797 VFTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001798 } else {
1799 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1800 // be referencing any RTTI data.
1801 // The GlobalVariable will end up being an appropriate definition of the
1802 // VFTable.
1803 VFTable = VTable;
1804 }
1805 if (C)
1806 VTable->setComdat(C);
1807
David Majnemer2d8b2002016-02-11 17:49:28 +00001808 if (RD->hasAttr<DLLExportAttr>())
David Majnemera03849b2015-03-18 22:04:43 +00001809 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1810
1811 VFTablesMap[ID] = VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001812 return VTable;
1813}
1814
John McCallb92ab1a2016-10-26 23:46:34 +00001815CGCallee MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1816 GlobalDecl GD,
1817 Address This,
1818 llvm::Type *Ty,
1819 SourceLocation Loc) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001820 GD = GD.getCanonicalDecl();
1821 CGBuilderTy &Builder = CGF.Builder;
1822
1823 Ty = Ty->getPointerTo()->getPointerTo();
John McCall7f416cc2015-09-08 08:05:57 +00001824 Address VPtr =
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001825 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001826
1827 auto *MethodDecl = cast<CXXMethodDecl>(GD.getDecl());
1828 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty, MethodDecl->getParent());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001829
David Majnemer07c915e2016-10-27 17:11:51 +00001830 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001831 MicrosoftVTableContext::MethodVFTableLocation ML =
David Majnemer07c915e2016-10-27 17:11:51 +00001832 VFTContext.getMethodVFTableLocation(GD);
1833
1834 // Compute the identity of the most derived class whose virtual table is
1835 // located at the MethodVFTableLocation ML.
1836 auto getObjectWithVPtr = [&] {
1837 return llvm::find_if(VFTContext.getVFPtrOffsets(
1838 ML.VBase ? ML.VBase : MethodDecl->getParent()),
1839 [&](const std::unique_ptr<VPtrInfo> &Info) {
1840 return Info->FullOffsetInMDC == ML.VFPtrOffset;
1841 })
1842 ->get()
1843 ->ObjectWithVPtr;
1844 };
Peter Collingbourned9546012015-06-19 02:30:43 +00001845
John McCallb92ab1a2016-10-26 23:46:34 +00001846 llvm::Value *VFunc;
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001847 if (CGF.ShouldEmitVTableTypeCheckedLoad(MethodDecl->getParent())) {
John McCallb92ab1a2016-10-26 23:46:34 +00001848 VFunc = CGF.EmitVTableTypeCheckedLoad(
David Majnemer07c915e2016-10-27 17:11:51 +00001849 getObjectWithVPtr(), VTable,
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001850 ML.Index * CGM.getContext().getTargetInfo().getPointerWidth(0) / 8);
1851 } else {
1852 if (CGM.getCodeGenOpts().PrepareForLTO)
David Majnemer07c915e2016-10-27 17:11:51 +00001853 CGF.EmitTypeMetadataCodeForVCall(getObjectWithVPtr(), VTable, Loc);
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001854
1855 llvm::Value *VFuncPtr =
1856 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
John McCallb92ab1a2016-10-26 23:46:34 +00001857 VFunc = Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001858 }
John McCallb92ab1a2016-10-26 23:46:34 +00001859
1860 CGCallee Callee(MethodDecl, VFunc);
1861 return Callee;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001862}
1863
David Majnemer0c0b6d92014-10-31 20:09:12 +00001864llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1865 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +00001866 Address This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001867 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001868 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1869
1870 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001871 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001872 GlobalDecl GD(Dtor, Dtor_Deleting);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001873 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1874 Dtor, StructorType::Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001875 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
John McCallb92ab1a2016-10-26 23:46:34 +00001876 CGCallee Callee = getVirtualFunctionPointer(
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001877 CGF, GD, This, Ty, CE ? CE->getLocStart() : SourceLocation());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001878
David Majnemer9ced3dd2015-03-14 23:44:48 +00001879 ASTContext &Context = getContext();
Nico Weber0a029922015-01-12 21:24:10 +00001880 llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1881 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1882 DtorType == Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001883
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001884 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001885 RValue RV =
1886 CGF.EmitCXXDestructorCall(Dtor, Callee, This.getPointer(), ImplicitParam,
1887 Context.IntTy, CE, StructorType::Deleting);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001888 return RV.getScalarVal();
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001889}
1890
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001891const VBTableGlobals &
1892MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001893 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001894 // easier than caching each vbtable individually.
1895 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1896 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001897 std::tie(Entry, Added) =
1898 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001899 VBTableGlobals &VBGlobals = Entry->second;
1900 if (!Added)
1901 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001902
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001903 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1904 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001905
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001906 // Cache the globals for all vbtables so we don't have to recompute the
1907 // mangled names.
1908 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001909 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1910 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001911 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001912 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001913 }
1914
1915 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001916}
1917
Reid Klecknere4a52202014-02-21 02:27:32 +00001918llvm::Function *MicrosoftCXXABI::EmitVirtualMemPtrThunk(
1919 const CXXMethodDecl *MD,
1920 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001921 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1922 "can't form pointers to ctors or virtual dtors");
1923
Reid Klecknere4a52202014-02-21 02:27:32 +00001924 // Calculate the mangled name.
1925 SmallString<256> ThunkName;
1926 llvm::raw_svector_ostream Out(ThunkName);
1927 getMangleContext().mangleVirtualMemPtrThunk(MD, Out);
Reid Klecknere4a52202014-02-21 02:27:32 +00001928
Hans Wennborg88497d62013-11-15 17:24:45 +00001929 // If the thunk has been generated previously, just return it.
1930 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1931 return cast<llvm::Function>(GV);
1932
1933 // Create the llvm::Function.
Reid Klecknerc3473512014-08-29 21:43:29 +00001934 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSMemberPointerThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00001935 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1936 llvm::Function *ThunkFn =
1937 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1938 ThunkName.str(), &CGM.getModule());
1939 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1940
Hans Wennborg88497d62013-11-15 17:24:45 +00001941 ThunkFn->setLinkage(MD->isExternallyVisible()
1942 ? llvm::GlobalValue::LinkOnceODRLinkage
1943 : llvm::GlobalValue::InternalLinkage);
David Majnemer8c9cdb62015-01-21 01:21:31 +00001944 if (MD->isExternallyVisible())
1945 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
Hans Wennborg88497d62013-11-15 17:24:45 +00001946
1947 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1948 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1949
Reid Kleckner9da94482015-01-21 22:18:17 +00001950 // Add the "thunk" attribute so that LLVM knows that the return type is
1951 // meaningless. These thunks can be used to call functions with differing
1952 // return types, and the caller is required to cast the prototype
1953 // appropriately to extract the correct value.
1954 ThunkFn->addFnAttr("thunk");
1955
Reid Klecknerb9538a62014-08-15 18:12:40 +00001956 // These thunks can be compared, so they are not unnamed.
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001957 ThunkFn->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::None);
Reid Klecknerb9538a62014-08-15 18:12:40 +00001958
Hans Wennborg88497d62013-11-15 17:24:45 +00001959 // Start codegen.
1960 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00001961 CGF.CurGD = GlobalDecl(MD);
1962 CGF.CurFuncIsThunk = true;
1963
1964 // Build FunctionArgs, but only include the implicit 'this' parameter
1965 // declaration.
1966 FunctionArgList FunctionArgs;
1967 buildThisParam(CGF, FunctionArgs);
1968
1969 // Start defining the function.
1970 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
1971 FunctionArgs, MD->getLocation(), SourceLocation());
Reid Kleckner06239e42017-11-16 19:09:36 +00001972 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
Hans Wennborg88497d62013-11-15 17:24:45 +00001973
Reid Klecknere4a52202014-02-21 02:27:32 +00001974 // Load the vfptr and then callee from the vftable. The callee should have
1975 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00001976 llvm::Value *VTable = CGF.GetVTablePtr(
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001977 getThisAddress(CGF), ThunkTy->getPointerTo()->getPointerTo(), MD->getParent());
1978
Reid Klecknere4a52202014-02-21 02:27:32 +00001979 llvm::Value *VFuncPtr =
1980 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
John McCall7f416cc2015-09-08 08:05:57 +00001981 llvm::Value *Callee =
1982 CGF.Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
Hans Wennborg88497d62013-11-15 17:24:45 +00001983
Reid Klecknerc3473512014-08-29 21:43:29 +00001984 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee);
Hans Wennborg88497d62013-11-15 17:24:45 +00001985
1986 return ThunkFn;
1987}
1988
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001989void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001990 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1991 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00001992 const std::unique_ptr<VPtrInfo>& VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001993 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
David Majnemer129f4172015-02-02 10:22:20 +00001994 if (GV->isDeclaration())
1995 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00001996 }
1997}
1998
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001999llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002000MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002001 llvm::GlobalVariable::LinkageTypes Linkage) {
2002 SmallString<256> OutName;
2003 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00002004 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002005 StringRef Name = OutName.str();
2006
2007 llvm::ArrayType *VBTableType =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002008 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ObjectWithVPtr->getNumVBases());
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002009
2010 assert(!CGM.getModule().getNamedGlobal(Name) &&
2011 "vbtable with this name already exists: mangling bug?");
2012 llvm::GlobalVariable *GV =
2013 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00002014 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Hans Wennborg853ae942014-05-30 16:59:42 +00002015
2016 if (RD->hasAttr<DLLImportAttr>())
2017 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
2018 else if (RD->hasAttr<DLLExportAttr>())
2019 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
2020
David Majnemer129f4172015-02-02 10:22:20 +00002021 if (!GV->hasExternalLinkage())
2022 emitVBTableDefinition(VBT, RD, GV);
2023
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002024 return GV;
2025}
2026
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002027void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002028 const CXXRecordDecl *RD,
2029 llvm::GlobalVariable *GV) const {
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002030 const CXXRecordDecl *ObjectWithVPtr = VBT.ObjectWithVPtr;
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002031
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002032 assert(RD->getNumVBases() && ObjectWithVPtr->getNumVBases() &&
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002033 "should only emit vbtables for classes with vbtables");
2034
2035 const ASTRecordLayout &BaseLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002036 getContext().getASTRecordLayout(VBT.IntroducingObject);
David Majnemer9ced3dd2015-03-14 23:44:48 +00002037 const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002038
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002039 SmallVector<llvm::Constant *, 4> Offsets(1 + ObjectWithVPtr->getNumVBases(),
Craig Topper8a13c412014-05-21 05:09:00 +00002040 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002041
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002042 // The offset from ObjectWithVPtr's vbptr to itself always leads.
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002043 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
2044 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
2045
2046 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002047 for (const auto &I : ObjectWithVPtr->vbases()) {
Aaron Ballman445a9392014-03-13 16:15:17 +00002048 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002049 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
2050 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00002051
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002052 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00002053 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002054 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00002055 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002056 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00002057 Offset -= CompleteVBPtrOffset;
2058
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002059 unsigned VBIndex = Context.getVBTableIndex(ObjectWithVPtr, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00002060 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002061 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
2062 }
2063
2064 assert(Offsets.size() ==
2065 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
2066 ->getElementType())->getNumElements());
2067 llvm::ArrayType *VBTableType =
2068 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
2069 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
2070 GV->setInitializer(Init);
David Majnemer46e39cc2016-02-22 17:22:08 +00002071
2072 if (RD->hasAttr<DLLImportAttr>())
2073 GV->setLinkage(llvm::GlobalVariable::AvailableExternallyLinkage);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002074}
2075
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002076llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002077 Address This,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002078 const ThisAdjustment &TA) {
2079 if (TA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002080 return This.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002081
John McCall7f416cc2015-09-08 08:05:57 +00002082 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002083
John McCall7f416cc2015-09-08 08:05:57 +00002084 llvm::Value *V;
2085 if (TA.Virtual.isEmpty()) {
2086 V = This.getPointer();
2087 } else {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002088 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
2089 // Adjust the this argument based on the vtordisp value.
John McCall7f416cc2015-09-08 08:05:57 +00002090 Address VtorDispPtr =
2091 CGF.Builder.CreateConstInBoundsByteGEP(This,
2092 CharUnits::fromQuantity(TA.Virtual.Microsoft.VtordispOffset));
2093 VtorDispPtr = CGF.Builder.CreateElementBitCast(VtorDispPtr, CGF.Int32Ty);
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002094 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
John McCall7f416cc2015-09-08 08:05:57 +00002095 V = CGF.Builder.CreateGEP(This.getPointer(),
2096 CGF.Builder.CreateNeg(VtorDisp));
2097
2098 // Unfortunately, having applied the vtordisp means that we no
2099 // longer really have a known alignment for the vbptr step.
2100 // We'll assume the vbptr is pointer-aligned.
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002101
2102 if (TA.Virtual.Microsoft.VBPtrOffset) {
2103 // If the final overrider is defined in a virtual base other than the one
2104 // that holds the vfptr, we have to use a vtordispex thunk which looks up
2105 // the vbtable of the derived class.
2106 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
2107 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
2108 llvm::Value *VBPtr;
2109 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002110 GetVBaseOffsetFromVBPtr(CGF, Address(V, CGF.getPointerAlign()),
2111 -TA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002112 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
2113 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2114 }
2115 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002116
2117 if (TA.NonVirtual) {
2118 // Non-virtual adjustment might result in a pointer outside the allocated
2119 // object, e.g. if the final overrider class is laid out after the virtual
2120 // base that declares a method in the most derived class.
2121 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
2122 }
2123
2124 // Don't need to bitcast back, the call CodeGen will handle this.
2125 return V;
2126}
2127
2128llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00002129MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002130 const ReturnAdjustment &RA) {
2131 if (RA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002132 return Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002133
John McCall7f416cc2015-09-08 08:05:57 +00002134 auto OrigTy = Ret.getType();
2135 Ret = CGF.Builder.CreateElementBitCast(Ret, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002136
John McCall7f416cc2015-09-08 08:05:57 +00002137 llvm::Value *V = Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002138 if (RA.Virtual.Microsoft.VBIndex) {
2139 assert(RA.Virtual.Microsoft.VBIndex > 0);
John McCall7f416cc2015-09-08 08:05:57 +00002140 int32_t IntSize = CGF.getIntSize().getQuantity();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002141 llvm::Value *VBPtr;
2142 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002143 GetVBaseOffsetFromVBPtr(CGF, Ret, RA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002144 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
2145 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2146 }
2147
2148 if (RA.NonVirtual)
David Blaikiefb901c7a2015-04-04 15:12:29 +00002149 V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002150
2151 // Cast back to the original type.
John McCall7f416cc2015-09-08 08:05:57 +00002152 return CGF.Builder.CreateBitCast(V, OrigTy);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002153}
2154
John McCallb91cd662012-05-01 05:23:51 +00002155bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
2156 QualType elementType) {
2157 // Microsoft seems to completely ignore the possibility of a
2158 // two-argument usual deallocation function.
2159 return elementType.isDestructedType();
2160}
2161
2162bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
2163 // Microsoft seems to completely ignore the possibility of a
2164 // two-argument usual deallocation function.
2165 return expr->getAllocatedType().isDestructedType();
2166}
2167
2168CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
2169 // The array cookie is always a size_t; we then pad that out to the
2170 // alignment of the element type.
2171 ASTContext &Ctx = getContext();
2172 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
2173 Ctx.getTypeAlignInChars(type));
2174}
2175
2176llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002177 Address allocPtr,
John McCallb91cd662012-05-01 05:23:51 +00002178 CharUnits cookieSize) {
John McCall7f416cc2015-09-08 08:05:57 +00002179 Address numElementsPtr =
2180 CGF.Builder.CreateElementBitCast(allocPtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002181 return CGF.Builder.CreateLoad(numElementsPtr);
2182}
2183
John McCall7f416cc2015-09-08 08:05:57 +00002184Address MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
2185 Address newPtr,
2186 llvm::Value *numElements,
2187 const CXXNewExpr *expr,
2188 QualType elementType) {
John McCallb91cd662012-05-01 05:23:51 +00002189 assert(requiresArrayCookie(expr));
2190
2191 // The size of the cookie.
2192 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
2193
2194 // Compute an offset to the cookie.
John McCall7f416cc2015-09-08 08:05:57 +00002195 Address cookiePtr = newPtr;
John McCallb91cd662012-05-01 05:23:51 +00002196
2197 // Write the number of elements into the appropriate slot.
John McCall7f416cc2015-09-08 08:05:57 +00002198 Address numElementsPtr
2199 = CGF.Builder.CreateElementBitCast(cookiePtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002200 CGF.Builder.CreateStore(numElements, numElementsPtr);
2201
2202 // Finally, compute a pointer to the actual data buffer by skipping
2203 // over the cookie completely.
John McCall7f416cc2015-09-08 08:05:57 +00002204 return CGF.Builder.CreateConstInBoundsByteGEP(newPtr, cookieSize);
John McCallb91cd662012-05-01 05:23:51 +00002205}
2206
David Majnemerb3341ea2014-10-05 05:05:40 +00002207static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
2208 llvm::Constant *Dtor,
2209 llvm::Constant *Addr) {
2210 // Create a function which calls the destructor.
2211 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
2212
2213 // extern "C" int __tlregdtor(void (*f)(void));
2214 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
2215 CGF.IntTy, DtorStub->getType(), /*IsVarArg=*/false);
2216
Reid Klecknerde864822017-03-21 16:57:30 +00002217 llvm::Constant *TLRegDtor = CGF.CGM.CreateRuntimeFunction(
2218 TLRegDtorTy, "__tlregdtor", llvm::AttributeList(), /*Local=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002219 if (llvm::Function *TLRegDtorFn = dyn_cast<llvm::Function>(TLRegDtor))
2220 TLRegDtorFn->setDoesNotThrow();
2221
2222 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
2223}
2224
2225void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
2226 llvm::Constant *Dtor,
2227 llvm::Constant *Addr) {
2228 if (D.getTLSKind())
2229 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
2230
2231 // The default behavior is to use atexit.
2232 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
2233}
2234
2235void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +00002236 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +00002237 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +00002238 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) {
David Majnemercb60a432016-09-12 02:51:43 +00002239 if (CXXThreadLocalInits.empty())
2240 return;
2241
2242 CGM.AppendLinkerOptions(CGM.getTarget().getTriple().getArch() ==
2243 llvm::Triple::x86
2244 ? "/include:___dyn_tls_init@12"
2245 : "/include:__dyn_tls_init");
2246
David Majnemerb3341ea2014-10-05 05:05:40 +00002247 // This will create a GV in the .CRT$XDU section. It will point to our
2248 // initialization function. The CRT will call all of these function
2249 // pointers at start-up time and, eventually, at thread-creation time.
2250 auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
2251 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
2252 CGM.getModule(), InitFunc->getType(), /*IsConstant=*/true,
2253 llvm::GlobalVariable::InternalLinkage, InitFunc,
2254 Twine(InitFunc->getName(), "$initializer$"));
2255 InitFuncPtr->setSection(".CRT$XDU");
2256 // This variable has discardable linkage, we have to add it to @llvm.used to
2257 // ensure it won't get discarded.
2258 CGM.addUsedGlobal(InitFuncPtr);
2259 return InitFuncPtr;
2260 };
2261
2262 std::vector<llvm::Function *> NonComdatInits;
2263 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
Richard Smith5a99c492015-12-01 01:10:48 +00002264 llvm::GlobalVariable *GV = cast<llvm::GlobalVariable>(
2265 CGM.GetGlobalValue(CGM.getMangledName(CXXThreadLocalInitVars[I])));
David Majnemerb3341ea2014-10-05 05:05:40 +00002266 llvm::Function *F = CXXThreadLocalInits[I];
2267
2268 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002269 if (llvm::Comdat *C = GV->getComdat())
David Majnemerb3341ea2014-10-05 05:05:40 +00002270 AddToXDU(F)->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002271 else
David Majnemerb3341ea2014-10-05 05:05:40 +00002272 NonComdatInits.push_back(F);
David Majnemerb3341ea2014-10-05 05:05:40 +00002273 }
2274
2275 if (!NonComdatInits.empty()) {
2276 llvm::FunctionType *FTy =
2277 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002278 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +00002279 FTy, "__tls_init", CGM.getTypes().arrangeNullaryFunction(),
2280 SourceLocation(), /*TLS=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002281 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2282
2283 AddToXDU(InitFunc);
2284 }
2285}
2286
2287LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2288 const VarDecl *VD,
2289 QualType LValType) {
2290 CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2291 return LValue();
2292}
2293
John McCall7f416cc2015-09-08 08:05:57 +00002294static ConstantAddress getInitThreadEpochPtr(CodeGenModule &CGM) {
David Majnemer8354eee2015-05-07 06:15:46 +00002295 StringRef VarName("_Init_thread_epoch");
John McCall7f416cc2015-09-08 08:05:57 +00002296 CharUnits Align = CGM.getIntAlign();
David Majnemer8354eee2015-05-07 06:15:46 +00002297 if (auto *GV = CGM.getModule().getNamedGlobal(VarName))
John McCall7f416cc2015-09-08 08:05:57 +00002298 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002299 auto *GV = new llvm::GlobalVariable(
2300 CGM.getModule(), CGM.IntTy,
2301 /*Constant=*/false, llvm::GlobalVariable::ExternalLinkage,
2302 /*Initializer=*/nullptr, VarName,
2303 /*InsertBefore=*/nullptr, llvm::GlobalVariable::GeneralDynamicTLSModel);
John McCall7f416cc2015-09-08 08:05:57 +00002304 GV->setAlignment(Align.getQuantity());
2305 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002306}
2307
2308static llvm::Constant *getInitThreadHeaderFn(CodeGenModule &CGM) {
2309 llvm::FunctionType *FTy =
2310 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2311 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2312 return CGM.CreateRuntimeFunction(
2313 FTy, "_Init_thread_header",
Reid Klecknerde864822017-03-21 16:57:30 +00002314 llvm::AttributeList::get(CGM.getLLVMContext(),
2315 llvm::AttributeList::FunctionIndex,
2316 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002317 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002318}
2319
2320static llvm::Constant *getInitThreadFooterFn(CodeGenModule &CGM) {
2321 llvm::FunctionType *FTy =
2322 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2323 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2324 return CGM.CreateRuntimeFunction(
2325 FTy, "_Init_thread_footer",
Reid Klecknerde864822017-03-21 16:57:30 +00002326 llvm::AttributeList::get(CGM.getLLVMContext(),
2327 llvm::AttributeList::FunctionIndex,
2328 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002329 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002330}
2331
2332static llvm::Constant *getInitThreadAbortFn(CodeGenModule &CGM) {
2333 llvm::FunctionType *FTy =
2334 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2335 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2336 return CGM.CreateRuntimeFunction(
2337 FTy, "_Init_thread_abort",
Reid Klecknerde864822017-03-21 16:57:30 +00002338 llvm::AttributeList::get(CGM.getLLVMContext(),
2339 llvm::AttributeList::FunctionIndex,
2340 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002341 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002342}
2343
2344namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002345struct ResetGuardBit final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002346 Address Guard;
David Majnemer8354eee2015-05-07 06:15:46 +00002347 unsigned GuardNum;
John McCall7f416cc2015-09-08 08:05:57 +00002348 ResetGuardBit(Address Guard, unsigned GuardNum)
David Majnemer8354eee2015-05-07 06:15:46 +00002349 : Guard(Guard), GuardNum(GuardNum) {}
2350
2351 void Emit(CodeGenFunction &CGF, Flags flags) override {
2352 // Reset the bit in the mask so that the static variable may be
2353 // reinitialized.
2354 CGBuilderTy &Builder = CGF.Builder;
2355 llvm::LoadInst *LI = Builder.CreateLoad(Guard);
2356 llvm::ConstantInt *Mask =
Reid Klecknerd16cebe2016-02-10 19:09:15 +00002357 llvm::ConstantInt::get(CGF.IntTy, ~(1ULL << GuardNum));
David Majnemer8354eee2015-05-07 06:15:46 +00002358 Builder.CreateStore(Builder.CreateAnd(LI, Mask), Guard);
2359 }
2360};
2361
David Blaikie7e70d682015-08-18 22:40:54 +00002362struct CallInitThreadAbort final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002363 llvm::Value *Guard;
2364 CallInitThreadAbort(Address Guard) : Guard(Guard.getPointer()) {}
David Majnemer8354eee2015-05-07 06:15:46 +00002365
2366 void Emit(CodeGenFunction &CGF, Flags flags) override {
2367 // Calling _Init_thread_abort will reset the guard's state.
2368 CGF.EmitNounwindRuntimeCall(getInitThreadAbortFn(CGF.CGM), Guard);
2369 }
2370};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002371}
David Majnemer8354eee2015-05-07 06:15:46 +00002372
John McCallc84ed6a2012-05-01 06:13:13 +00002373void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00002374 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00002375 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00002376 // MSVC only uses guards for static locals.
2377 if (!D.isStaticLocal()) {
2378 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2379 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
Rafael Espindola77abc3a2015-01-16 16:04:45 +00002380 llvm::Function *F = CGF.CurFn;
2381 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2382 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
Reid Kleckner563f0e82014-05-23 21:13:45 +00002383 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2384 return;
2385 }
2386
David Majnemerec8e54b2015-05-07 21:19:06 +00002387 bool ThreadlocalStatic = D.getTLSKind();
2388 bool ThreadsafeStatic = getContext().getLangOpts().ThreadsafeStatics;
2389
2390 // Thread-safe static variables which aren't thread-specific have a
2391 // per-variable guard.
2392 bool HasPerVariableGuard = ThreadsafeStatic && !ThreadlocalStatic;
Richard Smithdbf74ba2013-04-14 23:01:42 +00002393
Reid Klecknerd8110b62013-09-10 20:14:30 +00002394 CGBuilderTy &Builder = CGF.Builder;
2395 llvm::IntegerType *GuardTy = CGF.Int32Ty;
2396 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
John McCall7f416cc2015-09-08 08:05:57 +00002397 CharUnits GuardAlign = CharUnits::fromQuantity(4);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002398
2399 // Get the guard variable for this function if we have one already.
David Majnemerec8e54b2015-05-07 21:19:06 +00002400 GuardInfo *GI = nullptr;
2401 if (ThreadlocalStatic)
2402 GI = &ThreadLocalGuardVariableMap[D.getDeclContext()];
2403 else if (!ThreadsafeStatic)
2404 GI = &GuardVariableMap[D.getDeclContext()];
2405
2406 llvm::GlobalVariable *GuardVar = GI ? GI->Guard : nullptr;
David Majnemer8354eee2015-05-07 06:15:46 +00002407 unsigned GuardNum;
David Majnemerec8e54b2015-05-07 21:19:06 +00002408 if (D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002409 // Externally visible variables have to be numbered in Sema to properly
2410 // handle unreachable VarDecls.
David Majnemer8354eee2015-05-07 06:15:46 +00002411 GuardNum = getContext().getStaticLocalNumber(&D);
2412 assert(GuardNum > 0);
2413 GuardNum--;
2414 } else if (HasPerVariableGuard) {
2415 GuardNum = ThreadSafeGuardNumMap[D.getDeclContext()]++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002416 } else {
2417 // Non-externally visible variables are numbered here in CodeGen.
David Majnemer8354eee2015-05-07 06:15:46 +00002418 GuardNum = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002419 }
2420
David Majnemer8354eee2015-05-07 06:15:46 +00002421 if (!HasPerVariableGuard && GuardNum >= 32) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002422 if (D.isExternallyVisible())
2423 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
David Majnemer8354eee2015-05-07 06:15:46 +00002424 GuardNum %= 32;
2425 GuardVar = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002426 }
2427
David Majnemer8354eee2015-05-07 06:15:46 +00002428 if (!GuardVar) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002429 // Mangle the name for the guard.
2430 SmallString<256> GuardName;
2431 {
2432 llvm::raw_svector_ostream Out(GuardName);
David Majnemer8354eee2015-05-07 06:15:46 +00002433 if (HasPerVariableGuard)
2434 getMangleContext().mangleThreadSafeStaticGuardVariable(&D, GuardNum,
2435 Out);
2436 else
2437 getMangleContext().mangleStaticGuardVariable(&D, Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002438 }
2439
Hans Wennborgef2272c2014-06-18 15:55:13 +00002440 // Create the guard variable with a zero-initializer. Just absorb linkage,
2441 // visibility and dll storage class from the guarded variable.
David Majnemer8354eee2015-05-07 06:15:46 +00002442 GuardVar =
2443 new llvm::GlobalVariable(CGM.getModule(), GuardTy, /*isConstant=*/false,
Reid Klecknere9591b32014-04-23 18:22:11 +00002444 GV->getLinkage(), Zero, GuardName.str());
David Majnemer8354eee2015-05-07 06:15:46 +00002445 GuardVar->setVisibility(GV->getVisibility());
2446 GuardVar->setDLLStorageClass(GV->getDLLStorageClass());
John McCall7f416cc2015-09-08 08:05:57 +00002447 GuardVar->setAlignment(GuardAlign.getQuantity());
David Majnemer8354eee2015-05-07 06:15:46 +00002448 if (GuardVar->isWeakForLinker())
2449 GuardVar->setComdat(
2450 CGM.getModule().getOrInsertComdat(GuardVar->getName()));
2451 if (D.getTLSKind())
2452 GuardVar->setThreadLocal(true);
2453 if (GI && !HasPerVariableGuard)
2454 GI->Guard = GuardVar;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002455 }
2456
John McCall7f416cc2015-09-08 08:05:57 +00002457 ConstantAddress GuardAddr(GuardVar, GuardAlign);
2458
David Majnemer8354eee2015-05-07 06:15:46 +00002459 assert(GuardVar->getLinkage() == GV->getLinkage() &&
2460 "static local from the same function had different linkage");
Reid Klecknerd8110b62013-09-10 20:14:30 +00002461
David Majnemer8354eee2015-05-07 06:15:46 +00002462 if (!HasPerVariableGuard) {
2463 // Pseudo code for the test:
2464 // if (!(GuardVar & MyGuardBit)) {
2465 // GuardVar |= MyGuardBit;
2466 // ... initialize the object ...;
2467 // }
Reid Klecknerd8110b62013-09-10 20:14:30 +00002468
David Majnemer8354eee2015-05-07 06:15:46 +00002469 // Test our bit from the guard variable.
Aaron Ballmanabd466e2016-03-30 21:33:34 +00002470 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1ULL << GuardNum);
John McCall7f416cc2015-09-08 08:05:57 +00002471 llvm::LoadInst *LI = Builder.CreateLoad(GuardAddr);
Richard Smithae8d62c2017-07-26 22:01:09 +00002472 llvm::Value *NeedsInit =
2473 Builder.CreateICmpEQ(Builder.CreateAnd(LI, Bit), Zero);
David Majnemer8354eee2015-05-07 06:15:46 +00002474 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2475 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002476 CGF.EmitCXXGuardedInitBranch(NeedsInit, InitBlock, EndBlock,
2477 CodeGenFunction::GuardKind::VariableGuard, &D);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002478
David Majnemer8354eee2015-05-07 06:15:46 +00002479 // Set our bit in the guard variable and emit the initializer and add a global
2480 // destructor if appropriate.
2481 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002482 Builder.CreateStore(Builder.CreateOr(LI, Bit), GuardAddr);
2483 CGF.EHStack.pushCleanup<ResetGuardBit>(EHCleanup, GuardAddr, GuardNum);
David Majnemer8354eee2015-05-07 06:15:46 +00002484 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2485 CGF.PopCleanupBlock();
2486 Builder.CreateBr(EndBlock);
2487
2488 // Continue.
2489 CGF.EmitBlock(EndBlock);
2490 } else {
2491 // Pseudo code for the test:
2492 // if (TSS > _Init_thread_epoch) {
2493 // _Init_thread_header(&TSS);
2494 // if (TSS == -1) {
2495 // ... initialize the object ...;
2496 // _Init_thread_footer(&TSS);
2497 // }
2498 // }
2499 //
2500 // The algorithm is almost identical to what can be found in the appendix
2501 // found in N2325.
2502
David Majnemer8354eee2015-05-07 06:15:46 +00002503 // This BasicBLock determines whether or not we have any work to do.
John McCall7f416cc2015-09-08 08:05:57 +00002504 llvm::LoadInst *FirstGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002505 FirstGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2506 llvm::LoadInst *InitThreadEpoch =
2507 Builder.CreateLoad(getInitThreadEpochPtr(CGM));
2508 llvm::Value *IsUninitialized =
2509 Builder.CreateICmpSGT(FirstGuardLoad, InitThreadEpoch);
2510 llvm::BasicBlock *AttemptInitBlock = CGF.createBasicBlock("init.attempt");
2511 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002512 CGF.EmitCXXGuardedInitBranch(IsUninitialized, AttemptInitBlock, EndBlock,
2513 CodeGenFunction::GuardKind::VariableGuard, &D);
David Majnemer8354eee2015-05-07 06:15:46 +00002514
2515 // This BasicBlock attempts to determine whether or not this thread is
2516 // responsible for doing the initialization.
2517 CGF.EmitBlock(AttemptInitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002518 CGF.EmitNounwindRuntimeCall(getInitThreadHeaderFn(CGM),
2519 GuardAddr.getPointer());
2520 llvm::LoadInst *SecondGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002521 SecondGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2522 llvm::Value *ShouldDoInit =
2523 Builder.CreateICmpEQ(SecondGuardLoad, getAllOnesInt());
2524 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2525 Builder.CreateCondBr(ShouldDoInit, InitBlock, EndBlock);
2526
2527 // Ok, we ended up getting selected as the initializing thread.
2528 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002529 CGF.EHStack.pushCleanup<CallInitThreadAbort>(EHCleanup, GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002530 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2531 CGF.PopCleanupBlock();
John McCall7f416cc2015-09-08 08:05:57 +00002532 CGF.EmitNounwindRuntimeCall(getInitThreadFooterFn(CGM),
2533 GuardAddr.getPointer());
David Majnemer8354eee2015-05-07 06:15:46 +00002534 Builder.CreateBr(EndBlock);
2535
2536 CGF.EmitBlock(EndBlock);
2537 }
John McCallc84ed6a2012-05-01 06:13:13 +00002538}
2539
Reid Kleckner2341ae32013-04-11 18:13:19 +00002540bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2541 // Null-ness for function memptrs only depends on the first field, which is
2542 // the function pointer. The rest don't matter, so we can zero initialize.
2543 if (MPT->isMemberFunctionPointer())
2544 return true;
2545
2546 // The virtual base adjustment field is always -1 for null, so if we have one
2547 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
2548 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002549 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2550 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002551 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
2552 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00002553}
2554
2555llvm::Type *
2556MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002557 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2558 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002559 llvm::SmallVector<llvm::Type *, 4> fields;
2560 if (MPT->isMemberFunctionPointer())
2561 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
2562 else
2563 fields.push_back(CGM.IntTy); // FieldOffset
2564
Reid Kleckner96f8f932014-02-05 17:27:08 +00002565 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2566 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002567 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002568 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002569 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002570 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002571 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
2572
2573 if (fields.size() == 1)
2574 return fields[0];
2575 return llvm::StructType::get(CGM.getLLVMContext(), fields);
2576}
2577
2578void MicrosoftCXXABI::
2579GetNullMemberPointerFields(const MemberPointerType *MPT,
2580 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2581 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00002582 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2583 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002584 if (MPT->isMemberFunctionPointer()) {
2585 // FunctionPointerOrVirtualThunk
2586 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2587 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00002588 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00002589 fields.push_back(getZeroInt()); // FieldOffset
2590 else
2591 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00002592 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00002593
Reid Kleckner96f8f932014-02-05 17:27:08 +00002594 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2595 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002596 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002597 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002598 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002599 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002600 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002601}
2602
2603llvm::Constant *
2604MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002605 llvm::SmallVector<llvm::Constant *, 4> fields;
2606 GetNullMemberPointerFields(MPT, fields);
2607 if (fields.size() == 1)
2608 return fields[0];
2609 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2610 assert(Res->getType() == ConvertMemberPointerType(MPT));
2611 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002612}
2613
2614llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002615MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2616 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00002617 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +00002618 CharUnits NonVirtualBaseAdjustment,
2619 unsigned VBTableIndex) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002620 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002621
2622 // Single inheritance class member pointer are represented as scalars instead
2623 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002624 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002625 return FirstField;
2626
Reid Kleckner2341ae32013-04-11 18:13:19 +00002627 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002628 fields.push_back(FirstField);
2629
Reid Kleckner96f8f932014-02-05 17:27:08 +00002630 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002631 fields.push_back(llvm::ConstantInt::get(
2632 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002633
Reid Kleckner96f8f932014-02-05 17:27:08 +00002634 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00002635 CharUnits Offs = CharUnits::Zero();
David Majnemerc1709d32015-06-23 07:31:11 +00002636 if (VBTableIndex)
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002637 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00002638 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00002639 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002640
2641 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002642 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
David Majnemere60813f2015-05-10 21:48:08 +00002643 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, VBTableIndex));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002644
Reid Kleckner2341ae32013-04-11 18:13:19 +00002645 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002646}
2647
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002648llvm::Constant *
2649MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2650 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002651 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerc1709d32015-06-23 07:31:11 +00002652 if (RD->getMSInheritanceModel() ==
2653 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002654 offset -= getContext().getOffsetOfBaseWithVBPtr(RD);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002655 llvm::Constant *FirstField =
2656 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00002657 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002658 CharUnits::Zero(), /*VBTableIndex=*/0);
Reid Kleckner452abac2013-05-09 21:01:17 +00002659}
2660
Reid Kleckner452abac2013-05-09 21:01:17 +00002661llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2662 QualType MPType) {
David Majnemer5ca193c2015-06-23 07:31:07 +00002663 const MemberPointerType *DstTy = MPType->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002664 const ValueDecl *MPD = MP.getMemberPointerDecl();
2665 if (!MPD)
David Majnemer5ca193c2015-06-23 07:31:07 +00002666 return EmitNullMemberPointer(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002667
David Majnemer5ca193c2015-06-23 07:31:07 +00002668 ASTContext &Ctx = getContext();
2669 ArrayRef<const CXXRecordDecl *> MemberPointerPath = MP.getMemberPointerPath();
Reid Kleckner452abac2013-05-09 21:01:17 +00002670
David Majnemer5ca193c2015-06-23 07:31:07 +00002671 llvm::Constant *C;
2672 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) {
2673 C = EmitMemberFunctionPointer(MD);
2674 } else {
2675 CharUnits FieldOffset = Ctx.toCharUnitsFromBits(Ctx.getFieldOffset(MPD));
2676 C = EmitMemberDataPointer(DstTy, FieldOffset);
2677 }
Reid Kleckner452abac2013-05-09 21:01:17 +00002678
David Majnemer5ca193c2015-06-23 07:31:07 +00002679 if (!MemberPointerPath.empty()) {
2680 const CXXRecordDecl *SrcRD = cast<CXXRecordDecl>(MPD->getDeclContext());
2681 const Type *SrcRecTy = Ctx.getTypeDeclType(SrcRD).getTypePtr();
2682 const MemberPointerType *SrcTy =
2683 Ctx.getMemberPointerType(DstTy->getPointeeType(), SrcRecTy)
2684 ->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002685
David Majnemer5ca193c2015-06-23 07:31:07 +00002686 bool DerivedMember = MP.isMemberPointerToDerivedMember();
2687 SmallVector<const CXXBaseSpecifier *, 4> DerivedToBasePath;
2688 const CXXRecordDecl *PrevRD = SrcRD;
2689 for (const CXXRecordDecl *PathElem : MemberPointerPath) {
2690 const CXXRecordDecl *Base = nullptr;
2691 const CXXRecordDecl *Derived = nullptr;
2692 if (DerivedMember) {
2693 Base = PathElem;
2694 Derived = PrevRD;
2695 } else {
2696 Base = PrevRD;
2697 Derived = PathElem;
2698 }
2699 for (const CXXBaseSpecifier &BS : Derived->bases())
2700 if (BS.getType()->getAsCXXRecordDecl()->getCanonicalDecl() ==
2701 Base->getCanonicalDecl())
2702 DerivedToBasePath.push_back(&BS);
2703 PrevRD = PathElem;
2704 }
2705 assert(DerivedToBasePath.size() == MemberPointerPath.size());
2706
2707 CastKind CK = DerivedMember ? CK_DerivedToBaseMemberPointer
2708 : CK_BaseToDerivedMemberPointer;
2709 C = EmitMemberPointerConversion(SrcTy, DstTy, CK, DerivedToBasePath.begin(),
2710 DerivedToBasePath.end(), C);
2711 }
2712 return C;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002713}
2714
2715llvm::Constant *
David Majnemer5ca193c2015-06-23 07:31:07 +00002716MicrosoftCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002717 assert(MD->isInstance() && "Member function must not be static!");
David Majnemer5ca193c2015-06-23 07:31:07 +00002718
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002719 MD = MD->getCanonicalDecl();
David Majnemer5ca193c2015-06-23 07:31:07 +00002720 CharUnits NonVirtualBaseAdjustment = CharUnits::Zero();
2721 const CXXRecordDecl *RD = MD->getParent()->getMostRecentDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002722 CodeGenTypes &Types = CGM.getTypes();
2723
David Majnemere60813f2015-05-10 21:48:08 +00002724 unsigned VBTableIndex = 0;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002725 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00002726 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00002727 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002728 llvm::Type *Ty;
2729 // Check whether the function has a computable LLVM signature.
2730 if (Types.isFuncTypeConvertible(FPT)) {
2731 // The function has a computable LLVM signature; use the correct type.
2732 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2733 } else {
2734 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2735 // function type is incomplete.
2736 Ty = CGM.PtrDiffTy;
2737 }
2738 FirstField = CGM.GetAddrOfFunction(MD, Ty);
Hans Wennborg88497d62013-11-15 17:24:45 +00002739 } else {
David Majnemere0e228a2015-06-11 08:12:44 +00002740 auto &VTableContext = CGM.getMicrosoftVTableContext();
2741 MicrosoftVTableContext::MethodVFTableLocation ML =
2742 VTableContext.getMethodVFTableLocation(MD);
David Majnemerc1709d32015-06-23 07:31:11 +00002743 FirstField = EmitVirtualMemPtrThunk(MD, ML);
David Majnemere0e228a2015-06-11 08:12:44 +00002744 // Include the vfptr adjustment if the method is in a non-primary vftable.
2745 NonVirtualBaseAdjustment += ML.VFPtrOffset;
2746 if (ML.VBase)
2747 VBTableIndex = VTableContext.getVBTableIndex(RD, ML.VBase) * 4;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002748 }
2749
David Majnemerc1709d32015-06-23 07:31:11 +00002750 if (VBTableIndex == 0 &&
2751 RD->getMSInheritanceModel() ==
2752 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002753 NonVirtualBaseAdjustment -= getContext().getOffsetOfBaseWithVBPtr(RD);
David Majnemerc1709d32015-06-23 07:31:11 +00002754
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002755 // The rest of the fields are common with data member pointers.
David Majnemerc1709d32015-06-23 07:31:11 +00002756 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002757 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002758 NonVirtualBaseAdjustment, VBTableIndex);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002759}
2760
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002761/// Member pointers are the same if they're either bitwise identical *or* both
2762/// null. Null-ness for function members is determined by the first field,
2763/// while for data member pointers we must compare all fields.
2764llvm::Value *
2765MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2766 llvm::Value *L,
2767 llvm::Value *R,
2768 const MemberPointerType *MPT,
2769 bool Inequality) {
2770 CGBuilderTy &Builder = CGF.Builder;
2771
2772 // Handle != comparisons by switching the sense of all boolean operations.
2773 llvm::ICmpInst::Predicate Eq;
2774 llvm::Instruction::BinaryOps And, Or;
2775 if (Inequality) {
2776 Eq = llvm::ICmpInst::ICMP_NE;
2777 And = llvm::Instruction::Or;
2778 Or = llvm::Instruction::And;
2779 } else {
2780 Eq = llvm::ICmpInst::ICMP_EQ;
2781 And = llvm::Instruction::And;
2782 Or = llvm::Instruction::Or;
2783 }
2784
2785 // If this is a single field member pointer (single inheritance), this is a
2786 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002787 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2788 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002789 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2790 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002791 return Builder.CreateICmp(Eq, L, R);
2792
2793 // Compare the first field.
2794 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2795 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2796 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2797
2798 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002799 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002800 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2801 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2802 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2803 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2804 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2805 if (Res)
2806 Res = Builder.CreateBinOp(And, Res, Cmp);
2807 else
2808 Res = Cmp;
2809 }
2810
2811 // Check if the first field is 0 if this is a function pointer.
2812 if (MPT->isMemberFunctionPointer()) {
2813 // (l1 == r1 && ...) || l0 == 0
2814 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2815 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2816 Res = Builder.CreateBinOp(Or, Res, IsZero);
2817 }
2818
2819 // Combine the comparison of the first field, which must always be true for
2820 // this comparison to succeeed.
2821 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2822}
2823
Reid Kleckner407e8b62013-03-22 19:02:54 +00002824llvm::Value *
2825MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2826 llvm::Value *MemPtr,
2827 const MemberPointerType *MPT) {
2828 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002829 llvm::SmallVector<llvm::Constant *, 4> fields;
2830 // We only need one field for member functions.
2831 if (MPT->isMemberFunctionPointer())
2832 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2833 else
2834 GetNullMemberPointerFields(MPT, fields);
2835 assert(!fields.empty());
2836 llvm::Value *FirstField = MemPtr;
2837 if (MemPtr->getType()->isStructTy())
2838 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2839 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002840
Reid Kleckner2341ae32013-04-11 18:13:19 +00002841 // For function member pointers, we only need to test the function pointer
2842 // field. The other fields if any can be garbage.
2843 if (MPT->isMemberFunctionPointer())
2844 return Res;
2845
2846 // Otherwise, emit a series of compares and combine the results.
2847 for (int I = 1, E = fields.size(); I < E; ++I) {
2848 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2849 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002850 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002851 }
2852 return Res;
2853}
2854
Reid Kleckner452abac2013-05-09 21:01:17 +00002855bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2856 llvm::Constant *Val) {
2857 // Function pointers are null if the pointer in the first field is null.
2858 if (MPT->isMemberFunctionPointer()) {
2859 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2860 Val->getAggregateElement(0U) : Val;
2861 return FirstField->isNullValue();
2862 }
2863
2864 // If it's not a function pointer and it's zero initializable, we can easily
2865 // check zero.
2866 if (isZeroInitializable(MPT) && Val->isNullValue())
2867 return true;
2868
2869 // Otherwise, break down all the fields for comparison. Hopefully these
2870 // little Constants are reused, while a big null struct might not be.
2871 llvm::SmallVector<llvm::Constant *, 4> Fields;
2872 GetNullMemberPointerFields(MPT, Fields);
2873 if (Fields.size() == 1) {
2874 assert(Val->getType()->isIntegerTy());
2875 return Val == Fields[0];
2876 }
2877
2878 unsigned I, E;
2879 for (I = 0, E = Fields.size(); I != E; ++I) {
2880 if (Val->getAggregateElement(I) != Fields[I])
2881 break;
2882 }
2883 return I == E;
2884}
2885
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002886llvm::Value *
2887MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002888 Address This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002889 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002890 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002891 llvm::Value **VBPtrOut) {
2892 CGBuilderTy &Builder = CGF.Builder;
2893 // Load the vbtable pointer from the vbptr in the instance.
John McCall7f416cc2015-09-08 08:05:57 +00002894 This = Builder.CreateElementBitCast(This, CGM.Int8Ty);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002895 llvm::Value *VBPtr =
John McCall7f416cc2015-09-08 08:05:57 +00002896 Builder.CreateInBoundsGEP(This.getPointer(), VBPtrOffset, "vbptr");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002897 if (VBPtrOut) *VBPtrOut = VBPtr;
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002898 VBPtr = Builder.CreateBitCast(VBPtr,
John McCall7f416cc2015-09-08 08:05:57 +00002899 CGM.Int32Ty->getPointerTo(0)->getPointerTo(This.getAddressSpace()));
2900
2901 CharUnits VBPtrAlign;
2902 if (auto CI = dyn_cast<llvm::ConstantInt>(VBPtrOffset)) {
2903 VBPtrAlign = This.getAlignment().alignmentAtOffset(
2904 CharUnits::fromQuantity(CI->getSExtValue()));
2905 } else {
2906 VBPtrAlign = CGF.getPointerAlign();
2907 }
2908
2909 llvm::Value *VBTable = Builder.CreateAlignedLoad(VBPtr, VBPtrAlign, "vbtable");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002910
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002911 // Translate from byte offset to table index. It improves analyzability.
2912 llvm::Value *VBTableIndex = Builder.CreateAShr(
2913 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
2914 "vbtindex", /*isExact=*/true);
2915
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002916 // Load an i32 offset from the vb-table.
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002917 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002918 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
John McCall7f416cc2015-09-08 08:05:57 +00002919 return Builder.CreateAlignedLoad(VBaseOffs, CharUnits::fromQuantity(4),
2920 "vbase_offs");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002921}
2922
Reid Kleckner2341ae32013-04-11 18:13:19 +00002923// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2924// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002925llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2926 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
John McCall7f416cc2015-09-08 08:05:57 +00002927 Address Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002928 CGBuilderTy &Builder = CGF.Builder;
John McCall7f416cc2015-09-08 08:05:57 +00002929 Base = Builder.CreateElementBitCast(Base, CGM.Int8Ty);
Craig Topper8a13c412014-05-21 05:09:00 +00002930 llvm::BasicBlock *OriginalBB = nullptr;
2931 llvm::BasicBlock *SkipAdjustBB = nullptr;
2932 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002933
2934 // In the unspecified inheritance model, there might not be a vbtable at all,
2935 // in which case we need to skip the virtual base lookup. If there is a
2936 // vbtable, the first entry is a no-op entry that gives back the original
2937 // base, so look for a virtual base adjustment offset of zero.
2938 if (VBPtrOffset) {
2939 OriginalBB = Builder.GetInsertBlock();
2940 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2941 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2942 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002943 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002944 "memptr.is_vbase");
2945 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2946 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002947 }
2948
Reid Kleckner2341ae32013-04-11 18:13:19 +00002949 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
2950 // know the vbptr offset.
2951 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002952 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00002953 if (!RD->hasDefinition()) {
2954 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
2955 unsigned DiagID = Diags.getCustomDiagID(
2956 DiagnosticsEngine::Error,
2957 "member pointer representation requires a "
2958 "complete class type for %0 to perform this expression");
2959 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
2960 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002961 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002962 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
2963 }
Craig Topper8a13c412014-05-21 05:09:00 +00002964 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002965 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002966 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002967 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
2968
2969 // Merge control flow with the case where we didn't have to adjust.
2970 if (VBaseAdjustBB) {
2971 Builder.CreateBr(SkipAdjustBB);
2972 CGF.EmitBlock(SkipAdjustBB);
2973 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
John McCall7f416cc2015-09-08 08:05:57 +00002974 Phi->addIncoming(Base.getPointer(), OriginalBB);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002975 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
2976 return Phi;
2977 }
2978 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002979}
2980
David Majnemer2b0d66d2014-02-20 23:22:07 +00002981llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
John McCall7f416cc2015-09-08 08:05:57 +00002982 CodeGenFunction &CGF, const Expr *E, Address Base, llvm::Value *MemPtr,
David Majnemer2b0d66d2014-02-20 23:22:07 +00002983 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002984 assert(MPT->isMemberDataPointer());
John McCall7f416cc2015-09-08 08:05:57 +00002985 unsigned AS = Base.getAddressSpace();
Reid Kleckner407e8b62013-03-22 19:02:54 +00002986 llvm::Type *PType =
2987 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
2988 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002989 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2990 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00002991
Reid Kleckner2341ae32013-04-11 18:13:19 +00002992 // Extract the fields we need, regardless of model. We'll apply them if we
2993 // have them.
2994 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002995 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2996 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002997 if (MemPtr->getType()->isStructTy()) {
2998 // We need to extract values.
2999 unsigned I = 0;
3000 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003001 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003002 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003003 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003004 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00003005 }
3006
John McCall7f416cc2015-09-08 08:05:57 +00003007 llvm::Value *Addr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003008 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003009 Addr = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00003010 VBPtrOffset);
John McCall7f416cc2015-09-08 08:05:57 +00003011 } else {
3012 Addr = Base.getPointer();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003013 }
Reid Klecknerae945122013-12-05 22:44:07 +00003014
3015 // Cast to char*.
John McCall7f416cc2015-09-08 08:05:57 +00003016 Addr = Builder.CreateBitCast(Addr, CGF.Int8Ty->getPointerTo(AS));
Reid Klecknerae945122013-12-05 22:44:07 +00003017
3018 // Apply the offset, which we assume is non-null.
John McCall7f416cc2015-09-08 08:05:57 +00003019 Addr = Builder.CreateInBoundsGEP(Addr, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00003020
3021 // Cast the address to the appropriate pointer type, adopting the address
3022 // space of the base pointer.
3023 return Builder.CreateBitCast(Addr, PType);
3024}
3025
Reid Kleckner452abac2013-05-09 21:01:17 +00003026llvm::Value *
3027MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
3028 const CastExpr *E,
3029 llvm::Value *Src) {
3030 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
3031 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
3032 E->getCastKind() == CK_ReinterpretMemberPointer);
3033
3034 // Use constant emission if we can.
3035 if (isa<llvm::Constant>(Src))
3036 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
3037
3038 // We may be adding or dropping fields from the member pointer, so we need
3039 // both types and the inheritance models of both records.
3040 const MemberPointerType *SrcTy =
3041 E->getSubExpr()->getType()->castAs<MemberPointerType>();
3042 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003043 bool IsFunc = SrcTy->isMemberFunctionPointer();
3044
3045 // If the classes use the same null representation, reinterpret_cast is a nop.
3046 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003047 if (IsReinterpret && IsFunc)
3048 return Src;
3049
3050 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3051 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3052 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00003053 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00003054 return Src;
3055
3056 CGBuilderTy &Builder = CGF.Builder;
3057
3058 // Branch past the conversion if Src is null.
3059 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
3060 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
3061
3062 // C++ 5.2.10p9: The null member pointer value is converted to the null member
3063 // pointer value of the destination type.
3064 if (IsReinterpret) {
3065 // For reinterpret casts, sema ensures that src and dst are both functions
3066 // or data and have the same size, which means the LLVM types should match.
3067 assert(Src->getType() == DstNull->getType());
3068 return Builder.CreateSelect(IsNotNull, Src, DstNull);
3069 }
3070
3071 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
3072 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
3073 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
3074 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
3075 CGF.EmitBlock(ConvertBB);
3076
David Majnemer0d9ad682015-06-29 00:06:50 +00003077 llvm::Value *Dst = EmitNonNullMemberPointerConversion(
3078 SrcTy, DstTy, E->getCastKind(), E->path_begin(), E->path_end(), Src,
3079 Builder);
3080
3081 Builder.CreateBr(ContinueBB);
3082
3083 // In the continuation, choose between DstNull and Dst.
3084 CGF.EmitBlock(ContinueBB);
3085 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
3086 Phi->addIncoming(DstNull, OriginalBB);
3087 Phi->addIncoming(Dst, ConvertBB);
3088 return Phi;
3089}
3090
3091llvm::Value *MicrosoftCXXABI::EmitNonNullMemberPointerConversion(
3092 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3093 CastExpr::path_const_iterator PathBegin,
3094 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
3095 CGBuilderTy &Builder) {
3096 const CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3097 const CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3098 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
3099 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
3100 bool IsFunc = SrcTy->isMemberFunctionPointer();
3101 bool IsConstant = isa<llvm::Constant>(Src);
3102
Reid Kleckner452abac2013-05-09 21:01:17 +00003103 // Decompose src.
3104 llvm::Value *FirstField = Src;
David Majnemerc1709d32015-06-23 07:31:11 +00003105 llvm::Value *NonVirtualBaseAdjustment = getZeroInt();
3106 llvm::Value *VirtualBaseAdjustmentOffset = getZeroInt();
3107 llvm::Value *VBPtrOffset = getZeroInt();
Reid Kleckner96f8f932014-02-05 17:27:08 +00003108 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003109 // We need to extract values.
3110 unsigned I = 0;
3111 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003112 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003113 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003114 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003115 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003116 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003117 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
3118 }
3119
David Majnemer0d9ad682015-06-29 00:06:50 +00003120 bool IsDerivedToBase = (CK == CK_DerivedToBaseMemberPointer);
David Majnemerc1709d32015-06-23 07:31:11 +00003121 const MemberPointerType *DerivedTy = IsDerivedToBase ? SrcTy : DstTy;
3122 const CXXRecordDecl *DerivedClass = DerivedTy->getMostRecentCXXRecordDecl();
3123
Reid Kleckner452abac2013-05-09 21:01:17 +00003124 // For data pointers, we adjust the field offset directly. For functions, we
3125 // have a separate field.
David Majnemerc1709d32015-06-23 07:31:11 +00003126 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
3127
3128 // The virtual inheritance model has a quirk: the virtual base table is always
3129 // referenced when dereferencing a member pointer even if the member pointer
3130 // is non-virtual. This is accounted for by adjusting the non-virtual offset
3131 // to point backwards to the top of the MDC from the first VBase. Undo this
3132 // adjustment to normalize the member pointer.
3133 llvm::Value *SrcVBIndexEqZero =
3134 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3135 if (SrcInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3136 if (int64_t SrcOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003137 getContext().getOffsetOfBaseWithVBPtr(SrcRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003138 llvm::Value *UndoSrcAdjustment = Builder.CreateSelect(
3139 SrcVBIndexEqZero,
3140 llvm::ConstantInt::get(CGM.IntTy, SrcOffsetToFirstVBase),
3141 getZeroInt());
3142 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, UndoSrcAdjustment);
3143 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003144 }
3145
David Majnemerc1709d32015-06-23 07:31:11 +00003146 // A non-zero vbindex implies that we are dealing with a source member in a
3147 // floating virtual base in addition to some non-virtual offset. If the
3148 // vbindex is zero, we are dealing with a source that exists in a non-virtual,
3149 // fixed, base. The difference between these two cases is that the vbindex +
3150 // nvoffset *always* point to the member regardless of what context they are
3151 // evaluated in so long as the vbindex is adjusted. A member inside a fixed
3152 // base requires explicit nv adjustment.
3153 llvm::Constant *BaseClassOffset = llvm::ConstantInt::get(
David Majnemer0d9ad682015-06-29 00:06:50 +00003154 CGM.IntTy,
3155 CGM.computeNonVirtualBaseClassOffset(DerivedClass, PathBegin, PathEnd)
3156 .getQuantity());
David Majnemerc1709d32015-06-23 07:31:11 +00003157
3158 llvm::Value *NVDisp;
3159 if (IsDerivedToBase)
3160 NVDisp = Builder.CreateNSWSub(NVAdjustField, BaseClassOffset, "adj");
3161 else
3162 NVDisp = Builder.CreateNSWAdd(NVAdjustField, BaseClassOffset, "adj");
3163
3164 NVAdjustField = Builder.CreateSelect(SrcVBIndexEqZero, NVDisp, getZeroInt());
3165
3166 // Update the vbindex to an appropriate value in the destination because
3167 // SrcRD's vbtable might not be a strict prefix of the one in DstRD.
3168 llvm::Value *DstVBIndexEqZero = SrcVBIndexEqZero;
3169 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance) &&
3170 MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance)) {
3171 if (llvm::GlobalVariable *VDispMap =
3172 getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) {
3173 llvm::Value *VBIndex = Builder.CreateExactUDiv(
3174 VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003175 if (IsConstant) {
3176 llvm::Constant *Mapping = VDispMap->getInitializer();
3177 VirtualBaseAdjustmentOffset =
3178 Mapping->getAggregateElement(cast<llvm::Constant>(VBIndex));
3179 } else {
3180 llvm::Value *Idxs[] = {getZeroInt(), VBIndex};
3181 VirtualBaseAdjustmentOffset =
John McCall7f416cc2015-09-08 08:05:57 +00003182 Builder.CreateAlignedLoad(Builder.CreateInBoundsGEP(VDispMap, Idxs),
3183 CharUnits::fromQuantity(4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003184 }
David Majnemerc1709d32015-06-23 07:31:11 +00003185
3186 DstVBIndexEqZero =
3187 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3188 }
3189 }
3190
3191 // Set the VBPtrOffset to zero if the vbindex is zero. Otherwise, initialize
3192 // it to the offset of the vbptr.
3193 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance)) {
3194 llvm::Value *DstVBPtrOffset = llvm::ConstantInt::get(
3195 CGM.IntTy,
3196 getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity());
3197 VBPtrOffset =
3198 Builder.CreateSelect(DstVBIndexEqZero, getZeroInt(), DstVBPtrOffset);
3199 }
3200
3201 // Likewise, apply a similar adjustment so that dereferencing the member
3202 // pointer correctly accounts for the distance between the start of the first
3203 // virtual base and the top of the MDC.
3204 if (DstInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3205 if (int64_t DstOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003206 getContext().getOffsetOfBaseWithVBPtr(DstRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003207 llvm::Value *DoDstAdjustment = Builder.CreateSelect(
3208 DstVBIndexEqZero,
3209 llvm::ConstantInt::get(CGM.IntTy, DstOffsetToFirstVBase),
3210 getZeroInt());
3211 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, DoDstAdjustment);
3212 }
3213 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003214
3215 // Recompose dst from the null struct and the adjusted fields from src.
3216 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00003217 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003218 Dst = FirstField;
3219 } else {
David Majnemer0d9ad682015-06-29 00:06:50 +00003220 Dst = llvm::UndefValue::get(ConvertMemberPointerType(DstTy));
Reid Kleckner452abac2013-05-09 21:01:17 +00003221 unsigned Idx = 0;
3222 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003223 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003224 Dst = Builder.CreateInsertValue(Dst, NonVirtualBaseAdjustment, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003225 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003226 Dst = Builder.CreateInsertValue(Dst, VBPtrOffset, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003227 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003228 Dst = Builder.CreateInsertValue(Dst, VirtualBaseAdjustmentOffset, Idx++);
Reid Kleckner452abac2013-05-09 21:01:17 +00003229 }
David Majnemer0d9ad682015-06-29 00:06:50 +00003230 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003231}
3232
3233llvm::Constant *
3234MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
3235 llvm::Constant *Src) {
3236 const MemberPointerType *SrcTy =
David Majnemer5ca193c2015-06-23 07:31:07 +00003237 E->getSubExpr()->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003238 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3239
David Majnemer5ca193c2015-06-23 07:31:07 +00003240 CastKind CK = E->getCastKind();
3241
3242 return EmitMemberPointerConversion(SrcTy, DstTy, CK, E->path_begin(),
3243 E->path_end(), Src);
3244}
3245
3246llvm::Constant *MicrosoftCXXABI::EmitMemberPointerConversion(
3247 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3248 CastExpr::path_const_iterator PathBegin,
3249 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src) {
3250 assert(CK == CK_DerivedToBaseMemberPointer ||
3251 CK == CK_BaseToDerivedMemberPointer ||
3252 CK == CK_ReinterpretMemberPointer);
Reid Kleckner452abac2013-05-09 21:01:17 +00003253 // If src is null, emit a new null for dst. We can't return src because dst
3254 // might have a new representation.
3255 if (MemberPointerConstantIsNull(SrcTy, Src))
3256 return EmitNullMemberPointer(DstTy);
3257
3258 // We don't need to do anything for reinterpret_casts of non-null member
3259 // pointers. We should only get here when the two type representations have
3260 // the same size.
David Majnemer5ca193c2015-06-23 07:31:07 +00003261 if (CK == CK_ReinterpretMemberPointer)
Reid Kleckner452abac2013-05-09 21:01:17 +00003262 return Src;
3263
John McCall7f416cc2015-09-08 08:05:57 +00003264 CGBuilderTy Builder(CGM, CGM.getLLVMContext());
David Majnemer0d9ad682015-06-29 00:06:50 +00003265 auto *Dst = cast<llvm::Constant>(EmitNonNullMemberPointerConversion(
3266 SrcTy, DstTy, CK, PathBegin, PathEnd, Src, Builder));
Reid Kleckner452abac2013-05-09 21:01:17 +00003267
David Majnemer0d9ad682015-06-29 00:06:50 +00003268 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003269}
3270
John McCallb92ab1a2016-10-26 23:46:34 +00003271CGCallee MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
John McCall7f416cc2015-09-08 08:05:57 +00003272 CodeGenFunction &CGF, const Expr *E, Address This,
3273 llvm::Value *&ThisPtrForCall, llvm::Value *MemPtr,
3274 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003275 assert(MPT->isMemberFunctionPointer());
3276 const FunctionProtoType *FPT =
3277 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00003278 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003279 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(
3280 CGM.getTypes().arrangeCXXMethodType(RD, FPT, /*FD=*/nullptr));
Reid Kleckner2341ae32013-04-11 18:13:19 +00003281 CGBuilderTy &Builder = CGF.Builder;
3282
David Majnemer1cdd96d2014-01-17 09:01:00 +00003283 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003284
3285 // Extract the fields we need, regardless of model. We'll apply them if we
3286 // have them.
3287 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003288 llvm::Value *NonVirtualBaseAdjustment = nullptr;
3289 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3290 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003291 if (MemPtr->getType()->isStructTy()) {
3292 // We need to extract values.
3293 unsigned I = 0;
3294 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003295 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003296 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003297 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00003298 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003299 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003300 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3301 }
3302
3303 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003304 ThisPtrForCall = AdjustVirtualBase(CGF, E, RD, This,
3305 VirtualBaseAdjustmentOffset, VBPtrOffset);
3306 } else {
3307 ThisPtrForCall = This.getPointer();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003308 }
3309
3310 if (NonVirtualBaseAdjustment) {
3311 // Apply the adjustment and cast back to the original struct type.
John McCall7f416cc2015-09-08 08:05:57 +00003312 llvm::Value *Ptr = Builder.CreateBitCast(ThisPtrForCall, CGF.Int8PtrTy);
Reid Kleckner2341ae32013-04-11 18:13:19 +00003313 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
John McCall7f416cc2015-09-08 08:05:57 +00003314 ThisPtrForCall = Builder.CreateBitCast(Ptr, ThisPtrForCall->getType(),
3315 "this.adjusted");
Reid Kleckner2341ae32013-04-11 18:13:19 +00003316 }
3317
John McCallb92ab1a2016-10-26 23:46:34 +00003318 FunctionPointer =
3319 Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
3320 CGCallee Callee(FPT, FunctionPointer);
3321 return Callee;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003322}
3323
Charles Davis53c59df2010-08-16 03:33:14 +00003324CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00003325 return new MicrosoftCXXABI(CGM);
3326}
David Majnemere2cb8d12014-07-07 06:20:47 +00003327
3328// MS RTTI Overview:
3329// The run time type information emitted by cl.exe contains 5 distinct types of
3330// structures. Many of them reference each other.
3331//
3332// TypeInfo: Static classes that are returned by typeid.
3333//
3334// CompleteObjectLocator: Referenced by vftables. They contain information
3335// required for dynamic casting, including OffsetFromTop. They also contain
3336// a reference to the TypeInfo for the type and a reference to the
3337// CompleteHierarchyDescriptor for the type.
3338//
3339// ClassHieararchyDescriptor: Contains information about a class hierarchy.
3340// Used during dynamic_cast to walk a class hierarchy. References a base
3341// class array and the size of said array.
3342//
3343// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
3344// somewhat of a misnomer because the most derived class is also in the list
3345// as well as multiple copies of virtual bases (if they occur multiple times
3346// in the hiearchy.) The BaseClassArray contains one BaseClassDescriptor for
3347// every path in the hierarchy, in pre-order depth first order. Note, we do
3348// not declare a specific llvm type for BaseClassArray, it's merely an array
3349// of BaseClassDescriptor pointers.
3350//
3351// BaseClassDescriptor: Contains information about a class in a class hierarchy.
3352// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
3353// BaseClassArray is. It contains information about a class within a
3354// hierarchy such as: is this base is ambiguous and what is its offset in the
3355// vbtable. The names of the BaseClassDescriptors have all of their fields
3356// mangled into them so they can be aggressively deduplicated by the linker.
3357
David Majnemere2cb8d12014-07-07 06:20:47 +00003358static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
3359 StringRef MangledName("\01??_7type_info@@6B@");
3360 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
3361 return VTable;
3362 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
3363 /*Constant=*/true,
3364 llvm::GlobalVariable::ExternalLinkage,
3365 /*Initializer=*/nullptr, MangledName);
3366}
3367
3368namespace {
3369
3370/// \brief A Helper struct that stores information about a class in a class
3371/// hierarchy. The information stored in these structs struct is used during
3372/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
3373// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
3374// implicit depth first pre-order tree connectivity. getFirstChild and
3375// getNextSibling allow us to walk the tree efficiently.
3376struct MSRTTIClass {
3377 enum {
3378 IsPrivateOnPath = 1 | 8,
3379 IsAmbiguous = 2,
3380 IsPrivate = 4,
3381 IsVirtual = 16,
3382 HasHierarchyDescriptor = 64
3383 };
3384 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
3385 uint32_t initialize(const MSRTTIClass *Parent,
3386 const CXXBaseSpecifier *Specifier);
3387
3388 MSRTTIClass *getFirstChild() { return this + 1; }
3389 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
3390 return Child + 1 + Child->NumBases;
3391 }
3392
3393 const CXXRecordDecl *RD, *VirtualRoot;
3394 uint32_t Flags, NumBases, OffsetInVBase;
3395};
3396
3397/// \brief Recursively initialize the base class array.
3398uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
3399 const CXXBaseSpecifier *Specifier) {
3400 Flags = HasHierarchyDescriptor;
3401 if (!Parent) {
3402 VirtualRoot = nullptr;
3403 OffsetInVBase = 0;
3404 } else {
3405 if (Specifier->getAccessSpecifier() != AS_public)
3406 Flags |= IsPrivate | IsPrivateOnPath;
3407 if (Specifier->isVirtual()) {
3408 Flags |= IsVirtual;
3409 VirtualRoot = RD;
3410 OffsetInVBase = 0;
3411 } else {
3412 if (Parent->Flags & IsPrivateOnPath)
3413 Flags |= IsPrivateOnPath;
3414 VirtualRoot = Parent->VirtualRoot;
3415 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
3416 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
3417 }
3418 }
3419 NumBases = 0;
3420 MSRTTIClass *Child = getFirstChild();
3421 for (const CXXBaseSpecifier &Base : RD->bases()) {
3422 NumBases += Child->initialize(this, &Base) + 1;
3423 Child = getNextChild(Child);
3424 }
3425 return NumBases;
3426}
3427
3428static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
3429 switch (Ty->getLinkage()) {
3430 case NoLinkage:
3431 case InternalLinkage:
3432 case UniqueExternalLinkage:
3433 return llvm::GlobalValue::InternalLinkage;
3434
3435 case VisibleNoLinkage:
Richard Smith1283e982017-07-07 20:04:28 +00003436 case ModuleInternalLinkage:
3437 case ModuleLinkage:
David Majnemere2cb8d12014-07-07 06:20:47 +00003438 case ExternalLinkage:
3439 return llvm::GlobalValue::LinkOnceODRLinkage;
3440 }
3441 llvm_unreachable("Invalid linkage!");
3442}
3443
3444/// \brief An ephemeral helper class for building MS RTTI types. It caches some
3445/// calls to the module and information about the most derived class in a
3446/// hierarchy.
3447struct MSRTTIBuilder {
3448 enum {
3449 HasBranchingHierarchy = 1,
3450 HasVirtualBranchingHierarchy = 2,
3451 HasAmbiguousBases = 4
3452 };
3453
David Majnemer611cdb92014-07-07 08:09:15 +00003454 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
3455 : CGM(ABI.CGM), Context(CGM.getContext()),
3456 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00003457 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003458 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00003459
3460 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
3461 llvm::GlobalVariable *
3462 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
3463 llvm::GlobalVariable *getClassHierarchyDescriptor();
Justin Lebar562914e2016-10-10 16:26:29 +00003464 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo &Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003465
3466 CodeGenModule &CGM;
3467 ASTContext &Context;
3468 llvm::LLVMContext &VMContext;
3469 llvm::Module &Module;
3470 const CXXRecordDecl *RD;
3471 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00003472 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00003473};
3474
3475} // namespace
3476
3477/// \brief Recursively serializes a class hierarchy in pre-order depth first
3478/// order.
3479static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
3480 const CXXRecordDecl *RD) {
3481 Classes.push_back(MSRTTIClass(RD));
3482 for (const CXXBaseSpecifier &Base : RD->bases())
3483 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
3484}
3485
3486/// \brief Find ambiguity among base classes.
3487static void
3488detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
3489 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
3490 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
3491 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
3492 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
3493 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
David Blaikie82e95a32014-11-19 07:49:47 +00003494 !VirtualBases.insert(Class->RD).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003495 Class = MSRTTIClass::getNextChild(Class);
3496 continue;
3497 }
David Blaikie82e95a32014-11-19 07:49:47 +00003498 if (!UniqueBases.insert(Class->RD).second)
David Majnemere2cb8d12014-07-07 06:20:47 +00003499 AmbiguousBases.insert(Class->RD);
3500 Class++;
3501 }
3502 if (AmbiguousBases.empty())
3503 return;
3504 for (MSRTTIClass &Class : Classes)
3505 if (AmbiguousBases.count(Class.RD))
3506 Class.Flags |= MSRTTIClass::IsAmbiguous;
3507}
3508
3509llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
3510 SmallString<256> MangledName;
3511 {
3512 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003513 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003514 }
3515
3516 // Check to see if we've already declared this ClassHierarchyDescriptor.
3517 if (auto CHD = Module.getNamedGlobal(MangledName))
3518 return CHD;
3519
3520 // Serialize the class hierarchy and initialize the CHD Fields.
3521 SmallVector<MSRTTIClass, 8> Classes;
3522 serializeClassHierarchy(Classes, RD);
3523 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3524 detectAmbiguousBases(Classes);
3525 int Flags = 0;
3526 for (auto Class : Classes) {
3527 if (Class.RD->getNumBases() > 1)
3528 Flags |= HasBranchingHierarchy;
3529 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
3530 // believe the field isn't actually used.
3531 if (Class.Flags & MSRTTIClass::IsAmbiguous)
3532 Flags |= HasAmbiguousBases;
3533 }
3534 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
3535 Flags |= HasVirtualBranchingHierarchy;
3536 // These gep indices are used to get the address of the first element of the
3537 // base class array.
3538 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
3539 llvm::ConstantInt::get(CGM.IntTy, 0)};
3540
3541 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00003542 auto Type = ABI.getClassHierarchyDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003543 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3544 /*Initializer=*/nullptr,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003545 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003546 if (CHD->isWeakForLinker())
3547 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003548
David Blaikiee3b172a2015-04-02 18:55:21 +00003549 auto *Bases = getBaseClassArray(Classes);
3550
David Majnemere2cb8d12014-07-07 06:20:47 +00003551 // Initialize the base class ClassHierarchyDescriptor.
3552 llvm::Constant *Fields[] = {
Saleem Abdulrasoola9e14502017-01-01 19:16:02 +00003553 llvm::ConstantInt::get(CGM.IntTy, 0), // reserved by the runtime
David Majnemer611cdb92014-07-07 08:09:15 +00003554 llvm::ConstantInt::get(CGM.IntTy, Flags),
3555 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
3556 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00003557 Bases->getValueType(), Bases,
David Majnemer611cdb92014-07-07 08:09:15 +00003558 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00003559 };
3560 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3561 return CHD;
3562}
3563
3564llvm::GlobalVariable *
3565MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3566 SmallString<256> MangledName;
3567 {
3568 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003569 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003570 }
3571
3572 // Forward-declare the base class array.
3573 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3574 // mode) bytes of padding. We provide a pointer sized amount of padding by
3575 // adding +1 to Classes.size(). The sections have pointer alignment and are
3576 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00003577 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00003578 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00003579 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
David Majnemer7c237072015-03-05 00:46:22 +00003580 auto *BCA =
3581 new llvm::GlobalVariable(Module, ArrType,
3582 /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003583 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003584 if (BCA->isWeakForLinker())
3585 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003586
3587 // Initialize the BaseClassArray.
3588 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3589 for (MSRTTIClass &Class : Classes)
3590 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00003591 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00003592 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00003593 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00003594 return BCA;
3595}
3596
3597llvm::GlobalVariable *
3598MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3599 // Compute the fields for the BaseClassDescriptor. They are computed up front
3600 // because they are mangled into the name of the object.
3601 uint32_t OffsetInVBTable = 0;
3602 int32_t VBPtrOffset = -1;
3603 if (Class.VirtualRoot) {
3604 auto &VTableContext = CGM.getMicrosoftVTableContext();
3605 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3606 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3607 }
3608
3609 SmallString<256> MangledName;
3610 {
3611 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003612 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3613 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3614 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003615 }
3616
David Majnemer26a90f82014-07-07 15:29:10 +00003617 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00003618 if (auto BCD = Module.getNamedGlobal(MangledName))
3619 return BCD;
3620
3621 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00003622 auto Type = ABI.getBaseClassDescriptorType();
David Majnemer7c237072015-03-05 00:46:22 +00003623 auto BCD =
3624 new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003625 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003626 if (BCD->isWeakForLinker())
3627 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003628
3629 // Initialize the BaseClassDescriptor.
3630 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003631 ABI.getImageRelativeConstant(
David Majnemer443250f2015-03-17 20:35:00 +00003632 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003633 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3634 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3635 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3636 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3637 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3638 ABI.getImageRelativeConstant(
3639 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00003640 };
3641 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3642 return BCD;
3643}
3644
3645llvm::GlobalVariable *
Justin Lebar562914e2016-10-10 16:26:29 +00003646MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo &Info) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003647 SmallString<256> MangledName;
3648 {
3649 llvm::raw_svector_ostream Out(MangledName);
Justin Lebar562914e2016-10-10 16:26:29 +00003650 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info.MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003651 }
3652
3653 // Check to see if we've already computed this complete object locator.
3654 if (auto COL = Module.getNamedGlobal(MangledName))
3655 return COL;
3656
3657 // Compute the fields of the complete object locator.
Justin Lebar562914e2016-10-10 16:26:29 +00003658 int OffsetToTop = Info.FullOffsetInMDC.getQuantity();
David Majnemere2cb8d12014-07-07 06:20:47 +00003659 int VFPtrOffset = 0;
3660 // The offset includes the vtordisp if one exists.
Justin Lebar562914e2016-10-10 16:26:29 +00003661 if (const CXXRecordDecl *VBase = Info.getVBaseWithVPtr())
David Majnemere2cb8d12014-07-07 06:20:47 +00003662 if (Context.getASTRecordLayout(RD)
3663 .getVBaseOffsetsMap()
3664 .find(VBase)
3665 ->second.hasVtorDisp())
Justin Lebar562914e2016-10-10 16:26:29 +00003666 VFPtrOffset = Info.NonVirtualOffset.getQuantity() + 4;
David Majnemere2cb8d12014-07-07 06:20:47 +00003667
3668 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00003669 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003670 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003671 /*Initializer=*/nullptr, MangledName);
David Majnemere2cb8d12014-07-07 06:20:47 +00003672
3673 // Initialize the CompleteObjectLocator.
3674 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003675 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3676 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3677 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3678 ABI.getImageRelativeConstant(
3679 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3680 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3681 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00003682 };
3683 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00003684 if (!ABI.isImageRelative())
3685 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00003686 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
Rafael Espindola654542a2015-01-16 19:23:42 +00003687 if (COL->isWeakForLinker())
3688 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003689 return COL;
3690}
3691
David Majnemerad803d42015-03-15 07:10:01 +00003692static QualType decomposeTypeForEH(ASTContext &Context, QualType T,
David Majnemer526793d2016-07-12 04:42:50 +00003693 bool &IsConst, bool &IsVolatile,
3694 bool &IsUnaligned) {
David Majnemerad803d42015-03-15 07:10:01 +00003695 T = Context.getExceptionObjectType(T);
3696
3697 // C++14 [except.handle]p3:
3698 // A handler is a match for an exception object of type E if [...]
3699 // - the handler is of type cv T or const T& where T is a pointer type and
3700 // E is a pointer type that can be converted to T by [...]
3701 // - a qualification conversion
3702 IsConst = false;
3703 IsVolatile = false;
David Majnemer526793d2016-07-12 04:42:50 +00003704 IsUnaligned = false;
David Majnemerad803d42015-03-15 07:10:01 +00003705 QualType PointeeType = T->getPointeeType();
3706 if (!PointeeType.isNull()) {
3707 IsConst = PointeeType.isConstQualified();
3708 IsVolatile = PointeeType.isVolatileQualified();
David Majnemer526793d2016-07-12 04:42:50 +00003709 IsUnaligned = PointeeType.getQualifiers().hasUnaligned();
David Majnemerad803d42015-03-15 07:10:01 +00003710 }
3711
3712 // Member pointer types like "const int A::*" are represented by having RTTI
3713 // for "int A::*" and separately storing the const qualifier.
3714 if (const auto *MPTy = T->getAs<MemberPointerType>())
3715 T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(),
3716 MPTy->getClass());
3717
3718 // Pointer types like "const int * const *" are represented by having RTTI
3719 // for "const int **" and separately storing the const qualifier.
3720 if (T->isPointerType())
3721 T = Context.getPointerType(PointeeType.getUnqualifiedType());
3722
3723 return T;
3724}
3725
Reid Kleckner10aa7702015-09-16 20:15:55 +00003726CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +00003727MicrosoftCXXABI::getAddrOfCXXCatchHandlerType(QualType Type,
3728 QualType CatchHandlerType) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003729 // TypeDescriptors for exceptions never have qualified pointer types,
Simon Pilgrim2c518802017-03-30 14:13:19 +00003730 // qualifiers are stored separately in order to support qualification
David Majnemer443250f2015-03-17 20:35:00 +00003731 // conversions.
David Majnemer526793d2016-07-12 04:42:50 +00003732 bool IsConst, IsVolatile, IsUnaligned;
3733 Type =
3734 decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile, IsUnaligned);
David Majnemer443250f2015-03-17 20:35:00 +00003735
David Majnemer5f0dd612015-03-17 20:35:05 +00003736 bool IsReference = CatchHandlerType->isReferenceType();
3737
David Majnemer5f0dd612015-03-17 20:35:05 +00003738 uint32_t Flags = 0;
3739 if (IsConst)
3740 Flags |= 1;
3741 if (IsVolatile)
3742 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00003743 if (IsUnaligned)
3744 Flags |= 4;
David Majnemer5f0dd612015-03-17 20:35:05 +00003745 if (IsReference)
3746 Flags |= 8;
3747
Reid Kleckner10aa7702015-09-16 20:15:55 +00003748 return CatchTypeInfo{getAddrOfRTTIDescriptor(Type)->stripPointerCasts(),
3749 Flags};
David Majnemer443250f2015-03-17 20:35:00 +00003750}
3751
David Majnemere2cb8d12014-07-07 06:20:47 +00003752/// \brief Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
3753/// llvm::GlobalVariable * because different type descriptors have different
3754/// types, and need to be abstracted. They are abstracting by casting the
3755/// address to an Int8PtrTy.
David Majnemer443250f2015-03-17 20:35:00 +00003756llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003757 SmallString<256> MangledName;
David Majnemere2cb8d12014-07-07 06:20:47 +00003758 {
3759 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003760 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003761 }
3762
3763 // Check to see if we've already declared this TypeDescriptor.
3764 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3765 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3766
Piotr Padlewskid3b1cbd2017-06-01 08:04:05 +00003767 // Note for the future: If we would ever like to do deferred emission of
3768 // RTTI, check if emitting vtables opportunistically need any adjustment.
3769
David Majnemere2cb8d12014-07-07 06:20:47 +00003770 // Compute the fields for the TypeDescriptor.
David Majnemer5f0dd612015-03-17 20:35:05 +00003771 SmallString<256> TypeInfoString;
David Majnemere2cb8d12014-07-07 06:20:47 +00003772 {
3773 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00003774 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003775 }
3776
3777 // Declare and initialize the TypeDescriptor.
3778 llvm::Constant *Fields[] = {
3779 getTypeInfoVTable(CGM), // VFPtr
3780 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3781 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3782 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00003783 getTypeDescriptorType(TypeInfoString);
Rafael Espindola654542a2015-01-16 19:23:42 +00003784 auto *Var = new llvm::GlobalVariable(
3785 CGM.getModule(), TypeDescriptorType, /*Constant=*/false,
3786 getLinkageForRTTI(Type),
3787 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
Yaron Keren2c07cc72015-12-01 08:14:39 +00003788 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003789 if (Var->isWeakForLinker())
3790 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3791 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003792}
3793
3794/// \brief Gets or a creates a Microsoft CompleteObjectLocator.
3795llvm::GlobalVariable *
3796MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
Justin Lebar562914e2016-10-10 16:26:29 +00003797 const VPtrInfo &Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00003798 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003799}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003800
3801static void emitCXXConstructor(CodeGenModule &CGM,
3802 const CXXConstructorDecl *ctor,
3803 StructorType ctorType) {
Rafael Espindolad48b51b2014-09-15 19:24:44 +00003804 // There are no constructor variants, always emit the complete destructor.
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003805 llvm::Function *Fn = CGM.codegenCXXStructor(ctor, StructorType::Complete);
3806 CGM.maybeSetTrivialComdat(*ctor, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003807}
3808
3809static void emitCXXDestructor(CodeGenModule &CGM, const CXXDestructorDecl *dtor,
3810 StructorType dtorType) {
3811 // The complete destructor is equivalent to the base destructor for
3812 // classes with no virtual bases, so try to emit it as an alias.
3813 if (!dtor->getParent()->getNumVBases() &&
3814 (dtorType == StructorType::Complete || dtorType == StructorType::Base)) {
3815 bool ProducedAlias = !CGM.TryEmitDefinitionAsAlias(
Reid Kleckner3da37e02017-10-13 00:53:02 +00003816 GlobalDecl(dtor, Dtor_Complete), GlobalDecl(dtor, Dtor_Base));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003817 if (ProducedAlias) {
3818 if (dtorType == StructorType::Complete)
3819 return;
3820 if (dtor->isVirtual())
3821 CGM.getVTables().EmitThunks(GlobalDecl(dtor, Dtor_Complete));
3822 }
3823 }
3824
3825 // The base destructor is equivalent to the base destructor of its
3826 // base class if there is exactly one non-virtual base class with a
3827 // non-trivial destructor, there are no fields with a non-trivial
3828 // destructor, and the body of the destructor is trivial.
3829 if (dtorType == StructorType::Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
3830 return;
3831
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003832 llvm::Function *Fn = CGM.codegenCXXStructor(dtor, dtorType);
Rafael Espindolad3e04692015-01-17 01:47:39 +00003833 if (Fn->isWeakForLinker())
3834 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003835}
3836
3837void MicrosoftCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3838 StructorType Type) {
3839 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
3840 emitCXXConstructor(CGM, CD, Type);
3841 return;
3842 }
3843 emitCXXDestructor(CGM, cast<CXXDestructorDecl>(MD), Type);
3844}
David Majnemer7c237072015-03-05 00:46:22 +00003845
David Majnemerdfa6d202015-03-11 18:36:39 +00003846llvm::Function *
David Majnemer37fd66e2015-03-13 22:36:55 +00003847MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
3848 CXXCtorType CT) {
3849 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
3850
David Majnemerdfa6d202015-03-11 18:36:39 +00003851 // Calculate the mangled name.
3852 SmallString<256> ThunkName;
3853 llvm::raw_svector_ostream Out(ThunkName);
David Majnemer37fd66e2015-03-13 22:36:55 +00003854 getMangleContext().mangleCXXCtor(CD, CT, Out);
David Majnemerdfa6d202015-03-11 18:36:39 +00003855
3856 // If the thunk has been generated previously, just return it.
3857 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
3858 return cast<llvm::Function>(GV);
3859
3860 // Create the llvm::Function.
David Majnemer37fd66e2015-03-13 22:36:55 +00003861 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT);
David Majnemerdfa6d202015-03-11 18:36:39 +00003862 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
3863 const CXXRecordDecl *RD = CD->getParent();
3864 QualType RecordTy = getContext().getRecordType(RD);
3865 llvm::Function *ThunkFn = llvm::Function::Create(
3866 ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule());
Reid Klecknerbba3cb92015-03-17 19:00:50 +00003867 ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>(
3868 FnInfo.getEffectiveCallingConvention()));
David Majnemer63aa2fb2015-06-30 21:23:51 +00003869 if (ThunkFn->isWeakForLinker())
3870 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
David Majnemer37fd66e2015-03-13 22:36:55 +00003871 bool IsCopy = CT == Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003872
3873 // Start codegen.
3874 CodeGenFunction CGF(CGM);
3875 CGF.CurGD = GlobalDecl(CD, Ctor_Complete);
3876
3877 // Build FunctionArgs.
3878 FunctionArgList FunctionArgs;
3879
David Majnemer37fd66e2015-03-13 22:36:55 +00003880 // A constructor always starts with a 'this' pointer as its first argument.
David Majnemerdfa6d202015-03-11 18:36:39 +00003881 buildThisParam(CGF, FunctionArgs);
3882
3883 // Following the 'this' pointer is a reference to the source object that we
3884 // are copying from.
3885 ImplicitParamDecl SrcParam(
Alexey Bataev56223232017-06-09 13:40:18 +00003886 getContext(), /*DC=*/nullptr, SourceLocation(),
3887 &getContext().Idents.get("src"),
David Majnemerdfa6d202015-03-11 18:36:39 +00003888 getContext().getLValueReferenceType(RecordTy,
Alexey Bataev56223232017-06-09 13:40:18 +00003889 /*SpelledAsLValue=*/true),
3890 ImplicitParamDecl::Other);
David Majnemer37fd66e2015-03-13 22:36:55 +00003891 if (IsCopy)
3892 FunctionArgs.push_back(&SrcParam);
David Majnemerdfa6d202015-03-11 18:36:39 +00003893
David Majnemer37fd66e2015-03-13 22:36:55 +00003894 // Constructors for classes which utilize virtual bases have an additional
3895 // parameter which indicates whether or not it is being delegated to by a more
3896 // derived constructor.
Alexey Bataev56223232017-06-09 13:40:18 +00003897 ImplicitParamDecl IsMostDerived(getContext(), /*DC=*/nullptr,
3898 SourceLocation(),
David Majnemerdfa6d202015-03-11 18:36:39 +00003899 &getContext().Idents.get("is_most_derived"),
Alexey Bataev56223232017-06-09 13:40:18 +00003900 getContext().IntTy, ImplicitParamDecl::Other);
David Majnemerdfa6d202015-03-11 18:36:39 +00003901 // Only add the parameter to the list if thie class has virtual bases.
3902 if (RD->getNumVBases() > 0)
3903 FunctionArgs.push_back(&IsMostDerived);
3904
3905 // Start defining the function.
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003906 auto NL = ApplyDebugLocation::CreateEmpty(CGF);
David Majnemerdfa6d202015-03-11 18:36:39 +00003907 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
3908 FunctionArgs, CD->getLocation(), SourceLocation());
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003909 // Create a scope with an artificial location for the body of this function.
3910 auto AL = ApplyDebugLocation::CreateArtificial(CGF);
Reid Kleckner06239e42017-11-16 19:09:36 +00003911 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
David Majnemerdfa6d202015-03-11 18:36:39 +00003912 llvm::Value *This = getThisValue(CGF);
3913
3914 llvm::Value *SrcVal =
David Majnemer37fd66e2015-03-13 22:36:55 +00003915 IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src")
3916 : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003917
3918 CallArgList Args;
3919
3920 // Push the this ptr.
3921 Args.add(RValue::get(This), CD->getThisType(getContext()));
3922
3923 // Push the src ptr.
David Majnemer37fd66e2015-03-13 22:36:55 +00003924 if (SrcVal)
3925 Args.add(RValue::get(SrcVal), SrcParam.getType());
David Majnemerdfa6d202015-03-11 18:36:39 +00003926
3927 // Add the rest of the default arguments.
Reid Klecknerc01ee752016-11-23 16:51:30 +00003928 SmallVector<const Stmt *, 4> ArgVec;
3929 ArrayRef<ParmVarDecl *> params = CD->parameters().drop_front(IsCopy ? 1 : 0);
3930 for (const ParmVarDecl *PD : params) {
3931 assert(PD->hasDefaultArg() && "ctor closure lacks default args");
3932 ArgVec.push_back(PD->getDefaultArg());
Reid Kleckner93f661a2015-03-17 21:51:43 +00003933 }
David Majnemerdfa6d202015-03-11 18:36:39 +00003934
3935 CodeGenFunction::RunCleanupsScope Cleanups(CGF);
3936
3937 const auto *FPT = CD->getType()->castAs<FunctionProtoType>();
David Blaikief05779e2015-07-21 18:37:18 +00003938 CGF.EmitCallArgs(Args, FPT, llvm::makeArrayRef(ArgVec), CD, IsCopy ? 1 : 0);
David Majnemerdfa6d202015-03-11 18:36:39 +00003939
3940 // Insert any ABI-specific implicit constructor arguments.
George Burgess IVf203dbf2017-02-22 20:28:02 +00003941 AddedStructorArgs ExtraArgs =
3942 addImplicitConstructorArgs(CGF, CD, Ctor_Complete,
3943 /*ForVirtualBase=*/false,
3944 /*Delegating=*/false, Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00003945 // Call the destructor with our arguments.
John McCallb92ab1a2016-10-26 23:46:34 +00003946 llvm::Constant *CalleePtr =
3947 CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3948 CGCallee Callee = CGCallee::forDirect(CalleePtr, CD);
David Majnemerdfa6d202015-03-11 18:36:39 +00003949 const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall(
George Burgess IVd0a9e802017-02-23 22:07:35 +00003950 Args, CD, Ctor_Complete, ExtraArgs.Prefix, ExtraArgs.Suffix);
John McCallb92ab1a2016-10-26 23:46:34 +00003951 CGF.EmitCall(CalleeInfo, Callee, ReturnValueSlot(), Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00003952
3953 Cleanups.ForceCleanup();
3954
3955 // Emit the ret instruction, remove any temporary instructions created for the
3956 // aid of CodeGen.
3957 CGF.FinishFunction(SourceLocation());
3958
3959 return ThunkFn;
3960}
3961
David Majnemer7c237072015-03-05 00:46:22 +00003962llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
3963 uint32_t NVOffset,
3964 int32_t VBPtrOffset,
3965 uint32_t VBIndex) {
3966 assert(!T->isReferenceType());
3967
David Majnemere7a818f2015-03-06 18:53:55 +00003968 CXXRecordDecl *RD = T->getAsCXXRecordDecl();
3969 const CXXConstructorDecl *CD =
3970 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003971 CXXCtorType CT = Ctor_Complete;
David Majnemer37fd66e2015-03-13 22:36:55 +00003972 if (CD)
3973 if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1)
David Majnemerdfa6d202015-03-11 18:36:39 +00003974 CT = Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003975
David Majnemer7c237072015-03-05 00:46:22 +00003976 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
3977 SmallString<256> MangledName;
3978 {
3979 llvm::raw_svector_ostream Out(MangledName);
David Majnemerdfa6d202015-03-11 18:36:39 +00003980 getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +00003981 VBPtrOffset, VBIndex, Out);
David Majnemer7c237072015-03-05 00:46:22 +00003982 }
3983 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3984 return getImageRelativeConstant(GV);
3985
David Majnemerdfa6d202015-03-11 18:36:39 +00003986 // The TypeDescriptor is used by the runtime to determine if a catch handler
David Majnemer7c237072015-03-05 00:46:22 +00003987 // is appropriate for the exception object.
David Majnemer443250f2015-03-17 20:35:00 +00003988 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
David Majnemer7c237072015-03-05 00:46:22 +00003989
3990 // The runtime is responsible for calling the copy constructor if the
3991 // exception is caught by value.
David Majnemerdfa6d202015-03-11 18:36:39 +00003992 llvm::Constant *CopyCtor;
3993 if (CD) {
3994 if (CT == Ctor_CopyingClosure)
David Majnemer37fd66e2015-03-13 22:36:55 +00003995 CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure);
David Majnemerdfa6d202015-03-11 18:36:39 +00003996 else
3997 CopyCtor = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3998
3999 CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy);
4000 } else {
4001 CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4002 }
David Majnemere7a818f2015-03-06 18:53:55 +00004003 CopyCtor = getImageRelativeConstant(CopyCtor);
David Majnemer7c237072015-03-05 00:46:22 +00004004
David Majnemere7a818f2015-03-06 18:53:55 +00004005 bool IsScalar = !RD;
David Majnemer7c237072015-03-05 00:46:22 +00004006 bool HasVirtualBases = false;
4007 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
David Majnemer7c237072015-03-05 00:46:22 +00004008 QualType PointeeType = T;
4009 if (T->isPointerType())
4010 PointeeType = T->getPointeeType();
4011 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
4012 HasVirtualBases = RD->getNumVBases() > 0;
4013 if (IdentifierInfo *II = RD->getIdentifier())
4014 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
4015 }
4016
4017 // Encode the relevant CatchableType properties into the Flags bitfield.
4018 // FIXME: Figure out how bits 2 or 8 can get set.
4019 uint32_t Flags = 0;
4020 if (IsScalar)
4021 Flags |= 1;
4022 if (HasVirtualBases)
4023 Flags |= 4;
4024 if (IsStdBadAlloc)
4025 Flags |= 16;
4026
4027 llvm::Constant *Fields[] = {
4028 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4029 TD, // TypeDescriptor
4030 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment
4031 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
4032 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex
4033 llvm::ConstantInt::get(CGM.IntTy, Size), // Size
4034 CopyCtor // CopyCtor
4035 };
4036 llvm::StructType *CTType = getCatchableTypeType();
4037 auto *GV = new llvm::GlobalVariable(
4038 CGM.getModule(), CTType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004039 llvm::ConstantStruct::get(CTType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004040 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004041 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004042 if (GV->isWeakForLinker())
4043 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004044 return getImageRelativeConstant(GV);
4045}
4046
4047llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
4048 assert(!T->isReferenceType());
4049
4050 // See if we've already generated a CatchableTypeArray for this type before.
4051 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
4052 if (CTA)
4053 return CTA;
4054
4055 // Ensure that we don't have duplicate entries in our CatchableTypeArray by
4056 // using a SmallSetVector. Duplicates may arise due to virtual bases
4057 // occurring more than once in the hierarchy.
4058 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
4059
4060 // C++14 [except.handle]p3:
4061 // A handler is a match for an exception object of type E if [...]
4062 // - the handler is of type cv T or cv T& and T is an unambiguous public
4063 // base class of E, or
4064 // - the handler is of type cv T or const T& where T is a pointer type and
4065 // E is a pointer type that can be converted to T by [...]
4066 // - a standard pointer conversion (4.10) not involving conversions to
4067 // pointers to private or protected or ambiguous classes
4068 const CXXRecordDecl *MostDerivedClass = nullptr;
4069 bool IsPointer = T->isPointerType();
4070 if (IsPointer)
4071 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
4072 else
4073 MostDerivedClass = T->getAsCXXRecordDecl();
4074
4075 // Collect all the unambiguous public bases of the MostDerivedClass.
4076 if (MostDerivedClass) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00004077 const ASTContext &Context = getContext();
David Majnemer7c237072015-03-05 00:46:22 +00004078 const ASTRecordLayout &MostDerivedLayout =
4079 Context.getASTRecordLayout(MostDerivedClass);
4080 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
4081 SmallVector<MSRTTIClass, 8> Classes;
4082 serializeClassHierarchy(Classes, MostDerivedClass);
4083 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
4084 detectAmbiguousBases(Classes);
4085 for (const MSRTTIClass &Class : Classes) {
4086 // Skip any ambiguous or private bases.
4087 if (Class.Flags &
4088 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
4089 continue;
4090 // Write down how to convert from a derived pointer to a base pointer.
4091 uint32_t OffsetInVBTable = 0;
4092 int32_t VBPtrOffset = -1;
4093 if (Class.VirtualRoot) {
4094 OffsetInVBTable =
4095 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
4096 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
4097 }
4098
4099 // Turn our record back into a pointer if the exception object is a
4100 // pointer.
4101 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
4102 if (IsPointer)
4103 RTTITy = Context.getPointerType(RTTITy);
4104 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
4105 VBPtrOffset, OffsetInVBTable));
4106 }
4107 }
4108
4109 // C++14 [except.handle]p3:
4110 // A handler is a match for an exception object of type E if
4111 // - The handler is of type cv T or cv T& and E and T are the same type
4112 // (ignoring the top-level cv-qualifiers)
4113 CatchableTypes.insert(getCatchableType(T));
4114
4115 // C++14 [except.handle]p3:
4116 // A handler is a match for an exception object of type E if
4117 // - the handler is of type cv T or const T& where T is a pointer type and
4118 // E is a pointer type that can be converted to T by [...]
4119 // - a standard pointer conversion (4.10) not involving conversions to
4120 // pointers to private or protected or ambiguous classes
4121 //
David Majnemerf205f532015-04-04 05:37:48 +00004122 // C++14 [conv.ptr]p2:
4123 // A prvalue of type "pointer to cv T," where T is an object type, can be
4124 // converted to a prvalue of type "pointer to cv void".
4125 if (IsPointer && T->getPointeeType()->isObjectType())
David Majnemer7c237072015-03-05 00:46:22 +00004126 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4127
David Majnemera1aea9a2015-03-12 17:44:49 +00004128 // 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 or
4131 // pointer to member type and E is std::nullptr_t.
4132 //
4133 // We cannot possibly list all possible pointer types here, making this
4134 // implementation incompatible with the standard. However, MSVC includes an
4135 // entry for pointer-to-void in this case. Let's do the same.
4136 if (T->isNullPtrType())
4137 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4138
David Majnemer7c237072015-03-05 00:46:22 +00004139 uint32_t NumEntries = CatchableTypes.size();
4140 llvm::Type *CTType =
4141 getImageRelativeType(getCatchableTypeType()->getPointerTo());
4142 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
4143 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
4144 llvm::Constant *Fields[] = {
4145 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries
4146 llvm::ConstantArray::get(
4147 AT, llvm::makeArrayRef(CatchableTypes.begin(),
4148 CatchableTypes.end())) // CatchableTypes
4149 };
4150 SmallString<256> MangledName;
4151 {
4152 llvm::raw_svector_ostream Out(MangledName);
4153 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
4154 }
4155 CTA = new llvm::GlobalVariable(
4156 CGM.getModule(), CTAType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004157 llvm::ConstantStruct::get(CTAType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004158 CTA->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004159 CTA->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004160 if (CTA->isWeakForLinker())
4161 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004162 return CTA;
4163}
4164
4165llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
David Majnemer526793d2016-07-12 04:42:50 +00004166 bool IsConst, IsVolatile, IsUnaligned;
4167 T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile, IsUnaligned);
David Majnemer7c237072015-03-05 00:46:22 +00004168
4169 // The CatchableTypeArray enumerates the various (CV-unqualified) types that
4170 // the exception object may be caught as.
4171 llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
4172 // The first field in a CatchableTypeArray is the number of CatchableTypes.
4173 // This is used as a component of the mangled name which means that we need to
4174 // know what it is in order to see if we have previously generated the
4175 // ThrowInfo.
4176 uint32_t NumEntries =
4177 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
4178 ->getLimitedValue();
4179
4180 SmallString<256> MangledName;
4181 {
4182 llvm::raw_svector_ostream Out(MangledName);
David Majnemer526793d2016-07-12 04:42:50 +00004183 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, IsUnaligned,
4184 NumEntries, Out);
David Majnemer7c237072015-03-05 00:46:22 +00004185 }
4186
4187 // Reuse a previously generated ThrowInfo if we have generated an appropriate
4188 // one before.
4189 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4190 return GV;
4191
4192 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
4193 // be at least as CV qualified. Encode this requirement into the Flags
4194 // bitfield.
4195 uint32_t Flags = 0;
4196 if (IsConst)
4197 Flags |= 1;
4198 if (IsVolatile)
4199 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00004200 if (IsUnaligned)
4201 Flags |= 4;
David Majnemer7c237072015-03-05 00:46:22 +00004202
4203 // The cleanup-function (a destructor) must be called when the exception
4204 // object's lifetime ends.
4205 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4206 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
4207 if (CXXDestructorDecl *DtorD = RD->getDestructor())
4208 if (!DtorD->isTrivial())
4209 CleanupFn = llvm::ConstantExpr::getBitCast(
4210 CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete),
4211 CGM.Int8PtrTy);
4212 // This is unused as far as we can tell, initialize it to null.
4213 llvm::Constant *ForwardCompat =
4214 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
4215 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
4216 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
4217 llvm::StructType *TIType = getThrowInfoType();
4218 llvm::Constant *Fields[] = {
4219 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4220 getImageRelativeConstant(CleanupFn), // CleanupFn
4221 ForwardCompat, // ForwardCompat
4222 PointerToCatchableTypes // CatchableTypeArray
4223 };
4224 auto *GV = new llvm::GlobalVariable(
4225 CGM.getModule(), TIType, /*Constant=*/true, getLinkageForRTTI(T),
4226 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004227 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004228 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004229 if (GV->isWeakForLinker())
4230 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004231 return GV;
4232}
4233
4234void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
4235 const Expr *SubExpr = E->getSubExpr();
4236 QualType ThrowType = SubExpr->getType();
4237 // The exception object lives on the stack and it's address is passed to the
4238 // runtime function.
John McCall7f416cc2015-09-08 08:05:57 +00004239 Address AI = CGF.CreateMemTemp(ThrowType);
David Majnemer7c237072015-03-05 00:46:22 +00004240 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
4241 /*IsInit=*/true);
4242
4243 // The so-called ThrowInfo is used to describe how the exception object may be
4244 // caught.
4245 llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
4246
4247 // Call into the runtime to throw the exception.
John McCall7f416cc2015-09-08 08:05:57 +00004248 llvm::Value *Args[] = {
4249 CGF.Builder.CreateBitCast(AI.getPointer(), CGM.Int8PtrTy),
4250 TI
4251 };
David Majnemer7c237072015-03-05 00:46:22 +00004252 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
4253}
Peter Collingbourne60108802017-12-13 21:53:04 +00004254
4255std::pair<llvm::Value *, const CXXRecordDecl *>
4256MicrosoftCXXABI::LoadVTablePtr(CodeGenFunction &CGF, Address This,
4257 const CXXRecordDecl *RD) {
4258 std::tie(This, std::ignore, RD) =
4259 performBaseAdjustment(CGF, This, QualType(RD->getTypeForDecl(), 0));
4260 return {CGF.GetVTablePtr(This, CGM.Int8PtrTy, RD), RD};
4261}