blob: fabdef3d158d33cca03b336438383cc9a12ba55d [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 Kleckner7810af02013-06-19 15:20:38 +000018#include "CGVTables.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000019#include "CodeGenModule.h"
David Majnemere7a818f2015-03-06 18:53:55 +000020#include "CodeGenTypes.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000021#include "TargetInfo.h"
Charles Davis74ce8592010-06-09 23:25:41 +000022#include "clang/AST/Decl.h"
23#include "clang/AST/DeclCXX.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000024#include "clang/AST/StmtCXX.h"
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +000025#include "clang/AST/VTableBuilder.h"
David Majnemer611cdb92014-07-07 08:09:15 +000026#include "llvm/ADT/StringExtras.h"
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +000027#include "llvm/ADT/StringSet.h"
David Majnemer1162d252014-06-22 19:05:33 +000028#include "llvm/IR/CallSite.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000029#include "llvm/IR/Intrinsics.h"
Charles Davis74ce8592010-06-09 23:25:41 +000030
31using namespace clang;
32using namespace CodeGen;
33
34namespace {
35
Reid Klecknerb40a27d2014-01-03 00:14:35 +000036/// Holds all the vbtable globals for a given class.
37struct VBTableGlobals {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +000038 const VPtrInfoVector *VBTables;
Reid Klecknerb40a27d2014-01-03 00:14:35 +000039 SmallVector<llvm::GlobalVariable *, 2> Globals;
40};
41
Charles Davis53c59df2010-08-16 03:33:14 +000042class MicrosoftCXXABI : public CGCXXABI {
Charles Davis74ce8592010-06-09 23:25:41 +000043public:
David Majnemer611cdb92014-07-07 08:09:15 +000044 MicrosoftCXXABI(CodeGenModule &CGM)
45 : CGCXXABI(CGM), BaseClassDescriptorType(nullptr),
46 ClassHierarchyDescriptorType(nullptr),
David Majnemer7c237072015-03-05 00:46:22 +000047 CompleteObjectLocatorType(nullptr), CatchableTypeType(nullptr),
David Majnemer37b417f2015-03-29 21:55:10 +000048 ThrowInfoType(nullptr), CatchHandlerTypeType(nullptr) {}
John McCall5d865c322010-08-31 07:33:07 +000049
Craig Topper4f12f102014-03-12 06:41:41 +000050 bool HasThisReturn(GlobalDecl GD) const override;
David Majnemer0c0b6d92014-10-31 20:09:12 +000051 bool hasMostDerivedReturn(GlobalDecl GD) const override;
Stephen Lin9dc6eef2013-06-30 20:40:16 +000052
Reid Kleckner40ca9132014-05-13 22:05:45 +000053 bool classifyReturnType(CGFunctionInfo &FI) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000054
Reid Klecknere39ee212014-05-03 00:33:28 +000055 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000056
Reid Kleckner37abaca2014-05-09 22:46:15 +000057 bool isSRetParameterAfterThis() const override { return true; }
58
David Majnemer196ac332014-09-11 23:05:02 +000059 size_t getSrcArgforCopyCtor(const CXXConstructorDecl *CD,
60 FunctionArgList &Args) const override {
61 assert(Args.size() >= 2 &&
62 "expected the arglist to have at least two args!");
63 // The 'most_derived' parameter goes second if the ctor is variadic and
64 // has v-bases.
65 if (CD->getParent()->getNumVBases() > 0 &&
66 CD->getType()->castAs<FunctionProtoType>()->isVariadic())
67 return 2;
68 return 1;
69 }
70
Craig Topper4f12f102014-03-12 06:41:41 +000071 StringRef GetPureVirtualCallName() override { return "_purecall"; }
Craig Topper4f12f102014-03-12 06:41:41 +000072 StringRef GetDeletedVirtualCallName() override { return "_purecall"; }
Joao Matos2ce88ef2012-07-17 17:10:11 +000073
David Majnemer08681372014-11-01 07:37:17 +000074 void emitVirtualObjectDelete(CodeGenFunction &CGF, const CXXDeleteExpr *DE,
David Majnemer0c0b6d92014-10-31 20:09:12 +000075 llvm::Value *Ptr, QualType ElementType,
David Majnemer0c0b6d92014-10-31 20:09:12 +000076 const CXXDestructorDecl *Dtor) override;
John McCall82fb8922012-09-25 10:10:39 +000077
Chandler Carruth4b9e8572014-11-25 08:59:34 +000078 void emitRethrow(CodeGenFunction &CGF, bool isNoReturn) override;
David Majnemer7c237072015-03-05 00:46:22 +000079 void emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) override;
David Majnemer442d0a22014-11-25 07:20:20 +000080
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000081 void emitBeginCatch(CodeGenFunction &CGF, const CXXCatchStmt *C) override;
82
David Majnemere2cb8d12014-07-07 06:20:47 +000083 llvm::GlobalVariable *getMSCompleteObjectLocator(const CXXRecordDecl *RD,
84 const VPtrInfo *Info);
85
David Majnemer443250f2015-03-17 20:35:00 +000086 llvm::Constant *getAddrOfRTTIDescriptor(QualType Ty) override;
David Majnemer5f0dd612015-03-17 20:35:05 +000087 llvm::Constant *
David Majnemer37b417f2015-03-29 21:55:10 +000088 getAddrOfCXXCatchHandlerType(QualType Ty, QualType CatchHandlerType) override;
David Majnemere2cb8d12014-07-07 06:20:47 +000089
David Majnemer1162d252014-06-22 19:05:33 +000090 bool shouldTypeidBeNullChecked(bool IsDeref, QualType SrcRecordTy) override;
91 void EmitBadTypeidCall(CodeGenFunction &CGF) override;
92 llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy,
93 llvm::Value *ThisPtr,
94 llvm::Type *StdTypeInfoPtrTy) override;
95
96 bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
97 QualType SrcRecordTy) override;
98
99 llvm::Value *EmitDynamicCastCall(CodeGenFunction &CGF, llvm::Value *Value,
100 QualType SrcRecordTy, QualType DestTy,
101 QualType DestRecordTy,
102 llvm::BasicBlock *CastEnd) override;
103
104 llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF, llvm::Value *Value,
105 QualType SrcRecordTy,
106 QualType DestTy) override;
107
108 bool EmitBadCastCall(CodeGenFunction &CGF) override;
109
Craig Topper4f12f102014-03-12 06:41:41 +0000110 llvm::Value *
111 GetVirtualBaseClassOffset(CodeGenFunction &CGF, llvm::Value *This,
112 const CXXRecordDecl *ClassDecl,
113 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000114
Craig Topper4f12f102014-03-12 06:41:41 +0000115 llvm::BasicBlock *
116 EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
117 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000118
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000119 void initializeHiddenVirtualInheritanceMembers(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000120 const CXXRecordDecl *RD) override;
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000121
Craig Topper4f12f102014-03-12 06:41:41 +0000122 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000123
Reid Klecknere7de47e2013-07-22 13:51:44 +0000124 // Background on MSVC destructors
125 // ==============================
126 //
127 // Both Itanium and MSVC ABIs have destructor variants. The variant names
128 // roughly correspond in the following way:
129 // Itanium Microsoft
130 // Base -> no name, just ~Class
131 // Complete -> vbase destructor
132 // Deleting -> scalar deleting destructor
133 // vector deleting destructor
134 //
135 // The base and complete destructors are the same as in Itanium, although the
136 // complete destructor does not accept a VTT parameter when there are virtual
137 // bases. A separate mechanism involving vtordisps is used to ensure that
138 // virtual methods of destroyed subobjects are not called.
139 //
140 // The deleting destructors accept an i32 bitfield as a second parameter. Bit
141 // 1 indicates if the memory should be deleted. Bit 2 indicates if the this
142 // pointer points to an array. The scalar deleting destructor assumes that
143 // bit 2 is zero, and therefore does not contain a loop.
144 //
145 // For virtual destructors, only one entry is reserved in the vftable, and it
146 // always points to the vector deleting destructor. The vector deleting
147 // destructor is the most general, so it can be used to destroy objects in
148 // place, delete single heap objects, or delete arrays.
149 //
150 // A TU defining a non-inline destructor is only guaranteed to emit a base
151 // destructor, and all of the other variants are emitted on an as-needed basis
152 // in COMDATs. Because a non-base destructor can be emitted in a TU that
153 // lacks a definition for the destructor, non-base destructors must always
154 // delegate to or alias the base destructor.
155
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000156 void buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
157 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000158
Reid Klecknere7de47e2013-07-22 13:51:44 +0000159 /// Non-base dtors should be emitted as delegating thunks in this ABI.
160 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000161 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000162 return DT != Dtor_Base;
163 }
164
Craig Topper4f12f102014-03-12 06:41:41 +0000165 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000166
Craig Topper4f12f102014-03-12 06:41:41 +0000167 const CXXRecordDecl *
168 getThisArgumentTypeForMethod(const CXXMethodDecl *MD) override {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000169 MD = MD->getCanonicalDecl();
170 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD)) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000171 MicrosoftVTableContext::MethodVFTableLocation ML =
172 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000173 // The vbases might be ordered differently in the final overrider object
174 // and the complete object, so the "this" argument may sometimes point to
175 // memory that has no particular type (e.g. past the complete object).
176 // In this case, we just use a generic pointer type.
177 // FIXME: might want to have a more precise type in the non-virtual
178 // multiple inheritance case.
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +0000179 if (ML.VBase || !ML.VFPtrOffset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000180 return nullptr;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000181 }
182 return MD->getParent();
183 }
184
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000185 llvm::Value *
186 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD,
187 llvm::Value *This,
188 bool VirtualCall) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000189
Reid Kleckner89077a12013-12-17 19:46:40 +0000190 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000191 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000192
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000193 llvm::Value *adjustThisParameterInVirtualFunctionPrologue(
Craig Topper4f12f102014-03-12 06:41:41 +0000194 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000195
Craig Topper4f12f102014-03-12 06:41:41 +0000196 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall29036752011-01-27 02:46:02 +0000197
Reid Kleckner89077a12013-12-17 19:46:40 +0000198 unsigned addImplicitConstructorArgs(CodeGenFunction &CGF,
199 const CXXConstructorDecl *D,
200 CXXCtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000201 bool Delegating,
202 CallArgList &Args) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000203
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000204 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
205 CXXDtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000206 bool Delegating, llvm::Value *This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000207
Peter Collingbourned9546012015-06-19 02:30:43 +0000208 void emitVTableBitSetEntries(VPtrInfo *Info, const CXXRecordDecl *RD,
209 llvm::GlobalVariable *VTable);
210
Craig Topper4f12f102014-03-12 06:41:41 +0000211 void emitVTableDefinitions(CodeGenVTables &CGVT,
212 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000213
214 llvm::Value *getVTableAddressPointInStructor(
215 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
216 BaseSubobject Base, const CXXRecordDecl *NearestVBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000217 bool &NeedsVirtualOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000218
219 llvm::Constant *
220 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000221 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000222
223 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000224 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000225
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000226 llvm::Value *getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +0000227 llvm::Value *This, llvm::Type *Ty,
228 SourceLocation Loc) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000229
David Majnemer0c0b6d92014-10-31 20:09:12 +0000230 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF,
231 const CXXDestructorDecl *Dtor,
232 CXXDtorType DtorType,
233 llvm::Value *This,
234 const CXXMemberCallExpr *CE) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000235
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000236 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000237 CallArgList &CallArgs) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000238 assert(GD.getDtorType() == Dtor_Deleting &&
239 "Only deleting destructor thunks are available in this ABI");
240 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)),
David Majnemer9ced3dd2015-03-14 23:44:48 +0000241 getContext().IntTy);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000242 }
243
Craig Topper4f12f102014-03-12 06:41:41 +0000244 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000245
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000246 llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000247 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000248 llvm::GlobalVariable::LinkageTypes Linkage);
249
David Majnemerc1709d32015-06-23 07:31:11 +0000250 llvm::GlobalVariable *
251 getAddrOfVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
252 const CXXRecordDecl *DstRD) {
253 SmallString<256> OutName;
254 llvm::raw_svector_ostream Out(OutName);
255 getMangleContext().mangleCXXVirtualDisplacementMap(SrcRD, DstRD, Out);
256 Out.flush();
257 StringRef MangledName = OutName.str();
258
259 if (auto *VDispMap = CGM.getModule().getNamedGlobal(MangledName))
260 return VDispMap;
261
262 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
263 unsigned NumEntries = 1 + SrcRD->getNumVBases();
264 SmallVector<llvm::Constant *, 4> Map(NumEntries,
265 llvm::UndefValue::get(CGM.IntTy));
266 Map[0] = llvm::ConstantInt::get(CGM.IntTy, 0);
267 bool AnyDifferent = false;
268 for (const auto &I : SrcRD->vbases()) {
269 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
270 if (!DstRD->isVirtuallyDerivedFrom(VBase))
271 continue;
272
273 unsigned SrcVBIndex = VTContext.getVBTableIndex(SrcRD, VBase);
274 unsigned DstVBIndex = VTContext.getVBTableIndex(DstRD, VBase);
275 Map[SrcVBIndex] = llvm::ConstantInt::get(CGM.IntTy, DstVBIndex * 4);
276 AnyDifferent |= SrcVBIndex != DstVBIndex;
277 }
278 // This map would be useless, don't use it.
279 if (!AnyDifferent)
280 return nullptr;
281
282 llvm::ArrayType *VDispMapTy = llvm::ArrayType::get(CGM.IntTy, Map.size());
283 llvm::Constant *Init = llvm::ConstantArray::get(VDispMapTy, Map);
284 llvm::GlobalValue::LinkageTypes Linkage =
285 SrcRD->isExternallyVisible() && DstRD->isExternallyVisible()
286 ? llvm::GlobalValue::LinkOnceODRLinkage
287 : llvm::GlobalValue::InternalLinkage;
288 auto *VDispMap = new llvm::GlobalVariable(
289 CGM.getModule(), VDispMapTy, /*Constant=*/true, Linkage,
290 /*Initializer=*/Init, MangledName);
291 return VDispMap;
292 }
293
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000294 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000295 llvm::GlobalVariable *GV) const;
296
Hans Wennborgc94391d2014-06-06 20:04:01 +0000297 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
298 GlobalDecl GD, bool ReturnAdjustment) override {
Hans Wennborg853ae942014-05-30 16:59:42 +0000299 // Never dllimport/dllexport thunks.
300 Thunk->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
Hans Wennborgc94391d2014-06-06 20:04:01 +0000301
302 GVALinkage Linkage =
303 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
304
305 if (Linkage == GVA_Internal)
306 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
307 else if (ReturnAdjustment)
308 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
309 else
310 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000311 }
312
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000313 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, llvm::Value *This,
Craig Topper4f12f102014-03-12 06:41:41 +0000314 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000315
316 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000317 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000318
David Majnemerb3341ea2014-10-05 05:05:40 +0000319 void EmitThreadLocalInitFuncs(
320 CodeGenModule &CGM,
321 ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *>>
322 CXXThreadLocals,
323 ArrayRef<llvm::Function *> CXXThreadLocalInits,
324 ArrayRef<llvm::GlobalVariable *> CXXThreadLocalInitVars) override;
325
326 bool usesThreadWrapperFunction() const override { return false; }
327 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
328 QualType LValType) override;
329
John McCallc84ed6a2012-05-01 06:13:13 +0000330 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
331 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000332 bool PerformInit) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000333 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
334 llvm::Constant *Dtor, llvm::Constant *Addr) override;
John McCallc84ed6a2012-05-01 06:13:13 +0000335
John McCall29036752011-01-27 02:46:02 +0000336 // ==== Notes on array cookies =========
337 //
338 // MSVC seems to only use cookies when the class has a destructor; a
339 // two-argument usual array deallocation function isn't sufficient.
340 //
341 // For example, this code prints "100" and "1":
342 // struct A {
343 // char x;
344 // void *operator new[](size_t sz) {
345 // printf("%u\n", sz);
346 // return malloc(sz);
347 // }
348 // void operator delete[](void *p, size_t sz) {
349 // printf("%u\n", sz);
350 // free(p);
351 // }
352 // };
353 // int main() {
354 // A *p = new A[100];
355 // delete[] p;
356 // }
357 // Whereas it prints "104" and "104" if you give A a destructor.
John McCallb91cd662012-05-01 05:23:51 +0000358
Craig Topper4f12f102014-03-12 06:41:41 +0000359 bool requiresArrayCookie(const CXXDeleteExpr *expr,
360 QualType elementType) override;
361 bool requiresArrayCookie(const CXXNewExpr *expr) override;
362 CharUnits getArrayCookieSizeImpl(QualType type) override;
John McCallb91cd662012-05-01 05:23:51 +0000363 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
364 llvm::Value *NewPtr,
365 llvm::Value *NumElements,
366 const CXXNewExpr *expr,
Craig Topper4f12f102014-03-12 06:41:41 +0000367 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000368 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
369 llvm::Value *allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000370 CharUnits cookieSize) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000371
David Majnemer611cdb92014-07-07 08:09:15 +0000372 friend struct MSRTTIBuilder;
373
374 bool isImageRelative() const {
375 return CGM.getTarget().getPointerWidth(/*AddressSpace=*/0) == 64;
376 }
377
378 // 5 routines for constructing the llvm types for MS RTTI structs.
379 llvm::StructType *getTypeDescriptorType(StringRef TypeInfoString) {
380 llvm::SmallString<32> TDTypeName("rtti.TypeDescriptor");
381 TDTypeName += llvm::utostr(TypeInfoString.size());
382 llvm::StructType *&TypeDescriptorType =
383 TypeDescriptorTypeMap[TypeInfoString.size()];
384 if (TypeDescriptorType)
385 return TypeDescriptorType;
386 llvm::Type *FieldTypes[] = {
387 CGM.Int8PtrPtrTy,
388 CGM.Int8PtrTy,
389 llvm::ArrayType::get(CGM.Int8Ty, TypeInfoString.size() + 1)};
390 TypeDescriptorType =
391 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, TDTypeName);
392 return TypeDescriptorType;
393 }
394
395 llvm::Type *getImageRelativeType(llvm::Type *PtrType) {
396 if (!isImageRelative())
397 return PtrType;
398 return CGM.IntTy;
399 }
400
401 llvm::StructType *getBaseClassDescriptorType() {
402 if (BaseClassDescriptorType)
403 return BaseClassDescriptorType;
404 llvm::Type *FieldTypes[] = {
405 getImageRelativeType(CGM.Int8PtrTy),
406 CGM.IntTy,
407 CGM.IntTy,
408 CGM.IntTy,
409 CGM.IntTy,
410 CGM.IntTy,
411 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
412 };
413 BaseClassDescriptorType = llvm::StructType::create(
414 CGM.getLLVMContext(), FieldTypes, "rtti.BaseClassDescriptor");
415 return BaseClassDescriptorType;
416 }
417
418 llvm::StructType *getClassHierarchyDescriptorType() {
419 if (ClassHierarchyDescriptorType)
420 return ClassHierarchyDescriptorType;
421 // Forward-declare RTTIClassHierarchyDescriptor to break a cycle.
422 ClassHierarchyDescriptorType = llvm::StructType::create(
423 CGM.getLLVMContext(), "rtti.ClassHierarchyDescriptor");
424 llvm::Type *FieldTypes[] = {
425 CGM.IntTy,
426 CGM.IntTy,
427 CGM.IntTy,
428 getImageRelativeType(
429 getBaseClassDescriptorType()->getPointerTo()->getPointerTo()),
430 };
431 ClassHierarchyDescriptorType->setBody(FieldTypes);
432 return ClassHierarchyDescriptorType;
433 }
434
435 llvm::StructType *getCompleteObjectLocatorType() {
436 if (CompleteObjectLocatorType)
437 return CompleteObjectLocatorType;
438 CompleteObjectLocatorType = llvm::StructType::create(
439 CGM.getLLVMContext(), "rtti.CompleteObjectLocator");
440 llvm::Type *FieldTypes[] = {
441 CGM.IntTy,
442 CGM.IntTy,
443 CGM.IntTy,
444 getImageRelativeType(CGM.Int8PtrTy),
445 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
446 getImageRelativeType(CompleteObjectLocatorType),
447 };
448 llvm::ArrayRef<llvm::Type *> FieldTypesRef(FieldTypes);
449 if (!isImageRelative())
450 FieldTypesRef = FieldTypesRef.drop_back();
451 CompleteObjectLocatorType->setBody(FieldTypesRef);
452 return CompleteObjectLocatorType;
453 }
454
455 llvm::GlobalVariable *getImageBase() {
456 StringRef Name = "__ImageBase";
457 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name))
458 return GV;
459
460 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8Ty,
461 /*isConstant=*/true,
462 llvm::GlobalValue::ExternalLinkage,
463 /*Initializer=*/nullptr, Name);
464 }
465
466 llvm::Constant *getImageRelativeConstant(llvm::Constant *PtrVal) {
467 if (!isImageRelative())
468 return PtrVal;
469
David Majnemer7c237072015-03-05 00:46:22 +0000470 if (PtrVal->isNullValue())
471 return llvm::Constant::getNullValue(CGM.IntTy);
472
David Majnemer611cdb92014-07-07 08:09:15 +0000473 llvm::Constant *ImageBaseAsInt =
474 llvm::ConstantExpr::getPtrToInt(getImageBase(), CGM.IntPtrTy);
475 llvm::Constant *PtrValAsInt =
476 llvm::ConstantExpr::getPtrToInt(PtrVal, CGM.IntPtrTy);
477 llvm::Constant *Diff =
478 llvm::ConstantExpr::getSub(PtrValAsInt, ImageBaseAsInt,
479 /*HasNUW=*/true, /*HasNSW=*/true);
480 return llvm::ConstantExpr::getTrunc(Diff, CGM.IntTy);
481 }
482
Reid Kleckner407e8b62013-03-22 19:02:54 +0000483private:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000484 MicrosoftMangleContext &getMangleContext() {
485 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext());
486 }
487
Reid Kleckner2341ae32013-04-11 18:13:19 +0000488 llvm::Constant *getZeroInt() {
489 return llvm::ConstantInt::get(CGM.IntTy, 0);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000490 }
491
Reid Kleckner2341ae32013-04-11 18:13:19 +0000492 llvm::Constant *getAllOnesInt() {
493 return llvm::Constant::getAllOnesValue(CGM.IntTy);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000494 }
495
Reid Kleckner452abac2013-05-09 21:01:17 +0000496 llvm::Constant *getConstantOrZeroInt(llvm::Constant *C) {
497 return C ? C : getZeroInt();
498 }
499
500 llvm::Value *getValueOrZeroInt(llvm::Value *C) {
501 return C ? C : getZeroInt();
502 }
503
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000504 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD);
505
Reid Kleckner2341ae32013-04-11 18:13:19 +0000506 void
507 GetNullMemberPointerFields(const MemberPointerType *MPT,
508 llvm::SmallVectorImpl<llvm::Constant *> &fields);
509
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000510 /// \brief Shared code for virtual base adjustment. Returns the offset from
511 /// the vbptr to the virtual base. Optionally returns the address of the
512 /// vbptr itself.
513 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
514 llvm::Value *Base,
515 llvm::Value *VBPtrOffset,
516 llvm::Value *VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000517 llvm::Value **VBPtr = nullptr);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000518
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000519 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
520 llvm::Value *Base,
521 int32_t VBPtrOffset,
522 int32_t VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000523 llvm::Value **VBPtr = nullptr) {
Reid Kleckner0ba8ba42014-10-22 17:26:00 +0000524 assert(VBTableOffset % 4 == 0 && "should be byte offset into table of i32s");
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000525 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
526 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset);
527 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr);
528 }
529
David Majnemer5bc883f2015-02-27 02:38:02 +0000530 std::pair<llvm::Value *, llvm::Value *>
531 performBaseAdjustment(CodeGenFunction &CGF, llvm::Value *Value,
532 QualType SrcRecordTy);
533
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000534 /// \brief Performs a full virtual base adjustment. Used to dereference
535 /// pointers to members of virtual bases.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000536 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E,
537 const CXXRecordDecl *RD, llvm::Value *Base,
Reid Kleckner2341ae32013-04-11 18:13:19 +0000538 llvm::Value *VirtualBaseAdjustmentOffset,
539 llvm::Value *VBPtrOffset /* optional */);
540
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000541 /// \brief Emits a full member pointer with the fields common to data and
542 /// function member pointers.
543 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField,
544 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +0000545 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +0000546 CharUnits NonVirtualBaseAdjustment,
547 unsigned VBTableIndex);
Reid Kleckner452abac2013-05-09 21:01:17 +0000548
Reid Kleckner452abac2013-05-09 21:01:17 +0000549 bool MemberPointerConstantIsNull(const MemberPointerType *MPT,
550 llvm::Constant *MP);
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000551
Reid Kleckner7810af02013-06-19 15:20:38 +0000552 /// \brief - Initialize all vbptrs of 'this' with RD as the complete type.
553 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
554
555 /// \brief Caching wrapper around VBTableBuilder::enumerateVBTables().
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000556 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000557
Hans Wennborg88497d62013-11-15 17:24:45 +0000558 /// \brief Generate a thunk for calling a virtual member function MD.
Reid Klecknere4a52202014-02-21 02:27:32 +0000559 llvm::Function *EmitVirtualMemPtrThunk(
560 const CXXMethodDecl *MD,
561 const MicrosoftVTableContext::MethodVFTableLocation &ML);
Hans Wennborg88497d62013-11-15 17:24:45 +0000562
Reid Kleckner407e8b62013-03-22 19:02:54 +0000563public:
Craig Topper4f12f102014-03-12 06:41:41 +0000564 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000565
Craig Topper4f12f102014-03-12 06:41:41 +0000566 bool isZeroInitializable(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000567
David Majnemerb3e56542014-08-07 22:56:13 +0000568 bool isMemberPointerConvertible(const MemberPointerType *MPT) const override {
569 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemer99281062014-09-18 22:05:54 +0000570 return RD->hasAttr<MSInheritanceAttr>();
571 }
572
David Blaikie1cbb9712014-11-14 19:09:44 +0000573 bool isTypeInfoCalculable(QualType Ty) const override {
David Majnemer99281062014-09-18 22:05:54 +0000574 if (!CGCXXABI::isTypeInfoCalculable(Ty))
575 return false;
576 if (const auto *MPT = Ty->getAs<MemberPointerType>()) {
577 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
578 if (!RD->hasAttr<MSInheritanceAttr>())
579 return false;
580 }
581 return true;
David Majnemerb3e56542014-08-07 22:56:13 +0000582 }
583
Craig Topper4f12f102014-03-12 06:41:41 +0000584 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000585
Craig Topper4f12f102014-03-12 06:41:41 +0000586 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
587 CharUnits offset) override;
David Majnemere2be95b2015-06-23 07:31:01 +0000588 llvm::Constant *EmitMemberFunctionPointer(const CXXMethodDecl *MD) override;
Craig Topper4f12f102014-03-12 06:41:41 +0000589 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000590
Craig Topper4f12f102014-03-12 06:41:41 +0000591 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
592 llvm::Value *L,
593 llvm::Value *R,
594 const MemberPointerType *MPT,
595 bool Inequality) override;
Reid Kleckner700c3ee2013-04-30 20:15:14 +0000596
Craig Topper4f12f102014-03-12 06:41:41 +0000597 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
598 llvm::Value *MemPtr,
599 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000600
Craig Topper4f12f102014-03-12 06:41:41 +0000601 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000602 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
603 llvm::Value *Base, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000604 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000605
Craig Topper4f12f102014-03-12 06:41:41 +0000606 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
607 const CastExpr *E,
608 llvm::Value *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000609
Craig Topper4f12f102014-03-12 06:41:41 +0000610 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
611 llvm::Constant *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000612
David Majnemer5ca193c2015-06-23 07:31:07 +0000613 llvm::Constant *EmitMemberPointerConversion(
614 const MemberPointerType *SrcTy, const MemberPointerType *DstTy,
615 CastKind CK, CastExpr::path_const_iterator PathBegin,
616 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src);
617
Craig Topper4f12f102014-03-12 06:41:41 +0000618 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000619 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E,
620 llvm::Value *&This, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000621 const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000622
Rafael Espindola91f68b42014-09-15 19:20:10 +0000623 void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) override;
624
David Majnemer37b417f2015-03-29 21:55:10 +0000625 llvm::StructType *getCatchHandlerTypeType() {
626 if (!CatchHandlerTypeType) {
David Majnemer5f0dd612015-03-17 20:35:05 +0000627 llvm::Type *FieldTypes[] = {
David Majnemer37b417f2015-03-29 21:55:10 +0000628 CGM.IntTy, // Flags
629 CGM.Int8PtrTy, // TypeDescriptor
David Majnemer5f0dd612015-03-17 20:35:05 +0000630 };
David Majnemer37b417f2015-03-29 21:55:10 +0000631 CatchHandlerTypeType = llvm::StructType::create(
632 CGM.getLLVMContext(), FieldTypes, "eh.CatchHandlerType");
David Majnemer5f0dd612015-03-17 20:35:05 +0000633 }
David Majnemer37b417f2015-03-29 21:55:10 +0000634 return CatchHandlerTypeType;
David Majnemer5f0dd612015-03-17 20:35:05 +0000635 }
636
David Majnemer7c237072015-03-05 00:46:22 +0000637 llvm::StructType *getCatchableTypeType() {
638 if (CatchableTypeType)
639 return CatchableTypeType;
640 llvm::Type *FieldTypes[] = {
641 CGM.IntTy, // Flags
642 getImageRelativeType(CGM.Int8PtrTy), // TypeDescriptor
643 CGM.IntTy, // NonVirtualAdjustment
644 CGM.IntTy, // OffsetToVBPtr
645 CGM.IntTy, // VBTableIndex
646 CGM.IntTy, // Size
647 getImageRelativeType(CGM.Int8PtrTy) // CopyCtor
648 };
649 CatchableTypeType = llvm::StructType::create(
650 CGM.getLLVMContext(), FieldTypes, "eh.CatchableType");
651 return CatchableTypeType;
652 }
653
654 llvm::StructType *getCatchableTypeArrayType(uint32_t NumEntries) {
655 llvm::StructType *&CatchableTypeArrayType =
656 CatchableTypeArrayTypeMap[NumEntries];
657 if (CatchableTypeArrayType)
658 return CatchableTypeArrayType;
659
660 llvm::SmallString<23> CTATypeName("eh.CatchableTypeArray.");
661 CTATypeName += llvm::utostr(NumEntries);
662 llvm::Type *CTType =
663 getImageRelativeType(getCatchableTypeType()->getPointerTo());
664 llvm::Type *FieldTypes[] = {
665 CGM.IntTy, // NumEntries
666 llvm::ArrayType::get(CTType, NumEntries) // CatchableTypes
667 };
668 CatchableTypeArrayType =
669 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, CTATypeName);
670 return CatchableTypeArrayType;
671 }
672
673 llvm::StructType *getThrowInfoType() {
674 if (ThrowInfoType)
675 return ThrowInfoType;
676 llvm::Type *FieldTypes[] = {
677 CGM.IntTy, // Flags
678 getImageRelativeType(CGM.Int8PtrTy), // CleanupFn
679 getImageRelativeType(CGM.Int8PtrTy), // ForwardCompat
680 getImageRelativeType(CGM.Int8PtrTy) // CatchableTypeArray
681 };
682 ThrowInfoType = llvm::StructType::create(CGM.getLLVMContext(), FieldTypes,
683 "eh.ThrowInfo");
684 return ThrowInfoType;
685 }
686
687 llvm::Constant *getThrowFn() {
688 // _CxxThrowException is passed an exception object and a ThrowInfo object
689 // which describes the exception.
690 llvm::Type *Args[] = {CGM.Int8PtrTy, getThrowInfoType()->getPointerTo()};
691 llvm::FunctionType *FTy =
692 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
693 auto *Fn = cast<llvm::Function>(
694 CGM.CreateRuntimeFunction(FTy, "_CxxThrowException"));
695 // _CxxThrowException is stdcall on 32-bit x86 platforms.
696 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::x86)
697 Fn->setCallingConv(llvm::CallingConv::X86_StdCall);
698 return Fn;
699 }
700
David Majnemer37fd66e2015-03-13 22:36:55 +0000701 llvm::Function *getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
702 CXXCtorType CT);
David Majnemerdfa6d202015-03-11 18:36:39 +0000703
David Majnemer7c237072015-03-05 00:46:22 +0000704 llvm::Constant *getCatchableType(QualType T,
705 uint32_t NVOffset = 0,
706 int32_t VBPtrOffset = -1,
707 uint32_t VBIndex = 0);
708
709 llvm::GlobalVariable *getCatchableTypeArray(QualType T);
710
David Majnemerba3e5ec2015-03-13 18:26:17 +0000711 llvm::GlobalVariable *getThrowInfo(QualType T) override;
David Majnemer7c237072015-03-05 00:46:22 +0000712
Reid Kleckner7810af02013-06-19 15:20:38 +0000713private:
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000714 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy;
David Majnemerd905da42014-07-01 20:30:31 +0000715 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy;
716 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000717 /// \brief All the vftables that have been referenced.
718 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000719 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000720
721 /// \brief This set holds the record decls we've deferred vtable emission for.
722 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
723
724
725 /// \brief All the vbtables which have been referenced.
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000726 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap;
Reid Klecknerd8110b62013-09-10 20:14:30 +0000727
728 /// Info on the global variable used to guard initialization of static locals.
729 /// The BitIndex field is only used for externally invisible declarations.
730 struct GuardInfo {
Craig Topper8a13c412014-05-21 05:09:00 +0000731 GuardInfo() : Guard(nullptr), BitIndex(0) {}
Reid Klecknerd8110b62013-09-10 20:14:30 +0000732 llvm::GlobalVariable *Guard;
733 unsigned BitIndex;
734 };
735
736 /// Map from DeclContext to the current guard variable. We assume that the
737 /// AST is visited in source code order.
738 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap;
David Majnemerec8e54b2015-05-07 21:19:06 +0000739 llvm::DenseMap<const DeclContext *, GuardInfo> ThreadLocalGuardVariableMap;
David Majnemer8354eee2015-05-07 06:15:46 +0000740 llvm::DenseMap<const DeclContext *, unsigned> ThreadSafeGuardNumMap;
David Majnemer611cdb92014-07-07 08:09:15 +0000741
742 llvm::DenseMap<size_t, llvm::StructType *> TypeDescriptorTypeMap;
743 llvm::StructType *BaseClassDescriptorType;
744 llvm::StructType *ClassHierarchyDescriptorType;
745 llvm::StructType *CompleteObjectLocatorType;
David Majnemer7c237072015-03-05 00:46:22 +0000746
747 llvm::DenseMap<QualType, llvm::GlobalVariable *> CatchableTypeArrays;
748
749 llvm::StructType *CatchableTypeType;
750 llvm::DenseMap<uint32_t, llvm::StructType *> CatchableTypeArrayTypeMap;
751 llvm::StructType *ThrowInfoType;
David Majnemer37b417f2015-03-29 21:55:10 +0000752 llvm::StructType *CatchHandlerTypeType;
Charles Davis74ce8592010-06-09 23:25:41 +0000753};
754
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000755}
Charles Davis74ce8592010-06-09 23:25:41 +0000756
Reid Klecknere39ee212014-05-03 00:33:28 +0000757CGCXXABI::RecordArgABI
758MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const {
759 switch (CGM.getTarget().getTriple().getArch()) {
760 default:
761 // FIXME: Implement for other architectures.
762 return RAA_Default;
763
764 case llvm::Triple::x86:
Reid Klecknercf87e102014-05-14 16:02:09 +0000765 // All record arguments are passed in memory on x86. Decide whether to
766 // construct the object directly in argument memory, or to construct the
767 // argument elsewhere and copy the bytes during the call.
768
769 // If C++ prohibits us from making a copy, construct the arguments directly
770 // into argument memory.
771 if (!canCopyArgument(RD))
Reid Klecknere39ee212014-05-03 00:33:28 +0000772 return RAA_DirectInMemory;
Reid Klecknercf87e102014-05-14 16:02:09 +0000773
774 // Otherwise, construct the argument into a temporary and copy the bytes
775 // into the outgoing argument memory.
Reid Klecknere39ee212014-05-03 00:33:28 +0000776 return RAA_Default;
777
778 case llvm::Triple::x86_64:
779 // Win64 passes objects with non-trivial copy ctors indirectly.
780 if (RD->hasNonTrivialCopyConstructor())
781 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000782
Reid Kleckner80944df2014-10-31 22:00:51 +0000783 // If an object has a destructor, we'd really like to pass it indirectly
784 // because it allows us to elide copies. Unfortunately, MSVC makes that
785 // impossible for small types, which it will pass in a single register or
786 // stack slot. Most objects with dtors are large-ish, so handle that early.
787 // We can't call out all large objects as being indirect because there are
788 // multiple x64 calling conventions and the C++ ABI code shouldn't dictate
789 // how we pass large POD types.
790 if (RD->hasNonTrivialDestructor() &&
791 getContext().getTypeSize(RD->getTypeForDecl()) > 64)
Reid Klecknere39ee212014-05-03 00:33:28 +0000792 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000793
794 // We have a trivial copy constructor or no copy constructors, but we have
795 // to make sure it isn't deleted.
796 bool CopyDeleted = false;
797 for (const CXXConstructorDecl *CD : RD->ctors()) {
798 if (CD->isCopyConstructor()) {
799 assert(CD->isTrivial());
800 // We had at least one undeleted trivial copy ctor. Return directly.
801 if (!CD->isDeleted())
802 return RAA_Default;
803 CopyDeleted = true;
804 }
805 }
806
807 // The trivial copy constructor was deleted. Return indirectly.
808 if (CopyDeleted)
809 return RAA_Indirect;
810
811 // There were no copy ctors. Return in RAX.
Reid Klecknere39ee212014-05-03 00:33:28 +0000812 return RAA_Default;
813 }
814
815 llvm_unreachable("invalid enum");
816}
817
David Majnemer08681372014-11-01 07:37:17 +0000818void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
819 const CXXDeleteExpr *DE,
820 llvm::Value *Ptr,
821 QualType ElementType,
822 const CXXDestructorDecl *Dtor) {
David Majnemer0c0b6d92014-10-31 20:09:12 +0000823 // FIXME: Provide a source location here even though there's no
824 // CXXMemberCallExpr for dtor call.
David Majnemer08681372014-11-01 07:37:17 +0000825 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000826 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
827 llvm::Value *MDThis =
828 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr);
829 if (UseGlobalDelete)
David Majnemer08681372014-11-01 07:37:17 +0000830 CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType);
John McCall82fb8922012-09-25 10:10:39 +0000831}
832
David Majnemer442d0a22014-11-25 07:20:20 +0000833void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
David Majnemer7c237072015-03-05 00:46:22 +0000834 llvm::Value *Args[] = {
835 llvm::ConstantPointerNull::get(CGM.Int8PtrTy),
836 llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())};
837 auto *Fn = getThrowFn();
David Majnemer442d0a22014-11-25 07:20:20 +0000838 if (isNoReturn)
839 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args);
840 else
841 CGF.EmitRuntimeCallOrInvoke(Fn, Args);
842}
843
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000844namespace {
845struct CallEndCatchMSVC : EHScopeStack::Cleanup {
846 CallEndCatchMSVC() {}
847 void Emit(CodeGenFunction &CGF, Flags flags) override {
848 CGF.EmitNounwindRuntimeCall(
849 CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_endcatch));
850 }
851};
852}
853
854void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF,
855 const CXXCatchStmt *S) {
856 // In the MS ABI, the runtime handles the copy, and the catch handler is
857 // responsible for destruction.
858 VarDecl *CatchParam = S->getExceptionDecl();
859 llvm::Value *Exn = CGF.getExceptionFromSlot();
860 llvm::Function *BeginCatch =
861 CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_begincatch);
862
Reid Kleckner67cf0352015-04-07 00:09:59 +0000863 // If this is a catch-all or the catch parameter is unnamed, we don't need to
864 // emit an alloca to the object.
865 if (!CatchParam || !CatchParam->getDeclName()) {
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000866 llvm::Value *Args[2] = {Exn, llvm::Constant::getNullValue(CGF.Int8PtrTy)};
867 CGF.EmitNounwindRuntimeCall(BeginCatch, Args);
Reid Kleckner7d4bc9c2015-04-22 23:39:15 +0000868 CGF.EHStack.pushCleanup<CallEndCatchMSVC>(NormalCleanup);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000869 return;
870 }
871
872 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
873 llvm::Value *ParamAddr =
874 CGF.Builder.CreateBitCast(var.getObjectAddress(CGF), CGF.Int8PtrTy);
875 llvm::Value *Args[2] = {Exn, ParamAddr};
876 CGF.EmitNounwindRuntimeCall(BeginCatch, Args);
Reid Kleckner7d4bc9c2015-04-22 23:39:15 +0000877 CGF.EHStack.pushCleanup<CallEndCatchMSVC>(NormalCleanup);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000878 CGF.EmitAutoVarCleanups(var);
879}
880
David Majnemer5bc883f2015-02-27 02:38:02 +0000881std::pair<llvm::Value *, llvm::Value *>
882MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, llvm::Value *Value,
883 QualType SrcRecordTy) {
David Majnemer1162d252014-06-22 19:05:33 +0000884 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
885 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
David Majnemer9ced3dd2015-03-14 23:44:48 +0000886 const ASTContext &Context = getContext();
David Majnemer1162d252014-06-22 19:05:33 +0000887
David Majnemer5bc883f2015-02-27 02:38:02 +0000888 if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
David Majnemer1162d252014-06-22 19:05:33 +0000889 return std::make_pair(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0));
890
891 // Perform a base adjustment.
David Majnemer5bc883f2015-02-27 02:38:02 +0000892 const CXXBaseSpecifier *PolymorphicBase = std::find_if(
893 SrcDecl->vbases_begin(), SrcDecl->vbases_end(),
894 [&](const CXXBaseSpecifier &Base) {
895 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
896 return Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr();
897 });
898 llvm::Value *Offset = GetVirtualBaseClassOffset(
899 CGF, Value, SrcDecl, PolymorphicBase->getType()->getAsCXXRecordDecl());
David Majnemer1162d252014-06-22 19:05:33 +0000900 Value = CGF.Builder.CreateInBoundsGEP(Value, Offset);
901 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
902 return std::make_pair(Value, Offset);
903}
904
905bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
906 QualType SrcRecordTy) {
907 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
908 return IsDeref &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000909 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000910}
911
912static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF,
913 llvm::Value *Argument) {
914 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
915 llvm::FunctionType *FTy =
916 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
917 llvm::Value *Args[] = {Argument};
918 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
919 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
920}
921
922void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
923 llvm::CallSite Call =
924 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
925 Call.setDoesNotReturn();
926 CGF.Builder.CreateUnreachable();
927}
928
929llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
930 QualType SrcRecordTy,
931 llvm::Value *ThisPtr,
932 llvm::Type *StdTypeInfoPtrTy) {
933 llvm::Value *Offset;
934 std::tie(ThisPtr, Offset) = performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
935 return CGF.Builder.CreateBitCast(
936 emitRTtypeidCall(CGF, ThisPtr).getInstruction(), StdTypeInfoPtrTy);
937}
938
939bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
940 QualType SrcRecordTy) {
941 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
942 return SrcIsPtr &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000943 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000944}
945
946llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
947 CodeGenFunction &CGF, llvm::Value *Value, QualType SrcRecordTy,
948 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
949 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
950
951 llvm::Value *SrcRTTI =
952 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
953 llvm::Value *DestRTTI =
954 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
955
956 llvm::Value *Offset;
957 std::tie(Value, Offset) = performBaseAdjustment(CGF, Value, SrcRecordTy);
958
959 // PVOID __RTDynamicCast(
960 // PVOID inptr,
961 // LONG VfDelta,
962 // PVOID SrcType,
963 // PVOID TargetType,
964 // BOOL isReference)
965 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
966 CGF.Int8PtrTy, CGF.Int32Ty};
967 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
968 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
969 "__RTDynamicCast");
970 llvm::Value *Args[] = {
971 Value, Offset, SrcRTTI, DestRTTI,
972 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
973 Value = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction();
974 return CGF.Builder.CreateBitCast(Value, DestLTy);
975}
976
977llvm::Value *
978MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, llvm::Value *Value,
979 QualType SrcRecordTy,
980 QualType DestTy) {
981 llvm::Value *Offset;
982 std::tie(Value, Offset) = performBaseAdjustment(CGF, Value, SrcRecordTy);
983
984 // PVOID __RTCastToVoid(
985 // PVOID inptr)
986 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
987 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
988 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
989 "__RTCastToVoid");
990 llvm::Value *Args[] = {Value};
991 return CGF.EmitRuntimeCall(Function, Args);
992}
993
994bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
995 return false;
996}
997
David Majnemerca32f932014-09-01 18:50:02 +0000998llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
999 CodeGenFunction &CGF, llvm::Value *This, const CXXRecordDecl *ClassDecl,
1000 const CXXRecordDecl *BaseClassDecl) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00001001 const ASTContext &Context = getContext();
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00001002 int64_t VBPtrChars =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001003 Context.getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001004 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
David Majnemer9ced3dd2015-03-14 23:44:48 +00001005 CharUnits IntSize = Context.getTypeSizeInChars(Context.IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001006 CharUnits VBTableChars =
1007 IntSize *
1008 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001009 llvm::Value *VBTableOffset =
David Majnemerca32f932014-09-01 18:50:02 +00001010 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001011
1012 llvm::Value *VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001013 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001014 VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +00001015 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001016 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
1017}
1018
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001019bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
1020 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +00001021}
1022
David Majnemer0c0b6d92014-10-31 20:09:12 +00001023static bool isDeletingDtor(GlobalDecl GD) {
1024 return isa<CXXDestructorDecl>(GD.getDecl()) &&
1025 GD.getDtorType() == Dtor_Deleting;
1026}
1027
1028bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const {
1029 return isDeletingDtor(GD);
1030}
1031
Reid Kleckner40ca9132014-05-13 22:05:45 +00001032bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
1033 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
1034 if (!RD)
1035 return false;
1036
1037 if (FI.isInstanceMethod()) {
1038 // If it's an instance method, aggregates are always returned indirectly via
1039 // the second parameter.
1040 FI.getReturnInfo() = ABIArgInfo::getIndirect(0, /*ByVal=*/false);
1041 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod());
1042 return true;
1043 } else if (!RD->isPOD()) {
1044 // If it's a free function, non-POD types are returned indirectly.
1045 FI.getReturnInfo() = ABIArgInfo::getIndirect(0, /*ByVal=*/false);
1046 return true;
1047 }
1048
1049 // Otherwise, use the C ABI rules.
1050 return false;
1051}
1052
Reid Kleckner7810af02013-06-19 15:20:38 +00001053llvm::BasicBlock *
1054MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
1055 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001056 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1057 assert(IsMostDerivedClass &&
1058 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +00001059 llvm::Value *IsCompleteObject =
1060 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001061
1062 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
1063 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
1064 CGF.Builder.CreateCondBr(IsCompleteObject,
1065 CallVbaseCtorsBB, SkipVbaseCtorsBB);
1066
1067 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +00001068
1069 // Fill in the vbtable pointers here.
1070 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001071
1072 // CGF will put the base ctor calls in this basic block for us later.
1073
1074 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +00001075}
1076
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001077void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
1078 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
1079 // In most cases, an override for a vbase virtual method can adjust
1080 // the "this" parameter by applying a constant offset.
1081 // However, this is not enough while a constructor or a destructor of some
1082 // class X is being executed if all the following conditions are met:
1083 // - X has virtual bases, (1)
1084 // - X overrides a virtual method M of a vbase Y, (2)
1085 // - X itself is a vbase of the most derived class.
1086 //
1087 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
1088 // which holds the extra amount of "this" adjustment we must do when we use
1089 // the X vftables (i.e. during X ctor or dtor).
1090 // Outside the ctors and dtors, the values of vtorDisps are zero.
1091
1092 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
1093 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
1094 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
1095 CGBuilderTy &Builder = CGF.Builder;
1096
1097 unsigned AS =
1098 cast<llvm::PointerType>(getThisValue(CGF)->getType())->getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +00001099 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001100
1101 for (VBOffsets::const_iterator I = VBaseMap.begin(), E = VBaseMap.end();
1102 I != E; ++I) {
1103 if (!I->second.hasVtorDisp())
1104 continue;
1105
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +00001106 llvm::Value *VBaseOffset =
1107 GetVirtualBaseClassOffset(CGF, getThisValue(CGF), RD, I->first);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001108 // FIXME: it doesn't look right that we SExt in GetVirtualBaseClassOffset()
1109 // just to Trunc back immediately.
1110 VBaseOffset = Builder.CreateTruncOrBitCast(VBaseOffset, CGF.Int32Ty);
1111 uint64_t ConstantVBaseOffset =
1112 Layout.getVBaseClassOffset(I->first).getQuantity();
1113
1114 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
1115 llvm::Value *VtorDispValue = Builder.CreateSub(
1116 VBaseOffset, llvm::ConstantInt::get(CGM.Int32Ty, ConstantVBaseOffset),
1117 "vtordisp.value");
1118
1119 if (!Int8This)
1120 Int8This = Builder.CreateBitCast(getThisValue(CGF),
1121 CGF.Int8Ty->getPointerTo(AS));
1122 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
1123 // vtorDisp is always the 32-bits before the vbase in the class layout.
1124 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
1125 VtorDispPtr = Builder.CreateBitCast(
1126 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
1127
1128 Builder.CreateStore(VtorDispValue, VtorDispPtr);
1129 }
1130}
1131
David Majnemer37fd66e2015-03-13 22:36:55 +00001132static bool hasDefaultCXXMethodCC(ASTContext &Context,
1133 const CXXMethodDecl *MD) {
1134 CallingConv ExpectedCallingConv = Context.getDefaultCallingConvention(
1135 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1136 CallingConv ActualCallingConv =
1137 MD->getType()->getAs<FunctionProtoType>()->getCallConv();
1138 return ExpectedCallingConv == ActualCallingConv;
1139}
1140
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001141void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1142 // There's only one constructor type in this ABI.
1143 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
David Majnemer37fd66e2015-03-13 22:36:55 +00001144
1145 // Exported default constructors either have a simple call-site where they use
1146 // the typical calling convention and have a single 'this' pointer for an
1147 // argument -or- they get a wrapper function which appropriately thunks to the
1148 // real default constructor. This thunk is the default constructor closure.
1149 if (D->hasAttr<DLLExportAttr>() && D->isDefaultConstructor())
1150 if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) {
1151 llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure);
1152 Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage);
1153 Fn->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1154 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001155}
1156
Reid Kleckner7810af02013-06-19 15:20:38 +00001157void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1158 const CXXRecordDecl *RD) {
1159 llvm::Value *ThisInt8Ptr =
1160 CGF.Builder.CreateBitCast(getThisValue(CGF), CGM.Int8PtrTy, "this.int8");
David Majnemer9ced3dd2015-03-14 23:44:48 +00001161 const ASTContext &Context = getContext();
1162 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001163
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001164 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1165 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001166 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001167 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +00001168 const ASTRecordLayout &SubobjectLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001169 Context.getASTRecordLayout(VBT->BaseWithVPtr);
Reid Kleckner5f080942014-01-03 23:42:00 +00001170 CharUnits Offs = VBT->NonVirtualOffset;
1171 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001172 if (VBT->getVBaseWithVPtr())
1173 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
Reid Kleckner7810af02013-06-19 15:20:38 +00001174 llvm::Value *VBPtr =
Reid Kleckner5f080942014-01-03 23:42:00 +00001175 CGF.Builder.CreateConstInBoundsGEP1_64(ThisInt8Ptr, Offs.getQuantity());
David Blaikie1ed728c2015-04-05 22:45:47 +00001176 llvm::Value *GVPtr =
1177 CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0);
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001178 VBPtr = CGF.Builder.CreateBitCast(VBPtr, GVPtr->getType()->getPointerTo(0),
Reid Kleckner5f080942014-01-03 23:42:00 +00001179 "vbptr." + VBT->ReusingBase->getName());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001180 CGF.Builder.CreateStore(GVPtr, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +00001181 }
1182}
1183
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001184void
1185MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001186 SmallVectorImpl<CanQualType> &ArgTys) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001187 // TODO: 'for base' flag
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001188 if (T == StructorType::Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001189 // The scalar deleting destructor takes an implicit int parameter.
David Majnemer9ced3dd2015-03-14 23:44:48 +00001190 ArgTys.push_back(getContext().IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001191 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001192 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
1193 if (!CD)
1194 return;
1195
1196 // All parameters are already in place except is_most_derived, which goes
1197 // after 'this' if it's variadic and last if it's not.
1198
1199 const CXXRecordDecl *Class = CD->getParent();
1200 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1201 if (Class->getNumVBases()) {
1202 if (FPT->isVariadic())
David Majnemer9ced3dd2015-03-14 23:44:48 +00001203 ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001204 else
David Majnemer9ced3dd2015-03-14 23:44:48 +00001205 ArgTys.push_back(getContext().IntTy);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001206 }
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001207}
1208
Reid Klecknere7de47e2013-07-22 13:51:44 +00001209void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1210 // The TU defining a dtor is only guaranteed to emit a base destructor. All
1211 // other destructor variants are delegating thunks.
1212 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1213}
1214
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001215CharUnits
1216MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001217 GD = GD.getCanonicalDecl();
1218 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001219
1220 GlobalDecl LookupGD = GD;
1221 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1222 // Complete destructors take a pointer to the complete object as a
1223 // parameter, thus don't need this adjustment.
1224 if (GD.getDtorType() == Dtor_Complete)
1225 return CharUnits();
1226
1227 // There's no Dtor_Base in vftable but it shares the this adjustment with
1228 // the deleting one, so look it up instead.
1229 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1230 }
1231
1232 MicrosoftVTableContext::MethodVFTableLocation ML =
1233 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
1234 CharUnits Adjustment = ML.VFPtrOffset;
1235
1236 // Normal virtual instance methods need to adjust from the vfptr that first
1237 // defined the virtual method to the virtual base subobject, but destructors
1238 // do not. The vector deleting destructor thunk applies this adjustment for
1239 // us if necessary.
1240 if (isa<CXXDestructorDecl>(MD))
1241 Adjustment = CharUnits::Zero();
1242
1243 if (ML.VBase) {
1244 const ASTRecordLayout &DerivedLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001245 getContext().getASTRecordLayout(MD->getParent());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001246 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1247 }
1248
1249 return Adjustment;
1250}
1251
1252llvm::Value *MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1253 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This, bool VirtualCall) {
1254 if (!VirtualCall) {
1255 // If the call of a virtual function is not virtual, we just have to
1256 // compensate for the adjustment the virtual function does in its prologue.
1257 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1258 if (Adjustment.isZero())
1259 return This;
1260
1261 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1262 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS);
1263 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1264 assert(Adjustment.isPositive());
1265 return CGF.Builder.CreateConstGEP1_32(This, Adjustment.getQuantity());
1266 }
1267
1268 GD = GD.getCanonicalDecl();
1269 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001270
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001271 GlobalDecl LookupGD = GD;
1272 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1273 // Complete dtors take a pointer to the complete object,
1274 // thus don't need adjustment.
1275 if (GD.getDtorType() == Dtor_Complete)
1276 return This;
1277
1278 // There's only Dtor_Deleting in vftable but it shares the this adjustment
1279 // with the base one, so look up the deleting one instead.
1280 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1281 }
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001282 MicrosoftVTableContext::MethodVFTableLocation ML =
1283 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001284
1285 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1286 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS);
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001287 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001288
1289 // Base destructors expect 'this' to point to the beginning of the base
1290 // subobject, not the first vfptr that happens to contain the virtual dtor.
1291 // However, we still need to apply the virtual base adjustment.
1292 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1293 StaticOffset = CharUnits::Zero();
1294
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001295 if (ML.VBase) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001296 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1297 llvm::Value *VBaseOffset =
1298 GetVirtualBaseClassOffset(CGF, This, MD->getParent(), ML.VBase);
1299 This = CGF.Builder.CreateInBoundsGEP(This, VBaseOffset);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001300 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001301 if (!StaticOffset.isZero()) {
1302 assert(StaticOffset.isPositive());
1303 This = CGF.Builder.CreateBitCast(This, charPtrTy);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001304 if (ML.VBase) {
1305 // Non-virtual adjustment might result in a pointer outside the allocated
1306 // object, e.g. if the final overrider class is laid out after the virtual
1307 // base that declares a method in the most derived class.
1308 // FIXME: Update the code that emits this adjustment in thunks prologues.
1309 This = CGF.Builder.CreateConstGEP1_32(This, StaticOffset.getQuantity());
1310 } else {
David Blaikiefb901c7a2015-04-04 15:12:29 +00001311 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001312 StaticOffset.getQuantity());
1313 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001314 }
1315 return This;
1316}
1317
Reid Kleckner89077a12013-12-17 19:46:40 +00001318void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1319 QualType &ResTy,
1320 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001321 ASTContext &Context = getContext();
1322 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001323 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001324 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1325 ImplicitParamDecl *IsMostDerived
Craig Topper8a13c412014-05-21 05:09:00 +00001326 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001327 CGF.CurGD.getDecl()->getLocation(),
1328 &Context.Idents.get("is_most_derived"),
1329 Context.IntTy);
Reid Kleckner89077a12013-12-17 19:46:40 +00001330 // The 'most_derived' parameter goes second if the ctor is variadic and last
1331 // if it's not. Dtors can't be variadic.
1332 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1333 if (FPT->isVariadic())
1334 Params.insert(Params.begin() + 1, IsMostDerived);
1335 else
1336 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001337 getStructorImplicitParamDecl(CGF) = IsMostDerived;
David Majnemer0c0b6d92014-10-31 20:09:12 +00001338 } else if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001339 ImplicitParamDecl *ShouldDelete
Craig Topper8a13c412014-05-21 05:09:00 +00001340 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001341 CGF.CurGD.getDecl()->getLocation(),
1342 &Context.Idents.get("should_call_delete"),
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001343 Context.IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001344 Params.push_back(ShouldDelete);
1345 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1346 }
John McCall0f999f32012-09-25 08:00:39 +00001347}
1348
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001349llvm::Value *MicrosoftCXXABI::adjustThisParameterInVirtualFunctionPrologue(
1350 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001351 // In this ABI, every virtual function takes a pointer to one of the
1352 // subobjects that first defines it as the 'this' parameter, rather than a
Alp Tokerf6a24ce2013-12-05 16:25:25 +00001353 // pointer to the final overrider subobject. Thus, we need to adjust it back
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001354 // to the final overrider subobject before use.
1355 // See comments in the MicrosoftVFTableContext implementation for the details.
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001356 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001357 if (Adjustment.isZero())
1358 return This;
1359
1360 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1361 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1362 *thisTy = This->getType();
1363
1364 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1365 assert(Adjustment.isPositive());
David Blaikiefb901c7a2015-04-04 15:12:29 +00001366 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
1367 -Adjustment.getQuantity());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001368 return CGF.Builder.CreateBitCast(This, thisTy);
1369}
1370
John McCall0f999f32012-09-25 08:00:39 +00001371void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
1372 EmitThisParam(CGF);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001373
1374 /// If this is a function that the ABI specifies returns 'this', initialize
1375 /// the return slot to 'this' at the start of the function.
1376 ///
1377 /// Unlike the setting of return types, this is done within the ABI
1378 /// implementation instead of by clients of CGCXXABI because:
1379 /// 1) getThisValue is currently protected
1380 /// 2) in theory, an ABI could implement 'this' returns some other way;
1381 /// HasThisReturn only specifies a contract, not the implementation
1382 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001383 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001384 else if (hasMostDerivedReturn(CGF.CurGD))
1385 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1386 CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001387
1388 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1389 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1390 assert(getStructorImplicitParamDecl(CGF) &&
1391 "no implicit parameter for a constructor with virtual bases?");
1392 getStructorImplicitParamValue(CGF)
1393 = CGF.Builder.CreateLoad(
1394 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1395 "is_most_derived");
1396 }
1397
David Majnemer0c0b6d92014-10-31 20:09:12 +00001398 if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001399 assert(getStructorImplicitParamDecl(CGF) &&
1400 "no implicit parameter for a deleting destructor?");
1401 getStructorImplicitParamValue(CGF)
1402 = CGF.Builder.CreateLoad(
1403 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1404 "should_call_delete");
1405 }
John McCall0f999f32012-09-25 08:00:39 +00001406}
1407
Reid Kleckner89077a12013-12-17 19:46:40 +00001408unsigned MicrosoftCXXABI::addImplicitConstructorArgs(
1409 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1410 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001411 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001412
Reid Kleckner89077a12013-12-17 19:46:40 +00001413 // Check if we need a 'most_derived' parameter.
1414 if (!D->getParent()->getNumVBases())
1415 return 0;
1416
1417 // Add the 'most_derived' argument second if we are variadic or last if not.
1418 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
1419 llvm::Value *MostDerivedArg =
1420 llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
1421 RValue RV = RValue::get(MostDerivedArg);
1422 if (MostDerivedArg) {
1423 if (FPT->isVariadic())
1424 Args.insert(Args.begin() + 1,
1425 CallArg(RV, getContext().IntTy, /*needscopy=*/false));
1426 else
1427 Args.add(RV, getContext().IntTy);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001428 }
1429
Reid Kleckner89077a12013-12-17 19:46:40 +00001430 return 1; // Added one arg.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001431}
1432
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001433void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1434 const CXXDestructorDecl *DD,
1435 CXXDtorType Type, bool ForVirtualBase,
1436 bool Delegating, llvm::Value *This) {
Rafael Espindola1ac0ec82014-09-11 15:42:06 +00001437 llvm::Value *Callee = CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type));
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001438
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001439 if (DD->isVirtual()) {
1440 assert(Type != CXXDtorType::Dtor_Deleting &&
1441 "The deleting destructor should only be called via a virtual call");
1442 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1443 This, false);
1444 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001445
David Majnemer0c0b6d92014-10-31 20:09:12 +00001446 CGF.EmitCXXStructorCall(DD, Callee, ReturnValueSlot(), This,
1447 /*ImplicitParam=*/nullptr,
1448 /*ImplicitParamTy=*/QualType(), nullptr,
1449 getFromDtorType(Type));
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001450}
1451
Peter Collingbourned9546012015-06-19 02:30:43 +00001452void MicrosoftCXXABI::emitVTableBitSetEntries(VPtrInfo *Info,
1453 const CXXRecordDecl *RD,
1454 llvm::GlobalVariable *VTable) {
1455 if (!getContext().getLangOpts().Sanitize.has(SanitizerKind::CFIVCall) &&
1456 !getContext().getLangOpts().Sanitize.has(SanitizerKind::CFINVCall) &&
1457 !getContext().getLangOpts().Sanitize.has(SanitizerKind::CFIDerivedCast) &&
1458 !getContext().getLangOpts().Sanitize.has(SanitizerKind::CFIUnrelatedCast))
1459 return;
1460
1461 llvm::NamedMDNode *BitsetsMD =
1462 CGM.getModule().getOrInsertNamedMetadata("llvm.bitsets");
1463 CharUnits PointerWidth = getContext().toCharUnitsFromBits(
1464 getContext().getTargetInfo().getPointerWidth(0));
1465
1466 // FIXME: Add blacklisting scheme.
1467
1468 if (Info->PathToBaseWithVPtr.empty()) {
1469 BitsetsMD->addOperand(
1470 CGM.CreateVTableBitSetEntry(VTable, PointerWidth, RD));
1471 return;
1472 }
1473
1474 // Add a bitset entry for the least derived base belonging to this vftable.
1475 BitsetsMD->addOperand(CGM.CreateVTableBitSetEntry(
1476 VTable, PointerWidth, Info->PathToBaseWithVPtr.back()));
1477
1478 // Add a bitset entry for each derived class that is laid out at the same
1479 // offset as the least derived base.
1480 for (unsigned I = Info->PathToBaseWithVPtr.size() - 1; I != 0; --I) {
1481 const CXXRecordDecl *DerivedRD = Info->PathToBaseWithVPtr[I - 1];
1482 const CXXRecordDecl *BaseRD = Info->PathToBaseWithVPtr[I];
1483
1484 const ASTRecordLayout &Layout =
1485 getContext().getASTRecordLayout(DerivedRD);
1486 CharUnits Offset;
1487 auto VBI = Layout.getVBaseOffsetsMap().find(BaseRD);
1488 if (VBI == Layout.getVBaseOffsetsMap().end())
1489 Offset = Layout.getBaseClassOffset(BaseRD);
1490 else
1491 Offset = VBI->second.VBaseOffset;
1492 if (!Offset.isZero())
1493 return;
1494 BitsetsMD->addOperand(
1495 CGM.CreateVTableBitSetEntry(VTable, PointerWidth, DerivedRD));
1496 }
1497
1498 // Finally do the same for the most derived class.
1499 if (Info->FullOffsetInMDC.isZero())
1500 BitsetsMD->addOperand(
1501 CGM.CreateVTableBitSetEntry(VTable, PointerWidth, RD));
1502}
1503
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001504void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1505 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001506 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001507 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001508
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001509 for (VPtrInfo *Info : VFPtrs) {
1510 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001511 if (VTable->hasInitializer())
1512 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001513
David Majnemer65f87322014-07-24 06:09:19 +00001514 llvm::Constant *RTTI = getContext().getLangOpts().RTTIData
1515 ? getMSCompleteObjectLocator(RD, Info)
1516 : nullptr;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001517
1518 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001519 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001520 llvm::Constant *Init = CGVT.CreateVTableInitializer(
1521 RD, VTLayout.vtable_component_begin(),
1522 VTLayout.getNumVTableComponents(), VTLayout.vtable_thunk_begin(),
David Majnemerd905da42014-07-01 20:30:31 +00001523 VTLayout.getNumVTableThunks(), RTTI);
1524
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001525 VTable->setInitializer(Init);
Peter Collingbourned9546012015-06-19 02:30:43 +00001526
1527 emitVTableBitSetEntries(Info, RD, VTable);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001528 }
1529}
1530
1531llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1532 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
1533 const CXXRecordDecl *NearestVBase, bool &NeedsVirtualOffset) {
Craig Topper8a13c412014-05-21 05:09:00 +00001534 NeedsVirtualOffset = (NearestVBase != nullptr);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001535
David Majnemerd905da42014-07-01 20:30:31 +00001536 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1537 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1538 llvm::GlobalValue *VTableAddressPoint = VFTablesMap[ID];
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001539 if (!VTableAddressPoint) {
1540 assert(Base.getBase()->getNumVBases() &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001541 !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001542 }
1543 return VTableAddressPoint;
1544}
1545
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001546static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001547 const CXXRecordDecl *RD, const VPtrInfo *VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001548 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001549 llvm::raw_svector_ostream Out(Name);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001550 MangleContext.mangleCXXVFTable(RD, VFPtr->MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001551}
1552
1553llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1554 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
David Majnemerd905da42014-07-01 20:30:31 +00001555 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1556 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1557 llvm::GlobalValue *VFTable = VFTablesMap[ID];
1558 assert(VFTable && "Couldn't find a vftable for the given base?");
1559 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001560}
1561
1562llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1563 CharUnits VPtrOffset) {
1564 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1565 // shouldn't be used in the given record type. We want to cache this result in
1566 // VFTablesMap, thus a simple zero check is not sufficient.
1567 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001568 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001569 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001570 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001571 if (!Inserted)
1572 return I->second;
1573
1574 llvm::GlobalVariable *&VTable = I->second;
1575
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001576 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001577 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001578
David Blaikie82e95a32014-11-19 07:49:47 +00001579 if (DeferredVFTables.insert(RD).second) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001580 // We haven't processed this record type before.
1581 // Queue up this v-table for possible deferred emission.
1582 CGM.addDeferredVTable(RD);
1583
1584#ifndef NDEBUG
1585 // Create all the vftables at once in order to make sure each vftable has
1586 // a unique mangled name.
1587 llvm::StringSet<> ObservedMangledNames;
1588 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1589 SmallString<256> Name;
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001590 mangleVFTableName(getMangleContext(), RD, VFPtrs[J], Name);
David Blaikie61b86d42014-11-19 02:56:13 +00001591 if (!ObservedMangledNames.insert(Name.str()).second)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001592 llvm_unreachable("Already saw this mangling before?");
1593 }
1594#endif
1595 }
1596
David Majnemera03849b2015-03-18 22:04:43 +00001597 VPtrInfo *const *VFPtrI =
1598 std::find_if(VFPtrs.begin(), VFPtrs.end(), [&](VPtrInfo *VPI) {
1599 return VPI->FullOffsetInMDC == VPtrOffset;
1600 });
1601 if (VFPtrI == VFPtrs.end()) {
1602 VFTablesMap[ID] = nullptr;
1603 return nullptr;
1604 }
1605 VPtrInfo *VFPtr = *VFPtrI;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001606
David Majnemera03849b2015-03-18 22:04:43 +00001607 SmallString<256> VFTableName;
1608 mangleVFTableName(getMangleContext(), RD, VFPtr, VFTableName);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001609
David Majnemera03849b2015-03-18 22:04:43 +00001610 llvm::GlobalValue::LinkageTypes VFTableLinkage = CGM.getVTableLinkage(RD);
1611 bool VFTableComesFromAnotherTU =
1612 llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) ||
1613 llvm::GlobalValue::isExternalLinkage(VFTableLinkage);
1614 bool VTableAliasIsRequred =
1615 !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData;
David Majnemerbb848712014-07-01 22:37:08 +00001616
David Majnemera03849b2015-03-18 22:04:43 +00001617 if (llvm::GlobalValue *VFTable =
1618 CGM.getModule().getNamedGlobal(VFTableName)) {
1619 VFTablesMap[ID] = VFTable;
1620 return VTableAliasIsRequred
1621 ? cast<llvm::GlobalVariable>(
1622 cast<llvm::GlobalAlias>(VFTable)->getBaseObject())
1623 : cast<llvm::GlobalVariable>(VFTable);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001624 }
1625
David Majnemera03849b2015-03-18 22:04:43 +00001626 uint64_t NumVTableSlots =
1627 VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC)
1628 .getNumVTableComponents();
1629 llvm::GlobalValue::LinkageTypes VTableLinkage =
1630 VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage;
1631
1632 StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str();
1633
1634 llvm::ArrayType *VTableType =
1635 llvm::ArrayType::get(CGM.Int8PtrTy, NumVTableSlots);
1636
1637 // Create a backing variable for the contents of VTable. The VTable may
1638 // or may not include space for a pointer to RTTI data.
1639 llvm::GlobalValue *VFTable;
1640 VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType,
1641 /*isConstant=*/true, VTableLinkage,
1642 /*Initializer=*/nullptr, VTableName);
1643 VTable->setUnnamedAddr(true);
1644
1645 llvm::Comdat *C = nullptr;
1646 if (!VFTableComesFromAnotherTU &&
1647 (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) ||
1648 (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) &&
1649 VTableAliasIsRequred)))
1650 C = CGM.getModule().getOrInsertComdat(VFTableName.str());
1651
1652 // Only insert a pointer into the VFTable for RTTI data if we are not
1653 // importing it. We never reference the RTTI data directly so there is no
1654 // need to make room for it.
1655 if (VTableAliasIsRequred) {
1656 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
1657 llvm::ConstantInt::get(CGM.IntTy, 1)};
1658 // Create a GEP which points just after the first entry in the VFTable,
1659 // this should be the location of the first virtual method.
David Blaikiee3b172a2015-04-02 18:55:21 +00001660 llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr(
1661 VTable->getValueType(), VTable, GEPIndices);
David Majnemera03849b2015-03-18 22:04:43 +00001662 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) {
1663 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1664 if (C)
1665 C->setSelectionKind(llvm::Comdat::Largest);
1666 }
1667 VFTable = llvm::GlobalAlias::create(
David Blaikie881b2342015-04-29 21:22:47 +00001668 cast<llvm::PointerType>(VTableGEP->getType()), VFTableLinkage,
1669 VFTableName.str(), VTableGEP, &CGM.getModule());
David Majnemera03849b2015-03-18 22:04:43 +00001670 VFTable->setUnnamedAddr(true);
1671 } else {
1672 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1673 // be referencing any RTTI data.
1674 // The GlobalVariable will end up being an appropriate definition of the
1675 // VFTable.
1676 VFTable = VTable;
1677 }
1678 if (C)
1679 VTable->setComdat(C);
1680
1681 if (RD->hasAttr<DLLImportAttr>())
1682 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1683 else if (RD->hasAttr<DLLExportAttr>())
1684 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1685
1686 VFTablesMap[ID] = VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001687 return VTable;
1688}
1689
Peter Collingbourned9546012015-06-19 02:30:43 +00001690// Compute the identity of the most derived class whose virtual table is located
1691// at the given offset into RD.
1692static const CXXRecordDecl *getClassAtVTableLocation(ASTContext &Ctx,
1693 const CXXRecordDecl *RD,
1694 CharUnits Offset) {
1695 if (Offset.isZero())
1696 return RD;
1697
1698 const ASTRecordLayout &Layout = Ctx.getASTRecordLayout(RD);
1699 const CXXRecordDecl *MaxBase = nullptr;
1700 CharUnits MaxBaseOffset;
1701 for (auto &&B : RD->bases()) {
1702 const CXXRecordDecl *Base = B.getType()->getAsCXXRecordDecl();
1703 CharUnits BaseOffset = Layout.getBaseClassOffset(Base);
1704 if (BaseOffset <= Offset && BaseOffset > MaxBaseOffset) {
1705 MaxBase = Base;
1706 MaxBaseOffset = BaseOffset;
1707 }
1708 }
1709 for (auto &&B : RD->vbases()) {
1710 const CXXRecordDecl *Base = B.getType()->getAsCXXRecordDecl();
1711 CharUnits BaseOffset = Layout.getVBaseClassOffset(Base);
1712 if (BaseOffset <= Offset && BaseOffset > MaxBaseOffset) {
1713 MaxBase = Base;
1714 MaxBaseOffset = BaseOffset;
1715 }
1716 }
1717 assert(MaxBase);
1718 return getClassAtVTableLocation(Ctx, MaxBase, Offset - MaxBaseOffset);
1719}
1720
1721// Compute the identity of the most derived class whose virtual table is located
1722// at the MethodVFTableLocation ML.
1723static const CXXRecordDecl *
1724getClassAtVTableLocation(ASTContext &Ctx, GlobalDecl GD,
1725 MicrosoftVTableContext::MethodVFTableLocation &ML) {
1726 const CXXRecordDecl *RD = ML.VBase;
1727 if (!RD)
1728 RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
1729
1730 return getClassAtVTableLocation(Ctx, RD, ML.VFPtrOffset);
1731}
1732
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001733llvm::Value *MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1734 GlobalDecl GD,
1735 llvm::Value *This,
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001736 llvm::Type *Ty,
1737 SourceLocation Loc) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001738 GD = GD.getCanonicalDecl();
1739 CGBuilderTy &Builder = CGF.Builder;
1740
1741 Ty = Ty->getPointerTo()->getPointerTo();
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001742 llvm::Value *VPtr =
1743 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001744 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty);
1745
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001746 MicrosoftVTableContext::MethodVFTableLocation ML =
1747 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
Peter Collingbourned9546012015-06-19 02:30:43 +00001748 if (CGF.SanOpts.has(SanitizerKind::CFIVCall))
1749 CGF.EmitVTablePtrCheck(getClassAtVTableLocation(getContext(), GD, ML),
1750 VTable, CodeGenFunction::CFITCK_VCall, Loc);
1751
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001752 llvm::Value *VFuncPtr =
1753 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1754 return Builder.CreateLoad(VFuncPtr);
1755}
1756
David Majnemer0c0b6d92014-10-31 20:09:12 +00001757llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1758 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
1759 llvm::Value *This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001760 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001761 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1762
1763 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001764 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001765 GlobalDecl GD(Dtor, Dtor_Deleting);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001766 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1767 Dtor, StructorType::Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001768 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001769 llvm::Value *Callee = getVirtualFunctionPointer(
1770 CGF, GD, This, Ty, CE ? CE->getLocStart() : SourceLocation());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001771
David Majnemer9ced3dd2015-03-14 23:44:48 +00001772 ASTContext &Context = getContext();
Nico Weber0a029922015-01-12 21:24:10 +00001773 llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1774 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1775 DtorType == Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001776
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001777 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001778 RValue RV = CGF.EmitCXXStructorCall(Dtor, Callee, ReturnValueSlot(), This,
1779 ImplicitParam, Context.IntTy, CE,
1780 StructorType::Deleting);
1781 return RV.getScalarVal();
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001782}
1783
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001784const VBTableGlobals &
1785MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001786 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001787 // easier than caching each vbtable individually.
1788 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1789 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001790 std::tie(Entry, Added) =
1791 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001792 VBTableGlobals &VBGlobals = Entry->second;
1793 if (!Added)
1794 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001795
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001796 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1797 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001798
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001799 // Cache the globals for all vbtables so we don't have to recompute the
1800 // mangled names.
1801 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001802 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1803 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001804 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001805 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001806 }
1807
1808 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001809}
1810
Reid Klecknere4a52202014-02-21 02:27:32 +00001811llvm::Function *MicrosoftCXXABI::EmitVirtualMemPtrThunk(
1812 const CXXMethodDecl *MD,
1813 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001814 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1815 "can't form pointers to ctors or virtual dtors");
1816
Reid Klecknere4a52202014-02-21 02:27:32 +00001817 // Calculate the mangled name.
1818 SmallString<256> ThunkName;
1819 llvm::raw_svector_ostream Out(ThunkName);
1820 getMangleContext().mangleVirtualMemPtrThunk(MD, Out);
1821 Out.flush();
1822
Hans Wennborg88497d62013-11-15 17:24:45 +00001823 // If the thunk has been generated previously, just return it.
1824 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1825 return cast<llvm::Function>(GV);
1826
1827 // Create the llvm::Function.
Reid Klecknerc3473512014-08-29 21:43:29 +00001828 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSMemberPointerThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00001829 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1830 llvm::Function *ThunkFn =
1831 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1832 ThunkName.str(), &CGM.getModule());
1833 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1834
Hans Wennborg88497d62013-11-15 17:24:45 +00001835 ThunkFn->setLinkage(MD->isExternallyVisible()
1836 ? llvm::GlobalValue::LinkOnceODRLinkage
1837 : llvm::GlobalValue::InternalLinkage);
David Majnemer8c9cdb62015-01-21 01:21:31 +00001838 if (MD->isExternallyVisible())
1839 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
Hans Wennborg88497d62013-11-15 17:24:45 +00001840
1841 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1842 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1843
Reid Kleckner9da94482015-01-21 22:18:17 +00001844 // Add the "thunk" attribute so that LLVM knows that the return type is
1845 // meaningless. These thunks can be used to call functions with differing
1846 // return types, and the caller is required to cast the prototype
1847 // appropriately to extract the correct value.
1848 ThunkFn->addFnAttr("thunk");
1849
Reid Klecknerb9538a62014-08-15 18:12:40 +00001850 // These thunks can be compared, so they are not unnamed.
1851 ThunkFn->setUnnamedAddr(false);
1852
Hans Wennborg88497d62013-11-15 17:24:45 +00001853 // Start codegen.
1854 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00001855 CGF.CurGD = GlobalDecl(MD);
1856 CGF.CurFuncIsThunk = true;
1857
1858 // Build FunctionArgs, but only include the implicit 'this' parameter
1859 // declaration.
1860 FunctionArgList FunctionArgs;
1861 buildThisParam(CGF, FunctionArgs);
1862
1863 // Start defining the function.
1864 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
1865 FunctionArgs, MD->getLocation(), SourceLocation());
1866 EmitThisParam(CGF);
Hans Wennborg88497d62013-11-15 17:24:45 +00001867
Reid Klecknere4a52202014-02-21 02:27:32 +00001868 // Load the vfptr and then callee from the vftable. The callee should have
1869 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00001870 llvm::Value *VTable = CGF.GetVTablePtr(
1871 getThisValue(CGF), ThunkTy->getPointerTo()->getPointerTo());
Reid Klecknere4a52202014-02-21 02:27:32 +00001872 llvm::Value *VFuncPtr =
1873 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1874 llvm::Value *Callee = CGF.Builder.CreateLoad(VFuncPtr);
Hans Wennborg88497d62013-11-15 17:24:45 +00001875
Reid Klecknerc3473512014-08-29 21:43:29 +00001876 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee);
Hans Wennborg88497d62013-11-15 17:24:45 +00001877
1878 return ThunkFn;
1879}
1880
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001881void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001882 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1883 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001884 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001885 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
David Majnemer129f4172015-02-02 10:22:20 +00001886 if (GV->isDeclaration())
1887 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00001888 }
1889}
1890
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001891llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001892MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001893 llvm::GlobalVariable::LinkageTypes Linkage) {
1894 SmallString<256> OutName;
1895 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00001896 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001897 Out.flush();
1898 StringRef Name = OutName.str();
1899
1900 llvm::ArrayType *VBTableType =
1901 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ReusingBase->getNumVBases());
1902
1903 assert(!CGM.getModule().getNamedGlobal(Name) &&
1904 "vbtable with this name already exists: mangling bug?");
1905 llvm::GlobalVariable *GV =
1906 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
1907 GV->setUnnamedAddr(true);
Hans Wennborg853ae942014-05-30 16:59:42 +00001908
1909 if (RD->hasAttr<DLLImportAttr>())
1910 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1911 else if (RD->hasAttr<DLLExportAttr>())
1912 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1913
David Majnemer129f4172015-02-02 10:22:20 +00001914 if (!GV->hasExternalLinkage())
1915 emitVBTableDefinition(VBT, RD, GV);
1916
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001917 return GV;
1918}
1919
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001920void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001921 const CXXRecordDecl *RD,
1922 llvm::GlobalVariable *GV) const {
1923 const CXXRecordDecl *ReusingBase = VBT.ReusingBase;
1924
1925 assert(RD->getNumVBases() && ReusingBase->getNumVBases() &&
1926 "should only emit vbtables for classes with vbtables");
1927
1928 const ASTRecordLayout &BaseLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001929 getContext().getASTRecordLayout(VBT.BaseWithVPtr);
1930 const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001931
Craig Topper8a13c412014-05-21 05:09:00 +00001932 SmallVector<llvm::Constant *, 4> Offsets(1 + ReusingBase->getNumVBases(),
1933 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001934
1935 // The offset from ReusingBase's vbptr to itself always leads.
1936 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
1937 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
1938
1939 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Aaron Ballman445a9392014-03-13 16:15:17 +00001940 for (const auto &I : ReusingBase->vbases()) {
1941 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001942 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
1943 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00001944
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001945 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00001946 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001947 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00001948 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001949 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00001950 Offset -= CompleteVBPtrOffset;
1951
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001952 unsigned VBIndex = Context.getVBTableIndex(ReusingBase, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00001953 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001954 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
1955 }
1956
1957 assert(Offsets.size() ==
1958 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
1959 ->getElementType())->getNumElements());
1960 llvm::ArrayType *VBTableType =
1961 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
1962 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
1963 GV->setInitializer(Init);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001964}
1965
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001966llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
1967 llvm::Value *This,
1968 const ThisAdjustment &TA) {
1969 if (TA.isEmpty())
1970 return This;
1971
1972 llvm::Value *V = CGF.Builder.CreateBitCast(This, CGF.Int8PtrTy);
1973
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00001974 if (!TA.Virtual.isEmpty()) {
1975 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
1976 // Adjust the this argument based on the vtordisp value.
1977 llvm::Value *VtorDispPtr =
1978 CGF.Builder.CreateConstGEP1_32(V, TA.Virtual.Microsoft.VtordispOffset);
1979 VtorDispPtr =
1980 CGF.Builder.CreateBitCast(VtorDispPtr, CGF.Int32Ty->getPointerTo());
1981 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
1982 V = CGF.Builder.CreateGEP(V, CGF.Builder.CreateNeg(VtorDisp));
1983
1984 if (TA.Virtual.Microsoft.VBPtrOffset) {
1985 // If the final overrider is defined in a virtual base other than the one
1986 // that holds the vfptr, we have to use a vtordispex thunk which looks up
1987 // the vbtable of the derived class.
1988 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
1989 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
1990 llvm::Value *VBPtr;
1991 llvm::Value *VBaseOffset =
1992 GetVBaseOffsetFromVBPtr(CGF, V, -TA.Virtual.Microsoft.VBPtrOffset,
1993 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
1994 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
1995 }
1996 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001997
1998 if (TA.NonVirtual) {
1999 // Non-virtual adjustment might result in a pointer outside the allocated
2000 // object, e.g. if the final overrider class is laid out after the virtual
2001 // base that declares a method in the most derived class.
2002 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
2003 }
2004
2005 // Don't need to bitcast back, the call CodeGen will handle this.
2006 return V;
2007}
2008
2009llvm::Value *
2010MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
2011 const ReturnAdjustment &RA) {
2012 if (RA.isEmpty())
2013 return Ret;
2014
2015 llvm::Value *V = CGF.Builder.CreateBitCast(Ret, CGF.Int8PtrTy);
2016
2017 if (RA.Virtual.Microsoft.VBIndex) {
2018 assert(RA.Virtual.Microsoft.VBIndex > 0);
David Majnemer9ced3dd2015-03-14 23:44:48 +00002019 const ASTContext &Context = getContext();
2020 int32_t IntSize = Context.getTypeSizeInChars(Context.IntTy).getQuantity();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002021 llvm::Value *VBPtr;
2022 llvm::Value *VBaseOffset =
2023 GetVBaseOffsetFromVBPtr(CGF, V, RA.Virtual.Microsoft.VBPtrOffset,
2024 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
2025 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
2026 }
2027
2028 if (RA.NonVirtual)
David Blaikiefb901c7a2015-04-04 15:12:29 +00002029 V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00002030
2031 // Cast back to the original type.
2032 return CGF.Builder.CreateBitCast(V, Ret->getType());
2033}
2034
John McCallb91cd662012-05-01 05:23:51 +00002035bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
2036 QualType elementType) {
2037 // Microsoft seems to completely ignore the possibility of a
2038 // two-argument usual deallocation function.
2039 return elementType.isDestructedType();
2040}
2041
2042bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
2043 // Microsoft seems to completely ignore the possibility of a
2044 // two-argument usual deallocation function.
2045 return expr->getAllocatedType().isDestructedType();
2046}
2047
2048CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
2049 // The array cookie is always a size_t; we then pad that out to the
2050 // alignment of the element type.
2051 ASTContext &Ctx = getContext();
2052 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
2053 Ctx.getTypeAlignInChars(type));
2054}
2055
2056llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
2057 llvm::Value *allocPtr,
2058 CharUnits cookieSize) {
Micah Villmowea2fea22012-10-25 15:39:14 +00002059 unsigned AS = allocPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00002060 llvm::Value *numElementsPtr =
2061 CGF.Builder.CreateBitCast(allocPtr, CGF.SizeTy->getPointerTo(AS));
2062 return CGF.Builder.CreateLoad(numElementsPtr);
2063}
2064
2065llvm::Value* MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
2066 llvm::Value *newPtr,
2067 llvm::Value *numElements,
2068 const CXXNewExpr *expr,
2069 QualType elementType) {
2070 assert(requiresArrayCookie(expr));
2071
2072 // The size of the cookie.
2073 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
2074
2075 // Compute an offset to the cookie.
2076 llvm::Value *cookiePtr = newPtr;
2077
2078 // Write the number of elements into the appropriate slot.
Micah Villmowea2fea22012-10-25 15:39:14 +00002079 unsigned AS = newPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00002080 llvm::Value *numElementsPtr
2081 = CGF.Builder.CreateBitCast(cookiePtr, CGF.SizeTy->getPointerTo(AS));
2082 CGF.Builder.CreateStore(numElements, numElementsPtr);
2083
2084 // Finally, compute a pointer to the actual data buffer by skipping
2085 // over the cookie completely.
2086 return CGF.Builder.CreateConstInBoundsGEP1_64(newPtr,
2087 cookieSize.getQuantity());
2088}
2089
David Majnemerb3341ea2014-10-05 05:05:40 +00002090static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
2091 llvm::Constant *Dtor,
2092 llvm::Constant *Addr) {
2093 // Create a function which calls the destructor.
2094 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
2095
2096 // extern "C" int __tlregdtor(void (*f)(void));
2097 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
2098 CGF.IntTy, DtorStub->getType(), /*IsVarArg=*/false);
2099
2100 llvm::Constant *TLRegDtor =
2101 CGF.CGM.CreateRuntimeFunction(TLRegDtorTy, "__tlregdtor");
2102 if (llvm::Function *TLRegDtorFn = dyn_cast<llvm::Function>(TLRegDtor))
2103 TLRegDtorFn->setDoesNotThrow();
2104
2105 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
2106}
2107
2108void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
2109 llvm::Constant *Dtor,
2110 llvm::Constant *Addr) {
2111 if (D.getTLSKind())
2112 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
2113
2114 // The default behavior is to use atexit.
2115 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
2116}
2117
2118void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
2119 CodeGenModule &CGM,
2120 ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *>>
2121 CXXThreadLocals,
2122 ArrayRef<llvm::Function *> CXXThreadLocalInits,
2123 ArrayRef<llvm::GlobalVariable *> CXXThreadLocalInitVars) {
2124 // This will create a GV in the .CRT$XDU section. It will point to our
2125 // initialization function. The CRT will call all of these function
2126 // pointers at start-up time and, eventually, at thread-creation time.
2127 auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
2128 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
2129 CGM.getModule(), InitFunc->getType(), /*IsConstant=*/true,
2130 llvm::GlobalVariable::InternalLinkage, InitFunc,
2131 Twine(InitFunc->getName(), "$initializer$"));
2132 InitFuncPtr->setSection(".CRT$XDU");
2133 // This variable has discardable linkage, we have to add it to @llvm.used to
2134 // ensure it won't get discarded.
2135 CGM.addUsedGlobal(InitFuncPtr);
2136 return InitFuncPtr;
2137 };
2138
2139 std::vector<llvm::Function *> NonComdatInits;
2140 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
2141 llvm::GlobalVariable *GV = CXXThreadLocalInitVars[I];
2142 llvm::Function *F = CXXThreadLocalInits[I];
2143
2144 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002145 if (llvm::Comdat *C = GV->getComdat())
David Majnemerb3341ea2014-10-05 05:05:40 +00002146 AddToXDU(F)->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002147 else
David Majnemerb3341ea2014-10-05 05:05:40 +00002148 NonComdatInits.push_back(F);
David Majnemerb3341ea2014-10-05 05:05:40 +00002149 }
2150
2151 if (!NonComdatInits.empty()) {
2152 llvm::FunctionType *FTy =
2153 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002154 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction(
2155 FTy, "__tls_init", SourceLocation(),
2156 /*TLS=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002157 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2158
2159 AddToXDU(InitFunc);
2160 }
2161}
2162
2163LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2164 const VarDecl *VD,
2165 QualType LValType) {
2166 CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2167 return LValue();
2168}
2169
David Majnemer8354eee2015-05-07 06:15:46 +00002170static llvm::GlobalVariable *getInitThreadEpochPtr(CodeGenModule &CGM) {
2171 StringRef VarName("_Init_thread_epoch");
2172 if (auto *GV = CGM.getModule().getNamedGlobal(VarName))
2173 return GV;
2174 auto *GV = new llvm::GlobalVariable(
2175 CGM.getModule(), CGM.IntTy,
2176 /*Constant=*/false, llvm::GlobalVariable::ExternalLinkage,
2177 /*Initializer=*/nullptr, VarName,
2178 /*InsertBefore=*/nullptr, llvm::GlobalVariable::GeneralDynamicTLSModel);
2179 GV->setAlignment(CGM.getTarget().getIntAlign() / 8);
2180 return GV;
2181}
2182
2183static llvm::Constant *getInitThreadHeaderFn(CodeGenModule &CGM) {
2184 llvm::FunctionType *FTy =
2185 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2186 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2187 return CGM.CreateRuntimeFunction(
2188 FTy, "_Init_thread_header",
2189 llvm::AttributeSet::get(CGM.getLLVMContext(),
2190 llvm::AttributeSet::FunctionIndex,
2191 llvm::Attribute::NoUnwind));
2192}
2193
2194static llvm::Constant *getInitThreadFooterFn(CodeGenModule &CGM) {
2195 llvm::FunctionType *FTy =
2196 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2197 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2198 return CGM.CreateRuntimeFunction(
2199 FTy, "_Init_thread_footer",
2200 llvm::AttributeSet::get(CGM.getLLVMContext(),
2201 llvm::AttributeSet::FunctionIndex,
2202 llvm::Attribute::NoUnwind));
2203}
2204
2205static llvm::Constant *getInitThreadAbortFn(CodeGenModule &CGM) {
2206 llvm::FunctionType *FTy =
2207 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2208 CGM.IntTy->getPointerTo(), /*isVarArg=*/false);
2209 return CGM.CreateRuntimeFunction(
2210 FTy, "_Init_thread_abort",
2211 llvm::AttributeSet::get(CGM.getLLVMContext(),
2212 llvm::AttributeSet::FunctionIndex,
2213 llvm::Attribute::NoUnwind));
2214}
2215
2216namespace {
2217struct ResetGuardBit : EHScopeStack::Cleanup {
2218 llvm::GlobalVariable *Guard;
2219 unsigned GuardNum;
2220 ResetGuardBit(llvm::GlobalVariable *Guard, unsigned GuardNum)
2221 : Guard(Guard), GuardNum(GuardNum) {}
2222
2223 void Emit(CodeGenFunction &CGF, Flags flags) override {
2224 // Reset the bit in the mask so that the static variable may be
2225 // reinitialized.
2226 CGBuilderTy &Builder = CGF.Builder;
2227 llvm::LoadInst *LI = Builder.CreateLoad(Guard);
2228 llvm::ConstantInt *Mask =
2229 llvm::ConstantInt::get(CGF.IntTy, ~(1U << GuardNum));
2230 Builder.CreateStore(Builder.CreateAnd(LI, Mask), Guard);
2231 }
2232};
2233
2234struct CallInitThreadAbort : EHScopeStack::Cleanup {
2235 llvm::GlobalVariable *Guard;
2236 CallInitThreadAbort(llvm::GlobalVariable *Guard) : Guard(Guard) {}
2237
2238 void Emit(CodeGenFunction &CGF, Flags flags) override {
2239 // Calling _Init_thread_abort will reset the guard's state.
2240 CGF.EmitNounwindRuntimeCall(getInitThreadAbortFn(CGF.CGM), Guard);
2241 }
2242};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002243}
David Majnemer8354eee2015-05-07 06:15:46 +00002244
John McCallc84ed6a2012-05-01 06:13:13 +00002245void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00002246 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00002247 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00002248 // MSVC only uses guards for static locals.
2249 if (!D.isStaticLocal()) {
2250 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2251 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
Rafael Espindola77abc3a2015-01-16 16:04:45 +00002252 llvm::Function *F = CGF.CurFn;
2253 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2254 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
Reid Kleckner563f0e82014-05-23 21:13:45 +00002255 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2256 return;
2257 }
2258
David Majnemerec8e54b2015-05-07 21:19:06 +00002259 bool ThreadlocalStatic = D.getTLSKind();
2260 bool ThreadsafeStatic = getContext().getLangOpts().ThreadsafeStatics;
2261
2262 // Thread-safe static variables which aren't thread-specific have a
2263 // per-variable guard.
2264 bool HasPerVariableGuard = ThreadsafeStatic && !ThreadlocalStatic;
Richard Smithdbf74ba2013-04-14 23:01:42 +00002265
Reid Klecknerd8110b62013-09-10 20:14:30 +00002266 CGBuilderTy &Builder = CGF.Builder;
2267 llvm::IntegerType *GuardTy = CGF.Int32Ty;
2268 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
2269
2270 // Get the guard variable for this function if we have one already.
David Majnemerec8e54b2015-05-07 21:19:06 +00002271 GuardInfo *GI = nullptr;
2272 if (ThreadlocalStatic)
2273 GI = &ThreadLocalGuardVariableMap[D.getDeclContext()];
2274 else if (!ThreadsafeStatic)
2275 GI = &GuardVariableMap[D.getDeclContext()];
2276
2277 llvm::GlobalVariable *GuardVar = GI ? GI->Guard : nullptr;
David Majnemer8354eee2015-05-07 06:15:46 +00002278 unsigned GuardNum;
David Majnemerec8e54b2015-05-07 21:19:06 +00002279 if (D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002280 // Externally visible variables have to be numbered in Sema to properly
2281 // handle unreachable VarDecls.
David Majnemer8354eee2015-05-07 06:15:46 +00002282 GuardNum = getContext().getStaticLocalNumber(&D);
2283 assert(GuardNum > 0);
2284 GuardNum--;
2285 } else if (HasPerVariableGuard) {
2286 GuardNum = ThreadSafeGuardNumMap[D.getDeclContext()]++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002287 } else {
2288 // Non-externally visible variables are numbered here in CodeGen.
David Majnemer8354eee2015-05-07 06:15:46 +00002289 GuardNum = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002290 }
2291
David Majnemer8354eee2015-05-07 06:15:46 +00002292 if (!HasPerVariableGuard && GuardNum >= 32) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002293 if (D.isExternallyVisible())
2294 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
David Majnemer8354eee2015-05-07 06:15:46 +00002295 GuardNum %= 32;
2296 GuardVar = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002297 }
2298
David Majnemer8354eee2015-05-07 06:15:46 +00002299 if (!GuardVar) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002300 // Mangle the name for the guard.
2301 SmallString<256> GuardName;
2302 {
2303 llvm::raw_svector_ostream Out(GuardName);
David Majnemer8354eee2015-05-07 06:15:46 +00002304 if (HasPerVariableGuard)
2305 getMangleContext().mangleThreadSafeStaticGuardVariable(&D, GuardNum,
2306 Out);
2307 else
2308 getMangleContext().mangleStaticGuardVariable(&D, Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002309 Out.flush();
2310 }
2311
Hans Wennborgef2272c2014-06-18 15:55:13 +00002312 // Create the guard variable with a zero-initializer. Just absorb linkage,
2313 // visibility and dll storage class from the guarded variable.
David Majnemer8354eee2015-05-07 06:15:46 +00002314 GuardVar =
2315 new llvm::GlobalVariable(CGM.getModule(), GuardTy, /*isConstant=*/false,
Reid Klecknere9591b32014-04-23 18:22:11 +00002316 GV->getLinkage(), Zero, GuardName.str());
David Majnemer8354eee2015-05-07 06:15:46 +00002317 GuardVar->setVisibility(GV->getVisibility());
2318 GuardVar->setDLLStorageClass(GV->getDLLStorageClass());
2319 if (GuardVar->isWeakForLinker())
2320 GuardVar->setComdat(
2321 CGM.getModule().getOrInsertComdat(GuardVar->getName()));
2322 if (D.getTLSKind())
2323 GuardVar->setThreadLocal(true);
2324 if (GI && !HasPerVariableGuard)
2325 GI->Guard = GuardVar;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002326 }
2327
David Majnemer8354eee2015-05-07 06:15:46 +00002328 assert(GuardVar->getLinkage() == GV->getLinkage() &&
2329 "static local from the same function had different linkage");
Reid Klecknerd8110b62013-09-10 20:14:30 +00002330
David Majnemer8354eee2015-05-07 06:15:46 +00002331 if (!HasPerVariableGuard) {
2332 // Pseudo code for the test:
2333 // if (!(GuardVar & MyGuardBit)) {
2334 // GuardVar |= MyGuardBit;
2335 // ... initialize the object ...;
2336 // }
Reid Klecknerd8110b62013-09-10 20:14:30 +00002337
David Majnemer8354eee2015-05-07 06:15:46 +00002338 // Test our bit from the guard variable.
2339 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1U << GuardNum);
2340 llvm::LoadInst *LI = Builder.CreateLoad(GuardVar);
2341 llvm::Value *IsInitialized =
2342 Builder.CreateICmpNE(Builder.CreateAnd(LI, Bit), Zero);
2343 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2344 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
2345 Builder.CreateCondBr(IsInitialized, EndBlock, InitBlock);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002346
David Majnemer8354eee2015-05-07 06:15:46 +00002347 // Set our bit in the guard variable and emit the initializer and add a global
2348 // destructor if appropriate.
2349 CGF.EmitBlock(InitBlock);
2350 Builder.CreateStore(Builder.CreateOr(LI, Bit), GuardVar);
2351 CGF.EHStack.pushCleanup<ResetGuardBit>(EHCleanup, GuardVar, GuardNum);
2352 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2353 CGF.PopCleanupBlock();
2354 Builder.CreateBr(EndBlock);
2355
2356 // Continue.
2357 CGF.EmitBlock(EndBlock);
2358 } else {
2359 // Pseudo code for the test:
2360 // if (TSS > _Init_thread_epoch) {
2361 // _Init_thread_header(&TSS);
2362 // if (TSS == -1) {
2363 // ... initialize the object ...;
2364 // _Init_thread_footer(&TSS);
2365 // }
2366 // }
2367 //
2368 // The algorithm is almost identical to what can be found in the appendix
2369 // found in N2325.
2370
2371 unsigned IntAlign = CGM.getTarget().getIntAlign() / 8;
2372
2373 // This BasicBLock determines whether or not we have any work to do.
2374 llvm::LoadInst *FirstGuardLoad =
2375 Builder.CreateAlignedLoad(GuardVar, IntAlign);
2376 FirstGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2377 llvm::LoadInst *InitThreadEpoch =
2378 Builder.CreateLoad(getInitThreadEpochPtr(CGM));
2379 llvm::Value *IsUninitialized =
2380 Builder.CreateICmpSGT(FirstGuardLoad, InitThreadEpoch);
2381 llvm::BasicBlock *AttemptInitBlock = CGF.createBasicBlock("init.attempt");
2382 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
2383 Builder.CreateCondBr(IsUninitialized, AttemptInitBlock, EndBlock);
2384
2385 // This BasicBlock attempts to determine whether or not this thread is
2386 // responsible for doing the initialization.
2387 CGF.EmitBlock(AttemptInitBlock);
2388 CGF.EmitNounwindRuntimeCall(getInitThreadHeaderFn(CGM), GuardVar);
2389 llvm::LoadInst *SecondGuardLoad =
2390 Builder.CreateAlignedLoad(GuardVar, IntAlign);
2391 SecondGuardLoad->setOrdering(llvm::AtomicOrdering::Unordered);
2392 llvm::Value *ShouldDoInit =
2393 Builder.CreateICmpEQ(SecondGuardLoad, getAllOnesInt());
2394 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2395 Builder.CreateCondBr(ShouldDoInit, InitBlock, EndBlock);
2396
2397 // Ok, we ended up getting selected as the initializing thread.
2398 CGF.EmitBlock(InitBlock);
2399 CGF.EHStack.pushCleanup<CallInitThreadAbort>(EHCleanup, GuardVar);
2400 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2401 CGF.PopCleanupBlock();
2402 CGF.EmitNounwindRuntimeCall(getInitThreadFooterFn(CGM), GuardVar);
2403 Builder.CreateBr(EndBlock);
2404
2405 CGF.EmitBlock(EndBlock);
2406 }
John McCallc84ed6a2012-05-01 06:13:13 +00002407}
2408
Reid Kleckner2341ae32013-04-11 18:13:19 +00002409bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2410 // Null-ness for function memptrs only depends on the first field, which is
2411 // the function pointer. The rest don't matter, so we can zero initialize.
2412 if (MPT->isMemberFunctionPointer())
2413 return true;
2414
2415 // The virtual base adjustment field is always -1 for null, so if we have one
2416 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
2417 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002418 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2419 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002420 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
2421 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00002422}
2423
2424llvm::Type *
2425MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002426 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2427 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002428 llvm::SmallVector<llvm::Type *, 4> fields;
2429 if (MPT->isMemberFunctionPointer())
2430 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
2431 else
2432 fields.push_back(CGM.IntTy); // FieldOffset
2433
Reid Kleckner96f8f932014-02-05 17:27:08 +00002434 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2435 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002436 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002437 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002438 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002439 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002440 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
2441
2442 if (fields.size() == 1)
2443 return fields[0];
2444 return llvm::StructType::get(CGM.getLLVMContext(), fields);
2445}
2446
2447void MicrosoftCXXABI::
2448GetNullMemberPointerFields(const MemberPointerType *MPT,
2449 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2450 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00002451 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2452 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002453 if (MPT->isMemberFunctionPointer()) {
2454 // FunctionPointerOrVirtualThunk
2455 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2456 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00002457 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00002458 fields.push_back(getZeroInt()); // FieldOffset
2459 else
2460 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00002461 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00002462
Reid Kleckner96f8f932014-02-05 17:27:08 +00002463 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2464 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002465 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002466 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002467 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002468 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002469 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002470}
2471
2472llvm::Constant *
2473MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002474 llvm::SmallVector<llvm::Constant *, 4> fields;
2475 GetNullMemberPointerFields(MPT, fields);
2476 if (fields.size() == 1)
2477 return fields[0];
2478 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2479 assert(Res->getType() == ConvertMemberPointerType(MPT));
2480 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002481}
2482
2483llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002484MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2485 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00002486 const CXXRecordDecl *RD,
David Majnemere60813f2015-05-10 21:48:08 +00002487 CharUnits NonVirtualBaseAdjustment,
2488 unsigned VBTableIndex) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002489 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002490
2491 // Single inheritance class member pointer are represented as scalars instead
2492 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002493 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002494 return FirstField;
2495
Reid Kleckner2341ae32013-04-11 18:13:19 +00002496 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002497 fields.push_back(FirstField);
2498
Reid Kleckner96f8f932014-02-05 17:27:08 +00002499 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002500 fields.push_back(llvm::ConstantInt::get(
2501 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002502
Reid Kleckner96f8f932014-02-05 17:27:08 +00002503 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00002504 CharUnits Offs = CharUnits::Zero();
David Majnemerc1709d32015-06-23 07:31:11 +00002505 if (VBTableIndex)
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002506 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00002507 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00002508 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002509
2510 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002511 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
David Majnemere60813f2015-05-10 21:48:08 +00002512 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, VBTableIndex));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002513
Reid Kleckner2341ae32013-04-11 18:13:19 +00002514 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002515}
2516
David Majnemerc1709d32015-06-23 07:31:11 +00002517// Loading virtual member pointers using the virtual inheritance model
2518// always results in an adjustment using the vbtable even if the index is
2519// zero.
2520//
2521// This is usually OK because the first slot in the vbtable points
2522// backwards to the top of the MDC. However, the MDC might be reusing a
2523// vbptr from an nv-base. In this case, the first slot in the vbtable
2524// points to the start of the nv-base which introduced the vbptr and *not*
2525// the MDC. Modify the NonVirtualBaseAdjustment to account for this.
2526static CharUnits computeOffsetOfBaseWithVBPtr(const ASTContext &Ctx,
2527 const CXXRecordDecl *RD) {
2528 CharUnits Offset = CharUnits::Zero();
2529 const ASTRecordLayout *Layout = &Ctx.getASTRecordLayout(RD);
2530 while (const CXXRecordDecl *Base = Layout->getBaseSharingVBPtr()) {
2531 Offset += Layout->getBaseClassOffset(Base);
2532 Layout = &Ctx.getASTRecordLayout(Base);
2533 }
2534 return Offset;
2535}
2536
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002537llvm::Constant *
2538MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2539 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002540 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerc1709d32015-06-23 07:31:11 +00002541 if (RD->getMSInheritanceModel() ==
2542 MSInheritanceAttr::Keyword_virtual_inheritance)
2543 offset -= computeOffsetOfBaseWithVBPtr(getContext(), RD);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002544 llvm::Constant *FirstField =
2545 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00002546 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002547 CharUnits::Zero(), /*VBTableIndex=*/0);
Reid Kleckner452abac2013-05-09 21:01:17 +00002548}
2549
Reid Kleckner452abac2013-05-09 21:01:17 +00002550llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2551 QualType MPType) {
David Majnemer5ca193c2015-06-23 07:31:07 +00002552 const MemberPointerType *DstTy = MPType->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002553 const ValueDecl *MPD = MP.getMemberPointerDecl();
2554 if (!MPD)
David Majnemer5ca193c2015-06-23 07:31:07 +00002555 return EmitNullMemberPointer(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002556
David Majnemer5ca193c2015-06-23 07:31:07 +00002557 ASTContext &Ctx = getContext();
2558 ArrayRef<const CXXRecordDecl *> MemberPointerPath = MP.getMemberPointerPath();
Reid Kleckner452abac2013-05-09 21:01:17 +00002559
David Majnemer5ca193c2015-06-23 07:31:07 +00002560 llvm::Constant *C;
2561 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD)) {
2562 C = EmitMemberFunctionPointer(MD);
2563 } else {
2564 CharUnits FieldOffset = Ctx.toCharUnitsFromBits(Ctx.getFieldOffset(MPD));
2565 C = EmitMemberDataPointer(DstTy, FieldOffset);
2566 }
Reid Kleckner452abac2013-05-09 21:01:17 +00002567
David Majnemer5ca193c2015-06-23 07:31:07 +00002568 if (!MemberPointerPath.empty()) {
2569 const CXXRecordDecl *SrcRD = cast<CXXRecordDecl>(MPD->getDeclContext());
2570 const Type *SrcRecTy = Ctx.getTypeDeclType(SrcRD).getTypePtr();
2571 const MemberPointerType *SrcTy =
2572 Ctx.getMemberPointerType(DstTy->getPointeeType(), SrcRecTy)
2573 ->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002574
David Majnemer5ca193c2015-06-23 07:31:07 +00002575 bool DerivedMember = MP.isMemberPointerToDerivedMember();
2576 SmallVector<const CXXBaseSpecifier *, 4> DerivedToBasePath;
2577 const CXXRecordDecl *PrevRD = SrcRD;
2578 for (const CXXRecordDecl *PathElem : MemberPointerPath) {
2579 const CXXRecordDecl *Base = nullptr;
2580 const CXXRecordDecl *Derived = nullptr;
2581 if (DerivedMember) {
2582 Base = PathElem;
2583 Derived = PrevRD;
2584 } else {
2585 Base = PrevRD;
2586 Derived = PathElem;
2587 }
2588 for (const CXXBaseSpecifier &BS : Derived->bases())
2589 if (BS.getType()->getAsCXXRecordDecl()->getCanonicalDecl() ==
2590 Base->getCanonicalDecl())
2591 DerivedToBasePath.push_back(&BS);
2592 PrevRD = PathElem;
2593 }
2594 assert(DerivedToBasePath.size() == MemberPointerPath.size());
2595
2596 CastKind CK = DerivedMember ? CK_DerivedToBaseMemberPointer
2597 : CK_BaseToDerivedMemberPointer;
2598 C = EmitMemberPointerConversion(SrcTy, DstTy, CK, DerivedToBasePath.begin(),
2599 DerivedToBasePath.end(), C);
2600 }
2601 return C;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002602}
2603
2604llvm::Constant *
David Majnemer5ca193c2015-06-23 07:31:07 +00002605MicrosoftCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002606 assert(MD->isInstance() && "Member function must not be static!");
David Majnemer5ca193c2015-06-23 07:31:07 +00002607
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002608 MD = MD->getCanonicalDecl();
David Majnemer5ca193c2015-06-23 07:31:07 +00002609 CharUnits NonVirtualBaseAdjustment = CharUnits::Zero();
2610 const CXXRecordDecl *RD = MD->getParent()->getMostRecentDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002611 CodeGenTypes &Types = CGM.getTypes();
2612
David Majnemere60813f2015-05-10 21:48:08 +00002613 unsigned VBTableIndex = 0;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002614 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00002615 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00002616 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002617 llvm::Type *Ty;
2618 // Check whether the function has a computable LLVM signature.
2619 if (Types.isFuncTypeConvertible(FPT)) {
2620 // The function has a computable LLVM signature; use the correct type.
2621 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2622 } else {
2623 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2624 // function type is incomplete.
2625 Ty = CGM.PtrDiffTy;
2626 }
2627 FirstField = CGM.GetAddrOfFunction(MD, Ty);
Hans Wennborg88497d62013-11-15 17:24:45 +00002628 } else {
David Majnemere0e228a2015-06-11 08:12:44 +00002629 auto &VTableContext = CGM.getMicrosoftVTableContext();
2630 MicrosoftVTableContext::MethodVFTableLocation ML =
2631 VTableContext.getMethodVFTableLocation(MD);
David Majnemerc1709d32015-06-23 07:31:11 +00002632 FirstField = EmitVirtualMemPtrThunk(MD, ML);
David Majnemere0e228a2015-06-11 08:12:44 +00002633 // Include the vfptr adjustment if the method is in a non-primary vftable.
2634 NonVirtualBaseAdjustment += ML.VFPtrOffset;
2635 if (ML.VBase)
2636 VBTableIndex = VTableContext.getVBTableIndex(RD, ML.VBase) * 4;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002637 }
2638
David Majnemerc1709d32015-06-23 07:31:11 +00002639 if (VBTableIndex == 0 &&
2640 RD->getMSInheritanceModel() ==
2641 MSInheritanceAttr::Keyword_virtual_inheritance)
2642 NonVirtualBaseAdjustment -= computeOffsetOfBaseWithVBPtr(getContext(), RD);
2643
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002644 // The rest of the fields are common with data member pointers.
David Majnemerc1709d32015-06-23 07:31:11 +00002645 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002646 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
David Majnemere60813f2015-05-10 21:48:08 +00002647 NonVirtualBaseAdjustment, VBTableIndex);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002648}
2649
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002650/// Member pointers are the same if they're either bitwise identical *or* both
2651/// null. Null-ness for function members is determined by the first field,
2652/// while for data member pointers we must compare all fields.
2653llvm::Value *
2654MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2655 llvm::Value *L,
2656 llvm::Value *R,
2657 const MemberPointerType *MPT,
2658 bool Inequality) {
2659 CGBuilderTy &Builder = CGF.Builder;
2660
2661 // Handle != comparisons by switching the sense of all boolean operations.
2662 llvm::ICmpInst::Predicate Eq;
2663 llvm::Instruction::BinaryOps And, Or;
2664 if (Inequality) {
2665 Eq = llvm::ICmpInst::ICMP_NE;
2666 And = llvm::Instruction::Or;
2667 Or = llvm::Instruction::And;
2668 } else {
2669 Eq = llvm::ICmpInst::ICMP_EQ;
2670 And = llvm::Instruction::And;
2671 Or = llvm::Instruction::Or;
2672 }
2673
2674 // If this is a single field member pointer (single inheritance), this is a
2675 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002676 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2677 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002678 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2679 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002680 return Builder.CreateICmp(Eq, L, R);
2681
2682 // Compare the first field.
2683 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2684 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2685 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2686
2687 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002688 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002689 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2690 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2691 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2692 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2693 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2694 if (Res)
2695 Res = Builder.CreateBinOp(And, Res, Cmp);
2696 else
2697 Res = Cmp;
2698 }
2699
2700 // Check if the first field is 0 if this is a function pointer.
2701 if (MPT->isMemberFunctionPointer()) {
2702 // (l1 == r1 && ...) || l0 == 0
2703 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2704 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2705 Res = Builder.CreateBinOp(Or, Res, IsZero);
2706 }
2707
2708 // Combine the comparison of the first field, which must always be true for
2709 // this comparison to succeeed.
2710 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2711}
2712
Reid Kleckner407e8b62013-03-22 19:02:54 +00002713llvm::Value *
2714MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2715 llvm::Value *MemPtr,
2716 const MemberPointerType *MPT) {
2717 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002718 llvm::SmallVector<llvm::Constant *, 4> fields;
2719 // We only need one field for member functions.
2720 if (MPT->isMemberFunctionPointer())
2721 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2722 else
2723 GetNullMemberPointerFields(MPT, fields);
2724 assert(!fields.empty());
2725 llvm::Value *FirstField = MemPtr;
2726 if (MemPtr->getType()->isStructTy())
2727 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2728 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002729
Reid Kleckner2341ae32013-04-11 18:13:19 +00002730 // For function member pointers, we only need to test the function pointer
2731 // field. The other fields if any can be garbage.
2732 if (MPT->isMemberFunctionPointer())
2733 return Res;
2734
2735 // Otherwise, emit a series of compares and combine the results.
2736 for (int I = 1, E = fields.size(); I < E; ++I) {
2737 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2738 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002739 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002740 }
2741 return Res;
2742}
2743
Reid Kleckner452abac2013-05-09 21:01:17 +00002744bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2745 llvm::Constant *Val) {
2746 // Function pointers are null if the pointer in the first field is null.
2747 if (MPT->isMemberFunctionPointer()) {
2748 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2749 Val->getAggregateElement(0U) : Val;
2750 return FirstField->isNullValue();
2751 }
2752
2753 // If it's not a function pointer and it's zero initializable, we can easily
2754 // check zero.
2755 if (isZeroInitializable(MPT) && Val->isNullValue())
2756 return true;
2757
2758 // Otherwise, break down all the fields for comparison. Hopefully these
2759 // little Constants are reused, while a big null struct might not be.
2760 llvm::SmallVector<llvm::Constant *, 4> Fields;
2761 GetNullMemberPointerFields(MPT, Fields);
2762 if (Fields.size() == 1) {
2763 assert(Val->getType()->isIntegerTy());
2764 return Val == Fields[0];
2765 }
2766
2767 unsigned I, E;
2768 for (I = 0, E = Fields.size(); I != E; ++I) {
2769 if (Val->getAggregateElement(I) != Fields[I])
2770 break;
2771 }
2772 return I == E;
2773}
2774
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002775llvm::Value *
2776MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
2777 llvm::Value *This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002778 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002779 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002780 llvm::Value **VBPtrOut) {
2781 CGBuilderTy &Builder = CGF.Builder;
2782 // Load the vbtable pointer from the vbptr in the instance.
2783 This = Builder.CreateBitCast(This, CGM.Int8PtrTy);
2784 llvm::Value *VBPtr =
2785 Builder.CreateInBoundsGEP(This, VBPtrOffset, "vbptr");
2786 if (VBPtrOut) *VBPtrOut = VBPtr;
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002787 VBPtr = Builder.CreateBitCast(VBPtr,
2788 CGM.Int32Ty->getPointerTo(0)->getPointerTo(0));
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002789 llvm::Value *VBTable = Builder.CreateLoad(VBPtr, "vbtable");
2790
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002791 // Translate from byte offset to table index. It improves analyzability.
2792 llvm::Value *VBTableIndex = Builder.CreateAShr(
2793 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
2794 "vbtindex", /*isExact=*/true);
2795
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002796 // Load an i32 offset from the vb-table.
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002797 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002798 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
2799 return Builder.CreateLoad(VBaseOffs, "vbase_offs");
2800}
2801
Reid Kleckner2341ae32013-04-11 18:13:19 +00002802// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2803// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002804llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2805 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
2806 llvm::Value *Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002807 CGBuilderTy &Builder = CGF.Builder;
2808 Base = Builder.CreateBitCast(Base, CGM.Int8PtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +00002809 llvm::BasicBlock *OriginalBB = nullptr;
2810 llvm::BasicBlock *SkipAdjustBB = nullptr;
2811 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002812
2813 // In the unspecified inheritance model, there might not be a vbtable at all,
2814 // in which case we need to skip the virtual base lookup. If there is a
2815 // vbtable, the first entry is a no-op entry that gives back the original
2816 // base, so look for a virtual base adjustment offset of zero.
2817 if (VBPtrOffset) {
2818 OriginalBB = Builder.GetInsertBlock();
2819 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2820 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2821 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002822 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002823 "memptr.is_vbase");
2824 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2825 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002826 }
2827
Reid Kleckner2341ae32013-04-11 18:13:19 +00002828 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
2829 // know the vbptr offset.
2830 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002831 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00002832 if (!RD->hasDefinition()) {
2833 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
2834 unsigned DiagID = Diags.getCustomDiagID(
2835 DiagnosticsEngine::Error,
2836 "member pointer representation requires a "
2837 "complete class type for %0 to perform this expression");
2838 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
2839 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002840 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002841 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
2842 }
Craig Topper8a13c412014-05-21 05:09:00 +00002843 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002844 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002845 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002846 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
2847
2848 // Merge control flow with the case where we didn't have to adjust.
2849 if (VBaseAdjustBB) {
2850 Builder.CreateBr(SkipAdjustBB);
2851 CGF.EmitBlock(SkipAdjustBB);
2852 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
2853 Phi->addIncoming(Base, OriginalBB);
2854 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
2855 return Phi;
2856 }
2857 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002858}
2859
David Majnemer2b0d66d2014-02-20 23:22:07 +00002860llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
2861 CodeGenFunction &CGF, const Expr *E, llvm::Value *Base, llvm::Value *MemPtr,
2862 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002863 assert(MPT->isMemberDataPointer());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002864 unsigned AS = Base->getType()->getPointerAddressSpace();
2865 llvm::Type *PType =
2866 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
2867 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002868 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2869 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00002870
Reid Kleckner2341ae32013-04-11 18:13:19 +00002871 // Extract the fields we need, regardless of model. We'll apply them if we
2872 // have them.
2873 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002874 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2875 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002876 if (MemPtr->getType()->isStructTy()) {
2877 // We need to extract values.
2878 unsigned I = 0;
2879 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002880 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002881 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002882 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002883 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002884 }
2885
Reid Kleckner2341ae32013-04-11 18:13:19 +00002886 if (VirtualBaseAdjustmentOffset) {
David Majnemer2b0d66d2014-02-20 23:22:07 +00002887 Base = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00002888 VBPtrOffset);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002889 }
Reid Klecknerae945122013-12-05 22:44:07 +00002890
2891 // Cast to char*.
2892 Base = Builder.CreateBitCast(Base, Builder.getInt8Ty()->getPointerTo(AS));
2893
2894 // Apply the offset, which we assume is non-null.
Reid Kleckner2341ae32013-04-11 18:13:19 +00002895 llvm::Value *Addr =
2896 Builder.CreateInBoundsGEP(Base, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002897
2898 // Cast the address to the appropriate pointer type, adopting the address
2899 // space of the base pointer.
2900 return Builder.CreateBitCast(Addr, PType);
2901}
2902
Reid Kleckner452abac2013-05-09 21:01:17 +00002903llvm::Value *
2904MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
2905 const CastExpr *E,
2906 llvm::Value *Src) {
2907 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
2908 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
2909 E->getCastKind() == CK_ReinterpretMemberPointer);
2910
2911 // Use constant emission if we can.
2912 if (isa<llvm::Constant>(Src))
2913 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
2914
2915 // We may be adding or dropping fields from the member pointer, so we need
2916 // both types and the inheritance models of both records.
2917 const MemberPointerType *SrcTy =
2918 E->getSubExpr()->getType()->castAs<MemberPointerType>();
2919 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002920 bool IsFunc = SrcTy->isMemberFunctionPointer();
2921
2922 // If the classes use the same null representation, reinterpret_cast is a nop.
2923 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002924 if (IsReinterpret && IsFunc)
2925 return Src;
2926
2927 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
2928 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
2929 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00002930 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00002931 return Src;
2932
2933 CGBuilderTy &Builder = CGF.Builder;
2934
2935 // Branch past the conversion if Src is null.
2936 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
2937 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
2938
2939 // C++ 5.2.10p9: The null member pointer value is converted to the null member
2940 // pointer value of the destination type.
2941 if (IsReinterpret) {
2942 // For reinterpret casts, sema ensures that src and dst are both functions
2943 // or data and have the same size, which means the LLVM types should match.
2944 assert(Src->getType() == DstNull->getType());
2945 return Builder.CreateSelect(IsNotNull, Src, DstNull);
2946 }
2947
2948 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
2949 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
2950 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
2951 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
2952 CGF.EmitBlock(ConvertBB);
2953
2954 // Decompose src.
2955 llvm::Value *FirstField = Src;
David Majnemerc1709d32015-06-23 07:31:11 +00002956 llvm::Value *NonVirtualBaseAdjustment = getZeroInt();
2957 llvm::Value *VirtualBaseAdjustmentOffset = getZeroInt();
2958 llvm::Value *VBPtrOffset = getZeroInt();
David Majnemer1cdd96d2014-01-17 09:01:00 +00002959 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
David Majnemerc1709d32015-06-23 07:31:11 +00002960 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002961 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002962 // We need to extract values.
2963 unsigned I = 0;
2964 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002965 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002966 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002967 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002968 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002969 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002970 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
2971 }
2972
David Majnemerc1709d32015-06-23 07:31:11 +00002973 bool IsDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
2974 const MemberPointerType *DerivedTy = IsDerivedToBase ? SrcTy : DstTy;
2975 const CXXRecordDecl *DerivedClass = DerivedTy->getMostRecentCXXRecordDecl();
2976
Reid Kleckner452abac2013-05-09 21:01:17 +00002977 // For data pointers, we adjust the field offset directly. For functions, we
2978 // have a separate field.
David Majnemerc1709d32015-06-23 07:31:11 +00002979 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
2980
2981 // The virtual inheritance model has a quirk: the virtual base table is always
2982 // referenced when dereferencing a member pointer even if the member pointer
2983 // is non-virtual. This is accounted for by adjusting the non-virtual offset
2984 // to point backwards to the top of the MDC from the first VBase. Undo this
2985 // adjustment to normalize the member pointer.
2986 llvm::Value *SrcVBIndexEqZero =
2987 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
2988 if (SrcInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
2989 if (int64_t SrcOffsetToFirstVBase =
2990 computeOffsetOfBaseWithVBPtr(getContext(), SrcRD).getQuantity()) {
2991 llvm::Value *UndoSrcAdjustment = Builder.CreateSelect(
2992 SrcVBIndexEqZero,
2993 llvm::ConstantInt::get(CGM.IntTy, SrcOffsetToFirstVBase),
2994 getZeroInt());
2995 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, UndoSrcAdjustment);
2996 }
Reid Kleckner452abac2013-05-09 21:01:17 +00002997 }
2998
David Majnemerc1709d32015-06-23 07:31:11 +00002999 // A non-zero vbindex implies that we are dealing with a source member in a
3000 // floating virtual base in addition to some non-virtual offset. If the
3001 // vbindex is zero, we are dealing with a source that exists in a non-virtual,
3002 // fixed, base. The difference between these two cases is that the vbindex +
3003 // nvoffset *always* point to the member regardless of what context they are
3004 // evaluated in so long as the vbindex is adjusted. A member inside a fixed
3005 // base requires explicit nv adjustment.
3006 llvm::Constant *BaseClassOffset = llvm::ConstantInt::get(
3007 CGM.IntTy, CGM.computeNonVirtualBaseClassOffset(
3008 DerivedClass, E->path_begin(), E->path_end())
3009 .getQuantity());
3010
3011 llvm::Value *NVDisp;
3012 if (IsDerivedToBase)
3013 NVDisp = Builder.CreateNSWSub(NVAdjustField, BaseClassOffset, "adj");
3014 else
3015 NVDisp = Builder.CreateNSWAdd(NVAdjustField, BaseClassOffset, "adj");
3016
3017 NVAdjustField = Builder.CreateSelect(SrcVBIndexEqZero, NVDisp, getZeroInt());
3018
3019 // Update the vbindex to an appropriate value in the destination because
3020 // SrcRD's vbtable might not be a strict prefix of the one in DstRD.
3021 llvm::Value *DstVBIndexEqZero = SrcVBIndexEqZero;
3022 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance) &&
3023 MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance)) {
3024 if (llvm::GlobalVariable *VDispMap =
3025 getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) {
3026 llvm::Value *VBIndex = Builder.CreateExactUDiv(
3027 VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4));
3028 llvm::Value *Idxs[] = {getZeroInt(), VBIndex};
3029 VirtualBaseAdjustmentOffset =
3030 Builder.CreateLoad(Builder.CreateInBoundsGEP(VDispMap, Idxs));
3031
3032 DstVBIndexEqZero =
3033 Builder.CreateICmpEQ(VirtualBaseAdjustmentOffset, getZeroInt());
3034 }
3035 }
3036
3037 // Set the VBPtrOffset to zero if the vbindex is zero. Otherwise, initialize
3038 // it to the offset of the vbptr.
3039 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance)) {
3040 llvm::Value *DstVBPtrOffset = llvm::ConstantInt::get(
3041 CGM.IntTy,
3042 getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity());
3043 VBPtrOffset =
3044 Builder.CreateSelect(DstVBIndexEqZero, getZeroInt(), DstVBPtrOffset);
3045 }
3046
3047 // Likewise, apply a similar adjustment so that dereferencing the member
3048 // pointer correctly accounts for the distance between the start of the first
3049 // virtual base and the top of the MDC.
3050 if (DstInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3051 if (int64_t DstOffsetToFirstVBase =
3052 computeOffsetOfBaseWithVBPtr(getContext(), DstRD).getQuantity()) {
3053 llvm::Value *DoDstAdjustment = Builder.CreateSelect(
3054 DstVBIndexEqZero,
3055 llvm::ConstantInt::get(CGM.IntTy, DstOffsetToFirstVBase),
3056 getZeroInt());
3057 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, DoDstAdjustment);
3058 }
3059 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003060
3061 // Recompose dst from the null struct and the adjusted fields from src.
3062 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00003063 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00003064 Dst = FirstField;
3065 } else {
3066 Dst = llvm::UndefValue::get(DstNull->getType());
3067 unsigned Idx = 0;
3068 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003069 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003070 Dst = Builder.CreateInsertValue(Dst, NonVirtualBaseAdjustment, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003071 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003072 Dst = Builder.CreateInsertValue(Dst, VBPtrOffset, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003073 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003074 Dst = Builder.CreateInsertValue(Dst, VirtualBaseAdjustmentOffset, Idx++);
Reid Kleckner452abac2013-05-09 21:01:17 +00003075 }
3076 Builder.CreateBr(ContinueBB);
3077
3078 // In the continuation, choose between DstNull and Dst.
3079 CGF.EmitBlock(ContinueBB);
3080 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
3081 Phi->addIncoming(DstNull, OriginalBB);
3082 Phi->addIncoming(Dst, ConvertBB);
3083 return Phi;
3084}
3085
3086llvm::Constant *
3087MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
3088 llvm::Constant *Src) {
3089 const MemberPointerType *SrcTy =
David Majnemer5ca193c2015-06-23 07:31:07 +00003090 E->getSubExpr()->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00003091 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
3092
David Majnemer5ca193c2015-06-23 07:31:07 +00003093 CastKind CK = E->getCastKind();
3094
3095 return EmitMemberPointerConversion(SrcTy, DstTy, CK, E->path_begin(),
3096 E->path_end(), Src);
3097}
3098
3099llvm::Constant *MicrosoftCXXABI::EmitMemberPointerConversion(
3100 const MemberPointerType *SrcTy, const MemberPointerType *DstTy, CastKind CK,
3101 CastExpr::path_const_iterator PathBegin,
3102 CastExpr::path_const_iterator PathEnd, llvm::Constant *Src) {
3103 assert(CK == CK_DerivedToBaseMemberPointer ||
3104 CK == CK_BaseToDerivedMemberPointer ||
3105 CK == CK_ReinterpretMemberPointer);
Reid Kleckner452abac2013-05-09 21:01:17 +00003106 // If src is null, emit a new null for dst. We can't return src because dst
3107 // might have a new representation.
3108 if (MemberPointerConstantIsNull(SrcTy, Src))
3109 return EmitNullMemberPointer(DstTy);
3110
3111 // We don't need to do anything for reinterpret_casts of non-null member
3112 // pointers. We should only get here when the two type representations have
3113 // the same size.
David Majnemer5ca193c2015-06-23 07:31:07 +00003114 if (CK == CK_ReinterpretMemberPointer)
Reid Kleckner452abac2013-05-09 21:01:17 +00003115 return Src;
3116
David Majnemerc1709d32015-06-23 07:31:11 +00003117 const CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
3118 const CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
3119 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
3120 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
Reid Kleckner452abac2013-05-09 21:01:17 +00003121
3122 // Decompose src.
3123 llvm::Constant *FirstField = Src;
David Majnemerc1709d32015-06-23 07:31:11 +00003124 llvm::Constant *NonVirtualBaseAdjustment = getZeroInt();
3125 llvm::Constant *VirtualBaseAdjustmentOffset = getZeroInt();
3126 llvm::Constant *VBPtrOffset = getZeroInt();
Reid Kleckner452abac2013-05-09 21:01:17 +00003127 bool IsFunc = SrcTy->isMemberFunctionPointer();
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 = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003132 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003133 NonVirtualBaseAdjustment = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003134 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003135 VBPtrOffset = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003136 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003137 VirtualBaseAdjustmentOffset = Src->getAggregateElement(I++);
3138 }
3139
David Majnemerc1709d32015-06-23 07:31:11 +00003140 bool IsDerivedToBase = (CK == CK_DerivedToBaseMemberPointer);
3141 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::Constant *&NVAdjustField =
Reid Kleckner452abac2013-05-09 21:01:17 +00003147 IsFunc ? NonVirtualBaseAdjustment : FirstField;
David Majnemerc1709d32015-06-23 07:31:11 +00003148
3149 // The virtual inheritance model has a quirk: the virtual base table is always
3150 // referenced when dereferencing a member pointer even if the member pointer
3151 // is non-virtual. This is accounted for by adjusting the non-virtual offset
3152 // to point backwards to the top of the MDC from the first VBase. Undo this
3153 // adjustment to normalize the member pointer.
3154 llvm::Constant *SrcVBIndexEqZero = llvm::ConstantExpr::getICmp(
3155 llvm::ICmpInst::ICMP_EQ, VirtualBaseAdjustmentOffset, getZeroInt());
3156 if (SrcInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3157 llvm::Constant *SrcOffsetToFirstVBase = llvm::ConstantInt::get(
3158 CGM.IntTy,
3159 computeOffsetOfBaseWithVBPtr(getContext(), SrcRD).getQuantity());
3160 llvm::Constant *UndoSrcAdjustment = llvm::ConstantExpr::getSelect(
3161 SrcVBIndexEqZero, SrcOffsetToFirstVBase, getZeroInt());
3162 NVAdjustField =
3163 llvm::ConstantExpr::getNSWAdd(NVAdjustField, UndoSrcAdjustment);
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(
3174 CGM.IntTy,
3175 CGM.computeNonVirtualBaseClassOffset(DerivedClass, PathBegin, PathEnd)
3176 .getQuantity());
3177
3178 llvm::Constant *NVDisp;
3179 if (IsDerivedToBase)
3180 NVDisp = llvm::ConstantExpr::getNSWSub(NVAdjustField, BaseClassOffset);
3181 else
3182 NVDisp = llvm::ConstantExpr::getNSWAdd(NVAdjustField, BaseClassOffset);
3183
3184 // An nv-base adjustment must only be made if the vbindex is zero (or does not
3185 // exist).
3186 NVAdjustField =
3187 llvm::ConstantExpr::getSelect(SrcVBIndexEqZero, NVDisp, getZeroInt());
3188
3189 // Update the vbindex to an appropriate value in the destination because
3190 // SrcRD's vbtable might not be a strict prefix of the one in DstRD.
3191 llvm::Constant *DstVBIndexEqZero = SrcVBIndexEqZero;
3192 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance) &&
3193 MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance)) {
3194 if (llvm::GlobalVariable *VDispMap =
3195 getAddrOfVirtualDisplacementMap(SrcRD, DstRD)) {
3196 llvm::Constant *Mapping = VDispMap->getInitializer();
3197 llvm::Constant *VBIndex = llvm::ConstantExpr::getUDiv(
3198 VirtualBaseAdjustmentOffset, llvm::ConstantInt::get(CGM.IntTy, 4),
3199 /*IsExact=*/true);
3200 VirtualBaseAdjustmentOffset = Mapping->getAggregateElement(VBIndex);
3201
3202 DstVBIndexEqZero = llvm::ConstantExpr::getICmp(
3203 llvm::ICmpInst::ICMP_EQ, VirtualBaseAdjustmentOffset, getZeroInt());
3204 }
3205 }
3206
3207 // Set the VBPtrOffset to zero if the vbindex is zero. Otherwise, initialize
3208 // it to the offset of the vbptr.
3209 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance)) {
3210 llvm::Constant *DstVBPtrOffset = llvm::ConstantInt::get(
3211 CGM.IntTy,
3212 getContext().getASTRecordLayout(DstRD).getVBPtrOffset().getQuantity());
3213 VBPtrOffset = llvm::ConstantExpr::getSelect(DstVBIndexEqZero, getZeroInt(),
3214 DstVBPtrOffset);
3215 }
3216
3217 // Likewise, apply a similar adjustment so that dereferencing the member
3218 // pointer correctly accounts for the distance between the start of the first
3219 // virtual base and the top of the MDC.
3220 if (DstInheritance == MSInheritanceAttr::Keyword_virtual_inheritance) {
3221 llvm::Constant *DstOffsetToFirstVBase = llvm::ConstantInt::get(
3222 CGM.IntTy,
3223 computeOffsetOfBaseWithVBPtr(getContext(), DstRD).getQuantity());
3224 llvm::Constant *DoDstAdjustment = llvm::ConstantExpr::getSelect(
3225 DstVBIndexEqZero, DstOffsetToFirstVBase, getZeroInt());
3226 NVAdjustField =
3227 llvm::ConstantExpr::getNSWSub(NVAdjustField, DoDstAdjustment);
3228 }
Reid Kleckner452abac2013-05-09 21:01:17 +00003229
3230 // Recompose dst from the null struct and the adjusted fields from src.
Reid Kleckner96f8f932014-02-05 17:27:08 +00003231 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00003232 return FirstField;
3233
3234 llvm::SmallVector<llvm::Constant *, 4> Fields;
3235 Fields.push_back(FirstField);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003236 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003237 Fields.push_back(NonVirtualBaseAdjustment);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003238 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003239 Fields.push_back(VBPtrOffset);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003240 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
David Majnemerc1709d32015-06-23 07:31:11 +00003241 Fields.push_back(VirtualBaseAdjustmentOffset);
Reid Kleckner452abac2013-05-09 21:01:17 +00003242 return llvm::ConstantStruct::getAnon(Fields);
3243}
3244
David Majnemer2b0d66d2014-02-20 23:22:07 +00003245llvm::Value *MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
3246 CodeGenFunction &CGF, const Expr *E, llvm::Value *&This,
3247 llvm::Value *MemPtr, const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00003248 assert(MPT->isMemberFunctionPointer());
3249 const FunctionProtoType *FPT =
3250 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00003251 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003252 llvm::FunctionType *FTy =
3253 CGM.getTypes().GetFunctionType(
3254 CGM.getTypes().arrangeCXXMethodType(RD, FPT));
3255 CGBuilderTy &Builder = CGF.Builder;
3256
David Majnemer1cdd96d2014-01-17 09:01:00 +00003257 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00003258
3259 // Extract the fields we need, regardless of model. We'll apply them if we
3260 // have them.
3261 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00003262 llvm::Value *NonVirtualBaseAdjustment = nullptr;
3263 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
3264 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00003265 if (MemPtr->getType()->isStructTy()) {
3266 // We need to extract values.
3267 unsigned I = 0;
3268 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003269 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003270 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003271 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00003272 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00003273 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00003274 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
3275 }
3276
3277 if (VirtualBaseAdjustmentOffset) {
David Majnemer2b0d66d2014-02-20 23:22:07 +00003278 This = AdjustVirtualBase(CGF, E, RD, This, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00003279 VBPtrOffset);
3280 }
3281
3282 if (NonVirtualBaseAdjustment) {
3283 // Apply the adjustment and cast back to the original struct type.
3284 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy());
3285 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
3286 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted");
3287 }
3288
3289 return Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
3290}
3291
Charles Davis53c59df2010-08-16 03:33:14 +00003292CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00003293 return new MicrosoftCXXABI(CGM);
3294}
David Majnemere2cb8d12014-07-07 06:20:47 +00003295
3296// MS RTTI Overview:
3297// The run time type information emitted by cl.exe contains 5 distinct types of
3298// structures. Many of them reference each other.
3299//
3300// TypeInfo: Static classes that are returned by typeid.
3301//
3302// CompleteObjectLocator: Referenced by vftables. They contain information
3303// required for dynamic casting, including OffsetFromTop. They also contain
3304// a reference to the TypeInfo for the type and a reference to the
3305// CompleteHierarchyDescriptor for the type.
3306//
3307// ClassHieararchyDescriptor: Contains information about a class hierarchy.
3308// Used during dynamic_cast to walk a class hierarchy. References a base
3309// class array and the size of said array.
3310//
3311// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
3312// somewhat of a misnomer because the most derived class is also in the list
3313// as well as multiple copies of virtual bases (if they occur multiple times
3314// in the hiearchy.) The BaseClassArray contains one BaseClassDescriptor for
3315// every path in the hierarchy, in pre-order depth first order. Note, we do
3316// not declare a specific llvm type for BaseClassArray, it's merely an array
3317// of BaseClassDescriptor pointers.
3318//
3319// BaseClassDescriptor: Contains information about a class in a class hierarchy.
3320// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
3321// BaseClassArray is. It contains information about a class within a
3322// hierarchy such as: is this base is ambiguous and what is its offset in the
3323// vbtable. The names of the BaseClassDescriptors have all of their fields
3324// mangled into them so they can be aggressively deduplicated by the linker.
3325
David Majnemere2cb8d12014-07-07 06:20:47 +00003326static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
3327 StringRef MangledName("\01??_7type_info@@6B@");
3328 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
3329 return VTable;
3330 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
3331 /*Constant=*/true,
3332 llvm::GlobalVariable::ExternalLinkage,
3333 /*Initializer=*/nullptr, MangledName);
3334}
3335
3336namespace {
3337
3338/// \brief A Helper struct that stores information about a class in a class
3339/// hierarchy. The information stored in these structs struct is used during
3340/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
3341// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
3342// implicit depth first pre-order tree connectivity. getFirstChild and
3343// getNextSibling allow us to walk the tree efficiently.
3344struct MSRTTIClass {
3345 enum {
3346 IsPrivateOnPath = 1 | 8,
3347 IsAmbiguous = 2,
3348 IsPrivate = 4,
3349 IsVirtual = 16,
3350 HasHierarchyDescriptor = 64
3351 };
3352 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
3353 uint32_t initialize(const MSRTTIClass *Parent,
3354 const CXXBaseSpecifier *Specifier);
3355
3356 MSRTTIClass *getFirstChild() { return this + 1; }
3357 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
3358 return Child + 1 + Child->NumBases;
3359 }
3360
3361 const CXXRecordDecl *RD, *VirtualRoot;
3362 uint32_t Flags, NumBases, OffsetInVBase;
3363};
3364
3365/// \brief Recursively initialize the base class array.
3366uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
3367 const CXXBaseSpecifier *Specifier) {
3368 Flags = HasHierarchyDescriptor;
3369 if (!Parent) {
3370 VirtualRoot = nullptr;
3371 OffsetInVBase = 0;
3372 } else {
3373 if (Specifier->getAccessSpecifier() != AS_public)
3374 Flags |= IsPrivate | IsPrivateOnPath;
3375 if (Specifier->isVirtual()) {
3376 Flags |= IsVirtual;
3377 VirtualRoot = RD;
3378 OffsetInVBase = 0;
3379 } else {
3380 if (Parent->Flags & IsPrivateOnPath)
3381 Flags |= IsPrivateOnPath;
3382 VirtualRoot = Parent->VirtualRoot;
3383 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
3384 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
3385 }
3386 }
3387 NumBases = 0;
3388 MSRTTIClass *Child = getFirstChild();
3389 for (const CXXBaseSpecifier &Base : RD->bases()) {
3390 NumBases += Child->initialize(this, &Base) + 1;
3391 Child = getNextChild(Child);
3392 }
3393 return NumBases;
3394}
3395
3396static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
3397 switch (Ty->getLinkage()) {
3398 case NoLinkage:
3399 case InternalLinkage:
3400 case UniqueExternalLinkage:
3401 return llvm::GlobalValue::InternalLinkage;
3402
3403 case VisibleNoLinkage:
3404 case ExternalLinkage:
3405 return llvm::GlobalValue::LinkOnceODRLinkage;
3406 }
3407 llvm_unreachable("Invalid linkage!");
3408}
3409
3410/// \brief An ephemeral helper class for building MS RTTI types. It caches some
3411/// calls to the module and information about the most derived class in a
3412/// hierarchy.
3413struct MSRTTIBuilder {
3414 enum {
3415 HasBranchingHierarchy = 1,
3416 HasVirtualBranchingHierarchy = 2,
3417 HasAmbiguousBases = 4
3418 };
3419
David Majnemer611cdb92014-07-07 08:09:15 +00003420 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
3421 : CGM(ABI.CGM), Context(CGM.getContext()),
3422 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00003423 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003424 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00003425
3426 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
3427 llvm::GlobalVariable *
3428 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
3429 llvm::GlobalVariable *getClassHierarchyDescriptor();
3430 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo *Info);
3431
3432 CodeGenModule &CGM;
3433 ASTContext &Context;
3434 llvm::LLVMContext &VMContext;
3435 llvm::Module &Module;
3436 const CXXRecordDecl *RD;
3437 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00003438 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00003439};
3440
3441} // namespace
3442
3443/// \brief Recursively serializes a class hierarchy in pre-order depth first
3444/// order.
3445static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
3446 const CXXRecordDecl *RD) {
3447 Classes.push_back(MSRTTIClass(RD));
3448 for (const CXXBaseSpecifier &Base : RD->bases())
3449 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
3450}
3451
3452/// \brief Find ambiguity among base classes.
3453static void
3454detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
3455 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
3456 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
3457 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
3458 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
3459 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
David Blaikie82e95a32014-11-19 07:49:47 +00003460 !VirtualBases.insert(Class->RD).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003461 Class = MSRTTIClass::getNextChild(Class);
3462 continue;
3463 }
David Blaikie82e95a32014-11-19 07:49:47 +00003464 if (!UniqueBases.insert(Class->RD).second)
David Majnemere2cb8d12014-07-07 06:20:47 +00003465 AmbiguousBases.insert(Class->RD);
3466 Class++;
3467 }
3468 if (AmbiguousBases.empty())
3469 return;
3470 for (MSRTTIClass &Class : Classes)
3471 if (AmbiguousBases.count(Class.RD))
3472 Class.Flags |= MSRTTIClass::IsAmbiguous;
3473}
3474
3475llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
3476 SmallString<256> MangledName;
3477 {
3478 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003479 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003480 }
3481
3482 // Check to see if we've already declared this ClassHierarchyDescriptor.
3483 if (auto CHD = Module.getNamedGlobal(MangledName))
3484 return CHD;
3485
3486 // Serialize the class hierarchy and initialize the CHD Fields.
3487 SmallVector<MSRTTIClass, 8> Classes;
3488 serializeClassHierarchy(Classes, RD);
3489 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3490 detectAmbiguousBases(Classes);
3491 int Flags = 0;
3492 for (auto Class : Classes) {
3493 if (Class.RD->getNumBases() > 1)
3494 Flags |= HasBranchingHierarchy;
3495 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
3496 // believe the field isn't actually used.
3497 if (Class.Flags & MSRTTIClass::IsAmbiguous)
3498 Flags |= HasAmbiguousBases;
3499 }
3500 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
3501 Flags |= HasVirtualBranchingHierarchy;
3502 // These gep indices are used to get the address of the first element of the
3503 // base class array.
3504 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
3505 llvm::ConstantInt::get(CGM.IntTy, 0)};
3506
3507 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00003508 auto Type = ABI.getClassHierarchyDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003509 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3510 /*Initializer=*/nullptr,
David Majnemer7c237072015-03-05 00:46:22 +00003511 StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003512 if (CHD->isWeakForLinker())
3513 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003514
David Blaikiee3b172a2015-04-02 18:55:21 +00003515 auto *Bases = getBaseClassArray(Classes);
3516
David Majnemere2cb8d12014-07-07 06:20:47 +00003517 // Initialize the base class ClassHierarchyDescriptor.
3518 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003519 llvm::ConstantInt::get(CGM.IntTy, 0), // Unknown
3520 llvm::ConstantInt::get(CGM.IntTy, Flags),
3521 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
3522 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00003523 Bases->getValueType(), Bases,
David Majnemer611cdb92014-07-07 08:09:15 +00003524 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00003525 };
3526 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3527 return CHD;
3528}
3529
3530llvm::GlobalVariable *
3531MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3532 SmallString<256> MangledName;
3533 {
3534 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003535 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003536 }
3537
3538 // Forward-declare the base class array.
3539 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3540 // mode) bytes of padding. We provide a pointer sized amount of padding by
3541 // adding +1 to Classes.size(). The sections have pointer alignment and are
3542 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00003543 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00003544 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00003545 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
David Majnemer7c237072015-03-05 00:46:22 +00003546 auto *BCA =
3547 new llvm::GlobalVariable(Module, ArrType,
3548 /*Constant=*/true, Linkage,
3549 /*Initializer=*/nullptr, StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003550 if (BCA->isWeakForLinker())
3551 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003552
3553 // Initialize the BaseClassArray.
3554 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3555 for (MSRTTIClass &Class : Classes)
3556 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00003557 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00003558 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00003559 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00003560 return BCA;
3561}
3562
3563llvm::GlobalVariable *
3564MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3565 // Compute the fields for the BaseClassDescriptor. They are computed up front
3566 // because they are mangled into the name of the object.
3567 uint32_t OffsetInVBTable = 0;
3568 int32_t VBPtrOffset = -1;
3569 if (Class.VirtualRoot) {
3570 auto &VTableContext = CGM.getMicrosoftVTableContext();
3571 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3572 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3573 }
3574
3575 SmallString<256> MangledName;
3576 {
3577 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003578 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3579 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3580 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003581 }
3582
David Majnemer26a90f82014-07-07 15:29:10 +00003583 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00003584 if (auto BCD = Module.getNamedGlobal(MangledName))
3585 return BCD;
3586
3587 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00003588 auto Type = ABI.getBaseClassDescriptorType();
David Majnemer7c237072015-03-05 00:46:22 +00003589 auto BCD =
3590 new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3591 /*Initializer=*/nullptr, StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003592 if (BCD->isWeakForLinker())
3593 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003594
3595 // Initialize the BaseClassDescriptor.
3596 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003597 ABI.getImageRelativeConstant(
David Majnemer443250f2015-03-17 20:35:00 +00003598 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003599 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3600 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3601 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3602 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3603 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3604 ABI.getImageRelativeConstant(
3605 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00003606 };
3607 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3608 return BCD;
3609}
3610
3611llvm::GlobalVariable *
3612MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo *Info) {
3613 SmallString<256> MangledName;
3614 {
3615 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003616 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info->MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003617 }
3618
3619 // Check to see if we've already computed this complete object locator.
3620 if (auto COL = Module.getNamedGlobal(MangledName))
3621 return COL;
3622
3623 // Compute the fields of the complete object locator.
3624 int OffsetToTop = Info->FullOffsetInMDC.getQuantity();
3625 int VFPtrOffset = 0;
3626 // The offset includes the vtordisp if one exists.
3627 if (const CXXRecordDecl *VBase = Info->getVBaseWithVPtr())
3628 if (Context.getASTRecordLayout(RD)
3629 .getVBaseOffsetsMap()
3630 .find(VBase)
3631 ->second.hasVtorDisp())
3632 VFPtrOffset = Info->NonVirtualOffset.getQuantity() + 4;
3633
3634 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00003635 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003636 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
David Majnemer7c237072015-03-05 00:46:22 +00003637 /*Initializer=*/nullptr, StringRef(MangledName));
David Majnemere2cb8d12014-07-07 06:20:47 +00003638
3639 // Initialize the CompleteObjectLocator.
3640 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003641 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3642 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3643 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3644 ABI.getImageRelativeConstant(
3645 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3646 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3647 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00003648 };
3649 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00003650 if (!ABI.isImageRelative())
3651 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00003652 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
Rafael Espindola654542a2015-01-16 19:23:42 +00003653 if (COL->isWeakForLinker())
3654 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003655 return COL;
3656}
3657
David Majnemerad803d42015-03-15 07:10:01 +00003658static QualType decomposeTypeForEH(ASTContext &Context, QualType T,
3659 bool &IsConst, bool &IsVolatile) {
3660 T = Context.getExceptionObjectType(T);
3661
3662 // C++14 [except.handle]p3:
3663 // A handler is a match for an exception object of type E if [...]
3664 // - the handler is of type cv T or const T& where T is a pointer type and
3665 // E is a pointer type that can be converted to T by [...]
3666 // - a qualification conversion
3667 IsConst = false;
3668 IsVolatile = false;
3669 QualType PointeeType = T->getPointeeType();
3670 if (!PointeeType.isNull()) {
3671 IsConst = PointeeType.isConstQualified();
3672 IsVolatile = PointeeType.isVolatileQualified();
3673 }
3674
3675 // Member pointer types like "const int A::*" are represented by having RTTI
3676 // for "int A::*" and separately storing the const qualifier.
3677 if (const auto *MPTy = T->getAs<MemberPointerType>())
3678 T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(),
3679 MPTy->getClass());
3680
3681 // Pointer types like "const int * const *" are represented by having RTTI
3682 // for "const int **" and separately storing the const qualifier.
3683 if (T->isPointerType())
3684 T = Context.getPointerType(PointeeType.getUnqualifiedType());
3685
3686 return T;
3687}
3688
David Majnemer5f0dd612015-03-17 20:35:05 +00003689llvm::Constant *
David Majnemer37b417f2015-03-29 21:55:10 +00003690MicrosoftCXXABI::getAddrOfCXXCatchHandlerType(QualType Type,
3691 QualType CatchHandlerType) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003692 // TypeDescriptors for exceptions never have qualified pointer types,
David Majnemer443250f2015-03-17 20:35:00 +00003693 // qualifiers are stored seperately in order to support qualification
3694 // conversions.
3695 bool IsConst, IsVolatile;
3696 Type = decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile);
3697
David Majnemer5f0dd612015-03-17 20:35:05 +00003698 bool IsReference = CatchHandlerType->isReferenceType();
3699
David Majnemer5f0dd612015-03-17 20:35:05 +00003700 uint32_t Flags = 0;
3701 if (IsConst)
3702 Flags |= 1;
3703 if (IsVolatile)
3704 Flags |= 2;
3705 if (IsReference)
3706 Flags |= 8;
3707
David Majnemer37b417f2015-03-29 21:55:10 +00003708 SmallString<256> MangledName;
3709 {
3710 llvm::raw_svector_ostream Out(MangledName);
3711 getMangleContext().mangleCXXCatchHandlerType(Type, Flags, Out);
3712 }
3713
3714 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3715 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3716
David Majnemer5f0dd612015-03-17 20:35:05 +00003717 llvm::Constant *Fields[] = {
David Majnemer37b417f2015-03-29 21:55:10 +00003718 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
3719 getAddrOfRTTIDescriptor(Type), // TypeDescriptor
David Majnemer5f0dd612015-03-17 20:35:05 +00003720 };
David Majnemer37b417f2015-03-29 21:55:10 +00003721 llvm::StructType *CatchHandlerTypeType = getCatchHandlerTypeType();
David Majnemer5f0dd612015-03-17 20:35:05 +00003722 auto *Var = new llvm::GlobalVariable(
David Majnemer37b417f2015-03-29 21:55:10 +00003723 CGM.getModule(), CatchHandlerTypeType, /*Constant=*/true,
David Majnemer5f0dd612015-03-17 20:35:05 +00003724 llvm::GlobalValue::PrivateLinkage,
David Majnemer37b417f2015-03-29 21:55:10 +00003725 llvm::ConstantStruct::get(CatchHandlerTypeType, Fields),
David Majnemer5f0dd612015-03-17 20:35:05 +00003726 StringRef(MangledName));
3727 Var->setUnnamedAddr(true);
3728 Var->setSection("llvm.metadata");
3729 return Var;
David Majnemer443250f2015-03-17 20:35:00 +00003730}
3731
David Majnemere2cb8d12014-07-07 06:20:47 +00003732/// \brief Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
3733/// llvm::GlobalVariable * because different type descriptors have different
3734/// types, and need to be abstracted. They are abstracting by casting the
3735/// address to an Int8PtrTy.
David Majnemer443250f2015-03-17 20:35:00 +00003736llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003737 SmallString<256> MangledName;
David Majnemere2cb8d12014-07-07 06:20:47 +00003738 {
3739 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003740 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003741 }
3742
3743 // Check to see if we've already declared this TypeDescriptor.
3744 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3745 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3746
3747 // Compute the fields for the TypeDescriptor.
David Majnemer5f0dd612015-03-17 20:35:05 +00003748 SmallString<256> TypeInfoString;
David Majnemere2cb8d12014-07-07 06:20:47 +00003749 {
3750 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00003751 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003752 }
3753
3754 // Declare and initialize the TypeDescriptor.
3755 llvm::Constant *Fields[] = {
3756 getTypeInfoVTable(CGM), // VFPtr
3757 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3758 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3759 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00003760 getTypeDescriptorType(TypeInfoString);
Rafael Espindola654542a2015-01-16 19:23:42 +00003761 auto *Var = new llvm::GlobalVariable(
3762 CGM.getModule(), TypeDescriptorType, /*Constant=*/false,
3763 getLinkageForRTTI(Type),
3764 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
David Majnemer7c237072015-03-05 00:46:22 +00003765 StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003766 if (Var->isWeakForLinker())
3767 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3768 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003769}
3770
3771/// \brief Gets or a creates a Microsoft CompleteObjectLocator.
3772llvm::GlobalVariable *
3773MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
3774 const VPtrInfo *Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00003775 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003776}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003777
3778static void emitCXXConstructor(CodeGenModule &CGM,
3779 const CXXConstructorDecl *ctor,
3780 StructorType ctorType) {
Rafael Espindolad48b51b2014-09-15 19:24:44 +00003781 // There are no constructor variants, always emit the complete destructor.
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003782 llvm::Function *Fn = CGM.codegenCXXStructor(ctor, StructorType::Complete);
3783 CGM.maybeSetTrivialComdat(*ctor, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003784}
3785
3786static void emitCXXDestructor(CodeGenModule &CGM, const CXXDestructorDecl *dtor,
3787 StructorType dtorType) {
3788 // The complete destructor is equivalent to the base destructor for
3789 // classes with no virtual bases, so try to emit it as an alias.
3790 if (!dtor->getParent()->getNumVBases() &&
3791 (dtorType == StructorType::Complete || dtorType == StructorType::Base)) {
3792 bool ProducedAlias = !CGM.TryEmitDefinitionAsAlias(
3793 GlobalDecl(dtor, Dtor_Complete), GlobalDecl(dtor, Dtor_Base), true);
3794 if (ProducedAlias) {
3795 if (dtorType == StructorType::Complete)
3796 return;
3797 if (dtor->isVirtual())
3798 CGM.getVTables().EmitThunks(GlobalDecl(dtor, Dtor_Complete));
3799 }
3800 }
3801
3802 // The base destructor is equivalent to the base destructor of its
3803 // base class if there is exactly one non-virtual base class with a
3804 // non-trivial destructor, there are no fields with a non-trivial
3805 // destructor, and the body of the destructor is trivial.
3806 if (dtorType == StructorType::Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
3807 return;
3808
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003809 llvm::Function *Fn = CGM.codegenCXXStructor(dtor, dtorType);
Rafael Espindolad3e04692015-01-17 01:47:39 +00003810 if (Fn->isWeakForLinker())
3811 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003812}
3813
3814void MicrosoftCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3815 StructorType Type) {
3816 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
3817 emitCXXConstructor(CGM, CD, Type);
3818 return;
3819 }
3820 emitCXXDestructor(CGM, cast<CXXDestructorDecl>(MD), Type);
3821}
David Majnemer7c237072015-03-05 00:46:22 +00003822
David Majnemerdfa6d202015-03-11 18:36:39 +00003823llvm::Function *
David Majnemer37fd66e2015-03-13 22:36:55 +00003824MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
3825 CXXCtorType CT) {
3826 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
3827
David Majnemerdfa6d202015-03-11 18:36:39 +00003828 // Calculate the mangled name.
3829 SmallString<256> ThunkName;
3830 llvm::raw_svector_ostream Out(ThunkName);
David Majnemer37fd66e2015-03-13 22:36:55 +00003831 getMangleContext().mangleCXXCtor(CD, CT, Out);
David Majnemerdfa6d202015-03-11 18:36:39 +00003832 Out.flush();
3833
3834 // If the thunk has been generated previously, just return it.
3835 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
3836 return cast<llvm::Function>(GV);
3837
3838 // Create the llvm::Function.
David Majnemer37fd66e2015-03-13 22:36:55 +00003839 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT);
David Majnemerdfa6d202015-03-11 18:36:39 +00003840 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
3841 const CXXRecordDecl *RD = CD->getParent();
3842 QualType RecordTy = getContext().getRecordType(RD);
3843 llvm::Function *ThunkFn = llvm::Function::Create(
3844 ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule());
Reid Klecknerbba3cb92015-03-17 19:00:50 +00003845 ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>(
3846 FnInfo.getEffectiveCallingConvention()));
David Majnemer37fd66e2015-03-13 22:36:55 +00003847 bool IsCopy = CT == Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003848
3849 // Start codegen.
3850 CodeGenFunction CGF(CGM);
3851 CGF.CurGD = GlobalDecl(CD, Ctor_Complete);
3852
3853 // Build FunctionArgs.
3854 FunctionArgList FunctionArgs;
3855
David Majnemer37fd66e2015-03-13 22:36:55 +00003856 // A constructor always starts with a 'this' pointer as its first argument.
David Majnemerdfa6d202015-03-11 18:36:39 +00003857 buildThisParam(CGF, FunctionArgs);
3858
3859 // Following the 'this' pointer is a reference to the source object that we
3860 // are copying from.
3861 ImplicitParamDecl SrcParam(
3862 getContext(), nullptr, SourceLocation(), &getContext().Idents.get("src"),
3863 getContext().getLValueReferenceType(RecordTy,
3864 /*SpelledAsLValue=*/true));
David Majnemer37fd66e2015-03-13 22:36:55 +00003865 if (IsCopy)
3866 FunctionArgs.push_back(&SrcParam);
David Majnemerdfa6d202015-03-11 18:36:39 +00003867
David Majnemer37fd66e2015-03-13 22:36:55 +00003868 // Constructors for classes which utilize virtual bases have an additional
3869 // parameter which indicates whether or not it is being delegated to by a more
3870 // derived constructor.
David Majnemerdfa6d202015-03-11 18:36:39 +00003871 ImplicitParamDecl IsMostDerived(getContext(), nullptr, SourceLocation(),
3872 &getContext().Idents.get("is_most_derived"),
3873 getContext().IntTy);
3874 // Only add the parameter to the list if thie class has virtual bases.
3875 if (RD->getNumVBases() > 0)
3876 FunctionArgs.push_back(&IsMostDerived);
3877
3878 // Start defining the function.
3879 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
3880 FunctionArgs, CD->getLocation(), SourceLocation());
3881 EmitThisParam(CGF);
3882 llvm::Value *This = getThisValue(CGF);
3883
3884 llvm::Value *SrcVal =
David Majnemer37fd66e2015-03-13 22:36:55 +00003885 IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src")
3886 : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003887
3888 CallArgList Args;
3889
3890 // Push the this ptr.
3891 Args.add(RValue::get(This), CD->getThisType(getContext()));
3892
3893 // Push the src ptr.
David Majnemer37fd66e2015-03-13 22:36:55 +00003894 if (SrcVal)
3895 Args.add(RValue::get(SrcVal), SrcParam.getType());
David Majnemerdfa6d202015-03-11 18:36:39 +00003896
3897 // Add the rest of the default arguments.
3898 std::vector<Stmt *> ArgVec;
Reid Kleckner93f661a2015-03-17 21:51:43 +00003899 for (unsigned I = IsCopy ? 1 : 0, E = CD->getNumParams(); I != E; ++I) {
3900 Stmt *DefaultArg = getContext().getDefaultArgExprForConstructor(CD, I);
3901 assert(DefaultArg && "sema forgot to instantiate default args");
3902 ArgVec.push_back(DefaultArg);
3903 }
David Majnemerdfa6d202015-03-11 18:36:39 +00003904
3905 CodeGenFunction::RunCleanupsScope Cleanups(CGF);
3906
3907 const auto *FPT = CD->getType()->castAs<FunctionProtoType>();
Aaron Ballman0c22d5a2015-03-12 13:49:45 +00003908 ConstExprIterator ArgBegin(ArgVec.data()),
3909 ArgEnd(ArgVec.data() + ArgVec.size());
David Majnemer37fd66e2015-03-13 22:36:55 +00003910 CGF.EmitCallArgs(Args, FPT, ArgBegin, ArgEnd, CD, IsCopy ? 1 : 0);
David Majnemerdfa6d202015-03-11 18:36:39 +00003911
3912 // Insert any ABI-specific implicit constructor arguments.
3913 unsigned ExtraArgs = addImplicitConstructorArgs(CGF, CD, Ctor_Complete,
3914 /*ForVirtualBase=*/false,
3915 /*Delegating=*/false, Args);
3916
3917 // Call the destructor with our arguments.
3918 llvm::Value *CalleeFn = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3919 const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall(
3920 Args, CD, Ctor_Complete, ExtraArgs);
3921 CGF.EmitCall(CalleeInfo, CalleeFn, ReturnValueSlot(), Args, CD);
3922
3923 Cleanups.ForceCleanup();
3924
3925 // Emit the ret instruction, remove any temporary instructions created for the
3926 // aid of CodeGen.
3927 CGF.FinishFunction(SourceLocation());
3928
3929 return ThunkFn;
3930}
3931
David Majnemer7c237072015-03-05 00:46:22 +00003932llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
3933 uint32_t NVOffset,
3934 int32_t VBPtrOffset,
3935 uint32_t VBIndex) {
3936 assert(!T->isReferenceType());
3937
David Majnemere7a818f2015-03-06 18:53:55 +00003938 CXXRecordDecl *RD = T->getAsCXXRecordDecl();
3939 const CXXConstructorDecl *CD =
3940 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003941 CXXCtorType CT = Ctor_Complete;
David Majnemer37fd66e2015-03-13 22:36:55 +00003942 if (CD)
3943 if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1)
David Majnemerdfa6d202015-03-11 18:36:39 +00003944 CT = Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003945
David Majnemer7c237072015-03-05 00:46:22 +00003946 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
3947 SmallString<256> MangledName;
3948 {
3949 llvm::raw_svector_ostream Out(MangledName);
David Majnemerdfa6d202015-03-11 18:36:39 +00003950 getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +00003951 VBPtrOffset, VBIndex, Out);
David Majnemer7c237072015-03-05 00:46:22 +00003952 }
3953 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3954 return getImageRelativeConstant(GV);
3955
David Majnemerdfa6d202015-03-11 18:36:39 +00003956 // The TypeDescriptor is used by the runtime to determine if a catch handler
David Majnemer7c237072015-03-05 00:46:22 +00003957 // is appropriate for the exception object.
David Majnemer443250f2015-03-17 20:35:00 +00003958 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
David Majnemer7c237072015-03-05 00:46:22 +00003959
3960 // The runtime is responsible for calling the copy constructor if the
3961 // exception is caught by value.
David Majnemerdfa6d202015-03-11 18:36:39 +00003962 llvm::Constant *CopyCtor;
3963 if (CD) {
3964 if (CT == Ctor_CopyingClosure)
David Majnemer37fd66e2015-03-13 22:36:55 +00003965 CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure);
David Majnemerdfa6d202015-03-11 18:36:39 +00003966 else
3967 CopyCtor = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3968
3969 CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy);
3970 } else {
3971 CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
3972 }
David Majnemere7a818f2015-03-06 18:53:55 +00003973 CopyCtor = getImageRelativeConstant(CopyCtor);
David Majnemer7c237072015-03-05 00:46:22 +00003974
David Majnemere7a818f2015-03-06 18:53:55 +00003975 bool IsScalar = !RD;
David Majnemer7c237072015-03-05 00:46:22 +00003976 bool HasVirtualBases = false;
3977 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
David Majnemer7c237072015-03-05 00:46:22 +00003978 QualType PointeeType = T;
3979 if (T->isPointerType())
3980 PointeeType = T->getPointeeType();
3981 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
3982 HasVirtualBases = RD->getNumVBases() > 0;
3983 if (IdentifierInfo *II = RD->getIdentifier())
3984 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
3985 }
3986
3987 // Encode the relevant CatchableType properties into the Flags bitfield.
3988 // FIXME: Figure out how bits 2 or 8 can get set.
3989 uint32_t Flags = 0;
3990 if (IsScalar)
3991 Flags |= 1;
3992 if (HasVirtualBases)
3993 Flags |= 4;
3994 if (IsStdBadAlloc)
3995 Flags |= 16;
3996
3997 llvm::Constant *Fields[] = {
3998 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
3999 TD, // TypeDescriptor
4000 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment
4001 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
4002 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex
4003 llvm::ConstantInt::get(CGM.IntTy, Size), // Size
4004 CopyCtor // CopyCtor
4005 };
4006 llvm::StructType *CTType = getCatchableTypeType();
4007 auto *GV = new llvm::GlobalVariable(
4008 CGM.getModule(), CTType, /*Constant=*/true, getLinkageForRTTI(T),
4009 llvm::ConstantStruct::get(CTType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00004010 GV->setUnnamedAddr(true);
4011 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004012 if (GV->isWeakForLinker())
4013 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004014 return getImageRelativeConstant(GV);
4015}
4016
4017llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
4018 assert(!T->isReferenceType());
4019
4020 // See if we've already generated a CatchableTypeArray for this type before.
4021 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
4022 if (CTA)
4023 return CTA;
4024
4025 // Ensure that we don't have duplicate entries in our CatchableTypeArray by
4026 // using a SmallSetVector. Duplicates may arise due to virtual bases
4027 // occurring more than once in the hierarchy.
4028 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
4029
4030 // C++14 [except.handle]p3:
4031 // A handler is a match for an exception object of type E if [...]
4032 // - the handler is of type cv T or cv T& and T is an unambiguous public
4033 // base class of E, or
4034 // - the handler is of type cv T or const T& where T is a pointer type and
4035 // E is a pointer type that can be converted to T by [...]
4036 // - a standard pointer conversion (4.10) not involving conversions to
4037 // pointers to private or protected or ambiguous classes
4038 const CXXRecordDecl *MostDerivedClass = nullptr;
4039 bool IsPointer = T->isPointerType();
4040 if (IsPointer)
4041 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
4042 else
4043 MostDerivedClass = T->getAsCXXRecordDecl();
4044
4045 // Collect all the unambiguous public bases of the MostDerivedClass.
4046 if (MostDerivedClass) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00004047 const ASTContext &Context = getContext();
David Majnemer7c237072015-03-05 00:46:22 +00004048 const ASTRecordLayout &MostDerivedLayout =
4049 Context.getASTRecordLayout(MostDerivedClass);
4050 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
4051 SmallVector<MSRTTIClass, 8> Classes;
4052 serializeClassHierarchy(Classes, MostDerivedClass);
4053 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
4054 detectAmbiguousBases(Classes);
4055 for (const MSRTTIClass &Class : Classes) {
4056 // Skip any ambiguous or private bases.
4057 if (Class.Flags &
4058 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
4059 continue;
4060 // Write down how to convert from a derived pointer to a base pointer.
4061 uint32_t OffsetInVBTable = 0;
4062 int32_t VBPtrOffset = -1;
4063 if (Class.VirtualRoot) {
4064 OffsetInVBTable =
4065 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
4066 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
4067 }
4068
4069 // Turn our record back into a pointer if the exception object is a
4070 // pointer.
4071 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
4072 if (IsPointer)
4073 RTTITy = Context.getPointerType(RTTITy);
4074 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
4075 VBPtrOffset, OffsetInVBTable));
4076 }
4077 }
4078
4079 // C++14 [except.handle]p3:
4080 // A handler is a match for an exception object of type E if
4081 // - The handler is of type cv T or cv T& and E and T are the same type
4082 // (ignoring the top-level cv-qualifiers)
4083 CatchableTypes.insert(getCatchableType(T));
4084
4085 // C++14 [except.handle]p3:
4086 // A handler is a match for an exception object of type E if
4087 // - the handler is of type cv T or const T& where T is a pointer type and
4088 // E is a pointer type that can be converted to T by [...]
4089 // - a standard pointer conversion (4.10) not involving conversions to
4090 // pointers to private or protected or ambiguous classes
4091 //
David Majnemerf205f532015-04-04 05:37:48 +00004092 // C++14 [conv.ptr]p2:
4093 // A prvalue of type "pointer to cv T," where T is an object type, can be
4094 // converted to a prvalue of type "pointer to cv void".
4095 if (IsPointer && T->getPointeeType()->isObjectType())
David Majnemer7c237072015-03-05 00:46:22 +00004096 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4097
David Majnemera1aea9a2015-03-12 17:44:49 +00004098 // C++14 [except.handle]p3:
4099 // A handler is a match for an exception object of type E if [...]
4100 // - the handler is of type cv T or const T& where T is a pointer or
4101 // pointer to member type and E is std::nullptr_t.
4102 //
4103 // We cannot possibly list all possible pointer types here, making this
4104 // implementation incompatible with the standard. However, MSVC includes an
4105 // entry for pointer-to-void in this case. Let's do the same.
4106 if (T->isNullPtrType())
4107 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
4108
David Majnemer7c237072015-03-05 00:46:22 +00004109 uint32_t NumEntries = CatchableTypes.size();
4110 llvm::Type *CTType =
4111 getImageRelativeType(getCatchableTypeType()->getPointerTo());
4112 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
4113 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
4114 llvm::Constant *Fields[] = {
4115 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries
4116 llvm::ConstantArray::get(
4117 AT, llvm::makeArrayRef(CatchableTypes.begin(),
4118 CatchableTypes.end())) // CatchableTypes
4119 };
4120 SmallString<256> MangledName;
4121 {
4122 llvm::raw_svector_ostream Out(MangledName);
4123 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
4124 }
4125 CTA = new llvm::GlobalVariable(
4126 CGM.getModule(), CTAType, /*Constant=*/true, getLinkageForRTTI(T),
4127 llvm::ConstantStruct::get(CTAType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00004128 CTA->setUnnamedAddr(true);
4129 CTA->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004130 if (CTA->isWeakForLinker())
4131 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004132 return CTA;
4133}
4134
4135llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
David Majnemerad803d42015-03-15 07:10:01 +00004136 bool IsConst, IsVolatile;
4137 T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile);
David Majnemer7c237072015-03-05 00:46:22 +00004138
4139 // The CatchableTypeArray enumerates the various (CV-unqualified) types that
4140 // the exception object may be caught as.
4141 llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
4142 // The first field in a CatchableTypeArray is the number of CatchableTypes.
4143 // This is used as a component of the mangled name which means that we need to
4144 // know what it is in order to see if we have previously generated the
4145 // ThrowInfo.
4146 uint32_t NumEntries =
4147 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
4148 ->getLimitedValue();
4149
4150 SmallString<256> MangledName;
4151 {
4152 llvm::raw_svector_ostream Out(MangledName);
4153 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, NumEntries,
4154 Out);
4155 }
4156
4157 // Reuse a previously generated ThrowInfo if we have generated an appropriate
4158 // one before.
4159 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
4160 return GV;
4161
4162 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
4163 // be at least as CV qualified. Encode this requirement into the Flags
4164 // bitfield.
4165 uint32_t Flags = 0;
4166 if (IsConst)
4167 Flags |= 1;
4168 if (IsVolatile)
4169 Flags |= 2;
4170
4171 // The cleanup-function (a destructor) must be called when the exception
4172 // object's lifetime ends.
4173 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
4174 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
4175 if (CXXDestructorDecl *DtorD = RD->getDestructor())
4176 if (!DtorD->isTrivial())
4177 CleanupFn = llvm::ConstantExpr::getBitCast(
4178 CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete),
4179 CGM.Int8PtrTy);
4180 // This is unused as far as we can tell, initialize it to null.
4181 llvm::Constant *ForwardCompat =
4182 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
4183 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
4184 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
4185 llvm::StructType *TIType = getThrowInfoType();
4186 llvm::Constant *Fields[] = {
4187 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
4188 getImageRelativeConstant(CleanupFn), // CleanupFn
4189 ForwardCompat, // ForwardCompat
4190 PointerToCatchableTypes // CatchableTypeArray
4191 };
4192 auto *GV = new llvm::GlobalVariable(
4193 CGM.getModule(), TIType, /*Constant=*/true, getLinkageForRTTI(T),
4194 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00004195 GV->setUnnamedAddr(true);
4196 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00004197 if (GV->isWeakForLinker())
4198 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00004199 return GV;
4200}
4201
4202void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
4203 const Expr *SubExpr = E->getSubExpr();
4204 QualType ThrowType = SubExpr->getType();
4205 // The exception object lives on the stack and it's address is passed to the
4206 // runtime function.
4207 llvm::AllocaInst *AI = CGF.CreateMemTemp(ThrowType);
4208 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
4209 /*IsInit=*/true);
4210
4211 // The so-called ThrowInfo is used to describe how the exception object may be
4212 // caught.
4213 llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
4214
4215 // Call into the runtime to throw the exception.
4216 llvm::Value *Args[] = {CGF.Builder.CreateBitCast(AI, CGM.Int8PtrTy), TI};
4217 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
4218}