blob: 2a76203e71c4225cbe5587d72cd127a151935a1f [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
Craig Topper4f12f102014-03-12 06:41:41 +0000208 void emitVTableDefinitions(CodeGenVTables &CGVT,
209 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000210
211 llvm::Value *getVTableAddressPointInStructor(
212 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
213 BaseSubobject Base, const CXXRecordDecl *NearestVBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000214 bool &NeedsVirtualOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000215
216 llvm::Constant *
217 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000218 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000219
220 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000221 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000222
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000223 llvm::Value *getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000224 llvm::Value *This,
225 llvm::Type *Ty) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000226
David Majnemer0c0b6d92014-10-31 20:09:12 +0000227 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF,
228 const CXXDestructorDecl *Dtor,
229 CXXDtorType DtorType,
230 llvm::Value *This,
231 const CXXMemberCallExpr *CE) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000232
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000233 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000234 CallArgList &CallArgs) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000235 assert(GD.getDtorType() == Dtor_Deleting &&
236 "Only deleting destructor thunks are available in this ABI");
237 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)),
David Majnemer9ced3dd2015-03-14 23:44:48 +0000238 getContext().IntTy);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000239 }
240
Craig Topper4f12f102014-03-12 06:41:41 +0000241 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000242
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000243 llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000244 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000245 llvm::GlobalVariable::LinkageTypes Linkage);
246
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000247 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000248 llvm::GlobalVariable *GV) const;
249
Hans Wennborgc94391d2014-06-06 20:04:01 +0000250 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
251 GlobalDecl GD, bool ReturnAdjustment) override {
Hans Wennborg853ae942014-05-30 16:59:42 +0000252 // Never dllimport/dllexport thunks.
253 Thunk->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
Hans Wennborgc94391d2014-06-06 20:04:01 +0000254
255 GVALinkage Linkage =
256 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
257
258 if (Linkage == GVA_Internal)
259 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
260 else if (ReturnAdjustment)
261 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
262 else
263 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000264 }
265
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000266 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, llvm::Value *This,
Craig Topper4f12f102014-03-12 06:41:41 +0000267 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000268
269 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000270 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000271
David Majnemerb3341ea2014-10-05 05:05:40 +0000272 void EmitThreadLocalInitFuncs(
273 CodeGenModule &CGM,
274 ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *>>
275 CXXThreadLocals,
276 ArrayRef<llvm::Function *> CXXThreadLocalInits,
277 ArrayRef<llvm::GlobalVariable *> CXXThreadLocalInitVars) override;
278
279 bool usesThreadWrapperFunction() const override { return false; }
280 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
281 QualType LValType) override;
282
John McCallc84ed6a2012-05-01 06:13:13 +0000283 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
284 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000285 bool PerformInit) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000286 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
287 llvm::Constant *Dtor, llvm::Constant *Addr) override;
John McCallc84ed6a2012-05-01 06:13:13 +0000288
John McCall29036752011-01-27 02:46:02 +0000289 // ==== Notes on array cookies =========
290 //
291 // MSVC seems to only use cookies when the class has a destructor; a
292 // two-argument usual array deallocation function isn't sufficient.
293 //
294 // For example, this code prints "100" and "1":
295 // struct A {
296 // char x;
297 // void *operator new[](size_t sz) {
298 // printf("%u\n", sz);
299 // return malloc(sz);
300 // }
301 // void operator delete[](void *p, size_t sz) {
302 // printf("%u\n", sz);
303 // free(p);
304 // }
305 // };
306 // int main() {
307 // A *p = new A[100];
308 // delete[] p;
309 // }
310 // Whereas it prints "104" and "104" if you give A a destructor.
John McCallb91cd662012-05-01 05:23:51 +0000311
Craig Topper4f12f102014-03-12 06:41:41 +0000312 bool requiresArrayCookie(const CXXDeleteExpr *expr,
313 QualType elementType) override;
314 bool requiresArrayCookie(const CXXNewExpr *expr) override;
315 CharUnits getArrayCookieSizeImpl(QualType type) override;
John McCallb91cd662012-05-01 05:23:51 +0000316 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
317 llvm::Value *NewPtr,
318 llvm::Value *NumElements,
319 const CXXNewExpr *expr,
Craig Topper4f12f102014-03-12 06:41:41 +0000320 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000321 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
322 llvm::Value *allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000323 CharUnits cookieSize) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000324
David Majnemer611cdb92014-07-07 08:09:15 +0000325 friend struct MSRTTIBuilder;
326
327 bool isImageRelative() const {
328 return CGM.getTarget().getPointerWidth(/*AddressSpace=*/0) == 64;
329 }
330
331 // 5 routines for constructing the llvm types for MS RTTI structs.
332 llvm::StructType *getTypeDescriptorType(StringRef TypeInfoString) {
333 llvm::SmallString<32> TDTypeName("rtti.TypeDescriptor");
334 TDTypeName += llvm::utostr(TypeInfoString.size());
335 llvm::StructType *&TypeDescriptorType =
336 TypeDescriptorTypeMap[TypeInfoString.size()];
337 if (TypeDescriptorType)
338 return TypeDescriptorType;
339 llvm::Type *FieldTypes[] = {
340 CGM.Int8PtrPtrTy,
341 CGM.Int8PtrTy,
342 llvm::ArrayType::get(CGM.Int8Ty, TypeInfoString.size() + 1)};
343 TypeDescriptorType =
344 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, TDTypeName);
345 return TypeDescriptorType;
346 }
347
348 llvm::Type *getImageRelativeType(llvm::Type *PtrType) {
349 if (!isImageRelative())
350 return PtrType;
351 return CGM.IntTy;
352 }
353
354 llvm::StructType *getBaseClassDescriptorType() {
355 if (BaseClassDescriptorType)
356 return BaseClassDescriptorType;
357 llvm::Type *FieldTypes[] = {
358 getImageRelativeType(CGM.Int8PtrTy),
359 CGM.IntTy,
360 CGM.IntTy,
361 CGM.IntTy,
362 CGM.IntTy,
363 CGM.IntTy,
364 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
365 };
366 BaseClassDescriptorType = llvm::StructType::create(
367 CGM.getLLVMContext(), FieldTypes, "rtti.BaseClassDescriptor");
368 return BaseClassDescriptorType;
369 }
370
371 llvm::StructType *getClassHierarchyDescriptorType() {
372 if (ClassHierarchyDescriptorType)
373 return ClassHierarchyDescriptorType;
374 // Forward-declare RTTIClassHierarchyDescriptor to break a cycle.
375 ClassHierarchyDescriptorType = llvm::StructType::create(
376 CGM.getLLVMContext(), "rtti.ClassHierarchyDescriptor");
377 llvm::Type *FieldTypes[] = {
378 CGM.IntTy,
379 CGM.IntTy,
380 CGM.IntTy,
381 getImageRelativeType(
382 getBaseClassDescriptorType()->getPointerTo()->getPointerTo()),
383 };
384 ClassHierarchyDescriptorType->setBody(FieldTypes);
385 return ClassHierarchyDescriptorType;
386 }
387
388 llvm::StructType *getCompleteObjectLocatorType() {
389 if (CompleteObjectLocatorType)
390 return CompleteObjectLocatorType;
391 CompleteObjectLocatorType = llvm::StructType::create(
392 CGM.getLLVMContext(), "rtti.CompleteObjectLocator");
393 llvm::Type *FieldTypes[] = {
394 CGM.IntTy,
395 CGM.IntTy,
396 CGM.IntTy,
397 getImageRelativeType(CGM.Int8PtrTy),
398 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
399 getImageRelativeType(CompleteObjectLocatorType),
400 };
401 llvm::ArrayRef<llvm::Type *> FieldTypesRef(FieldTypes);
402 if (!isImageRelative())
403 FieldTypesRef = FieldTypesRef.drop_back();
404 CompleteObjectLocatorType->setBody(FieldTypesRef);
405 return CompleteObjectLocatorType;
406 }
407
408 llvm::GlobalVariable *getImageBase() {
409 StringRef Name = "__ImageBase";
410 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name))
411 return GV;
412
413 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8Ty,
414 /*isConstant=*/true,
415 llvm::GlobalValue::ExternalLinkage,
416 /*Initializer=*/nullptr, Name);
417 }
418
419 llvm::Constant *getImageRelativeConstant(llvm::Constant *PtrVal) {
420 if (!isImageRelative())
421 return PtrVal;
422
David Majnemer7c237072015-03-05 00:46:22 +0000423 if (PtrVal->isNullValue())
424 return llvm::Constant::getNullValue(CGM.IntTy);
425
David Majnemer611cdb92014-07-07 08:09:15 +0000426 llvm::Constant *ImageBaseAsInt =
427 llvm::ConstantExpr::getPtrToInt(getImageBase(), CGM.IntPtrTy);
428 llvm::Constant *PtrValAsInt =
429 llvm::ConstantExpr::getPtrToInt(PtrVal, CGM.IntPtrTy);
430 llvm::Constant *Diff =
431 llvm::ConstantExpr::getSub(PtrValAsInt, ImageBaseAsInt,
432 /*HasNUW=*/true, /*HasNSW=*/true);
433 return llvm::ConstantExpr::getTrunc(Diff, CGM.IntTy);
434 }
435
Reid Kleckner407e8b62013-03-22 19:02:54 +0000436private:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000437 MicrosoftMangleContext &getMangleContext() {
438 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext());
439 }
440
Reid Kleckner2341ae32013-04-11 18:13:19 +0000441 llvm::Constant *getZeroInt() {
442 return llvm::ConstantInt::get(CGM.IntTy, 0);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000443 }
444
Reid Kleckner2341ae32013-04-11 18:13:19 +0000445 llvm::Constant *getAllOnesInt() {
446 return llvm::Constant::getAllOnesValue(CGM.IntTy);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000447 }
448
Reid Kleckner452abac2013-05-09 21:01:17 +0000449 llvm::Constant *getConstantOrZeroInt(llvm::Constant *C) {
450 return C ? C : getZeroInt();
451 }
452
453 llvm::Value *getValueOrZeroInt(llvm::Value *C) {
454 return C ? C : getZeroInt();
455 }
456
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000457 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD);
458
Reid Kleckner2341ae32013-04-11 18:13:19 +0000459 void
460 GetNullMemberPointerFields(const MemberPointerType *MPT,
461 llvm::SmallVectorImpl<llvm::Constant *> &fields);
462
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000463 /// \brief Shared code for virtual base adjustment. Returns the offset from
464 /// the vbptr to the virtual base. Optionally returns the address of the
465 /// vbptr itself.
466 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
467 llvm::Value *Base,
468 llvm::Value *VBPtrOffset,
469 llvm::Value *VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000470 llvm::Value **VBPtr = nullptr);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000471
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000472 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
473 llvm::Value *Base,
474 int32_t VBPtrOffset,
475 int32_t VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000476 llvm::Value **VBPtr = nullptr) {
Reid Kleckner0ba8ba42014-10-22 17:26:00 +0000477 assert(VBTableOffset % 4 == 0 && "should be byte offset into table of i32s");
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000478 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
479 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset);
480 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr);
481 }
482
David Majnemer5bc883f2015-02-27 02:38:02 +0000483 std::pair<llvm::Value *, llvm::Value *>
484 performBaseAdjustment(CodeGenFunction &CGF, llvm::Value *Value,
485 QualType SrcRecordTy);
486
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000487 /// \brief Performs a full virtual base adjustment. Used to dereference
488 /// pointers to members of virtual bases.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000489 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E,
490 const CXXRecordDecl *RD, llvm::Value *Base,
Reid Kleckner2341ae32013-04-11 18:13:19 +0000491 llvm::Value *VirtualBaseAdjustmentOffset,
492 llvm::Value *VBPtrOffset /* optional */);
493
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000494 /// \brief Emits a full member pointer with the fields common to data and
495 /// function member pointers.
496 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField,
497 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +0000498 const CXXRecordDecl *RD,
499 CharUnits NonVirtualBaseAdjustment);
500
501 llvm::Constant *BuildMemberPointer(const CXXRecordDecl *RD,
502 const CXXMethodDecl *MD,
503 CharUnits NonVirtualBaseAdjustment);
504
505 bool MemberPointerConstantIsNull(const MemberPointerType *MPT,
506 llvm::Constant *MP);
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000507
Reid Kleckner7810af02013-06-19 15:20:38 +0000508 /// \brief - Initialize all vbptrs of 'this' with RD as the complete type.
509 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
510
511 /// \brief Caching wrapper around VBTableBuilder::enumerateVBTables().
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000512 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000513
Hans Wennborg88497d62013-11-15 17:24:45 +0000514 /// \brief Generate a thunk for calling a virtual member function MD.
Reid Klecknere4a52202014-02-21 02:27:32 +0000515 llvm::Function *EmitVirtualMemPtrThunk(
516 const CXXMethodDecl *MD,
517 const MicrosoftVTableContext::MethodVFTableLocation &ML);
Hans Wennborg88497d62013-11-15 17:24:45 +0000518
Reid Kleckner407e8b62013-03-22 19:02:54 +0000519public:
Craig Topper4f12f102014-03-12 06:41:41 +0000520 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000521
Craig Topper4f12f102014-03-12 06:41:41 +0000522 bool isZeroInitializable(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000523
David Majnemerb3e56542014-08-07 22:56:13 +0000524 bool isMemberPointerConvertible(const MemberPointerType *MPT) const override {
525 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemer99281062014-09-18 22:05:54 +0000526 return RD->hasAttr<MSInheritanceAttr>();
527 }
528
David Blaikie1cbb9712014-11-14 19:09:44 +0000529 bool isTypeInfoCalculable(QualType Ty) const override {
David Majnemer99281062014-09-18 22:05:54 +0000530 if (!CGCXXABI::isTypeInfoCalculable(Ty))
531 return false;
532 if (const auto *MPT = Ty->getAs<MemberPointerType>()) {
533 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
534 if (!RD->hasAttr<MSInheritanceAttr>())
535 return false;
536 }
537 return true;
David Majnemerb3e56542014-08-07 22:56:13 +0000538 }
539
Craig Topper4f12f102014-03-12 06:41:41 +0000540 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000541
Craig Topper4f12f102014-03-12 06:41:41 +0000542 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
543 CharUnits offset) override;
544 llvm::Constant *EmitMemberPointer(const CXXMethodDecl *MD) override;
545 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000546
Craig Topper4f12f102014-03-12 06:41:41 +0000547 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
548 llvm::Value *L,
549 llvm::Value *R,
550 const MemberPointerType *MPT,
551 bool Inequality) override;
Reid Kleckner700c3ee2013-04-30 20:15:14 +0000552
Craig Topper4f12f102014-03-12 06:41:41 +0000553 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
554 llvm::Value *MemPtr,
555 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000556
Craig Topper4f12f102014-03-12 06:41:41 +0000557 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000558 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
559 llvm::Value *Base, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000560 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000561
Craig Topper4f12f102014-03-12 06:41:41 +0000562 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
563 const CastExpr *E,
564 llvm::Value *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000565
Craig Topper4f12f102014-03-12 06:41:41 +0000566 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
567 llvm::Constant *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000568
Craig Topper4f12f102014-03-12 06:41:41 +0000569 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000570 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E,
571 llvm::Value *&This, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000572 const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000573
Rafael Espindola91f68b42014-09-15 19:20:10 +0000574 void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) override;
575
David Majnemer37b417f2015-03-29 21:55:10 +0000576 llvm::StructType *getCatchHandlerTypeType() {
577 if (!CatchHandlerTypeType) {
David Majnemer5f0dd612015-03-17 20:35:05 +0000578 llvm::Type *FieldTypes[] = {
David Majnemer37b417f2015-03-29 21:55:10 +0000579 CGM.IntTy, // Flags
580 CGM.Int8PtrTy, // TypeDescriptor
David Majnemer5f0dd612015-03-17 20:35:05 +0000581 };
David Majnemer37b417f2015-03-29 21:55:10 +0000582 CatchHandlerTypeType = llvm::StructType::create(
583 CGM.getLLVMContext(), FieldTypes, "eh.CatchHandlerType");
David Majnemer5f0dd612015-03-17 20:35:05 +0000584 }
David Majnemer37b417f2015-03-29 21:55:10 +0000585 return CatchHandlerTypeType;
David Majnemer5f0dd612015-03-17 20:35:05 +0000586 }
587
David Majnemer7c237072015-03-05 00:46:22 +0000588 llvm::StructType *getCatchableTypeType() {
589 if (CatchableTypeType)
590 return CatchableTypeType;
591 llvm::Type *FieldTypes[] = {
592 CGM.IntTy, // Flags
593 getImageRelativeType(CGM.Int8PtrTy), // TypeDescriptor
594 CGM.IntTy, // NonVirtualAdjustment
595 CGM.IntTy, // OffsetToVBPtr
596 CGM.IntTy, // VBTableIndex
597 CGM.IntTy, // Size
598 getImageRelativeType(CGM.Int8PtrTy) // CopyCtor
599 };
600 CatchableTypeType = llvm::StructType::create(
601 CGM.getLLVMContext(), FieldTypes, "eh.CatchableType");
602 return CatchableTypeType;
603 }
604
605 llvm::StructType *getCatchableTypeArrayType(uint32_t NumEntries) {
606 llvm::StructType *&CatchableTypeArrayType =
607 CatchableTypeArrayTypeMap[NumEntries];
608 if (CatchableTypeArrayType)
609 return CatchableTypeArrayType;
610
611 llvm::SmallString<23> CTATypeName("eh.CatchableTypeArray.");
612 CTATypeName += llvm::utostr(NumEntries);
613 llvm::Type *CTType =
614 getImageRelativeType(getCatchableTypeType()->getPointerTo());
615 llvm::Type *FieldTypes[] = {
616 CGM.IntTy, // NumEntries
617 llvm::ArrayType::get(CTType, NumEntries) // CatchableTypes
618 };
619 CatchableTypeArrayType =
620 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, CTATypeName);
621 return CatchableTypeArrayType;
622 }
623
624 llvm::StructType *getThrowInfoType() {
625 if (ThrowInfoType)
626 return ThrowInfoType;
627 llvm::Type *FieldTypes[] = {
628 CGM.IntTy, // Flags
629 getImageRelativeType(CGM.Int8PtrTy), // CleanupFn
630 getImageRelativeType(CGM.Int8PtrTy), // ForwardCompat
631 getImageRelativeType(CGM.Int8PtrTy) // CatchableTypeArray
632 };
633 ThrowInfoType = llvm::StructType::create(CGM.getLLVMContext(), FieldTypes,
634 "eh.ThrowInfo");
635 return ThrowInfoType;
636 }
637
638 llvm::Constant *getThrowFn() {
639 // _CxxThrowException is passed an exception object and a ThrowInfo object
640 // which describes the exception.
641 llvm::Type *Args[] = {CGM.Int8PtrTy, getThrowInfoType()->getPointerTo()};
642 llvm::FunctionType *FTy =
643 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
644 auto *Fn = cast<llvm::Function>(
645 CGM.CreateRuntimeFunction(FTy, "_CxxThrowException"));
646 // _CxxThrowException is stdcall on 32-bit x86 platforms.
647 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::x86)
648 Fn->setCallingConv(llvm::CallingConv::X86_StdCall);
649 return Fn;
650 }
651
David Majnemer37fd66e2015-03-13 22:36:55 +0000652 llvm::Function *getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
653 CXXCtorType CT);
David Majnemerdfa6d202015-03-11 18:36:39 +0000654
David Majnemer7c237072015-03-05 00:46:22 +0000655 llvm::Constant *getCatchableType(QualType T,
656 uint32_t NVOffset = 0,
657 int32_t VBPtrOffset = -1,
658 uint32_t VBIndex = 0);
659
660 llvm::GlobalVariable *getCatchableTypeArray(QualType T);
661
David Majnemerba3e5ec2015-03-13 18:26:17 +0000662 llvm::GlobalVariable *getThrowInfo(QualType T) override;
David Majnemer7c237072015-03-05 00:46:22 +0000663
Reid Kleckner7810af02013-06-19 15:20:38 +0000664private:
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000665 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy;
David Majnemerd905da42014-07-01 20:30:31 +0000666 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy;
667 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000668 /// \brief All the vftables that have been referenced.
669 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000670 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000671
672 /// \brief This set holds the record decls we've deferred vtable emission for.
673 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
674
675
676 /// \brief All the vbtables which have been referenced.
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000677 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap;
Reid Klecknerd8110b62013-09-10 20:14:30 +0000678
679 /// Info on the global variable used to guard initialization of static locals.
680 /// The BitIndex field is only used for externally invisible declarations.
681 struct GuardInfo {
Craig Topper8a13c412014-05-21 05:09:00 +0000682 GuardInfo() : Guard(nullptr), BitIndex(0) {}
Reid Klecknerd8110b62013-09-10 20:14:30 +0000683 llvm::GlobalVariable *Guard;
684 unsigned BitIndex;
685 };
686
687 /// Map from DeclContext to the current guard variable. We assume that the
688 /// AST is visited in source code order.
689 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap;
David Majnemer611cdb92014-07-07 08:09:15 +0000690
691 llvm::DenseMap<size_t, llvm::StructType *> TypeDescriptorTypeMap;
692 llvm::StructType *BaseClassDescriptorType;
693 llvm::StructType *ClassHierarchyDescriptorType;
694 llvm::StructType *CompleteObjectLocatorType;
David Majnemer7c237072015-03-05 00:46:22 +0000695
696 llvm::DenseMap<QualType, llvm::GlobalVariable *> CatchableTypeArrays;
697
698 llvm::StructType *CatchableTypeType;
699 llvm::DenseMap<uint32_t, llvm::StructType *> CatchableTypeArrayTypeMap;
700 llvm::StructType *ThrowInfoType;
David Majnemer37b417f2015-03-29 21:55:10 +0000701 llvm::StructType *CatchHandlerTypeType;
Charles Davis74ce8592010-06-09 23:25:41 +0000702};
703
704}
705
Reid Klecknere39ee212014-05-03 00:33:28 +0000706CGCXXABI::RecordArgABI
707MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const {
708 switch (CGM.getTarget().getTriple().getArch()) {
709 default:
710 // FIXME: Implement for other architectures.
711 return RAA_Default;
712
713 case llvm::Triple::x86:
Reid Klecknercf87e102014-05-14 16:02:09 +0000714 // All record arguments are passed in memory on x86. Decide whether to
715 // construct the object directly in argument memory, or to construct the
716 // argument elsewhere and copy the bytes during the call.
717
718 // If C++ prohibits us from making a copy, construct the arguments directly
719 // into argument memory.
720 if (!canCopyArgument(RD))
Reid Klecknere39ee212014-05-03 00:33:28 +0000721 return RAA_DirectInMemory;
Reid Klecknercf87e102014-05-14 16:02:09 +0000722
723 // Otherwise, construct the argument into a temporary and copy the bytes
724 // into the outgoing argument memory.
Reid Klecknere39ee212014-05-03 00:33:28 +0000725 return RAA_Default;
726
727 case llvm::Triple::x86_64:
728 // Win64 passes objects with non-trivial copy ctors indirectly.
729 if (RD->hasNonTrivialCopyConstructor())
730 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000731
Reid Kleckner80944df2014-10-31 22:00:51 +0000732 // If an object has a destructor, we'd really like to pass it indirectly
733 // because it allows us to elide copies. Unfortunately, MSVC makes that
734 // impossible for small types, which it will pass in a single register or
735 // stack slot. Most objects with dtors are large-ish, so handle that early.
736 // We can't call out all large objects as being indirect because there are
737 // multiple x64 calling conventions and the C++ ABI code shouldn't dictate
738 // how we pass large POD types.
739 if (RD->hasNonTrivialDestructor() &&
740 getContext().getTypeSize(RD->getTypeForDecl()) > 64)
Reid Klecknere39ee212014-05-03 00:33:28 +0000741 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000742
743 // We have a trivial copy constructor or no copy constructors, but we have
744 // to make sure it isn't deleted.
745 bool CopyDeleted = false;
746 for (const CXXConstructorDecl *CD : RD->ctors()) {
747 if (CD->isCopyConstructor()) {
748 assert(CD->isTrivial());
749 // We had at least one undeleted trivial copy ctor. Return directly.
750 if (!CD->isDeleted())
751 return RAA_Default;
752 CopyDeleted = true;
753 }
754 }
755
756 // The trivial copy constructor was deleted. Return indirectly.
757 if (CopyDeleted)
758 return RAA_Indirect;
759
760 // There were no copy ctors. Return in RAX.
Reid Klecknere39ee212014-05-03 00:33:28 +0000761 return RAA_Default;
762 }
763
764 llvm_unreachable("invalid enum");
765}
766
David Majnemer08681372014-11-01 07:37:17 +0000767void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
768 const CXXDeleteExpr *DE,
769 llvm::Value *Ptr,
770 QualType ElementType,
771 const CXXDestructorDecl *Dtor) {
David Majnemer0c0b6d92014-10-31 20:09:12 +0000772 // FIXME: Provide a source location here even though there's no
773 // CXXMemberCallExpr for dtor call.
David Majnemer08681372014-11-01 07:37:17 +0000774 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000775 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
776 llvm::Value *MDThis =
777 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr);
778 if (UseGlobalDelete)
David Majnemer08681372014-11-01 07:37:17 +0000779 CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType);
John McCall82fb8922012-09-25 10:10:39 +0000780}
781
David Majnemer442d0a22014-11-25 07:20:20 +0000782void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
David Majnemer7c237072015-03-05 00:46:22 +0000783 llvm::Value *Args[] = {
784 llvm::ConstantPointerNull::get(CGM.Int8PtrTy),
785 llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())};
786 auto *Fn = getThrowFn();
David Majnemer442d0a22014-11-25 07:20:20 +0000787 if (isNoReturn)
788 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args);
789 else
790 CGF.EmitRuntimeCallOrInvoke(Fn, Args);
791}
792
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000793namespace {
794struct CallEndCatchMSVC : EHScopeStack::Cleanup {
795 CallEndCatchMSVC() {}
796 void Emit(CodeGenFunction &CGF, Flags flags) override {
797 CGF.EmitNounwindRuntimeCall(
798 CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_endcatch));
799 }
800};
801}
802
803void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF,
804 const CXXCatchStmt *S) {
805 // In the MS ABI, the runtime handles the copy, and the catch handler is
806 // responsible for destruction.
807 VarDecl *CatchParam = S->getExceptionDecl();
808 llvm::Value *Exn = CGF.getExceptionFromSlot();
809 llvm::Function *BeginCatch =
810 CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_begincatch);
811
812 if (!CatchParam) {
813 llvm::Value *Args[2] = {Exn, llvm::Constant::getNullValue(CGF.Int8PtrTy)};
814 CGF.EmitNounwindRuntimeCall(BeginCatch, Args);
815 CGF.EHStack.pushCleanup<CallEndCatchMSVC>(NormalAndEHCleanup);
816 return;
817 }
818
819 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
820 llvm::Value *ParamAddr =
821 CGF.Builder.CreateBitCast(var.getObjectAddress(CGF), CGF.Int8PtrTy);
822 llvm::Value *Args[2] = {Exn, ParamAddr};
823 CGF.EmitNounwindRuntimeCall(BeginCatch, Args);
824 // FIXME: Do we really need exceptional endcatch cleanups?
825 CGF.EHStack.pushCleanup<CallEndCatchMSVC>(NormalAndEHCleanup);
826 CGF.EmitAutoVarCleanups(var);
827}
828
David Majnemer5bc883f2015-02-27 02:38:02 +0000829std::pair<llvm::Value *, llvm::Value *>
830MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, llvm::Value *Value,
831 QualType SrcRecordTy) {
David Majnemer1162d252014-06-22 19:05:33 +0000832 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
833 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
David Majnemer9ced3dd2015-03-14 23:44:48 +0000834 const ASTContext &Context = getContext();
David Majnemer1162d252014-06-22 19:05:33 +0000835
David Majnemer5bc883f2015-02-27 02:38:02 +0000836 if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
David Majnemer1162d252014-06-22 19:05:33 +0000837 return std::make_pair(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0));
838
839 // Perform a base adjustment.
David Majnemer5bc883f2015-02-27 02:38:02 +0000840 const CXXBaseSpecifier *PolymorphicBase = std::find_if(
841 SrcDecl->vbases_begin(), SrcDecl->vbases_end(),
842 [&](const CXXBaseSpecifier &Base) {
843 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
844 return Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr();
845 });
846 llvm::Value *Offset = GetVirtualBaseClassOffset(
847 CGF, Value, SrcDecl, PolymorphicBase->getType()->getAsCXXRecordDecl());
David Majnemer1162d252014-06-22 19:05:33 +0000848 Value = CGF.Builder.CreateInBoundsGEP(Value, Offset);
849 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
850 return std::make_pair(Value, Offset);
851}
852
853bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
854 QualType SrcRecordTy) {
855 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
856 return IsDeref &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000857 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000858}
859
860static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF,
861 llvm::Value *Argument) {
862 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
863 llvm::FunctionType *FTy =
864 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
865 llvm::Value *Args[] = {Argument};
866 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
867 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
868}
869
870void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
871 llvm::CallSite Call =
872 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
873 Call.setDoesNotReturn();
874 CGF.Builder.CreateUnreachable();
875}
876
877llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
878 QualType SrcRecordTy,
879 llvm::Value *ThisPtr,
880 llvm::Type *StdTypeInfoPtrTy) {
881 llvm::Value *Offset;
882 std::tie(ThisPtr, Offset) = performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
883 return CGF.Builder.CreateBitCast(
884 emitRTtypeidCall(CGF, ThisPtr).getInstruction(), StdTypeInfoPtrTy);
885}
886
887bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
888 QualType SrcRecordTy) {
889 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
890 return SrcIsPtr &&
David Majnemer9ced3dd2015-03-14 23:44:48 +0000891 !getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
David Majnemer1162d252014-06-22 19:05:33 +0000892}
893
894llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
895 CodeGenFunction &CGF, llvm::Value *Value, QualType SrcRecordTy,
896 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
897 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
898
899 llvm::Value *SrcRTTI =
900 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
901 llvm::Value *DestRTTI =
902 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
903
904 llvm::Value *Offset;
905 std::tie(Value, Offset) = performBaseAdjustment(CGF, Value, SrcRecordTy);
906
907 // PVOID __RTDynamicCast(
908 // PVOID inptr,
909 // LONG VfDelta,
910 // PVOID SrcType,
911 // PVOID TargetType,
912 // BOOL isReference)
913 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
914 CGF.Int8PtrTy, CGF.Int32Ty};
915 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
916 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
917 "__RTDynamicCast");
918 llvm::Value *Args[] = {
919 Value, Offset, SrcRTTI, DestRTTI,
920 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
921 Value = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction();
922 return CGF.Builder.CreateBitCast(Value, DestLTy);
923}
924
925llvm::Value *
926MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, llvm::Value *Value,
927 QualType SrcRecordTy,
928 QualType DestTy) {
929 llvm::Value *Offset;
930 std::tie(Value, Offset) = performBaseAdjustment(CGF, Value, SrcRecordTy);
931
932 // PVOID __RTCastToVoid(
933 // PVOID inptr)
934 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
935 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
936 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
937 "__RTCastToVoid");
938 llvm::Value *Args[] = {Value};
939 return CGF.EmitRuntimeCall(Function, Args);
940}
941
942bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
943 return false;
944}
945
David Majnemerca32f932014-09-01 18:50:02 +0000946llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
947 CodeGenFunction &CGF, llvm::Value *This, const CXXRecordDecl *ClassDecl,
948 const CXXRecordDecl *BaseClassDecl) {
David Majnemer9ced3dd2015-03-14 23:44:48 +0000949 const ASTContext &Context = getContext();
Reid Kleckner5b1b5d52014-01-14 00:50:39 +0000950 int64_t VBPtrChars =
David Majnemer9ced3dd2015-03-14 23:44:48 +0000951 Context.getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000952 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
David Majnemer9ced3dd2015-03-14 23:44:48 +0000953 CharUnits IntSize = Context.getTypeSizeInChars(Context.IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000954 CharUnits VBTableChars =
955 IntSize *
956 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000957 llvm::Value *VBTableOffset =
David Majnemerca32f932014-09-01 18:50:02 +0000958 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000959
960 llvm::Value *VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +0000961 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000962 VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +0000963 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000964 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
965}
966
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000967bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
968 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +0000969}
970
David Majnemer0c0b6d92014-10-31 20:09:12 +0000971static bool isDeletingDtor(GlobalDecl GD) {
972 return isa<CXXDestructorDecl>(GD.getDecl()) &&
973 GD.getDtorType() == Dtor_Deleting;
974}
975
976bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const {
977 return isDeletingDtor(GD);
978}
979
Reid Kleckner40ca9132014-05-13 22:05:45 +0000980bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
981 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
982 if (!RD)
983 return false;
984
985 if (FI.isInstanceMethod()) {
986 // If it's an instance method, aggregates are always returned indirectly via
987 // the second parameter.
988 FI.getReturnInfo() = ABIArgInfo::getIndirect(0, /*ByVal=*/false);
989 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod());
990 return true;
991 } else if (!RD->isPOD()) {
992 // If it's a free function, non-POD types are returned indirectly.
993 FI.getReturnInfo() = ABIArgInfo::getIndirect(0, /*ByVal=*/false);
994 return true;
995 }
996
997 // Otherwise, use the C ABI rules.
998 return false;
999}
1000
Reid Kleckner7810af02013-06-19 15:20:38 +00001001llvm::BasicBlock *
1002MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
1003 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001004 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
1005 assert(IsMostDerivedClass &&
1006 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +00001007 llvm::Value *IsCompleteObject =
1008 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001009
1010 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
1011 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
1012 CGF.Builder.CreateCondBr(IsCompleteObject,
1013 CallVbaseCtorsBB, SkipVbaseCtorsBB);
1014
1015 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +00001016
1017 // Fill in the vbtable pointers here.
1018 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001019
1020 // CGF will put the base ctor calls in this basic block for us later.
1021
1022 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +00001023}
1024
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001025void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
1026 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
1027 // In most cases, an override for a vbase virtual method can adjust
1028 // the "this" parameter by applying a constant offset.
1029 // However, this is not enough while a constructor or a destructor of some
1030 // class X is being executed if all the following conditions are met:
1031 // - X has virtual bases, (1)
1032 // - X overrides a virtual method M of a vbase Y, (2)
1033 // - X itself is a vbase of the most derived class.
1034 //
1035 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
1036 // which holds the extra amount of "this" adjustment we must do when we use
1037 // the X vftables (i.e. during X ctor or dtor).
1038 // Outside the ctors and dtors, the values of vtorDisps are zero.
1039
1040 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
1041 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
1042 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
1043 CGBuilderTy &Builder = CGF.Builder;
1044
1045 unsigned AS =
1046 cast<llvm::PointerType>(getThisValue(CGF)->getType())->getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +00001047 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001048
1049 for (VBOffsets::const_iterator I = VBaseMap.begin(), E = VBaseMap.end();
1050 I != E; ++I) {
1051 if (!I->second.hasVtorDisp())
1052 continue;
1053
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +00001054 llvm::Value *VBaseOffset =
1055 GetVirtualBaseClassOffset(CGF, getThisValue(CGF), RD, I->first);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001056 // FIXME: it doesn't look right that we SExt in GetVirtualBaseClassOffset()
1057 // just to Trunc back immediately.
1058 VBaseOffset = Builder.CreateTruncOrBitCast(VBaseOffset, CGF.Int32Ty);
1059 uint64_t ConstantVBaseOffset =
1060 Layout.getVBaseClassOffset(I->first).getQuantity();
1061
1062 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
1063 llvm::Value *VtorDispValue = Builder.CreateSub(
1064 VBaseOffset, llvm::ConstantInt::get(CGM.Int32Ty, ConstantVBaseOffset),
1065 "vtordisp.value");
1066
1067 if (!Int8This)
1068 Int8This = Builder.CreateBitCast(getThisValue(CGF),
1069 CGF.Int8Ty->getPointerTo(AS));
1070 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
1071 // vtorDisp is always the 32-bits before the vbase in the class layout.
1072 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
1073 VtorDispPtr = Builder.CreateBitCast(
1074 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
1075
1076 Builder.CreateStore(VtorDispValue, VtorDispPtr);
1077 }
1078}
1079
David Majnemer37fd66e2015-03-13 22:36:55 +00001080static bool hasDefaultCXXMethodCC(ASTContext &Context,
1081 const CXXMethodDecl *MD) {
1082 CallingConv ExpectedCallingConv = Context.getDefaultCallingConvention(
1083 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1084 CallingConv ActualCallingConv =
1085 MD->getType()->getAs<FunctionProtoType>()->getCallConv();
1086 return ExpectedCallingConv == ActualCallingConv;
1087}
1088
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001089void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1090 // There's only one constructor type in this ABI.
1091 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
David Majnemer37fd66e2015-03-13 22:36:55 +00001092
1093 // Exported default constructors either have a simple call-site where they use
1094 // the typical calling convention and have a single 'this' pointer for an
1095 // argument -or- they get a wrapper function which appropriately thunks to the
1096 // real default constructor. This thunk is the default constructor closure.
1097 if (D->hasAttr<DLLExportAttr>() && D->isDefaultConstructor())
1098 if (!hasDefaultCXXMethodCC(getContext(), D) || D->getNumParams() != 0) {
1099 llvm::Function *Fn = getAddrOfCXXCtorClosure(D, Ctor_DefaultClosure);
1100 Fn->setLinkage(llvm::GlobalValue::WeakODRLinkage);
1101 Fn->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1102 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001103}
1104
Reid Kleckner7810af02013-06-19 15:20:38 +00001105void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1106 const CXXRecordDecl *RD) {
1107 llvm::Value *ThisInt8Ptr =
1108 CGF.Builder.CreateBitCast(getThisValue(CGF), CGM.Int8PtrTy, "this.int8");
David Majnemer9ced3dd2015-03-14 23:44:48 +00001109 const ASTContext &Context = getContext();
1110 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001111
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001112 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1113 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001114 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001115 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +00001116 const ASTRecordLayout &SubobjectLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001117 Context.getASTRecordLayout(VBT->BaseWithVPtr);
Reid Kleckner5f080942014-01-03 23:42:00 +00001118 CharUnits Offs = VBT->NonVirtualOffset;
1119 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001120 if (VBT->getVBaseWithVPtr())
1121 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
Reid Kleckner7810af02013-06-19 15:20:38 +00001122 llvm::Value *VBPtr =
Reid Kleckner5f080942014-01-03 23:42:00 +00001123 CGF.Builder.CreateConstInBoundsGEP1_64(ThisInt8Ptr, Offs.getQuantity());
David Blaikie1ed728c2015-04-05 22:45:47 +00001124 llvm::Value *GVPtr =
1125 CGF.Builder.CreateConstInBoundsGEP2_32(GV->getValueType(), GV, 0, 0);
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001126 VBPtr = CGF.Builder.CreateBitCast(VBPtr, GVPtr->getType()->getPointerTo(0),
Reid Kleckner5f080942014-01-03 23:42:00 +00001127 "vbptr." + VBT->ReusingBase->getName());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001128 CGF.Builder.CreateStore(GVPtr, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +00001129 }
1130}
1131
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001132void
1133MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001134 SmallVectorImpl<CanQualType> &ArgTys) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001135 // TODO: 'for base' flag
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001136 if (T == StructorType::Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001137 // The scalar deleting destructor takes an implicit int parameter.
David Majnemer9ced3dd2015-03-14 23:44:48 +00001138 ArgTys.push_back(getContext().IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001139 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001140 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
1141 if (!CD)
1142 return;
1143
1144 // All parameters are already in place except is_most_derived, which goes
1145 // after 'this' if it's variadic and last if it's not.
1146
1147 const CXXRecordDecl *Class = CD->getParent();
1148 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1149 if (Class->getNumVBases()) {
1150 if (FPT->isVariadic())
David Majnemer9ced3dd2015-03-14 23:44:48 +00001151 ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001152 else
David Majnemer9ced3dd2015-03-14 23:44:48 +00001153 ArgTys.push_back(getContext().IntTy);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001154 }
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001155}
1156
Reid Klecknere7de47e2013-07-22 13:51:44 +00001157void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1158 // The TU defining a dtor is only guaranteed to emit a base destructor. All
1159 // other destructor variants are delegating thunks.
1160 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1161}
1162
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001163CharUnits
1164MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001165 GD = GD.getCanonicalDecl();
1166 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001167
1168 GlobalDecl LookupGD = GD;
1169 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1170 // Complete destructors take a pointer to the complete object as a
1171 // parameter, thus don't need this adjustment.
1172 if (GD.getDtorType() == Dtor_Complete)
1173 return CharUnits();
1174
1175 // There's no Dtor_Base in vftable but it shares the this adjustment with
1176 // the deleting one, so look it up instead.
1177 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1178 }
1179
1180 MicrosoftVTableContext::MethodVFTableLocation ML =
1181 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
1182 CharUnits Adjustment = ML.VFPtrOffset;
1183
1184 // Normal virtual instance methods need to adjust from the vfptr that first
1185 // defined the virtual method to the virtual base subobject, but destructors
1186 // do not. The vector deleting destructor thunk applies this adjustment for
1187 // us if necessary.
1188 if (isa<CXXDestructorDecl>(MD))
1189 Adjustment = CharUnits::Zero();
1190
1191 if (ML.VBase) {
1192 const ASTRecordLayout &DerivedLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001193 getContext().getASTRecordLayout(MD->getParent());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001194 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1195 }
1196
1197 return Adjustment;
1198}
1199
1200llvm::Value *MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1201 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This, bool VirtualCall) {
1202 if (!VirtualCall) {
1203 // If the call of a virtual function is not virtual, we just have to
1204 // compensate for the adjustment the virtual function does in its prologue.
1205 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1206 if (Adjustment.isZero())
1207 return This;
1208
1209 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1210 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS);
1211 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1212 assert(Adjustment.isPositive());
1213 return CGF.Builder.CreateConstGEP1_32(This, Adjustment.getQuantity());
1214 }
1215
1216 GD = GD.getCanonicalDecl();
1217 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001218
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001219 GlobalDecl LookupGD = GD;
1220 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1221 // Complete dtors take a pointer to the complete object,
1222 // thus don't need adjustment.
1223 if (GD.getDtorType() == Dtor_Complete)
1224 return This;
1225
1226 // There's only Dtor_Deleting in vftable but it shares the this adjustment
1227 // with the base one, so look up the deleting one instead.
1228 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1229 }
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001230 MicrosoftVTableContext::MethodVFTableLocation ML =
1231 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001232
1233 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1234 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS);
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001235 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001236
1237 // Base destructors expect 'this' to point to the beginning of the base
1238 // subobject, not the first vfptr that happens to contain the virtual dtor.
1239 // However, we still need to apply the virtual base adjustment.
1240 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1241 StaticOffset = CharUnits::Zero();
1242
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001243 if (ML.VBase) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001244 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1245 llvm::Value *VBaseOffset =
1246 GetVirtualBaseClassOffset(CGF, This, MD->getParent(), ML.VBase);
1247 This = CGF.Builder.CreateInBoundsGEP(This, VBaseOffset);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001248 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001249 if (!StaticOffset.isZero()) {
1250 assert(StaticOffset.isPositive());
1251 This = CGF.Builder.CreateBitCast(This, charPtrTy);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001252 if (ML.VBase) {
1253 // Non-virtual adjustment might result in a pointer outside the allocated
1254 // object, e.g. if the final overrider class is laid out after the virtual
1255 // base that declares a method in the most derived class.
1256 // FIXME: Update the code that emits this adjustment in thunks prologues.
1257 This = CGF.Builder.CreateConstGEP1_32(This, StaticOffset.getQuantity());
1258 } else {
David Blaikiefb901c7a2015-04-04 15:12:29 +00001259 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001260 StaticOffset.getQuantity());
1261 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001262 }
1263 return This;
1264}
1265
Reid Kleckner89077a12013-12-17 19:46:40 +00001266void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1267 QualType &ResTy,
1268 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001269 ASTContext &Context = getContext();
1270 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001271 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001272 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1273 ImplicitParamDecl *IsMostDerived
Craig Topper8a13c412014-05-21 05:09:00 +00001274 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001275 CGF.CurGD.getDecl()->getLocation(),
1276 &Context.Idents.get("is_most_derived"),
1277 Context.IntTy);
Reid Kleckner89077a12013-12-17 19:46:40 +00001278 // The 'most_derived' parameter goes second if the ctor is variadic and last
1279 // if it's not. Dtors can't be variadic.
1280 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1281 if (FPT->isVariadic())
1282 Params.insert(Params.begin() + 1, IsMostDerived);
1283 else
1284 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001285 getStructorImplicitParamDecl(CGF) = IsMostDerived;
David Majnemer0c0b6d92014-10-31 20:09:12 +00001286 } else if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001287 ImplicitParamDecl *ShouldDelete
Craig Topper8a13c412014-05-21 05:09:00 +00001288 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001289 CGF.CurGD.getDecl()->getLocation(),
1290 &Context.Idents.get("should_call_delete"),
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001291 Context.IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001292 Params.push_back(ShouldDelete);
1293 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1294 }
John McCall0f999f32012-09-25 08:00:39 +00001295}
1296
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001297llvm::Value *MicrosoftCXXABI::adjustThisParameterInVirtualFunctionPrologue(
1298 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001299 // In this ABI, every virtual function takes a pointer to one of the
1300 // subobjects that first defines it as the 'this' parameter, rather than a
Alp Tokerf6a24ce2013-12-05 16:25:25 +00001301 // pointer to the final overrider subobject. Thus, we need to adjust it back
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001302 // to the final overrider subobject before use.
1303 // See comments in the MicrosoftVFTableContext implementation for the details.
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001304 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001305 if (Adjustment.isZero())
1306 return This;
1307
1308 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1309 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1310 *thisTy = This->getType();
1311
1312 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1313 assert(Adjustment.isPositive());
David Blaikiefb901c7a2015-04-04 15:12:29 +00001314 This = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, This,
1315 -Adjustment.getQuantity());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001316 return CGF.Builder.CreateBitCast(This, thisTy);
1317}
1318
John McCall0f999f32012-09-25 08:00:39 +00001319void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
1320 EmitThisParam(CGF);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001321
1322 /// If this is a function that the ABI specifies returns 'this', initialize
1323 /// the return slot to 'this' at the start of the function.
1324 ///
1325 /// Unlike the setting of return types, this is done within the ABI
1326 /// implementation instead of by clients of CGCXXABI because:
1327 /// 1) getThisValue is currently protected
1328 /// 2) in theory, an ABI could implement 'this' returns some other way;
1329 /// HasThisReturn only specifies a contract, not the implementation
1330 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001331 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001332 else if (hasMostDerivedReturn(CGF.CurGD))
1333 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1334 CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001335
1336 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1337 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1338 assert(getStructorImplicitParamDecl(CGF) &&
1339 "no implicit parameter for a constructor with virtual bases?");
1340 getStructorImplicitParamValue(CGF)
1341 = CGF.Builder.CreateLoad(
1342 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1343 "is_most_derived");
1344 }
1345
David Majnemer0c0b6d92014-10-31 20:09:12 +00001346 if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001347 assert(getStructorImplicitParamDecl(CGF) &&
1348 "no implicit parameter for a deleting destructor?");
1349 getStructorImplicitParamValue(CGF)
1350 = CGF.Builder.CreateLoad(
1351 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1352 "should_call_delete");
1353 }
John McCall0f999f32012-09-25 08:00:39 +00001354}
1355
Reid Kleckner89077a12013-12-17 19:46:40 +00001356unsigned MicrosoftCXXABI::addImplicitConstructorArgs(
1357 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1358 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001359 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001360
Reid Kleckner89077a12013-12-17 19:46:40 +00001361 // Check if we need a 'most_derived' parameter.
1362 if (!D->getParent()->getNumVBases())
1363 return 0;
1364
1365 // Add the 'most_derived' argument second if we are variadic or last if not.
1366 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
1367 llvm::Value *MostDerivedArg =
1368 llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
1369 RValue RV = RValue::get(MostDerivedArg);
1370 if (MostDerivedArg) {
1371 if (FPT->isVariadic())
1372 Args.insert(Args.begin() + 1,
1373 CallArg(RV, getContext().IntTy, /*needscopy=*/false));
1374 else
1375 Args.add(RV, getContext().IntTy);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001376 }
1377
Reid Kleckner89077a12013-12-17 19:46:40 +00001378 return 1; // Added one arg.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001379}
1380
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001381void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1382 const CXXDestructorDecl *DD,
1383 CXXDtorType Type, bool ForVirtualBase,
1384 bool Delegating, llvm::Value *This) {
Rafael Espindola1ac0ec82014-09-11 15:42:06 +00001385 llvm::Value *Callee = CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type));
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001386
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001387 if (DD->isVirtual()) {
1388 assert(Type != CXXDtorType::Dtor_Deleting &&
1389 "The deleting destructor should only be called via a virtual call");
1390 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1391 This, false);
1392 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001393
David Majnemer0c0b6d92014-10-31 20:09:12 +00001394 CGF.EmitCXXStructorCall(DD, Callee, ReturnValueSlot(), This,
1395 /*ImplicitParam=*/nullptr,
1396 /*ImplicitParamTy=*/QualType(), nullptr,
1397 getFromDtorType(Type));
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001398}
1399
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001400void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1401 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001402 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001403 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001404
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001405 for (VPtrInfo *Info : VFPtrs) {
1406 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001407 if (VTable->hasInitializer())
1408 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001409
David Majnemer65f87322014-07-24 06:09:19 +00001410 llvm::Constant *RTTI = getContext().getLangOpts().RTTIData
1411 ? getMSCompleteObjectLocator(RD, Info)
1412 : nullptr;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001413
1414 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001415 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001416 llvm::Constant *Init = CGVT.CreateVTableInitializer(
1417 RD, VTLayout.vtable_component_begin(),
1418 VTLayout.getNumVTableComponents(), VTLayout.vtable_thunk_begin(),
David Majnemerd905da42014-07-01 20:30:31 +00001419 VTLayout.getNumVTableThunks(), RTTI);
1420
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001421 VTable->setInitializer(Init);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001422 }
1423}
1424
1425llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1426 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
1427 const CXXRecordDecl *NearestVBase, bool &NeedsVirtualOffset) {
Craig Topper8a13c412014-05-21 05:09:00 +00001428 NeedsVirtualOffset = (NearestVBase != nullptr);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001429
David Majnemerd905da42014-07-01 20:30:31 +00001430 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1431 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1432 llvm::GlobalValue *VTableAddressPoint = VFTablesMap[ID];
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001433 if (!VTableAddressPoint) {
1434 assert(Base.getBase()->getNumVBases() &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001435 !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001436 }
1437 return VTableAddressPoint;
1438}
1439
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001440static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001441 const CXXRecordDecl *RD, const VPtrInfo *VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001442 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001443 llvm::raw_svector_ostream Out(Name);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001444 MangleContext.mangleCXXVFTable(RD, VFPtr->MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001445}
1446
1447llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1448 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
David Majnemerd905da42014-07-01 20:30:31 +00001449 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1450 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1451 llvm::GlobalValue *VFTable = VFTablesMap[ID];
1452 assert(VFTable && "Couldn't find a vftable for the given base?");
1453 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001454}
1455
1456llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1457 CharUnits VPtrOffset) {
1458 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1459 // shouldn't be used in the given record type. We want to cache this result in
1460 // VFTablesMap, thus a simple zero check is not sufficient.
1461 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001462 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001463 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001464 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001465 if (!Inserted)
1466 return I->second;
1467
1468 llvm::GlobalVariable *&VTable = I->second;
1469
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001470 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001471 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001472
David Blaikie82e95a32014-11-19 07:49:47 +00001473 if (DeferredVFTables.insert(RD).second) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001474 // We haven't processed this record type before.
1475 // Queue up this v-table for possible deferred emission.
1476 CGM.addDeferredVTable(RD);
1477
1478#ifndef NDEBUG
1479 // Create all the vftables at once in order to make sure each vftable has
1480 // a unique mangled name.
1481 llvm::StringSet<> ObservedMangledNames;
1482 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1483 SmallString<256> Name;
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001484 mangleVFTableName(getMangleContext(), RD, VFPtrs[J], Name);
David Blaikie61b86d42014-11-19 02:56:13 +00001485 if (!ObservedMangledNames.insert(Name.str()).second)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001486 llvm_unreachable("Already saw this mangling before?");
1487 }
1488#endif
1489 }
1490
David Majnemera03849b2015-03-18 22:04:43 +00001491 VPtrInfo *const *VFPtrI =
1492 std::find_if(VFPtrs.begin(), VFPtrs.end(), [&](VPtrInfo *VPI) {
1493 return VPI->FullOffsetInMDC == VPtrOffset;
1494 });
1495 if (VFPtrI == VFPtrs.end()) {
1496 VFTablesMap[ID] = nullptr;
1497 return nullptr;
1498 }
1499 VPtrInfo *VFPtr = *VFPtrI;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001500
David Majnemera03849b2015-03-18 22:04:43 +00001501 SmallString<256> VFTableName;
1502 mangleVFTableName(getMangleContext(), RD, VFPtr, VFTableName);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001503
David Majnemera03849b2015-03-18 22:04:43 +00001504 llvm::GlobalValue::LinkageTypes VFTableLinkage = CGM.getVTableLinkage(RD);
1505 bool VFTableComesFromAnotherTU =
1506 llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage) ||
1507 llvm::GlobalValue::isExternalLinkage(VFTableLinkage);
1508 bool VTableAliasIsRequred =
1509 !VFTableComesFromAnotherTU && getContext().getLangOpts().RTTIData;
David Majnemerbb848712014-07-01 22:37:08 +00001510
David Majnemera03849b2015-03-18 22:04:43 +00001511 if (llvm::GlobalValue *VFTable =
1512 CGM.getModule().getNamedGlobal(VFTableName)) {
1513 VFTablesMap[ID] = VFTable;
1514 return VTableAliasIsRequred
1515 ? cast<llvm::GlobalVariable>(
1516 cast<llvm::GlobalAlias>(VFTable)->getBaseObject())
1517 : cast<llvm::GlobalVariable>(VFTable);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001518 }
1519
David Majnemera03849b2015-03-18 22:04:43 +00001520 uint64_t NumVTableSlots =
1521 VTContext.getVFTableLayout(RD, VFPtr->FullOffsetInMDC)
1522 .getNumVTableComponents();
1523 llvm::GlobalValue::LinkageTypes VTableLinkage =
1524 VTableAliasIsRequred ? llvm::GlobalValue::PrivateLinkage : VFTableLinkage;
1525
1526 StringRef VTableName = VTableAliasIsRequred ? StringRef() : VFTableName.str();
1527
1528 llvm::ArrayType *VTableType =
1529 llvm::ArrayType::get(CGM.Int8PtrTy, NumVTableSlots);
1530
1531 // Create a backing variable for the contents of VTable. The VTable may
1532 // or may not include space for a pointer to RTTI data.
1533 llvm::GlobalValue *VFTable;
1534 VTable = new llvm::GlobalVariable(CGM.getModule(), VTableType,
1535 /*isConstant=*/true, VTableLinkage,
1536 /*Initializer=*/nullptr, VTableName);
1537 VTable->setUnnamedAddr(true);
1538
1539 llvm::Comdat *C = nullptr;
1540 if (!VFTableComesFromAnotherTU &&
1541 (llvm::GlobalValue::isWeakForLinker(VFTableLinkage) ||
1542 (llvm::GlobalValue::isLocalLinkage(VFTableLinkage) &&
1543 VTableAliasIsRequred)))
1544 C = CGM.getModule().getOrInsertComdat(VFTableName.str());
1545
1546 // Only insert a pointer into the VFTable for RTTI data if we are not
1547 // importing it. We never reference the RTTI data directly so there is no
1548 // need to make room for it.
1549 if (VTableAliasIsRequred) {
1550 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
1551 llvm::ConstantInt::get(CGM.IntTy, 1)};
1552 // Create a GEP which points just after the first entry in the VFTable,
1553 // this should be the location of the first virtual method.
David Blaikiee3b172a2015-04-02 18:55:21 +00001554 llvm::Constant *VTableGEP = llvm::ConstantExpr::getInBoundsGetElementPtr(
1555 VTable->getValueType(), VTable, GEPIndices);
David Majnemera03849b2015-03-18 22:04:43 +00001556 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage)) {
1557 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1558 if (C)
1559 C->setSelectionKind(llvm::Comdat::Largest);
1560 }
1561 VFTable = llvm::GlobalAlias::create(
1562 cast<llvm::SequentialType>(VTableGEP->getType())->getElementType(),
1563 /*AddressSpace=*/0, VFTableLinkage, VFTableName.str(), VTableGEP,
1564 &CGM.getModule());
1565 VFTable->setUnnamedAddr(true);
1566 } else {
1567 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1568 // be referencing any RTTI data.
1569 // The GlobalVariable will end up being an appropriate definition of the
1570 // VFTable.
1571 VFTable = VTable;
1572 }
1573 if (C)
1574 VTable->setComdat(C);
1575
1576 if (RD->hasAttr<DLLImportAttr>())
1577 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1578 else if (RD->hasAttr<DLLExportAttr>())
1579 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1580
1581 VFTablesMap[ID] = VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001582 return VTable;
1583}
1584
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001585llvm::Value *MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1586 GlobalDecl GD,
1587 llvm::Value *This,
1588 llvm::Type *Ty) {
1589 GD = GD.getCanonicalDecl();
1590 CGBuilderTy &Builder = CGF.Builder;
1591
1592 Ty = Ty->getPointerTo()->getPointerTo();
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001593 llvm::Value *VPtr =
1594 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001595 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty);
1596
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001597 MicrosoftVTableContext::MethodVFTableLocation ML =
1598 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001599 llvm::Value *VFuncPtr =
1600 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1601 return Builder.CreateLoad(VFuncPtr);
1602}
1603
David Majnemer0c0b6d92014-10-31 20:09:12 +00001604llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1605 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
1606 llvm::Value *This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001607 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001608 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1609
1610 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001611 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001612 GlobalDecl GD(Dtor, Dtor_Deleting);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001613 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1614 Dtor, StructorType::Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001615 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001616 llvm::Value *Callee = getVirtualFunctionPointer(CGF, GD, This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001617
David Majnemer9ced3dd2015-03-14 23:44:48 +00001618 ASTContext &Context = getContext();
Nico Weber0a029922015-01-12 21:24:10 +00001619 llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1620 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1621 DtorType == Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001622
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001623 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001624 RValue RV = CGF.EmitCXXStructorCall(Dtor, Callee, ReturnValueSlot(), This,
1625 ImplicitParam, Context.IntTy, CE,
1626 StructorType::Deleting);
1627 return RV.getScalarVal();
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001628}
1629
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001630const VBTableGlobals &
1631MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001632 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001633 // easier than caching each vbtable individually.
1634 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1635 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001636 std::tie(Entry, Added) =
1637 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001638 VBTableGlobals &VBGlobals = Entry->second;
1639 if (!Added)
1640 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001641
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001642 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1643 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001644
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001645 // Cache the globals for all vbtables so we don't have to recompute the
1646 // mangled names.
1647 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001648 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1649 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001650 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001651 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001652 }
1653
1654 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001655}
1656
Reid Klecknere4a52202014-02-21 02:27:32 +00001657llvm::Function *MicrosoftCXXABI::EmitVirtualMemPtrThunk(
1658 const CXXMethodDecl *MD,
1659 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001660 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1661 "can't form pointers to ctors or virtual dtors");
1662
Reid Klecknere4a52202014-02-21 02:27:32 +00001663 // Calculate the mangled name.
1664 SmallString<256> ThunkName;
1665 llvm::raw_svector_ostream Out(ThunkName);
1666 getMangleContext().mangleVirtualMemPtrThunk(MD, Out);
1667 Out.flush();
1668
Hans Wennborg88497d62013-11-15 17:24:45 +00001669 // If the thunk has been generated previously, just return it.
1670 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1671 return cast<llvm::Function>(GV);
1672
1673 // Create the llvm::Function.
Reid Klecknerc3473512014-08-29 21:43:29 +00001674 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSMemberPointerThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00001675 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1676 llvm::Function *ThunkFn =
1677 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1678 ThunkName.str(), &CGM.getModule());
1679 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1680
Hans Wennborg88497d62013-11-15 17:24:45 +00001681 ThunkFn->setLinkage(MD->isExternallyVisible()
1682 ? llvm::GlobalValue::LinkOnceODRLinkage
1683 : llvm::GlobalValue::InternalLinkage);
David Majnemer8c9cdb62015-01-21 01:21:31 +00001684 if (MD->isExternallyVisible())
1685 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
Hans Wennborg88497d62013-11-15 17:24:45 +00001686
1687 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1688 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1689
Reid Kleckner9da94482015-01-21 22:18:17 +00001690 // Add the "thunk" attribute so that LLVM knows that the return type is
1691 // meaningless. These thunks can be used to call functions with differing
1692 // return types, and the caller is required to cast the prototype
1693 // appropriately to extract the correct value.
1694 ThunkFn->addFnAttr("thunk");
1695
Reid Klecknerb9538a62014-08-15 18:12:40 +00001696 // These thunks can be compared, so they are not unnamed.
1697 ThunkFn->setUnnamedAddr(false);
1698
Hans Wennborg88497d62013-11-15 17:24:45 +00001699 // Start codegen.
1700 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00001701 CGF.CurGD = GlobalDecl(MD);
1702 CGF.CurFuncIsThunk = true;
1703
1704 // Build FunctionArgs, but only include the implicit 'this' parameter
1705 // declaration.
1706 FunctionArgList FunctionArgs;
1707 buildThisParam(CGF, FunctionArgs);
1708
1709 // Start defining the function.
1710 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
1711 FunctionArgs, MD->getLocation(), SourceLocation());
1712 EmitThisParam(CGF);
Hans Wennborg88497d62013-11-15 17:24:45 +00001713
Reid Klecknere4a52202014-02-21 02:27:32 +00001714 // Load the vfptr and then callee from the vftable. The callee should have
1715 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00001716 llvm::Value *VTable = CGF.GetVTablePtr(
1717 getThisValue(CGF), ThunkTy->getPointerTo()->getPointerTo());
Reid Klecknere4a52202014-02-21 02:27:32 +00001718 llvm::Value *VFuncPtr =
1719 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1720 llvm::Value *Callee = CGF.Builder.CreateLoad(VFuncPtr);
Hans Wennborg88497d62013-11-15 17:24:45 +00001721
Reid Klecknerc3473512014-08-29 21:43:29 +00001722 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee);
Hans Wennborg88497d62013-11-15 17:24:45 +00001723
1724 return ThunkFn;
1725}
1726
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001727void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001728 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1729 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001730 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001731 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
David Majnemer129f4172015-02-02 10:22:20 +00001732 if (GV->isDeclaration())
1733 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00001734 }
1735}
1736
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001737llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001738MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001739 llvm::GlobalVariable::LinkageTypes Linkage) {
1740 SmallString<256> OutName;
1741 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00001742 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001743 Out.flush();
1744 StringRef Name = OutName.str();
1745
1746 llvm::ArrayType *VBTableType =
1747 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ReusingBase->getNumVBases());
1748
1749 assert(!CGM.getModule().getNamedGlobal(Name) &&
1750 "vbtable with this name already exists: mangling bug?");
1751 llvm::GlobalVariable *GV =
1752 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
1753 GV->setUnnamedAddr(true);
Hans Wennborg853ae942014-05-30 16:59:42 +00001754
1755 if (RD->hasAttr<DLLImportAttr>())
1756 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1757 else if (RD->hasAttr<DLLExportAttr>())
1758 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1759
David Majnemer129f4172015-02-02 10:22:20 +00001760 if (!GV->hasExternalLinkage())
1761 emitVBTableDefinition(VBT, RD, GV);
1762
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001763 return GV;
1764}
1765
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001766void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001767 const CXXRecordDecl *RD,
1768 llvm::GlobalVariable *GV) const {
1769 const CXXRecordDecl *ReusingBase = VBT.ReusingBase;
1770
1771 assert(RD->getNumVBases() && ReusingBase->getNumVBases() &&
1772 "should only emit vbtables for classes with vbtables");
1773
1774 const ASTRecordLayout &BaseLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001775 getContext().getASTRecordLayout(VBT.BaseWithVPtr);
1776 const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001777
Craig Topper8a13c412014-05-21 05:09:00 +00001778 SmallVector<llvm::Constant *, 4> Offsets(1 + ReusingBase->getNumVBases(),
1779 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001780
1781 // The offset from ReusingBase's vbptr to itself always leads.
1782 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
1783 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
1784
1785 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Aaron Ballman445a9392014-03-13 16:15:17 +00001786 for (const auto &I : ReusingBase->vbases()) {
1787 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001788 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
1789 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00001790
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001791 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00001792 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001793 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00001794 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001795 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00001796 Offset -= CompleteVBPtrOffset;
1797
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001798 unsigned VBIndex = Context.getVBTableIndex(ReusingBase, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00001799 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001800 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
1801 }
1802
1803 assert(Offsets.size() ==
1804 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
1805 ->getElementType())->getNumElements());
1806 llvm::ArrayType *VBTableType =
1807 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
1808 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
1809 GV->setInitializer(Init);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001810}
1811
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001812llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
1813 llvm::Value *This,
1814 const ThisAdjustment &TA) {
1815 if (TA.isEmpty())
1816 return This;
1817
1818 llvm::Value *V = CGF.Builder.CreateBitCast(This, CGF.Int8PtrTy);
1819
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00001820 if (!TA.Virtual.isEmpty()) {
1821 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
1822 // Adjust the this argument based on the vtordisp value.
1823 llvm::Value *VtorDispPtr =
1824 CGF.Builder.CreateConstGEP1_32(V, TA.Virtual.Microsoft.VtordispOffset);
1825 VtorDispPtr =
1826 CGF.Builder.CreateBitCast(VtorDispPtr, CGF.Int32Ty->getPointerTo());
1827 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
1828 V = CGF.Builder.CreateGEP(V, CGF.Builder.CreateNeg(VtorDisp));
1829
1830 if (TA.Virtual.Microsoft.VBPtrOffset) {
1831 // If the final overrider is defined in a virtual base other than the one
1832 // that holds the vfptr, we have to use a vtordispex thunk which looks up
1833 // the vbtable of the derived class.
1834 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
1835 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
1836 llvm::Value *VBPtr;
1837 llvm::Value *VBaseOffset =
1838 GetVBaseOffsetFromVBPtr(CGF, V, -TA.Virtual.Microsoft.VBPtrOffset,
1839 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
1840 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
1841 }
1842 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001843
1844 if (TA.NonVirtual) {
1845 // Non-virtual adjustment might result in a pointer outside the allocated
1846 // object, e.g. if the final overrider class is laid out after the virtual
1847 // base that declares a method in the most derived class.
1848 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
1849 }
1850
1851 // Don't need to bitcast back, the call CodeGen will handle this.
1852 return V;
1853}
1854
1855llvm::Value *
1856MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
1857 const ReturnAdjustment &RA) {
1858 if (RA.isEmpty())
1859 return Ret;
1860
1861 llvm::Value *V = CGF.Builder.CreateBitCast(Ret, CGF.Int8PtrTy);
1862
1863 if (RA.Virtual.Microsoft.VBIndex) {
1864 assert(RA.Virtual.Microsoft.VBIndex > 0);
David Majnemer9ced3dd2015-03-14 23:44:48 +00001865 const ASTContext &Context = getContext();
1866 int32_t IntSize = Context.getTypeSizeInChars(Context.IntTy).getQuantity();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001867 llvm::Value *VBPtr;
1868 llvm::Value *VBaseOffset =
1869 GetVBaseOffsetFromVBPtr(CGF, V, RA.Virtual.Microsoft.VBPtrOffset,
1870 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
1871 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
1872 }
1873
1874 if (RA.NonVirtual)
David Blaikiefb901c7a2015-04-04 15:12:29 +00001875 V = CGF.Builder.CreateConstInBoundsGEP1_32(CGF.Int8Ty, V, RA.NonVirtual);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001876
1877 // Cast back to the original type.
1878 return CGF.Builder.CreateBitCast(V, Ret->getType());
1879}
1880
John McCallb91cd662012-05-01 05:23:51 +00001881bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
1882 QualType elementType) {
1883 // Microsoft seems to completely ignore the possibility of a
1884 // two-argument usual deallocation function.
1885 return elementType.isDestructedType();
1886}
1887
1888bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
1889 // Microsoft seems to completely ignore the possibility of a
1890 // two-argument usual deallocation function.
1891 return expr->getAllocatedType().isDestructedType();
1892}
1893
1894CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
1895 // The array cookie is always a size_t; we then pad that out to the
1896 // alignment of the element type.
1897 ASTContext &Ctx = getContext();
1898 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
1899 Ctx.getTypeAlignInChars(type));
1900}
1901
1902llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
1903 llvm::Value *allocPtr,
1904 CharUnits cookieSize) {
Micah Villmowea2fea22012-10-25 15:39:14 +00001905 unsigned AS = allocPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001906 llvm::Value *numElementsPtr =
1907 CGF.Builder.CreateBitCast(allocPtr, CGF.SizeTy->getPointerTo(AS));
1908 return CGF.Builder.CreateLoad(numElementsPtr);
1909}
1910
1911llvm::Value* MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
1912 llvm::Value *newPtr,
1913 llvm::Value *numElements,
1914 const CXXNewExpr *expr,
1915 QualType elementType) {
1916 assert(requiresArrayCookie(expr));
1917
1918 // The size of the cookie.
1919 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
1920
1921 // Compute an offset to the cookie.
1922 llvm::Value *cookiePtr = newPtr;
1923
1924 // Write the number of elements into the appropriate slot.
Micah Villmowea2fea22012-10-25 15:39:14 +00001925 unsigned AS = newPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001926 llvm::Value *numElementsPtr
1927 = CGF.Builder.CreateBitCast(cookiePtr, CGF.SizeTy->getPointerTo(AS));
1928 CGF.Builder.CreateStore(numElements, numElementsPtr);
1929
1930 // Finally, compute a pointer to the actual data buffer by skipping
1931 // over the cookie completely.
1932 return CGF.Builder.CreateConstInBoundsGEP1_64(newPtr,
1933 cookieSize.getQuantity());
1934}
1935
David Majnemerb3341ea2014-10-05 05:05:40 +00001936static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
1937 llvm::Constant *Dtor,
1938 llvm::Constant *Addr) {
1939 // Create a function which calls the destructor.
1940 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
1941
1942 // extern "C" int __tlregdtor(void (*f)(void));
1943 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
1944 CGF.IntTy, DtorStub->getType(), /*IsVarArg=*/false);
1945
1946 llvm::Constant *TLRegDtor =
1947 CGF.CGM.CreateRuntimeFunction(TLRegDtorTy, "__tlregdtor");
1948 if (llvm::Function *TLRegDtorFn = dyn_cast<llvm::Function>(TLRegDtor))
1949 TLRegDtorFn->setDoesNotThrow();
1950
1951 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
1952}
1953
1954void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
1955 llvm::Constant *Dtor,
1956 llvm::Constant *Addr) {
1957 if (D.getTLSKind())
1958 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
1959
1960 // The default behavior is to use atexit.
1961 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
1962}
1963
1964void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
1965 CodeGenModule &CGM,
1966 ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *>>
1967 CXXThreadLocals,
1968 ArrayRef<llvm::Function *> CXXThreadLocalInits,
1969 ArrayRef<llvm::GlobalVariable *> CXXThreadLocalInitVars) {
1970 // This will create a GV in the .CRT$XDU section. It will point to our
1971 // initialization function. The CRT will call all of these function
1972 // pointers at start-up time and, eventually, at thread-creation time.
1973 auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
1974 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
1975 CGM.getModule(), InitFunc->getType(), /*IsConstant=*/true,
1976 llvm::GlobalVariable::InternalLinkage, InitFunc,
1977 Twine(InitFunc->getName(), "$initializer$"));
1978 InitFuncPtr->setSection(".CRT$XDU");
1979 // This variable has discardable linkage, we have to add it to @llvm.used to
1980 // ensure it won't get discarded.
1981 CGM.addUsedGlobal(InitFuncPtr);
1982 return InitFuncPtr;
1983 };
1984
1985 std::vector<llvm::Function *> NonComdatInits;
1986 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
1987 llvm::GlobalVariable *GV = CXXThreadLocalInitVars[I];
1988 llvm::Function *F = CXXThreadLocalInits[I];
1989
1990 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00001991 if (llvm::Comdat *C = GV->getComdat())
David Majnemerb3341ea2014-10-05 05:05:40 +00001992 AddToXDU(F)->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00001993 else
David Majnemerb3341ea2014-10-05 05:05:40 +00001994 NonComdatInits.push_back(F);
David Majnemerb3341ea2014-10-05 05:05:40 +00001995 }
1996
1997 if (!NonComdatInits.empty()) {
1998 llvm::FunctionType *FTy =
1999 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002000 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction(
2001 FTy, "__tls_init", SourceLocation(),
2002 /*TLS=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002003 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2004
2005 AddToXDU(InitFunc);
2006 }
2007}
2008
2009LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2010 const VarDecl *VD,
2011 QualType LValType) {
2012 CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2013 return LValue();
2014}
2015
John McCallc84ed6a2012-05-01 06:13:13 +00002016void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00002017 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00002018 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00002019 // MSVC only uses guards for static locals.
2020 if (!D.isStaticLocal()) {
2021 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2022 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
Rafael Espindola77abc3a2015-01-16 16:04:45 +00002023 llvm::Function *F = CGF.CurFn;
2024 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2025 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
Reid Kleckner563f0e82014-05-23 21:13:45 +00002026 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2027 return;
2028 }
2029
Reid Klecknerd8110b62013-09-10 20:14:30 +00002030 // MSVC always uses an i32 bitfield to guard initialization, which is *not*
2031 // threadsafe. Since the user may be linking in inline functions compiled by
2032 // cl.exe, there's no reason to provide a false sense of security by using
2033 // critical sections here.
John McCallc84ed6a2012-05-01 06:13:13 +00002034
Richard Smithdbf74ba2013-04-14 23:01:42 +00002035 if (D.getTLSKind())
2036 CGM.ErrorUnsupported(&D, "dynamic TLS initialization");
2037
Reid Klecknerd8110b62013-09-10 20:14:30 +00002038 CGBuilderTy &Builder = CGF.Builder;
2039 llvm::IntegerType *GuardTy = CGF.Int32Ty;
2040 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
2041
2042 // Get the guard variable for this function if we have one already.
Reid Kleckner563f0e82014-05-23 21:13:45 +00002043 GuardInfo *GI = &GuardVariableMap[D.getDeclContext()];
Reid Klecknerd8110b62013-09-10 20:14:30 +00002044
2045 unsigned BitIndex;
Reid Klecknere9591b32014-04-23 18:22:11 +00002046 if (D.isStaticLocal() && D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002047 // Externally visible variables have to be numbered in Sema to properly
2048 // handle unreachable VarDecls.
David Majnemer2206bf52014-03-05 08:57:59 +00002049 BitIndex = getContext().getStaticLocalNumber(&D);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002050 assert(BitIndex > 0);
2051 BitIndex--;
2052 } else {
2053 // Non-externally visible variables are numbered here in CodeGen.
Reid Klecknere9591b32014-04-23 18:22:11 +00002054 BitIndex = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002055 }
2056
2057 if (BitIndex >= 32) {
2058 if (D.isExternallyVisible())
2059 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
2060 BitIndex %= 32;
Craig Topper8a13c412014-05-21 05:09:00 +00002061 GI->Guard = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002062 }
2063
2064 // Lazily create the i32 bitfield for this function.
Reid Klecknere9591b32014-04-23 18:22:11 +00002065 if (!GI->Guard) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002066 // Mangle the name for the guard.
2067 SmallString<256> GuardName;
2068 {
2069 llvm::raw_svector_ostream Out(GuardName);
2070 getMangleContext().mangleStaticGuardVariable(&D, Out);
2071 Out.flush();
2072 }
2073
Hans Wennborgef2272c2014-06-18 15:55:13 +00002074 // Create the guard variable with a zero-initializer. Just absorb linkage,
2075 // visibility and dll storage class from the guarded variable.
Reid Klecknere9591b32014-04-23 18:22:11 +00002076 GI->Guard =
2077 new llvm::GlobalVariable(CGM.getModule(), GuardTy, false,
2078 GV->getLinkage(), Zero, GuardName.str());
2079 GI->Guard->setVisibility(GV->getVisibility());
Hans Wennborgef2272c2014-06-18 15:55:13 +00002080 GI->Guard->setDLLStorageClass(GV->getDLLStorageClass());
David Majnemer3072fc82015-01-21 01:04:30 +00002081 if (GI->Guard->isWeakForLinker())
2082 GI->Guard->setComdat(
2083 CGM.getModule().getOrInsertComdat(GI->Guard->getName()));
Reid Klecknerd8110b62013-09-10 20:14:30 +00002084 } else {
Reid Klecknere9591b32014-04-23 18:22:11 +00002085 assert(GI->Guard->getLinkage() == GV->getLinkage() &&
Reid Klecknerd8110b62013-09-10 20:14:30 +00002086 "static local from the same function had different linkage");
2087 }
2088
2089 // Pseudo code for the test:
2090 // if (!(GuardVar & MyGuardBit)) {
2091 // GuardVar |= MyGuardBit;
2092 // ... initialize the object ...;
2093 // }
2094
2095 // Test our bit from the guard variable.
2096 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1U << BitIndex);
Reid Klecknere9591b32014-04-23 18:22:11 +00002097 llvm::LoadInst *LI = Builder.CreateLoad(GI->Guard);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002098 llvm::Value *IsInitialized =
2099 Builder.CreateICmpNE(Builder.CreateAnd(LI, Bit), Zero);
2100 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2101 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
2102 Builder.CreateCondBr(IsInitialized, EndBlock, InitBlock);
2103
2104 // Set our bit in the guard variable and emit the initializer and add a global
2105 // destructor if appropriate.
2106 CGF.EmitBlock(InitBlock);
Reid Klecknere9591b32014-04-23 18:22:11 +00002107 Builder.CreateStore(Builder.CreateOr(LI, Bit), GI->Guard);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002108 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2109 Builder.CreateBr(EndBlock);
2110
2111 // Continue.
2112 CGF.EmitBlock(EndBlock);
John McCallc84ed6a2012-05-01 06:13:13 +00002113}
2114
Reid Kleckner2341ae32013-04-11 18:13:19 +00002115bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2116 // Null-ness for function memptrs only depends on the first field, which is
2117 // the function pointer. The rest don't matter, so we can zero initialize.
2118 if (MPT->isMemberFunctionPointer())
2119 return true;
2120
2121 // The virtual base adjustment field is always -1 for null, so if we have one
2122 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
2123 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002124 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2125 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002126 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
2127 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00002128}
2129
2130llvm::Type *
2131MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002132 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2133 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002134 llvm::SmallVector<llvm::Type *, 4> fields;
2135 if (MPT->isMemberFunctionPointer())
2136 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
2137 else
2138 fields.push_back(CGM.IntTy); // FieldOffset
2139
Reid Kleckner96f8f932014-02-05 17:27:08 +00002140 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2141 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002142 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002143 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002144 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002145 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002146 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
2147
2148 if (fields.size() == 1)
2149 return fields[0];
2150 return llvm::StructType::get(CGM.getLLVMContext(), fields);
2151}
2152
2153void MicrosoftCXXABI::
2154GetNullMemberPointerFields(const MemberPointerType *MPT,
2155 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2156 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00002157 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2158 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002159 if (MPT->isMemberFunctionPointer()) {
2160 // FunctionPointerOrVirtualThunk
2161 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2162 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00002163 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00002164 fields.push_back(getZeroInt()); // FieldOffset
2165 else
2166 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00002167 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00002168
Reid Kleckner96f8f932014-02-05 17:27:08 +00002169 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2170 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002171 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002172 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002173 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002174 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002175 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002176}
2177
2178llvm::Constant *
2179MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002180 llvm::SmallVector<llvm::Constant *, 4> fields;
2181 GetNullMemberPointerFields(MPT, fields);
2182 if (fields.size() == 1)
2183 return fields[0];
2184 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2185 assert(Res->getType() == ConvertMemberPointerType(MPT));
2186 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002187}
2188
2189llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002190MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2191 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00002192 const CXXRecordDecl *RD,
2193 CharUnits NonVirtualBaseAdjustment)
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002194{
David Majnemer1cdd96d2014-01-17 09:01:00 +00002195 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002196
2197 // Single inheritance class member pointer are represented as scalars instead
2198 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002199 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002200 return FirstField;
2201
Reid Kleckner2341ae32013-04-11 18:13:19 +00002202 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002203 fields.push_back(FirstField);
2204
Reid Kleckner96f8f932014-02-05 17:27:08 +00002205 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002206 fields.push_back(llvm::ConstantInt::get(
2207 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002208
Reid Kleckner96f8f932014-02-05 17:27:08 +00002209 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00002210 CharUnits Offs = CharUnits::Zero();
2211 if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002212 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00002213 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00002214 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002215
2216 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002217 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002218 fields.push_back(getZeroInt());
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002219
Reid Kleckner2341ae32013-04-11 18:13:19 +00002220 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002221}
2222
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002223llvm::Constant *
2224MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2225 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002226 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002227 llvm::Constant *FirstField =
2228 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00002229 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
2230 CharUnits::Zero());
2231}
2232
2233llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const CXXMethodDecl *MD) {
2234 return BuildMemberPointer(MD->getParent(), MD, CharUnits::Zero());
2235}
2236
2237llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2238 QualType MPType) {
2239 const MemberPointerType *MPT = MPType->castAs<MemberPointerType>();
2240 const ValueDecl *MPD = MP.getMemberPointerDecl();
2241 if (!MPD)
2242 return EmitNullMemberPointer(MPT);
2243
2244 CharUnits ThisAdjustment = getMemberPointerPathAdjustment(MP);
2245
2246 // FIXME PR15713: Support virtual inheritance paths.
2247
2248 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD))
David Majnemer1cdd96d2014-01-17 09:01:00 +00002249 return BuildMemberPointer(MPT->getMostRecentCXXRecordDecl(), MD,
2250 ThisAdjustment);
Reid Kleckner452abac2013-05-09 21:01:17 +00002251
2252 CharUnits FieldOffset =
2253 getContext().toCharUnitsFromBits(getContext().getFieldOffset(MPD));
2254 return EmitMemberDataPointer(MPT, ThisAdjustment + FieldOffset);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002255}
2256
2257llvm::Constant *
Reid Kleckner452abac2013-05-09 21:01:17 +00002258MicrosoftCXXABI::BuildMemberPointer(const CXXRecordDecl *RD,
2259 const CXXMethodDecl *MD,
2260 CharUnits NonVirtualBaseAdjustment) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002261 assert(MD->isInstance() && "Member function must not be static!");
2262 MD = MD->getCanonicalDecl();
David Majnemer1cdd96d2014-01-17 09:01:00 +00002263 RD = RD->getMostRecentDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002264 CodeGenTypes &Types = CGM.getTypes();
2265
2266 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00002267 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00002268 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002269 llvm::Type *Ty;
2270 // Check whether the function has a computable LLVM signature.
2271 if (Types.isFuncTypeConvertible(FPT)) {
2272 // The function has a computable LLVM signature; use the correct type.
2273 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2274 } else {
2275 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2276 // function type is incomplete.
2277 Ty = CGM.PtrDiffTy;
2278 }
2279 FirstField = CGM.GetAddrOfFunction(MD, Ty);
2280 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Hans Wennborg88497d62013-11-15 17:24:45 +00002281 } else {
2282 MicrosoftVTableContext::MethodVFTableLocation ML =
2283 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Reid Klecknerc3473512014-08-29 21:43:29 +00002284 if (!CGM.getTypes().isFuncTypeConvertible(
2285 MD->getType()->castAs<FunctionType>())) {
Hans Wennborg88497d62013-11-15 17:24:45 +00002286 CGM.ErrorUnsupported(MD, "pointer to virtual member function with "
2287 "incomplete return or parameter type");
2288 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
Reid Klecknerc3473512014-08-29 21:43:29 +00002289 } else if (FPT->getCallConv() == CC_X86FastCall) {
2290 CGM.ErrorUnsupported(MD, "pointer to fastcall virtual member function");
2291 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
Hans Wennborg88497d62013-11-15 17:24:45 +00002292 } else if (ML.VBase) {
2293 CGM.ErrorUnsupported(MD, "pointer to virtual member function overriding "
2294 "member function in virtual base class");
2295 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
2296 } else {
Reid Klecknere4a52202014-02-21 02:27:32 +00002297 llvm::Function *Thunk = EmitVirtualMemPtrThunk(MD, ML);
Hans Wennborg88497d62013-11-15 17:24:45 +00002298 FirstField = llvm::ConstantExpr::getBitCast(Thunk, CGM.VoidPtrTy);
Reid Klecknere4a52202014-02-21 02:27:32 +00002299 // Include the vfptr adjustment if the method is in a non-primary vftable.
2300 NonVirtualBaseAdjustment += ML.VFPtrOffset;
Hans Wennborg88497d62013-11-15 17:24:45 +00002301 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002302 }
2303
2304 // The rest of the fields are common with data member pointers.
Reid Kleckner452abac2013-05-09 21:01:17 +00002305 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
2306 NonVirtualBaseAdjustment);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002307}
2308
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002309/// Member pointers are the same if they're either bitwise identical *or* both
2310/// null. Null-ness for function members is determined by the first field,
2311/// while for data member pointers we must compare all fields.
2312llvm::Value *
2313MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2314 llvm::Value *L,
2315 llvm::Value *R,
2316 const MemberPointerType *MPT,
2317 bool Inequality) {
2318 CGBuilderTy &Builder = CGF.Builder;
2319
2320 // Handle != comparisons by switching the sense of all boolean operations.
2321 llvm::ICmpInst::Predicate Eq;
2322 llvm::Instruction::BinaryOps And, Or;
2323 if (Inequality) {
2324 Eq = llvm::ICmpInst::ICMP_NE;
2325 And = llvm::Instruction::Or;
2326 Or = llvm::Instruction::And;
2327 } else {
2328 Eq = llvm::ICmpInst::ICMP_EQ;
2329 And = llvm::Instruction::And;
2330 Or = llvm::Instruction::Or;
2331 }
2332
2333 // If this is a single field member pointer (single inheritance), this is a
2334 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002335 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2336 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002337 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2338 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002339 return Builder.CreateICmp(Eq, L, R);
2340
2341 // Compare the first field.
2342 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2343 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2344 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2345
2346 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002347 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002348 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2349 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2350 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2351 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2352 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2353 if (Res)
2354 Res = Builder.CreateBinOp(And, Res, Cmp);
2355 else
2356 Res = Cmp;
2357 }
2358
2359 // Check if the first field is 0 if this is a function pointer.
2360 if (MPT->isMemberFunctionPointer()) {
2361 // (l1 == r1 && ...) || l0 == 0
2362 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2363 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2364 Res = Builder.CreateBinOp(Or, Res, IsZero);
2365 }
2366
2367 // Combine the comparison of the first field, which must always be true for
2368 // this comparison to succeeed.
2369 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2370}
2371
Reid Kleckner407e8b62013-03-22 19:02:54 +00002372llvm::Value *
2373MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2374 llvm::Value *MemPtr,
2375 const MemberPointerType *MPT) {
2376 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002377 llvm::SmallVector<llvm::Constant *, 4> fields;
2378 // We only need one field for member functions.
2379 if (MPT->isMemberFunctionPointer())
2380 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2381 else
2382 GetNullMemberPointerFields(MPT, fields);
2383 assert(!fields.empty());
2384 llvm::Value *FirstField = MemPtr;
2385 if (MemPtr->getType()->isStructTy())
2386 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2387 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002388
Reid Kleckner2341ae32013-04-11 18:13:19 +00002389 // For function member pointers, we only need to test the function pointer
2390 // field. The other fields if any can be garbage.
2391 if (MPT->isMemberFunctionPointer())
2392 return Res;
2393
2394 // Otherwise, emit a series of compares and combine the results.
2395 for (int I = 1, E = fields.size(); I < E; ++I) {
2396 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2397 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002398 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002399 }
2400 return Res;
2401}
2402
Reid Kleckner452abac2013-05-09 21:01:17 +00002403bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2404 llvm::Constant *Val) {
2405 // Function pointers are null if the pointer in the first field is null.
2406 if (MPT->isMemberFunctionPointer()) {
2407 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2408 Val->getAggregateElement(0U) : Val;
2409 return FirstField->isNullValue();
2410 }
2411
2412 // If it's not a function pointer and it's zero initializable, we can easily
2413 // check zero.
2414 if (isZeroInitializable(MPT) && Val->isNullValue())
2415 return true;
2416
2417 // Otherwise, break down all the fields for comparison. Hopefully these
2418 // little Constants are reused, while a big null struct might not be.
2419 llvm::SmallVector<llvm::Constant *, 4> Fields;
2420 GetNullMemberPointerFields(MPT, Fields);
2421 if (Fields.size() == 1) {
2422 assert(Val->getType()->isIntegerTy());
2423 return Val == Fields[0];
2424 }
2425
2426 unsigned I, E;
2427 for (I = 0, E = Fields.size(); I != E; ++I) {
2428 if (Val->getAggregateElement(I) != Fields[I])
2429 break;
2430 }
2431 return I == E;
2432}
2433
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002434llvm::Value *
2435MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
2436 llvm::Value *This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002437 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002438 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002439 llvm::Value **VBPtrOut) {
2440 CGBuilderTy &Builder = CGF.Builder;
2441 // Load the vbtable pointer from the vbptr in the instance.
2442 This = Builder.CreateBitCast(This, CGM.Int8PtrTy);
2443 llvm::Value *VBPtr =
2444 Builder.CreateInBoundsGEP(This, VBPtrOffset, "vbptr");
2445 if (VBPtrOut) *VBPtrOut = VBPtr;
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002446 VBPtr = Builder.CreateBitCast(VBPtr,
2447 CGM.Int32Ty->getPointerTo(0)->getPointerTo(0));
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002448 llvm::Value *VBTable = Builder.CreateLoad(VBPtr, "vbtable");
2449
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002450 // Translate from byte offset to table index. It improves analyzability.
2451 llvm::Value *VBTableIndex = Builder.CreateAShr(
2452 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
2453 "vbtindex", /*isExact=*/true);
2454
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002455 // Load an i32 offset from the vb-table.
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002456 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002457 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
2458 return Builder.CreateLoad(VBaseOffs, "vbase_offs");
2459}
2460
Reid Kleckner2341ae32013-04-11 18:13:19 +00002461// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2462// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002463llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2464 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
2465 llvm::Value *Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002466 CGBuilderTy &Builder = CGF.Builder;
2467 Base = Builder.CreateBitCast(Base, CGM.Int8PtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +00002468 llvm::BasicBlock *OriginalBB = nullptr;
2469 llvm::BasicBlock *SkipAdjustBB = nullptr;
2470 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002471
2472 // In the unspecified inheritance model, there might not be a vbtable at all,
2473 // in which case we need to skip the virtual base lookup. If there is a
2474 // vbtable, the first entry is a no-op entry that gives back the original
2475 // base, so look for a virtual base adjustment offset of zero.
2476 if (VBPtrOffset) {
2477 OriginalBB = Builder.GetInsertBlock();
2478 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2479 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2480 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002481 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002482 "memptr.is_vbase");
2483 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2484 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002485 }
2486
Reid Kleckner2341ae32013-04-11 18:13:19 +00002487 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
2488 // know the vbptr offset.
2489 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002490 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00002491 if (!RD->hasDefinition()) {
2492 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
2493 unsigned DiagID = Diags.getCustomDiagID(
2494 DiagnosticsEngine::Error,
2495 "member pointer representation requires a "
2496 "complete class type for %0 to perform this expression");
2497 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
2498 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002499 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002500 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
2501 }
Craig Topper8a13c412014-05-21 05:09:00 +00002502 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002503 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002504 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002505 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
2506
2507 // Merge control flow with the case where we didn't have to adjust.
2508 if (VBaseAdjustBB) {
2509 Builder.CreateBr(SkipAdjustBB);
2510 CGF.EmitBlock(SkipAdjustBB);
2511 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
2512 Phi->addIncoming(Base, OriginalBB);
2513 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
2514 return Phi;
2515 }
2516 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002517}
2518
David Majnemer2b0d66d2014-02-20 23:22:07 +00002519llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
2520 CodeGenFunction &CGF, const Expr *E, llvm::Value *Base, llvm::Value *MemPtr,
2521 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002522 assert(MPT->isMemberDataPointer());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002523 unsigned AS = Base->getType()->getPointerAddressSpace();
2524 llvm::Type *PType =
2525 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
2526 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002527 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2528 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00002529
Reid Kleckner2341ae32013-04-11 18:13:19 +00002530 // Extract the fields we need, regardless of model. We'll apply them if we
2531 // have them.
2532 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002533 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2534 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002535 if (MemPtr->getType()->isStructTy()) {
2536 // We need to extract values.
2537 unsigned I = 0;
2538 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002539 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002540 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002541 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002542 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002543 }
2544
Reid Kleckner2341ae32013-04-11 18:13:19 +00002545 if (VirtualBaseAdjustmentOffset) {
David Majnemer2b0d66d2014-02-20 23:22:07 +00002546 Base = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00002547 VBPtrOffset);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002548 }
Reid Klecknerae945122013-12-05 22:44:07 +00002549
2550 // Cast to char*.
2551 Base = Builder.CreateBitCast(Base, Builder.getInt8Ty()->getPointerTo(AS));
2552
2553 // Apply the offset, which we assume is non-null.
Reid Kleckner2341ae32013-04-11 18:13:19 +00002554 llvm::Value *Addr =
2555 Builder.CreateInBoundsGEP(Base, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002556
2557 // Cast the address to the appropriate pointer type, adopting the address
2558 // space of the base pointer.
2559 return Builder.CreateBitCast(Addr, PType);
2560}
2561
David Majnemer1cdd96d2014-01-17 09:01:00 +00002562static MSInheritanceAttr::Spelling
Reid Kleckner452abac2013-05-09 21:01:17 +00002563getInheritanceFromMemptr(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002564 return MPT->getMostRecentCXXRecordDecl()->getMSInheritanceModel();
Reid Kleckner452abac2013-05-09 21:01:17 +00002565}
2566
2567llvm::Value *
2568MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
2569 const CastExpr *E,
2570 llvm::Value *Src) {
2571 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
2572 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
2573 E->getCastKind() == CK_ReinterpretMemberPointer);
2574
2575 // Use constant emission if we can.
2576 if (isa<llvm::Constant>(Src))
2577 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
2578
2579 // We may be adding or dropping fields from the member pointer, so we need
2580 // both types and the inheritance models of both records.
2581 const MemberPointerType *SrcTy =
2582 E->getSubExpr()->getType()->castAs<MemberPointerType>();
2583 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002584 bool IsFunc = SrcTy->isMemberFunctionPointer();
2585
2586 // If the classes use the same null representation, reinterpret_cast is a nop.
2587 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002588 if (IsReinterpret && IsFunc)
2589 return Src;
2590
2591 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
2592 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
2593 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00002594 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00002595 return Src;
2596
2597 CGBuilderTy &Builder = CGF.Builder;
2598
2599 // Branch past the conversion if Src is null.
2600 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
2601 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
2602
2603 // C++ 5.2.10p9: The null member pointer value is converted to the null member
2604 // pointer value of the destination type.
2605 if (IsReinterpret) {
2606 // For reinterpret casts, sema ensures that src and dst are both functions
2607 // or data and have the same size, which means the LLVM types should match.
2608 assert(Src->getType() == DstNull->getType());
2609 return Builder.CreateSelect(IsNotNull, Src, DstNull);
2610 }
2611
2612 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
2613 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
2614 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
2615 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
2616 CGF.EmitBlock(ConvertBB);
2617
2618 // Decompose src.
2619 llvm::Value *FirstField = Src;
Craig Topper8a13c412014-05-21 05:09:00 +00002620 llvm::Value *NonVirtualBaseAdjustment = nullptr;
2621 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2622 llvm::Value *VBPtrOffset = nullptr;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002623 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002624 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002625 // We need to extract values.
2626 unsigned I = 0;
2627 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002628 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002629 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002630 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002631 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002632 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002633 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
2634 }
2635
2636 // For data pointers, we adjust the field offset directly. For functions, we
2637 // have a separate field.
2638 llvm::Constant *Adj = getMemberPointerAdjustment(E);
2639 if (Adj) {
2640 Adj = llvm::ConstantExpr::getTruncOrBitCast(Adj, CGM.IntTy);
2641 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
2642 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
2643 if (!NVAdjustField) // If this field didn't exist in src, it's zero.
2644 NVAdjustField = getZeroInt();
2645 if (isDerivedToBase)
2646 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, Adj, "adj");
2647 else
2648 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, Adj, "adj");
2649 }
2650
2651 // FIXME PR15713: Support conversions through virtually derived classes.
2652
2653 // Recompose dst from the null struct and the adjusted fields from src.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002654 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
Reid Kleckner452abac2013-05-09 21:01:17 +00002655 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00002656 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002657 Dst = FirstField;
2658 } else {
2659 Dst = llvm::UndefValue::get(DstNull->getType());
2660 unsigned Idx = 0;
2661 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002662 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002663 Dst = Builder.CreateInsertValue(
2664 Dst, getValueOrZeroInt(NonVirtualBaseAdjustment), Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002665 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002666 Dst = Builder.CreateInsertValue(
2667 Dst, getValueOrZeroInt(VBPtrOffset), Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002668 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002669 Dst = Builder.CreateInsertValue(
2670 Dst, getValueOrZeroInt(VirtualBaseAdjustmentOffset), Idx++);
2671 }
2672 Builder.CreateBr(ContinueBB);
2673
2674 // In the continuation, choose between DstNull and Dst.
2675 CGF.EmitBlock(ContinueBB);
2676 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
2677 Phi->addIncoming(DstNull, OriginalBB);
2678 Phi->addIncoming(Dst, ConvertBB);
2679 return Phi;
2680}
2681
2682llvm::Constant *
2683MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
2684 llvm::Constant *Src) {
2685 const MemberPointerType *SrcTy =
2686 E->getSubExpr()->getType()->castAs<MemberPointerType>();
2687 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
2688
2689 // If src is null, emit a new null for dst. We can't return src because dst
2690 // might have a new representation.
2691 if (MemberPointerConstantIsNull(SrcTy, Src))
2692 return EmitNullMemberPointer(DstTy);
2693
2694 // We don't need to do anything for reinterpret_casts of non-null member
2695 // pointers. We should only get here when the two type representations have
2696 // the same size.
2697 if (E->getCastKind() == CK_ReinterpretMemberPointer)
2698 return Src;
2699
David Majnemer1cdd96d2014-01-17 09:01:00 +00002700 MSInheritanceAttr::Spelling SrcInheritance = getInheritanceFromMemptr(SrcTy);
2701 MSInheritanceAttr::Spelling DstInheritance = getInheritanceFromMemptr(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002702
2703 // Decompose src.
2704 llvm::Constant *FirstField = Src;
Craig Topper8a13c412014-05-21 05:09:00 +00002705 llvm::Constant *NonVirtualBaseAdjustment = nullptr;
2706 llvm::Constant *VirtualBaseAdjustmentOffset = nullptr;
2707 llvm::Constant *VBPtrOffset = nullptr;
Reid Kleckner452abac2013-05-09 21:01:17 +00002708 bool IsFunc = SrcTy->isMemberFunctionPointer();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002709 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002710 // We need to extract values.
2711 unsigned I = 0;
2712 FirstField = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002713 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002714 NonVirtualBaseAdjustment = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002715 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002716 VBPtrOffset = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002717 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002718 VirtualBaseAdjustmentOffset = Src->getAggregateElement(I++);
2719 }
2720
2721 // For data pointers, we adjust the field offset directly. For functions, we
2722 // have a separate field.
2723 llvm::Constant *Adj = getMemberPointerAdjustment(E);
2724 if (Adj) {
2725 Adj = llvm::ConstantExpr::getTruncOrBitCast(Adj, CGM.IntTy);
2726 llvm::Constant *&NVAdjustField =
2727 IsFunc ? NonVirtualBaseAdjustment : FirstField;
2728 bool IsDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
2729 if (!NVAdjustField) // If this field didn't exist in src, it's zero.
2730 NVAdjustField = getZeroInt();
2731 if (IsDerivedToBase)
2732 NVAdjustField = llvm::ConstantExpr::getNSWSub(NVAdjustField, Adj);
2733 else
2734 NVAdjustField = llvm::ConstantExpr::getNSWAdd(NVAdjustField, Adj);
2735 }
2736
2737 // FIXME PR15713: Support conversions through virtually derived classes.
2738
2739 // Recompose dst from the null struct and the adjusted fields from src.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002740 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002741 return FirstField;
2742
2743 llvm::SmallVector<llvm::Constant *, 4> Fields;
2744 Fields.push_back(FirstField);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002745 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002746 Fields.push_back(getConstantOrZeroInt(NonVirtualBaseAdjustment));
Reid Kleckner96f8f932014-02-05 17:27:08 +00002747 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002748 Fields.push_back(getConstantOrZeroInt(VBPtrOffset));
Reid Kleckner96f8f932014-02-05 17:27:08 +00002749 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002750 Fields.push_back(getConstantOrZeroInt(VirtualBaseAdjustmentOffset));
2751 return llvm::ConstantStruct::getAnon(Fields);
2752}
2753
David Majnemer2b0d66d2014-02-20 23:22:07 +00002754llvm::Value *MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
2755 CodeGenFunction &CGF, const Expr *E, llvm::Value *&This,
2756 llvm::Value *MemPtr, const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002757 assert(MPT->isMemberFunctionPointer());
2758 const FunctionProtoType *FPT =
2759 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00002760 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002761 llvm::FunctionType *FTy =
2762 CGM.getTypes().GetFunctionType(
2763 CGM.getTypes().arrangeCXXMethodType(RD, FPT));
2764 CGBuilderTy &Builder = CGF.Builder;
2765
David Majnemer1cdd96d2014-01-17 09:01:00 +00002766 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002767
2768 // Extract the fields we need, regardless of model. We'll apply them if we
2769 // have them.
2770 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002771 llvm::Value *NonVirtualBaseAdjustment = nullptr;
2772 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2773 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002774 if (MemPtr->getType()->isStructTy()) {
2775 // We need to extract values.
2776 unsigned I = 0;
2777 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002778 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002779 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002780 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002781 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002782 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002783 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
2784 }
2785
2786 if (VirtualBaseAdjustmentOffset) {
David Majnemer2b0d66d2014-02-20 23:22:07 +00002787 This = AdjustVirtualBase(CGF, E, RD, This, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00002788 VBPtrOffset);
2789 }
2790
2791 if (NonVirtualBaseAdjustment) {
2792 // Apply the adjustment and cast back to the original struct type.
2793 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy());
2794 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
2795 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted");
2796 }
2797
2798 return Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
2799}
2800
Charles Davis53c59df2010-08-16 03:33:14 +00002801CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00002802 return new MicrosoftCXXABI(CGM);
2803}
David Majnemere2cb8d12014-07-07 06:20:47 +00002804
2805// MS RTTI Overview:
2806// The run time type information emitted by cl.exe contains 5 distinct types of
2807// structures. Many of them reference each other.
2808//
2809// TypeInfo: Static classes that are returned by typeid.
2810//
2811// CompleteObjectLocator: Referenced by vftables. They contain information
2812// required for dynamic casting, including OffsetFromTop. They also contain
2813// a reference to the TypeInfo for the type and a reference to the
2814// CompleteHierarchyDescriptor for the type.
2815//
2816// ClassHieararchyDescriptor: Contains information about a class hierarchy.
2817// Used during dynamic_cast to walk a class hierarchy. References a base
2818// class array and the size of said array.
2819//
2820// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
2821// somewhat of a misnomer because the most derived class is also in the list
2822// as well as multiple copies of virtual bases (if they occur multiple times
2823// in the hiearchy.) The BaseClassArray contains one BaseClassDescriptor for
2824// every path in the hierarchy, in pre-order depth first order. Note, we do
2825// not declare a specific llvm type for BaseClassArray, it's merely an array
2826// of BaseClassDescriptor pointers.
2827//
2828// BaseClassDescriptor: Contains information about a class in a class hierarchy.
2829// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
2830// BaseClassArray is. It contains information about a class within a
2831// hierarchy such as: is this base is ambiguous and what is its offset in the
2832// vbtable. The names of the BaseClassDescriptors have all of their fields
2833// mangled into them so they can be aggressively deduplicated by the linker.
2834
David Majnemere2cb8d12014-07-07 06:20:47 +00002835static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
2836 StringRef MangledName("\01??_7type_info@@6B@");
2837 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
2838 return VTable;
2839 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
2840 /*Constant=*/true,
2841 llvm::GlobalVariable::ExternalLinkage,
2842 /*Initializer=*/nullptr, MangledName);
2843}
2844
2845namespace {
2846
2847/// \brief A Helper struct that stores information about a class in a class
2848/// hierarchy. The information stored in these structs struct is used during
2849/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
2850// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
2851// implicit depth first pre-order tree connectivity. getFirstChild and
2852// getNextSibling allow us to walk the tree efficiently.
2853struct MSRTTIClass {
2854 enum {
2855 IsPrivateOnPath = 1 | 8,
2856 IsAmbiguous = 2,
2857 IsPrivate = 4,
2858 IsVirtual = 16,
2859 HasHierarchyDescriptor = 64
2860 };
2861 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
2862 uint32_t initialize(const MSRTTIClass *Parent,
2863 const CXXBaseSpecifier *Specifier);
2864
2865 MSRTTIClass *getFirstChild() { return this + 1; }
2866 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
2867 return Child + 1 + Child->NumBases;
2868 }
2869
2870 const CXXRecordDecl *RD, *VirtualRoot;
2871 uint32_t Flags, NumBases, OffsetInVBase;
2872};
2873
2874/// \brief Recursively initialize the base class array.
2875uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
2876 const CXXBaseSpecifier *Specifier) {
2877 Flags = HasHierarchyDescriptor;
2878 if (!Parent) {
2879 VirtualRoot = nullptr;
2880 OffsetInVBase = 0;
2881 } else {
2882 if (Specifier->getAccessSpecifier() != AS_public)
2883 Flags |= IsPrivate | IsPrivateOnPath;
2884 if (Specifier->isVirtual()) {
2885 Flags |= IsVirtual;
2886 VirtualRoot = RD;
2887 OffsetInVBase = 0;
2888 } else {
2889 if (Parent->Flags & IsPrivateOnPath)
2890 Flags |= IsPrivateOnPath;
2891 VirtualRoot = Parent->VirtualRoot;
2892 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
2893 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
2894 }
2895 }
2896 NumBases = 0;
2897 MSRTTIClass *Child = getFirstChild();
2898 for (const CXXBaseSpecifier &Base : RD->bases()) {
2899 NumBases += Child->initialize(this, &Base) + 1;
2900 Child = getNextChild(Child);
2901 }
2902 return NumBases;
2903}
2904
2905static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
2906 switch (Ty->getLinkage()) {
2907 case NoLinkage:
2908 case InternalLinkage:
2909 case UniqueExternalLinkage:
2910 return llvm::GlobalValue::InternalLinkage;
2911
2912 case VisibleNoLinkage:
2913 case ExternalLinkage:
2914 return llvm::GlobalValue::LinkOnceODRLinkage;
2915 }
2916 llvm_unreachable("Invalid linkage!");
2917}
2918
2919/// \brief An ephemeral helper class for building MS RTTI types. It caches some
2920/// calls to the module and information about the most derived class in a
2921/// hierarchy.
2922struct MSRTTIBuilder {
2923 enum {
2924 HasBranchingHierarchy = 1,
2925 HasVirtualBranchingHierarchy = 2,
2926 HasAmbiguousBases = 4
2927 };
2928
David Majnemer611cdb92014-07-07 08:09:15 +00002929 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
2930 : CGM(ABI.CGM), Context(CGM.getContext()),
2931 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00002932 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00002933 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00002934
2935 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
2936 llvm::GlobalVariable *
2937 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
2938 llvm::GlobalVariable *getClassHierarchyDescriptor();
2939 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo *Info);
2940
2941 CodeGenModule &CGM;
2942 ASTContext &Context;
2943 llvm::LLVMContext &VMContext;
2944 llvm::Module &Module;
2945 const CXXRecordDecl *RD;
2946 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00002947 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00002948};
2949
2950} // namespace
2951
2952/// \brief Recursively serializes a class hierarchy in pre-order depth first
2953/// order.
2954static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
2955 const CXXRecordDecl *RD) {
2956 Classes.push_back(MSRTTIClass(RD));
2957 for (const CXXBaseSpecifier &Base : RD->bases())
2958 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
2959}
2960
2961/// \brief Find ambiguity among base classes.
2962static void
2963detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
2964 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
2965 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
2966 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
2967 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
2968 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
David Blaikie82e95a32014-11-19 07:49:47 +00002969 !VirtualBases.insert(Class->RD).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00002970 Class = MSRTTIClass::getNextChild(Class);
2971 continue;
2972 }
David Blaikie82e95a32014-11-19 07:49:47 +00002973 if (!UniqueBases.insert(Class->RD).second)
David Majnemere2cb8d12014-07-07 06:20:47 +00002974 AmbiguousBases.insert(Class->RD);
2975 Class++;
2976 }
2977 if (AmbiguousBases.empty())
2978 return;
2979 for (MSRTTIClass &Class : Classes)
2980 if (AmbiguousBases.count(Class.RD))
2981 Class.Flags |= MSRTTIClass::IsAmbiguous;
2982}
2983
2984llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
2985 SmallString<256> MangledName;
2986 {
2987 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00002988 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00002989 }
2990
2991 // Check to see if we've already declared this ClassHierarchyDescriptor.
2992 if (auto CHD = Module.getNamedGlobal(MangledName))
2993 return CHD;
2994
2995 // Serialize the class hierarchy and initialize the CHD Fields.
2996 SmallVector<MSRTTIClass, 8> Classes;
2997 serializeClassHierarchy(Classes, RD);
2998 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
2999 detectAmbiguousBases(Classes);
3000 int Flags = 0;
3001 for (auto Class : Classes) {
3002 if (Class.RD->getNumBases() > 1)
3003 Flags |= HasBranchingHierarchy;
3004 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
3005 // believe the field isn't actually used.
3006 if (Class.Flags & MSRTTIClass::IsAmbiguous)
3007 Flags |= HasAmbiguousBases;
3008 }
3009 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
3010 Flags |= HasVirtualBranchingHierarchy;
3011 // These gep indices are used to get the address of the first element of the
3012 // base class array.
3013 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
3014 llvm::ConstantInt::get(CGM.IntTy, 0)};
3015
3016 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00003017 auto Type = ABI.getClassHierarchyDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003018 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3019 /*Initializer=*/nullptr,
David Majnemer7c237072015-03-05 00:46:22 +00003020 StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003021 if (CHD->isWeakForLinker())
3022 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003023
David Blaikiee3b172a2015-04-02 18:55:21 +00003024 auto *Bases = getBaseClassArray(Classes);
3025
David Majnemere2cb8d12014-07-07 06:20:47 +00003026 // Initialize the base class ClassHierarchyDescriptor.
3027 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003028 llvm::ConstantInt::get(CGM.IntTy, 0), // Unknown
3029 llvm::ConstantInt::get(CGM.IntTy, Flags),
3030 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
3031 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
David Blaikiee3b172a2015-04-02 18:55:21 +00003032 Bases->getValueType(), Bases,
David Majnemer611cdb92014-07-07 08:09:15 +00003033 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00003034 };
3035 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3036 return CHD;
3037}
3038
3039llvm::GlobalVariable *
3040MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3041 SmallString<256> MangledName;
3042 {
3043 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003044 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003045 }
3046
3047 // Forward-declare the base class array.
3048 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3049 // mode) bytes of padding. We provide a pointer sized amount of padding by
3050 // adding +1 to Classes.size(). The sections have pointer alignment and are
3051 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00003052 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00003053 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00003054 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
David Majnemer7c237072015-03-05 00:46:22 +00003055 auto *BCA =
3056 new llvm::GlobalVariable(Module, ArrType,
3057 /*Constant=*/true, Linkage,
3058 /*Initializer=*/nullptr, StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003059 if (BCA->isWeakForLinker())
3060 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003061
3062 // Initialize the BaseClassArray.
3063 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3064 for (MSRTTIClass &Class : Classes)
3065 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00003066 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00003067 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00003068 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00003069 return BCA;
3070}
3071
3072llvm::GlobalVariable *
3073MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3074 // Compute the fields for the BaseClassDescriptor. They are computed up front
3075 // because they are mangled into the name of the object.
3076 uint32_t OffsetInVBTable = 0;
3077 int32_t VBPtrOffset = -1;
3078 if (Class.VirtualRoot) {
3079 auto &VTableContext = CGM.getMicrosoftVTableContext();
3080 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3081 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3082 }
3083
3084 SmallString<256> MangledName;
3085 {
3086 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003087 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3088 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3089 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003090 }
3091
David Majnemer26a90f82014-07-07 15:29:10 +00003092 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00003093 if (auto BCD = Module.getNamedGlobal(MangledName))
3094 return BCD;
3095
3096 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00003097 auto Type = ABI.getBaseClassDescriptorType();
David Majnemer7c237072015-03-05 00:46:22 +00003098 auto BCD =
3099 new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3100 /*Initializer=*/nullptr, StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003101 if (BCD->isWeakForLinker())
3102 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003103
3104 // Initialize the BaseClassDescriptor.
3105 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003106 ABI.getImageRelativeConstant(
David Majnemer443250f2015-03-17 20:35:00 +00003107 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003108 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3109 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3110 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3111 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3112 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3113 ABI.getImageRelativeConstant(
3114 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00003115 };
3116 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3117 return BCD;
3118}
3119
3120llvm::GlobalVariable *
3121MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo *Info) {
3122 SmallString<256> MangledName;
3123 {
3124 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003125 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info->MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003126 }
3127
3128 // Check to see if we've already computed this complete object locator.
3129 if (auto COL = Module.getNamedGlobal(MangledName))
3130 return COL;
3131
3132 // Compute the fields of the complete object locator.
3133 int OffsetToTop = Info->FullOffsetInMDC.getQuantity();
3134 int VFPtrOffset = 0;
3135 // The offset includes the vtordisp if one exists.
3136 if (const CXXRecordDecl *VBase = Info->getVBaseWithVPtr())
3137 if (Context.getASTRecordLayout(RD)
3138 .getVBaseOffsetsMap()
3139 .find(VBase)
3140 ->second.hasVtorDisp())
3141 VFPtrOffset = Info->NonVirtualOffset.getQuantity() + 4;
3142
3143 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00003144 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003145 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
David Majnemer7c237072015-03-05 00:46:22 +00003146 /*Initializer=*/nullptr, StringRef(MangledName));
David Majnemere2cb8d12014-07-07 06:20:47 +00003147
3148 // Initialize the CompleteObjectLocator.
3149 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003150 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3151 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3152 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3153 ABI.getImageRelativeConstant(
3154 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3155 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3156 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00003157 };
3158 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00003159 if (!ABI.isImageRelative())
3160 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00003161 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
Rafael Espindola654542a2015-01-16 19:23:42 +00003162 if (COL->isWeakForLinker())
3163 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003164 return COL;
3165}
3166
David Majnemerad803d42015-03-15 07:10:01 +00003167static QualType decomposeTypeForEH(ASTContext &Context, QualType T,
3168 bool &IsConst, bool &IsVolatile) {
3169 T = Context.getExceptionObjectType(T);
3170
3171 // C++14 [except.handle]p3:
3172 // A handler is a match for an exception object of type E if [...]
3173 // - the handler is of type cv T or const T& where T is a pointer type and
3174 // E is a pointer type that can be converted to T by [...]
3175 // - a qualification conversion
3176 IsConst = false;
3177 IsVolatile = false;
3178 QualType PointeeType = T->getPointeeType();
3179 if (!PointeeType.isNull()) {
3180 IsConst = PointeeType.isConstQualified();
3181 IsVolatile = PointeeType.isVolatileQualified();
3182 }
3183
3184 // Member pointer types like "const int A::*" are represented by having RTTI
3185 // for "int A::*" and separately storing the const qualifier.
3186 if (const auto *MPTy = T->getAs<MemberPointerType>())
3187 T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(),
3188 MPTy->getClass());
3189
3190 // Pointer types like "const int * const *" are represented by having RTTI
3191 // for "const int **" and separately storing the const qualifier.
3192 if (T->isPointerType())
3193 T = Context.getPointerType(PointeeType.getUnqualifiedType());
3194
3195 return T;
3196}
3197
David Majnemer5f0dd612015-03-17 20:35:05 +00003198llvm::Constant *
David Majnemer37b417f2015-03-29 21:55:10 +00003199MicrosoftCXXABI::getAddrOfCXXCatchHandlerType(QualType Type,
3200 QualType CatchHandlerType) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003201 // TypeDescriptors for exceptions never have qualified pointer types,
David Majnemer443250f2015-03-17 20:35:00 +00003202 // qualifiers are stored seperately in order to support qualification
3203 // conversions.
3204 bool IsConst, IsVolatile;
3205 Type = decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile);
3206
David Majnemer5f0dd612015-03-17 20:35:05 +00003207 bool IsReference = CatchHandlerType->isReferenceType();
3208
David Majnemer5f0dd612015-03-17 20:35:05 +00003209 uint32_t Flags = 0;
3210 if (IsConst)
3211 Flags |= 1;
3212 if (IsVolatile)
3213 Flags |= 2;
3214 if (IsReference)
3215 Flags |= 8;
3216
David Majnemer37b417f2015-03-29 21:55:10 +00003217 SmallString<256> MangledName;
3218 {
3219 llvm::raw_svector_ostream Out(MangledName);
3220 getMangleContext().mangleCXXCatchHandlerType(Type, Flags, Out);
3221 }
3222
3223 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3224 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3225
David Majnemer5f0dd612015-03-17 20:35:05 +00003226 llvm::Constant *Fields[] = {
David Majnemer37b417f2015-03-29 21:55:10 +00003227 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
3228 getAddrOfRTTIDescriptor(Type), // TypeDescriptor
David Majnemer5f0dd612015-03-17 20:35:05 +00003229 };
David Majnemer37b417f2015-03-29 21:55:10 +00003230 llvm::StructType *CatchHandlerTypeType = getCatchHandlerTypeType();
David Majnemer5f0dd612015-03-17 20:35:05 +00003231 auto *Var = new llvm::GlobalVariable(
David Majnemer37b417f2015-03-29 21:55:10 +00003232 CGM.getModule(), CatchHandlerTypeType, /*Constant=*/true,
David Majnemer5f0dd612015-03-17 20:35:05 +00003233 llvm::GlobalValue::PrivateLinkage,
David Majnemer37b417f2015-03-29 21:55:10 +00003234 llvm::ConstantStruct::get(CatchHandlerTypeType, Fields),
David Majnemer5f0dd612015-03-17 20:35:05 +00003235 StringRef(MangledName));
3236 Var->setUnnamedAddr(true);
3237 Var->setSection("llvm.metadata");
3238 return Var;
David Majnemer443250f2015-03-17 20:35:00 +00003239}
3240
David Majnemere2cb8d12014-07-07 06:20:47 +00003241/// \brief Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
3242/// llvm::GlobalVariable * because different type descriptors have different
3243/// types, and need to be abstracted. They are abstracting by casting the
3244/// address to an Int8PtrTy.
David Majnemer443250f2015-03-17 20:35:00 +00003245llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003246 SmallString<256> MangledName;
David Majnemere2cb8d12014-07-07 06:20:47 +00003247 {
3248 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003249 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003250 }
3251
3252 // Check to see if we've already declared this TypeDescriptor.
3253 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3254 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3255
3256 // Compute the fields for the TypeDescriptor.
David Majnemer5f0dd612015-03-17 20:35:05 +00003257 SmallString<256> TypeInfoString;
David Majnemere2cb8d12014-07-07 06:20:47 +00003258 {
3259 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00003260 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003261 }
3262
3263 // Declare and initialize the TypeDescriptor.
3264 llvm::Constant *Fields[] = {
3265 getTypeInfoVTable(CGM), // VFPtr
3266 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3267 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3268 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00003269 getTypeDescriptorType(TypeInfoString);
Rafael Espindola654542a2015-01-16 19:23:42 +00003270 auto *Var = new llvm::GlobalVariable(
3271 CGM.getModule(), TypeDescriptorType, /*Constant=*/false,
3272 getLinkageForRTTI(Type),
3273 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
David Majnemer7c237072015-03-05 00:46:22 +00003274 StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003275 if (Var->isWeakForLinker())
3276 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3277 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003278}
3279
3280/// \brief Gets or a creates a Microsoft CompleteObjectLocator.
3281llvm::GlobalVariable *
3282MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
3283 const VPtrInfo *Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00003284 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003285}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003286
3287static void emitCXXConstructor(CodeGenModule &CGM,
3288 const CXXConstructorDecl *ctor,
3289 StructorType ctorType) {
Rafael Espindolad48b51b2014-09-15 19:24:44 +00003290 // There are no constructor variants, always emit the complete destructor.
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003291 llvm::Function *Fn = CGM.codegenCXXStructor(ctor, StructorType::Complete);
3292 CGM.maybeSetTrivialComdat(*ctor, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003293}
3294
3295static void emitCXXDestructor(CodeGenModule &CGM, const CXXDestructorDecl *dtor,
3296 StructorType dtorType) {
3297 // The complete destructor is equivalent to the base destructor for
3298 // classes with no virtual bases, so try to emit it as an alias.
3299 if (!dtor->getParent()->getNumVBases() &&
3300 (dtorType == StructorType::Complete || dtorType == StructorType::Base)) {
3301 bool ProducedAlias = !CGM.TryEmitDefinitionAsAlias(
3302 GlobalDecl(dtor, Dtor_Complete), GlobalDecl(dtor, Dtor_Base), true);
3303 if (ProducedAlias) {
3304 if (dtorType == StructorType::Complete)
3305 return;
3306 if (dtor->isVirtual())
3307 CGM.getVTables().EmitThunks(GlobalDecl(dtor, Dtor_Complete));
3308 }
3309 }
3310
3311 // The base destructor is equivalent to the base destructor of its
3312 // base class if there is exactly one non-virtual base class with a
3313 // non-trivial destructor, there are no fields with a non-trivial
3314 // destructor, and the body of the destructor is trivial.
3315 if (dtorType == StructorType::Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
3316 return;
3317
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003318 llvm::Function *Fn = CGM.codegenCXXStructor(dtor, dtorType);
Rafael Espindolad3e04692015-01-17 01:47:39 +00003319 if (Fn->isWeakForLinker())
3320 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003321}
3322
3323void MicrosoftCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3324 StructorType Type) {
3325 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
3326 emitCXXConstructor(CGM, CD, Type);
3327 return;
3328 }
3329 emitCXXDestructor(CGM, cast<CXXDestructorDecl>(MD), Type);
3330}
David Majnemer7c237072015-03-05 00:46:22 +00003331
David Majnemerdfa6d202015-03-11 18:36:39 +00003332llvm::Function *
David Majnemer37fd66e2015-03-13 22:36:55 +00003333MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
3334 CXXCtorType CT) {
3335 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
3336
David Majnemerdfa6d202015-03-11 18:36:39 +00003337 // Calculate the mangled name.
3338 SmallString<256> ThunkName;
3339 llvm::raw_svector_ostream Out(ThunkName);
David Majnemer37fd66e2015-03-13 22:36:55 +00003340 getMangleContext().mangleCXXCtor(CD, CT, Out);
David Majnemerdfa6d202015-03-11 18:36:39 +00003341 Out.flush();
3342
3343 // If the thunk has been generated previously, just return it.
3344 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
3345 return cast<llvm::Function>(GV);
3346
3347 // Create the llvm::Function.
David Majnemer37fd66e2015-03-13 22:36:55 +00003348 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT);
David Majnemerdfa6d202015-03-11 18:36:39 +00003349 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
3350 const CXXRecordDecl *RD = CD->getParent();
3351 QualType RecordTy = getContext().getRecordType(RD);
3352 llvm::Function *ThunkFn = llvm::Function::Create(
3353 ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule());
Reid Klecknerbba3cb92015-03-17 19:00:50 +00003354 ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>(
3355 FnInfo.getEffectiveCallingConvention()));
David Majnemer37fd66e2015-03-13 22:36:55 +00003356 bool IsCopy = CT == Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003357
3358 // Start codegen.
3359 CodeGenFunction CGF(CGM);
3360 CGF.CurGD = GlobalDecl(CD, Ctor_Complete);
3361
3362 // Build FunctionArgs.
3363 FunctionArgList FunctionArgs;
3364
David Majnemer37fd66e2015-03-13 22:36:55 +00003365 // A constructor always starts with a 'this' pointer as its first argument.
David Majnemerdfa6d202015-03-11 18:36:39 +00003366 buildThisParam(CGF, FunctionArgs);
3367
3368 // Following the 'this' pointer is a reference to the source object that we
3369 // are copying from.
3370 ImplicitParamDecl SrcParam(
3371 getContext(), nullptr, SourceLocation(), &getContext().Idents.get("src"),
3372 getContext().getLValueReferenceType(RecordTy,
3373 /*SpelledAsLValue=*/true));
David Majnemer37fd66e2015-03-13 22:36:55 +00003374 if (IsCopy)
3375 FunctionArgs.push_back(&SrcParam);
David Majnemerdfa6d202015-03-11 18:36:39 +00003376
David Majnemer37fd66e2015-03-13 22:36:55 +00003377 // Constructors for classes which utilize virtual bases have an additional
3378 // parameter which indicates whether or not it is being delegated to by a more
3379 // derived constructor.
David Majnemerdfa6d202015-03-11 18:36:39 +00003380 ImplicitParamDecl IsMostDerived(getContext(), nullptr, SourceLocation(),
3381 &getContext().Idents.get("is_most_derived"),
3382 getContext().IntTy);
3383 // Only add the parameter to the list if thie class has virtual bases.
3384 if (RD->getNumVBases() > 0)
3385 FunctionArgs.push_back(&IsMostDerived);
3386
3387 // Start defining the function.
3388 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
3389 FunctionArgs, CD->getLocation(), SourceLocation());
3390 EmitThisParam(CGF);
3391 llvm::Value *This = getThisValue(CGF);
3392
3393 llvm::Value *SrcVal =
David Majnemer37fd66e2015-03-13 22:36:55 +00003394 IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src")
3395 : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003396
3397 CallArgList Args;
3398
3399 // Push the this ptr.
3400 Args.add(RValue::get(This), CD->getThisType(getContext()));
3401
3402 // Push the src ptr.
David Majnemer37fd66e2015-03-13 22:36:55 +00003403 if (SrcVal)
3404 Args.add(RValue::get(SrcVal), SrcParam.getType());
David Majnemerdfa6d202015-03-11 18:36:39 +00003405
3406 // Add the rest of the default arguments.
3407 std::vector<Stmt *> ArgVec;
Reid Kleckner93f661a2015-03-17 21:51:43 +00003408 for (unsigned I = IsCopy ? 1 : 0, E = CD->getNumParams(); I != E; ++I) {
3409 Stmt *DefaultArg = getContext().getDefaultArgExprForConstructor(CD, I);
3410 assert(DefaultArg && "sema forgot to instantiate default args");
3411 ArgVec.push_back(DefaultArg);
3412 }
David Majnemerdfa6d202015-03-11 18:36:39 +00003413
3414 CodeGenFunction::RunCleanupsScope Cleanups(CGF);
3415
3416 const auto *FPT = CD->getType()->castAs<FunctionProtoType>();
Aaron Ballman0c22d5a2015-03-12 13:49:45 +00003417 ConstExprIterator ArgBegin(ArgVec.data()),
3418 ArgEnd(ArgVec.data() + ArgVec.size());
David Majnemer37fd66e2015-03-13 22:36:55 +00003419 CGF.EmitCallArgs(Args, FPT, ArgBegin, ArgEnd, CD, IsCopy ? 1 : 0);
David Majnemerdfa6d202015-03-11 18:36:39 +00003420
3421 // Insert any ABI-specific implicit constructor arguments.
3422 unsigned ExtraArgs = addImplicitConstructorArgs(CGF, CD, Ctor_Complete,
3423 /*ForVirtualBase=*/false,
3424 /*Delegating=*/false, Args);
3425
3426 // Call the destructor with our arguments.
3427 llvm::Value *CalleeFn = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3428 const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall(
3429 Args, CD, Ctor_Complete, ExtraArgs);
3430 CGF.EmitCall(CalleeInfo, CalleeFn, ReturnValueSlot(), Args, CD);
3431
3432 Cleanups.ForceCleanup();
3433
3434 // Emit the ret instruction, remove any temporary instructions created for the
3435 // aid of CodeGen.
3436 CGF.FinishFunction(SourceLocation());
3437
3438 return ThunkFn;
3439}
3440
David Majnemer7c237072015-03-05 00:46:22 +00003441llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
3442 uint32_t NVOffset,
3443 int32_t VBPtrOffset,
3444 uint32_t VBIndex) {
3445 assert(!T->isReferenceType());
3446
David Majnemere7a818f2015-03-06 18:53:55 +00003447 CXXRecordDecl *RD = T->getAsCXXRecordDecl();
3448 const CXXConstructorDecl *CD =
3449 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003450 CXXCtorType CT = Ctor_Complete;
David Majnemer37fd66e2015-03-13 22:36:55 +00003451 if (CD)
3452 if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1)
David Majnemerdfa6d202015-03-11 18:36:39 +00003453 CT = Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003454
David Majnemer7c237072015-03-05 00:46:22 +00003455 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
3456 SmallString<256> MangledName;
3457 {
3458 llvm::raw_svector_ostream Out(MangledName);
David Majnemerdfa6d202015-03-11 18:36:39 +00003459 getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +00003460 VBPtrOffset, VBIndex, Out);
David Majnemer7c237072015-03-05 00:46:22 +00003461 }
3462 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3463 return getImageRelativeConstant(GV);
3464
David Majnemerdfa6d202015-03-11 18:36:39 +00003465 // The TypeDescriptor is used by the runtime to determine if a catch handler
David Majnemer7c237072015-03-05 00:46:22 +00003466 // is appropriate for the exception object.
David Majnemer443250f2015-03-17 20:35:00 +00003467 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
David Majnemer7c237072015-03-05 00:46:22 +00003468
3469 // The runtime is responsible for calling the copy constructor if the
3470 // exception is caught by value.
David Majnemerdfa6d202015-03-11 18:36:39 +00003471 llvm::Constant *CopyCtor;
3472 if (CD) {
3473 if (CT == Ctor_CopyingClosure)
David Majnemer37fd66e2015-03-13 22:36:55 +00003474 CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure);
David Majnemerdfa6d202015-03-11 18:36:39 +00003475 else
3476 CopyCtor = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3477
3478 CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy);
3479 } else {
3480 CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
3481 }
David Majnemere7a818f2015-03-06 18:53:55 +00003482 CopyCtor = getImageRelativeConstant(CopyCtor);
David Majnemer7c237072015-03-05 00:46:22 +00003483
David Majnemere7a818f2015-03-06 18:53:55 +00003484 bool IsScalar = !RD;
David Majnemer7c237072015-03-05 00:46:22 +00003485 bool HasVirtualBases = false;
3486 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
David Majnemer7c237072015-03-05 00:46:22 +00003487 QualType PointeeType = T;
3488 if (T->isPointerType())
3489 PointeeType = T->getPointeeType();
3490 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
3491 HasVirtualBases = RD->getNumVBases() > 0;
3492 if (IdentifierInfo *II = RD->getIdentifier())
3493 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
3494 }
3495
3496 // Encode the relevant CatchableType properties into the Flags bitfield.
3497 // FIXME: Figure out how bits 2 or 8 can get set.
3498 uint32_t Flags = 0;
3499 if (IsScalar)
3500 Flags |= 1;
3501 if (HasVirtualBases)
3502 Flags |= 4;
3503 if (IsStdBadAlloc)
3504 Flags |= 16;
3505
3506 llvm::Constant *Fields[] = {
3507 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
3508 TD, // TypeDescriptor
3509 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment
3510 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
3511 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex
3512 llvm::ConstantInt::get(CGM.IntTy, Size), // Size
3513 CopyCtor // CopyCtor
3514 };
3515 llvm::StructType *CTType = getCatchableTypeType();
3516 auto *GV = new llvm::GlobalVariable(
3517 CGM.getModule(), CTType, /*Constant=*/true, getLinkageForRTTI(T),
3518 llvm::ConstantStruct::get(CTType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00003519 GV->setUnnamedAddr(true);
3520 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00003521 if (GV->isWeakForLinker())
3522 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00003523 return getImageRelativeConstant(GV);
3524}
3525
3526llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
3527 assert(!T->isReferenceType());
3528
3529 // See if we've already generated a CatchableTypeArray for this type before.
3530 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
3531 if (CTA)
3532 return CTA;
3533
3534 // Ensure that we don't have duplicate entries in our CatchableTypeArray by
3535 // using a SmallSetVector. Duplicates may arise due to virtual bases
3536 // occurring more than once in the hierarchy.
3537 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
3538
3539 // C++14 [except.handle]p3:
3540 // A handler is a match for an exception object of type E if [...]
3541 // - the handler is of type cv T or cv T& and T is an unambiguous public
3542 // base class of E, or
3543 // - the handler is of type cv T or const T& where T is a pointer type and
3544 // E is a pointer type that can be converted to T by [...]
3545 // - a standard pointer conversion (4.10) not involving conversions to
3546 // pointers to private or protected or ambiguous classes
3547 const CXXRecordDecl *MostDerivedClass = nullptr;
3548 bool IsPointer = T->isPointerType();
3549 if (IsPointer)
3550 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
3551 else
3552 MostDerivedClass = T->getAsCXXRecordDecl();
3553
3554 // Collect all the unambiguous public bases of the MostDerivedClass.
3555 if (MostDerivedClass) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00003556 const ASTContext &Context = getContext();
David Majnemer7c237072015-03-05 00:46:22 +00003557 const ASTRecordLayout &MostDerivedLayout =
3558 Context.getASTRecordLayout(MostDerivedClass);
3559 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
3560 SmallVector<MSRTTIClass, 8> Classes;
3561 serializeClassHierarchy(Classes, MostDerivedClass);
3562 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3563 detectAmbiguousBases(Classes);
3564 for (const MSRTTIClass &Class : Classes) {
3565 // Skip any ambiguous or private bases.
3566 if (Class.Flags &
3567 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
3568 continue;
3569 // Write down how to convert from a derived pointer to a base pointer.
3570 uint32_t OffsetInVBTable = 0;
3571 int32_t VBPtrOffset = -1;
3572 if (Class.VirtualRoot) {
3573 OffsetInVBTable =
3574 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
3575 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
3576 }
3577
3578 // Turn our record back into a pointer if the exception object is a
3579 // pointer.
3580 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
3581 if (IsPointer)
3582 RTTITy = Context.getPointerType(RTTITy);
3583 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
3584 VBPtrOffset, OffsetInVBTable));
3585 }
3586 }
3587
3588 // C++14 [except.handle]p3:
3589 // A handler is a match for an exception object of type E if
3590 // - The handler is of type cv T or cv T& and E and T are the same type
3591 // (ignoring the top-level cv-qualifiers)
3592 CatchableTypes.insert(getCatchableType(T));
3593
3594 // C++14 [except.handle]p3:
3595 // A handler is a match for an exception object of type E if
3596 // - the handler is of type cv T or const T& where T is a pointer type and
3597 // E is a pointer type that can be converted to T by [...]
3598 // - a standard pointer conversion (4.10) not involving conversions to
3599 // pointers to private or protected or ambiguous classes
3600 //
David Majnemerf205f532015-04-04 05:37:48 +00003601 // C++14 [conv.ptr]p2:
3602 // A prvalue of type "pointer to cv T," where T is an object type, can be
3603 // converted to a prvalue of type "pointer to cv void".
3604 if (IsPointer && T->getPointeeType()->isObjectType())
David Majnemer7c237072015-03-05 00:46:22 +00003605 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
3606
David Majnemera1aea9a2015-03-12 17:44:49 +00003607 // C++14 [except.handle]p3:
3608 // A handler is a match for an exception object of type E if [...]
3609 // - the handler is of type cv T or const T& where T is a pointer or
3610 // pointer to member type and E is std::nullptr_t.
3611 //
3612 // We cannot possibly list all possible pointer types here, making this
3613 // implementation incompatible with the standard. However, MSVC includes an
3614 // entry for pointer-to-void in this case. Let's do the same.
3615 if (T->isNullPtrType())
3616 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
3617
David Majnemer7c237072015-03-05 00:46:22 +00003618 uint32_t NumEntries = CatchableTypes.size();
3619 llvm::Type *CTType =
3620 getImageRelativeType(getCatchableTypeType()->getPointerTo());
3621 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
3622 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
3623 llvm::Constant *Fields[] = {
3624 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries
3625 llvm::ConstantArray::get(
3626 AT, llvm::makeArrayRef(CatchableTypes.begin(),
3627 CatchableTypes.end())) // CatchableTypes
3628 };
3629 SmallString<256> MangledName;
3630 {
3631 llvm::raw_svector_ostream Out(MangledName);
3632 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
3633 }
3634 CTA = new llvm::GlobalVariable(
3635 CGM.getModule(), CTAType, /*Constant=*/true, getLinkageForRTTI(T),
3636 llvm::ConstantStruct::get(CTAType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00003637 CTA->setUnnamedAddr(true);
3638 CTA->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00003639 if (CTA->isWeakForLinker())
3640 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00003641 return CTA;
3642}
3643
3644llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
David Majnemerad803d42015-03-15 07:10:01 +00003645 bool IsConst, IsVolatile;
3646 T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile);
David Majnemer7c237072015-03-05 00:46:22 +00003647
3648 // The CatchableTypeArray enumerates the various (CV-unqualified) types that
3649 // the exception object may be caught as.
3650 llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
3651 // The first field in a CatchableTypeArray is the number of CatchableTypes.
3652 // This is used as a component of the mangled name which means that we need to
3653 // know what it is in order to see if we have previously generated the
3654 // ThrowInfo.
3655 uint32_t NumEntries =
3656 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
3657 ->getLimitedValue();
3658
3659 SmallString<256> MangledName;
3660 {
3661 llvm::raw_svector_ostream Out(MangledName);
3662 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, NumEntries,
3663 Out);
3664 }
3665
3666 // Reuse a previously generated ThrowInfo if we have generated an appropriate
3667 // one before.
3668 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3669 return GV;
3670
3671 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
3672 // be at least as CV qualified. Encode this requirement into the Flags
3673 // bitfield.
3674 uint32_t Flags = 0;
3675 if (IsConst)
3676 Flags |= 1;
3677 if (IsVolatile)
3678 Flags |= 2;
3679
3680 // The cleanup-function (a destructor) must be called when the exception
3681 // object's lifetime ends.
3682 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
3683 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
3684 if (CXXDestructorDecl *DtorD = RD->getDestructor())
3685 if (!DtorD->isTrivial())
3686 CleanupFn = llvm::ConstantExpr::getBitCast(
3687 CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete),
3688 CGM.Int8PtrTy);
3689 // This is unused as far as we can tell, initialize it to null.
3690 llvm::Constant *ForwardCompat =
3691 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
3692 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
3693 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
3694 llvm::StructType *TIType = getThrowInfoType();
3695 llvm::Constant *Fields[] = {
3696 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
3697 getImageRelativeConstant(CleanupFn), // CleanupFn
3698 ForwardCompat, // ForwardCompat
3699 PointerToCatchableTypes // CatchableTypeArray
3700 };
3701 auto *GV = new llvm::GlobalVariable(
3702 CGM.getModule(), TIType, /*Constant=*/true, getLinkageForRTTI(T),
3703 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00003704 GV->setUnnamedAddr(true);
3705 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00003706 if (GV->isWeakForLinker())
3707 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00003708 return GV;
3709}
3710
3711void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
3712 const Expr *SubExpr = E->getSubExpr();
3713 QualType ThrowType = SubExpr->getType();
3714 // The exception object lives on the stack and it's address is passed to the
3715 // runtime function.
3716 llvm::AllocaInst *AI = CGF.CreateMemTemp(ThrowType);
3717 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
3718 /*IsInit=*/true);
3719
3720 // The so-called ThrowInfo is used to describe how the exception object may be
3721 // caught.
3722 llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
3723
3724 // Call into the runtime to throw the exception.
3725 llvm::Value *Args[] = {CGF.Builder.CreateBitCast(AI, CGM.Int8PtrTy), TI};
3726 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
3727}