blob: 6417b87444d32ea5fcc041671c8ad781650c5660 [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 Majnemer5f0dd612015-03-17 20:35:05 +000048 ThrowInfoType(nullptr), HandlerMapEntryType(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 *
88 getAddrOfCXXHandlerMapEntry(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 Majnemer5f0dd612015-03-17 20:35:05 +0000576 llvm::StructType *getHandlerMapEntryType() {
577 if (!HandlerMapEntryType) {
578 llvm::Type *FieldTypes[] = {
579 CGM.IntTy, // Flags
580 getImageRelativeType(CGM.Int8PtrTy), // TypeDescriptor
581 };
582 HandlerMapEntryType = llvm::StructType::create(
583 CGM.getLLVMContext(), FieldTypes, "eh.HandlerMapEntry");
584 }
585 return HandlerMapEntryType;
586 }
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 Majnemer5f0dd612015-03-17 20:35:05 +0000701 llvm::StructType *HandlerMapEntryType;
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());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001124 llvm::Value *GVPtr = CGF.Builder.CreateConstInBoundsGEP2_32(GV, 0, 0);
1125 VBPtr = CGF.Builder.CreateBitCast(VBPtr, GVPtr->getType()->getPointerTo(0),
Reid Kleckner5f080942014-01-03 23:42:00 +00001126 "vbptr." + VBT->ReusingBase->getName());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001127 CGF.Builder.CreateStore(GVPtr, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +00001128 }
1129}
1130
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001131void
1132MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001133 SmallVectorImpl<CanQualType> &ArgTys) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001134 // TODO: 'for base' flag
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001135 if (T == StructorType::Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001136 // The scalar deleting destructor takes an implicit int parameter.
David Majnemer9ced3dd2015-03-14 23:44:48 +00001137 ArgTys.push_back(getContext().IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001138 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001139 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
1140 if (!CD)
1141 return;
1142
1143 // All parameters are already in place except is_most_derived, which goes
1144 // after 'this' if it's variadic and last if it's not.
1145
1146 const CXXRecordDecl *Class = CD->getParent();
1147 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1148 if (Class->getNumVBases()) {
1149 if (FPT->isVariadic())
David Majnemer9ced3dd2015-03-14 23:44:48 +00001150 ArgTys.insert(ArgTys.begin() + 1, getContext().IntTy);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001151 else
David Majnemer9ced3dd2015-03-14 23:44:48 +00001152 ArgTys.push_back(getContext().IntTy);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001153 }
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001154}
1155
Reid Klecknere7de47e2013-07-22 13:51:44 +00001156void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1157 // The TU defining a dtor is only guaranteed to emit a base destructor. All
1158 // other destructor variants are delegating thunks.
1159 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1160}
1161
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001162CharUnits
1163MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001164 GD = GD.getCanonicalDecl();
1165 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001166
1167 GlobalDecl LookupGD = GD;
1168 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1169 // Complete destructors take a pointer to the complete object as a
1170 // parameter, thus don't need this adjustment.
1171 if (GD.getDtorType() == Dtor_Complete)
1172 return CharUnits();
1173
1174 // There's no Dtor_Base in vftable but it shares the this adjustment with
1175 // the deleting one, so look it up instead.
1176 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1177 }
1178
1179 MicrosoftVTableContext::MethodVFTableLocation ML =
1180 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
1181 CharUnits Adjustment = ML.VFPtrOffset;
1182
1183 // Normal virtual instance methods need to adjust from the vfptr that first
1184 // defined the virtual method to the virtual base subobject, but destructors
1185 // do not. The vector deleting destructor thunk applies this adjustment for
1186 // us if necessary.
1187 if (isa<CXXDestructorDecl>(MD))
1188 Adjustment = CharUnits::Zero();
1189
1190 if (ML.VBase) {
1191 const ASTRecordLayout &DerivedLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001192 getContext().getASTRecordLayout(MD->getParent());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001193 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1194 }
1195
1196 return Adjustment;
1197}
1198
1199llvm::Value *MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1200 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This, bool VirtualCall) {
1201 if (!VirtualCall) {
1202 // If the call of a virtual function is not virtual, we just have to
1203 // compensate for the adjustment the virtual function does in its prologue.
1204 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1205 if (Adjustment.isZero())
1206 return This;
1207
1208 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1209 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS);
1210 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1211 assert(Adjustment.isPositive());
1212 return CGF.Builder.CreateConstGEP1_32(This, Adjustment.getQuantity());
1213 }
1214
1215 GD = GD.getCanonicalDecl();
1216 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001217
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001218 GlobalDecl LookupGD = GD;
1219 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1220 // Complete dtors take a pointer to the complete object,
1221 // thus don't need adjustment.
1222 if (GD.getDtorType() == Dtor_Complete)
1223 return This;
1224
1225 // There's only Dtor_Deleting in vftable but it shares the this adjustment
1226 // with the base one, so look up the deleting one instead.
1227 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1228 }
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001229 MicrosoftVTableContext::MethodVFTableLocation ML =
1230 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001231
1232 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1233 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS);
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001234 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001235
1236 // Base destructors expect 'this' to point to the beginning of the base
1237 // subobject, not the first vfptr that happens to contain the virtual dtor.
1238 // However, we still need to apply the virtual base adjustment.
1239 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1240 StaticOffset = CharUnits::Zero();
1241
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001242 if (ML.VBase) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001243 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1244 llvm::Value *VBaseOffset =
1245 GetVirtualBaseClassOffset(CGF, This, MD->getParent(), ML.VBase);
1246 This = CGF.Builder.CreateInBoundsGEP(This, VBaseOffset);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001247 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001248 if (!StaticOffset.isZero()) {
1249 assert(StaticOffset.isPositive());
1250 This = CGF.Builder.CreateBitCast(This, charPtrTy);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001251 if (ML.VBase) {
1252 // Non-virtual adjustment might result in a pointer outside the allocated
1253 // object, e.g. if the final overrider class is laid out after the virtual
1254 // base that declares a method in the most derived class.
1255 // FIXME: Update the code that emits this adjustment in thunks prologues.
1256 This = CGF.Builder.CreateConstGEP1_32(This, StaticOffset.getQuantity());
1257 } else {
1258 This = CGF.Builder.CreateConstInBoundsGEP1_32(This,
1259 StaticOffset.getQuantity());
1260 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001261 }
1262 return This;
1263}
1264
Reid Kleckner89077a12013-12-17 19:46:40 +00001265void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1266 QualType &ResTy,
1267 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001268 ASTContext &Context = getContext();
1269 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001270 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001271 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1272 ImplicitParamDecl *IsMostDerived
Craig Topper8a13c412014-05-21 05:09:00 +00001273 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001274 CGF.CurGD.getDecl()->getLocation(),
1275 &Context.Idents.get("is_most_derived"),
1276 Context.IntTy);
Reid Kleckner89077a12013-12-17 19:46:40 +00001277 // The 'most_derived' parameter goes second if the ctor is variadic and last
1278 // if it's not. Dtors can't be variadic.
1279 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1280 if (FPT->isVariadic())
1281 Params.insert(Params.begin() + 1, IsMostDerived);
1282 else
1283 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001284 getStructorImplicitParamDecl(CGF) = IsMostDerived;
David Majnemer0c0b6d92014-10-31 20:09:12 +00001285 } else if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001286 ImplicitParamDecl *ShouldDelete
Craig Topper8a13c412014-05-21 05:09:00 +00001287 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001288 CGF.CurGD.getDecl()->getLocation(),
1289 &Context.Idents.get("should_call_delete"),
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001290 Context.IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001291 Params.push_back(ShouldDelete);
1292 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1293 }
John McCall0f999f32012-09-25 08:00:39 +00001294}
1295
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001296llvm::Value *MicrosoftCXXABI::adjustThisParameterInVirtualFunctionPrologue(
1297 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001298 // In this ABI, every virtual function takes a pointer to one of the
1299 // subobjects that first defines it as the 'this' parameter, rather than a
Alp Tokerf6a24ce2013-12-05 16:25:25 +00001300 // pointer to the final overrider subobject. Thus, we need to adjust it back
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001301 // to the final overrider subobject before use.
1302 // See comments in the MicrosoftVFTableContext implementation for the details.
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001303 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001304 if (Adjustment.isZero())
1305 return This;
1306
1307 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1308 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1309 *thisTy = This->getType();
1310
1311 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1312 assert(Adjustment.isPositive());
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001313 This =
1314 CGF.Builder.CreateConstInBoundsGEP1_32(This, -Adjustment.getQuantity());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001315 return CGF.Builder.CreateBitCast(This, thisTy);
1316}
1317
John McCall0f999f32012-09-25 08:00:39 +00001318void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
1319 EmitThisParam(CGF);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001320
1321 /// If this is a function that the ABI specifies returns 'this', initialize
1322 /// the return slot to 'this' at the start of the function.
1323 ///
1324 /// Unlike the setting of return types, this is done within the ABI
1325 /// implementation instead of by clients of CGCXXABI because:
1326 /// 1) getThisValue is currently protected
1327 /// 2) in theory, an ABI could implement 'this' returns some other way;
1328 /// HasThisReturn only specifies a contract, not the implementation
1329 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001330 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001331 else if (hasMostDerivedReturn(CGF.CurGD))
1332 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1333 CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001334
1335 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1336 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1337 assert(getStructorImplicitParamDecl(CGF) &&
1338 "no implicit parameter for a constructor with virtual bases?");
1339 getStructorImplicitParamValue(CGF)
1340 = CGF.Builder.CreateLoad(
1341 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1342 "is_most_derived");
1343 }
1344
David Majnemer0c0b6d92014-10-31 20:09:12 +00001345 if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001346 assert(getStructorImplicitParamDecl(CGF) &&
1347 "no implicit parameter for a deleting destructor?");
1348 getStructorImplicitParamValue(CGF)
1349 = CGF.Builder.CreateLoad(
1350 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1351 "should_call_delete");
1352 }
John McCall0f999f32012-09-25 08:00:39 +00001353}
1354
Reid Kleckner89077a12013-12-17 19:46:40 +00001355unsigned MicrosoftCXXABI::addImplicitConstructorArgs(
1356 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1357 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001358 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001359
Reid Kleckner89077a12013-12-17 19:46:40 +00001360 // Check if we need a 'most_derived' parameter.
1361 if (!D->getParent()->getNumVBases())
1362 return 0;
1363
1364 // Add the 'most_derived' argument second if we are variadic or last if not.
1365 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
1366 llvm::Value *MostDerivedArg =
1367 llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
1368 RValue RV = RValue::get(MostDerivedArg);
1369 if (MostDerivedArg) {
1370 if (FPT->isVariadic())
1371 Args.insert(Args.begin() + 1,
1372 CallArg(RV, getContext().IntTy, /*needscopy=*/false));
1373 else
1374 Args.add(RV, getContext().IntTy);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001375 }
1376
Reid Kleckner89077a12013-12-17 19:46:40 +00001377 return 1; // Added one arg.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001378}
1379
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001380void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1381 const CXXDestructorDecl *DD,
1382 CXXDtorType Type, bool ForVirtualBase,
1383 bool Delegating, llvm::Value *This) {
Rafael Espindola1ac0ec82014-09-11 15:42:06 +00001384 llvm::Value *Callee = CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type));
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001385
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001386 if (DD->isVirtual()) {
1387 assert(Type != CXXDtorType::Dtor_Deleting &&
1388 "The deleting destructor should only be called via a virtual call");
1389 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1390 This, false);
1391 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001392
David Majnemer0c0b6d92014-10-31 20:09:12 +00001393 CGF.EmitCXXStructorCall(DD, Callee, ReturnValueSlot(), This,
1394 /*ImplicitParam=*/nullptr,
1395 /*ImplicitParamTy=*/QualType(), nullptr,
1396 getFromDtorType(Type));
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001397}
1398
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001399void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1400 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001401 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001402 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001403
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001404 for (VPtrInfo *Info : VFPtrs) {
1405 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001406 if (VTable->hasInitializer())
1407 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001408
David Majnemer65f87322014-07-24 06:09:19 +00001409 llvm::Constant *RTTI = getContext().getLangOpts().RTTIData
1410 ? getMSCompleteObjectLocator(RD, Info)
1411 : nullptr;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001412
1413 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001414 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001415 llvm::Constant *Init = CGVT.CreateVTableInitializer(
1416 RD, VTLayout.vtable_component_begin(),
1417 VTLayout.getNumVTableComponents(), VTLayout.vtable_thunk_begin(),
David Majnemerd905da42014-07-01 20:30:31 +00001418 VTLayout.getNumVTableThunks(), RTTI);
1419
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001420 VTable->setInitializer(Init);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001421 }
1422}
1423
1424llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1425 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
1426 const CXXRecordDecl *NearestVBase, bool &NeedsVirtualOffset) {
Craig Topper8a13c412014-05-21 05:09:00 +00001427 NeedsVirtualOffset = (NearestVBase != nullptr);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001428
David Majnemerd905da42014-07-01 20:30:31 +00001429 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1430 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1431 llvm::GlobalValue *VTableAddressPoint = VFTablesMap[ID];
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001432 if (!VTableAddressPoint) {
1433 assert(Base.getBase()->getNumVBases() &&
David Majnemer9ced3dd2015-03-14 23:44:48 +00001434 !getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001435 }
1436 return VTableAddressPoint;
1437}
1438
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001439static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001440 const CXXRecordDecl *RD, const VPtrInfo *VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001441 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001442 llvm::raw_svector_ostream Out(Name);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001443 MangleContext.mangleCXXVFTable(RD, VFPtr->MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001444}
1445
1446llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1447 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
David Majnemerd905da42014-07-01 20:30:31 +00001448 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1449 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1450 llvm::GlobalValue *VFTable = VFTablesMap[ID];
1451 assert(VFTable && "Couldn't find a vftable for the given base?");
1452 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001453}
1454
1455llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1456 CharUnits VPtrOffset) {
1457 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1458 // shouldn't be used in the given record type. We want to cache this result in
1459 // VFTablesMap, thus a simple zero check is not sufficient.
1460 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001461 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001462 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001463 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001464 if (!Inserted)
1465 return I->second;
1466
1467 llvm::GlobalVariable *&VTable = I->second;
1468
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001469 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001470 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001471
David Blaikie82e95a32014-11-19 07:49:47 +00001472 if (DeferredVFTables.insert(RD).second) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001473 // We haven't processed this record type before.
1474 // Queue up this v-table for possible deferred emission.
1475 CGM.addDeferredVTable(RD);
1476
1477#ifndef NDEBUG
1478 // Create all the vftables at once in order to make sure each vftable has
1479 // a unique mangled name.
1480 llvm::StringSet<> ObservedMangledNames;
1481 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1482 SmallString<256> Name;
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001483 mangleVFTableName(getMangleContext(), RD, VFPtrs[J], Name);
David Blaikie61b86d42014-11-19 02:56:13 +00001484 if (!ObservedMangledNames.insert(Name.str()).second)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001485 llvm_unreachable("Already saw this mangling before?");
1486 }
1487#endif
1488 }
1489
1490 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001491 if (VFPtrs[J]->FullOffsetInMDC != VPtrOffset)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001492 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001493 SmallString<256> VFTableName;
1494 mangleVFTableName(getMangleContext(), RD, VFPtrs[J], VFTableName);
1495 StringRef VTableName = VFTableName;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001496
David Majnemerd905da42014-07-01 20:30:31 +00001497 uint64_t NumVTableSlots =
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001498 VTContext.getVFTableLayout(RD, VFPtrs[J]->FullOffsetInMDC)
David Majnemerd905da42014-07-01 20:30:31 +00001499 .getNumVTableComponents();
1500 llvm::GlobalValue::LinkageTypes VTableLinkage =
1501 llvm::GlobalValue::ExternalLinkage;
1502 llvm::ArrayType *VTableType =
1503 llvm::ArrayType::get(CGM.Int8PtrTy, NumVTableSlots);
David Majnemerf6072342014-07-01 22:24:56 +00001504 if (getContext().getLangOpts().RTTIData) {
David Majnemerd905da42014-07-01 20:30:31 +00001505 VTableLinkage = llvm::GlobalValue::PrivateLinkage;
1506 VTableName = "";
1507 }
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001508
David Majnemerd905da42014-07-01 20:30:31 +00001509 VTable = CGM.getModule().getNamedGlobal(VFTableName);
1510 if (!VTable) {
David Majnemerbb848712014-07-01 22:37:08 +00001511 // Create a backing variable for the contents of VTable. The VTable may
1512 // or may not include space for a pointer to RTTI data.
David Majnemerd905da42014-07-01 20:30:31 +00001513 llvm::GlobalValue *VFTable = VTable = new llvm::GlobalVariable(
1514 CGM.getModule(), VTableType, /*isConstant=*/true, VTableLinkage,
1515 /*Initializer=*/nullptr, VTableName);
1516 VTable->setUnnamedAddr(true);
David Majnemerbb848712014-07-01 22:37:08 +00001517
1518 // Only insert a pointer into the VFTable for RTTI data if we are not
1519 // importing it. We never reference the RTTI data directly so there is no
1520 // need to make room for it.
David Majnemerf6072342014-07-01 22:24:56 +00001521 if (getContext().getLangOpts().RTTIData &&
1522 !RD->hasAttr<DLLImportAttr>()) {
David Majnemerd905da42014-07-01 20:30:31 +00001523 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
1524 llvm::ConstantInt::get(CGM.IntTy, 1)};
David Majnemerbb848712014-07-01 22:37:08 +00001525 // Create a GEP which points just after the first entry in the VFTable,
1526 // this should be the location of the first virtual method.
David Majnemerd905da42014-07-01 20:30:31 +00001527 llvm::Constant *VTableGEP =
1528 llvm::ConstantExpr::getInBoundsGetElementPtr(VTable, GEPIndices);
David Majnemerbb848712014-07-01 22:37:08 +00001529 // The symbol for the VFTable is an alias to the GEP. It is
1530 // transparent, to other modules, what the nature of this symbol is; all
1531 // that matters is that the alias be the address of the first virtual
1532 // method.
David Majnemerd905da42014-07-01 20:30:31 +00001533 VFTable = llvm::GlobalAlias::create(
1534 cast<llvm::SequentialType>(VTableGEP->getType())->getElementType(),
1535 /*AddressSpace=*/0, llvm::GlobalValue::ExternalLinkage,
1536 VFTableName.str(), VTableGEP, &CGM.getModule());
1537 } else {
David Majnemerbb848712014-07-01 22:37:08 +00001538 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1539 // be referencing any RTTI data. The GlobalVariable will end up being
1540 // an appropriate definition of the VFTable.
David Majnemerd905da42014-07-01 20:30:31 +00001541 VTable->setName(VFTableName.str());
1542 }
1543
1544 VFTable->setUnnamedAddr(true);
1545 if (RD->hasAttr<DLLImportAttr>())
1546 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1547 else if (RD->hasAttr<DLLExportAttr>())
1548 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1549
1550 llvm::GlobalValue::LinkageTypes VFTableLinkage = CGM.getVTableLinkage(RD);
1551 if (VFTable != VTable) {
1552 if (llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage)) {
1553 // AvailableExternally implies that we grabbed the data from another
1554 // executable. No need to stick the alias in a Comdat.
David Majnemerb2615aa2014-07-13 05:19:56 +00001555 } else if (llvm::GlobalValue::isInternalLinkage(VFTableLinkage) ||
1556 llvm::GlobalValue::isWeakODRLinkage(VFTableLinkage) ||
David Majnemerd905da42014-07-01 20:30:31 +00001557 llvm::GlobalValue::isLinkOnceODRLinkage(VFTableLinkage)) {
1558 // The alias is going to be dropped into a Comdat, no need to make it
1559 // weak.
David Majnemerb2615aa2014-07-13 05:19:56 +00001560 if (!llvm::GlobalValue::isInternalLinkage(VFTableLinkage))
1561 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
David Majnemerd905da42014-07-01 20:30:31 +00001562 llvm::Comdat *C =
1563 CGM.getModule().getOrInsertComdat(VFTable->getName());
David Majnemerbb848712014-07-01 22:37:08 +00001564 // We must indicate which VFTable is larger to support linking between
1565 // translation units which do and do not have RTTI data. The largest
1566 // VFTable contains the RTTI data; translation units which reference
1567 // the smaller VFTable always reference it relative to the first
1568 // virtual method.
David Majnemerd905da42014-07-01 20:30:31 +00001569 C->setSelectionKind(llvm::Comdat::Largest);
1570 VTable->setComdat(C);
1571 } else {
1572 llvm_unreachable("unexpected linkage for vftable!");
1573 }
Rafael Espindola4af2cdb2015-01-16 21:41:44 +00001574 } else {
1575 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage))
1576 VTable->setComdat(
1577 CGM.getModule().getOrInsertComdat(VTable->getName()));
David Majnemerd905da42014-07-01 20:30:31 +00001578 }
1579 VFTable->setLinkage(VFTableLinkage);
1580 CGM.setGlobalVisibility(VFTable, RD);
1581 VFTablesMap[ID] = VFTable;
1582 }
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001583 break;
1584 }
1585
1586 return VTable;
1587}
1588
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001589llvm::Value *MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1590 GlobalDecl GD,
1591 llvm::Value *This,
1592 llvm::Type *Ty) {
1593 GD = GD.getCanonicalDecl();
1594 CGBuilderTy &Builder = CGF.Builder;
1595
1596 Ty = Ty->getPointerTo()->getPointerTo();
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001597 llvm::Value *VPtr =
1598 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001599 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty);
1600
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001601 MicrosoftVTableContext::MethodVFTableLocation ML =
1602 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001603 llvm::Value *VFuncPtr =
1604 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1605 return Builder.CreateLoad(VFuncPtr);
1606}
1607
David Majnemer0c0b6d92014-10-31 20:09:12 +00001608llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1609 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
1610 llvm::Value *This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001611 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001612 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1613
1614 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001615 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001616 GlobalDecl GD(Dtor, Dtor_Deleting);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001617 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1618 Dtor, StructorType::Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001619 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001620 llvm::Value *Callee = getVirtualFunctionPointer(CGF, GD, This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001621
David Majnemer9ced3dd2015-03-14 23:44:48 +00001622 ASTContext &Context = getContext();
Nico Weber0a029922015-01-12 21:24:10 +00001623 llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1624 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1625 DtorType == Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001626
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001627 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001628 RValue RV = CGF.EmitCXXStructorCall(Dtor, Callee, ReturnValueSlot(), This,
1629 ImplicitParam, Context.IntTy, CE,
1630 StructorType::Deleting);
1631 return RV.getScalarVal();
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001632}
1633
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001634const VBTableGlobals &
1635MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001636 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001637 // easier than caching each vbtable individually.
1638 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1639 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001640 std::tie(Entry, Added) =
1641 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001642 VBTableGlobals &VBGlobals = Entry->second;
1643 if (!Added)
1644 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001645
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001646 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1647 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001648
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001649 // Cache the globals for all vbtables so we don't have to recompute the
1650 // mangled names.
1651 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001652 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1653 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001654 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001655 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001656 }
1657
1658 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001659}
1660
Reid Klecknere4a52202014-02-21 02:27:32 +00001661llvm::Function *MicrosoftCXXABI::EmitVirtualMemPtrThunk(
1662 const CXXMethodDecl *MD,
1663 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001664 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1665 "can't form pointers to ctors or virtual dtors");
1666
Reid Klecknere4a52202014-02-21 02:27:32 +00001667 // Calculate the mangled name.
1668 SmallString<256> ThunkName;
1669 llvm::raw_svector_ostream Out(ThunkName);
1670 getMangleContext().mangleVirtualMemPtrThunk(MD, Out);
1671 Out.flush();
1672
Hans Wennborg88497d62013-11-15 17:24:45 +00001673 // If the thunk has been generated previously, just return it.
1674 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1675 return cast<llvm::Function>(GV);
1676
1677 // Create the llvm::Function.
Reid Klecknerc3473512014-08-29 21:43:29 +00001678 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSMemberPointerThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00001679 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1680 llvm::Function *ThunkFn =
1681 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1682 ThunkName.str(), &CGM.getModule());
1683 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1684
Hans Wennborg88497d62013-11-15 17:24:45 +00001685 ThunkFn->setLinkage(MD->isExternallyVisible()
1686 ? llvm::GlobalValue::LinkOnceODRLinkage
1687 : llvm::GlobalValue::InternalLinkage);
David Majnemer8c9cdb62015-01-21 01:21:31 +00001688 if (MD->isExternallyVisible())
1689 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
Hans Wennborg88497d62013-11-15 17:24:45 +00001690
1691 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1692 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1693
Reid Kleckner9da94482015-01-21 22:18:17 +00001694 // Add the "thunk" attribute so that LLVM knows that the return type is
1695 // meaningless. These thunks can be used to call functions with differing
1696 // return types, and the caller is required to cast the prototype
1697 // appropriately to extract the correct value.
1698 ThunkFn->addFnAttr("thunk");
1699
Reid Klecknerb9538a62014-08-15 18:12:40 +00001700 // These thunks can be compared, so they are not unnamed.
1701 ThunkFn->setUnnamedAddr(false);
1702
Hans Wennborg88497d62013-11-15 17:24:45 +00001703 // Start codegen.
1704 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00001705 CGF.CurGD = GlobalDecl(MD);
1706 CGF.CurFuncIsThunk = true;
1707
1708 // Build FunctionArgs, but only include the implicit 'this' parameter
1709 // declaration.
1710 FunctionArgList FunctionArgs;
1711 buildThisParam(CGF, FunctionArgs);
1712
1713 // Start defining the function.
1714 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
1715 FunctionArgs, MD->getLocation(), SourceLocation());
1716 EmitThisParam(CGF);
Hans Wennborg88497d62013-11-15 17:24:45 +00001717
Reid Klecknere4a52202014-02-21 02:27:32 +00001718 // Load the vfptr and then callee from the vftable. The callee should have
1719 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00001720 llvm::Value *VTable = CGF.GetVTablePtr(
1721 getThisValue(CGF), ThunkTy->getPointerTo()->getPointerTo());
Reid Klecknere4a52202014-02-21 02:27:32 +00001722 llvm::Value *VFuncPtr =
1723 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1724 llvm::Value *Callee = CGF.Builder.CreateLoad(VFuncPtr);
Hans Wennborg88497d62013-11-15 17:24:45 +00001725
Reid Klecknerc3473512014-08-29 21:43:29 +00001726 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee);
Hans Wennborg88497d62013-11-15 17:24:45 +00001727
1728 return ThunkFn;
1729}
1730
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001731void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001732 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1733 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001734 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001735 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
David Majnemer129f4172015-02-02 10:22:20 +00001736 if (GV->isDeclaration())
1737 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00001738 }
1739}
1740
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001741llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001742MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001743 llvm::GlobalVariable::LinkageTypes Linkage) {
1744 SmallString<256> OutName;
1745 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00001746 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001747 Out.flush();
1748 StringRef Name = OutName.str();
1749
1750 llvm::ArrayType *VBTableType =
1751 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ReusingBase->getNumVBases());
1752
1753 assert(!CGM.getModule().getNamedGlobal(Name) &&
1754 "vbtable with this name already exists: mangling bug?");
1755 llvm::GlobalVariable *GV =
1756 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
1757 GV->setUnnamedAddr(true);
Hans Wennborg853ae942014-05-30 16:59:42 +00001758
1759 if (RD->hasAttr<DLLImportAttr>())
1760 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1761 else if (RD->hasAttr<DLLExportAttr>())
1762 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1763
David Majnemer129f4172015-02-02 10:22:20 +00001764 if (!GV->hasExternalLinkage())
1765 emitVBTableDefinition(VBT, RD, GV);
1766
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001767 return GV;
1768}
1769
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001770void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001771 const CXXRecordDecl *RD,
1772 llvm::GlobalVariable *GV) const {
1773 const CXXRecordDecl *ReusingBase = VBT.ReusingBase;
1774
1775 assert(RD->getNumVBases() && ReusingBase->getNumVBases() &&
1776 "should only emit vbtables for classes with vbtables");
1777
1778 const ASTRecordLayout &BaseLayout =
David Majnemer9ced3dd2015-03-14 23:44:48 +00001779 getContext().getASTRecordLayout(VBT.BaseWithVPtr);
1780 const ASTRecordLayout &DerivedLayout = getContext().getASTRecordLayout(RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001781
Craig Topper8a13c412014-05-21 05:09:00 +00001782 SmallVector<llvm::Constant *, 4> Offsets(1 + ReusingBase->getNumVBases(),
1783 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001784
1785 // The offset from ReusingBase's vbptr to itself always leads.
1786 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
1787 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
1788
1789 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Aaron Ballman445a9392014-03-13 16:15:17 +00001790 for (const auto &I : ReusingBase->vbases()) {
1791 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001792 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
1793 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00001794
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001795 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00001796 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001797 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00001798 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001799 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00001800 Offset -= CompleteVBPtrOffset;
1801
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001802 unsigned VBIndex = Context.getVBTableIndex(ReusingBase, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00001803 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001804 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
1805 }
1806
1807 assert(Offsets.size() ==
1808 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
1809 ->getElementType())->getNumElements());
1810 llvm::ArrayType *VBTableType =
1811 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
1812 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
1813 GV->setInitializer(Init);
1814
1815 // Set the right visibility.
John McCall8f80a612014-02-08 00:41:16 +00001816 CGM.setGlobalVisibility(GV, RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001817}
1818
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001819llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
1820 llvm::Value *This,
1821 const ThisAdjustment &TA) {
1822 if (TA.isEmpty())
1823 return This;
1824
1825 llvm::Value *V = CGF.Builder.CreateBitCast(This, CGF.Int8PtrTy);
1826
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00001827 if (!TA.Virtual.isEmpty()) {
1828 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
1829 // Adjust the this argument based on the vtordisp value.
1830 llvm::Value *VtorDispPtr =
1831 CGF.Builder.CreateConstGEP1_32(V, TA.Virtual.Microsoft.VtordispOffset);
1832 VtorDispPtr =
1833 CGF.Builder.CreateBitCast(VtorDispPtr, CGF.Int32Ty->getPointerTo());
1834 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
1835 V = CGF.Builder.CreateGEP(V, CGF.Builder.CreateNeg(VtorDisp));
1836
1837 if (TA.Virtual.Microsoft.VBPtrOffset) {
1838 // If the final overrider is defined in a virtual base other than the one
1839 // that holds the vfptr, we have to use a vtordispex thunk which looks up
1840 // the vbtable of the derived class.
1841 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
1842 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
1843 llvm::Value *VBPtr;
1844 llvm::Value *VBaseOffset =
1845 GetVBaseOffsetFromVBPtr(CGF, V, -TA.Virtual.Microsoft.VBPtrOffset,
1846 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
1847 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
1848 }
1849 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001850
1851 if (TA.NonVirtual) {
1852 // Non-virtual adjustment might result in a pointer outside the allocated
1853 // object, e.g. if the final overrider class is laid out after the virtual
1854 // base that declares a method in the most derived class.
1855 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
1856 }
1857
1858 // Don't need to bitcast back, the call CodeGen will handle this.
1859 return V;
1860}
1861
1862llvm::Value *
1863MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
1864 const ReturnAdjustment &RA) {
1865 if (RA.isEmpty())
1866 return Ret;
1867
1868 llvm::Value *V = CGF.Builder.CreateBitCast(Ret, CGF.Int8PtrTy);
1869
1870 if (RA.Virtual.Microsoft.VBIndex) {
1871 assert(RA.Virtual.Microsoft.VBIndex > 0);
David Majnemer9ced3dd2015-03-14 23:44:48 +00001872 const ASTContext &Context = getContext();
1873 int32_t IntSize = Context.getTypeSizeInChars(Context.IntTy).getQuantity();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001874 llvm::Value *VBPtr;
1875 llvm::Value *VBaseOffset =
1876 GetVBaseOffsetFromVBPtr(CGF, V, RA.Virtual.Microsoft.VBPtrOffset,
1877 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
1878 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
1879 }
1880
1881 if (RA.NonVirtual)
1882 V = CGF.Builder.CreateConstInBoundsGEP1_32(V, RA.NonVirtual);
1883
1884 // Cast back to the original type.
1885 return CGF.Builder.CreateBitCast(V, Ret->getType());
1886}
1887
John McCallb91cd662012-05-01 05:23:51 +00001888bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
1889 QualType elementType) {
1890 // Microsoft seems to completely ignore the possibility of a
1891 // two-argument usual deallocation function.
1892 return elementType.isDestructedType();
1893}
1894
1895bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
1896 // Microsoft seems to completely ignore the possibility of a
1897 // two-argument usual deallocation function.
1898 return expr->getAllocatedType().isDestructedType();
1899}
1900
1901CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
1902 // The array cookie is always a size_t; we then pad that out to the
1903 // alignment of the element type.
1904 ASTContext &Ctx = getContext();
1905 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
1906 Ctx.getTypeAlignInChars(type));
1907}
1908
1909llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
1910 llvm::Value *allocPtr,
1911 CharUnits cookieSize) {
Micah Villmowea2fea22012-10-25 15:39:14 +00001912 unsigned AS = allocPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001913 llvm::Value *numElementsPtr =
1914 CGF.Builder.CreateBitCast(allocPtr, CGF.SizeTy->getPointerTo(AS));
1915 return CGF.Builder.CreateLoad(numElementsPtr);
1916}
1917
1918llvm::Value* MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
1919 llvm::Value *newPtr,
1920 llvm::Value *numElements,
1921 const CXXNewExpr *expr,
1922 QualType elementType) {
1923 assert(requiresArrayCookie(expr));
1924
1925 // The size of the cookie.
1926 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
1927
1928 // Compute an offset to the cookie.
1929 llvm::Value *cookiePtr = newPtr;
1930
1931 // Write the number of elements into the appropriate slot.
Micah Villmowea2fea22012-10-25 15:39:14 +00001932 unsigned AS = newPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001933 llvm::Value *numElementsPtr
1934 = CGF.Builder.CreateBitCast(cookiePtr, CGF.SizeTy->getPointerTo(AS));
1935 CGF.Builder.CreateStore(numElements, numElementsPtr);
1936
1937 // Finally, compute a pointer to the actual data buffer by skipping
1938 // over the cookie completely.
1939 return CGF.Builder.CreateConstInBoundsGEP1_64(newPtr,
1940 cookieSize.getQuantity());
1941}
1942
David Majnemerb3341ea2014-10-05 05:05:40 +00001943static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
1944 llvm::Constant *Dtor,
1945 llvm::Constant *Addr) {
1946 // Create a function which calls the destructor.
1947 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
1948
1949 // extern "C" int __tlregdtor(void (*f)(void));
1950 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
1951 CGF.IntTy, DtorStub->getType(), /*IsVarArg=*/false);
1952
1953 llvm::Constant *TLRegDtor =
1954 CGF.CGM.CreateRuntimeFunction(TLRegDtorTy, "__tlregdtor");
1955 if (llvm::Function *TLRegDtorFn = dyn_cast<llvm::Function>(TLRegDtor))
1956 TLRegDtorFn->setDoesNotThrow();
1957
1958 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
1959}
1960
1961void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
1962 llvm::Constant *Dtor,
1963 llvm::Constant *Addr) {
1964 if (D.getTLSKind())
1965 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
1966
1967 // The default behavior is to use atexit.
1968 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
1969}
1970
1971void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
1972 CodeGenModule &CGM,
1973 ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *>>
1974 CXXThreadLocals,
1975 ArrayRef<llvm::Function *> CXXThreadLocalInits,
1976 ArrayRef<llvm::GlobalVariable *> CXXThreadLocalInitVars) {
1977 // This will create a GV in the .CRT$XDU section. It will point to our
1978 // initialization function. The CRT will call all of these function
1979 // pointers at start-up time and, eventually, at thread-creation time.
1980 auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
1981 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
1982 CGM.getModule(), InitFunc->getType(), /*IsConstant=*/true,
1983 llvm::GlobalVariable::InternalLinkage, InitFunc,
1984 Twine(InitFunc->getName(), "$initializer$"));
1985 InitFuncPtr->setSection(".CRT$XDU");
1986 // This variable has discardable linkage, we have to add it to @llvm.used to
1987 // ensure it won't get discarded.
1988 CGM.addUsedGlobal(InitFuncPtr);
1989 return InitFuncPtr;
1990 };
1991
1992 std::vector<llvm::Function *> NonComdatInits;
1993 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
1994 llvm::GlobalVariable *GV = CXXThreadLocalInitVars[I];
1995 llvm::Function *F = CXXThreadLocalInits[I];
1996
1997 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00001998 if (llvm::Comdat *C = GV->getComdat())
David Majnemerb3341ea2014-10-05 05:05:40 +00001999 AddToXDU(F)->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002000 else
David Majnemerb3341ea2014-10-05 05:05:40 +00002001 NonComdatInits.push_back(F);
David Majnemerb3341ea2014-10-05 05:05:40 +00002002 }
2003
2004 if (!NonComdatInits.empty()) {
2005 llvm::FunctionType *FTy =
2006 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002007 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction(
2008 FTy, "__tls_init", SourceLocation(),
2009 /*TLS=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00002010 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
2011
2012 AddToXDU(InitFunc);
2013 }
2014}
2015
2016LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2017 const VarDecl *VD,
2018 QualType LValType) {
2019 CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
2020 return LValue();
2021}
2022
John McCallc84ed6a2012-05-01 06:13:13 +00002023void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00002024 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00002025 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00002026 // MSVC only uses guards for static locals.
2027 if (!D.isStaticLocal()) {
2028 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
2029 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
Rafael Espindola77abc3a2015-01-16 16:04:45 +00002030 llvm::Function *F = CGF.CurFn;
2031 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
2032 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
Reid Kleckner563f0e82014-05-23 21:13:45 +00002033 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2034 return;
2035 }
2036
Reid Klecknerd8110b62013-09-10 20:14:30 +00002037 // MSVC always uses an i32 bitfield to guard initialization, which is *not*
2038 // threadsafe. Since the user may be linking in inline functions compiled by
2039 // cl.exe, there's no reason to provide a false sense of security by using
2040 // critical sections here.
John McCallc84ed6a2012-05-01 06:13:13 +00002041
Richard Smithdbf74ba2013-04-14 23:01:42 +00002042 if (D.getTLSKind())
2043 CGM.ErrorUnsupported(&D, "dynamic TLS initialization");
2044
Reid Klecknerd8110b62013-09-10 20:14:30 +00002045 CGBuilderTy &Builder = CGF.Builder;
2046 llvm::IntegerType *GuardTy = CGF.Int32Ty;
2047 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
2048
2049 // Get the guard variable for this function if we have one already.
Reid Kleckner563f0e82014-05-23 21:13:45 +00002050 GuardInfo *GI = &GuardVariableMap[D.getDeclContext()];
Reid Klecknerd8110b62013-09-10 20:14:30 +00002051
2052 unsigned BitIndex;
Reid Klecknere9591b32014-04-23 18:22:11 +00002053 if (D.isStaticLocal() && D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002054 // Externally visible variables have to be numbered in Sema to properly
2055 // handle unreachable VarDecls.
David Majnemer2206bf52014-03-05 08:57:59 +00002056 BitIndex = getContext().getStaticLocalNumber(&D);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002057 assert(BitIndex > 0);
2058 BitIndex--;
2059 } else {
2060 // Non-externally visible variables are numbered here in CodeGen.
Reid Klecknere9591b32014-04-23 18:22:11 +00002061 BitIndex = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002062 }
2063
2064 if (BitIndex >= 32) {
2065 if (D.isExternallyVisible())
2066 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
2067 BitIndex %= 32;
Craig Topper8a13c412014-05-21 05:09:00 +00002068 GI->Guard = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002069 }
2070
2071 // Lazily create the i32 bitfield for this function.
Reid Klecknere9591b32014-04-23 18:22:11 +00002072 if (!GI->Guard) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002073 // Mangle the name for the guard.
2074 SmallString<256> GuardName;
2075 {
2076 llvm::raw_svector_ostream Out(GuardName);
2077 getMangleContext().mangleStaticGuardVariable(&D, Out);
2078 Out.flush();
2079 }
2080
Hans Wennborgef2272c2014-06-18 15:55:13 +00002081 // Create the guard variable with a zero-initializer. Just absorb linkage,
2082 // visibility and dll storage class from the guarded variable.
Reid Klecknere9591b32014-04-23 18:22:11 +00002083 GI->Guard =
2084 new llvm::GlobalVariable(CGM.getModule(), GuardTy, false,
2085 GV->getLinkage(), Zero, GuardName.str());
2086 GI->Guard->setVisibility(GV->getVisibility());
Hans Wennborgef2272c2014-06-18 15:55:13 +00002087 GI->Guard->setDLLStorageClass(GV->getDLLStorageClass());
David Majnemer3072fc82015-01-21 01:04:30 +00002088 if (GI->Guard->isWeakForLinker())
2089 GI->Guard->setComdat(
2090 CGM.getModule().getOrInsertComdat(GI->Guard->getName()));
Reid Klecknerd8110b62013-09-10 20:14:30 +00002091 } else {
Reid Klecknere9591b32014-04-23 18:22:11 +00002092 assert(GI->Guard->getLinkage() == GV->getLinkage() &&
Reid Klecknerd8110b62013-09-10 20:14:30 +00002093 "static local from the same function had different linkage");
2094 }
2095
2096 // Pseudo code for the test:
2097 // if (!(GuardVar & MyGuardBit)) {
2098 // GuardVar |= MyGuardBit;
2099 // ... initialize the object ...;
2100 // }
2101
2102 // Test our bit from the guard variable.
2103 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1U << BitIndex);
Reid Klecknere9591b32014-04-23 18:22:11 +00002104 llvm::LoadInst *LI = Builder.CreateLoad(GI->Guard);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002105 llvm::Value *IsInitialized =
2106 Builder.CreateICmpNE(Builder.CreateAnd(LI, Bit), Zero);
2107 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2108 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
2109 Builder.CreateCondBr(IsInitialized, EndBlock, InitBlock);
2110
2111 // Set our bit in the guard variable and emit the initializer and add a global
2112 // destructor if appropriate.
2113 CGF.EmitBlock(InitBlock);
Reid Klecknere9591b32014-04-23 18:22:11 +00002114 Builder.CreateStore(Builder.CreateOr(LI, Bit), GI->Guard);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002115 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2116 Builder.CreateBr(EndBlock);
2117
2118 // Continue.
2119 CGF.EmitBlock(EndBlock);
John McCallc84ed6a2012-05-01 06:13:13 +00002120}
2121
Reid Kleckner2341ae32013-04-11 18:13:19 +00002122bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2123 // Null-ness for function memptrs only depends on the first field, which is
2124 // the function pointer. The rest don't matter, so we can zero initialize.
2125 if (MPT->isMemberFunctionPointer())
2126 return true;
2127
2128 // The virtual base adjustment field is always -1 for null, so if we have one
2129 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
2130 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002131 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2132 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002133 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
2134 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00002135}
2136
2137llvm::Type *
2138MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002139 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2140 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002141 llvm::SmallVector<llvm::Type *, 4> fields;
2142 if (MPT->isMemberFunctionPointer())
2143 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
2144 else
2145 fields.push_back(CGM.IntTy); // FieldOffset
2146
Reid Kleckner96f8f932014-02-05 17:27:08 +00002147 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2148 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002149 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002150 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002151 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002152 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002153 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
2154
2155 if (fields.size() == 1)
2156 return fields[0];
2157 return llvm::StructType::get(CGM.getLLVMContext(), fields);
2158}
2159
2160void MicrosoftCXXABI::
2161GetNullMemberPointerFields(const MemberPointerType *MPT,
2162 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2163 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00002164 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2165 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002166 if (MPT->isMemberFunctionPointer()) {
2167 // FunctionPointerOrVirtualThunk
2168 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2169 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00002170 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00002171 fields.push_back(getZeroInt()); // FieldOffset
2172 else
2173 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00002174 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00002175
Reid Kleckner96f8f932014-02-05 17:27:08 +00002176 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2177 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002178 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002179 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002180 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002181 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002182 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002183}
2184
2185llvm::Constant *
2186MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002187 llvm::SmallVector<llvm::Constant *, 4> fields;
2188 GetNullMemberPointerFields(MPT, fields);
2189 if (fields.size() == 1)
2190 return fields[0];
2191 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2192 assert(Res->getType() == ConvertMemberPointerType(MPT));
2193 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002194}
2195
2196llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002197MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2198 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00002199 const CXXRecordDecl *RD,
2200 CharUnits NonVirtualBaseAdjustment)
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002201{
David Majnemer1cdd96d2014-01-17 09:01:00 +00002202 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002203
2204 // Single inheritance class member pointer are represented as scalars instead
2205 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002206 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002207 return FirstField;
2208
Reid Kleckner2341ae32013-04-11 18:13:19 +00002209 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002210 fields.push_back(FirstField);
2211
Reid Kleckner96f8f932014-02-05 17:27:08 +00002212 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002213 fields.push_back(llvm::ConstantInt::get(
2214 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002215
Reid Kleckner96f8f932014-02-05 17:27:08 +00002216 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00002217 CharUnits Offs = CharUnits::Zero();
2218 if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002219 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00002220 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00002221 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002222
2223 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002224 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002225 fields.push_back(getZeroInt());
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002226
Reid Kleckner2341ae32013-04-11 18:13:19 +00002227 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002228}
2229
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002230llvm::Constant *
2231MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2232 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002233 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002234 llvm::Constant *FirstField =
2235 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00002236 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
2237 CharUnits::Zero());
2238}
2239
2240llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const CXXMethodDecl *MD) {
2241 return BuildMemberPointer(MD->getParent(), MD, CharUnits::Zero());
2242}
2243
2244llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2245 QualType MPType) {
2246 const MemberPointerType *MPT = MPType->castAs<MemberPointerType>();
2247 const ValueDecl *MPD = MP.getMemberPointerDecl();
2248 if (!MPD)
2249 return EmitNullMemberPointer(MPT);
2250
2251 CharUnits ThisAdjustment = getMemberPointerPathAdjustment(MP);
2252
2253 // FIXME PR15713: Support virtual inheritance paths.
2254
2255 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD))
David Majnemer1cdd96d2014-01-17 09:01:00 +00002256 return BuildMemberPointer(MPT->getMostRecentCXXRecordDecl(), MD,
2257 ThisAdjustment);
Reid Kleckner452abac2013-05-09 21:01:17 +00002258
2259 CharUnits FieldOffset =
2260 getContext().toCharUnitsFromBits(getContext().getFieldOffset(MPD));
2261 return EmitMemberDataPointer(MPT, ThisAdjustment + FieldOffset);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002262}
2263
2264llvm::Constant *
Reid Kleckner452abac2013-05-09 21:01:17 +00002265MicrosoftCXXABI::BuildMemberPointer(const CXXRecordDecl *RD,
2266 const CXXMethodDecl *MD,
2267 CharUnits NonVirtualBaseAdjustment) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002268 assert(MD->isInstance() && "Member function must not be static!");
2269 MD = MD->getCanonicalDecl();
David Majnemer1cdd96d2014-01-17 09:01:00 +00002270 RD = RD->getMostRecentDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002271 CodeGenTypes &Types = CGM.getTypes();
2272
2273 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00002274 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00002275 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002276 llvm::Type *Ty;
2277 // Check whether the function has a computable LLVM signature.
2278 if (Types.isFuncTypeConvertible(FPT)) {
2279 // The function has a computable LLVM signature; use the correct type.
2280 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2281 } else {
2282 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2283 // function type is incomplete.
2284 Ty = CGM.PtrDiffTy;
2285 }
2286 FirstField = CGM.GetAddrOfFunction(MD, Ty);
2287 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Hans Wennborg88497d62013-11-15 17:24:45 +00002288 } else {
2289 MicrosoftVTableContext::MethodVFTableLocation ML =
2290 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Reid Klecknerc3473512014-08-29 21:43:29 +00002291 if (!CGM.getTypes().isFuncTypeConvertible(
2292 MD->getType()->castAs<FunctionType>())) {
Hans Wennborg88497d62013-11-15 17:24:45 +00002293 CGM.ErrorUnsupported(MD, "pointer to virtual member function with "
2294 "incomplete return or parameter type");
2295 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
Reid Klecknerc3473512014-08-29 21:43:29 +00002296 } else if (FPT->getCallConv() == CC_X86FastCall) {
2297 CGM.ErrorUnsupported(MD, "pointer to fastcall virtual member function");
2298 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
Hans Wennborg88497d62013-11-15 17:24:45 +00002299 } else if (ML.VBase) {
2300 CGM.ErrorUnsupported(MD, "pointer to virtual member function overriding "
2301 "member function in virtual base class");
2302 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
2303 } else {
Reid Klecknere4a52202014-02-21 02:27:32 +00002304 llvm::Function *Thunk = EmitVirtualMemPtrThunk(MD, ML);
Hans Wennborg88497d62013-11-15 17:24:45 +00002305 FirstField = llvm::ConstantExpr::getBitCast(Thunk, CGM.VoidPtrTy);
Reid Klecknere4a52202014-02-21 02:27:32 +00002306 // Include the vfptr adjustment if the method is in a non-primary vftable.
2307 NonVirtualBaseAdjustment += ML.VFPtrOffset;
Hans Wennborg88497d62013-11-15 17:24:45 +00002308 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002309 }
2310
2311 // The rest of the fields are common with data member pointers.
Reid Kleckner452abac2013-05-09 21:01:17 +00002312 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
2313 NonVirtualBaseAdjustment);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002314}
2315
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002316/// Member pointers are the same if they're either bitwise identical *or* both
2317/// null. Null-ness for function members is determined by the first field,
2318/// while for data member pointers we must compare all fields.
2319llvm::Value *
2320MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2321 llvm::Value *L,
2322 llvm::Value *R,
2323 const MemberPointerType *MPT,
2324 bool Inequality) {
2325 CGBuilderTy &Builder = CGF.Builder;
2326
2327 // Handle != comparisons by switching the sense of all boolean operations.
2328 llvm::ICmpInst::Predicate Eq;
2329 llvm::Instruction::BinaryOps And, Or;
2330 if (Inequality) {
2331 Eq = llvm::ICmpInst::ICMP_NE;
2332 And = llvm::Instruction::Or;
2333 Or = llvm::Instruction::And;
2334 } else {
2335 Eq = llvm::ICmpInst::ICMP_EQ;
2336 And = llvm::Instruction::And;
2337 Or = llvm::Instruction::Or;
2338 }
2339
2340 // If this is a single field member pointer (single inheritance), this is a
2341 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002342 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2343 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002344 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2345 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002346 return Builder.CreateICmp(Eq, L, R);
2347
2348 // Compare the first field.
2349 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2350 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2351 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2352
2353 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002354 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002355 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2356 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2357 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2358 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2359 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2360 if (Res)
2361 Res = Builder.CreateBinOp(And, Res, Cmp);
2362 else
2363 Res = Cmp;
2364 }
2365
2366 // Check if the first field is 0 if this is a function pointer.
2367 if (MPT->isMemberFunctionPointer()) {
2368 // (l1 == r1 && ...) || l0 == 0
2369 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2370 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2371 Res = Builder.CreateBinOp(Or, Res, IsZero);
2372 }
2373
2374 // Combine the comparison of the first field, which must always be true for
2375 // this comparison to succeeed.
2376 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2377}
2378
Reid Kleckner407e8b62013-03-22 19:02:54 +00002379llvm::Value *
2380MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2381 llvm::Value *MemPtr,
2382 const MemberPointerType *MPT) {
2383 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002384 llvm::SmallVector<llvm::Constant *, 4> fields;
2385 // We only need one field for member functions.
2386 if (MPT->isMemberFunctionPointer())
2387 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2388 else
2389 GetNullMemberPointerFields(MPT, fields);
2390 assert(!fields.empty());
2391 llvm::Value *FirstField = MemPtr;
2392 if (MemPtr->getType()->isStructTy())
2393 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2394 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002395
Reid Kleckner2341ae32013-04-11 18:13:19 +00002396 // For function member pointers, we only need to test the function pointer
2397 // field. The other fields if any can be garbage.
2398 if (MPT->isMemberFunctionPointer())
2399 return Res;
2400
2401 // Otherwise, emit a series of compares and combine the results.
2402 for (int I = 1, E = fields.size(); I < E; ++I) {
2403 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2404 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002405 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002406 }
2407 return Res;
2408}
2409
Reid Kleckner452abac2013-05-09 21:01:17 +00002410bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2411 llvm::Constant *Val) {
2412 // Function pointers are null if the pointer in the first field is null.
2413 if (MPT->isMemberFunctionPointer()) {
2414 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2415 Val->getAggregateElement(0U) : Val;
2416 return FirstField->isNullValue();
2417 }
2418
2419 // If it's not a function pointer and it's zero initializable, we can easily
2420 // check zero.
2421 if (isZeroInitializable(MPT) && Val->isNullValue())
2422 return true;
2423
2424 // Otherwise, break down all the fields for comparison. Hopefully these
2425 // little Constants are reused, while a big null struct might not be.
2426 llvm::SmallVector<llvm::Constant *, 4> Fields;
2427 GetNullMemberPointerFields(MPT, Fields);
2428 if (Fields.size() == 1) {
2429 assert(Val->getType()->isIntegerTy());
2430 return Val == Fields[0];
2431 }
2432
2433 unsigned I, E;
2434 for (I = 0, E = Fields.size(); I != E; ++I) {
2435 if (Val->getAggregateElement(I) != Fields[I])
2436 break;
2437 }
2438 return I == E;
2439}
2440
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002441llvm::Value *
2442MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
2443 llvm::Value *This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002444 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002445 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002446 llvm::Value **VBPtrOut) {
2447 CGBuilderTy &Builder = CGF.Builder;
2448 // Load the vbtable pointer from the vbptr in the instance.
2449 This = Builder.CreateBitCast(This, CGM.Int8PtrTy);
2450 llvm::Value *VBPtr =
2451 Builder.CreateInBoundsGEP(This, VBPtrOffset, "vbptr");
2452 if (VBPtrOut) *VBPtrOut = VBPtr;
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002453 VBPtr = Builder.CreateBitCast(VBPtr,
2454 CGM.Int32Ty->getPointerTo(0)->getPointerTo(0));
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002455 llvm::Value *VBTable = Builder.CreateLoad(VBPtr, "vbtable");
2456
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002457 // Translate from byte offset to table index. It improves analyzability.
2458 llvm::Value *VBTableIndex = Builder.CreateAShr(
2459 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
2460 "vbtindex", /*isExact=*/true);
2461
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002462 // Load an i32 offset from the vb-table.
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002463 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002464 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
2465 return Builder.CreateLoad(VBaseOffs, "vbase_offs");
2466}
2467
Reid Kleckner2341ae32013-04-11 18:13:19 +00002468// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2469// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002470llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2471 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
2472 llvm::Value *Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002473 CGBuilderTy &Builder = CGF.Builder;
2474 Base = Builder.CreateBitCast(Base, CGM.Int8PtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +00002475 llvm::BasicBlock *OriginalBB = nullptr;
2476 llvm::BasicBlock *SkipAdjustBB = nullptr;
2477 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002478
2479 // In the unspecified inheritance model, there might not be a vbtable at all,
2480 // in which case we need to skip the virtual base lookup. If there is a
2481 // vbtable, the first entry is a no-op entry that gives back the original
2482 // base, so look for a virtual base adjustment offset of zero.
2483 if (VBPtrOffset) {
2484 OriginalBB = Builder.GetInsertBlock();
2485 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2486 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2487 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002488 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002489 "memptr.is_vbase");
2490 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2491 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002492 }
2493
Reid Kleckner2341ae32013-04-11 18:13:19 +00002494 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
2495 // know the vbptr offset.
2496 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002497 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00002498 if (!RD->hasDefinition()) {
2499 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
2500 unsigned DiagID = Diags.getCustomDiagID(
2501 DiagnosticsEngine::Error,
2502 "member pointer representation requires a "
2503 "complete class type for %0 to perform this expression");
2504 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
2505 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002506 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002507 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
2508 }
Craig Topper8a13c412014-05-21 05:09:00 +00002509 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002510 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002511 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002512 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
2513
2514 // Merge control flow with the case where we didn't have to adjust.
2515 if (VBaseAdjustBB) {
2516 Builder.CreateBr(SkipAdjustBB);
2517 CGF.EmitBlock(SkipAdjustBB);
2518 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
2519 Phi->addIncoming(Base, OriginalBB);
2520 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
2521 return Phi;
2522 }
2523 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002524}
2525
David Majnemer2b0d66d2014-02-20 23:22:07 +00002526llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
2527 CodeGenFunction &CGF, const Expr *E, llvm::Value *Base, llvm::Value *MemPtr,
2528 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002529 assert(MPT->isMemberDataPointer());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002530 unsigned AS = Base->getType()->getPointerAddressSpace();
2531 llvm::Type *PType =
2532 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
2533 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002534 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2535 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00002536
Reid Kleckner2341ae32013-04-11 18:13:19 +00002537 // Extract the fields we need, regardless of model. We'll apply them if we
2538 // have them.
2539 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002540 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2541 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002542 if (MemPtr->getType()->isStructTy()) {
2543 // We need to extract values.
2544 unsigned I = 0;
2545 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002546 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002547 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002548 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002549 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002550 }
2551
Reid Kleckner2341ae32013-04-11 18:13:19 +00002552 if (VirtualBaseAdjustmentOffset) {
David Majnemer2b0d66d2014-02-20 23:22:07 +00002553 Base = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00002554 VBPtrOffset);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002555 }
Reid Klecknerae945122013-12-05 22:44:07 +00002556
2557 // Cast to char*.
2558 Base = Builder.CreateBitCast(Base, Builder.getInt8Ty()->getPointerTo(AS));
2559
2560 // Apply the offset, which we assume is non-null.
Reid Kleckner2341ae32013-04-11 18:13:19 +00002561 llvm::Value *Addr =
2562 Builder.CreateInBoundsGEP(Base, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002563
2564 // Cast the address to the appropriate pointer type, adopting the address
2565 // space of the base pointer.
2566 return Builder.CreateBitCast(Addr, PType);
2567}
2568
David Majnemer1cdd96d2014-01-17 09:01:00 +00002569static MSInheritanceAttr::Spelling
Reid Kleckner452abac2013-05-09 21:01:17 +00002570getInheritanceFromMemptr(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002571 return MPT->getMostRecentCXXRecordDecl()->getMSInheritanceModel();
Reid Kleckner452abac2013-05-09 21:01:17 +00002572}
2573
2574llvm::Value *
2575MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
2576 const CastExpr *E,
2577 llvm::Value *Src) {
2578 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
2579 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
2580 E->getCastKind() == CK_ReinterpretMemberPointer);
2581
2582 // Use constant emission if we can.
2583 if (isa<llvm::Constant>(Src))
2584 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
2585
2586 // We may be adding or dropping fields from the member pointer, so we need
2587 // both types and the inheritance models of both records.
2588 const MemberPointerType *SrcTy =
2589 E->getSubExpr()->getType()->castAs<MemberPointerType>();
2590 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002591 bool IsFunc = SrcTy->isMemberFunctionPointer();
2592
2593 // If the classes use the same null representation, reinterpret_cast is a nop.
2594 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002595 if (IsReinterpret && IsFunc)
2596 return Src;
2597
2598 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
2599 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
2600 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00002601 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00002602 return Src;
2603
2604 CGBuilderTy &Builder = CGF.Builder;
2605
2606 // Branch past the conversion if Src is null.
2607 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
2608 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
2609
2610 // C++ 5.2.10p9: The null member pointer value is converted to the null member
2611 // pointer value of the destination type.
2612 if (IsReinterpret) {
2613 // For reinterpret casts, sema ensures that src and dst are both functions
2614 // or data and have the same size, which means the LLVM types should match.
2615 assert(Src->getType() == DstNull->getType());
2616 return Builder.CreateSelect(IsNotNull, Src, DstNull);
2617 }
2618
2619 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
2620 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
2621 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
2622 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
2623 CGF.EmitBlock(ConvertBB);
2624
2625 // Decompose src.
2626 llvm::Value *FirstField = Src;
Craig Topper8a13c412014-05-21 05:09:00 +00002627 llvm::Value *NonVirtualBaseAdjustment = nullptr;
2628 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2629 llvm::Value *VBPtrOffset = nullptr;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002630 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002631 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002632 // We need to extract values.
2633 unsigned I = 0;
2634 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002635 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002636 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002637 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002638 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002639 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002640 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
2641 }
2642
2643 // For data pointers, we adjust the field offset directly. For functions, we
2644 // have a separate field.
2645 llvm::Constant *Adj = getMemberPointerAdjustment(E);
2646 if (Adj) {
2647 Adj = llvm::ConstantExpr::getTruncOrBitCast(Adj, CGM.IntTy);
2648 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
2649 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
2650 if (!NVAdjustField) // If this field didn't exist in src, it's zero.
2651 NVAdjustField = getZeroInt();
2652 if (isDerivedToBase)
2653 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, Adj, "adj");
2654 else
2655 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, Adj, "adj");
2656 }
2657
2658 // FIXME PR15713: Support conversions through virtually derived classes.
2659
2660 // Recompose dst from the null struct and the adjusted fields from src.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002661 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
Reid Kleckner452abac2013-05-09 21:01:17 +00002662 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00002663 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002664 Dst = FirstField;
2665 } else {
2666 Dst = llvm::UndefValue::get(DstNull->getType());
2667 unsigned Idx = 0;
2668 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002669 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002670 Dst = Builder.CreateInsertValue(
2671 Dst, getValueOrZeroInt(NonVirtualBaseAdjustment), Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002672 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002673 Dst = Builder.CreateInsertValue(
2674 Dst, getValueOrZeroInt(VBPtrOffset), Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002675 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002676 Dst = Builder.CreateInsertValue(
2677 Dst, getValueOrZeroInt(VirtualBaseAdjustmentOffset), Idx++);
2678 }
2679 Builder.CreateBr(ContinueBB);
2680
2681 // In the continuation, choose between DstNull and Dst.
2682 CGF.EmitBlock(ContinueBB);
2683 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
2684 Phi->addIncoming(DstNull, OriginalBB);
2685 Phi->addIncoming(Dst, ConvertBB);
2686 return Phi;
2687}
2688
2689llvm::Constant *
2690MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
2691 llvm::Constant *Src) {
2692 const MemberPointerType *SrcTy =
2693 E->getSubExpr()->getType()->castAs<MemberPointerType>();
2694 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
2695
2696 // If src is null, emit a new null for dst. We can't return src because dst
2697 // might have a new representation.
2698 if (MemberPointerConstantIsNull(SrcTy, Src))
2699 return EmitNullMemberPointer(DstTy);
2700
2701 // We don't need to do anything for reinterpret_casts of non-null member
2702 // pointers. We should only get here when the two type representations have
2703 // the same size.
2704 if (E->getCastKind() == CK_ReinterpretMemberPointer)
2705 return Src;
2706
David Majnemer1cdd96d2014-01-17 09:01:00 +00002707 MSInheritanceAttr::Spelling SrcInheritance = getInheritanceFromMemptr(SrcTy);
2708 MSInheritanceAttr::Spelling DstInheritance = getInheritanceFromMemptr(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002709
2710 // Decompose src.
2711 llvm::Constant *FirstField = Src;
Craig Topper8a13c412014-05-21 05:09:00 +00002712 llvm::Constant *NonVirtualBaseAdjustment = nullptr;
2713 llvm::Constant *VirtualBaseAdjustmentOffset = nullptr;
2714 llvm::Constant *VBPtrOffset = nullptr;
Reid Kleckner452abac2013-05-09 21:01:17 +00002715 bool IsFunc = SrcTy->isMemberFunctionPointer();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002716 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002717 // We need to extract values.
2718 unsigned I = 0;
2719 FirstField = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002720 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002721 NonVirtualBaseAdjustment = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002722 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002723 VBPtrOffset = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002724 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002725 VirtualBaseAdjustmentOffset = Src->getAggregateElement(I++);
2726 }
2727
2728 // For data pointers, we adjust the field offset directly. For functions, we
2729 // have a separate field.
2730 llvm::Constant *Adj = getMemberPointerAdjustment(E);
2731 if (Adj) {
2732 Adj = llvm::ConstantExpr::getTruncOrBitCast(Adj, CGM.IntTy);
2733 llvm::Constant *&NVAdjustField =
2734 IsFunc ? NonVirtualBaseAdjustment : FirstField;
2735 bool IsDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
2736 if (!NVAdjustField) // If this field didn't exist in src, it's zero.
2737 NVAdjustField = getZeroInt();
2738 if (IsDerivedToBase)
2739 NVAdjustField = llvm::ConstantExpr::getNSWSub(NVAdjustField, Adj);
2740 else
2741 NVAdjustField = llvm::ConstantExpr::getNSWAdd(NVAdjustField, Adj);
2742 }
2743
2744 // FIXME PR15713: Support conversions through virtually derived classes.
2745
2746 // Recompose dst from the null struct and the adjusted fields from src.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002747 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002748 return FirstField;
2749
2750 llvm::SmallVector<llvm::Constant *, 4> Fields;
2751 Fields.push_back(FirstField);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002752 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002753 Fields.push_back(getConstantOrZeroInt(NonVirtualBaseAdjustment));
Reid Kleckner96f8f932014-02-05 17:27:08 +00002754 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002755 Fields.push_back(getConstantOrZeroInt(VBPtrOffset));
Reid Kleckner96f8f932014-02-05 17:27:08 +00002756 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002757 Fields.push_back(getConstantOrZeroInt(VirtualBaseAdjustmentOffset));
2758 return llvm::ConstantStruct::getAnon(Fields);
2759}
2760
David Majnemer2b0d66d2014-02-20 23:22:07 +00002761llvm::Value *MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
2762 CodeGenFunction &CGF, const Expr *E, llvm::Value *&This,
2763 llvm::Value *MemPtr, const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002764 assert(MPT->isMemberFunctionPointer());
2765 const FunctionProtoType *FPT =
2766 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00002767 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002768 llvm::FunctionType *FTy =
2769 CGM.getTypes().GetFunctionType(
2770 CGM.getTypes().arrangeCXXMethodType(RD, FPT));
2771 CGBuilderTy &Builder = CGF.Builder;
2772
David Majnemer1cdd96d2014-01-17 09:01:00 +00002773 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002774
2775 // Extract the fields we need, regardless of model. We'll apply them if we
2776 // have them.
2777 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002778 llvm::Value *NonVirtualBaseAdjustment = nullptr;
2779 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2780 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002781 if (MemPtr->getType()->isStructTy()) {
2782 // We need to extract values.
2783 unsigned I = 0;
2784 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002785 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002786 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002787 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002788 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002789 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002790 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
2791 }
2792
2793 if (VirtualBaseAdjustmentOffset) {
David Majnemer2b0d66d2014-02-20 23:22:07 +00002794 This = AdjustVirtualBase(CGF, E, RD, This, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00002795 VBPtrOffset);
2796 }
2797
2798 if (NonVirtualBaseAdjustment) {
2799 // Apply the adjustment and cast back to the original struct type.
2800 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy());
2801 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
2802 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted");
2803 }
2804
2805 return Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
2806}
2807
Charles Davis53c59df2010-08-16 03:33:14 +00002808CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00002809 return new MicrosoftCXXABI(CGM);
2810}
David Majnemere2cb8d12014-07-07 06:20:47 +00002811
2812// MS RTTI Overview:
2813// The run time type information emitted by cl.exe contains 5 distinct types of
2814// structures. Many of them reference each other.
2815//
2816// TypeInfo: Static classes that are returned by typeid.
2817//
2818// CompleteObjectLocator: Referenced by vftables. They contain information
2819// required for dynamic casting, including OffsetFromTop. They also contain
2820// a reference to the TypeInfo for the type and a reference to the
2821// CompleteHierarchyDescriptor for the type.
2822//
2823// ClassHieararchyDescriptor: Contains information about a class hierarchy.
2824// Used during dynamic_cast to walk a class hierarchy. References a base
2825// class array and the size of said array.
2826//
2827// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
2828// somewhat of a misnomer because the most derived class is also in the list
2829// as well as multiple copies of virtual bases (if they occur multiple times
2830// in the hiearchy.) The BaseClassArray contains one BaseClassDescriptor for
2831// every path in the hierarchy, in pre-order depth first order. Note, we do
2832// not declare a specific llvm type for BaseClassArray, it's merely an array
2833// of BaseClassDescriptor pointers.
2834//
2835// BaseClassDescriptor: Contains information about a class in a class hierarchy.
2836// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
2837// BaseClassArray is. It contains information about a class within a
2838// hierarchy such as: is this base is ambiguous and what is its offset in the
2839// vbtable. The names of the BaseClassDescriptors have all of their fields
2840// mangled into them so they can be aggressively deduplicated by the linker.
2841
David Majnemere2cb8d12014-07-07 06:20:47 +00002842static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
2843 StringRef MangledName("\01??_7type_info@@6B@");
2844 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
2845 return VTable;
2846 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
2847 /*Constant=*/true,
2848 llvm::GlobalVariable::ExternalLinkage,
2849 /*Initializer=*/nullptr, MangledName);
2850}
2851
2852namespace {
2853
2854/// \brief A Helper struct that stores information about a class in a class
2855/// hierarchy. The information stored in these structs struct is used during
2856/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
2857// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
2858// implicit depth first pre-order tree connectivity. getFirstChild and
2859// getNextSibling allow us to walk the tree efficiently.
2860struct MSRTTIClass {
2861 enum {
2862 IsPrivateOnPath = 1 | 8,
2863 IsAmbiguous = 2,
2864 IsPrivate = 4,
2865 IsVirtual = 16,
2866 HasHierarchyDescriptor = 64
2867 };
2868 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
2869 uint32_t initialize(const MSRTTIClass *Parent,
2870 const CXXBaseSpecifier *Specifier);
2871
2872 MSRTTIClass *getFirstChild() { return this + 1; }
2873 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
2874 return Child + 1 + Child->NumBases;
2875 }
2876
2877 const CXXRecordDecl *RD, *VirtualRoot;
2878 uint32_t Flags, NumBases, OffsetInVBase;
2879};
2880
2881/// \brief Recursively initialize the base class array.
2882uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
2883 const CXXBaseSpecifier *Specifier) {
2884 Flags = HasHierarchyDescriptor;
2885 if (!Parent) {
2886 VirtualRoot = nullptr;
2887 OffsetInVBase = 0;
2888 } else {
2889 if (Specifier->getAccessSpecifier() != AS_public)
2890 Flags |= IsPrivate | IsPrivateOnPath;
2891 if (Specifier->isVirtual()) {
2892 Flags |= IsVirtual;
2893 VirtualRoot = RD;
2894 OffsetInVBase = 0;
2895 } else {
2896 if (Parent->Flags & IsPrivateOnPath)
2897 Flags |= IsPrivateOnPath;
2898 VirtualRoot = Parent->VirtualRoot;
2899 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
2900 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
2901 }
2902 }
2903 NumBases = 0;
2904 MSRTTIClass *Child = getFirstChild();
2905 for (const CXXBaseSpecifier &Base : RD->bases()) {
2906 NumBases += Child->initialize(this, &Base) + 1;
2907 Child = getNextChild(Child);
2908 }
2909 return NumBases;
2910}
2911
2912static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
2913 switch (Ty->getLinkage()) {
2914 case NoLinkage:
2915 case InternalLinkage:
2916 case UniqueExternalLinkage:
2917 return llvm::GlobalValue::InternalLinkage;
2918
2919 case VisibleNoLinkage:
2920 case ExternalLinkage:
2921 return llvm::GlobalValue::LinkOnceODRLinkage;
2922 }
2923 llvm_unreachable("Invalid linkage!");
2924}
2925
2926/// \brief An ephemeral helper class for building MS RTTI types. It caches some
2927/// calls to the module and information about the most derived class in a
2928/// hierarchy.
2929struct MSRTTIBuilder {
2930 enum {
2931 HasBranchingHierarchy = 1,
2932 HasVirtualBranchingHierarchy = 2,
2933 HasAmbiguousBases = 4
2934 };
2935
David Majnemer611cdb92014-07-07 08:09:15 +00002936 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
2937 : CGM(ABI.CGM), Context(CGM.getContext()),
2938 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00002939 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00002940 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00002941
2942 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
2943 llvm::GlobalVariable *
2944 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
2945 llvm::GlobalVariable *getClassHierarchyDescriptor();
2946 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo *Info);
2947
2948 CodeGenModule &CGM;
2949 ASTContext &Context;
2950 llvm::LLVMContext &VMContext;
2951 llvm::Module &Module;
2952 const CXXRecordDecl *RD;
2953 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00002954 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00002955};
2956
2957} // namespace
2958
2959/// \brief Recursively serializes a class hierarchy in pre-order depth first
2960/// order.
2961static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
2962 const CXXRecordDecl *RD) {
2963 Classes.push_back(MSRTTIClass(RD));
2964 for (const CXXBaseSpecifier &Base : RD->bases())
2965 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
2966}
2967
2968/// \brief Find ambiguity among base classes.
2969static void
2970detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
2971 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
2972 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
2973 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
2974 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
2975 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
David Blaikie82e95a32014-11-19 07:49:47 +00002976 !VirtualBases.insert(Class->RD).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00002977 Class = MSRTTIClass::getNextChild(Class);
2978 continue;
2979 }
David Blaikie82e95a32014-11-19 07:49:47 +00002980 if (!UniqueBases.insert(Class->RD).second)
David Majnemere2cb8d12014-07-07 06:20:47 +00002981 AmbiguousBases.insert(Class->RD);
2982 Class++;
2983 }
2984 if (AmbiguousBases.empty())
2985 return;
2986 for (MSRTTIClass &Class : Classes)
2987 if (AmbiguousBases.count(Class.RD))
2988 Class.Flags |= MSRTTIClass::IsAmbiguous;
2989}
2990
2991llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
2992 SmallString<256> MangledName;
2993 {
2994 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00002995 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00002996 }
2997
2998 // Check to see if we've already declared this ClassHierarchyDescriptor.
2999 if (auto CHD = Module.getNamedGlobal(MangledName))
3000 return CHD;
3001
3002 // Serialize the class hierarchy and initialize the CHD Fields.
3003 SmallVector<MSRTTIClass, 8> Classes;
3004 serializeClassHierarchy(Classes, RD);
3005 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3006 detectAmbiguousBases(Classes);
3007 int Flags = 0;
3008 for (auto Class : Classes) {
3009 if (Class.RD->getNumBases() > 1)
3010 Flags |= HasBranchingHierarchy;
3011 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
3012 // believe the field isn't actually used.
3013 if (Class.Flags & MSRTTIClass::IsAmbiguous)
3014 Flags |= HasAmbiguousBases;
3015 }
3016 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
3017 Flags |= HasVirtualBranchingHierarchy;
3018 // These gep indices are used to get the address of the first element of the
3019 // base class array.
3020 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
3021 llvm::ConstantInt::get(CGM.IntTy, 0)};
3022
3023 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00003024 auto Type = ABI.getClassHierarchyDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003025 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3026 /*Initializer=*/nullptr,
David Majnemer7c237072015-03-05 00:46:22 +00003027 StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003028 if (CHD->isWeakForLinker())
3029 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003030
3031 // Initialize the base class ClassHierarchyDescriptor.
3032 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003033 llvm::ConstantInt::get(CGM.IntTy, 0), // Unknown
3034 llvm::ConstantInt::get(CGM.IntTy, Flags),
3035 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
3036 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
3037 getBaseClassArray(Classes),
3038 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00003039 };
3040 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3041 return CHD;
3042}
3043
3044llvm::GlobalVariable *
3045MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3046 SmallString<256> MangledName;
3047 {
3048 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003049 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003050 }
3051
3052 // Forward-declare the base class array.
3053 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3054 // mode) bytes of padding. We provide a pointer sized amount of padding by
3055 // adding +1 to Classes.size(). The sections have pointer alignment and are
3056 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00003057 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00003058 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00003059 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
David Majnemer7c237072015-03-05 00:46:22 +00003060 auto *BCA =
3061 new llvm::GlobalVariable(Module, ArrType,
3062 /*Constant=*/true, Linkage,
3063 /*Initializer=*/nullptr, StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003064 if (BCA->isWeakForLinker())
3065 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003066
3067 // Initialize the BaseClassArray.
3068 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3069 for (MSRTTIClass &Class : Classes)
3070 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00003071 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00003072 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00003073 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00003074 return BCA;
3075}
3076
3077llvm::GlobalVariable *
3078MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3079 // Compute the fields for the BaseClassDescriptor. They are computed up front
3080 // because they are mangled into the name of the object.
3081 uint32_t OffsetInVBTable = 0;
3082 int32_t VBPtrOffset = -1;
3083 if (Class.VirtualRoot) {
3084 auto &VTableContext = CGM.getMicrosoftVTableContext();
3085 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3086 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3087 }
3088
3089 SmallString<256> MangledName;
3090 {
3091 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003092 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3093 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3094 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003095 }
3096
David Majnemer26a90f82014-07-07 15:29:10 +00003097 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00003098 if (auto BCD = Module.getNamedGlobal(MangledName))
3099 return BCD;
3100
3101 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00003102 auto Type = ABI.getBaseClassDescriptorType();
David Majnemer7c237072015-03-05 00:46:22 +00003103 auto BCD =
3104 new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3105 /*Initializer=*/nullptr, StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003106 if (BCD->isWeakForLinker())
3107 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003108
3109 // Initialize the BaseClassDescriptor.
3110 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003111 ABI.getImageRelativeConstant(
David Majnemer443250f2015-03-17 20:35:00 +00003112 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003113 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3114 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3115 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3116 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3117 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3118 ABI.getImageRelativeConstant(
3119 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00003120 };
3121 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3122 return BCD;
3123}
3124
3125llvm::GlobalVariable *
3126MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo *Info) {
3127 SmallString<256> MangledName;
3128 {
3129 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003130 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info->MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003131 }
3132
3133 // Check to see if we've already computed this complete object locator.
3134 if (auto COL = Module.getNamedGlobal(MangledName))
3135 return COL;
3136
3137 // Compute the fields of the complete object locator.
3138 int OffsetToTop = Info->FullOffsetInMDC.getQuantity();
3139 int VFPtrOffset = 0;
3140 // The offset includes the vtordisp if one exists.
3141 if (const CXXRecordDecl *VBase = Info->getVBaseWithVPtr())
3142 if (Context.getASTRecordLayout(RD)
3143 .getVBaseOffsetsMap()
3144 .find(VBase)
3145 ->second.hasVtorDisp())
3146 VFPtrOffset = Info->NonVirtualOffset.getQuantity() + 4;
3147
3148 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00003149 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003150 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
David Majnemer7c237072015-03-05 00:46:22 +00003151 /*Initializer=*/nullptr, StringRef(MangledName));
David Majnemere2cb8d12014-07-07 06:20:47 +00003152
3153 // Initialize the CompleteObjectLocator.
3154 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003155 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3156 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3157 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3158 ABI.getImageRelativeConstant(
3159 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3160 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3161 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00003162 };
3163 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00003164 if (!ABI.isImageRelative())
3165 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00003166 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
Rafael Espindola654542a2015-01-16 19:23:42 +00003167 if (COL->isWeakForLinker())
3168 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003169 return COL;
3170}
3171
David Majnemerad803d42015-03-15 07:10:01 +00003172static QualType decomposeTypeForEH(ASTContext &Context, QualType T,
3173 bool &IsConst, bool &IsVolatile) {
3174 T = Context.getExceptionObjectType(T);
3175
3176 // C++14 [except.handle]p3:
3177 // A handler is a match for an exception object of type E if [...]
3178 // - the handler is of type cv T or const T& where T is a pointer type and
3179 // E is a pointer type that can be converted to T by [...]
3180 // - a qualification conversion
3181 IsConst = false;
3182 IsVolatile = false;
3183 QualType PointeeType = T->getPointeeType();
3184 if (!PointeeType.isNull()) {
3185 IsConst = PointeeType.isConstQualified();
3186 IsVolatile = PointeeType.isVolatileQualified();
3187 }
3188
3189 // Member pointer types like "const int A::*" are represented by having RTTI
3190 // for "int A::*" and separately storing the const qualifier.
3191 if (const auto *MPTy = T->getAs<MemberPointerType>())
3192 T = Context.getMemberPointerType(PointeeType.getUnqualifiedType(),
3193 MPTy->getClass());
3194
3195 // Pointer types like "const int * const *" are represented by having RTTI
3196 // for "const int **" and separately storing the const qualifier.
3197 if (T->isPointerType())
3198 T = Context.getPointerType(PointeeType.getUnqualifiedType());
3199
3200 return T;
3201}
3202
David Majnemer5f0dd612015-03-17 20:35:05 +00003203llvm::Constant *
3204MicrosoftCXXABI::getAddrOfCXXHandlerMapEntry(QualType Type,
3205 QualType CatchHandlerType) {
3206 // TypeDescriptors for exceptions never have qualified pointer types,
David Majnemer443250f2015-03-17 20:35:00 +00003207 // qualifiers are stored seperately in order to support qualification
3208 // conversions.
3209 bool IsConst, IsVolatile;
3210 Type = decomposeTypeForEH(getContext(), Type, IsConst, IsVolatile);
3211
David Majnemer5f0dd612015-03-17 20:35:05 +00003212 bool IsReference = CatchHandlerType->isReferenceType();
3213
3214 SmallString<256> MangledName;
3215 {
3216 llvm::raw_svector_ostream Out(MangledName);
3217 getMangleContext().mangleCXXHandlerMapEntry(Type, IsConst, IsVolatile,
3218 IsReference, Out);
3219 }
3220
3221 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3222 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3223
3224 uint32_t Flags = 0;
3225 if (IsConst)
3226 Flags |= 1;
3227 if (IsVolatile)
3228 Flags |= 2;
3229 if (IsReference)
3230 Flags |= 8;
3231
3232 llvm::Constant *Fields[] = {
3233 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
3234 getImageRelativeConstant(getAddrOfRTTIDescriptor(Type)), // TypeDescriptor
3235 };
3236 llvm::StructType *HandlerMapEntryType = getHandlerMapEntryType();
3237 auto *Var = new llvm::GlobalVariable(
3238 CGM.getModule(), HandlerMapEntryType, /*Constant=*/true,
3239 llvm::GlobalValue::PrivateLinkage,
3240 llvm::ConstantStruct::get(HandlerMapEntryType, Fields),
3241 StringRef(MangledName));
3242 Var->setUnnamedAddr(true);
3243 Var->setSection("llvm.metadata");
3244 return Var;
David Majnemer443250f2015-03-17 20:35:00 +00003245}
3246
David Majnemere2cb8d12014-07-07 06:20:47 +00003247/// \brief Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
3248/// llvm::GlobalVariable * because different type descriptors have different
3249/// types, and need to be abstracted. They are abstracting by casting the
3250/// address to an Int8PtrTy.
David Majnemer443250f2015-03-17 20:35:00 +00003251llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemer5f0dd612015-03-17 20:35:05 +00003252 SmallString<256> MangledName;
David Majnemere2cb8d12014-07-07 06:20:47 +00003253 {
3254 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003255 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003256 }
3257
3258 // Check to see if we've already declared this TypeDescriptor.
3259 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3260 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3261
3262 // Compute the fields for the TypeDescriptor.
David Majnemer5f0dd612015-03-17 20:35:05 +00003263 SmallString<256> TypeInfoString;
David Majnemere2cb8d12014-07-07 06:20:47 +00003264 {
3265 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00003266 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003267 }
3268
3269 // Declare and initialize the TypeDescriptor.
3270 llvm::Constant *Fields[] = {
3271 getTypeInfoVTable(CGM), // VFPtr
3272 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3273 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3274 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00003275 getTypeDescriptorType(TypeInfoString);
Rafael Espindola654542a2015-01-16 19:23:42 +00003276 auto *Var = new llvm::GlobalVariable(
3277 CGM.getModule(), TypeDescriptorType, /*Constant=*/false,
3278 getLinkageForRTTI(Type),
3279 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
David Majnemer7c237072015-03-05 00:46:22 +00003280 StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003281 if (Var->isWeakForLinker())
3282 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3283 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003284}
3285
3286/// \brief Gets or a creates a Microsoft CompleteObjectLocator.
3287llvm::GlobalVariable *
3288MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
3289 const VPtrInfo *Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00003290 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003291}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003292
3293static void emitCXXConstructor(CodeGenModule &CGM,
3294 const CXXConstructorDecl *ctor,
3295 StructorType ctorType) {
Rafael Espindolad48b51b2014-09-15 19:24:44 +00003296 // There are no constructor variants, always emit the complete destructor.
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003297 llvm::Function *Fn = CGM.codegenCXXStructor(ctor, StructorType::Complete);
3298 CGM.maybeSetTrivialComdat(*ctor, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003299}
3300
3301static void emitCXXDestructor(CodeGenModule &CGM, const CXXDestructorDecl *dtor,
3302 StructorType dtorType) {
3303 // The complete destructor is equivalent to the base destructor for
3304 // classes with no virtual bases, so try to emit it as an alias.
3305 if (!dtor->getParent()->getNumVBases() &&
3306 (dtorType == StructorType::Complete || dtorType == StructorType::Base)) {
3307 bool ProducedAlias = !CGM.TryEmitDefinitionAsAlias(
3308 GlobalDecl(dtor, Dtor_Complete), GlobalDecl(dtor, Dtor_Base), true);
3309 if (ProducedAlias) {
3310 if (dtorType == StructorType::Complete)
3311 return;
3312 if (dtor->isVirtual())
3313 CGM.getVTables().EmitThunks(GlobalDecl(dtor, Dtor_Complete));
3314 }
3315 }
3316
3317 // The base destructor is equivalent to the base destructor of its
3318 // base class if there is exactly one non-virtual base class with a
3319 // non-trivial destructor, there are no fields with a non-trivial
3320 // destructor, and the body of the destructor is trivial.
3321 if (dtorType == StructorType::Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
3322 return;
3323
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003324 llvm::Function *Fn = CGM.codegenCXXStructor(dtor, dtorType);
Rafael Espindolad3e04692015-01-17 01:47:39 +00003325 if (Fn->isWeakForLinker())
3326 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003327}
3328
3329void MicrosoftCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3330 StructorType Type) {
3331 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
3332 emitCXXConstructor(CGM, CD, Type);
3333 return;
3334 }
3335 emitCXXDestructor(CGM, cast<CXXDestructorDecl>(MD), Type);
3336}
David Majnemer7c237072015-03-05 00:46:22 +00003337
David Majnemerdfa6d202015-03-11 18:36:39 +00003338llvm::Function *
David Majnemer37fd66e2015-03-13 22:36:55 +00003339MicrosoftCXXABI::getAddrOfCXXCtorClosure(const CXXConstructorDecl *CD,
3340 CXXCtorType CT) {
3341 assert(CT == Ctor_CopyingClosure || CT == Ctor_DefaultClosure);
3342
David Majnemerdfa6d202015-03-11 18:36:39 +00003343 // Calculate the mangled name.
3344 SmallString<256> ThunkName;
3345 llvm::raw_svector_ostream Out(ThunkName);
David Majnemer37fd66e2015-03-13 22:36:55 +00003346 getMangleContext().mangleCXXCtor(CD, CT, Out);
David Majnemerdfa6d202015-03-11 18:36:39 +00003347 Out.flush();
3348
3349 // If the thunk has been generated previously, just return it.
3350 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
3351 return cast<llvm::Function>(GV);
3352
3353 // Create the llvm::Function.
David Majnemer37fd66e2015-03-13 22:36:55 +00003354 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSCtorClosure(CD, CT);
David Majnemerdfa6d202015-03-11 18:36:39 +00003355 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
3356 const CXXRecordDecl *RD = CD->getParent();
3357 QualType RecordTy = getContext().getRecordType(RD);
3358 llvm::Function *ThunkFn = llvm::Function::Create(
3359 ThunkTy, getLinkageForRTTI(RecordTy), ThunkName.str(), &CGM.getModule());
Reid Klecknerbba3cb92015-03-17 19:00:50 +00003360 ThunkFn->setCallingConv(static_cast<llvm::CallingConv::ID>(
3361 FnInfo.getEffectiveCallingConvention()));
David Majnemer37fd66e2015-03-13 22:36:55 +00003362 bool IsCopy = CT == Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003363
3364 // Start codegen.
3365 CodeGenFunction CGF(CGM);
3366 CGF.CurGD = GlobalDecl(CD, Ctor_Complete);
3367
3368 // Build FunctionArgs.
3369 FunctionArgList FunctionArgs;
3370
David Majnemer37fd66e2015-03-13 22:36:55 +00003371 // A constructor always starts with a 'this' pointer as its first argument.
David Majnemerdfa6d202015-03-11 18:36:39 +00003372 buildThisParam(CGF, FunctionArgs);
3373
3374 // Following the 'this' pointer is a reference to the source object that we
3375 // are copying from.
3376 ImplicitParamDecl SrcParam(
3377 getContext(), nullptr, SourceLocation(), &getContext().Idents.get("src"),
3378 getContext().getLValueReferenceType(RecordTy,
3379 /*SpelledAsLValue=*/true));
David Majnemer37fd66e2015-03-13 22:36:55 +00003380 if (IsCopy)
3381 FunctionArgs.push_back(&SrcParam);
David Majnemerdfa6d202015-03-11 18:36:39 +00003382
David Majnemer37fd66e2015-03-13 22:36:55 +00003383 // Constructors for classes which utilize virtual bases have an additional
3384 // parameter which indicates whether or not it is being delegated to by a more
3385 // derived constructor.
David Majnemerdfa6d202015-03-11 18:36:39 +00003386 ImplicitParamDecl IsMostDerived(getContext(), nullptr, SourceLocation(),
3387 &getContext().Idents.get("is_most_derived"),
3388 getContext().IntTy);
3389 // Only add the parameter to the list if thie class has virtual bases.
3390 if (RD->getNumVBases() > 0)
3391 FunctionArgs.push_back(&IsMostDerived);
3392
3393 // Start defining the function.
3394 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
3395 FunctionArgs, CD->getLocation(), SourceLocation());
3396 EmitThisParam(CGF);
3397 llvm::Value *This = getThisValue(CGF);
3398
3399 llvm::Value *SrcVal =
David Majnemer37fd66e2015-03-13 22:36:55 +00003400 IsCopy ? CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(&SrcParam), "src")
3401 : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003402
3403 CallArgList Args;
3404
3405 // Push the this ptr.
3406 Args.add(RValue::get(This), CD->getThisType(getContext()));
3407
3408 // Push the src ptr.
David Majnemer37fd66e2015-03-13 22:36:55 +00003409 if (SrcVal)
3410 Args.add(RValue::get(SrcVal), SrcParam.getType());
David Majnemerdfa6d202015-03-11 18:36:39 +00003411
3412 // Add the rest of the default arguments.
3413 std::vector<Stmt *> ArgVec;
David Majnemer37fd66e2015-03-13 22:36:55 +00003414 for (unsigned I = IsCopy ? 1 : 0, E = CD->getNumParams(); I != E; ++I)
David Majnemerdfa6d202015-03-11 18:36:39 +00003415 ArgVec.push_back(getContext().getDefaultArgExprForConstructor(CD, I));
3416
3417 CodeGenFunction::RunCleanupsScope Cleanups(CGF);
3418
3419 const auto *FPT = CD->getType()->castAs<FunctionProtoType>();
Aaron Ballman0c22d5a2015-03-12 13:49:45 +00003420 ConstExprIterator ArgBegin(ArgVec.data()),
3421 ArgEnd(ArgVec.data() + ArgVec.size());
David Majnemer37fd66e2015-03-13 22:36:55 +00003422 CGF.EmitCallArgs(Args, FPT, ArgBegin, ArgEnd, CD, IsCopy ? 1 : 0);
David Majnemerdfa6d202015-03-11 18:36:39 +00003423
3424 // Insert any ABI-specific implicit constructor arguments.
3425 unsigned ExtraArgs = addImplicitConstructorArgs(CGF, CD, Ctor_Complete,
3426 /*ForVirtualBase=*/false,
3427 /*Delegating=*/false, Args);
3428
3429 // Call the destructor with our arguments.
3430 llvm::Value *CalleeFn = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3431 const CGFunctionInfo &CalleeInfo = CGM.getTypes().arrangeCXXConstructorCall(
3432 Args, CD, Ctor_Complete, ExtraArgs);
3433 CGF.EmitCall(CalleeInfo, CalleeFn, ReturnValueSlot(), Args, CD);
3434
3435 Cleanups.ForceCleanup();
3436
3437 // Emit the ret instruction, remove any temporary instructions created for the
3438 // aid of CodeGen.
3439 CGF.FinishFunction(SourceLocation());
3440
3441 return ThunkFn;
3442}
3443
David Majnemer7c237072015-03-05 00:46:22 +00003444llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
3445 uint32_t NVOffset,
3446 int32_t VBPtrOffset,
3447 uint32_t VBIndex) {
3448 assert(!T->isReferenceType());
3449
David Majnemere7a818f2015-03-06 18:53:55 +00003450 CXXRecordDecl *RD = T->getAsCXXRecordDecl();
3451 const CXXConstructorDecl *CD =
3452 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
David Majnemerdfa6d202015-03-11 18:36:39 +00003453 CXXCtorType CT = Ctor_Complete;
David Majnemer37fd66e2015-03-13 22:36:55 +00003454 if (CD)
3455 if (!hasDefaultCXXMethodCC(getContext(), CD) || CD->getNumParams() != 1)
David Majnemerdfa6d202015-03-11 18:36:39 +00003456 CT = Ctor_CopyingClosure;
David Majnemerdfa6d202015-03-11 18:36:39 +00003457
David Majnemer7c237072015-03-05 00:46:22 +00003458 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
3459 SmallString<256> MangledName;
3460 {
3461 llvm::raw_svector_ostream Out(MangledName);
David Majnemerdfa6d202015-03-11 18:36:39 +00003462 getMangleContext().mangleCXXCatchableType(T, CD, CT, Size, NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +00003463 VBPtrOffset, VBIndex, Out);
David Majnemer7c237072015-03-05 00:46:22 +00003464 }
3465 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3466 return getImageRelativeConstant(GV);
3467
David Majnemerdfa6d202015-03-11 18:36:39 +00003468 // The TypeDescriptor is used by the runtime to determine if a catch handler
David Majnemer7c237072015-03-05 00:46:22 +00003469 // is appropriate for the exception object.
David Majnemer443250f2015-03-17 20:35:00 +00003470 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
David Majnemer7c237072015-03-05 00:46:22 +00003471
3472 // The runtime is responsible for calling the copy constructor if the
3473 // exception is caught by value.
David Majnemerdfa6d202015-03-11 18:36:39 +00003474 llvm::Constant *CopyCtor;
3475 if (CD) {
3476 if (CT == Ctor_CopyingClosure)
David Majnemer37fd66e2015-03-13 22:36:55 +00003477 CopyCtor = getAddrOfCXXCtorClosure(CD, Ctor_CopyingClosure);
David Majnemerdfa6d202015-03-11 18:36:39 +00003478 else
3479 CopyCtor = CGM.getAddrOfCXXStructor(CD, StructorType::Complete);
3480
3481 CopyCtor = llvm::ConstantExpr::getBitCast(CopyCtor, CGM.Int8PtrTy);
3482 } else {
3483 CopyCtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
3484 }
David Majnemere7a818f2015-03-06 18:53:55 +00003485 CopyCtor = getImageRelativeConstant(CopyCtor);
David Majnemer7c237072015-03-05 00:46:22 +00003486
David Majnemere7a818f2015-03-06 18:53:55 +00003487 bool IsScalar = !RD;
David Majnemer7c237072015-03-05 00:46:22 +00003488 bool HasVirtualBases = false;
3489 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
David Majnemer7c237072015-03-05 00:46:22 +00003490 QualType PointeeType = T;
3491 if (T->isPointerType())
3492 PointeeType = T->getPointeeType();
3493 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
3494 HasVirtualBases = RD->getNumVBases() > 0;
3495 if (IdentifierInfo *II = RD->getIdentifier())
3496 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
3497 }
3498
3499 // Encode the relevant CatchableType properties into the Flags bitfield.
3500 // FIXME: Figure out how bits 2 or 8 can get set.
3501 uint32_t Flags = 0;
3502 if (IsScalar)
3503 Flags |= 1;
3504 if (HasVirtualBases)
3505 Flags |= 4;
3506 if (IsStdBadAlloc)
3507 Flags |= 16;
3508
3509 llvm::Constant *Fields[] = {
3510 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
3511 TD, // TypeDescriptor
3512 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment
3513 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
3514 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex
3515 llvm::ConstantInt::get(CGM.IntTy, Size), // Size
3516 CopyCtor // CopyCtor
3517 };
3518 llvm::StructType *CTType = getCatchableTypeType();
3519 auto *GV = new llvm::GlobalVariable(
3520 CGM.getModule(), CTType, /*Constant=*/true, getLinkageForRTTI(T),
3521 llvm::ConstantStruct::get(CTType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00003522 GV->setUnnamedAddr(true);
3523 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00003524 if (GV->isWeakForLinker())
3525 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00003526 return getImageRelativeConstant(GV);
3527}
3528
3529llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
3530 assert(!T->isReferenceType());
3531
3532 // See if we've already generated a CatchableTypeArray for this type before.
3533 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
3534 if (CTA)
3535 return CTA;
3536
3537 // Ensure that we don't have duplicate entries in our CatchableTypeArray by
3538 // using a SmallSetVector. Duplicates may arise due to virtual bases
3539 // occurring more than once in the hierarchy.
3540 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
3541
3542 // C++14 [except.handle]p3:
3543 // A handler is a match for an exception object of type E if [...]
3544 // - the handler is of type cv T or cv T& and T is an unambiguous public
3545 // base class of E, or
3546 // - the handler is of type cv T or const T& where T is a pointer type and
3547 // E is a pointer type that can be converted to T by [...]
3548 // - a standard pointer conversion (4.10) not involving conversions to
3549 // pointers to private or protected or ambiguous classes
3550 const CXXRecordDecl *MostDerivedClass = nullptr;
3551 bool IsPointer = T->isPointerType();
3552 if (IsPointer)
3553 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
3554 else
3555 MostDerivedClass = T->getAsCXXRecordDecl();
3556
3557 // Collect all the unambiguous public bases of the MostDerivedClass.
3558 if (MostDerivedClass) {
David Majnemer9ced3dd2015-03-14 23:44:48 +00003559 const ASTContext &Context = getContext();
David Majnemer7c237072015-03-05 00:46:22 +00003560 const ASTRecordLayout &MostDerivedLayout =
3561 Context.getASTRecordLayout(MostDerivedClass);
3562 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
3563 SmallVector<MSRTTIClass, 8> Classes;
3564 serializeClassHierarchy(Classes, MostDerivedClass);
3565 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3566 detectAmbiguousBases(Classes);
3567 for (const MSRTTIClass &Class : Classes) {
3568 // Skip any ambiguous or private bases.
3569 if (Class.Flags &
3570 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
3571 continue;
3572 // Write down how to convert from a derived pointer to a base pointer.
3573 uint32_t OffsetInVBTable = 0;
3574 int32_t VBPtrOffset = -1;
3575 if (Class.VirtualRoot) {
3576 OffsetInVBTable =
3577 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
3578 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
3579 }
3580
3581 // Turn our record back into a pointer if the exception object is a
3582 // pointer.
3583 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
3584 if (IsPointer)
3585 RTTITy = Context.getPointerType(RTTITy);
3586 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
3587 VBPtrOffset, OffsetInVBTable));
3588 }
3589 }
3590
3591 // C++14 [except.handle]p3:
3592 // A handler is a match for an exception object of type E if
3593 // - The handler is of type cv T or cv T& and E and T are the same type
3594 // (ignoring the top-level cv-qualifiers)
3595 CatchableTypes.insert(getCatchableType(T));
3596
3597 // C++14 [except.handle]p3:
3598 // A handler is a match for an exception object of type E if
3599 // - the handler is of type cv T or const T& where T is a pointer type and
3600 // E is a pointer type that can be converted to T by [...]
3601 // - a standard pointer conversion (4.10) not involving conversions to
3602 // pointers to private or protected or ambiguous classes
3603 //
David Majnemerd3d76692015-03-06 23:45:20 +00003604 // All pointers are convertible to pointer-to-void so ensure that it is in the
David Majnemer7c237072015-03-05 00:46:22 +00003605 // CatchableTypeArray.
3606 if (IsPointer)
3607 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
3608
David Majnemera1aea9a2015-03-12 17:44:49 +00003609 // C++14 [except.handle]p3:
3610 // A handler is a match for an exception object of type E if [...]
3611 // - the handler is of type cv T or const T& where T is a pointer or
3612 // pointer to member type and E is std::nullptr_t.
3613 //
3614 // We cannot possibly list all possible pointer types here, making this
3615 // implementation incompatible with the standard. However, MSVC includes an
3616 // entry for pointer-to-void in this case. Let's do the same.
3617 if (T->isNullPtrType())
3618 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
3619
David Majnemer7c237072015-03-05 00:46:22 +00003620 uint32_t NumEntries = CatchableTypes.size();
3621 llvm::Type *CTType =
3622 getImageRelativeType(getCatchableTypeType()->getPointerTo());
3623 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
3624 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
3625 llvm::Constant *Fields[] = {
3626 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries
3627 llvm::ConstantArray::get(
3628 AT, llvm::makeArrayRef(CatchableTypes.begin(),
3629 CatchableTypes.end())) // CatchableTypes
3630 };
3631 SmallString<256> MangledName;
3632 {
3633 llvm::raw_svector_ostream Out(MangledName);
3634 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
3635 }
3636 CTA = new llvm::GlobalVariable(
3637 CGM.getModule(), CTAType, /*Constant=*/true, getLinkageForRTTI(T),
3638 llvm::ConstantStruct::get(CTAType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00003639 CTA->setUnnamedAddr(true);
3640 CTA->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00003641 if (CTA->isWeakForLinker())
3642 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00003643 return CTA;
3644}
3645
3646llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
David Majnemerad803d42015-03-15 07:10:01 +00003647 bool IsConst, IsVolatile;
3648 T = decomposeTypeForEH(getContext(), T, IsConst, IsVolatile);
David Majnemer7c237072015-03-05 00:46:22 +00003649
3650 // The CatchableTypeArray enumerates the various (CV-unqualified) types that
3651 // the exception object may be caught as.
3652 llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
3653 // The first field in a CatchableTypeArray is the number of CatchableTypes.
3654 // This is used as a component of the mangled name which means that we need to
3655 // know what it is in order to see if we have previously generated the
3656 // ThrowInfo.
3657 uint32_t NumEntries =
3658 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
3659 ->getLimitedValue();
3660
3661 SmallString<256> MangledName;
3662 {
3663 llvm::raw_svector_ostream Out(MangledName);
3664 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, NumEntries,
3665 Out);
3666 }
3667
3668 // Reuse a previously generated ThrowInfo if we have generated an appropriate
3669 // one before.
3670 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3671 return GV;
3672
3673 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
3674 // be at least as CV qualified. Encode this requirement into the Flags
3675 // bitfield.
3676 uint32_t Flags = 0;
3677 if (IsConst)
3678 Flags |= 1;
3679 if (IsVolatile)
3680 Flags |= 2;
3681
3682 // The cleanup-function (a destructor) must be called when the exception
3683 // object's lifetime ends.
3684 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
3685 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
3686 if (CXXDestructorDecl *DtorD = RD->getDestructor())
3687 if (!DtorD->isTrivial())
3688 CleanupFn = llvm::ConstantExpr::getBitCast(
3689 CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete),
3690 CGM.Int8PtrTy);
3691 // This is unused as far as we can tell, initialize it to null.
3692 llvm::Constant *ForwardCompat =
3693 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
3694 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
3695 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
3696 llvm::StructType *TIType = getThrowInfoType();
3697 llvm::Constant *Fields[] = {
3698 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
3699 getImageRelativeConstant(CleanupFn), // CleanupFn
3700 ForwardCompat, // ForwardCompat
3701 PointerToCatchableTypes // CatchableTypeArray
3702 };
3703 auto *GV = new llvm::GlobalVariable(
3704 CGM.getModule(), TIType, /*Constant=*/true, getLinkageForRTTI(T),
3705 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00003706 GV->setUnnamedAddr(true);
3707 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00003708 if (GV->isWeakForLinker())
3709 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00003710 return GV;
3711}
3712
3713void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
3714 const Expr *SubExpr = E->getSubExpr();
3715 QualType ThrowType = SubExpr->getType();
3716 // The exception object lives on the stack and it's address is passed to the
3717 // runtime function.
3718 llvm::AllocaInst *AI = CGF.CreateMemTemp(ThrowType);
3719 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
3720 /*IsInit=*/true);
3721
3722 // The so-called ThrowInfo is used to describe how the exception object may be
3723 // caught.
3724 llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
3725
3726 // Call into the runtime to throw the exception.
3727 llvm::Value *Args[] = {CGF.Builder.CreateBitCast(AI, CGM.Int8PtrTy), TI};
3728 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
3729}