blob: edd6a053f210138c848bbb86cb70963aae8f537b [file] [log] [blame]
Charles Davis74ce8592010-06-09 23:25:41 +00001//===--- MicrosoftCXXABI.cpp - Emit LLVM Code from ASTs for a Module ------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
Chris Lattner57540c52011-04-15 05:22:18 +000010// This provides C++ code generation targeting the Microsoft Visual C++ ABI.
Charles Davis74ce8592010-06-09 23:25:41 +000011// The class in this file generates structures that follow the Microsoft
12// Visual C++ ABI, which is actually not very well documented at all outside
13// of Microsoft.
14//
15//===----------------------------------------------------------------------===//
16
17#include "CGCXXABI.h"
Reid Kleckner10aa7702015-09-16 20:15:55 +000018#include "CGCleanup.h"
Reid Kleckner7810af02013-06-19 15:20:38 +000019#include "CGVTables.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000020#include "CodeGenModule.h"
David Majnemere7a818f2015-03-06 18:53:55 +000021#include "CodeGenTypes.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000022#include "TargetInfo.h"
John McCall5ad74072017-03-02 20:04:19 +000023#include "clang/CodeGen/ConstantInitBuilder.h"
Charles Davis74ce8592010-06-09 23:25:41 +000024#include "clang/AST/Decl.h"
25#include "clang/AST/DeclCXX.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000026#include "clang/AST/StmtCXX.h"
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +000027#include "clang/AST/VTableBuilder.h"
David Majnemer611cdb92014-07-07 08:09:15 +000028#include "llvm/ADT/StringExtras.h"
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +000029#include "llvm/ADT/StringSet.h"
David Majnemer1162d252014-06-22 19:05:33 +000030#include "llvm/IR/CallSite.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000031#include "llvm/IR/Intrinsics.h"
Charles Davis74ce8592010-06-09 23:25:41 +000032
33using namespace clang;
34using namespace CodeGen;
35
36namespace {
37
Reid Klecknerb40a27d2014-01-03 00:14:35 +000038/// Holds all the vbtable globals for a given class.
39struct VBTableGlobals {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +000040 const VPtrInfoVector *VBTables;
Reid Klecknerb40a27d2014-01-03 00:14:35 +000041 SmallVector<llvm::GlobalVariable *, 2> Globals;
42};
43
Charles Davis53c59df2010-08-16 03:33:14 +000044class MicrosoftCXXABI : public CGCXXABI {
Charles Davis74ce8592010-06-09 23:25:41 +000045public:
David Majnemer611cdb92014-07-07 08:09:15 +000046 MicrosoftCXXABI(CodeGenModule &CGM)
47 : CGCXXABI(CGM), BaseClassDescriptorType(nullptr),
48 ClassHierarchyDescriptorType(nullptr),
David Majnemer7c237072015-03-05 00:46:22 +000049 CompleteObjectLocatorType(nullptr), CatchableTypeType(nullptr),
Benjamin Kramerc2d2b422015-10-15 15:29:40 +000050 ThrowInfoType(nullptr) {}
John McCall5d865c322010-08-31 07:33:07 +000051
Craig Topper4f12f102014-03-12 06:41:41 +000052 bool HasThisReturn(GlobalDecl GD) const override;
David Majnemer0c0b6d92014-10-31 20:09:12 +000053 bool hasMostDerivedReturn(GlobalDecl GD) const override;
Stephen Lin9dc6eef2013-06-30 20:40:16 +000054
Reid Kleckner40ca9132014-05-13 22:05:45 +000055 bool classifyReturnType(CGFunctionInfo &FI) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000056
Reid Klecknere39ee212014-05-03 00:33:28 +000057 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000058
Reid Kleckner37abaca2014-05-09 22:46:15 +000059 bool isSRetParameterAfterThis() const override { return true; }
60
John McCall7f416cc2015-09-08 08:05:57 +000061 bool isThisCompleteObject(GlobalDecl GD) const override {
62 // The Microsoft ABI doesn't use separate complete-object vs.
63 // base-object variants of constructors, but it does of destructors.
64 if (isa<CXXDestructorDecl>(GD.getDecl())) {
65 switch (GD.getDtorType()) {
66 case Dtor_Complete:
67 case Dtor_Deleting:
68 return true;
69
70 case Dtor_Base:
71 return false;
72
73 case Dtor_Comdat: llvm_unreachable("emitting dtor comdat as function?");
74 }
75 llvm_unreachable("bad dtor kind");
76 }
77
78 // No other kinds.
79 return false;
80 }
81
David Majnemer196ac332014-09-11 23:05:02 +000082 size_t getSrcArgforCopyCtor(const CXXConstructorDecl *CD,
83 FunctionArgList &Args) const override {
84 assert(Args.size() >= 2 &&
85 "expected the arglist to have at least two args!");
86 // The 'most_derived' parameter goes second if the ctor is variadic and
87 // has v-bases.
88 if (CD->getParent()->getNumVBases() > 0 &&
89 CD->getType()->castAs<FunctionProtoType>()->isVariadic())
90 return 2;
91 return 1;
92 }
93
David Majnemer8671c6e2015-11-02 09:01:44 +000094 std::vector<CharUnits> getVBPtrOffsets(const CXXRecordDecl *RD) override {
95 std::vector<CharUnits> VBPtrOffsets;
96 const ASTContext &Context = getContext();
97 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
98
99 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
Justin Lebar562914e2016-10-10 16:26:29 +0000100 for (const std::unique_ptr<VPtrInfo> &VBT : *VBGlobals.VBTables) {
David Majnemer8671c6e2015-11-02 09:01:44 +0000101 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +0000102 Context.getASTRecordLayout(VBT->IntroducingObject);
David Majnemer8671c6e2015-11-02 09:01:44 +0000103 CharUnits Offs = VBT->NonVirtualOffset;
104 Offs += SubobjectLayout.getVBPtrOffset();
105 if (VBT->getVBaseWithVPtr())
106 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
107 VBPtrOffsets.push_back(Offs);
108 }
109 llvm::array_pod_sort(VBPtrOffsets.begin(), VBPtrOffsets.end());
110 return VBPtrOffsets;
111 }
112
Craig Topper4f12f102014-03-12 06:41:41 +0000113 StringRef GetPureVirtualCallName() override { return "_purecall"; }
Craig Topper4f12f102014-03-12 06:41:41 +0000114 StringRef GetDeletedVirtualCallName() override { return "_purecall"; }
Joao Matos2ce88ef2012-07-17 17:10:11 +0000115
David Majnemer08681372014-11-01 07:37:17 +0000116 void emitVirtualObjectDelete(CodeGenFunction &CGF, const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000117 Address Ptr, QualType ElementType,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000118 const CXXDestructorDecl *Dtor) override;
John McCall82fb8922012-09-25 10:10:39 +0000119
Chandler Carruth4b9e8572014-11-25 08:59:34 +0000120 void emitRethrow(CodeGenFunction &CGF, bool isNoReturn) override;
David Majnemer7c237072015-03-05 00:46:22 +0000121 void emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) override;
David Majnemer442d0a22014-11-25 07:20:20 +0000122
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000123 void emitBeginCatch(CodeGenFunction &CGF, const CXXCatchStmt *C) override;
124
David Majnemere2cb8d12014-07-07 06:20:47 +0000125 llvm::GlobalVariable *getMSCompleteObjectLocator(const CXXRecordDecl *RD,
Justin Lebar562914e2016-10-10 16:26:29 +0000126 const VPtrInfo &Info);
David Majnemere2cb8d12014-07-07 06:20:47 +0000127
David Majnemer443250f2015-03-17 20:35:00 +0000128 llvm::Constant *getAddrOfRTTIDescriptor(QualType Ty) override;
Reid Kleckner10aa7702015-09-16 20:15:55 +0000129 CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +0000130 getAddrOfCXXCatchHandlerType(QualType Ty, QualType CatchHandlerType) override;
David Majnemere2cb8d12014-07-07 06:20:47 +0000131
Reid Kleckner10aa7702015-09-16 20:15:55 +0000132 /// MSVC needs an extra flag to indicate a catchall.
133 CatchTypeInfo getCatchAllTypeInfo() override {
134 return CatchTypeInfo{nullptr, 0x40};
135 }
136
David Majnemer1162d252014-06-22 19:05:33 +0000137 bool shouldTypeidBeNullChecked(bool IsDeref, QualType SrcRecordTy) override;
138 void EmitBadTypeidCall(CodeGenFunction &CGF) override;
139 llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000140 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000141 llvm::Type *StdTypeInfoPtrTy) override;
142
143 bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
144 QualType SrcRecordTy) override;
145
John McCall7f416cc2015-09-08 08:05:57 +0000146 llvm::Value *EmitDynamicCastCall(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000147 QualType SrcRecordTy, QualType DestTy,
148 QualType DestRecordTy,
149 llvm::BasicBlock *CastEnd) override;
150
John McCall7f416cc2015-09-08 08:05:57 +0000151 llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000152 QualType SrcRecordTy,
153 QualType DestTy) override;
154
155 bool EmitBadCastCall(CodeGenFunction &CGF) override;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000156 bool canSpeculativelyEmitVTable(const CXXRecordDecl *RD) const override {
Piotr Padlewskia68a7872015-07-24 04:04:49 +0000157 return false;
158 }
David Majnemer1162d252014-06-22 19:05:33 +0000159
Craig Topper4f12f102014-03-12 06:41:41 +0000160 llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +0000161 GetVirtualBaseClassOffset(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000162 const CXXRecordDecl *ClassDecl,
163 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000164
Craig Topper4f12f102014-03-12 06:41:41 +0000165 llvm::BasicBlock *
166 EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
167 const CXXRecordDecl *RD) override;
Erich Keane13c7ec52016-12-07 00:21:45 +0000168
169 llvm::BasicBlock *
170 EmitDtorCompleteObjectHandler(CodeGenFunction &CGF);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000171
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000172 void initializeHiddenVirtualInheritanceMembers(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000173 const CXXRecordDecl *RD) override;
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000174
Craig Topper4f12f102014-03-12 06:41:41 +0000175 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000176
Reid Klecknere7de47e2013-07-22 13:51:44 +0000177 // Background on MSVC destructors
178 // ==============================
179 //
180 // Both Itanium and MSVC ABIs have destructor variants. The variant names
181 // roughly correspond in the following way:
182 // Itanium Microsoft
183 // Base -> no name, just ~Class
184 // Complete -> vbase destructor
185 // Deleting -> scalar deleting destructor
186 // vector deleting destructor
187 //
188 // The base and complete destructors are the same as in Itanium, although the
189 // complete destructor does not accept a VTT parameter when there are virtual
190 // bases. A separate mechanism involving vtordisps is used to ensure that
191 // virtual methods of destroyed subobjects are not called.
192 //
193 // The deleting destructors accept an i32 bitfield as a second parameter. Bit
194 // 1 indicates if the memory should be deleted. Bit 2 indicates if the this
195 // pointer points to an array. The scalar deleting destructor assumes that
196 // bit 2 is zero, and therefore does not contain a loop.
197 //
198 // For virtual destructors, only one entry is reserved in the vftable, and it
199 // always points to the vector deleting destructor. The vector deleting
200 // destructor is the most general, so it can be used to destroy objects in
201 // place, delete single heap objects, or delete arrays.
202 //
203 // A TU defining a non-inline destructor is only guaranteed to emit a base
204 // destructor, and all of the other variants are emitted on an as-needed basis
205 // in COMDATs. Because a non-base destructor can be emitted in a TU that
206 // lacks a definition for the destructor, non-base destructors must always
207 // delegate to or alias the base destructor.
208
George Burgess IVf203dbf2017-02-22 20:28:02 +0000209 AddedStructorArgs
210 buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
211 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000212
Reid Klecknere7de47e2013-07-22 13:51:44 +0000213 /// Non-base dtors should be emitted as delegating thunks in this ABI.
214 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000215 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000216 return DT != Dtor_Base;
217 }
218
Reid Klecknerae9b0702018-03-16 19:40:50 +0000219 void setCXXDestructorDLLStorage(llvm::GlobalValue *GV,
220 const CXXDestructorDecl *Dtor,
221 CXXDtorType DT) const override;
222
223 llvm::GlobalValue::LinkageTypes
224 getCXXDestructorLinkage(GVALinkage Linkage, const CXXDestructorDecl *Dtor,
225 CXXDtorType DT) const override;
226
Craig Topper4f12f102014-03-12 06:41:41 +0000227 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000228
Craig Topper4f12f102014-03-12 06:41:41 +0000229 const CXXRecordDecl *
230 getThisArgumentTypeForMethod(const CXXMethodDecl *MD) override {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000231 MD = MD->getCanonicalDecl();
232 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD)) {
Reid Klecknercbec0262018-04-02 20:00:39 +0000233 MethodVFTableLocation ML =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000234 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000235 // The vbases might be ordered differently in the final overrider object
236 // and the complete object, so the "this" argument may sometimes point to
237 // memory that has no particular type (e.g. past the complete object).
238 // In this case, we just use a generic pointer type.
239 // FIXME: might want to have a more precise type in the non-virtual
240 // multiple inheritance case.
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +0000241 if (ML.VBase || !ML.VFPtrOffset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000242 return nullptr;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000243 }
244 return MD->getParent();
245 }
246
John McCall7f416cc2015-09-08 08:05:57 +0000247 Address
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000248 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD,
John McCall7f416cc2015-09-08 08:05:57 +0000249 Address This,
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000250 bool VirtualCall) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000251
Reid Kleckner89077a12013-12-17 19:46:40 +0000252 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000253 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000254
Craig Topper4f12f102014-03-12 06:41:41 +0000255 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall29036752011-01-27 02:46:02 +0000256
George Burgess IVf203dbf2017-02-22 20:28:02 +0000257 AddedStructorArgs
258 addImplicitConstructorArgs(CodeGenFunction &CGF, const CXXConstructorDecl *D,
259 CXXCtorType Type, bool ForVirtualBase,
260 bool Delegating, CallArgList &Args) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000261
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000262 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
263 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +0000264 bool Delegating, Address This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000265
Justin Lebar562914e2016-10-10 16:26:29 +0000266 void emitVTableTypeMetadata(const VPtrInfo &Info, const CXXRecordDecl *RD,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +0000267 llvm::GlobalVariable *VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +0000268
Craig Topper4f12f102014-03-12 06:41:41 +0000269 void emitVTableDefinitions(CodeGenVTables &CGVT,
270 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000271
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000272 bool isVirtualOffsetNeededForVTableField(CodeGenFunction &CGF,
273 CodeGenFunction::VPtr Vptr) override;
274
275 /// Don't initialize vptrs if dynamic class
276 /// is marked with with the 'novtable' attribute.
277 bool doStructorsInitializeVPtrs(const CXXRecordDecl *VTableClass) override {
278 return !VTableClass->hasAttr<MSNoVTableAttr>();
279 }
280
281 llvm::Constant *
282 getVTableAddressPoint(BaseSubobject Base,
283 const CXXRecordDecl *VTableClass) override;
284
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000285 llvm::Value *getVTableAddressPointInStructor(
286 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000287 BaseSubobject Base, const CXXRecordDecl *NearestVBase) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000288
289 llvm::Constant *
290 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000291 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000292
293 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000294 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000295
John McCall9831b842018-02-06 18:52:44 +0000296 CGCallee getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
297 Address This, llvm::Type *Ty,
298 SourceLocation Loc) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000299
David Majnemer0c0b6d92014-10-31 20:09:12 +0000300 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF,
301 const CXXDestructorDecl *Dtor,
302 CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +0000303 Address This,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000304 const CXXMemberCallExpr *CE) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000305
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000306 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000307 CallArgList &CallArgs) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000308 assert(GD.getDtorType() == Dtor_Deleting &&
309 "Only deleting destructor thunks are available in this ABI");
310 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)),
David Majnemer9ced3dd2015-03-14 23:44:48 +0000311 getContext().IntTy);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000312 }
313
Craig Topper4f12f102014-03-12 06:41:41 +0000314 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000315
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000316 llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000317 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000318 llvm::GlobalVariable::LinkageTypes Linkage);
319
David Majnemerc1709d32015-06-23 07:31:11 +0000320 llvm::GlobalVariable *
321 getAddrOfVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
322 const CXXRecordDecl *DstRD) {
323 SmallString<256> OutName;
324 llvm::raw_svector_ostream Out(OutName);
325 getMangleContext().mangleCXXVirtualDisplacementMap(SrcRD, DstRD, Out);
David Majnemerc1709d32015-06-23 07:31:11 +0000326 StringRef MangledName = OutName.str();
327
328 if (auto *VDispMap = CGM.getModule().getNamedGlobal(MangledName))
329 return VDispMap;
330
331 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
332 unsigned NumEntries = 1 + SrcRD->getNumVBases();
333 SmallVector<llvm::Constant *, 4> Map(NumEntries,
334 llvm::UndefValue::get(CGM.IntTy));
335 Map[0] = llvm::ConstantInt::get(CGM.IntTy, 0);
336 bool AnyDifferent = false;
337 for (const auto &I : SrcRD->vbases()) {
338 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
339 if (!DstRD->isVirtuallyDerivedFrom(VBase))
340 continue;
341
342 unsigned SrcVBIndex = VTContext.getVBTableIndex(SrcRD, VBase);
343 unsigned DstVBIndex = VTContext.getVBTableIndex(DstRD, VBase);
344 Map[SrcVBIndex] = llvm::ConstantInt::get(CGM.IntTy, DstVBIndex * 4);
345 AnyDifferent |= SrcVBIndex != DstVBIndex;
346 }
347 // This map would be useless, don't use it.
348 if (!AnyDifferent)
349 return nullptr;
350
351 llvm::ArrayType *VDispMapTy = llvm::ArrayType::get(CGM.IntTy, Map.size());
352 llvm::Constant *Init = llvm::ConstantArray::get(VDispMapTy, Map);
353 llvm::GlobalValue::LinkageTypes Linkage =
354 SrcRD->isExternallyVisible() && DstRD->isExternallyVisible()
355 ? llvm::GlobalValue::LinkOnceODRLinkage
356 : llvm::GlobalValue::InternalLinkage;
357 auto *VDispMap = new llvm::GlobalVariable(
358 CGM.getModule(), VDispMapTy, /*Constant=*/true, Linkage,
359 /*Initializer=*/Init, MangledName);
360 return VDispMap;
361 }
362
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000363 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000364 llvm::GlobalVariable *GV) const;
365
Hans Wennborgc94391d2014-06-06 20:04:01 +0000366 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
367 GlobalDecl GD, bool ReturnAdjustment) override {
Hans Wennborgc94391d2014-06-06 20:04:01 +0000368 GVALinkage Linkage =
369 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
370
371 if (Linkage == GVA_Internal)
372 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
373 else if (ReturnAdjustment)
374 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
375 else
376 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000377 }
378
Rafael Espindolab7350042018-03-01 00:35:47 +0000379 bool exportThunk() override { return false; }
380
John McCall7f416cc2015-09-08 08:05:57 +0000381 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000382 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000383
John McCall7f416cc2015-09-08 08:05:57 +0000384 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000385 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000386
David Majnemerb3341ea2014-10-05 05:05:40 +0000387 void EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +0000388 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +0000389 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +0000390 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000391
392 bool usesThreadWrapperFunction() const override { return false; }
393 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
394 QualType LValType) override;
395
John McCallc84ed6a2012-05-01 06:13:13 +0000396 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
397 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000398 bool PerformInit) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000399 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
400 llvm::Constant *Dtor, llvm::Constant *Addr) override;
John McCallc84ed6a2012-05-01 06:13:13 +0000401
John McCall29036752011-01-27 02:46:02 +0000402 // ==== Notes on array cookies =========
403 //
404 // MSVC seems to only use cookies when the class has a destructor; a
405 // two-argument usual array deallocation function isn't sufficient.
406 //
407 // For example, this code prints "100" and "1":
408 // struct A {
409 // char x;
410 // void *operator new[](size_t sz) {
411 // printf("%u\n", sz);
412 // return malloc(sz);
413 // }
414 // void operator delete[](void *p, size_t sz) {
415 // printf("%u\n", sz);
416 // free(p);
417 // }
418 // };
419 // int main() {
420 // A *p = new A[100];
421 // delete[] p;
422 // }
423 // Whereas it prints "104" and "104" if you give A a destructor.
John McCallb91cd662012-05-01 05:23:51 +0000424
Craig Topper4f12f102014-03-12 06:41:41 +0000425 bool requiresArrayCookie(const CXXDeleteExpr *expr,
426 QualType elementType) override;
427 bool requiresArrayCookie(const CXXNewExpr *expr) override;
428 CharUnits getArrayCookieSizeImpl(QualType type) override;
John McCall7f416cc2015-09-08 08:05:57 +0000429 Address InitializeArrayCookie(CodeGenFunction &CGF,
430 Address NewPtr,
431 llvm::Value *NumElements,
432 const CXXNewExpr *expr,
433 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000434 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000435 Address allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000436 CharUnits cookieSize) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000437
David Majnemer611cdb92014-07-07 08:09:15 +0000438 friend struct MSRTTIBuilder;
439
440 bool isImageRelative() const {
441 return CGM.getTarget().getPointerWidth(/*AddressSpace=*/0) == 64;
442 }
443
444 // 5 routines for constructing the llvm types for MS RTTI structs.
445 llvm::StructType *getTypeDescriptorType(StringRef TypeInfoString) {
446 llvm::SmallString<32> TDTypeName("rtti.TypeDescriptor");
447 TDTypeName += llvm::utostr(TypeInfoString.size());
448 llvm::StructType *&TypeDescriptorType =
449 TypeDescriptorTypeMap[TypeInfoString.size()];
450 if (TypeDescriptorType)
451 return TypeDescriptorType;
452 llvm::Type *FieldTypes[] = {
453 CGM.Int8PtrPtrTy,
454 CGM.Int8PtrTy,
455 llvm::ArrayType::get(CGM.Int8Ty, TypeInfoString.size() + 1)};
456 TypeDescriptorType =
457 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, TDTypeName);
458 return TypeDescriptorType;
459 }
460
461 llvm::Type *getImageRelativeType(llvm::Type *PtrType) {
462 if (!isImageRelative())
463 return PtrType;
464 return CGM.IntTy;
465 }
466
467 llvm::StructType *getBaseClassDescriptorType() {
468 if (BaseClassDescriptorType)
469 return BaseClassDescriptorType;
470 llvm::Type *FieldTypes[] = {
471 getImageRelativeType(CGM.Int8PtrTy),
472 CGM.IntTy,
473 CGM.IntTy,
474 CGM.IntTy,
475 CGM.IntTy,
476 CGM.IntTy,
477 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
478 };
479 BaseClassDescriptorType = llvm::StructType::create(
480 CGM.getLLVMContext(), FieldTypes, "rtti.BaseClassDescriptor");
481 return BaseClassDescriptorType;
482 }
483
484 llvm::StructType *getClassHierarchyDescriptorType() {
485 if (ClassHierarchyDescriptorType)
486 return ClassHierarchyDescriptorType;
487 // Forward-declare RTTIClassHierarchyDescriptor to break a cycle.
488 ClassHierarchyDescriptorType = llvm::StructType::create(
489 CGM.getLLVMContext(), "rtti.ClassHierarchyDescriptor");
490 llvm::Type *FieldTypes[] = {
491 CGM.IntTy,
492 CGM.IntTy,
493 CGM.IntTy,
494 getImageRelativeType(
495 getBaseClassDescriptorType()->getPointerTo()->getPointerTo()),
496 };
497 ClassHierarchyDescriptorType->setBody(FieldTypes);
498 return ClassHierarchyDescriptorType;
499 }
500
501 llvm::StructType *getCompleteObjectLocatorType() {
502 if (CompleteObjectLocatorType)
503 return CompleteObjectLocatorType;
504 CompleteObjectLocatorType = llvm::StructType::create(
505 CGM.getLLVMContext(), "rtti.CompleteObjectLocator");
506 llvm::Type *FieldTypes[] = {
507 CGM.IntTy,
508 CGM.IntTy,
509 CGM.IntTy,
510 getImageRelativeType(CGM.Int8PtrTy),
511 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
512 getImageRelativeType(CompleteObjectLocatorType),
513 };
514 llvm::ArrayRef<llvm::Type *> FieldTypesRef(FieldTypes);
515 if (!isImageRelative())
516 FieldTypesRef = FieldTypesRef.drop_back();
517 CompleteObjectLocatorType->setBody(FieldTypesRef);
518 return CompleteObjectLocatorType;
519 }
520
521 llvm::GlobalVariable *getImageBase() {
522 StringRef Name = "__ImageBase";
523 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name))
524 return GV;
525
Rafael Espindola1c406472018-03-22 23:02:19 +0000526 auto *GV = new llvm::GlobalVariable(CGM.getModule(), CGM.Int8Ty,
527 /*isConstant=*/true,
528 llvm::GlobalValue::ExternalLinkage,
529 /*Initializer=*/nullptr, Name);
530 CGM.setDSOLocal(GV);
531 return GV;
David Majnemer611cdb92014-07-07 08:09:15 +0000532 }
533
534 llvm::Constant *getImageRelativeConstant(llvm::Constant *PtrVal) {
535 if (!isImageRelative())
536 return PtrVal;
537
David Majnemer7c237072015-03-05 00:46:22 +0000538 if (PtrVal->isNullValue())
539 return llvm::Constant::getNullValue(CGM.IntTy);
540
David Majnemer611cdb92014-07-07 08:09:15 +0000541 llvm::Constant *ImageBaseAsInt =
542 llvm::ConstantExpr::getPtrToInt(getImageBase(), CGM.IntPtrTy);
543 llvm::Constant *PtrValAsInt =
544 llvm::ConstantExpr::getPtrToInt(PtrVal, CGM.IntPtrTy);
545 llvm::Constant *Diff =
546 llvm::ConstantExpr::getSub(PtrValAsInt, ImageBaseAsInt,
547 /*HasNUW=*/true, /*HasNSW=*/true);
548 return llvm::ConstantExpr::getTrunc(Diff, CGM.IntTy);
549 }
550
Reid Kleckner407e8b62013-03-22 19:02:54 +0000551private:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000552 MicrosoftMangleContext &getMangleContext() {
553 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext());
554 }
555
Reid Kleckner2341ae32013-04-11 18:13:19 +0000556 llvm::Constant *getZeroInt() {
557 return llvm::ConstantInt::get(CGM.IntTy, 0);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000558 }
559
Reid Kleckner2341ae32013-04-11 18:13:19 +0000560 llvm::Constant *getAllOnesInt() {
561 return llvm::Constant::getAllOnesValue(CGM.IntTy);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000562 }
563
Reid Kleckner0358cbf2016-07-01 02:41:25 +0000564 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) override;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000565
Reid Kleckner2341ae32013-04-11 18:13:19 +0000566 void
567 GetNullMemberPointerFields(const MemberPointerType *MPT,
568 llvm::SmallVectorImpl<llvm::Constant *> &fields);
569
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000570 /// \brief Shared code for virtual base adjustment. Returns the offset from
571 /// the vbptr to the virtual base. Optionally returns the address of the
572 /// vbptr itself.
573 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000574 Address Base,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000575 llvm::Value *VBPtrOffset,
576 llvm::Value *VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000577 llvm::Value **VBPtr = nullptr);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000578
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000579 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000580 Address Base,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000581 int32_t VBPtrOffset,
582 int32_t VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000583 llvm::Value **VBPtr = nullptr) {
Reid Kleckner0ba8ba42014-10-22 17:26:00 +0000584 assert(VBTableOffset % 4 == 0 && "should be byte offset into table of i32s");
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000585 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
586 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset);
587 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr);
588 }
589
Peter Collingbourne60108802017-12-13 21:53:04 +0000590 std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000591 performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000592 QualType SrcRecordTy);
593
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000594 /// \brief Performs a full virtual base adjustment. Used to dereference
595 /// pointers to members of virtual bases.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000596 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000597 const CXXRecordDecl *RD, Address Base,
Reid Kleckner2341ae32013-04-11 18:13:19 +0000598 llvm::Value *VirtualBaseAdjustmentOffset,
599 llvm::Value *VBPtrOffset /* optional */);
600
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000601 /// \brief Emits a full member pointer with the fields common to data and
602 /// function member pointers.
603 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField,
604 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +0000605 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +0000606 CharUnits NonVirtualBaseAdjustment,
607 unsigned VBTableIndex);
Reid Kleckner452abac2013-05-09 21:01:17 +0000608
Reid Kleckner452abac2013-05-09 21:01:17 +0000609 bool MemberPointerConstantIsNull(const MemberPointerType *MPT,
610 llvm::Constant *MP);
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000611
Reid Kleckner7810af02013-06-19 15:20:38 +0000612 /// \brief - Initialize all vbptrs of 'this' with RD as the complete type.
613 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
614
615 /// \brief Caching wrapper around VBTableBuilder::enumerateVBTables().
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000616 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000617
Hans Wennborg88497d62013-11-15 17:24:45 +0000618 /// \brief Generate a thunk for calling a virtual member function MD.
Reid Klecknercbec0262018-04-02 20:00:39 +0000619 llvm::Function *EmitVirtualMemPtrThunk(const CXXMethodDecl *MD,
620 const MethodVFTableLocation &ML);
Hans Wennborg88497d62013-11-15 17:24:45 +0000621
Reid Kleckner407e8b62013-03-22 19:02:54 +0000622public:
Craig Topper4f12f102014-03-12 06:41:41 +0000623 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000624
Craig Topper4f12f102014-03-12 06:41:41 +0000625 bool isZeroInitializable(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000626
David Majnemerb3e56542014-08-07 22:56:13 +0000627 bool isMemberPointerConvertible(const MemberPointerType *MPT) const override {
628 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemer99281062014-09-18 22:05:54 +0000629 return RD->hasAttr<MSInheritanceAttr>();
630 }
631
Craig Topper4f12f102014-03-12 06:41:41 +0000632 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000633
Craig Topper4f12f102014-03-12 06:41:41 +0000634 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
635 CharUnits offset) override;
David Majnemere2be95b2015-06-23 07:31:01 +0000636 llvm::Constant *EmitMemberFunctionPointer(const CXXMethodDecl *MD) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000637 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000638
Craig Topper4f12f102014-03-12 06:41:41 +0000639 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
640 llvm::Value *L,
641 llvm::Value *R,
642 const MemberPointerType *MPT,
643 bool Inequality) override;
Reid Kleckner700c3ee2013-04-30 20:15:14 +0000644
Craig Topper4f12f102014-03-12 06:41:41 +0000645 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
646 llvm::Value *MemPtr,
647 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000648
Craig Topper4f12f102014-03-12 06:41:41 +0000649 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000650 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000651 Address Base, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000652 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000653
David Majnemer0d9ad682015-06-29 00:06:50 +0000654 llvm::Value *EmitNonNullMemberPointerConversion(
655 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
656 CastKind CK, CastExpr::path_const_iterator PathBegin,
657 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
658 CGBuilderTy &Builder);
659
Craig Topper4f12f102014-03-12 06:41:41 +0000660 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
661 const CastExpr *E,
662 llvm::Value *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000663
Craig Topper4f12f102014-03-12 06:41:41 +0000664 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
665 llvm::Constant *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000666
David Majnemer5ca193c2015-06-23 07:31:07 +0000667 llvm::Constant *EmitMemberPointerConversion(
668 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
669 CastKind CK, CastExpr::path_const_iterator PathBegin,
670 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src);
671
John McCallb92ab1a2016-10-26 23:46:34 +0000672 CGCallee
David Majnemer2b0d66d2014-02-20 23:22:07 +0000673 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000674 Address This, llvm::Value *&ThisPtrForCall,
675 llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000676 const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000677
Rafael Espindola91f68b42014-09-15 19:20:10 +0000678 void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) override;
679
David Majnemer7c237072015-03-05 00:46:22 +0000680 llvm::StructType *getCatchableTypeType() {
681 if (CatchableTypeType)
682 return CatchableTypeType;
683 llvm::Type *FieldTypes[] = {
684 CGM.IntTy, // Flags
685 getImageRelativeType(CGM.Int8PtrTy), // TypeDescriptor
686 CGM.IntTy, // NonVirtualAdjustment
687 CGM.IntTy, // OffsetToVBPtr
688 CGM.IntTy, // VBTableIndex
689 CGM.IntTy, // Size
690 getImageRelativeType(CGM.Int8PtrTy) // CopyCtor
691 };
692 CatchableTypeType = llvm::StructType::create(
693 CGM.getLLVMContext(), FieldTypes, "eh.CatchableType");
694 return CatchableTypeType;
695 }
696
697 llvm::StructType *getCatchableTypeArrayType(uint32_t NumEntries) {
698 llvm::StructType *&CatchableTypeArrayType =
699 CatchableTypeArrayTypeMap[NumEntries];
700 if (CatchableTypeArrayType)
701 return CatchableTypeArrayType;
702
703 llvm::SmallString<23> CTATypeName("eh.CatchableTypeArray.");
704 CTATypeName += llvm::utostr(NumEntries);
705 llvm::Type *CTType =
706 getImageRelativeType(getCatchableTypeType()->getPointerTo());
707 llvm::Type *FieldTypes[] = {
708 CGM.IntTy, // NumEntries
709 llvm::ArrayType::get(CTType, NumEntries) // CatchableTypes
710 };
711 CatchableTypeArrayType =
712 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, CTATypeName);
713 return CatchableTypeArrayType;
714 }
715
716 llvm::StructType *getThrowInfoType() {
717 if (ThrowInfoType)
718 return ThrowInfoType;
719 llvm::Type *FieldTypes[] = {
720 CGM.IntTy, // Flags
721 getImageRelativeType(CGM.Int8PtrTy), // CleanupFn
722 getImageRelativeType(CGM.Int8PtrTy), // ForwardCompat
723 getImageRelativeType(CGM.Int8PtrTy) // CatchableTypeArray
724 };
725 ThrowInfoType = llvm::StructType::create(CGM.getLLVMContext(), FieldTypes,
726 "eh.ThrowInfo");
727 return ThrowInfoType;
728 }
729
730 llvm::Constant *getThrowFn() {
731 // _CxxThrowException is passed an exception object and a ThrowInfo object
732 // which describes the exception.
733 llvm::Type *Args[] = {CGM.Int8PtrTy, getThrowInfoType()->getPointerTo()};
734 llvm::FunctionType *FTy =
735 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
736 auto *Fn = cast<llvm::Function>(
737 CGM.CreateRuntimeFunction(FTy, "_CxxThrowException"));
738 // _CxxThrowException is stdcall on 32-bit x86 platforms.
739 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::x86)
740 Fn->setCallingConv(llvm::CallingConv::X86_StdCall);
741 return Fn;
742 }
743
David Majnemer37fd66e2015-03-13 22:36:55 +0000744 llvm::Function *getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
745 CXXCtorType CT);
David Majnemerdfa6d202015-03-11 18:36:39 +0000746
David Majnemer7c237072015-03-05 00:46:22 +0000747 llvm::Constant *getCatchableType(QualType T,
748 uint32_t NVOffset = 0,
749 int32_t VBPtrOffset = -1,
750 uint32_t VBIndex = 0);
751
752 llvm::GlobalVariable *getCatchableTypeArray(QualType T);
753
David Majnemerba3e5ec2015-03-13 18:26:17 +0000754 llvm::GlobalVariable *getThrowInfo(QualType T) override;
David Majnemer7c237072015-03-05 00:46:22 +0000755
Peter Collingbourne60108802017-12-13 21:53:04 +0000756 std::pair<llvm::Value *, const CXXRecordDecl *>
757 LoadVTablePtr(CodeGenFunction &CGF, Address This,
758 const CXXRecordDecl *RD) override;
759
Reid Kleckner7810af02013-06-19 15:20:38 +0000760private:
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000761 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy;
David Majnemerd905da42014-07-01 20:30:31 +0000762 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy;
763 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000764 /// \brief All the vftables that have been referenced.
765 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000766 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000767
768 /// \brief This set holds the record decls we've deferred vtable emission for.
769 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
770
771
772 /// \brief All the vbtables which have been referenced.
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000773 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap;
Reid Klecknerd8110b62013-09-10 20:14:30 +0000774
775 /// Info on the global variable used to guard initialization of static locals.
776 /// The BitIndex field is only used for externally invisible declarations.
777 struct GuardInfo {
Craig Topper8a13c412014-05-21 05:09:00 +0000778 GuardInfo() : Guard(nullptr), BitIndex(0) {}
Reid Klecknerd8110b62013-09-10 20:14:30 +0000779 llvm::GlobalVariable *Guard;
780 unsigned BitIndex;
781 };
782
783 /// Map from DeclContext to the current guard variable. We assume that the
784 /// AST is visited in source code order.
785 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap;
David Majnemerec8e54b2015-05-07 21:19:06 +0000786 llvm::DenseMap<const DeclContext *, GuardInfo> ThreadLocalGuardVariableMap;
David Majnemer8354eee2015-05-07 06:15:46 +0000787 llvm::DenseMap<const DeclContext *, unsigned> ThreadSafeGuardNumMap;
David Majnemer611cdb92014-07-07 08:09:15 +0000788
789 llvm::DenseMap<size_t, llvm::StructType *> TypeDescriptorTypeMap;
790 llvm::StructType *BaseClassDescriptorType;
791 llvm::StructType *ClassHierarchyDescriptorType;
792 llvm::StructType *CompleteObjectLocatorType;
David Majnemer7c237072015-03-05 00:46:22 +0000793
794 llvm::DenseMap<QualType, llvm::GlobalVariable *> CatchableTypeArrays;
795
796 llvm::StructType *CatchableTypeType;
797 llvm::DenseMap<uint32_t, llvm::StructType *> CatchableTypeArrayTypeMap;
798 llvm::StructType *ThrowInfoType;
Charles Davis74ce8592010-06-09 23:25:41 +0000799};
800
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000801}
Charles Davis74ce8592010-06-09 23:25:41 +0000802
Reid Klecknere39ee212014-05-03 00:33:28 +0000803CGCXXABI::RecordArgABI
804MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const {
805 switch (CGM.getTarget().getTriple().getArch()) {
806 default:
807 // FIXME: Implement for other architectures.
808 return RAA_Default;
809
Reid Kleckner44051e62016-08-25 18:23:28 +0000810 case llvm::Triple::thumb:
811 // Use the simple Itanium rules for now.
812 // FIXME: This is incompatible with MSVC for arguments with a dtor and no
813 // copy ctor.
814 return !canCopyArgument(RD) ? RAA_Indirect : RAA_Default;
815
Reid Klecknere39ee212014-05-03 00:33:28 +0000816 case llvm::Triple::x86:
Reid Klecknercf87e102014-05-14 16:02:09 +0000817 // All record arguments are passed in memory on x86. Decide whether to
818 // construct the object directly in argument memory, or to construct the
819 // argument elsewhere and copy the bytes during the call.
820
821 // If C++ prohibits us from making a copy, construct the arguments directly
822 // into argument memory.
823 if (!canCopyArgument(RD))
Reid Klecknere39ee212014-05-03 00:33:28 +0000824 return RAA_DirectInMemory;
Reid Klecknercf87e102014-05-14 16:02:09 +0000825
826 // Otherwise, construct the argument into a temporary and copy the bytes
827 // into the outgoing argument memory.
Reid Klecknere39ee212014-05-03 00:33:28 +0000828 return RAA_Default;
829
830 case llvm::Triple::x86_64:
Akira Hatanakafcbe17c2018-03-28 21:13:14 +0000831 return !canCopyArgument(RD) ? RAA_Indirect : RAA_Default;
Reid Klecknere39ee212014-05-03 00:33:28 +0000832 }
833
834 llvm_unreachable("invalid enum");
835}
836
David Majnemer08681372014-11-01 07:37:17 +0000837void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
838 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000839 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +0000840 QualType ElementType,
841 const CXXDestructorDecl *Dtor) {
David Majnemer0c0b6d92014-10-31 20:09:12 +0000842 // FIXME: Provide a source location here even though there's no
843 // CXXMemberCallExpr for dtor call.
David Majnemer08681372014-11-01 07:37:17 +0000844 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000845 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
846 llvm::Value *MDThis =
847 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr);
848 if (UseGlobalDelete)
David Majnemer08681372014-11-01 07:37:17 +0000849 CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType);
John McCall82fb8922012-09-25 10:10:39 +0000850}
851
David Majnemer442d0a22014-11-25 07:20:20 +0000852void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
David Majnemer7c237072015-03-05 00:46:22 +0000853 llvm::Value *Args[] = {
854 llvm::ConstantPointerNull::get(CGM.Int8PtrTy),
855 llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())};
856 auto *Fn = getThrowFn();
David Majnemer442d0a22014-11-25 07:20:20 +0000857 if (isNoReturn)
858 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args);
859 else
860 CGF.EmitRuntimeCallOrInvoke(Fn, Args);
861}
862
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000863namespace {
Reid Kleckner129552b2015-10-08 01:13:52 +0000864struct CatchRetScope final : EHScopeStack::Cleanup {
David Majnemere888a2f2015-08-15 03:21:08 +0000865 llvm::CatchPadInst *CPI;
866
Reid Kleckner129552b2015-10-08 01:13:52 +0000867 CatchRetScope(llvm::CatchPadInst *CPI) : CPI(CPI) {}
David Majnemere888a2f2015-08-15 03:21:08 +0000868
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000869 void Emit(CodeGenFunction &CGF, Flags flags) override {
Reid Kleckner129552b2015-10-08 01:13:52 +0000870 llvm::BasicBlock *BB = CGF.createBasicBlock("catchret.dest");
871 CGF.Builder.CreateCatchRet(CPI, BB);
872 CGF.EmitBlock(BB);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000873 }
874};
875}
876
877void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF,
878 const CXXCatchStmt *S) {
879 // In the MS ABI, the runtime handles the copy, and the catch handler is
880 // responsible for destruction.
881 VarDecl *CatchParam = S->getExceptionDecl();
David Majnemer4e52d6f2015-12-12 05:39:21 +0000882 llvm::BasicBlock *CatchPadBB = CGF.Builder.GetInsertBlock();
Reid Kleckner129552b2015-10-08 01:13:52 +0000883 llvm::CatchPadInst *CPI =
884 cast<llvm::CatchPadInst>(CatchPadBB->getFirstNonPHI());
David Majnemer4e52d6f2015-12-12 05:39:21 +0000885 CGF.CurrentFuncletPad = CPI;
Reid Kleckner129552b2015-10-08 01:13:52 +0000886
Reid Kleckner67cf0352015-04-07 00:09:59 +0000887 // If this is a catch-all or the catch parameter is unnamed, we don't need to
888 // emit an alloca to the object.
889 if (!CatchParam || !CatchParam->getDeclName()) {
Reid Kleckner129552b2015-10-08 01:13:52 +0000890 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000891 return;
892 }
893
894 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
Reid Kleckner129552b2015-10-08 01:13:52 +0000895 CPI->setArgOperand(2, var.getObjectAddress(CGF).getPointer());
896 CGF.EHStack.pushCleanup<CatchRetScope>(NormalCleanup, CPI);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000897 CGF.EmitAutoVarCleanups(var);
898}
899
John McCall7f416cc2015-09-08 08:05:57 +0000900/// We need to perform a generic polymorphic operation (like a typeid
901/// or a cast), which requires an object with a vfptr. Adjust the
902/// address to point to an object with a vfptr.
Peter Collingbourne60108802017-12-13 21:53:04 +0000903std::tuple<Address, llvm::Value *, const CXXRecordDecl *>
John McCall7f416cc2015-09-08 08:05:57 +0000904MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, Address Value,
David Majnemer5bc883f2015-02-27 02:38:02 +0000905 QualType SrcRecordTy) {
David Majnemer1162d252014-06-22 19:05:33 +0000906 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
907 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
David Majnemer9ced3dd2015-03-14 23:44:48 +0000908 const ASTContext &Context = getContext();
David Majnemer1162d252014-06-22 19:05:33 +0000909
John McCall7f416cc2015-09-08 08:05:57 +0000910 // If the class itself has a vfptr, great. This check implicitly
911 // covers non-virtual base subobjects: a class with its own virtual
912 // functions would be a candidate to be a primary base.
David Majnemer5bc883f2015-02-27 02:38:02 +0000913 if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
Peter Collingbourne60108802017-12-13 21:53:04 +0000914 return std::make_tuple(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0),
915 SrcDecl);
David Majnemer1162d252014-06-22 19:05:33 +0000916
John McCall7f416cc2015-09-08 08:05:57 +0000917 // Okay, one of the vbases must have a vfptr, or else this isn't
918 // actually a polymorphic class.
919 const CXXRecordDecl *PolymorphicBase = nullptr;
920 for (auto &Base : SrcDecl->vbases()) {
921 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
922 if (Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr()) {
923 PolymorphicBase = BaseDecl;
924 break;
925 }
926 }
927 assert(PolymorphicBase && "polymorphic class has no apparent vfptr?");
928
929 llvm::Value *Offset =
930 GetVirtualBaseClassOffset(CGF, Value, SrcDecl, PolymorphicBase);
931 llvm::Value *Ptr = CGF.Builder.CreateInBoundsGEP(Value.getPointer(), Offset);
John McCall7f416cc2015-09-08 08:05:57 +0000932 CharUnits VBaseAlign =
933 CGF.CGM.getVBaseAlignment(Value.getAlignment(), SrcDecl, PolymorphicBase);
Peter Collingbourne60108802017-12-13 21:53:04 +0000934 return std::make_tuple(Address(Ptr, VBaseAlign), Offset, PolymorphicBase);
David Majnemer1162d252014-06-22 19:05:33 +0000935}
936
937bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
938 QualType SrcRecordTy) {
939 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
940 return IsDeref &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000941 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000942}
943
944static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF,
945 llvm::Value *Argument) {
946 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
947 llvm::FunctionType *FTy =
948 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
949 llvm::Value *Args[] = {Argument};
950 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
951 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
952}
953
954void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
955 llvm::CallSite Call =
956 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
957 Call.setDoesNotReturn();
958 CGF.Builder.CreateUnreachable();
959}
960
961llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
962 QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000963 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000964 llvm::Type *StdTypeInfoPtrTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +0000965 std::tie(ThisPtr, std::ignore, std::ignore) =
David Majnemer17755352016-07-09 19:26:25 +0000966 performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +0000967 auto Typeid = emitRTtypeidCall(CGF, ThisPtr.getPointer()).getInstruction();
968 return CGF.Builder.CreateBitCast(Typeid, StdTypeInfoPtrTy);
David Majnemer1162d252014-06-22 19:05:33 +0000969}
970
971bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
972 QualType SrcRecordTy) {
973 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
974 return SrcIsPtr &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000975 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000976}
977
978llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
John McCall7f416cc2015-09-08 08:05:57 +0000979 CodeGenFunction &CGF, Address This, QualType SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +0000980 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
981 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
982
983 llvm::Value *SrcRTTI =
984 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
985 llvm::Value *DestRTTI =
986 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
987
988 llvm::Value *Offset;
Peter Collingbourne60108802017-12-13 21:53:04 +0000989 std::tie(This, Offset, std::ignore) =
990 performBaseAdjustment(CGF, This, SrcRecordTy);
John McCall7f416cc2015-09-08 08:05:57 +0000991 llvm::Value *ThisPtr = This.getPointer();
David Majnemer17755352016-07-09 19:26:25 +0000992 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
David Majnemer1162d252014-06-22 19:05:33 +0000993
994 // PVOID __RTDynamicCast(
995 // PVOID inptr,
996 // LONG VfDelta,
997 // PVOID SrcType,
998 // PVOID TargetType,
999 // BOOL isReference)
1000 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
1001 CGF.Int8PtrTy, CGF.Int32Ty};
1002 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1003 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1004 "__RTDynamicCast");
1005 llvm::Value *Args[] = {
John McCall7f416cc2015-09-08 08:05:57 +00001006 ThisPtr, Offset, SrcRTTI, DestRTTI,
David Majnemer1162d252014-06-22 19:05:33 +00001007 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
John McCall7f416cc2015-09-08 08:05:57 +00001008 ThisPtr = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction();
1009 return CGF.Builder.CreateBitCast(ThisPtr, DestLTy);
David Majnemer1162d252014-06-22 19:05:33 +00001010}
1011
1012llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00001013MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +00001014 QualType SrcRecordTy,
1015 QualType DestTy) {
Peter Collingbourne60108802017-12-13 21:53:04 +00001016 std::tie(Value, std::ignore, std::ignore) =
1017 performBaseAdjustment(CGF, Value, SrcRecordTy);
David Majnemer1162d252014-06-22 19:05:33 +00001018
1019 // PVOID __RTCastToVoid(
1020 // PVOID inptr)
1021 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
1022 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
1023 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
1024 "__RTCastToVoid");
John McCall7f416cc2015-09-08 08:05:57 +00001025 llvm::Value *Args[] = {Value.getPointer()};
David Majnemer1162d252014-06-22 19:05:33 +00001026 return CGF.EmitRuntimeCall(Function, Args);
1027}
1028
1029bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
1030 return false;
1031}
1032
David Majnemerca32f932014-09-01 18:50:02 +00001033llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
John McCall7f416cc2015-09-08 08:05:57 +00001034 CodeGenFunction &CGF, Address This, const CXXRecordDecl *ClassDecl,
David Majnemerca32f932014-09-01 18:50:02 +00001035 const CXXRecordDecl *BaseClassDecl) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001036 const ASTContext &Context = getContext();
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00001037 int64_t VBPtrChars =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001038 Context.getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001039 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
David Majnemer9ced3dd2015-03-14 23:44:48 +00001040 CharUnits IntSize = Context.getTypeSizeInChars(Context.IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001041 CharUnits VBTableChars =
1042 IntSize *
1043 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001044 llvm::Value *VBTableOffset =
David Majnemerca32f932014-09-01 18:50:02 +00001045 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001046
1047 llvm::Value *VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001048 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001049 VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001050 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001051 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
1052}
1053
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001054bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
1055 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +00001056}
1057
David Majnemer0c0b6d92014-10-31 20:09:12 +00001058static bool isDeletingDtor(GlobalDecl GD) {
1059 return isa<CXXDestructorDecl>(GD.getDecl()) &&
1060 GD.getDtorType() == Dtor_Deleting;
1061}
1062
1063bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const {
1064 return isDeletingDtor(GD);
1065}
1066
Reid Kleckner40ca9132014-05-13 22:05:45 +00001067bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
1068 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
1069 if (!RD)
1070 return false;
1071
John McCall7f416cc2015-09-08 08:05:57 +00001072 CharUnits Align = CGM.getContext().getTypeAlignInChars(FI.getReturnType());
Reid Kleckner40ca9132014-05-13 22:05:45 +00001073 if (FI.isInstanceMethod()) {
1074 // If it's an instance method, aggregates are always returned indirectly via
1075 // the second parameter.
John McCall7f416cc2015-09-08 08:05:57 +00001076 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001077 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod());
1078 return true;
1079 } else if (!RD->isPOD()) {
1080 // If it's a free function, non-POD types are returned indirectly.
John McCall7f416cc2015-09-08 08:05:57 +00001081 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +00001082 return true;
1083 }
1084
1085 // Otherwise, use the C ABI rules.
1086 return false;
1087}
1088
Reid Kleckner7810af02013-06-19 15:20:38 +00001089llvm::BasicBlock *
1090MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
1091 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001092 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1093 assert(IsMostDerivedClass &&
1094 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +00001095 llvm::Value *IsCompleteObject =
1096 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001097
1098 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
1099 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
1100 CGF.Builder.CreateCondBr(IsCompleteObject,
1101 CallVbaseCtorsBB, SkipVbaseCtorsBB);
1102
1103 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +00001104
1105 // Fill in the vbtable pointers here.
1106 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001107
1108 // CGF will put the base ctor calls in this basic block for us later.
1109
1110 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +00001111}
1112
Erich Keane13c7ec52016-12-07 00:21:45 +00001113llvm::BasicBlock *
1114MicrosoftCXXABI::EmitDtorCompleteObjectHandler(CodeGenFunction &CGF) {
1115 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1116 assert(IsMostDerivedClass &&
1117 "ctor for a class with virtual bases must have an implicit parameter");
1118 llvm::Value *IsCompleteObject =
1119 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
1120
1121 llvm::BasicBlock *CallVbaseDtorsBB = CGF.createBasicBlock("Dtor.dtor_vbases");
1122 llvm::BasicBlock *SkipVbaseDtorsBB = CGF.createBasicBlock("Dtor.skip_vbases");
1123 CGF.Builder.CreateCondBr(IsCompleteObject,
1124 CallVbaseDtorsBB, SkipVbaseDtorsBB);
1125
1126 CGF.EmitBlock(CallVbaseDtorsBB);
1127 // CGF will put the base dtor calls in this basic block for us later.
1128
1129 return SkipVbaseDtorsBB;
1130}
1131
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001132void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
1133 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
1134 // In most cases, an override for a vbase virtual method can adjust
1135 // the "this" parameter by applying a constant offset.
1136 // However, this is not enough while a constructor or a destructor of some
1137 // class X is being executed if all the following conditions are met:
1138 // - X has virtual bases, (1)
1139 // - X overrides a virtual method M of a vbase Y, (2)
1140 // - X itself is a vbase of the most derived class.
1141 //
1142 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
1143 // which holds the extra amount of "this" adjustment we must do when we use
1144 // the X vftables (i.e. during X ctor or dtor).
1145 // Outside the ctors and dtors, the values of vtorDisps are zero.
1146
1147 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
1148 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
1149 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
1150 CGBuilderTy &Builder = CGF.Builder;
1151
John McCall7f416cc2015-09-08 08:05:57 +00001152 unsigned AS = getThisAddress(CGF).getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +00001153 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001154
Nico Weber91af2742018-03-07 23:15:20 +00001155 for (const CXXBaseSpecifier &S : RD->vbases()) {
1156 const CXXRecordDecl *VBase = S.getType()->getAsCXXRecordDecl();
1157 auto I = VBaseMap.find(VBase);
1158 assert(I != VBaseMap.end());
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001159 if (!I->second.hasVtorDisp())
1160 continue;
1161
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +00001162 llvm::Value *VBaseOffset =
Nico Weber91af2742018-03-07 23:15:20 +00001163 GetVirtualBaseClassOffset(CGF, getThisAddress(CGF), RD, VBase);
1164 uint64_t ConstantVBaseOffset = I->second.VBaseOffset.getQuantity();
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001165
1166 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
1167 llvm::Value *VtorDispValue = Builder.CreateSub(
David Majnemer17755352016-07-09 19:26:25 +00001168 VBaseOffset, llvm::ConstantInt::get(CGM.PtrDiffTy, ConstantVBaseOffset),
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001169 "vtordisp.value");
David Majnemer17755352016-07-09 19:26:25 +00001170 VtorDispValue = Builder.CreateTruncOrBitCast(VtorDispValue, CGF.Int32Ty);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001171
1172 if (!Int8This)
1173 Int8This = Builder.CreateBitCast(getThisValue(CGF),
1174 CGF.Int8Ty->getPointerTo(AS));
1175 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
1176 // vtorDisp is always the 32-bits before the vbase in the class layout.
1177 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
1178 VtorDispPtr = Builder.CreateBitCast(
1179 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
1180
John McCall7f416cc2015-09-08 08:05:57 +00001181 Builder.CreateAlignedStore(VtorDispValue, VtorDispPtr,
1182 CharUnits::fromQuantity(4));
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001183 }
1184}
1185
David Majnemer37fd66e2015-03-13 22:36:55 +00001186static bool hasDefaultCXXMethodCC(ASTContext &Context,
1187 const CXXMethodDecl *MD) {
1188 CallingConv ExpectedCallingConv = Context.getDefaultCallingConvention(
1189 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1190 CallingConv ActualCallingConv =
1191 MD->getType()->getAs<FunctionProtoType>()->getCallConv();
1192 return ExpectedCallingConv == ActualCallingConv;
1193}
1194
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001195void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1196 // There's only one constructor type in this ABI.
1197 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
David Majnemer37fd66e2015-03-13 22:36:55 +00001198
1199 // Exported default constructors either have a simple call-site where they use
1200 // the typical calling convention and have a single 'this' pointer for an
1201 // argument -or- they get a wrapper function which appropriately thunks to the
1202 // real default constructor. This thunk is the default constructor closure.
1203 if (D->hasAttr<DLLExportAttr>() && D->isDefaultConstructor())
1204 if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) {
1205 llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure);
1206 Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage);
Rafael Espindolab7350042018-03-01 00:35:47 +00001207 CGM.setGVProperties(Fn, D);
David Majnemer37fd66e2015-03-13 22:36:55 +00001208 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001209}
1210
Reid Kleckner7810af02013-06-19 15:20:38 +00001211void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1212 const CXXRecordDecl *RD) {
John McCall7f416cc2015-09-08 08:05:57 +00001213 Address This = getThisAddress(CGF);
1214 This = CGF.Builder.CreateElementBitCast(This, CGM.Int8Ty, "this.int8");
David Majnemer9ced3dd2015-03-14 23:44:48 +00001215 const ASTContext &Context = getContext();
1216 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001217
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001218 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1219 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00001220 const std::unique_ptr<VPtrInfo> &VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001221 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +00001222 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001223 Context.getASTRecordLayout(VBT->IntroducingObject);
Reid Kleckner5f080942014-01-03 23:42:00 +00001224 CharUnits Offs = VBT->NonVirtualOffset;
1225 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001226 if (VBT->getVBaseWithVPtr())
1227 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
John McCall7f416cc2015-09-08 08:05:57 +00001228 Address VBPtr = CGF.Builder.CreateConstInBoundsByteGEP(This, Offs);
David Blaikie1ed728c2015-04-05 22:45:47 +00001229 llvm::Value *GVPtr =
1230 CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001231 VBPtr = CGF.Builder.CreateElementBitCast(VBPtr, GVPtr->getType(),
Reid Kleckner8ad06d62016-07-20 14:40:25 +00001232 "vbptr." + VBT->ObjectWithVPtr->getName());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001233 CGF.Builder.CreateStore(GVPtr, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +00001234 }
1235}
1236
George Burgess IVf203dbf2017-02-22 20:28:02 +00001237CGCXXABI::AddedStructorArgs
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001238MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001239 SmallVectorImpl<CanQualType> &ArgTys) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001240 AddedStructorArgs Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001241 // TODO: 'for base' flag
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001242 if (T == StructorType::Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001243 // The scalar deleting destructor takes an implicit int parameter.
David Majnemer9ced3dd2015-03-14 23:44:48 +00001244 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001245 ++Added.Suffix;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001246 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001247 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
1248 if (!CD)
George Burgess IVf203dbf2017-02-22 20:28:02 +00001249 return Added;
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001250
1251 // All parameters are already in place except is_most_derived, which goes
1252 // after 'this' if it's variadic and last if it's not.
1253
1254 const CXXRecordDecl *Class = CD->getParent();
1255 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1256 if (Class->getNumVBases()) {
George Burgess IVf203dbf2017-02-22 20:28:02 +00001257 if (FPT->isVariadic()) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001258 ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001259 ++Added.Prefix;
1260 } else {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001261 ArgTys.push_back(getContext().IntTy);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001262 ++Added.Suffix;
1263 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001264 }
George Burgess IVf203dbf2017-02-22 20:28:02 +00001265
1266 return Added;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001267}
1268
Reid Klecknerae9b0702018-03-16 19:40:50 +00001269void MicrosoftCXXABI::setCXXDestructorDLLStorage(llvm::GlobalValue *GV,
1270 const CXXDestructorDecl *Dtor,
1271 CXXDtorType DT) const {
1272 // Deleting destructor variants are never imported or exported. Give them the
1273 // default storage class.
1274 if (DT == Dtor_Deleting) {
1275 GV->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
1276 } else {
1277 const NamedDecl *ND = Dtor;
1278 CGM.setDLLImportDLLExport(GV, ND);
1279 }
1280}
1281
1282llvm::GlobalValue::LinkageTypes MicrosoftCXXABI::getCXXDestructorLinkage(
1283 GVALinkage Linkage, const CXXDestructorDecl *Dtor, CXXDtorType DT) const {
1284 // Internal things are always internal, regardless of attributes. After this,
1285 // we know the thunk is externally visible.
1286 if (Linkage == GVA_Internal)
1287 return llvm::GlobalValue::InternalLinkage;
1288
1289 switch (DT) {
1290 case Dtor_Base:
1291 // The base destructor most closely tracks the user-declared constructor, so
1292 // we delegate back to the normal declarator case.
1293 return CGM.getLLVMLinkageForDeclarator(Dtor, Linkage,
1294 /*isConstantVariable=*/false);
1295 case Dtor_Complete:
1296 // The complete destructor is like an inline function, but it may be
1297 // imported and therefore must be exported as well. This requires changing
1298 // the linkage if a DLL attribute is present.
1299 if (Dtor->hasAttr<DLLExportAttr>())
1300 return llvm::GlobalValue::WeakODRLinkage;
1301 if (Dtor->hasAttr<DLLImportAttr>())
1302 return llvm::GlobalValue::AvailableExternallyLinkage;
1303 return llvm::GlobalValue::LinkOnceODRLinkage;
1304 case Dtor_Deleting:
1305 // Deleting destructors are like inline functions. They have vague linkage
1306 // and are emitted everywhere they are used. They are internal if the class
1307 // is internal.
1308 return llvm::GlobalValue::LinkOnceODRLinkage;
1309 case Dtor_Comdat:
1310 llvm_unreachable("MS C++ ABI does not support comdat dtors");
1311 }
1312 llvm_unreachable("invalid dtor type");
1313}
1314
Reid Klecknere7de47e2013-07-22 13:51:44 +00001315void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1316 // The TU defining a dtor is only guaranteed to emit a base destructor. All
1317 // other destructor variants are delegating thunks.
1318 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1319}
1320
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001321CharUnits
1322MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001323 GD = GD.getCanonicalDecl();
1324 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001325
1326 GlobalDecl LookupGD = GD;
1327 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1328 // Complete destructors take a pointer to the complete object as a
1329 // parameter, thus don't need this adjustment.
1330 if (GD.getDtorType() == Dtor_Complete)
1331 return CharUnits();
1332
1333 // There's no Dtor_Base in vftable but it shares the this adjustment with
1334 // the deleting one, so look it up instead.
1335 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1336 }
1337
Reid Klecknercbec0262018-04-02 20:00:39 +00001338 MethodVFTableLocation ML =
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001339 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
1340 CharUnits Adjustment = ML.VFPtrOffset;
1341
1342 // Normal virtual instance methods need to adjust from the vfptr that first
1343 // defined the virtual method to the virtual base subobject, but destructors
1344 // do not. The vector deleting destructor thunk applies this adjustment for
1345 // us if necessary.
1346 if (isa<CXXDestructorDecl>(MD))
1347 Adjustment = CharUnits::Zero();
1348
1349 if (ML.VBase) {
1350 const ASTRecordLayout &DerivedLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001351 getContext().getASTRecordLayout(MD->getParent());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001352 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1353 }
1354
1355 return Adjustment;
1356}
1357
John McCall7f416cc2015-09-08 08:05:57 +00001358Address MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1359 CodeGenFunction &CGF, GlobalDecl GD, Address This,
1360 bool VirtualCall) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001361 if (!VirtualCall) {
1362 // If the call of a virtual function is not virtual, we just have to
1363 // compensate for the adjustment the virtual function does in its prologue.
1364 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1365 if (Adjustment.isZero())
1366 return This;
1367
John McCall7f416cc2015-09-08 08:05:57 +00001368 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001369 assert(Adjustment.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001370 return CGF.Builder.CreateConstByteGEP(This, Adjustment);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001371 }
1372
1373 GD = GD.getCanonicalDecl();
1374 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001375
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001376 GlobalDecl LookupGD = GD;
1377 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1378 // Complete dtors take a pointer to the complete object,
1379 // thus don't need adjustment.
1380 if (GD.getDtorType() == Dtor_Complete)
1381 return This;
1382
1383 // There's only Dtor_Deleting in vftable but it shares the this adjustment
1384 // with the base one, so look up the deleting one instead.
1385 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1386 }
Reid Klecknercbec0262018-04-02 20:00:39 +00001387 MethodVFTableLocation ML =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001388 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001389
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001390 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001391
1392 // Base destructors expect 'this' to point to the beginning of the base
1393 // subobject, not the first vfptr that happens to contain the virtual dtor.
1394 // However, we still need to apply the virtual base adjustment.
1395 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1396 StaticOffset = CharUnits::Zero();
1397
John McCall7f416cc2015-09-08 08:05:57 +00001398 Address Result = This;
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001399 if (ML.VBase) {
John McCall7f416cc2015-09-08 08:05:57 +00001400 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
1401
1402 const CXXRecordDecl *Derived = MD->getParent();
1403 const CXXRecordDecl *VBase = ML.VBase;
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001404 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00001405 GetVirtualBaseClassOffset(CGF, Result, Derived, VBase);
1406 llvm::Value *VBasePtr =
1407 CGF.Builder.CreateInBoundsGEP(Result.getPointer(), VBaseOffset);
1408 CharUnits VBaseAlign =
1409 CGF.CGM.getVBaseAlignment(Result.getAlignment(), Derived, VBase);
1410 Result = Address(VBasePtr, VBaseAlign);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001411 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001412 if (!StaticOffset.isZero()) {
1413 assert(StaticOffset.isPositive());
John McCall7f416cc2015-09-08 08:05:57 +00001414 Result = CGF.Builder.CreateElementBitCast(Result, CGF.Int8Ty);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001415 if (ML.VBase) {
1416 // Non-virtual adjustment might result in a pointer outside the allocated
1417 // object, e.g. if the final overrider class is laid out after the virtual
1418 // base that declares a method in the most derived class.
1419 // FIXME: Update the code that emits this adjustment in thunks prologues.
John McCall7f416cc2015-09-08 08:05:57 +00001420 Result = CGF.Builder.CreateConstByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001421 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001422 Result = CGF.Builder.CreateConstInBoundsByteGEP(Result, StaticOffset);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001423 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001424 }
John McCall7f416cc2015-09-08 08:05:57 +00001425 return Result;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001426}
1427
Reid Kleckner89077a12013-12-17 19:46:40 +00001428void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1429 QualType &ResTy,
1430 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001431 ASTContext &Context = getContext();
1432 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001433 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001434 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
Alexey Bataev56223232017-06-09 13:40:18 +00001435 auto *IsMostDerived = ImplicitParamDecl::Create(
1436 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1437 &Context.Idents.get("is_most_derived"), Context.IntTy,
1438 ImplicitParamDecl::Other);
Reid Kleckner89077a12013-12-17 19:46:40 +00001439 // The 'most_derived' parameter goes second if the ctor is variadic and last
1440 // if it's not. Dtors can't be variadic.
1441 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1442 if (FPT->isVariadic())
1443 Params.insert(Params.begin() + 1, IsMostDerived);
1444 else
1445 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001446 getStructorImplicitParamDecl(CGF) = IsMostDerived;
David Majnemer0c0b6d92014-10-31 20:09:12 +00001447 } else if (isDeletingDtor(CGF.CurGD)) {
Alexey Bataev56223232017-06-09 13:40:18 +00001448 auto *ShouldDelete = ImplicitParamDecl::Create(
1449 Context, /*DC=*/nullptr, CGF.CurGD.getDecl()->getLocation(),
1450 &Context.Idents.get("should_call_delete"), Context.IntTy,
1451 ImplicitParamDecl::Other);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001452 Params.push_back(ShouldDelete);
1453 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1454 }
John McCall0f999f32012-09-25 08:00:39 +00001455}
1456
1457void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
Justin Lebared4f1722016-07-27 22:04:24 +00001458 // Naked functions have no prolog.
1459 if (CGF.CurFuncDecl && CGF.CurFuncDecl->hasAttr<NakedAttr>())
1460 return;
1461
Reid Kleckner06239e42017-11-16 19:09:36 +00001462 // Overridden virtual methods of non-primary bases need to adjust the incoming
1463 // 'this' pointer in the prologue. In this hierarchy, C::b will subtract
1464 // sizeof(void*) to adjust from B* to C*:
1465 // struct A { virtual void a(); };
1466 // struct B { virtual void b(); };
1467 // struct C : A, B { virtual void b(); };
1468 //
1469 // Leave the value stored in the 'this' alloca unadjusted, so that the
1470 // debugger sees the unadjusted value. Microsoft debuggers require this, and
1471 // will apply the ThisAdjustment in the method type information.
1472 // FIXME: Do something better for DWARF debuggers, which won't expect this,
1473 // without making our codegen depend on debug info settings.
1474 llvm::Value *This = loadIncomingCXXThis(CGF);
1475 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1476 if (!CGF.CurFuncIsThunk && MD->isVirtual()) {
1477 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(CGF.CurGD);
1478 if (!Adjustment.isZero()) {
1479 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1480 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1481 *thisTy = This->getType();
1482 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1483 assert(Adjustment.isPositive());
1484 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
1485 -Adjustment.getQuantity());
1486 This = CGF.Builder.CreateBitCast(This, thisTy, "this.adjusted");
1487 }
1488 }
1489 setCXXABIThisValue(CGF, This);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001490
Reid Kleckner06239e42017-11-16 19:09:36 +00001491 // If this is a function that the ABI specifies returns 'this', initialize
1492 // the return slot to 'this' at the start of the function.
1493 //
1494 // Unlike the setting of return types, this is done within the ABI
1495 // implementation instead of by clients of CGCXXABI because:
1496 // 1) getThisValue is currently protected
1497 // 2) in theory, an ABI could implement 'this' returns some other way;
1498 // HasThisReturn only specifies a contract, not the implementation
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001499 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001500 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001501 else if (hasMostDerivedReturn(CGF.CurGD))
1502 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1503 CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001504
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001505 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1506 assert(getStructorImplicitParamDecl(CGF) &&
1507 "no implicit parameter for a constructor with virtual bases?");
1508 getStructorImplicitParamValue(CGF)
1509 = CGF.Builder.CreateLoad(
1510 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1511 "is_most_derived");
1512 }
1513
David Majnemer0c0b6d92014-10-31 20:09:12 +00001514 if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001515 assert(getStructorImplicitParamDecl(CGF) &&
1516 "no implicit parameter for a deleting destructor?");
1517 getStructorImplicitParamValue(CGF)
1518 = CGF.Builder.CreateLoad(
1519 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1520 "should_call_delete");
1521 }
John McCall0f999f32012-09-25 08:00:39 +00001522}
1523
George Burgess IVf203dbf2017-02-22 20:28:02 +00001524CGCXXABI::AddedStructorArgs MicrosoftCXXABI::addImplicitConstructorArgs(
Reid Kleckner89077a12013-12-17 19:46:40 +00001525 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1526 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001527 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001528
Reid Kleckner89077a12013-12-17 19:46:40 +00001529 // Check if we need a 'most_derived' parameter.
1530 if (!D->getParent()->getNumVBases())
George Burgess IVf203dbf2017-02-22 20:28:02 +00001531 return AddedStructorArgs{};
Reid Kleckner89077a12013-12-17 19:46:40 +00001532
1533 // Add the 'most_derived' argument second if we are variadic or last if not.
1534 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
David Majnemer833b91e2016-05-13 20:05:09 +00001535 llvm::Value *MostDerivedArg;
1536 if (Delegating) {
1537 MostDerivedArg = getStructorImplicitParamValue(CGF);
1538 } else {
1539 MostDerivedArg = llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001540 }
David Majnemer833b91e2016-05-13 20:05:09 +00001541 RValue RV = RValue::get(MostDerivedArg);
George Burgess IVf203dbf2017-02-22 20:28:02 +00001542 if (FPT->isVariadic()) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001543 Args.insert(Args.begin() + 1, CallArg(RV, getContext().IntTy));
George Burgess IVf203dbf2017-02-22 20:28:02 +00001544 return AddedStructorArgs::prefix(1);
1545 }
1546 Args.add(RV, getContext().IntTy);
1547 return AddedStructorArgs::suffix(1);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001548}
1549
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001550void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1551 const CXXDestructorDecl *DD,
1552 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +00001553 bool Delegating, Address This) {
Reid Klecknerae9b0702018-03-16 19:40:50 +00001554 // Use the base destructor variant in place of the complete destructor variant
1555 // if the class has no virtual bases. This effectively implements some of the
1556 // -mconstructor-aliases optimization, but as part of the MS C++ ABI.
1557 if (Type == Dtor_Complete && DD->getParent()->getNumVBases() == 0)
1558 Type = Dtor_Base;
1559
John McCallb92ab1a2016-10-26 23:46:34 +00001560 CGCallee Callee = CGCallee::forDirect(
1561 CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type)),
1562 DD);
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001563
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001564 if (DD->isVirtual()) {
1565 assert(Type != CXXDtorType::Dtor_Deleting &&
1566 "The deleting destructor should only be called via a virtual call");
1567 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1568 This, false);
1569 }
Erich Keane13c7ec52016-12-07 00:21:45 +00001570
1571 llvm::BasicBlock *BaseDtorEndBB = nullptr;
1572 if (ForVirtualBase && isa<CXXConstructorDecl>(CGF.CurCodeDecl)) {
1573 BaseDtorEndBB = EmitDtorCompleteObjectHandler(CGF);
1574 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001575
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001576 CGF.EmitCXXDestructorCall(DD, Callee, This.getPointer(),
1577 /*ImplicitParam=*/nullptr,
1578 /*ImplicitParamTy=*/QualType(), nullptr,
1579 getFromDtorType(Type));
Erich Keane13c7ec52016-12-07 00:21:45 +00001580 if (BaseDtorEndBB) {
1581 // Complete object handler should continue to be the remaining
1582 CGF.Builder.CreateBr(BaseDtorEndBB);
1583 CGF.EmitBlock(BaseDtorEndBB);
1584 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001585}
1586
Justin Lebar562914e2016-10-10 16:26:29 +00001587void MicrosoftCXXABI::emitVTableTypeMetadata(const VPtrInfo &Info,
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001588 const CXXRecordDecl *RD,
1589 llvm::GlobalVariable *VTable) {
Peter Collingbourne1e1475a2017-01-18 23:55:27 +00001590 if (!CGM.getCodeGenOpts().LTOUnit)
Peter Collingbourned9546012015-06-19 02:30:43 +00001591 return;
1592
Peter Collingbournee5706442015-07-09 19:56:14 +00001593 // The location of the first virtual function pointer in the virtual table,
1594 // aka the "address point" on Itanium. This is at offset 0 if RTTI is
1595 // disabled, or sizeof(void*) if RTTI is enabled.
1596 CharUnits AddressPoint =
1597 getContext().getLangOpts().RTTIData
1598 ? getContext().toCharUnitsFromBits(
1599 getContext().getTargetInfo().getPointerWidth(0))
1600 : CharUnits::Zero();
Peter Collingbourned9546012015-06-19 02:30:43 +00001601
Justin Lebar562914e2016-10-10 16:26:29 +00001602 if (Info.PathToIntroducingObject.empty()) {
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001603 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001604 return;
1605 }
1606
1607 // Add a bitset entry for the least derived base belonging to this vftable.
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001608 CGM.AddVTableTypeMetadata(VTable, AddressPoint,
Justin Lebar562914e2016-10-10 16:26:29 +00001609 Info.PathToIntroducingObject.back());
Peter Collingbourned9546012015-06-19 02:30:43 +00001610
1611 // Add a bitset entry for each derived class that is laid out at the same
1612 // offset as the least derived base.
Justin Lebar562914e2016-10-10 16:26:29 +00001613 for (unsigned I = Info.PathToIntroducingObject.size() - 1; I != 0; --I) {
1614 const CXXRecordDecl *DerivedRD = Info.PathToIntroducingObject[I - 1];
1615 const CXXRecordDecl *BaseRD = Info.PathToIntroducingObject[I];
Peter Collingbourned9546012015-06-19 02:30:43 +00001616
1617 const ASTRecordLayout &Layout =
1618 getContext().getASTRecordLayout(DerivedRD);
1619 CharUnits Offset;
1620 auto VBI = Layout.getVBaseOffsetsMap().find(BaseRD);
1621 if (VBI == Layout.getVBaseOffsetsMap().end())
1622 Offset = Layout.getBaseClassOffset(BaseRD);
1623 else
1624 Offset = VBI->second.VBaseOffset;
1625 if (!Offset.isZero())
1626 return;
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001627 CGM.AddVTableTypeMetadata(VTable, AddressPoint, DerivedRD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001628 }
1629
1630 // Finally do the same for the most derived class.
Justin Lebar562914e2016-10-10 16:26:29 +00001631 if (Info.FullOffsetInMDC.isZero())
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001632 CGM.AddVTableTypeMetadata(VTable, AddressPoint, RD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001633}
1634
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001635void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1636 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001637 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001638 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001639
Justin Lebar562914e2016-10-10 16:26:29 +00001640 for (const std::unique_ptr<VPtrInfo>& Info : VFPtrs) {
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001641 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001642 if (VTable->hasInitializer())
1643 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001644
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001645 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001646 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
David Majnemer470ee612016-02-09 17:27:52 +00001647
1648 llvm::Constant *RTTI = nullptr;
1649 if (any_of(VTLayout.vtable_components(),
1650 [](const VTableComponent &VTC) { return VTC.isRTTIKind(); }))
Justin Lebar562914e2016-10-10 16:26:29 +00001651 RTTI = getMSCompleteObjectLocator(RD, *Info);
David Majnemer470ee612016-02-09 17:27:52 +00001652
John McCall9c6cb762016-11-28 22:18:33 +00001653 ConstantInitBuilder Builder(CGM);
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001654 auto Components = Builder.beginStruct();
John McCall9c6cb762016-11-28 22:18:33 +00001655 CGVT.createVTableInitializer(Components, VTLayout, RTTI);
1656 Components.finishAndSetAsInitializer(VTable);
Peter Collingbourned9546012015-06-19 02:30:43 +00001657
Justin Lebar562914e2016-10-10 16:26:29 +00001658 emitVTableTypeMetadata(*Info, RD, VTable);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001659 }
1660}
1661
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001662bool MicrosoftCXXABI::isVirtualOffsetNeededForVTableField(
1663 CodeGenFunction &CGF, CodeGenFunction::VPtr Vptr) {
1664 return Vptr.NearestVBase != nullptr;
1665}
1666
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001667llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1668 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001669 const CXXRecordDecl *NearestVBase) {
1670 llvm::Constant *VTableAddressPoint = getVTableAddressPoint(Base, VTableClass);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001671 if (!VTableAddressPoint) {
1672 assert(Base.getBase()->getNumVBases() &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001673 !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001674 }
1675 return VTableAddressPoint;
1676}
1677
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001678static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Justin Lebar562914e2016-10-10 16:26:29 +00001679 const CXXRecordDecl *RD, const VPtrInfo &VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001680 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001681 llvm::raw_svector_ostream Out(Name);
Justin Lebar562914e2016-10-10 16:26:29 +00001682 MangleContext.mangleCXXVFTable(RD, VFPtr.MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001683}
1684
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001685llvm::Constant *
1686MicrosoftCXXABI::getVTableAddressPoint(BaseSubobject Base,
1687 const CXXRecordDecl *VTableClass) {
Piotr Padlewski4bed31b2015-09-10 20:18:30 +00001688 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1689 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001690 return VFTablesMap[ID];
1691}
1692
1693llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1694 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1695 llvm::Constant *VFTable = getVTableAddressPoint(Base, VTableClass);
David Majnemerd905da42014-07-01 20:30:31 +00001696 assert(VFTable && "Couldn't find a vftable for the given base?");
1697 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001698}
1699
1700llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1701 CharUnits VPtrOffset) {
1702 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1703 // shouldn't be used in the given record type. We want to cache this result in
1704 // VFTablesMap, thus a simple zero check is not sufficient.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001705
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001706 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001707 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001708 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001709 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001710 if (!Inserted)
1711 return I->second;
1712
1713 llvm::GlobalVariable *&VTable = I->second;
1714
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001715 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001716 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001717
David Blaikie82e95a32014-11-19 07:49:47 +00001718 if (DeferredVFTables.insert(RD).second) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001719 // We haven't processed this record type before.
Eric Christopherd160c502016-01-29 01:35:53 +00001720 // Queue up this vtable for possible deferred emission.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001721 CGM.addDeferredVTable(RD);
1722
1723#ifndef NDEBUG
1724 // Create all the vftables at once in order to make sure each vftable has
1725 // a unique mangled name.
1726 llvm::StringSet<> ObservedMangledNames;
1727 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1728 SmallString<256> Name;
Justin Lebar562914e2016-10-10 16:26:29 +00001729 mangleVFTableName(getMangleContext(), RD, *VFPtrs[J], Name);
David Blaikie61b86d42014-11-19 02:56:13 +00001730 if (!ObservedMangledNames.insert(Name.str()).second)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001731 llvm_unreachable("Already saw this mangling before?");
1732 }
1733#endif
1734 }
1735
Justin Lebar562914e2016-10-10 16:26:29 +00001736 const std::unique_ptr<VPtrInfo> *VFPtrI = std::find_if(
1737 VFPtrs.begin(), VFPtrs.end(), [&](const std::unique_ptr<VPtrInfo>& VPI) {
David Majnemera03849b2015-03-18 22:04:43 +00001738 return VPI->FullOffsetInMDC == VPtrOffset;
1739 });
1740 if (VFPtrI == VFPtrs.end()) {
1741 VFTablesMap[ID] = nullptr;
1742 return nullptr;
1743 }
Justin Lebar562914e2016-10-10 16:26:29 +00001744 const std::unique_ptr<VPtrInfo> &VFPtr = *VFPtrI;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001745
David Majnemera03849b2015-03-18 22:04:43 +00001746 SmallString<256> VFTableName;
Justin Lebar562914e2016-10-10 16:26:29 +00001747 mangleVFTableName(getMangleContext(), RD, *VFPtr, VFTableName);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001748
David Majnemer2d8b2002016-02-11 17:49:28 +00001749 // Classes marked __declspec(dllimport) need vftables generated on the
1750 // import-side in order to support features like constexpr. No other
1751 // translation unit relies on the emission of the local vftable, translation
1752 // units are expected to generate them as needed.
1753 //
1754 // Because of this unique behavior, we maintain this logic here instead of
1755 // getVTableLinkage.
1756 llvm::GlobalValue::LinkageTypes VFTableLinkage =
1757 RD->hasAttr<DLLImportAttr>() ? llvm::GlobalValue::LinkOnceODRLinkage
1758 : CGM.getVTableLinkage(RD);
David Majnemera03849b2015-03-18 22:04:43 +00001759 bool VFTableComesFromAnotherTU =
1760 llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) ||
1761 llvm::GlobalValue::isExternalLinkage(VFTableLinkage);
1762 bool VTableAliasIsRequred =
1763 !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData;
David Majnemerbb848712014-07-01 22:37:08 +00001764
David Majnemera03849b2015-03-18 22:04:43 +00001765 if (llvm::GlobalValue *VFTable =
1766 CGM.getModule().getNamedGlobal(VFTableName)) {
1767 VFTablesMap[ID] = VFTable;
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001768 VTable = VTableAliasIsRequred
1769 ? cast<llvm::GlobalVariable>(
1770 cast<llvm::GlobalAlias>(VFTable)->getBaseObject())
1771 : cast<llvm::GlobalVariable>(VFTable);
1772 return VTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001773 }
1774
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001775 const VTableLayout &VTLayout =
1776 VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC);
David Majnemera03849b2015-03-18 22:04:43 +00001777 llvm::GlobalValue::LinkageTypes VTableLinkage =
1778 VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage;
1779
1780 StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str();
1781
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001782 llvm::Type *VTableType = CGM.getVTables().getVTableType(VTLayout);
David Majnemera03849b2015-03-18 22:04:43 +00001783
1784 // Create a backing variable for the contents of VTable. The VTable may
1785 // or may not include space for a pointer to RTTI data.
1786 llvm::GlobalValue *VFTable;
1787 VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType,
1788 /*isConstant=*/true, VTableLinkage,
1789 /*Initializer=*/nullptr, VTableName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001790 VTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001791
1792 llvm::Comdat *C = nullptr;
1793 if (!VFTableComesFromAnotherTU &&
1794 (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) ||
1795 (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) &&
1796 VTableAliasIsRequred)))
1797 C = CGM.getModule().getOrInsertComdat(VFTableName.str());
1798
1799 // Only insert a pointer into the VFTable for RTTI data if we are not
1800 // importing it. We never reference the RTTI data directly so there is no
1801 // need to make room for it.
1802 if (VTableAliasIsRequred) {
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001803 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.Int32Ty, 0),
1804 llvm::ConstantInt::get(CGM.Int32Ty, 0),
1805 llvm::ConstantInt::get(CGM.Int32Ty, 1)};
David Majnemera03849b2015-03-18 22:04:43 +00001806 // Create a GEP which points just after the first entry in the VFTable,
1807 // this should be the location of the first virtual method.
David Blaikiee3b172a2015-04-02 18:55:21 +00001808 llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr(
1809 VTable->getValueType(), VTable, GEPIndices);
David Majnemera03849b2015-03-18 22:04:43 +00001810 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) {
1811 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1812 if (C)
1813 C->setSelectionKind(llvm::Comdat::Largest);
1814 }
David Blaikie2a791d72015-09-14 18:38:22 +00001815 VFTable = llvm::GlobalAlias::create(CGM.Int8PtrTy,
1816 /*AddressSpace=*/0, VFTableLinkage,
1817 VFTableName.str(), VTableGEP,
1818 &CGM.getModule());
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001819 VFTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemera03849b2015-03-18 22:04:43 +00001820 } else {
1821 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1822 // be referencing any RTTI data.
1823 // The GlobalVariable will end up being an appropriate definition of the
1824 // VFTable.
1825 VFTable = VTable;
1826 }
1827 if (C)
1828 VTable->setComdat(C);
1829
David Majnemer2d8b2002016-02-11 17:49:28 +00001830 if (RD->hasAttr<DLLExportAttr>())
David Majnemera03849b2015-03-18 22:04:43 +00001831 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1832
1833 VFTablesMap[ID] = VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001834 return VTable;
1835}
1836
John McCall9831b842018-02-06 18:52:44 +00001837CGCallee MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1838 GlobalDecl GD,
1839 Address This,
1840 llvm::Type *Ty,
1841 SourceLocation Loc) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001842 GD = GD.getCanonicalDecl();
1843 CGBuilderTy &Builder = CGF.Builder;
1844
1845 Ty = Ty->getPointerTo()->getPointerTo();
John McCall7f416cc2015-09-08 08:05:57 +00001846 Address VPtr =
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001847 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001848
1849 auto *MethodDecl = cast<CXXMethodDecl>(GD.getDecl());
1850 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty, MethodDecl->getParent());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001851
David Majnemer07c915e2016-10-27 17:11:51 +00001852 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Reid Klecknercbec0262018-04-02 20:00:39 +00001853 MethodVFTableLocation ML = VFTContext.getMethodVFTableLocation(GD);
David Majnemer07c915e2016-10-27 17:11:51 +00001854
1855 // Compute the identity of the most derived class whose virtual table is
1856 // located at the MethodVFTableLocation ML.
1857 auto getObjectWithVPtr = [&] {
1858 return llvm::find_if(VFTContext.getVFPtrOffsets(
1859 ML.VBase ? ML.VBase : MethodDecl->getParent()),
1860 [&](const std::unique_ptr<VPtrInfo> &Info) {
1861 return Info->FullOffsetInMDC == ML.VFPtrOffset;
1862 })
1863 ->get()
1864 ->ObjectWithVPtr;
1865 };
Peter Collingbourned9546012015-06-19 02:30:43 +00001866
John McCall9831b842018-02-06 18:52:44 +00001867 llvm::Value *VFunc;
1868 if (CGF.ShouldEmitVTableTypeCheckedLoad(MethodDecl->getParent())) {
1869 VFunc = CGF.EmitVTableTypeCheckedLoad(
David Majnemer07c915e2016-10-27 17:11:51 +00001870 getObjectWithVPtr(), VTable,
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001871 ML.Index * CGM.getContext().getTargetInfo().getPointerWidth(0) / 8);
John McCall9831b842018-02-06 18:52:44 +00001872 } else {
1873 if (CGM.getCodeGenOpts().PrepareForLTO)
1874 CGF.EmitTypeMetadataCodeForVCall(getObjectWithVPtr(), VTable, Loc);
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001875
John McCall9831b842018-02-06 18:52:44 +00001876 llvm::Value *VFuncPtr =
1877 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1878 VFunc = Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
1879 }
John McCallb92ab1a2016-10-26 23:46:34 +00001880
John McCall9831b842018-02-06 18:52:44 +00001881 CGCallee Callee(MethodDecl, VFunc);
1882 return Callee;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001883}
1884
David Majnemer0c0b6d92014-10-31 20:09:12 +00001885llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1886 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +00001887 Address This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001888 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001889 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1890
1891 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001892 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001893 GlobalDecl GD(Dtor, Dtor_Deleting);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001894 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1895 Dtor, StructorType::Deleting);
George Burgess IV00f70bd2018-03-01 05:43:23 +00001896 llvm::FunctionType *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Peter Collingbourneea211002018-02-05 23:09:13 +00001897 CGCallee Callee = CGCallee::forVirtual(CE, GD, This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001898
David Majnemer9ced3dd2015-03-14 23:44:48 +00001899 ASTContext &Context = getContext();
Nico Weber0a029922015-01-12 21:24:10 +00001900 llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1901 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1902 DtorType == Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001903
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001904 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +00001905 RValue RV =
1906 CGF.EmitCXXDestructorCall(Dtor, Callee, This.getPointer(), ImplicitParam,
1907 Context.IntTy, CE, StructorType::Deleting);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001908 return RV.getScalarVal();
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001909}
1910
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001911const VBTableGlobals &
1912MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001913 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001914 // easier than caching each vbtable individually.
1915 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1916 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001917 std::tie(Entry, Added) =
1918 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001919 VBTableGlobals &VBGlobals = Entry->second;
1920 if (!Added)
1921 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001922
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001923 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1924 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001925
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001926 // Cache the globals for all vbtables so we don't have to recompute the
1927 // mangled names.
1928 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001929 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1930 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001931 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001932 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001933 }
1934
1935 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001936}
1937
Reid Klecknercbec0262018-04-02 20:00:39 +00001938llvm::Function *
1939MicrosoftCXXABI::EmitVirtualMemPtrThunk(const CXXMethodDecl *MD,
1940 const MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001941 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1942 "can't form pointers to ctors or virtual dtors");
1943
Reid Klecknere4a52202014-02-21 02:27:32 +00001944 // Calculate the mangled name.
1945 SmallString<256> ThunkName;
1946 llvm::raw_svector_ostream Out(ThunkName);
Reid Klecknercbec0262018-04-02 20:00:39 +00001947 getMangleContext().mangleVirtualMemPtrThunk(MD, ML, Out);
Reid Klecknere4a52202014-02-21 02:27:32 +00001948
Hans Wennborg88497d62013-11-15 17:24:45 +00001949 // If the thunk has been generated previously, just return it.
1950 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1951 return cast<llvm::Function>(GV);
1952
1953 // Create the llvm::Function.
Reid Kleckner399d96e2018-04-02 20:20:33 +00001954 const CGFunctionInfo &FnInfo =
1955 CGM.getTypes().arrangeUnprototypedMustTailThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00001956 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1957 llvm::Function *ThunkFn =
1958 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1959 ThunkName.str(), &CGM.getModule());
1960 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1961
Hans Wennborg88497d62013-11-15 17:24:45 +00001962 ThunkFn->setLinkage(MD->isExternallyVisible()
1963 ? llvm::GlobalValue::LinkOnceODRLinkage
1964 : llvm::GlobalValue::InternalLinkage);
David Majnemer8c9cdb62015-01-21 01:21:31 +00001965 if (MD->isExternallyVisible())
1966 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
Hans Wennborg88497d62013-11-15 17:24:45 +00001967
1968 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1969 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1970
Reid Kleckner9da94482015-01-21 22:18:17 +00001971 // Add the "thunk" attribute so that LLVM knows that the return type is
1972 // meaningless. These thunks can be used to call functions with differing
1973 // return types, and the caller is required to cast the prototype
1974 // appropriately to extract the correct value.
1975 ThunkFn->addFnAttr("thunk");
1976
Reid Klecknerb9538a62014-08-15 18:12:40 +00001977 // These thunks can be compared, so they are not unnamed.
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001978 ThunkFn->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::None);
Reid Klecknerb9538a62014-08-15 18:12:40 +00001979
Hans Wennborg88497d62013-11-15 17:24:45 +00001980 // Start codegen.
1981 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00001982 CGF.CurGD = GlobalDecl(MD);
1983 CGF.CurFuncIsThunk = true;
1984
1985 // Build FunctionArgs, but only include the implicit 'this' parameter
1986 // declaration.
1987 FunctionArgList FunctionArgs;
1988 buildThisParam(CGF, FunctionArgs);
1989
1990 // Start defining the function.
1991 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
1992 FunctionArgs, MD->getLocation(), SourceLocation());
Reid Kleckner06239e42017-11-16 19:09:36 +00001993 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
Hans Wennborg88497d62013-11-15 17:24:45 +00001994
Reid Klecknere4a52202014-02-21 02:27:32 +00001995 // Load the vfptr and then callee from the vftable. The callee should have
1996 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00001997 llvm::Value *VTable = CGF.GetVTablePtr(
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001998 getThisAddress(CGF), ThunkTy->getPointerTo()->getPointerTo(), MD->getParent());
1999
Reid Klecknere4a52202014-02-21 02:27:32 +00002000 llvm::Value *VFuncPtr =
2001 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
John McCall7f416cc2015-09-08 08:05:57 +00002002 llvm::Value *Callee =
2003 CGF.Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
Hans Wennborg88497d62013-11-15 17:24:45 +00002004
Reid Klecknerc3473512014-08-29 21:43:29 +00002005 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee);
Hans Wennborg88497d62013-11-15 17:24:45 +00002006
2007 return ThunkFn;
2008}
2009
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002010void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002011 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
2012 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Justin Lebar562914e2016-10-10 16:26:29 +00002013 const std::unique_ptr<VPtrInfo>& VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002014 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
David Majnemer129f4172015-02-02 10:22:20 +00002015 if (GV->isDeclaration())
2016 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00002017 }
2018}
2019
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002020llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002021MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002022 llvm::GlobalVariable::LinkageTypes Linkage) {
2023 SmallString<256> OutName;
2024 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00002025 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002026 StringRef Name = OutName.str();
2027
2028 llvm::ArrayType *VBTableType =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002029 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ObjectWithVPtr->getNumVBases());
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002030
2031 assert(!CGM.getModule().getNamedGlobal(Name) &&
2032 "vbtable with this name already exists: mangling bug?");
2033 llvm::GlobalVariable *GV =
2034 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00002035 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Hans Wennborg853ae942014-05-30 16:59:42 +00002036
2037 if (RD->hasAttr<DLLImportAttr>())
2038 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
2039 else if (RD->hasAttr<DLLExportAttr>())
2040 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
2041
David Majnemer129f4172015-02-02 10:22:20 +00002042 if (!GV->hasExternalLinkage())
2043 emitVBTableDefinition(VBT, RD, GV);
2044
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002045 return GV;
2046}
2047
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002048void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002049 const CXXRecordDecl *RD,
2050 llvm::GlobalVariable *GV) const {
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002051 const CXXRecordDecl *ObjectWithVPtr = VBT.ObjectWithVPtr;
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002052
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002053 assert(RD->getNumVBases() && ObjectWithVPtr->getNumVBases() &&
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002054 "should only emit vbtables for classes with vbtables");
2055
2056 const ASTRecordLayout &BaseLayout =
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002057 getContext().getASTRecordLayout(VBT.IntroducingObject);
David Majnemer9ced3dd2015-03-14 23:44:48 +00002058 const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002059
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002060 SmallVector<llvm::Constant *, 4> Offsets(1 + ObjectWithVPtr->getNumVBases(),
Craig Topper8a13c412014-05-21 05:09:00 +00002061 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002062
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002063 // The offset from ObjectWithVPtr's vbptr to itself always leads.
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002064 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
2065 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
2066
2067 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002068 for (const auto &I : ObjectWithVPtr->vbases()) {
Aaron Ballman445a9392014-03-13 16:15:17 +00002069 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002070 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
2071 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00002072
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002073 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00002074 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002075 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00002076 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00002077 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00002078 Offset -= CompleteVBPtrOffset;
2079
Reid Kleckner8ad06d62016-07-20 14:40:25 +00002080 unsigned VBIndex = Context.getVBTableIndex(ObjectWithVPtr, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00002081 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002082 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
2083 }
2084
2085 assert(Offsets.size() ==
2086 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
2087 ->getElementType())->getNumElements());
2088 llvm::ArrayType *VBTableType =
2089 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
2090 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
2091 GV->setInitializer(Init);
David Majnemer46e39cc2016-02-22 17:22:08 +00002092
2093 if (RD->hasAttr<DLLImportAttr>())
2094 GV->setLinkage(llvm::GlobalVariable::AvailableExternallyLinkage);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00002095}
2096
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002097llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002098 Address This,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002099 const ThisAdjustment &TA) {
2100 if (TA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002101 return This.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002102
John McCall7f416cc2015-09-08 08:05:57 +00002103 This = CGF.Builder.CreateElementBitCast(This, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002104
John McCall7f416cc2015-09-08 08:05:57 +00002105 llvm::Value *V;
2106 if (TA.Virtual.isEmpty()) {
2107 V = This.getPointer();
2108 } else {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002109 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
2110 // Adjust the this argument based on the vtordisp value.
John McCall7f416cc2015-09-08 08:05:57 +00002111 Address VtorDispPtr =
2112 CGF.Builder.CreateConstInBoundsByteGEP(This,
2113 CharUnits::fromQuantity(TA.Virtual.Microsoft.VtordispOffset));
2114 VtorDispPtr = CGF.Builder.CreateElementBitCast(VtorDispPtr, CGF.Int32Ty);
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002115 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
John McCall7f416cc2015-09-08 08:05:57 +00002116 V = CGF.Builder.CreateGEP(This.getPointer(),
2117 CGF.Builder.CreateNeg(VtorDisp));
2118
2119 // Unfortunately, having applied the vtordisp means that we no
2120 // longer really have a known alignment for the vbptr step.
2121 // We'll assume the vbptr is pointer-aligned.
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002122
2123 if (TA.Virtual.Microsoft.VBPtrOffset) {
2124 // If the final overrider is defined in a virtual base other than the one
2125 // that holds the vfptr, we have to use a vtordispex thunk which looks up
2126 // the vbtable of the derived class.
2127 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
2128 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
2129 llvm::Value *VBPtr;
2130 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002131 GetVBaseOffsetFromVBPtr(CGF, Address(V, CGF.getPointerAlign()),
2132 -TA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002133 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
2134 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2135 }
2136 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002137
2138 if (TA.NonVirtual) {
2139 // Non-virtual adjustment might result in a pointer outside the allocated
2140 // object, e.g. if the final overrider class is laid out after the virtual
2141 // base that declares a method in the most derived class.
2142 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
2143 }
2144
2145 // Don't need to bitcast back, the call CodeGen will handle this.
2146 return V;
2147}
2148
2149llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00002150MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002151 const ReturnAdjustment &RA) {
2152 if (RA.isEmpty())
John McCall7f416cc2015-09-08 08:05:57 +00002153 return Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002154
John McCall7f416cc2015-09-08 08:05:57 +00002155 auto OrigTy = Ret.getType();
2156 Ret = CGF.Builder.CreateElementBitCast(Ret, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002157
John McCall7f416cc2015-09-08 08:05:57 +00002158 llvm::Value *V = Ret.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002159 if (RA.Virtual.Microsoft.VBIndex) {
2160 assert(RA.Virtual.Microsoft.VBIndex > 0);
John McCall7f416cc2015-09-08 08:05:57 +00002161 int32_t IntSize = CGF.getIntSize().getQuantity();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002162 llvm::Value *VBPtr;
2163 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00002164 GetVBaseOffsetFromVBPtr(CGF, Ret, RA.Virtual.Microsoft.VBPtrOffset,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002165 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
2166 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2167 }
2168
2169 if (RA.NonVirtual)
David Blaikiefb901c7a2015-04-04 15:12:29 +00002170 V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002171
2172 // Cast back to the original type.
John McCall7f416cc2015-09-08 08:05:57 +00002173 return CGF.Builder.CreateBitCast(V, OrigTy);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002174}
2175
John McCallb91cd662012-05-01 05:23:51 +00002176bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
2177 QualType elementType) {
2178 // Microsoft seems to completely ignore the possibility of a
2179 // two-argument usual deallocation function.
2180 return elementType.isDestructedType();
2181}
2182
2183bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
2184 // Microsoft seems to completely ignore the possibility of a
2185 // two-argument usual deallocation function.
2186 return expr->getAllocatedType().isDestructedType();
2187}
2188
2189CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
2190 // The array cookie is always a size_t; we then pad that out to the
2191 // alignment of the element type.
2192 ASTContext &Ctx = getContext();
2193 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
2194 Ctx.getTypeAlignInChars(type));
2195}
2196
2197llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002198 Address allocPtr,
John McCallb91cd662012-05-01 05:23:51 +00002199 CharUnits cookieSize) {
John McCall7f416cc2015-09-08 08:05:57 +00002200 Address numElementsPtr =
2201 CGF.Builder.CreateElementBitCast(allocPtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002202 return CGF.Builder.CreateLoad(numElementsPtr);
2203}
2204
John McCall7f416cc2015-09-08 08:05:57 +00002205Address MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
2206 Address newPtr,
2207 llvm::Value *numElements,
2208 const CXXNewExpr *expr,
2209 QualType elementType) {
John McCallb91cd662012-05-01 05:23:51 +00002210 assert(requiresArrayCookie(expr));
2211
2212 // The size of the cookie.
2213 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
2214
2215 // Compute an offset to the cookie.
John McCall7f416cc2015-09-08 08:05:57 +00002216 Address cookiePtr = newPtr;
John McCallb91cd662012-05-01 05:23:51 +00002217
2218 // Write the number of elements into the appropriate slot.
John McCall7f416cc2015-09-08 08:05:57 +00002219 Address numElementsPtr
2220 = CGF.Builder.CreateElementBitCast(cookiePtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00002221 CGF.Builder.CreateStore(numElements, numElementsPtr);
2222
2223 // Finally, compute a pointer to the actual data buffer by skipping
2224 // over the cookie completely.
John McCall7f416cc2015-09-08 08:05:57 +00002225 return CGF.Builder.CreateConstInBoundsByteGEP(newPtr, cookieSize);
John McCallb91cd662012-05-01 05:23:51 +00002226}
2227
David Majnemerb3341ea2014-10-05 05:05:40 +00002228static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
2229 llvm::Constant *Dtor,
2230 llvm::Constant *Addr) {
2231 // Create a function which calls the destructor.
2232 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
2233
2234 // extern "C" int __tlregdtor(void (*f)(void));
2235 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
2236 CGF.IntTy, DtorStub->getType(), /*IsVarArg=*/false);
2237
Reid Klecknerde864822017-03-21 16:57:30 +00002238 llvm::Constant *TLRegDtor = CGF.CGM.CreateRuntimeFunction(
2239 TLRegDtorTy, "__tlregdtor", llvm::AttributeList(), /*Local=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002240 if (llvm::Function *TLRegDtorFn = dyn_cast<llvm::Function>(TLRegDtor))
2241 TLRegDtorFn->setDoesNotThrow();
2242
2243 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
2244}
2245
2246void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
2247 llvm::Constant *Dtor,
2248 llvm::Constant *Addr) {
2249 if (D.getTLSKind())
2250 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
2251
2252 // The default behavior is to use atexit.
2253 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
2254}
2255
2256void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +00002257 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +00002258 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +00002259 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) {
David Majnemercb60a432016-09-12 02:51:43 +00002260 if (CXXThreadLocalInits.empty())
2261 return;
2262
2263 CGM.AppendLinkerOptions(CGM.getTarget().getTriple().getArch() ==
2264 llvm::Triple::x86
2265 ? "/include:___dyn_tls_init@12"
2266 : "/include:__dyn_tls_init");
2267
David Majnemerb3341ea2014-10-05 05:05:40 +00002268 // This will create a GV in the .CRT$XDU section. It will point to our
2269 // initialization function. The CRT will call all of these function
2270 // pointers at start-up time and, eventually, at thread-creation time.
2271 auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
2272 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
2273 CGM.getModule(), InitFunc->getType(), /*IsConstant=*/true,
2274 llvm::GlobalVariable::InternalLinkage, InitFunc,
2275 Twine(InitFunc->getName(), "$initializer$"));
2276 InitFuncPtr->setSection(".CRT$XDU");
2277 // This variable has discardable linkage, we have to add it to @llvm.used to
2278 // ensure it won't get discarded.
2279 CGM.addUsedGlobal(InitFuncPtr);
2280 return InitFuncPtr;
2281 };
2282
2283 std::vector<llvm::Function *> NonComdatInits;
2284 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
Richard Smith5a99c492015-12-01 01:10:48 +00002285 llvm::GlobalVariable *GV = cast<llvm::GlobalVariable>(
2286 CGM.GetGlobalValue(CGM.getMangledName(CXXThreadLocalInitVars[I])));
David Majnemerb3341ea2014-10-05 05:05:40 +00002287 llvm::Function *F = CXXThreadLocalInits[I];
2288
2289 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002290 if (llvm::Comdat *C = GV->getComdat())
David Majnemerb3341ea2014-10-05 05:05:40 +00002291 AddToXDU(F)->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002292 else
David Majnemerb3341ea2014-10-05 05:05:40 +00002293 NonComdatInits.push_back(F);
David Majnemerb3341ea2014-10-05 05:05:40 +00002294 }
2295
2296 if (!NonComdatInits.empty()) {
2297 llvm::FunctionType *FTy =
2298 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002299 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction(
Akira Hatanaka7791f1a42015-10-31 01:28:07 +00002300 FTy, "__tls_init", CGM.getTypes().arrangeNullaryFunction(),
2301 SourceLocation(), /*TLS=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002302 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2303
2304 AddToXDU(InitFunc);
2305 }
2306}
2307
2308LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2309 const VarDecl *VD,
2310 QualType LValType) {
2311 CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2312 return LValue();
2313}
2314
John McCall7f416cc2015-09-08 08:05:57 +00002315static ConstantAddress getInitThreadEpochPtr(CodeGenModule &CGM) {
David Majnemer8354eee2015-05-07 06:15:46 +00002316 StringRef VarName("_Init_thread_epoch");
John McCall7f416cc2015-09-08 08:05:57 +00002317 CharUnits Align = CGM.getIntAlign();
David Majnemer8354eee2015-05-07 06:15:46 +00002318 if (auto *GV = CGM.getModule().getNamedGlobal(VarName))
John McCall7f416cc2015-09-08 08:05:57 +00002319 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002320 auto *GV = new llvm::GlobalVariable(
2321 CGM.getModule(), CGM.IntTy,
2322 /*Constant=*/false, llvm::GlobalVariable::ExternalLinkage,
2323 /*Initializer=*/nullptr, VarName,
2324 /*InsertBefore=*/nullptr, llvm::GlobalVariable::GeneralDynamicTLSModel);
John McCall7f416cc2015-09-08 08:05:57 +00002325 GV->setAlignment(Align.getQuantity());
2326 return ConstantAddress(GV, Align);
David Majnemer8354eee2015-05-07 06:15:46 +00002327}
2328
2329static llvm::Constant *getInitThreadHeaderFn(CodeGenModule &CGM) {
2330 llvm::FunctionType *FTy =
2331 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2332 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2333 return CGM.CreateRuntimeFunction(
2334 FTy, "_Init_thread_header",
Reid Klecknerde864822017-03-21 16:57:30 +00002335 llvm::AttributeList::get(CGM.getLLVMContext(),
2336 llvm::AttributeList::FunctionIndex,
2337 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002338 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002339}
2340
2341static llvm::Constant *getInitThreadFooterFn(CodeGenModule &CGM) {
2342 llvm::FunctionType *FTy =
2343 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2344 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2345 return CGM.CreateRuntimeFunction(
2346 FTy, "_Init_thread_footer",
Reid Klecknerde864822017-03-21 16:57:30 +00002347 llvm::AttributeList::get(CGM.getLLVMContext(),
2348 llvm::AttributeList::FunctionIndex,
2349 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002350 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002351}
2352
2353static llvm::Constant *getInitThreadAbortFn(CodeGenModule &CGM) {
2354 llvm::FunctionType *FTy =
2355 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2356 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2357 return CGM.CreateRuntimeFunction(
2358 FTy, "_Init_thread_abort",
Reid Klecknerde864822017-03-21 16:57:30 +00002359 llvm::AttributeList::get(CGM.getLLVMContext(),
2360 llvm::AttributeList::FunctionIndex,
2361 llvm::Attribute::NoUnwind),
Saleem Abdulrasool6cb07442016-12-15 06:59:05 +00002362 /*Local=*/true);
David Majnemer8354eee2015-05-07 06:15:46 +00002363}
2364
2365namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00002366struct ResetGuardBit final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002367 Address Guard;
David Majnemer8354eee2015-05-07 06:15:46 +00002368 unsigned GuardNum;
John McCall7f416cc2015-09-08 08:05:57 +00002369 ResetGuardBit(Address Guard, unsigned GuardNum)
David Majnemer8354eee2015-05-07 06:15:46 +00002370 : Guard(Guard), GuardNum(GuardNum) {}
2371
2372 void Emit(CodeGenFunction &CGF, Flags flags) override {
2373 // Reset the bit in the mask so that the static variable may be
2374 // reinitialized.
2375 CGBuilderTy &Builder = CGF.Builder;
2376 llvm::LoadInst *LI = Builder.CreateLoad(Guard);
2377 llvm::ConstantInt *Mask =
Reid Klecknerd16cebe2016-02-10 19:09:15 +00002378 llvm::ConstantInt::get(CGF.IntTy, ~(1ULL << GuardNum));
David Majnemer8354eee2015-05-07 06:15:46 +00002379 Builder.CreateStore(Builder.CreateAnd(LI, Mask), Guard);
2380 }
2381};
2382
David Blaikie7e70d682015-08-18 22:40:54 +00002383struct CallInitThreadAbort final : EHScopeStack::Cleanup {
John McCall7f416cc2015-09-08 08:05:57 +00002384 llvm::Value *Guard;
2385 CallInitThreadAbort(Address Guard) : Guard(Guard.getPointer()) {}
David Majnemer8354eee2015-05-07 06:15:46 +00002386
2387 void Emit(CodeGenFunction &CGF, Flags flags) override {
2388 // Calling _Init_thread_abort will reset the guard's state.
2389 CGF.EmitNounwindRuntimeCall(getInitThreadAbortFn(CGF.CGM), Guard);
2390 }
2391};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002392}
David Majnemer8354eee2015-05-07 06:15:46 +00002393
John McCallc84ed6a2012-05-01 06:13:13 +00002394void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00002395 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00002396 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00002397 // MSVC only uses guards for static locals.
2398 if (!D.isStaticLocal()) {
2399 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2400 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
Rafael Espindola77abc3a2015-01-16 16:04:45 +00002401 llvm::Function *F = CGF.CurFn;
2402 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2403 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
Reid Kleckner563f0e82014-05-23 21:13:45 +00002404 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2405 return;
2406 }
2407
David Majnemerec8e54b2015-05-07 21:19:06 +00002408 bool ThreadlocalStatic = D.getTLSKind();
2409 bool ThreadsafeStatic = getContext().getLangOpts().ThreadsafeStatics;
2410
2411 // Thread-safe static variables which aren't thread-specific have a
2412 // per-variable guard.
2413 bool HasPerVariableGuard = ThreadsafeStatic && !ThreadlocalStatic;
Richard Smithdbf74ba2013-04-14 23:01:42 +00002414
Reid Klecknerd8110b62013-09-10 20:14:30 +00002415 CGBuilderTy &Builder = CGF.Builder;
2416 llvm::IntegerType *GuardTy = CGF.Int32Ty;
2417 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
John McCall7f416cc2015-09-08 08:05:57 +00002418 CharUnits GuardAlign = CharUnits::fromQuantity(4);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002419
2420 // Get the guard variable for this function if we have one already.
David Majnemerec8e54b2015-05-07 21:19:06 +00002421 GuardInfo *GI = nullptr;
2422 if (ThreadlocalStatic)
2423 GI = &ThreadLocalGuardVariableMap[D.getDeclContext()];
2424 else if (!ThreadsafeStatic)
2425 GI = &GuardVariableMap[D.getDeclContext()];
2426
2427 llvm::GlobalVariable *GuardVar = GI ? GI->Guard : nullptr;
David Majnemer8354eee2015-05-07 06:15:46 +00002428 unsigned GuardNum;
David Majnemerec8e54b2015-05-07 21:19:06 +00002429 if (D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002430 // Externally visible variables have to be numbered in Sema to properly
2431 // handle unreachable VarDecls.
David Majnemer8354eee2015-05-07 06:15:46 +00002432 GuardNum = getContext().getStaticLocalNumber(&D);
2433 assert(GuardNum > 0);
2434 GuardNum--;
2435 } else if (HasPerVariableGuard) {
2436 GuardNum = ThreadSafeGuardNumMap[D.getDeclContext()]++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002437 } else {
2438 // Non-externally visible variables are numbered here in CodeGen.
David Majnemer8354eee2015-05-07 06:15:46 +00002439 GuardNum = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002440 }
2441
David Majnemer8354eee2015-05-07 06:15:46 +00002442 if (!HasPerVariableGuard && GuardNum >= 32) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002443 if (D.isExternallyVisible())
2444 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
David Majnemer8354eee2015-05-07 06:15:46 +00002445 GuardNum %= 32;
2446 GuardVar = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002447 }
2448
David Majnemer8354eee2015-05-07 06:15:46 +00002449 if (!GuardVar) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002450 // Mangle the name for the guard.
2451 SmallString<256> GuardName;
2452 {
2453 llvm::raw_svector_ostream Out(GuardName);
David Majnemer8354eee2015-05-07 06:15:46 +00002454 if (HasPerVariableGuard)
2455 getMangleContext().mangleThreadSafeStaticGuardVariable(&D, GuardNum,
2456 Out);
2457 else
2458 getMangleContext().mangleStaticGuardVariable(&D, Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002459 }
2460
Hans Wennborgef2272c2014-06-18 15:55:13 +00002461 // Create the guard variable with a zero-initializer. Just absorb linkage,
2462 // visibility and dll storage class from the guarded variable.
David Majnemer8354eee2015-05-07 06:15:46 +00002463 GuardVar =
2464 new llvm::GlobalVariable(CGM.getModule(), GuardTy, /*isConstant=*/false,
Reid Klecknere9591b32014-04-23 18:22:11 +00002465 GV->getLinkage(), Zero, GuardName.str());
David Majnemer8354eee2015-05-07 06:15:46 +00002466 GuardVar->setVisibility(GV->getVisibility());
2467 GuardVar->setDLLStorageClass(GV->getDLLStorageClass());
John McCall7f416cc2015-09-08 08:05:57 +00002468 GuardVar->setAlignment(GuardAlign.getQuantity());
David Majnemer8354eee2015-05-07 06:15:46 +00002469 if (GuardVar->isWeakForLinker())
2470 GuardVar->setComdat(
2471 CGM.getModule().getOrInsertComdat(GuardVar->getName()));
2472 if (D.getTLSKind())
2473 GuardVar->setThreadLocal(true);
2474 if (GI && !HasPerVariableGuard)
2475 GI->Guard = GuardVar;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002476 }
2477
John McCall7f416cc2015-09-08 08:05:57 +00002478 ConstantAddress GuardAddr(GuardVar, GuardAlign);
2479
David Majnemer8354eee2015-05-07 06:15:46 +00002480 assert(GuardVar->getLinkage() == GV->getLinkage() &&
2481 "static local from the same function had different linkage");
Reid Klecknerd8110b62013-09-10 20:14:30 +00002482
David Majnemer8354eee2015-05-07 06:15:46 +00002483 if (!HasPerVariableGuard) {
2484 // Pseudo code for the test:
2485 // if (!(GuardVar & MyGuardBit)) {
2486 // GuardVar |= MyGuardBit;
2487 // ... initialize the object ...;
2488 // }
Reid Klecknerd8110b62013-09-10 20:14:30 +00002489
David Majnemer8354eee2015-05-07 06:15:46 +00002490 // Test our bit from the guard variable.
Aaron Ballmanabd466e2016-03-30 21:33:34 +00002491 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1ULL << GuardNum);
John McCall7f416cc2015-09-08 08:05:57 +00002492 llvm::LoadInst *LI = Builder.CreateLoad(GuardAddr);
Richard Smithae8d62c2017-07-26 22:01:09 +00002493 llvm::Value *NeedsInit =
2494 Builder.CreateICmpEQ(Builder.CreateAnd(LI, Bit), Zero);
David Majnemer8354eee2015-05-07 06:15:46 +00002495 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2496 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002497 CGF.EmitCXXGuardedInitBranch(NeedsInit, InitBlock, EndBlock,
2498 CodeGenFunction::GuardKind::VariableGuard, &D);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002499
David Majnemer8354eee2015-05-07 06:15:46 +00002500 // Set our bit in the guard variable and emit the initializer and add a global
2501 // destructor if appropriate.
2502 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002503 Builder.CreateStore(Builder.CreateOr(LI, Bit), GuardAddr);
2504 CGF.EHStack.pushCleanup<ResetGuardBit>(EHCleanup, GuardAddr, GuardNum);
David Majnemer8354eee2015-05-07 06:15:46 +00002505 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2506 CGF.PopCleanupBlock();
2507 Builder.CreateBr(EndBlock);
2508
2509 // Continue.
2510 CGF.EmitBlock(EndBlock);
2511 } else {
2512 // Pseudo code for the test:
2513 // if (TSS > _Init_thread_epoch) {
2514 // _Init_thread_header(&TSS);
2515 // if (TSS == -1) {
2516 // ... initialize the object ...;
2517 // _Init_thread_footer(&TSS);
2518 // }
2519 // }
2520 //
2521 // The algorithm is almost identical to what can be found in the appendix
2522 // found in N2325.
2523
David Majnemer8354eee2015-05-07 06:15:46 +00002524 // This BasicBLock determines whether or not we have any work to do.
John McCall7f416cc2015-09-08 08:05:57 +00002525 llvm::LoadInst *FirstGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002526 FirstGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2527 llvm::LoadInst *InitThreadEpoch =
2528 Builder.CreateLoad(getInitThreadEpochPtr(CGM));
2529 llvm::Value *IsUninitialized =
2530 Builder.CreateICmpSGT(FirstGuardLoad, InitThreadEpoch);
2531 llvm::BasicBlock *AttemptInitBlock = CGF.createBasicBlock("init.attempt");
2532 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
Richard Smithae8d62c2017-07-26 22:01:09 +00002533 CGF.EmitCXXGuardedInitBranch(IsUninitialized, AttemptInitBlock, EndBlock,
2534 CodeGenFunction::GuardKind::VariableGuard, &D);
David Majnemer8354eee2015-05-07 06:15:46 +00002535
2536 // This BasicBlock attempts to determine whether or not this thread is
2537 // responsible for doing the initialization.
2538 CGF.EmitBlock(AttemptInitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002539 CGF.EmitNounwindRuntimeCall(getInitThreadHeaderFn(CGM),
2540 GuardAddr.getPointer());
2541 llvm::LoadInst *SecondGuardLoad = Builder.CreateLoad(GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002542 SecondGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2543 llvm::Value *ShouldDoInit =
2544 Builder.CreateICmpEQ(SecondGuardLoad, getAllOnesInt());
2545 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2546 Builder.CreateCondBr(ShouldDoInit, InitBlock, EndBlock);
2547
2548 // Ok, we ended up getting selected as the initializing thread.
2549 CGF.EmitBlock(InitBlock);
John McCall7f416cc2015-09-08 08:05:57 +00002550 CGF.EHStack.pushCleanup<CallInitThreadAbort>(EHCleanup, GuardAddr);
David Majnemer8354eee2015-05-07 06:15:46 +00002551 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2552 CGF.PopCleanupBlock();
John McCall7f416cc2015-09-08 08:05:57 +00002553 CGF.EmitNounwindRuntimeCall(getInitThreadFooterFn(CGM),
2554 GuardAddr.getPointer());
David Majnemer8354eee2015-05-07 06:15:46 +00002555 Builder.CreateBr(EndBlock);
2556
2557 CGF.EmitBlock(EndBlock);
2558 }
John McCallc84ed6a2012-05-01 06:13:13 +00002559}
2560
Reid Kleckner2341ae32013-04-11 18:13:19 +00002561bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2562 // Null-ness for function memptrs only depends on the first field, which is
2563 // the function pointer. The rest don't matter, so we can zero initialize.
2564 if (MPT->isMemberFunctionPointer())
2565 return true;
2566
2567 // The virtual base adjustment field is always -1 for null, so if we have one
2568 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
2569 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002570 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2571 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002572 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
2573 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00002574}
2575
2576llvm::Type *
2577MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002578 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2579 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002580 llvm::SmallVector<llvm::Type *, 4> fields;
2581 if (MPT->isMemberFunctionPointer())
2582 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
2583 else
2584 fields.push_back(CGM.IntTy); // FieldOffset
2585
Reid Kleckner96f8f932014-02-05 17:27:08 +00002586 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2587 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002588 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002589 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002590 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002591 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002592 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
2593
2594 if (fields.size() == 1)
2595 return fields[0];
2596 return llvm::StructType::get(CGM.getLLVMContext(), fields);
2597}
2598
2599void MicrosoftCXXABI::
2600GetNullMemberPointerFields(const MemberPointerType *MPT,
2601 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2602 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00002603 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2604 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002605 if (MPT->isMemberFunctionPointer()) {
2606 // FunctionPointerOrVirtualThunk
2607 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2608 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00002609 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00002610 fields.push_back(getZeroInt()); // FieldOffset
2611 else
2612 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00002613 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00002614
Reid Kleckner96f8f932014-02-05 17:27:08 +00002615 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2616 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002617 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002618 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002619 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002620 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002621 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002622}
2623
2624llvm::Constant *
2625MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002626 llvm::SmallVector<llvm::Constant *, 4> fields;
2627 GetNullMemberPointerFields(MPT, fields);
2628 if (fields.size() == 1)
2629 return fields[0];
2630 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2631 assert(Res->getType() == ConvertMemberPointerType(MPT));
2632 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002633}
2634
2635llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002636MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2637 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00002638 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +00002639 CharUnits NonVirtualBaseAdjustment,
2640 unsigned VBTableIndex) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002641 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002642
2643 // Single inheritance class member pointer are represented as scalars instead
2644 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002645 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002646 return FirstField;
2647
Reid Kleckner2341ae32013-04-11 18:13:19 +00002648 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002649 fields.push_back(FirstField);
2650
Reid Kleckner96f8f932014-02-05 17:27:08 +00002651 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002652 fields.push_back(llvm::ConstantInt::get(
2653 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002654
Reid Kleckner96f8f932014-02-05 17:27:08 +00002655 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00002656 CharUnits Offs = CharUnits::Zero();
David Majnemerc1709d32015-06-23 07:31:11 +00002657 if (VBTableIndex)
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002658 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00002659 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00002660 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002661
2662 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002663 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
David Majnemere60813f2015-05-10 21:48:08 +00002664 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, VBTableIndex));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002665
Reid Kleckner2341ae32013-04-11 18:13:19 +00002666 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002667}
2668
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002669llvm::Constant *
2670MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2671 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002672 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerc1709d32015-06-23 07:31:11 +00002673 if (RD->getMSInheritanceModel() ==
2674 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002675 offset -= getContext().getOffsetOfBaseWithVBPtr(RD);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002676 llvm::Constant *FirstField =
2677 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00002678 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002679 CharUnits::Zero(), /*VBTableIndex=*/0);
Reid Kleckner452abac2013-05-09 21:01:17 +00002680}
2681
Reid Kleckner452abac2013-05-09 21:01:17 +00002682llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2683 QualType MPType) {
David Majnemer5ca193c2015-06-23 07:31:07 +00002684 const MemberPointerType *DstTy = MPType->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002685 const ValueDecl *MPD = MP.getMemberPointerDecl();
2686 if (!MPD)
David Majnemer5ca193c2015-06-23 07:31:07 +00002687 return EmitNullMemberPointer(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002688
David Majnemer5ca193c2015-06-23 07:31:07 +00002689 ASTContext &Ctx = getContext();
2690 ArrayRef<const CXXRecordDecl *> MemberPointerPath = MP.getMemberPointerPath();
Reid Kleckner452abac2013-05-09 21:01:17 +00002691
David Majnemer5ca193c2015-06-23 07:31:07 +00002692 llvm::Constant *C;
2693 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) {
2694 C = EmitMemberFunctionPointer(MD);
2695 } else {
2696 CharUnits FieldOffset = Ctx.toCharUnitsFromBits(Ctx.getFieldOffset(MPD));
2697 C = EmitMemberDataPointer(DstTy, FieldOffset);
2698 }
Reid Kleckner452abac2013-05-09 21:01:17 +00002699
David Majnemer5ca193c2015-06-23 07:31:07 +00002700 if (!MemberPointerPath.empty()) {
2701 const CXXRecordDecl *SrcRD = cast<CXXRecordDecl>(MPD->getDeclContext());
2702 const Type *SrcRecTy = Ctx.getTypeDeclType(SrcRD).getTypePtr();
2703 const MemberPointerType *SrcTy =
2704 Ctx.getMemberPointerType(DstTy->getPointeeType(), SrcRecTy)
2705 ->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002706
David Majnemer5ca193c2015-06-23 07:31:07 +00002707 bool DerivedMember = MP.isMemberPointerToDerivedMember();
2708 SmallVector<const CXXBaseSpecifier *, 4> DerivedToBasePath;
2709 const CXXRecordDecl *PrevRD = SrcRD;
2710 for (const CXXRecordDecl *PathElem : MemberPointerPath) {
2711 const CXXRecordDecl *Base = nullptr;
2712 const CXXRecordDecl *Derived = nullptr;
2713 if (DerivedMember) {
2714 Base = PathElem;
2715 Derived = PrevRD;
2716 } else {
2717 Base = PrevRD;
2718 Derived = PathElem;
2719 }
2720 for (const CXXBaseSpecifier &BS : Derived->bases())
2721 if (BS.getType()->getAsCXXRecordDecl()->getCanonicalDecl() ==
2722 Base->getCanonicalDecl())
2723 DerivedToBasePath.push_back(&BS);
2724 PrevRD = PathElem;
2725 }
2726 assert(DerivedToBasePath.size() == MemberPointerPath.size());
2727
2728 CastKind CK = DerivedMember ? CK_DerivedToBaseMemberPointer
2729 : CK_BaseToDerivedMemberPointer;
2730 C = EmitMemberPointerConversion(SrcTy, DstTy, CK, DerivedToBasePath.begin(),
2731 DerivedToBasePath.end(), C);
2732 }
2733 return C;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002734}
2735
2736llvm::Constant *
David Majnemer5ca193c2015-06-23 07:31:07 +00002737MicrosoftCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002738 assert(MD->isInstance() && "Member function must not be static!");
David Majnemer5ca193c2015-06-23 07:31:07 +00002739
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002740 MD = MD->getCanonicalDecl();
David Majnemer5ca193c2015-06-23 07:31:07 +00002741 CharUnits NonVirtualBaseAdjustment = CharUnits::Zero();
2742 const CXXRecordDecl *RD = MD->getParent()->getMostRecentDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002743 CodeGenTypes &Types = CGM.getTypes();
2744
David Majnemere60813f2015-05-10 21:48:08 +00002745 unsigned VBTableIndex = 0;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002746 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00002747 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00002748 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002749 llvm::Type *Ty;
2750 // Check whether the function has a computable LLVM signature.
2751 if (Types.isFuncTypeConvertible(FPT)) {
2752 // The function has a computable LLVM signature; use the correct type.
2753 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2754 } else {
2755 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2756 // function type is incomplete.
2757 Ty = CGM.PtrDiffTy;
2758 }
2759 FirstField = CGM.GetAddrOfFunction(MD, Ty);
Hans Wennborg88497d62013-11-15 17:24:45 +00002760 } else {
David Majnemere0e228a2015-06-11 08:12:44 +00002761 auto &VTableContext = CGM.getMicrosoftVTableContext();
Reid Klecknercbec0262018-04-02 20:00:39 +00002762 MethodVFTableLocation ML = VTableContext.getMethodVFTableLocation(MD);
David Majnemerc1709d32015-06-23 07:31:11 +00002763 FirstField = EmitVirtualMemPtrThunk(MD, ML);
David Majnemere0e228a2015-06-11 08:12:44 +00002764 // Include the vfptr adjustment if the method is in a non-primary vftable.
2765 NonVirtualBaseAdjustment += ML.VFPtrOffset;
2766 if (ML.VBase)
2767 VBTableIndex = VTableContext.getVBTableIndex(RD, ML.VBase) * 4;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002768 }
2769
David Majnemerc1709d32015-06-23 07:31:11 +00002770 if (VBTableIndex == 0 &&
2771 RD->getMSInheritanceModel() ==
2772 MSInheritanceAttr::Keyword_virtual_inheritance)
David Majnemer08ef2ba2015-06-23 20:34:18 +00002773 NonVirtualBaseAdjustment -= getContext().getOffsetOfBaseWithVBPtr(RD);
David Majnemerc1709d32015-06-23 07:31:11 +00002774
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002775 // The rest of the fields are common with data member pointers.
David Majnemerc1709d32015-06-23 07:31:11 +00002776 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002777 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002778 NonVirtualBaseAdjustment, VBTableIndex);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002779}
2780
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002781/// Member pointers are the same if they're either bitwise identical *or* both
2782/// null. Null-ness for function members is determined by the first field,
2783/// while for data member pointers we must compare all fields.
2784llvm::Value *
2785MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2786 llvm::Value *L,
2787 llvm::Value *R,
2788 const MemberPointerType *MPT,
2789 bool Inequality) {
2790 CGBuilderTy &Builder = CGF.Builder;
2791
2792 // Handle != comparisons by switching the sense of all boolean operations.
2793 llvm::ICmpInst::Predicate Eq;
2794 llvm::Instruction::BinaryOps And, Or;
2795 if (Inequality) {
2796 Eq = llvm::ICmpInst::ICMP_NE;
2797 And = llvm::Instruction::Or;
2798 Or = llvm::Instruction::And;
2799 } else {
2800 Eq = llvm::ICmpInst::ICMP_EQ;
2801 And = llvm::Instruction::And;
2802 Or = llvm::Instruction::Or;
2803 }
2804
2805 // If this is a single field member pointer (single inheritance), this is a
2806 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002807 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2808 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002809 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2810 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002811 return Builder.CreateICmp(Eq, L, R);
2812
2813 // Compare the first field.
2814 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2815 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2816 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2817
2818 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002819 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002820 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2821 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2822 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2823 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2824 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2825 if (Res)
2826 Res = Builder.CreateBinOp(And, Res, Cmp);
2827 else
2828 Res = Cmp;
2829 }
2830
2831 // Check if the first field is 0 if this is a function pointer.
2832 if (MPT->isMemberFunctionPointer()) {
2833 // (l1 == r1 && ...) || l0 == 0
2834 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2835 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2836 Res = Builder.CreateBinOp(Or, Res, IsZero);
2837 }
2838
2839 // Combine the comparison of the first field, which must always be true for
2840 // this comparison to succeeed.
2841 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2842}
2843
Reid Kleckner407e8b62013-03-22 19:02:54 +00002844llvm::Value *
2845MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2846 llvm::Value *MemPtr,
2847 const MemberPointerType *MPT) {
2848 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002849 llvm::SmallVector<llvm::Constant *, 4> fields;
2850 // We only need one field for member functions.
2851 if (MPT->isMemberFunctionPointer())
2852 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2853 else
2854 GetNullMemberPointerFields(MPT, fields);
2855 assert(!fields.empty());
2856 llvm::Value *FirstField = MemPtr;
2857 if (MemPtr->getType()->isStructTy())
2858 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2859 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002860
Reid Kleckner2341ae32013-04-11 18:13:19 +00002861 // For function member pointers, we only need to test the function pointer
2862 // field. The other fields if any can be garbage.
2863 if (MPT->isMemberFunctionPointer())
2864 return Res;
2865
2866 // Otherwise, emit a series of compares and combine the results.
2867 for (int I = 1, E = fields.size(); I < E; ++I) {
2868 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2869 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002870 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002871 }
2872 return Res;
2873}
2874
Reid Kleckner452abac2013-05-09 21:01:17 +00002875bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2876 llvm::Constant *Val) {
2877 // Function pointers are null if the pointer in the first field is null.
2878 if (MPT->isMemberFunctionPointer()) {
2879 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2880 Val->getAggregateElement(0U) : Val;
2881 return FirstField->isNullValue();
2882 }
2883
2884 // If it's not a function pointer and it's zero initializable, we can easily
2885 // check zero.
2886 if (isZeroInitializable(MPT) && Val->isNullValue())
2887 return true;
2888
2889 // Otherwise, break down all the fields for comparison. Hopefully these
2890 // little Constants are reused, while a big null struct might not be.
2891 llvm::SmallVector<llvm::Constant *, 4> Fields;
2892 GetNullMemberPointerFields(MPT, Fields);
2893 if (Fields.size() == 1) {
2894 assert(Val->getType()->isIntegerTy());
2895 return Val == Fields[0];
2896 }
2897
2898 unsigned I, E;
2899 for (I = 0, E = Fields.size(); I != E; ++I) {
2900 if (Val->getAggregateElement(I) != Fields[I])
2901 break;
2902 }
2903 return I == E;
2904}
2905
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002906llvm::Value *
2907MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00002908 Address This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002909 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002910 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002911 llvm::Value **VBPtrOut) {
2912 CGBuilderTy &Builder = CGF.Builder;
2913 // Load the vbtable pointer from the vbptr in the instance.
John McCall7f416cc2015-09-08 08:05:57 +00002914 This = Builder.CreateElementBitCast(This, CGM.Int8Ty);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002915 llvm::Value *VBPtr =
John McCall7f416cc2015-09-08 08:05:57 +00002916 Builder.CreateInBoundsGEP(This.getPointer(), VBPtrOffset, "vbptr");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002917 if (VBPtrOut) *VBPtrOut = VBPtr;
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002918 VBPtr = Builder.CreateBitCast(VBPtr,
John McCall7f416cc2015-09-08 08:05:57 +00002919 CGM.Int32Ty->getPointerTo(0)->getPointerTo(This.getAddressSpace()));
2920
2921 CharUnits VBPtrAlign;
2922 if (auto CI = dyn_cast<llvm::ConstantInt>(VBPtrOffset)) {
2923 VBPtrAlign = This.getAlignment().alignmentAtOffset(
2924 CharUnits::fromQuantity(CI->getSExtValue()));
2925 } else {
2926 VBPtrAlign = CGF.getPointerAlign();
2927 }
2928
2929 llvm::Value *VBTable = Builder.CreateAlignedLoad(VBPtr, VBPtrAlign, "vbtable");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002930
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002931 // Translate from byte offset to table index. It improves analyzability.
2932 llvm::Value *VBTableIndex = Builder.CreateAShr(
2933 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
2934 "vbtindex", /*isExact=*/true);
2935
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002936 // Load an i32 offset from the vb-table.
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002937 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002938 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
John McCall7f416cc2015-09-08 08:05:57 +00002939 return Builder.CreateAlignedLoad(VBaseOffs, CharUnits::fromQuantity(4),
2940 "vbase_offs");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002941}
2942
Reid Kleckner2341ae32013-04-11 18:13:19 +00002943// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2944// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002945llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2946 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
John McCall7f416cc2015-09-08 08:05:57 +00002947 Address Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002948 CGBuilderTy &Builder = CGF.Builder;
John McCall7f416cc2015-09-08 08:05:57 +00002949 Base = Builder.CreateElementBitCast(Base, CGM.Int8Ty);
Craig Topper8a13c412014-05-21 05:09:00 +00002950 llvm::BasicBlock *OriginalBB = nullptr;
2951 llvm::BasicBlock *SkipAdjustBB = nullptr;
2952 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002953
2954 // In the unspecified inheritance model, there might not be a vbtable at all,
2955 // in which case we need to skip the virtual base lookup. If there is a
2956 // vbtable, the first entry is a no-op entry that gives back the original
2957 // base, so look for a virtual base adjustment offset of zero.
2958 if (VBPtrOffset) {
2959 OriginalBB = Builder.GetInsertBlock();
2960 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2961 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2962 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002963 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002964 "memptr.is_vbase");
2965 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2966 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002967 }
2968
Reid Kleckner2341ae32013-04-11 18:13:19 +00002969 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
2970 // know the vbptr offset.
2971 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002972 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00002973 if (!RD->hasDefinition()) {
2974 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
2975 unsigned DiagID = Diags.getCustomDiagID(
2976 DiagnosticsEngine::Error,
2977 "member pointer representation requires a "
2978 "complete class type for %0 to perform this expression");
2979 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
2980 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002981 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002982 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
2983 }
Craig Topper8a13c412014-05-21 05:09:00 +00002984 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002985 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002986 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002987 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
2988
2989 // Merge control flow with the case where we didn't have to adjust.
2990 if (VBaseAdjustBB) {
2991 Builder.CreateBr(SkipAdjustBB);
2992 CGF.EmitBlock(SkipAdjustBB);
2993 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
John McCall7f416cc2015-09-08 08:05:57 +00002994 Phi->addIncoming(Base.getPointer(), OriginalBB);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002995 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
2996 return Phi;
2997 }
2998 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002999}
3000
David Majnemer2b0d66d2014-02-20 23:22:07 +00003001llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
John McCall7f416cc2015-09-08 08:05:57 +00003002 CodeGenFunction &CGF, const Expr *E, Address Base, llvm::Value *MemPtr,
David Majnemer2b0d66d2014-02-20 23:22:07 +00003003 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003004 assert(MPT->isMemberDataPointer());
John McCall7f416cc2015-09-08 08:05:57 +00003005 unsigned AS = Base.getAddressSpace();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003006 llvm::Type *PType =
3007 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
3008 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003009 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
3010 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003011
Reid Kleckner2341ae32013-04-11 18:13:19 +00003012 // Extract the fields we need, regardless of model. We'll apply them if we
3013 // have them.
3014 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003015 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3016 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003017 if (MemPtr->getType()->isStructTy()) {
3018 // We need to extract values.
3019 unsigned I = 0;
3020 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003021 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003022 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003023 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003024 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00003025 }
3026
John McCall7f416cc2015-09-08 08:05:57 +00003027 llvm::Value *Addr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003028 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003029 Addr = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00003030 VBPtrOffset);
John McCall7f416cc2015-09-08 08:05:57 +00003031 } else {
3032 Addr = Base.getPointer();
Reid Kleckner407e8b62013-03-22 19:02:54 +00003033 }
Reid Klecknerae945122013-12-05 22:44:07 +00003034
3035 // Cast to char*.
John McCall7f416cc2015-09-08 08:05:57 +00003036 Addr = Builder.CreateBitCast(Addr, CGF.Int8Ty->getPointerTo(AS));
Reid Klecknerae945122013-12-05 22:44:07 +00003037
3038 // Apply the offset, which we assume is non-null.
John McCall7f416cc2015-09-08 08:05:57 +00003039 Addr = Builder.CreateInBoundsGEP(Addr, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00003040
3041 // Cast the address to the appropriate pointer type, adopting the address
3042 // space of the base pointer.
3043 return Builder.CreateBitCast(Addr, PType);
3044}
3045
Reid Kleckner452abac2013-05-09 21:01:17 +00003046llvm::Value *
3047MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
3048 const CastExpr *E,
3049 llvm::Value *Src) {
3050 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
3051 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
3052 E->getCastKind() == CK_ReinterpretMemberPointer);
3053
3054 // Use constant emission if we can.
3055 if (isa<llvm::Constant>(Src))
3056 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
3057
3058 // We may be adding or dropping fields from the member pointer, so we need
3059 // both types and the inheritance models of both records.
3060 const MemberPointerType *SrcTy =
3061 E->getSubExpr()->getType()->castAs<MemberPointerType>();
3062 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003063 bool IsFunc = SrcTy->isMemberFunctionPointer();
3064
3065 // If the classes use the same null representation, reinterpret_cast is a nop.
3066 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00003067 if (IsReinterpret && IsFunc)
3068 return Src;
3069
3070 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3071 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3072 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00003073 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00003074 return Src;
3075
3076 CGBuilderTy &Builder = CGF.Builder;
3077
3078 // Branch past the conversion if Src is null.
3079 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
3080 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
3081
3082 // C++ 5.2.10p9: The null member pointer value is converted to the null member
3083 // pointer value of the destination type.
3084 if (IsReinterpret) {
3085 // For reinterpret casts, sema ensures that src and dst are both functions
3086 // or data and have the same size, which means the LLVM types should match.
3087 assert(Src->getType() == DstNull->getType());
3088 return Builder.CreateSelect(IsNotNull, Src, DstNull);
3089 }
3090
3091 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
3092 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
3093 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
3094 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
3095 CGF.EmitBlock(ConvertBB);
3096
David Majnemer0d9ad682015-06-29 00:06:50 +00003097 llvm::Value *Dst = EmitNonNullMemberPointerConversion(
3098 SrcTy, DstTy, E->getCastKind(), E->path_begin(), E->path_end(), Src,
3099 Builder);
3100
3101 Builder.CreateBr(ContinueBB);
3102
3103 // In the continuation, choose between DstNull and Dst.
3104 CGF.EmitBlock(ContinueBB);
3105 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
3106 Phi->addIncoming(DstNull, OriginalBB);
3107 Phi->addIncoming(Dst, ConvertBB);
3108 return Phi;
3109}
3110
3111llvm::Value *MicrosoftCXXABI::EmitNonNullMemberPointerConversion(
3112 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3113 CastExpr::path_const_iterator PathBegin,
3114 CastExpr::path_const_iterator PathEnd, llvm::Value *Src,
3115 CGBuilderTy &Builder) {
3116 const CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3117 const CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3118 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
3119 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
3120 bool IsFunc = SrcTy->isMemberFunctionPointer();
3121 bool IsConstant = isa<llvm::Constant>(Src);
3122
Reid Kleckner452abac2013-05-09 21:01:17 +00003123 // Decompose src.
3124 llvm::Value *FirstField = Src;
David Majnemerc1709d32015-06-23 07:31:11 +00003125 llvm::Value *NonVirtualBaseAdjustment = getZeroInt();
3126 llvm::Value *VirtualBaseAdjustmentOffset = getZeroInt();
3127 llvm::Value *VBPtrOffset = getZeroInt();
Reid Kleckner96f8f932014-02-05 17:27:08 +00003128 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003129 // We need to extract values.
3130 unsigned I = 0;
3131 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003132 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003133 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003134 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003135 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003136 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003137 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
3138 }
3139
David Majnemer0d9ad682015-06-29 00:06:50 +00003140 bool IsDerivedToBase = (CK == CK_DerivedToBaseMemberPointer);
David Majnemerc1709d32015-06-23 07:31:11 +00003141 const MemberPointerType *DerivedTy = IsDerivedToBase ? SrcTy : DstTy;
3142 const CXXRecordDecl *DerivedClass = DerivedTy->getMostRecentCXXRecordDecl();
3143
Reid Kleckner452abac2013-05-09 21:01:17 +00003144 // For data pointers, we adjust the field offset directly. For functions, we
3145 // have a separate field.
David Majnemerc1709d32015-06-23 07:31:11 +00003146 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
3147
3148 // The virtual inheritance model has a quirk: the virtual base table is always
3149 // referenced when dereferencing a member pointer even if the member pointer
3150 // is non-virtual. This is accounted for by adjusting the non-virtual offset
3151 // to point backwards to the top of the MDC from the first VBase. Undo this
3152 // adjustment to normalize the member pointer.
3153 llvm::Value *SrcVBIndexEqZero =
3154 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3155 if (SrcInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3156 if (int64_t SrcOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003157 getContext().getOffsetOfBaseWithVBPtr(SrcRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003158 llvm::Value *UndoSrcAdjustment = Builder.CreateSelect(
3159 SrcVBIndexEqZero,
3160 llvm::ConstantInt::get(CGM.IntTy, SrcOffsetToFirstVBase),
3161 getZeroInt());
3162 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, UndoSrcAdjustment);
3163 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003164 }
3165
David Majnemerc1709d32015-06-23 07:31:11 +00003166 // A non-zero vbindex implies that we are dealing with a source member in a
3167 // floating virtual base in addition to some non-virtual offset. If the
3168 // vbindex is zero, we are dealing with a source that exists in a non-virtual,
3169 // fixed, base. The difference between these two cases is that the vbindex +
3170 // nvoffset *always* point to the member regardless of what context they are
3171 // evaluated in so long as the vbindex is adjusted. A member inside a fixed
3172 // base requires explicit nv adjustment.
3173 llvm::Constant *BaseClassOffset = llvm::ConstantInt::get(
David Majnemer0d9ad682015-06-29 00:06:50 +00003174 CGM.IntTy,
3175 CGM.computeNonVirtualBaseClassOffset(DerivedClass, PathBegin, PathEnd)
3176 .getQuantity());
David Majnemerc1709d32015-06-23 07:31:11 +00003177
3178 llvm::Value *NVDisp;
3179 if (IsDerivedToBase)
3180 NVDisp = Builder.CreateNSWSub(NVAdjustField, BaseClassOffset, "adj");
3181 else
3182 NVDisp = Builder.CreateNSWAdd(NVAdjustField, BaseClassOffset, "adj");
3183
3184 NVAdjustField = Builder.CreateSelect(SrcVBIndexEqZero, NVDisp, getZeroInt());
3185
3186 // Update the vbindex to an appropriate value in the destination because
3187 // SrcRD's vbtable might not be a strict prefix of the one in DstRD.
3188 llvm::Value *DstVBIndexEqZero = SrcVBIndexEqZero;
3189 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance) &&
3190 MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance)) {
3191 if (llvm::GlobalVariable *VDispMap =
3192 getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) {
3193 llvm::Value *VBIndex = Builder.CreateExactUDiv(
3194 VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003195 if (IsConstant) {
3196 llvm::Constant *Mapping = VDispMap->getInitializer();
3197 VirtualBaseAdjustmentOffset =
3198 Mapping->getAggregateElement(cast<llvm::Constant>(VBIndex));
3199 } else {
3200 llvm::Value *Idxs[] = {getZeroInt(), VBIndex};
3201 VirtualBaseAdjustmentOffset =
John McCall7f416cc2015-09-08 08:05:57 +00003202 Builder.CreateAlignedLoad(Builder.CreateInBoundsGEP(VDispMap, Idxs),
3203 CharUnits::fromQuantity(4));
David Majnemer0d9ad682015-06-29 00:06:50 +00003204 }
David Majnemerc1709d32015-06-23 07:31:11 +00003205
3206 DstVBIndexEqZero =
3207 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3208 }
3209 }
3210
3211 // Set the VBPtrOffset to zero if the vbindex is zero. Otherwise, initialize
3212 // it to the offset of the vbptr.
3213 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance)) {
3214 llvm::Value *DstVBPtrOffset = llvm::ConstantInt::get(
3215 CGM.IntTy,
3216 getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity());
3217 VBPtrOffset =
3218 Builder.CreateSelect(DstVBIndexEqZero, getZeroInt(), DstVBPtrOffset);
3219 }
3220
3221 // Likewise, apply a similar adjustment so that dereferencing the member
3222 // pointer correctly accounts for the distance between the start of the first
3223 // virtual base and the top of the MDC.
3224 if (DstInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3225 if (int64_t DstOffsetToFirstVBase =
David Majnemer08ef2ba2015-06-23 20:34:18 +00003226 getContext().getOffsetOfBaseWithVBPtr(DstRD).getQuantity()) {
David Majnemerc1709d32015-06-23 07:31:11 +00003227 llvm::Value *DoDstAdjustment = Builder.CreateSelect(
3228 DstVBIndexEqZero,
3229 llvm::ConstantInt::get(CGM.IntTy, DstOffsetToFirstVBase),
3230 getZeroInt());
3231 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, DoDstAdjustment);
3232 }
3233 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003234
3235 // Recompose dst from the null struct and the adjusted fields from src.
3236 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00003237 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003238 Dst = FirstField;
3239 } else {
David Majnemer0d9ad682015-06-29 00:06:50 +00003240 Dst = llvm::UndefValue::get(ConvertMemberPointerType(DstTy));
Reid Kleckner452abac2013-05-09 21:01:17 +00003241 unsigned Idx = 0;
3242 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003243 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003244 Dst = Builder.CreateInsertValue(Dst, NonVirtualBaseAdjustment, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003245 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003246 Dst = Builder.CreateInsertValue(Dst, VBPtrOffset, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003247 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003248 Dst = Builder.CreateInsertValue(Dst, VirtualBaseAdjustmentOffset, Idx++);
Reid Kleckner452abac2013-05-09 21:01:17 +00003249 }
David Majnemer0d9ad682015-06-29 00:06:50 +00003250 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003251}
3252
3253llvm::Constant *
3254MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
3255 llvm::Constant *Src) {
3256 const MemberPointerType *SrcTy =
David Majnemer5ca193c2015-06-23 07:31:07 +00003257 E->getSubExpr()->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003258 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3259
David Majnemer5ca193c2015-06-23 07:31:07 +00003260 CastKind CK = E->getCastKind();
3261
3262 return EmitMemberPointerConversion(SrcTy, DstTy, CK, E->path_begin(),
3263 E->path_end(), Src);
3264}
3265
3266llvm::Constant *MicrosoftCXXABI::EmitMemberPointerConversion(
3267 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3268 CastExpr::path_const_iterator PathBegin,
3269 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src) {
3270 assert(CK == CK_DerivedToBaseMemberPointer ||
3271 CK == CK_BaseToDerivedMemberPointer ||
3272 CK == CK_ReinterpretMemberPointer);
Reid Kleckner452abac2013-05-09 21:01:17 +00003273 // If src is null, emit a new null for dst. We can't return src because dst
3274 // might have a new representation.
3275 if (MemberPointerConstantIsNull(SrcTy, Src))
3276 return EmitNullMemberPointer(DstTy);
3277
3278 // We don't need to do anything for reinterpret_casts of non-null member
3279 // pointers. We should only get here when the two type representations have
3280 // the same size.
David Majnemer5ca193c2015-06-23 07:31:07 +00003281 if (CK == CK_ReinterpretMemberPointer)
Reid Kleckner452abac2013-05-09 21:01:17 +00003282 return Src;
3283
John McCall7f416cc2015-09-08 08:05:57 +00003284 CGBuilderTy Builder(CGM, CGM.getLLVMContext());
David Majnemer0d9ad682015-06-29 00:06:50 +00003285 auto *Dst = cast<llvm::Constant>(EmitNonNullMemberPointerConversion(
3286 SrcTy, DstTy, CK, PathBegin, PathEnd, Src, Builder));
Reid Kleckner452abac2013-05-09 21:01:17 +00003287
David Majnemer0d9ad682015-06-29 00:06:50 +00003288 return Dst;
Reid Kleckner452abac2013-05-09 21:01:17 +00003289}
3290
John McCallb92ab1a2016-10-26 23:46:34 +00003291CGCallee MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
John McCall7f416cc2015-09-08 08:05:57 +00003292 CodeGenFunction &CGF, const Expr *E, Address This,
3293 llvm::Value *&ThisPtrForCall, llvm::Value *MemPtr,
3294 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003295 assert(MPT->isMemberFunctionPointer());
3296 const FunctionProtoType *FPT =
3297 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00003298 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00003299 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(
3300 CGM.getTypes().arrangeCXXMethodType(RD, FPT, /*FD=*/nullptr));
Reid Kleckner2341ae32013-04-11 18:13:19 +00003301 CGBuilderTy &Builder = CGF.Builder;
3302
David Majnemer1cdd96d2014-01-17 09:01:00 +00003303 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003304
3305 // Extract the fields we need, regardless of model. We'll apply them if we
3306 // have them.
3307 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003308 llvm::Value *NonVirtualBaseAdjustment = nullptr;
3309 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3310 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003311 if (MemPtr->getType()->isStructTy()) {
3312 // We need to extract values.
3313 unsigned I = 0;
3314 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003315 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003316 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003317 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00003318 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003319 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003320 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3321 }
3322
3323 if (VirtualBaseAdjustmentOffset) {
John McCall7f416cc2015-09-08 08:05:57 +00003324 ThisPtrForCall = AdjustVirtualBase(CGF, E, RD, This,
3325 VirtualBaseAdjustmentOffset, VBPtrOffset);
3326 } else {
3327 ThisPtrForCall = This.getPointer();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003328 }
3329
3330 if (NonVirtualBaseAdjustment) {
3331 // Apply the adjustment and cast back to the original struct type.
John McCall7f416cc2015-09-08 08:05:57 +00003332 llvm::Value *Ptr = Builder.CreateBitCast(ThisPtrForCall, CGF.Int8PtrTy);
Reid Kleckner2341ae32013-04-11 18:13:19 +00003333 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
John McCall7f416cc2015-09-08 08:05:57 +00003334 ThisPtrForCall = Builder.CreateBitCast(Ptr, ThisPtrForCall->getType(),
3335 "this.adjusted");
Reid Kleckner2341ae32013-04-11 18:13:19 +00003336 }
3337
John McCallb92ab1a2016-10-26 23:46:34 +00003338 FunctionPointer =
3339 Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
3340 CGCallee Callee(FPT, FunctionPointer);
3341 return Callee;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003342}
3343
Charles Davis53c59df2010-08-16 03:33:14 +00003344CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00003345 return new MicrosoftCXXABI(CGM);
3346}
David Majnemere2cb8d12014-07-07 06:20:47 +00003347
3348// MS RTTI Overview:
3349// The run time type information emitted by cl.exe contains 5 distinct types of
3350// structures. Many of them reference each other.
3351//
3352// TypeInfo: Static classes that are returned by typeid.
3353//
3354// CompleteObjectLocator: Referenced by vftables. They contain information
3355// required for dynamic casting, including OffsetFromTop. They also contain
3356// a reference to the TypeInfo for the type and a reference to the
3357// CompleteHierarchyDescriptor for the type.
3358//
3359// ClassHieararchyDescriptor: Contains information about a class hierarchy.
3360// Used during dynamic_cast to walk a class hierarchy. References a base
3361// class array and the size of said array.
3362//
3363// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
3364// somewhat of a misnomer because the most derived class is also in the list
3365// as well as multiple copies of virtual bases (if they occur multiple times
3366// in the hiearchy.) The BaseClassArray contains one BaseClassDescriptor for
3367// every path in the hierarchy, in pre-order depth first order. Note, we do
3368// not declare a specific llvm type for BaseClassArray, it's merely an array
3369// of BaseClassDescriptor pointers.
3370//
3371// BaseClassDescriptor: Contains information about a class in a class hierarchy.
3372// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
3373// BaseClassArray is. It contains information about a class within a
3374// hierarchy such as: is this base is ambiguous and what is its offset in the
3375// vbtable. The names of the BaseClassDescriptors have all of their fields
3376// mangled into them so they can be aggressively deduplicated by the linker.
3377
David Majnemere2cb8d12014-07-07 06:20:47 +00003378static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
Reid Klecknerfb931542018-03-16 20:36:49 +00003379 StringRef MangledName("??_7type_info@@6B@");
David Majnemere2cb8d12014-07-07 06:20:47 +00003380 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
3381 return VTable;
3382 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
3383 /*Constant=*/true,
3384 llvm::GlobalVariable::ExternalLinkage,
3385 /*Initializer=*/nullptr, MangledName);
3386}
3387
3388namespace {
3389
3390/// \brief A Helper struct that stores information about a class in a class
3391/// hierarchy. The information stored in these structs struct is used during
3392/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
3393// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
3394// implicit depth first pre-order tree connectivity. getFirstChild and
3395// getNextSibling allow us to walk the tree efficiently.
3396struct MSRTTIClass {
3397 enum {
3398 IsPrivateOnPath = 1 | 8,
3399 IsAmbiguous = 2,
3400 IsPrivate = 4,
3401 IsVirtual = 16,
3402 HasHierarchyDescriptor = 64
3403 };
3404 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
3405 uint32_t initialize(const MSRTTIClass *Parent,
3406 const CXXBaseSpecifier *Specifier);
3407
3408 MSRTTIClass *getFirstChild() { return this + 1; }
3409 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
3410 return Child + 1 + Child->NumBases;
3411 }
3412
3413 const CXXRecordDecl *RD, *VirtualRoot;
3414 uint32_t Flags, NumBases, OffsetInVBase;
3415};
3416
3417/// \brief Recursively initialize the base class array.
3418uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
3419 const CXXBaseSpecifier *Specifier) {
3420 Flags = HasHierarchyDescriptor;
3421 if (!Parent) {
3422 VirtualRoot = nullptr;
3423 OffsetInVBase = 0;
3424 } else {
3425 if (Specifier->getAccessSpecifier() != AS_public)
3426 Flags |= IsPrivate | IsPrivateOnPath;
3427 if (Specifier->isVirtual()) {
3428 Flags |= IsVirtual;
3429 VirtualRoot = RD;
3430 OffsetInVBase = 0;
3431 } else {
3432 if (Parent->Flags & IsPrivateOnPath)
3433 Flags |= IsPrivateOnPath;
3434 VirtualRoot = Parent->VirtualRoot;
3435 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
3436 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
3437 }
3438 }
3439 NumBases = 0;
3440 MSRTTIClass *Child = getFirstChild();
3441 for (const CXXBaseSpecifier &Base : RD->bases()) {
3442 NumBases += Child->initialize(this, &Base) + 1;
3443 Child = getNextChild(Child);
3444 }
3445 return NumBases;
3446}
3447
3448static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
3449 switch (Ty->getLinkage()) {
3450 case NoLinkage:
3451 case InternalLinkage:
3452 case UniqueExternalLinkage:
3453 return llvm::GlobalValue::InternalLinkage;
3454
3455 case VisibleNoLinkage:
Richard Smith1283e982017-07-07 20:04:28 +00003456 case ModuleInternalLinkage:
3457 case ModuleLinkage:
David Majnemere2cb8d12014-07-07 06:20:47 +00003458 case ExternalLinkage:
3459 return llvm::GlobalValue::LinkOnceODRLinkage;
3460 }
3461 llvm_unreachable("Invalid linkage!");
3462}
3463
3464/// \brief An ephemeral helper class for building MS RTTI types. It caches some
3465/// calls to the module and information about the most derived class in a
3466/// hierarchy.
3467struct MSRTTIBuilder {
3468 enum {
3469 HasBranchingHierarchy = 1,
3470 HasVirtualBranchingHierarchy = 2,
3471 HasAmbiguousBases = 4
3472 };
3473
David Majnemer611cdb92014-07-07 08:09:15 +00003474 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
3475 : CGM(ABI.CGM), Context(CGM.getContext()),
3476 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00003477 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003478 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00003479
3480 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
3481 llvm::GlobalVariable *
3482 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
3483 llvm::GlobalVariable *getClassHierarchyDescriptor();
Justin Lebar562914e2016-10-10 16:26:29 +00003484 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo &Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003485
3486 CodeGenModule &CGM;
3487 ASTContext &Context;
3488 llvm::LLVMContext &VMContext;
3489 llvm::Module &Module;
3490 const CXXRecordDecl *RD;
3491 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00003492 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00003493};
3494
3495} // namespace
3496
3497/// \brief Recursively serializes a class hierarchy in pre-order depth first
3498/// order.
3499static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
3500 const CXXRecordDecl *RD) {
3501 Classes.push_back(MSRTTIClass(RD));
3502 for (const CXXBaseSpecifier &Base : RD->bases())
3503 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
3504}
3505
3506/// \brief Find ambiguity among base classes.
3507static void
3508detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
3509 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
3510 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
3511 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
3512 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
3513 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
David Blaikie82e95a32014-11-19 07:49:47 +00003514 !VirtualBases.insert(Class->RD).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003515 Class = MSRTTIClass::getNextChild(Class);
3516 continue;
3517 }
David Blaikie82e95a32014-11-19 07:49:47 +00003518 if (!UniqueBases.insert(Class->RD).second)
David Majnemere2cb8d12014-07-07 06:20:47 +00003519 AmbiguousBases.insert(Class->RD);
3520 Class++;
3521 }
3522 if (AmbiguousBases.empty())
3523 return;
3524 for (MSRTTIClass &Class : Classes)
3525 if (AmbiguousBases.count(Class.RD))
3526 Class.Flags |= MSRTTIClass::IsAmbiguous;
3527}
3528
3529llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
3530 SmallString<256> MangledName;
3531 {
3532 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003533 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003534 }
3535
3536 // Check to see if we've already declared this ClassHierarchyDescriptor.
3537 if (auto CHD = Module.getNamedGlobal(MangledName))
3538 return CHD;
3539
3540 // Serialize the class hierarchy and initialize the CHD Fields.
3541 SmallVector<MSRTTIClass, 8> Classes;
3542 serializeClassHierarchy(Classes, RD);
3543 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3544 detectAmbiguousBases(Classes);
3545 int Flags = 0;
3546 for (auto Class : Classes) {
3547 if (Class.RD->getNumBases() > 1)
3548 Flags |= HasBranchingHierarchy;
3549 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
3550 // believe the field isn't actually used.
3551 if (Class.Flags & MSRTTIClass::IsAmbiguous)
3552 Flags |= HasAmbiguousBases;
3553 }
3554 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
3555 Flags |= HasVirtualBranchingHierarchy;
3556 // These gep indices are used to get the address of the first element of the
3557 // base class array.
3558 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
3559 llvm::ConstantInt::get(CGM.IntTy, 0)};
3560
3561 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00003562 auto Type = ABI.getClassHierarchyDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003563 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3564 /*Initializer=*/nullptr,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003565 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003566 if (CHD->isWeakForLinker())
3567 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003568
David Blaikiee3b172a2015-04-02 18:55:21 +00003569 auto *Bases = getBaseClassArray(Classes);
3570
David Majnemere2cb8d12014-07-07 06:20:47 +00003571 // Initialize the base class ClassHierarchyDescriptor.
3572 llvm::Constant *Fields[] = {
Saleem Abdulrasoola9e14502017-01-01 19:16:02 +00003573 llvm::ConstantInt::get(CGM.IntTy, 0), // reserved by the runtime
David Majnemer611cdb92014-07-07 08:09:15 +00003574 llvm::ConstantInt::get(CGM.IntTy, Flags),
3575 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
3576 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00003577 Bases->getValueType(), Bases,
David Majnemer611cdb92014-07-07 08:09:15 +00003578 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00003579 };
3580 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3581 return CHD;
3582}
3583
3584llvm::GlobalVariable *
3585MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3586 SmallString<256> MangledName;
3587 {
3588 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003589 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003590 }
3591
3592 // Forward-declare the base class array.
3593 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3594 // mode) bytes of padding. We provide a pointer sized amount of padding by
3595 // adding +1 to Classes.size(). The sections have pointer alignment and are
3596 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00003597 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00003598 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00003599 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
David Majnemer7c237072015-03-05 00:46:22 +00003600 auto *BCA =
3601 new llvm::GlobalVariable(Module, ArrType,
3602 /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003603 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003604 if (BCA->isWeakForLinker())
3605 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003606
3607 // Initialize the BaseClassArray.
3608 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3609 for (MSRTTIClass &Class : Classes)
3610 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00003611 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00003612 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00003613 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00003614 return BCA;
3615}
3616
3617llvm::GlobalVariable *
3618MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3619 // Compute the fields for the BaseClassDescriptor. They are computed up front
3620 // because they are mangled into the name of the object.
3621 uint32_t OffsetInVBTable = 0;
3622 int32_t VBPtrOffset = -1;
3623 if (Class.VirtualRoot) {
3624 auto &VTableContext = CGM.getMicrosoftVTableContext();
3625 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3626 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3627 }
3628
3629 SmallString<256> MangledName;
3630 {
3631 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003632 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3633 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3634 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003635 }
3636
David Majnemer26a90f82014-07-07 15:29:10 +00003637 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00003638 if (auto BCD = Module.getNamedGlobal(MangledName))
3639 return BCD;
3640
3641 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00003642 auto Type = ABI.getBaseClassDescriptorType();
David Majnemer7c237072015-03-05 00:46:22 +00003643 auto BCD =
3644 new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003645 /*Initializer=*/nullptr, MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003646 if (BCD->isWeakForLinker())
3647 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003648
3649 // Initialize the BaseClassDescriptor.
3650 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003651 ABI.getImageRelativeConstant(
David Majnemer443250f2015-03-17 20:35:00 +00003652 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003653 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3654 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3655 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3656 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3657 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3658 ABI.getImageRelativeConstant(
3659 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00003660 };
3661 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3662 return BCD;
3663}
3664
3665llvm::GlobalVariable *
Justin Lebar562914e2016-10-10 16:26:29 +00003666MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo &Info) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003667 SmallString<256> MangledName;
3668 {
3669 llvm::raw_svector_ostream Out(MangledName);
Justin Lebar562914e2016-10-10 16:26:29 +00003670 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info.MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003671 }
3672
3673 // Check to see if we've already computed this complete object locator.
3674 if (auto COL = Module.getNamedGlobal(MangledName))
3675 return COL;
3676
3677 // Compute the fields of the complete object locator.
Justin Lebar562914e2016-10-10 16:26:29 +00003678 int OffsetToTop = Info.FullOffsetInMDC.getQuantity();
David Majnemere2cb8d12014-07-07 06:20:47 +00003679 int VFPtrOffset = 0;
3680 // The offset includes the vtordisp if one exists.
Justin Lebar562914e2016-10-10 16:26:29 +00003681 if (const CXXRecordDecl *VBase = Info.getVBaseWithVPtr())
David Majnemere2cb8d12014-07-07 06:20:47 +00003682 if (Context.getASTRecordLayout(RD)
3683 .getVBaseOffsetsMap()
3684 .find(VBase)
3685 ->second.hasVtorDisp())
Justin Lebar562914e2016-10-10 16:26:29 +00003686 VFPtrOffset = Info.NonVirtualOffset.getQuantity() + 4;
David Majnemere2cb8d12014-07-07 06:20:47 +00003687
3688 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00003689 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003690 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
Yaron Keren2c07cc72015-12-01 08:14:39 +00003691 /*Initializer=*/nullptr, MangledName);
David Majnemere2cb8d12014-07-07 06:20:47 +00003692
3693 // Initialize the CompleteObjectLocator.
3694 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003695 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3696 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3697 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3698 ABI.getImageRelativeConstant(
3699 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3700 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3701 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00003702 };
3703 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00003704 if (!ABI.isImageRelative())
3705 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00003706 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
Rafael Espindola654542a2015-01-16 19:23:42 +00003707 if (COL->isWeakForLinker())
3708 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003709 return COL;
3710}
3711
David Majnemerad803d42015-03-15 07:10:01 +00003712static QualType decomposeTypeForEH(ASTContext &Context, QualType T,
David Majnemer526793d2016-07-12 04:42:50 +00003713 bool &IsConst, bool &IsVolatile,
3714 bool &IsUnaligned) {
David Majnemerad803d42015-03-15 07:10:01 +00003715 T = Context.getExceptionObjectType(T);
3716
3717 // C++14 [except.handle]p3:
3718 // A handler is a match for an exception object of type E if [...]
3719 // - the handler is of type cv T or const T& where T is a pointer type and
3720 // E is a pointer type that can be converted to T by [...]
3721 // - a qualification conversion
3722 IsConst = false;
3723 IsVolatile = false;
David Majnemer526793d2016-07-12 04:42:50 +00003724 IsUnaligned = false;
David Majnemerad803d42015-03-15 07:10:01 +00003725 QualType PointeeType = T->getPointeeType();
3726 if (!PointeeType.isNull()) {
3727 IsConst = PointeeType.isConstQualified();
3728 IsVolatile = PointeeType.isVolatileQualified();
David Majnemer526793d2016-07-12 04:42:50 +00003729 IsUnaligned = PointeeType.getQualifiers().hasUnaligned();
David Majnemerad803d42015-03-15 07:10:01 +00003730 }
3731
3732 // Member pointer types like "const int A::*" are represented by having RTTI
3733 // for "int A::*" and separately storing the const qualifier.
3734 if (const auto *MPTy = T->getAs<MemberPointerType>())
3735 T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(),
3736 MPTy->getClass());
3737
3738 // Pointer types like "const int * const *" are represented by having RTTI
3739 // for "const int **" and separately storing the const qualifier.
3740 if (T->isPointerType())
3741 T = Context.getPointerType(PointeeType.getUnqualifiedType());
3742
3743 return T;
3744}
3745
Reid Kleckner10aa7702015-09-16 20:15:55 +00003746CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +00003747MicrosoftCXXABI::getAddrOfCXXCatchHandlerType(QualType Type,
3748 QualType CatchHandlerType) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003749 // TypeDescriptors for exceptions never have qualified pointer types,
Simon Pilgrim2c518802017-03-30 14:13:19 +00003750 // qualifiers are stored separately in order to support qualification
David Majnemer443250f2015-03-17 20:35:00 +00003751 // conversions.
David Majnemer526793d2016-07-12 04:42:50 +00003752 bool IsConst, IsVolatile, IsUnaligned;
3753 Type =
3754 decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile, IsUnaligned);
David Majnemer443250f2015-03-17 20:35:00 +00003755
David Majnemer5f0dd612015-03-17 20:35:05 +00003756 bool IsReference = CatchHandlerType->isReferenceType();
3757
David Majnemer5f0dd612015-03-17 20:35:05 +00003758 uint32_t Flags = 0;
3759 if (IsConst)
3760 Flags |= 1;
3761 if (IsVolatile)
3762 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00003763 if (IsUnaligned)
3764 Flags |= 4;
David Majnemer5f0dd612015-03-17 20:35:05 +00003765 if (IsReference)
3766 Flags |= 8;
3767
Reid Kleckner10aa7702015-09-16 20:15:55 +00003768 return CatchTypeInfo{getAddrOfRTTIDescriptor(Type)->stripPointerCasts(),
3769 Flags};
David Majnemer443250f2015-03-17 20:35:00 +00003770}
3771
David Majnemere2cb8d12014-07-07 06:20:47 +00003772/// \brief Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
3773/// llvm::GlobalVariable * because different type descriptors have different
3774/// types, and need to be abstracted. They are abstracting by casting the
3775/// address to an Int8PtrTy.
David Majnemer443250f2015-03-17 20:35:00 +00003776llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003777 SmallString<256> MangledName;
David Majnemere2cb8d12014-07-07 06:20:47 +00003778 {
3779 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003780 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003781 }
3782
3783 // Check to see if we've already declared this TypeDescriptor.
3784 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3785 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3786
Piotr Padlewskid3b1cbd2017-06-01 08:04:05 +00003787 // Note for the future: If we would ever like to do deferred emission of
3788 // RTTI, check if emitting vtables opportunistically need any adjustment.
3789
David Majnemere2cb8d12014-07-07 06:20:47 +00003790 // Compute the fields for the TypeDescriptor.
David Majnemer5f0dd612015-03-17 20:35:05 +00003791 SmallString<256> TypeInfoString;
David Majnemere2cb8d12014-07-07 06:20:47 +00003792 {
3793 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00003794 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003795 }
3796
3797 // Declare and initialize the TypeDescriptor.
3798 llvm::Constant *Fields[] = {
3799 getTypeInfoVTable(CGM), // VFPtr
3800 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3801 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3802 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00003803 getTypeDescriptorType(TypeInfoString);
Rafael Espindola654542a2015-01-16 19:23:42 +00003804 auto *Var = new llvm::GlobalVariable(
3805 CGM.getModule(), TypeDescriptorType, /*Constant=*/false,
3806 getLinkageForRTTI(Type),
3807 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
Yaron Keren2c07cc72015-12-01 08:14:39 +00003808 MangledName);
Rafael Espindola654542a2015-01-16 19:23:42 +00003809 if (Var->isWeakForLinker())
3810 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3811 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003812}
3813
3814/// \brief Gets or a creates a Microsoft CompleteObjectLocator.
3815llvm::GlobalVariable *
3816MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
Justin Lebar562914e2016-10-10 16:26:29 +00003817 const VPtrInfo &Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00003818 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003819}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003820
3821static void emitCXXConstructor(CodeGenModule &CGM,
3822 const CXXConstructorDecl *ctor,
3823 StructorType ctorType) {
Rafael Espindolad48b51b2014-09-15 19:24:44 +00003824 // There are no constructor variants, always emit the complete destructor.
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003825 llvm::Function *Fn = CGM.codegenCXXStructor(ctor, StructorType::Complete);
3826 CGM.maybeSetTrivialComdat(*ctor, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003827}
3828
3829static void emitCXXDestructor(CodeGenModule &CGM, const CXXDestructorDecl *dtor,
3830 StructorType dtorType) {
Reid Klecknerae9b0702018-03-16 19:40:50 +00003831 // Emit the base destructor if the base and complete (vbase) destructors are
3832 // equivalent. This effectively implements -mconstructor-aliases as part of
3833 // the ABI.
3834 if (dtorType == StructorType::Complete &&
3835 dtor->getParent()->getNumVBases() == 0)
3836 dtorType = StructorType::Base;
Rafael Espindola91f68b42014-09-15 19:20:10 +00003837
3838 // The base destructor is equivalent to the base destructor of its
3839 // base class if there is exactly one non-virtual base class with a
3840 // non-trivial destructor, there are no fields with a non-trivial
3841 // destructor, and the body of the destructor is trivial.
3842 if (dtorType == StructorType::Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
3843 return;
3844
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003845 llvm::Function *Fn = CGM.codegenCXXStructor(dtor, dtorType);
Rafael Espindolad3e04692015-01-17 01:47:39 +00003846 if (Fn->isWeakForLinker())
3847 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003848}
3849
3850void MicrosoftCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3851 StructorType Type) {
3852 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
3853 emitCXXConstructor(CGM, CD, Type);
3854 return;
3855 }
3856 emitCXXDestructor(CGM, cast<CXXDestructorDecl>(MD), Type);
3857}
David Majnemer7c237072015-03-05 00:46:22 +00003858
David Majnemerdfa6d202015-03-11 18:36:39 +00003859llvm::Function *
David Majnemer37fd66e2015-03-13 22:36:55 +00003860MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
3861 CXXCtorType CT) {
3862 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
3863
David Majnemerdfa6d202015-03-11 18:36:39 +00003864 // Calculate the mangled name.
3865 SmallString<256> ThunkName;
3866 llvm::raw_svector_ostream Out(ThunkName);
David Majnemer37fd66e2015-03-13 22:36:55 +00003867 getMangleContext().mangleCXXCtor(CD, CT, Out);
David Majnemerdfa6d202015-03-11 18:36:39 +00003868
3869 // If the thunk has been generated previously, just return it.
3870 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
3871 return cast<llvm::Function>(GV);
3872
3873 // Create the llvm::Function.
David Majnemer37fd66e2015-03-13 22:36:55 +00003874 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT);
David Majnemerdfa6d202015-03-11 18:36:39 +00003875 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
3876 const CXXRecordDecl *RD = CD->getParent();
3877 QualType RecordTy = getContext().getRecordType(RD);
3878 llvm::Function *ThunkFn = llvm::Function::Create(
3879 ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule());
Reid Klecknerbba3cb92015-03-17 19:00:50 +00003880 ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>(
3881 FnInfo.getEffectiveCallingConvention()));
David Majnemer63aa2fb2015-06-30 21:23:51 +00003882 if (ThunkFn->isWeakForLinker())
3883 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
David Majnemer37fd66e2015-03-13 22:36:55 +00003884 bool IsCopy = CT == Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003885
3886 // Start codegen.
3887 CodeGenFunction CGF(CGM);
3888 CGF.CurGD = GlobalDecl(CD, Ctor_Complete);
3889
3890 // Build FunctionArgs.
3891 FunctionArgList FunctionArgs;
3892
David Majnemer37fd66e2015-03-13 22:36:55 +00003893 // A constructor always starts with a 'this' pointer as its first argument.
David Majnemerdfa6d202015-03-11 18:36:39 +00003894 buildThisParam(CGF, FunctionArgs);
3895
3896 // Following the 'this' pointer is a reference to the source object that we
3897 // are copying from.
3898 ImplicitParamDecl SrcParam(
Alexey Bataev56223232017-06-09 13:40:18 +00003899 getContext(), /*DC=*/nullptr, SourceLocation(),
3900 &getContext().Idents.get("src"),
David Majnemerdfa6d202015-03-11 18:36:39 +00003901 getContext().getLValueReferenceType(RecordTy,
Alexey Bataev56223232017-06-09 13:40:18 +00003902 /*SpelledAsLValue=*/true),
3903 ImplicitParamDecl::Other);
David Majnemer37fd66e2015-03-13 22:36:55 +00003904 if (IsCopy)
3905 FunctionArgs.push_back(&SrcParam);
David Majnemerdfa6d202015-03-11 18:36:39 +00003906
David Majnemer37fd66e2015-03-13 22:36:55 +00003907 // Constructors for classes which utilize virtual bases have an additional
3908 // parameter which indicates whether or not it is being delegated to by a more
3909 // derived constructor.
Alexey Bataev56223232017-06-09 13:40:18 +00003910 ImplicitParamDecl IsMostDerived(getContext(), /*DC=*/nullptr,
3911 SourceLocation(),
David Majnemerdfa6d202015-03-11 18:36:39 +00003912 &getContext().Idents.get("is_most_derived"),
Alexey Bataev56223232017-06-09 13:40:18 +00003913 getContext().IntTy, ImplicitParamDecl::Other);
David Majnemerdfa6d202015-03-11 18:36:39 +00003914 // Only add the parameter to the list if thie class has virtual bases.
3915 if (RD->getNumVBases() > 0)
3916 FunctionArgs.push_back(&IsMostDerived);
3917
3918 // Start defining the function.
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003919 auto NL = ApplyDebugLocation::CreateEmpty(CGF);
David Majnemerdfa6d202015-03-11 18:36:39 +00003920 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
3921 FunctionArgs, CD->getLocation(), SourceLocation());
Adrian Prantld3c4e1b2016-11-16 18:49:47 +00003922 // Create a scope with an artificial location for the body of this function.
3923 auto AL = ApplyDebugLocation::CreateArtificial(CGF);
Reid Kleckner06239e42017-11-16 19:09:36 +00003924 setCXXABIThisValue(CGF, loadIncomingCXXThis(CGF));
David Majnemerdfa6d202015-03-11 18:36:39 +00003925 llvm::Value *This = getThisValue(CGF);
3926
3927 llvm::Value *SrcVal =
David Majnemer37fd66e2015-03-13 22:36:55 +00003928 IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src")
3929 : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003930
3931 CallArgList Args;
3932
3933 // Push the this ptr.
3934 Args.add(RValue::get(This), CD->getThisType(getContext()));
3935
3936 // Push the src ptr.
David Majnemer37fd66e2015-03-13 22:36:55 +00003937 if (SrcVal)
3938 Args.add(RValue::get(SrcVal), SrcParam.getType());
David Majnemerdfa6d202015-03-11 18:36:39 +00003939
3940 // Add the rest of the default arguments.
Reid Klecknerc01ee752016-11-23 16:51:30 +00003941 SmallVector<const Stmt *, 4> ArgVec;
3942 ArrayRef<ParmVarDecl *> params = CD->parameters().drop_front(IsCopy ? 1 : 0);
3943 for (const ParmVarDecl *PD : params) {
3944 assert(PD->hasDefaultArg() && "ctor closure lacks default args");
3945 ArgVec.push_back(PD->getDefaultArg());
Reid Kleckner93f661a2015-03-17 21:51:43 +00003946 }
David Majnemerdfa6d202015-03-11 18:36:39 +00003947
3948 CodeGenFunction::RunCleanupsScope Cleanups(CGF);
3949
3950 const auto *FPT = CD->getType()->castAs<FunctionProtoType>();
David Blaikief05779e2015-07-21 18:37:18 +00003951 CGF.EmitCallArgs(Args, FPT, llvm::makeArrayRef(ArgVec), CD, IsCopy ? 1 : 0);
David Majnemerdfa6d202015-03-11 18:36:39 +00003952
3953 // Insert any ABI-specific implicit constructor arguments.
George Burgess IVf203dbf2017-02-22 20:28:02 +00003954 AddedStructorArgs ExtraArgs =
3955 addImplicitConstructorArgs(CGF, CD, Ctor_Complete,
3956 /*ForVirtualBase=*/false,
3957 /*Delegating=*/false, Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00003958 // Call the destructor with our arguments.
John McCallb92ab1a2016-10-26 23:46:34 +00003959 llvm::Constant *CalleePtr =
3960 CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3961 CGCallee Callee = CGCallee::forDirect(CalleePtr, CD);
David Majnemerdfa6d202015-03-11 18:36:39 +00003962 const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall(
George Burgess IVd0a9e802017-02-23 22:07:35 +00003963 Args, CD, Ctor_Complete, ExtraArgs.Prefix, ExtraArgs.Suffix);
John McCallb92ab1a2016-10-26 23:46:34 +00003964 CGF.EmitCall(CalleeInfo, Callee, ReturnValueSlot(), Args);
David Majnemerdfa6d202015-03-11 18:36:39 +00003965
3966 Cleanups.ForceCleanup();
3967
3968 // Emit the ret instruction, remove any temporary instructions created for the
3969 // aid of CodeGen.
3970 CGF.FinishFunction(SourceLocation());
3971
3972 return ThunkFn;
3973}
3974
David Majnemer7c237072015-03-05 00:46:22 +00003975llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
3976 uint32_t NVOffset,
3977 int32_t VBPtrOffset,
3978 uint32_t VBIndex) {
3979 assert(!T->isReferenceType());
3980
David Majnemere7a818f2015-03-06 18:53:55 +00003981 CXXRecordDecl *RD = T->getAsCXXRecordDecl();
3982 const CXXConstructorDecl *CD =
3983 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003984 CXXCtorType CT = Ctor_Complete;
David Majnemer37fd66e2015-03-13 22:36:55 +00003985 if (CD)
3986 if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1)
David Majnemerdfa6d202015-03-11 18:36:39 +00003987 CT = Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003988
David Majnemer7c237072015-03-05 00:46:22 +00003989 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
3990 SmallString<256> MangledName;
3991 {
3992 llvm::raw_svector_ostream Out(MangledName);
David Majnemerdfa6d202015-03-11 18:36:39 +00003993 getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +00003994 VBPtrOffset, VBIndex, Out);
David Majnemer7c237072015-03-05 00:46:22 +00003995 }
3996 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3997 return getImageRelativeConstant(GV);
3998
David Majnemerdfa6d202015-03-11 18:36:39 +00003999 // The TypeDescriptor is used by the runtime to determine if a catch handler
David Majnemer7c237072015-03-05 00:46:22 +00004000 // is appropriate for the exception object.
David Majnemer443250f2015-03-17 20:35:00 +00004001 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
David Majnemer7c237072015-03-05 00:46:22 +00004002
4003 // The runtime is responsible for calling the copy constructor if the
4004 // exception is caught by value.
David Majnemerdfa6d202015-03-11 18:36:39 +00004005 llvm::Constant *CopyCtor;
4006 if (CD) {
4007 if (CT == Ctor_CopyingClosure)
David Majnemer37fd66e2015-03-13 22:36:55 +00004008 CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure);
David Majnemerdfa6d202015-03-11 18:36:39 +00004009 else
4010 CopyCtor = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
4011
4012 CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy);
4013 } else {
4014 CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4015 }
David Majnemere7a818f2015-03-06 18:53:55 +00004016 CopyCtor = getImageRelativeConstant(CopyCtor);
David Majnemer7c237072015-03-05 00:46:22 +00004017
David Majnemere7a818f2015-03-06 18:53:55 +00004018 bool IsScalar = !RD;
David Majnemer7c237072015-03-05 00:46:22 +00004019 bool HasVirtualBases = false;
4020 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
David Majnemer7c237072015-03-05 00:46:22 +00004021 QualType PointeeType = T;
4022 if (T->isPointerType())
4023 PointeeType = T->getPointeeType();
4024 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
4025 HasVirtualBases = RD->getNumVBases() > 0;
4026 if (IdentifierInfo *II = RD->getIdentifier())
4027 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
4028 }
4029
4030 // Encode the relevant CatchableType properties into the Flags bitfield.
4031 // FIXME: Figure out how bits 2 or 8 can get set.
4032 uint32_t Flags = 0;
4033 if (IsScalar)
4034 Flags |= 1;
4035 if (HasVirtualBases)
4036 Flags |= 4;
4037 if (IsStdBadAlloc)
4038 Flags |= 16;
4039
4040 llvm::Constant *Fields[] = {
4041 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4042 TD, // TypeDescriptor
4043 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment
4044 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
4045 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex
4046 llvm::ConstantInt::get(CGM.IntTy, Size), // Size
4047 CopyCtor // CopyCtor
4048 };
4049 llvm::StructType *CTType = getCatchableTypeType();
4050 auto *GV = new llvm::GlobalVariable(
4051 CGM.getModule(), CTType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004052 llvm::ConstantStruct::get(CTType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004053 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004054 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004055 if (GV->isWeakForLinker())
4056 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004057 return getImageRelativeConstant(GV);
4058}
4059
4060llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
4061 assert(!T->isReferenceType());
4062
4063 // See if we've already generated a CatchableTypeArray for this type before.
4064 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
4065 if (CTA)
4066 return CTA;
4067
4068 // Ensure that we don't have duplicate entries in our CatchableTypeArray by
4069 // using a SmallSetVector. Duplicates may arise due to virtual bases
4070 // occurring more than once in the hierarchy.
4071 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
4072
4073 // C++14 [except.handle]p3:
4074 // A handler is a match for an exception object of type E if [...]
4075 // - the handler is of type cv T or cv T& and T is an unambiguous public
4076 // base class of E, or
4077 // - the handler is of type cv T or const T& where T is a pointer type and
4078 // E is a pointer type that can be converted to T by [...]
4079 // - a standard pointer conversion (4.10) not involving conversions to
4080 // pointers to private or protected or ambiguous classes
4081 const CXXRecordDecl *MostDerivedClass = nullptr;
4082 bool IsPointer = T->isPointerType();
4083 if (IsPointer)
4084 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
4085 else
4086 MostDerivedClass = T->getAsCXXRecordDecl();
4087
4088 // Collect all the unambiguous public bases of the MostDerivedClass.
4089 if (MostDerivedClass) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00004090 const ASTContext &Context = getContext();
David Majnemer7c237072015-03-05 00:46:22 +00004091 const ASTRecordLayout &MostDerivedLayout =
4092 Context.getASTRecordLayout(MostDerivedClass);
4093 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
4094 SmallVector<MSRTTIClass, 8> Classes;
4095 serializeClassHierarchy(Classes, MostDerivedClass);
4096 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
4097 detectAmbiguousBases(Classes);
4098 for (const MSRTTIClass &Class : Classes) {
4099 // Skip any ambiguous or private bases.
4100 if (Class.Flags &
4101 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
4102 continue;
4103 // Write down how to convert from a derived pointer to a base pointer.
4104 uint32_t OffsetInVBTable = 0;
4105 int32_t VBPtrOffset = -1;
4106 if (Class.VirtualRoot) {
4107 OffsetInVBTable =
4108 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
4109 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
4110 }
4111
4112 // Turn our record back into a pointer if the exception object is a
4113 // pointer.
4114 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
4115 if (IsPointer)
4116 RTTITy = Context.getPointerType(RTTITy);
4117 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
4118 VBPtrOffset, OffsetInVBTable));
4119 }
4120 }
4121
4122 // C++14 [except.handle]p3:
4123 // A handler is a match for an exception object of type E if
4124 // - The handler is of type cv T or cv T& and E and T are the same type
4125 // (ignoring the top-level cv-qualifiers)
4126 CatchableTypes.insert(getCatchableType(T));
4127
4128 // C++14 [except.handle]p3:
4129 // A handler is a match for an exception object of type E if
4130 // - the handler is of type cv T or const T& where T is a pointer type and
4131 // E is a pointer type that can be converted to T by [...]
4132 // - a standard pointer conversion (4.10) not involving conversions to
4133 // pointers to private or protected or ambiguous classes
4134 //
David Majnemerf205f532015-04-04 05:37:48 +00004135 // C++14 [conv.ptr]p2:
4136 // A prvalue of type "pointer to cv T," where T is an object type, can be
4137 // converted to a prvalue of type "pointer to cv void".
4138 if (IsPointer && T->getPointeeType()->isObjectType())
David Majnemer7c237072015-03-05 00:46:22 +00004139 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4140
David Majnemera1aea9a2015-03-12 17:44:49 +00004141 // C++14 [except.handle]p3:
4142 // A handler is a match for an exception object of type E if [...]
4143 // - the handler is of type cv T or const T& where T is a pointer or
4144 // pointer to member type and E is std::nullptr_t.
4145 //
4146 // We cannot possibly list all possible pointer types here, making this
4147 // implementation incompatible with the standard. However, MSVC includes an
4148 // entry for pointer-to-void in this case. Let's do the same.
4149 if (T->isNullPtrType())
4150 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4151
David Majnemer7c237072015-03-05 00:46:22 +00004152 uint32_t NumEntries = CatchableTypes.size();
4153 llvm::Type *CTType =
4154 getImageRelativeType(getCatchableTypeType()->getPointerTo());
4155 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
4156 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
4157 llvm::Constant *Fields[] = {
4158 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries
4159 llvm::ConstantArray::get(
4160 AT, llvm::makeArrayRef(CatchableTypes.begin(),
4161 CatchableTypes.end())) // CatchableTypes
4162 };
4163 SmallString<256> MangledName;
4164 {
4165 llvm::raw_svector_ostream Out(MangledName);
4166 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
4167 }
4168 CTA = new llvm::GlobalVariable(
4169 CGM.getModule(), CTAType, /*Constant=*/true, getLinkageForRTTI(T),
Yaron Keren2c07cc72015-12-01 08:14:39 +00004170 llvm::ConstantStruct::get(CTAType, Fields), MangledName);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004171 CTA->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004172 CTA->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004173 if (CTA->isWeakForLinker())
4174 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004175 return CTA;
4176}
4177
4178llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
David Majnemer526793d2016-07-12 04:42:50 +00004179 bool IsConst, IsVolatile, IsUnaligned;
4180 T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile, IsUnaligned);
David Majnemer7c237072015-03-05 00:46:22 +00004181
4182 // The CatchableTypeArray enumerates the various (CV-unqualified) types that
4183 // the exception object may be caught as.
4184 llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
4185 // The first field in a CatchableTypeArray is the number of CatchableTypes.
4186 // This is used as a component of the mangled name which means that we need to
4187 // know what it is in order to see if we have previously generated the
4188 // ThrowInfo.
4189 uint32_t NumEntries =
4190 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
4191 ->getLimitedValue();
4192
4193 SmallString<256> MangledName;
4194 {
4195 llvm::raw_svector_ostream Out(MangledName);
David Majnemer526793d2016-07-12 04:42:50 +00004196 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, IsUnaligned,
4197 NumEntries, Out);
David Majnemer7c237072015-03-05 00:46:22 +00004198 }
4199
4200 // Reuse a previously generated ThrowInfo if we have generated an appropriate
4201 // one before.
4202 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4203 return GV;
4204
4205 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
4206 // be at least as CV qualified. Encode this requirement into the Flags
4207 // bitfield.
4208 uint32_t Flags = 0;
4209 if (IsConst)
4210 Flags |= 1;
4211 if (IsVolatile)
4212 Flags |= 2;
David Majnemer526793d2016-07-12 04:42:50 +00004213 if (IsUnaligned)
4214 Flags |= 4;
David Majnemer7c237072015-03-05 00:46:22 +00004215
4216 // The cleanup-function (a destructor) must be called when the exception
4217 // object's lifetime ends.
4218 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4219 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
4220 if (CXXDestructorDecl *DtorD = RD->getDestructor())
4221 if (!DtorD->isTrivial())
4222 CleanupFn = llvm::ConstantExpr::getBitCast(
4223 CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete),
4224 CGM.Int8PtrTy);
4225 // This is unused as far as we can tell, initialize it to null.
4226 llvm::Constant *ForwardCompat =
4227 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
4228 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
4229 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
4230 llvm::StructType *TIType = getThrowInfoType();
4231 llvm::Constant *Fields[] = {
4232 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4233 getImageRelativeConstant(CleanupFn), // CleanupFn
4234 ForwardCompat, // ForwardCompat
4235 PointerToCatchableTypes // CatchableTypeArray
4236 };
4237 auto *GV = new llvm::GlobalVariable(
4238 CGM.getModule(), TIType, /*Constant=*/true, getLinkageForRTTI(T),
4239 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
Peter Collingbournebcf909d2016-06-14 21:02:05 +00004240 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
David Majnemer322fe412015-03-06 23:45:23 +00004241 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004242 if (GV->isWeakForLinker())
4243 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004244 return GV;
4245}
4246
4247void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
4248 const Expr *SubExpr = E->getSubExpr();
4249 QualType ThrowType = SubExpr->getType();
4250 // The exception object lives on the stack and it's address is passed to the
4251 // runtime function.
John McCall7f416cc2015-09-08 08:05:57 +00004252 Address AI = CGF.CreateMemTemp(ThrowType);
David Majnemer7c237072015-03-05 00:46:22 +00004253 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
4254 /*IsInit=*/true);
4255
4256 // The so-called ThrowInfo is used to describe how the exception object may be
4257 // caught.
4258 llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
4259
4260 // Call into the runtime to throw the exception.
John McCall7f416cc2015-09-08 08:05:57 +00004261 llvm::Value *Args[] = {
4262 CGF.Builder.CreateBitCast(AI.getPointer(), CGM.Int8PtrTy),
4263 TI
4264 };
David Majnemer7c237072015-03-05 00:46:22 +00004265 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
4266}
Peter Collingbourne60108802017-12-13 21:53:04 +00004267
4268std::pair<llvm::Value *, const CXXRecordDecl *>
4269MicrosoftCXXABI::LoadVTablePtr(CodeGenFunction &CGF, Address This,
4270 const CXXRecordDecl *RD) {
4271 std::tie(This, std::ignore, RD) =
4272 performBaseAdjustment(CGF, This, QualType(RD->getTypeForDecl(), 0));
4273 return {CGF.GetVTablePtr(This, CGM.Int8PtrTy, RD), RD};
4274}