blob: 5b39e61173bb7b17b56584cdb1c181a82fdc07ee [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),
48 ThrowInfoType(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
86 llvm::Constant *getAddrOfRTTIDescriptor(QualType Ty) override;
87
David Majnemer1162d252014-06-22 19:05:33 +000088 bool shouldTypeidBeNullChecked(bool IsDeref, QualType SrcRecordTy) override;
89 void EmitBadTypeidCall(CodeGenFunction &CGF) override;
90 llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy,
91 llvm::Value *ThisPtr,
92 llvm::Type *StdTypeInfoPtrTy) override;
93
94 bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
95 QualType SrcRecordTy) override;
96
97 llvm::Value *EmitDynamicCastCall(CodeGenFunction &CGF, llvm::Value *Value,
98 QualType SrcRecordTy, QualType DestTy,
99 QualType DestRecordTy,
100 llvm::BasicBlock *CastEnd) override;
101
102 llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF, llvm::Value *Value,
103 QualType SrcRecordTy,
104 QualType DestTy) override;
105
106 bool EmitBadCastCall(CodeGenFunction &CGF) override;
107
Craig Topper4f12f102014-03-12 06:41:41 +0000108 llvm::Value *
109 GetVirtualBaseClassOffset(CodeGenFunction &CGF, llvm::Value *This,
110 const CXXRecordDecl *ClassDecl,
111 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000112
Craig Topper4f12f102014-03-12 06:41:41 +0000113 llvm::BasicBlock *
114 EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
115 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000116
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000117 void initializeHiddenVirtualInheritanceMembers(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000118 const CXXRecordDecl *RD) override;
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000119
Craig Topper4f12f102014-03-12 06:41:41 +0000120 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000121
Reid Klecknere7de47e2013-07-22 13:51:44 +0000122 // Background on MSVC destructors
123 // ==============================
124 //
125 // Both Itanium and MSVC ABIs have destructor variants. The variant names
126 // roughly correspond in the following way:
127 // Itanium Microsoft
128 // Base -> no name, just ~Class
129 // Complete -> vbase destructor
130 // Deleting -> scalar deleting destructor
131 // vector deleting destructor
132 //
133 // The base and complete destructors are the same as in Itanium, although the
134 // complete destructor does not accept a VTT parameter when there are virtual
135 // bases. A separate mechanism involving vtordisps is used to ensure that
136 // virtual methods of destroyed subobjects are not called.
137 //
138 // The deleting destructors accept an i32 bitfield as a second parameter. Bit
139 // 1 indicates if the memory should be deleted. Bit 2 indicates if the this
140 // pointer points to an array. The scalar deleting destructor assumes that
141 // bit 2 is zero, and therefore does not contain a loop.
142 //
143 // For virtual destructors, only one entry is reserved in the vftable, and it
144 // always points to the vector deleting destructor. The vector deleting
145 // destructor is the most general, so it can be used to destroy objects in
146 // place, delete single heap objects, or delete arrays.
147 //
148 // A TU defining a non-inline destructor is only guaranteed to emit a base
149 // destructor, and all of the other variants are emitted on an as-needed basis
150 // in COMDATs. Because a non-base destructor can be emitted in a TU that
151 // lacks a definition for the destructor, non-base destructors must always
152 // delegate to or alias the base destructor.
153
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000154 void buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
155 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000156
Reid Klecknere7de47e2013-07-22 13:51:44 +0000157 /// Non-base dtors should be emitted as delegating thunks in this ABI.
158 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000159 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000160 return DT != Dtor_Base;
161 }
162
Craig Topper4f12f102014-03-12 06:41:41 +0000163 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000164
Craig Topper4f12f102014-03-12 06:41:41 +0000165 const CXXRecordDecl *
166 getThisArgumentTypeForMethod(const CXXMethodDecl *MD) override {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000167 MD = MD->getCanonicalDecl();
168 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD)) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000169 MicrosoftVTableContext::MethodVFTableLocation ML =
170 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000171 // The vbases might be ordered differently in the final overrider object
172 // and the complete object, so the "this" argument may sometimes point to
173 // memory that has no particular type (e.g. past the complete object).
174 // In this case, we just use a generic pointer type.
175 // FIXME: might want to have a more precise type in the non-virtual
176 // multiple inheritance case.
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +0000177 if (ML.VBase || !ML.VFPtrOffset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000178 return nullptr;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000179 }
180 return MD->getParent();
181 }
182
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000183 llvm::Value *
184 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD,
185 llvm::Value *This,
186 bool VirtualCall) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000187
Reid Kleckner89077a12013-12-17 19:46:40 +0000188 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000189 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000190
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000191 llvm::Value *adjustThisParameterInVirtualFunctionPrologue(
Craig Topper4f12f102014-03-12 06:41:41 +0000192 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000193
Craig Topper4f12f102014-03-12 06:41:41 +0000194 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall29036752011-01-27 02:46:02 +0000195
Reid Kleckner89077a12013-12-17 19:46:40 +0000196 unsigned addImplicitConstructorArgs(CodeGenFunction &CGF,
197 const CXXConstructorDecl *D,
198 CXXCtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000199 bool Delegating,
200 CallArgList &Args) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000201
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000202 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
203 CXXDtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000204 bool Delegating, llvm::Value *This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000205
Craig Topper4f12f102014-03-12 06:41:41 +0000206 void emitVTableDefinitions(CodeGenVTables &CGVT,
207 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000208
209 llvm::Value *getVTableAddressPointInStructor(
210 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
211 BaseSubobject Base, const CXXRecordDecl *NearestVBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000212 bool &NeedsVirtualOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000213
214 llvm::Constant *
215 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000216 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000217
218 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000219 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000220
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000221 llvm::Value *getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000222 llvm::Value *This,
223 llvm::Type *Ty) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000224
David Majnemer0c0b6d92014-10-31 20:09:12 +0000225 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF,
226 const CXXDestructorDecl *Dtor,
227 CXXDtorType DtorType,
228 llvm::Value *This,
229 const CXXMemberCallExpr *CE) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000230
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000231 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000232 CallArgList &CallArgs) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000233 assert(GD.getDtorType() == Dtor_Deleting &&
234 "Only deleting destructor thunks are available in this ABI");
235 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)),
236 CGM.getContext().IntTy);
237 }
238
Craig Topper4f12f102014-03-12 06:41:41 +0000239 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000240
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000241 llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000242 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000243 llvm::GlobalVariable::LinkageTypes Linkage);
244
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000245 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000246 llvm::GlobalVariable *GV) const;
247
Hans Wennborgc94391d2014-06-06 20:04:01 +0000248 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
249 GlobalDecl GD, bool ReturnAdjustment) override {
Hans Wennborg853ae942014-05-30 16:59:42 +0000250 // Never dllimport/dllexport thunks.
251 Thunk->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
Hans Wennborgc94391d2014-06-06 20:04:01 +0000252
253 GVALinkage Linkage =
254 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
255
256 if (Linkage == GVA_Internal)
257 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
258 else if (ReturnAdjustment)
259 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
260 else
261 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000262 }
263
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000264 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, llvm::Value *This,
Craig Topper4f12f102014-03-12 06:41:41 +0000265 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000266
267 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000268 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000269
David Majnemerb3341ea2014-10-05 05:05:40 +0000270 void EmitThreadLocalInitFuncs(
271 CodeGenModule &CGM,
272 ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *>>
273 CXXThreadLocals,
274 ArrayRef<llvm::Function *> CXXThreadLocalInits,
275 ArrayRef<llvm::GlobalVariable *> CXXThreadLocalInitVars) override;
276
277 bool usesThreadWrapperFunction() const override { return false; }
278 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
279 QualType LValType) override;
280
John McCallc84ed6a2012-05-01 06:13:13 +0000281 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
282 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000283 bool PerformInit) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000284 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
285 llvm::Constant *Dtor, llvm::Constant *Addr) override;
John McCallc84ed6a2012-05-01 06:13:13 +0000286
John McCall29036752011-01-27 02:46:02 +0000287 // ==== Notes on array cookies =========
288 //
289 // MSVC seems to only use cookies when the class has a destructor; a
290 // two-argument usual array deallocation function isn't sufficient.
291 //
292 // For example, this code prints "100" and "1":
293 // struct A {
294 // char x;
295 // void *operator new[](size_t sz) {
296 // printf("%u\n", sz);
297 // return malloc(sz);
298 // }
299 // void operator delete[](void *p, size_t sz) {
300 // printf("%u\n", sz);
301 // free(p);
302 // }
303 // };
304 // int main() {
305 // A *p = new A[100];
306 // delete[] p;
307 // }
308 // Whereas it prints "104" and "104" if you give A a destructor.
John McCallb91cd662012-05-01 05:23:51 +0000309
Craig Topper4f12f102014-03-12 06:41:41 +0000310 bool requiresArrayCookie(const CXXDeleteExpr *expr,
311 QualType elementType) override;
312 bool requiresArrayCookie(const CXXNewExpr *expr) override;
313 CharUnits getArrayCookieSizeImpl(QualType type) override;
John McCallb91cd662012-05-01 05:23:51 +0000314 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
315 llvm::Value *NewPtr,
316 llvm::Value *NumElements,
317 const CXXNewExpr *expr,
Craig Topper4f12f102014-03-12 06:41:41 +0000318 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000319 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
320 llvm::Value *allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000321 CharUnits cookieSize) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000322
David Majnemer611cdb92014-07-07 08:09:15 +0000323 friend struct MSRTTIBuilder;
324
325 bool isImageRelative() const {
326 return CGM.getTarget().getPointerWidth(/*AddressSpace=*/0) == 64;
327 }
328
329 // 5 routines for constructing the llvm types for MS RTTI structs.
330 llvm::StructType *getTypeDescriptorType(StringRef TypeInfoString) {
331 llvm::SmallString<32> TDTypeName("rtti.TypeDescriptor");
332 TDTypeName += llvm::utostr(TypeInfoString.size());
333 llvm::StructType *&TypeDescriptorType =
334 TypeDescriptorTypeMap[TypeInfoString.size()];
335 if (TypeDescriptorType)
336 return TypeDescriptorType;
337 llvm::Type *FieldTypes[] = {
338 CGM.Int8PtrPtrTy,
339 CGM.Int8PtrTy,
340 llvm::ArrayType::get(CGM.Int8Ty, TypeInfoString.size() + 1)};
341 TypeDescriptorType =
342 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, TDTypeName);
343 return TypeDescriptorType;
344 }
345
346 llvm::Type *getImageRelativeType(llvm::Type *PtrType) {
347 if (!isImageRelative())
348 return PtrType;
349 return CGM.IntTy;
350 }
351
352 llvm::StructType *getBaseClassDescriptorType() {
353 if (BaseClassDescriptorType)
354 return BaseClassDescriptorType;
355 llvm::Type *FieldTypes[] = {
356 getImageRelativeType(CGM.Int8PtrTy),
357 CGM.IntTy,
358 CGM.IntTy,
359 CGM.IntTy,
360 CGM.IntTy,
361 CGM.IntTy,
362 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
363 };
364 BaseClassDescriptorType = llvm::StructType::create(
365 CGM.getLLVMContext(), FieldTypes, "rtti.BaseClassDescriptor");
366 return BaseClassDescriptorType;
367 }
368
369 llvm::StructType *getClassHierarchyDescriptorType() {
370 if (ClassHierarchyDescriptorType)
371 return ClassHierarchyDescriptorType;
372 // Forward-declare RTTIClassHierarchyDescriptor to break a cycle.
373 ClassHierarchyDescriptorType = llvm::StructType::create(
374 CGM.getLLVMContext(), "rtti.ClassHierarchyDescriptor");
375 llvm::Type *FieldTypes[] = {
376 CGM.IntTy,
377 CGM.IntTy,
378 CGM.IntTy,
379 getImageRelativeType(
380 getBaseClassDescriptorType()->getPointerTo()->getPointerTo()),
381 };
382 ClassHierarchyDescriptorType->setBody(FieldTypes);
383 return ClassHierarchyDescriptorType;
384 }
385
386 llvm::StructType *getCompleteObjectLocatorType() {
387 if (CompleteObjectLocatorType)
388 return CompleteObjectLocatorType;
389 CompleteObjectLocatorType = llvm::StructType::create(
390 CGM.getLLVMContext(), "rtti.CompleteObjectLocator");
391 llvm::Type *FieldTypes[] = {
392 CGM.IntTy,
393 CGM.IntTy,
394 CGM.IntTy,
395 getImageRelativeType(CGM.Int8PtrTy),
396 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
397 getImageRelativeType(CompleteObjectLocatorType),
398 };
399 llvm::ArrayRef<llvm::Type *> FieldTypesRef(FieldTypes);
400 if (!isImageRelative())
401 FieldTypesRef = FieldTypesRef.drop_back();
402 CompleteObjectLocatorType->setBody(FieldTypesRef);
403 return CompleteObjectLocatorType;
404 }
405
406 llvm::GlobalVariable *getImageBase() {
407 StringRef Name = "__ImageBase";
408 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name))
409 return GV;
410
411 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8Ty,
412 /*isConstant=*/true,
413 llvm::GlobalValue::ExternalLinkage,
414 /*Initializer=*/nullptr, Name);
415 }
416
417 llvm::Constant *getImageRelativeConstant(llvm::Constant *PtrVal) {
418 if (!isImageRelative())
419 return PtrVal;
420
David Majnemer7c237072015-03-05 00:46:22 +0000421 if (PtrVal->isNullValue())
422 return llvm::Constant::getNullValue(CGM.IntTy);
423
David Majnemer611cdb92014-07-07 08:09:15 +0000424 llvm::Constant *ImageBaseAsInt =
425 llvm::ConstantExpr::getPtrToInt(getImageBase(), CGM.IntPtrTy);
426 llvm::Constant *PtrValAsInt =
427 llvm::ConstantExpr::getPtrToInt(PtrVal, CGM.IntPtrTy);
428 llvm::Constant *Diff =
429 llvm::ConstantExpr::getSub(PtrValAsInt, ImageBaseAsInt,
430 /*HasNUW=*/true, /*HasNSW=*/true);
431 return llvm::ConstantExpr::getTrunc(Diff, CGM.IntTy);
432 }
433
Reid Kleckner407e8b62013-03-22 19:02:54 +0000434private:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000435 MicrosoftMangleContext &getMangleContext() {
436 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext());
437 }
438
Reid Kleckner2341ae32013-04-11 18:13:19 +0000439 llvm::Constant *getZeroInt() {
440 return llvm::ConstantInt::get(CGM.IntTy, 0);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000441 }
442
Reid Kleckner2341ae32013-04-11 18:13:19 +0000443 llvm::Constant *getAllOnesInt() {
444 return llvm::Constant::getAllOnesValue(CGM.IntTy);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000445 }
446
Reid Kleckner452abac2013-05-09 21:01:17 +0000447 llvm::Constant *getConstantOrZeroInt(llvm::Constant *C) {
448 return C ? C : getZeroInt();
449 }
450
451 llvm::Value *getValueOrZeroInt(llvm::Value *C) {
452 return C ? C : getZeroInt();
453 }
454
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000455 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD);
456
Reid Kleckner2341ae32013-04-11 18:13:19 +0000457 void
458 GetNullMemberPointerFields(const MemberPointerType *MPT,
459 llvm::SmallVectorImpl<llvm::Constant *> &fields);
460
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000461 /// \brief Shared code for virtual base adjustment. Returns the offset from
462 /// the vbptr to the virtual base. Optionally returns the address of the
463 /// vbptr itself.
464 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
465 llvm::Value *Base,
466 llvm::Value *VBPtrOffset,
467 llvm::Value *VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000468 llvm::Value **VBPtr = nullptr);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000469
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000470 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
471 llvm::Value *Base,
472 int32_t VBPtrOffset,
473 int32_t VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000474 llvm::Value **VBPtr = nullptr) {
Reid Kleckner0ba8ba42014-10-22 17:26:00 +0000475 assert(VBTableOffset % 4 == 0 && "should be byte offset into table of i32s");
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000476 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
477 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset);
478 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr);
479 }
480
David Majnemer5bc883f2015-02-27 02:38:02 +0000481 std::pair<llvm::Value *, llvm::Value *>
482 performBaseAdjustment(CodeGenFunction &CGF, llvm::Value *Value,
483 QualType SrcRecordTy);
484
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000485 /// \brief Performs a full virtual base adjustment. Used to dereference
486 /// pointers to members of virtual bases.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000487 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E,
488 const CXXRecordDecl *RD, llvm::Value *Base,
Reid Kleckner2341ae32013-04-11 18:13:19 +0000489 llvm::Value *VirtualBaseAdjustmentOffset,
490 llvm::Value *VBPtrOffset /* optional */);
491
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000492 /// \brief Emits a full member pointer with the fields common to data and
493 /// function member pointers.
494 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField,
495 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +0000496 const CXXRecordDecl *RD,
497 CharUnits NonVirtualBaseAdjustment);
498
499 llvm::Constant *BuildMemberPointer(const CXXRecordDecl *RD,
500 const CXXMethodDecl *MD,
501 CharUnits NonVirtualBaseAdjustment);
502
503 bool MemberPointerConstantIsNull(const MemberPointerType *MPT,
504 llvm::Constant *MP);
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000505
Reid Kleckner7810af02013-06-19 15:20:38 +0000506 /// \brief - Initialize all vbptrs of 'this' with RD as the complete type.
507 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
508
509 /// \brief Caching wrapper around VBTableBuilder::enumerateVBTables().
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000510 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000511
Hans Wennborg88497d62013-11-15 17:24:45 +0000512 /// \brief Generate a thunk for calling a virtual member function MD.
Reid Klecknere4a52202014-02-21 02:27:32 +0000513 llvm::Function *EmitVirtualMemPtrThunk(
514 const CXXMethodDecl *MD,
515 const MicrosoftVTableContext::MethodVFTableLocation &ML);
Hans Wennborg88497d62013-11-15 17:24:45 +0000516
Reid Kleckner407e8b62013-03-22 19:02:54 +0000517public:
Craig Topper4f12f102014-03-12 06:41:41 +0000518 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000519
Craig Topper4f12f102014-03-12 06:41:41 +0000520 bool isZeroInitializable(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000521
David Majnemerb3e56542014-08-07 22:56:13 +0000522 bool isMemberPointerConvertible(const MemberPointerType *MPT) const override {
523 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemer99281062014-09-18 22:05:54 +0000524 return RD->hasAttr<MSInheritanceAttr>();
525 }
526
David Blaikie1cbb9712014-11-14 19:09:44 +0000527 bool isTypeInfoCalculable(QualType Ty) const override {
David Majnemer99281062014-09-18 22:05:54 +0000528 if (!CGCXXABI::isTypeInfoCalculable(Ty))
529 return false;
530 if (const auto *MPT = Ty->getAs<MemberPointerType>()) {
531 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
532 if (!RD->hasAttr<MSInheritanceAttr>())
533 return false;
534 }
535 return true;
David Majnemerb3e56542014-08-07 22:56:13 +0000536 }
537
Craig Topper4f12f102014-03-12 06:41:41 +0000538 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000539
Craig Topper4f12f102014-03-12 06:41:41 +0000540 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
541 CharUnits offset) override;
542 llvm::Constant *EmitMemberPointer(const CXXMethodDecl *MD) override;
543 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000544
Craig Topper4f12f102014-03-12 06:41:41 +0000545 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
546 llvm::Value *L,
547 llvm::Value *R,
548 const MemberPointerType *MPT,
549 bool Inequality) override;
Reid Kleckner700c3ee2013-04-30 20:15:14 +0000550
Craig Topper4f12f102014-03-12 06:41:41 +0000551 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
552 llvm::Value *MemPtr,
553 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000554
Craig Topper4f12f102014-03-12 06:41:41 +0000555 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000556 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
557 llvm::Value *Base, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000558 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000559
Craig Topper4f12f102014-03-12 06:41:41 +0000560 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
561 const CastExpr *E,
562 llvm::Value *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000563
Craig Topper4f12f102014-03-12 06:41:41 +0000564 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
565 llvm::Constant *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000566
Craig Topper4f12f102014-03-12 06:41:41 +0000567 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000568 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E,
569 llvm::Value *&This, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000570 const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000571
Rafael Espindola91f68b42014-09-15 19:20:10 +0000572 void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) override;
573
David Majnemer7c237072015-03-05 00:46:22 +0000574 llvm::StructType *getCatchableTypeType() {
575 if (CatchableTypeType)
576 return CatchableTypeType;
577 llvm::Type *FieldTypes[] = {
578 CGM.IntTy, // Flags
579 getImageRelativeType(CGM.Int8PtrTy), // TypeDescriptor
580 CGM.IntTy, // NonVirtualAdjustment
581 CGM.IntTy, // OffsetToVBPtr
582 CGM.IntTy, // VBTableIndex
583 CGM.IntTy, // Size
584 getImageRelativeType(CGM.Int8PtrTy) // CopyCtor
585 };
586 CatchableTypeType = llvm::StructType::create(
587 CGM.getLLVMContext(), FieldTypes, "eh.CatchableType");
588 return CatchableTypeType;
589 }
590
591 llvm::StructType *getCatchableTypeArrayType(uint32_t NumEntries) {
592 llvm::StructType *&CatchableTypeArrayType =
593 CatchableTypeArrayTypeMap[NumEntries];
594 if (CatchableTypeArrayType)
595 return CatchableTypeArrayType;
596
597 llvm::SmallString<23> CTATypeName("eh.CatchableTypeArray.");
598 CTATypeName += llvm::utostr(NumEntries);
599 llvm::Type *CTType =
600 getImageRelativeType(getCatchableTypeType()->getPointerTo());
601 llvm::Type *FieldTypes[] = {
602 CGM.IntTy, // NumEntries
603 llvm::ArrayType::get(CTType, NumEntries) // CatchableTypes
604 };
605 CatchableTypeArrayType =
606 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, CTATypeName);
607 return CatchableTypeArrayType;
608 }
609
610 llvm::StructType *getThrowInfoType() {
611 if (ThrowInfoType)
612 return ThrowInfoType;
613 llvm::Type *FieldTypes[] = {
614 CGM.IntTy, // Flags
615 getImageRelativeType(CGM.Int8PtrTy), // CleanupFn
616 getImageRelativeType(CGM.Int8PtrTy), // ForwardCompat
617 getImageRelativeType(CGM.Int8PtrTy) // CatchableTypeArray
618 };
619 ThrowInfoType = llvm::StructType::create(CGM.getLLVMContext(), FieldTypes,
620 "eh.ThrowInfo");
621 return ThrowInfoType;
622 }
623
624 llvm::Constant *getThrowFn() {
625 // _CxxThrowException is passed an exception object and a ThrowInfo object
626 // which describes the exception.
627 llvm::Type *Args[] = {CGM.Int8PtrTy, getThrowInfoType()->getPointerTo()};
628 llvm::FunctionType *FTy =
629 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
630 auto *Fn = cast<llvm::Function>(
631 CGM.CreateRuntimeFunction(FTy, "_CxxThrowException"));
632 // _CxxThrowException is stdcall on 32-bit x86 platforms.
633 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::x86)
634 Fn->setCallingConv(llvm::CallingConv::X86_StdCall);
635 return Fn;
636 }
637
638 llvm::Constant *getCatchableType(QualType T,
639 uint32_t NVOffset = 0,
640 int32_t VBPtrOffset = -1,
641 uint32_t VBIndex = 0);
642
643 llvm::GlobalVariable *getCatchableTypeArray(QualType T);
644
645 llvm::GlobalVariable *getThrowInfo(QualType T);
646
Reid Kleckner7810af02013-06-19 15:20:38 +0000647private:
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000648 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy;
David Majnemerd905da42014-07-01 20:30:31 +0000649 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy;
650 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000651 /// \brief All the vftables that have been referenced.
652 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000653 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000654
655 /// \brief This set holds the record decls we've deferred vtable emission for.
656 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
657
658
659 /// \brief All the vbtables which have been referenced.
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000660 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap;
Reid Klecknerd8110b62013-09-10 20:14:30 +0000661
662 /// Info on the global variable used to guard initialization of static locals.
663 /// The BitIndex field is only used for externally invisible declarations.
664 struct GuardInfo {
Craig Topper8a13c412014-05-21 05:09:00 +0000665 GuardInfo() : Guard(nullptr), BitIndex(0) {}
Reid Klecknerd8110b62013-09-10 20:14:30 +0000666 llvm::GlobalVariable *Guard;
667 unsigned BitIndex;
668 };
669
670 /// Map from DeclContext to the current guard variable. We assume that the
671 /// AST is visited in source code order.
672 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap;
David Majnemer611cdb92014-07-07 08:09:15 +0000673
674 llvm::DenseMap<size_t, llvm::StructType *> TypeDescriptorTypeMap;
675 llvm::StructType *BaseClassDescriptorType;
676 llvm::StructType *ClassHierarchyDescriptorType;
677 llvm::StructType *CompleteObjectLocatorType;
David Majnemer7c237072015-03-05 00:46:22 +0000678
679 llvm::DenseMap<QualType, llvm::GlobalVariable *> CatchableTypeArrays;
680
681 llvm::StructType *CatchableTypeType;
682 llvm::DenseMap<uint32_t, llvm::StructType *> CatchableTypeArrayTypeMap;
683 llvm::StructType *ThrowInfoType;
Charles Davis74ce8592010-06-09 23:25:41 +0000684};
685
686}
687
Reid Klecknere39ee212014-05-03 00:33:28 +0000688CGCXXABI::RecordArgABI
689MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const {
690 switch (CGM.getTarget().getTriple().getArch()) {
691 default:
692 // FIXME: Implement for other architectures.
693 return RAA_Default;
694
695 case llvm::Triple::x86:
Reid Klecknercf87e102014-05-14 16:02:09 +0000696 // All record arguments are passed in memory on x86. Decide whether to
697 // construct the object directly in argument memory, or to construct the
698 // argument elsewhere and copy the bytes during the call.
699
700 // If C++ prohibits us from making a copy, construct the arguments directly
701 // into argument memory.
702 if (!canCopyArgument(RD))
Reid Klecknere39ee212014-05-03 00:33:28 +0000703 return RAA_DirectInMemory;
Reid Klecknercf87e102014-05-14 16:02:09 +0000704
705 // Otherwise, construct the argument into a temporary and copy the bytes
706 // into the outgoing argument memory.
Reid Klecknere39ee212014-05-03 00:33:28 +0000707 return RAA_Default;
708
709 case llvm::Triple::x86_64:
710 // Win64 passes objects with non-trivial copy ctors indirectly.
711 if (RD->hasNonTrivialCopyConstructor())
712 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000713
Reid Kleckner80944df2014-10-31 22:00:51 +0000714 // If an object has a destructor, we'd really like to pass it indirectly
715 // because it allows us to elide copies. Unfortunately, MSVC makes that
716 // impossible for small types, which it will pass in a single register or
717 // stack slot. Most objects with dtors are large-ish, so handle that early.
718 // We can't call out all large objects as being indirect because there are
719 // multiple x64 calling conventions and the C++ ABI code shouldn't dictate
720 // how we pass large POD types.
721 if (RD->hasNonTrivialDestructor() &&
722 getContext().getTypeSize(RD->getTypeForDecl()) > 64)
Reid Klecknere39ee212014-05-03 00:33:28 +0000723 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000724
725 // We have a trivial copy constructor or no copy constructors, but we have
726 // to make sure it isn't deleted.
727 bool CopyDeleted = false;
728 for (const CXXConstructorDecl *CD : RD->ctors()) {
729 if (CD->isCopyConstructor()) {
730 assert(CD->isTrivial());
731 // We had at least one undeleted trivial copy ctor. Return directly.
732 if (!CD->isDeleted())
733 return RAA_Default;
734 CopyDeleted = true;
735 }
736 }
737
738 // The trivial copy constructor was deleted. Return indirectly.
739 if (CopyDeleted)
740 return RAA_Indirect;
741
742 // There were no copy ctors. Return in RAX.
Reid Klecknere39ee212014-05-03 00:33:28 +0000743 return RAA_Default;
744 }
745
746 llvm_unreachable("invalid enum");
747}
748
David Majnemer08681372014-11-01 07:37:17 +0000749void MicrosoftCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
750 const CXXDeleteExpr *DE,
751 llvm::Value *Ptr,
752 QualType ElementType,
753 const CXXDestructorDecl *Dtor) {
David Majnemer0c0b6d92014-10-31 20:09:12 +0000754 // FIXME: Provide a source location here even though there's no
755 // CXXMemberCallExpr for dtor call.
David Majnemer08681372014-11-01 07:37:17 +0000756 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000757 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
758 llvm::Value *MDThis =
759 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr);
760 if (UseGlobalDelete)
David Majnemer08681372014-11-01 07:37:17 +0000761 CGF.EmitDeleteCall(DE->getOperatorDelete(), MDThis, ElementType);
John McCall82fb8922012-09-25 10:10:39 +0000762}
763
David Majnemer442d0a22014-11-25 07:20:20 +0000764void MicrosoftCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
David Majnemer7c237072015-03-05 00:46:22 +0000765 llvm::Value *Args[] = {
766 llvm::ConstantPointerNull::get(CGM.Int8PtrTy),
767 llvm::ConstantPointerNull::get(getThrowInfoType()->getPointerTo())};
768 auto *Fn = getThrowFn();
David Majnemer442d0a22014-11-25 07:20:20 +0000769 if (isNoReturn)
770 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, Args);
771 else
772 CGF.EmitRuntimeCallOrInvoke(Fn, Args);
773}
774
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000775namespace {
776struct CallEndCatchMSVC : EHScopeStack::Cleanup {
777 CallEndCatchMSVC() {}
778 void Emit(CodeGenFunction &CGF, Flags flags) override {
779 CGF.EmitNounwindRuntimeCall(
780 CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_endcatch));
781 }
782};
783}
784
785void MicrosoftCXXABI::emitBeginCatch(CodeGenFunction &CGF,
786 const CXXCatchStmt *S) {
787 // In the MS ABI, the runtime handles the copy, and the catch handler is
788 // responsible for destruction.
789 VarDecl *CatchParam = S->getExceptionDecl();
790 llvm::Value *Exn = CGF.getExceptionFromSlot();
791 llvm::Function *BeginCatch =
792 CGF.CGM.getIntrinsic(llvm::Intrinsic::eh_begincatch);
793
794 if (!CatchParam) {
795 llvm::Value *Args[2] = {Exn, llvm::Constant::getNullValue(CGF.Int8PtrTy)};
796 CGF.EmitNounwindRuntimeCall(BeginCatch, Args);
797 CGF.EHStack.pushCleanup<CallEndCatchMSVC>(NormalAndEHCleanup);
798 return;
799 }
800
801 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
802 llvm::Value *ParamAddr =
803 CGF.Builder.CreateBitCast(var.getObjectAddress(CGF), CGF.Int8PtrTy);
804 llvm::Value *Args[2] = {Exn, ParamAddr};
805 CGF.EmitNounwindRuntimeCall(BeginCatch, Args);
806 // FIXME: Do we really need exceptional endcatch cleanups?
807 CGF.EHStack.pushCleanup<CallEndCatchMSVC>(NormalAndEHCleanup);
808 CGF.EmitAutoVarCleanups(var);
809}
810
David Majnemer5bc883f2015-02-27 02:38:02 +0000811std::pair<llvm::Value *, llvm::Value *>
812MicrosoftCXXABI::performBaseAdjustment(CodeGenFunction &CGF, llvm::Value *Value,
813 QualType SrcRecordTy) {
David Majnemer1162d252014-06-22 19:05:33 +0000814 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
815 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
David Majnemer5bc883f2015-02-27 02:38:02 +0000816 const ASTContext &Context = CGF.getContext();
David Majnemer1162d252014-06-22 19:05:33 +0000817
David Majnemer5bc883f2015-02-27 02:38:02 +0000818 if (Context.getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
David Majnemer1162d252014-06-22 19:05:33 +0000819 return std::make_pair(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0));
820
821 // Perform a base adjustment.
David Majnemer5bc883f2015-02-27 02:38:02 +0000822 const CXXBaseSpecifier *PolymorphicBase = std::find_if(
823 SrcDecl->vbases_begin(), SrcDecl->vbases_end(),
824 [&](const CXXBaseSpecifier &Base) {
825 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
826 return Context.getASTRecordLayout(BaseDecl).hasExtendableVFPtr();
827 });
828 llvm::Value *Offset = GetVirtualBaseClassOffset(
829 CGF, Value, SrcDecl, PolymorphicBase->getType()->getAsCXXRecordDecl());
David Majnemer1162d252014-06-22 19:05:33 +0000830 Value = CGF.Builder.CreateInBoundsGEP(Value, Offset);
831 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
832 return std::make_pair(Value, Offset);
833}
834
835bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
836 QualType SrcRecordTy) {
837 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
838 return IsDeref &&
839 !CGM.getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
840}
841
842static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF,
843 llvm::Value *Argument) {
844 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
845 llvm::FunctionType *FTy =
846 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
847 llvm::Value *Args[] = {Argument};
848 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
849 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
850}
851
852void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
853 llvm::CallSite Call =
854 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
855 Call.setDoesNotReturn();
856 CGF.Builder.CreateUnreachable();
857}
858
859llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
860 QualType SrcRecordTy,
861 llvm::Value *ThisPtr,
862 llvm::Type *StdTypeInfoPtrTy) {
863 llvm::Value *Offset;
864 std::tie(ThisPtr, Offset) = performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
865 return CGF.Builder.CreateBitCast(
866 emitRTtypeidCall(CGF, ThisPtr).getInstruction(), StdTypeInfoPtrTy);
867}
868
869bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
870 QualType SrcRecordTy) {
871 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
872 return SrcIsPtr &&
873 !CGM.getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
874}
875
876llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
877 CodeGenFunction &CGF, llvm::Value *Value, QualType SrcRecordTy,
878 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
879 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
880
881 llvm::Value *SrcRTTI =
882 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
883 llvm::Value *DestRTTI =
884 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
885
886 llvm::Value *Offset;
887 std::tie(Value, Offset) = performBaseAdjustment(CGF, Value, SrcRecordTy);
888
889 // PVOID __RTDynamicCast(
890 // PVOID inptr,
891 // LONG VfDelta,
892 // PVOID SrcType,
893 // PVOID TargetType,
894 // BOOL isReference)
895 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
896 CGF.Int8PtrTy, CGF.Int32Ty};
897 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
898 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
899 "__RTDynamicCast");
900 llvm::Value *Args[] = {
901 Value, Offset, SrcRTTI, DestRTTI,
902 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
903 Value = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction();
904 return CGF.Builder.CreateBitCast(Value, DestLTy);
905}
906
907llvm::Value *
908MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, llvm::Value *Value,
909 QualType SrcRecordTy,
910 QualType DestTy) {
911 llvm::Value *Offset;
912 std::tie(Value, Offset) = performBaseAdjustment(CGF, Value, SrcRecordTy);
913
914 // PVOID __RTCastToVoid(
915 // PVOID inptr)
916 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
917 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
918 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
919 "__RTCastToVoid");
920 llvm::Value *Args[] = {Value};
921 return CGF.EmitRuntimeCall(Function, Args);
922}
923
924bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
925 return false;
926}
927
David Majnemerca32f932014-09-01 18:50:02 +0000928llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
929 CodeGenFunction &CGF, llvm::Value *This, const CXXRecordDecl *ClassDecl,
930 const CXXRecordDecl *BaseClassDecl) {
Reid Kleckner5b1b5d52014-01-14 00:50:39 +0000931 int64_t VBPtrChars =
932 getContext().getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000933 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000934 CharUnits IntSize = getContext().getTypeSizeInChars(getContext().IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000935 CharUnits VBTableChars =
936 IntSize *
937 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000938 llvm::Value *VBTableOffset =
David Majnemerca32f932014-09-01 18:50:02 +0000939 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000940
941 llvm::Value *VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +0000942 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000943 VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +0000944 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000945 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
946}
947
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000948bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
949 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +0000950}
951
David Majnemer0c0b6d92014-10-31 20:09:12 +0000952static bool isDeletingDtor(GlobalDecl GD) {
953 return isa<CXXDestructorDecl>(GD.getDecl()) &&
954 GD.getDtorType() == Dtor_Deleting;
955}
956
957bool MicrosoftCXXABI::hasMostDerivedReturn(GlobalDecl GD) const {
958 return isDeletingDtor(GD);
959}
960
Reid Kleckner40ca9132014-05-13 22:05:45 +0000961bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
962 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
963 if (!RD)
964 return false;
965
966 if (FI.isInstanceMethod()) {
967 // If it's an instance method, aggregates are always returned indirectly via
968 // the second parameter.
969 FI.getReturnInfo() = ABIArgInfo::getIndirect(0, /*ByVal=*/false);
970 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod());
971 return true;
972 } else if (!RD->isPOD()) {
973 // If it's a free function, non-POD types are returned indirectly.
974 FI.getReturnInfo() = ABIArgInfo::getIndirect(0, /*ByVal=*/false);
975 return true;
976 }
977
978 // Otherwise, use the C ABI rules.
979 return false;
980}
981
Reid Kleckner7810af02013-06-19 15:20:38 +0000982llvm::BasicBlock *
983MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
984 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000985 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
986 assert(IsMostDerivedClass &&
987 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +0000988 llvm::Value *IsCompleteObject =
989 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000990
991 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
992 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
993 CGF.Builder.CreateCondBr(IsCompleteObject,
994 CallVbaseCtorsBB, SkipVbaseCtorsBB);
995
996 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +0000997
998 // Fill in the vbtable pointers here.
999 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001000
1001 // CGF will put the base ctor calls in this basic block for us later.
1002
1003 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +00001004}
1005
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001006void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
1007 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
1008 // In most cases, an override for a vbase virtual method can adjust
1009 // the "this" parameter by applying a constant offset.
1010 // However, this is not enough while a constructor or a destructor of some
1011 // class X is being executed if all the following conditions are met:
1012 // - X has virtual bases, (1)
1013 // - X overrides a virtual method M of a vbase Y, (2)
1014 // - X itself is a vbase of the most derived class.
1015 //
1016 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
1017 // which holds the extra amount of "this" adjustment we must do when we use
1018 // the X vftables (i.e. during X ctor or dtor).
1019 // Outside the ctors and dtors, the values of vtorDisps are zero.
1020
1021 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
1022 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
1023 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
1024 CGBuilderTy &Builder = CGF.Builder;
1025
1026 unsigned AS =
1027 cast<llvm::PointerType>(getThisValue(CGF)->getType())->getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +00001028 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001029
1030 for (VBOffsets::const_iterator I = VBaseMap.begin(), E = VBaseMap.end();
1031 I != E; ++I) {
1032 if (!I->second.hasVtorDisp())
1033 continue;
1034
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +00001035 llvm::Value *VBaseOffset =
1036 GetVirtualBaseClassOffset(CGF, getThisValue(CGF), RD, I->first);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +00001037 // FIXME: it doesn't look right that we SExt in GetVirtualBaseClassOffset()
1038 // just to Trunc back immediately.
1039 VBaseOffset = Builder.CreateTruncOrBitCast(VBaseOffset, CGF.Int32Ty);
1040 uint64_t ConstantVBaseOffset =
1041 Layout.getVBaseClassOffset(I->first).getQuantity();
1042
1043 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
1044 llvm::Value *VtorDispValue = Builder.CreateSub(
1045 VBaseOffset, llvm::ConstantInt::get(CGM.Int32Ty, ConstantVBaseOffset),
1046 "vtordisp.value");
1047
1048 if (!Int8This)
1049 Int8This = Builder.CreateBitCast(getThisValue(CGF),
1050 CGF.Int8Ty->getPointerTo(AS));
1051 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
1052 // vtorDisp is always the 32-bits before the vbase in the class layout.
1053 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
1054 VtorDispPtr = Builder.CreateBitCast(
1055 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
1056
1057 Builder.CreateStore(VtorDispValue, VtorDispPtr);
1058 }
1059}
1060
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001061void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1062 // There's only one constructor type in this ABI.
1063 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
1064}
1065
Reid Kleckner7810af02013-06-19 15:20:38 +00001066void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
1067 const CXXRecordDecl *RD) {
1068 llvm::Value *ThisInt8Ptr =
1069 CGF.Builder.CreateBitCast(getThisValue(CGF), CGM.Int8PtrTy, "this.int8");
Reid Kleckner5f080942014-01-03 23:42:00 +00001070 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001071
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001072 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1073 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001074 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001075 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +00001076 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001077 CGM.getContext().getASTRecordLayout(VBT->BaseWithVPtr);
Reid Kleckner5f080942014-01-03 23:42:00 +00001078 CharUnits Offs = VBT->NonVirtualOffset;
1079 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001080 if (VBT->getVBaseWithVPtr())
1081 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
Reid Kleckner7810af02013-06-19 15:20:38 +00001082 llvm::Value *VBPtr =
Reid Kleckner5f080942014-01-03 23:42:00 +00001083 CGF.Builder.CreateConstInBoundsGEP1_64(ThisInt8Ptr, Offs.getQuantity());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001084 llvm::Value *GVPtr = CGF.Builder.CreateConstInBoundsGEP2_32(GV, 0, 0);
1085 VBPtr = CGF.Builder.CreateBitCast(VBPtr, GVPtr->getType()->getPointerTo(0),
Reid Kleckner5f080942014-01-03 23:42:00 +00001086 "vbptr." + VBT->ReusingBase->getName());
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00001087 CGF.Builder.CreateStore(GVPtr, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +00001088 }
1089}
1090
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001091void
1092MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001093 SmallVectorImpl<CanQualType> &ArgTys) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001094 // TODO: 'for base' flag
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001095 if (T == StructorType::Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001096 // The scalar deleting destructor takes an implicit int parameter.
1097 ArgTys.push_back(CGM.getContext().IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001098 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001099 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
1100 if (!CD)
1101 return;
1102
1103 // All parameters are already in place except is_most_derived, which goes
1104 // after 'this' if it's variadic and last if it's not.
1105
1106 const CXXRecordDecl *Class = CD->getParent();
1107 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
1108 if (Class->getNumVBases()) {
1109 if (FPT->isVariadic())
1110 ArgTys.insert(ArgTys.begin() + 1, CGM.getContext().IntTy);
1111 else
1112 ArgTys.push_back(CGM.getContext().IntTy);
1113 }
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001114}
1115
Reid Klecknere7de47e2013-07-22 13:51:44 +00001116void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
1117 // The TU defining a dtor is only guaranteed to emit a base destructor. All
1118 // other destructor variants are delegating thunks.
1119 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
1120}
1121
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001122CharUnits
1123MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001124 GD = GD.getCanonicalDecl();
1125 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001126
1127 GlobalDecl LookupGD = GD;
1128 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1129 // Complete destructors take a pointer to the complete object as a
1130 // parameter, thus don't need this adjustment.
1131 if (GD.getDtorType() == Dtor_Complete)
1132 return CharUnits();
1133
1134 // There's no Dtor_Base in vftable but it shares the this adjustment with
1135 // the deleting one, so look it up instead.
1136 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1137 }
1138
1139 MicrosoftVTableContext::MethodVFTableLocation ML =
1140 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
1141 CharUnits Adjustment = ML.VFPtrOffset;
1142
1143 // Normal virtual instance methods need to adjust from the vfptr that first
1144 // defined the virtual method to the virtual base subobject, but destructors
1145 // do not. The vector deleting destructor thunk applies this adjustment for
1146 // us if necessary.
1147 if (isa<CXXDestructorDecl>(MD))
1148 Adjustment = CharUnits::Zero();
1149
1150 if (ML.VBase) {
1151 const ASTRecordLayout &DerivedLayout =
1152 CGM.getContext().getASTRecordLayout(MD->getParent());
1153 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
1154 }
1155
1156 return Adjustment;
1157}
1158
1159llvm::Value *MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
1160 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This, bool VirtualCall) {
1161 if (!VirtualCall) {
1162 // If the call of a virtual function is not virtual, we just have to
1163 // compensate for the adjustment the virtual function does in its prologue.
1164 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
1165 if (Adjustment.isZero())
1166 return This;
1167
1168 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1169 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS);
1170 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1171 assert(Adjustment.isPositive());
1172 return CGF.Builder.CreateConstGEP1_32(This, Adjustment.getQuantity());
1173 }
1174
1175 GD = GD.getCanonicalDecl();
1176 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001177
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001178 GlobalDecl LookupGD = GD;
1179 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1180 // Complete dtors take a pointer to the complete object,
1181 // thus don't need adjustment.
1182 if (GD.getDtorType() == Dtor_Complete)
1183 return This;
1184
1185 // There's only Dtor_Deleting in vftable but it shares the this adjustment
1186 // with the base one, so look up the deleting one instead.
1187 LookupGD = GlobalDecl(DD, Dtor_Deleting);
1188 }
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001189 MicrosoftVTableContext::MethodVFTableLocation ML =
1190 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001191
1192 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1193 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS);
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001194 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001195
1196 // Base destructors expect 'this' to point to the beginning of the base
1197 // subobject, not the first vfptr that happens to contain the virtual dtor.
1198 // However, we still need to apply the virtual base adjustment.
1199 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1200 StaticOffset = CharUnits::Zero();
1201
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001202 if (ML.VBase) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001203 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1204 llvm::Value *VBaseOffset =
1205 GetVirtualBaseClassOffset(CGF, This, MD->getParent(), ML.VBase);
1206 This = CGF.Builder.CreateInBoundsGEP(This, VBaseOffset);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001207 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001208 if (!StaticOffset.isZero()) {
1209 assert(StaticOffset.isPositive());
1210 This = CGF.Builder.CreateBitCast(This, charPtrTy);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001211 if (ML.VBase) {
1212 // Non-virtual adjustment might result in a pointer outside the allocated
1213 // object, e.g. if the final overrider class is laid out after the virtual
1214 // base that declares a method in the most derived class.
1215 // FIXME: Update the code that emits this adjustment in thunks prologues.
1216 This = CGF.Builder.CreateConstGEP1_32(This, StaticOffset.getQuantity());
1217 } else {
1218 This = CGF.Builder.CreateConstInBoundsGEP1_32(This,
1219 StaticOffset.getQuantity());
1220 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001221 }
1222 return This;
1223}
1224
Reid Kleckner89077a12013-12-17 19:46:40 +00001225void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1226 QualType &ResTy,
1227 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001228 ASTContext &Context = getContext();
1229 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001230 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001231 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1232 ImplicitParamDecl *IsMostDerived
Craig Topper8a13c412014-05-21 05:09:00 +00001233 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001234 CGF.CurGD.getDecl()->getLocation(),
1235 &Context.Idents.get("is_most_derived"),
1236 Context.IntTy);
Reid Kleckner89077a12013-12-17 19:46:40 +00001237 // The 'most_derived' parameter goes second if the ctor is variadic and last
1238 // if it's not. Dtors can't be variadic.
1239 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1240 if (FPT->isVariadic())
1241 Params.insert(Params.begin() + 1, IsMostDerived);
1242 else
1243 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001244 getStructorImplicitParamDecl(CGF) = IsMostDerived;
David Majnemer0c0b6d92014-10-31 20:09:12 +00001245 } else if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001246 ImplicitParamDecl *ShouldDelete
Craig Topper8a13c412014-05-21 05:09:00 +00001247 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001248 CGF.CurGD.getDecl()->getLocation(),
1249 &Context.Idents.get("should_call_delete"),
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001250 Context.IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001251 Params.push_back(ShouldDelete);
1252 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1253 }
John McCall0f999f32012-09-25 08:00:39 +00001254}
1255
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001256llvm::Value *MicrosoftCXXABI::adjustThisParameterInVirtualFunctionPrologue(
1257 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001258 // In this ABI, every virtual function takes a pointer to one of the
1259 // subobjects that first defines it as the 'this' parameter, rather than a
Alp Tokerf6a24ce2013-12-05 16:25:25 +00001260 // pointer to the final overrider subobject. Thus, we need to adjust it back
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001261 // to the final overrider subobject before use.
1262 // See comments in the MicrosoftVFTableContext implementation for the details.
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001263 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001264 if (Adjustment.isZero())
1265 return This;
1266
1267 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1268 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1269 *thisTy = This->getType();
1270
1271 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1272 assert(Adjustment.isPositive());
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001273 This =
1274 CGF.Builder.CreateConstInBoundsGEP1_32(This, -Adjustment.getQuantity());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001275 return CGF.Builder.CreateBitCast(This, thisTy);
1276}
1277
John McCall0f999f32012-09-25 08:00:39 +00001278void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
1279 EmitThisParam(CGF);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001280
1281 /// If this is a function that the ABI specifies returns 'this', initialize
1282 /// the return slot to 'this' at the start of the function.
1283 ///
1284 /// Unlike the setting of return types, this is done within the ABI
1285 /// implementation instead of by clients of CGCXXABI because:
1286 /// 1) getThisValue is currently protected
1287 /// 2) in theory, an ABI could implement 'this' returns some other way;
1288 /// HasThisReturn only specifies a contract, not the implementation
1289 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001290 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001291 else if (hasMostDerivedReturn(CGF.CurGD))
1292 CGF.Builder.CreateStore(CGF.EmitCastToVoidPtr(getThisValue(CGF)),
1293 CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001294
1295 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1296 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1297 assert(getStructorImplicitParamDecl(CGF) &&
1298 "no implicit parameter for a constructor with virtual bases?");
1299 getStructorImplicitParamValue(CGF)
1300 = CGF.Builder.CreateLoad(
1301 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1302 "is_most_derived");
1303 }
1304
David Majnemer0c0b6d92014-10-31 20:09:12 +00001305 if (isDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001306 assert(getStructorImplicitParamDecl(CGF) &&
1307 "no implicit parameter for a deleting destructor?");
1308 getStructorImplicitParamValue(CGF)
1309 = CGF.Builder.CreateLoad(
1310 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1311 "should_call_delete");
1312 }
John McCall0f999f32012-09-25 08:00:39 +00001313}
1314
Reid Kleckner89077a12013-12-17 19:46:40 +00001315unsigned MicrosoftCXXABI::addImplicitConstructorArgs(
1316 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1317 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001318 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001319
Reid Kleckner89077a12013-12-17 19:46:40 +00001320 // Check if we need a 'most_derived' parameter.
1321 if (!D->getParent()->getNumVBases())
1322 return 0;
1323
1324 // Add the 'most_derived' argument second if we are variadic or last if not.
1325 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
1326 llvm::Value *MostDerivedArg =
1327 llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
1328 RValue RV = RValue::get(MostDerivedArg);
1329 if (MostDerivedArg) {
1330 if (FPT->isVariadic())
1331 Args.insert(Args.begin() + 1,
1332 CallArg(RV, getContext().IntTy, /*needscopy=*/false));
1333 else
1334 Args.add(RV, getContext().IntTy);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001335 }
1336
Reid Kleckner89077a12013-12-17 19:46:40 +00001337 return 1; // Added one arg.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001338}
1339
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001340void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1341 const CXXDestructorDecl *DD,
1342 CXXDtorType Type, bool ForVirtualBase,
1343 bool Delegating, llvm::Value *This) {
Rafael Espindola1ac0ec82014-09-11 15:42:06 +00001344 llvm::Value *Callee = CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type));
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001345
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001346 if (DD->isVirtual()) {
1347 assert(Type != CXXDtorType::Dtor_Deleting &&
1348 "The deleting destructor should only be called via a virtual call");
1349 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1350 This, false);
1351 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001352
David Majnemer0c0b6d92014-10-31 20:09:12 +00001353 CGF.EmitCXXStructorCall(DD, Callee, ReturnValueSlot(), This,
1354 /*ImplicitParam=*/nullptr,
1355 /*ImplicitParamTy=*/QualType(), nullptr,
1356 getFromDtorType(Type));
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001357}
1358
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001359void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1360 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001361 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001362 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001363
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001364 for (VPtrInfo *Info : VFPtrs) {
1365 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001366 if (VTable->hasInitializer())
1367 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001368
David Majnemer65f87322014-07-24 06:09:19 +00001369 llvm::Constant *RTTI = getContext().getLangOpts().RTTIData
1370 ? getMSCompleteObjectLocator(RD, Info)
1371 : nullptr;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001372
1373 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001374 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001375 llvm::Constant *Init = CGVT.CreateVTableInitializer(
1376 RD, VTLayout.vtable_component_begin(),
1377 VTLayout.getNumVTableComponents(), VTLayout.vtable_thunk_begin(),
David Majnemerd905da42014-07-01 20:30:31 +00001378 VTLayout.getNumVTableThunks(), RTTI);
1379
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001380 VTable->setInitializer(Init);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001381 }
1382}
1383
1384llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1385 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
1386 const CXXRecordDecl *NearestVBase, bool &NeedsVirtualOffset) {
Craig Topper8a13c412014-05-21 05:09:00 +00001387 NeedsVirtualOffset = (NearestVBase != nullptr);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001388
David Majnemerd905da42014-07-01 20:30:31 +00001389 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1390 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1391 llvm::GlobalValue *VTableAddressPoint = VFTablesMap[ID];
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001392 if (!VTableAddressPoint) {
1393 assert(Base.getBase()->getNumVBases() &&
1394 !CGM.getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
1395 }
1396 return VTableAddressPoint;
1397}
1398
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001399static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001400 const CXXRecordDecl *RD, const VPtrInfo *VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001401 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001402 llvm::raw_svector_ostream Out(Name);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001403 MangleContext.mangleCXXVFTable(RD, VFPtr->MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001404}
1405
1406llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1407 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
David Majnemerd905da42014-07-01 20:30:31 +00001408 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1409 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1410 llvm::GlobalValue *VFTable = VFTablesMap[ID];
1411 assert(VFTable && "Couldn't find a vftable for the given base?");
1412 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001413}
1414
1415llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1416 CharUnits VPtrOffset) {
1417 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1418 // shouldn't be used in the given record type. We want to cache this result in
1419 // VFTablesMap, thus a simple zero check is not sufficient.
1420 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001421 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001422 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001423 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001424 if (!Inserted)
1425 return I->second;
1426
1427 llvm::GlobalVariable *&VTable = I->second;
1428
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001429 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001430 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001431
David Blaikie82e95a32014-11-19 07:49:47 +00001432 if (DeferredVFTables.insert(RD).second) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001433 // We haven't processed this record type before.
1434 // Queue up this v-table for possible deferred emission.
1435 CGM.addDeferredVTable(RD);
1436
1437#ifndef NDEBUG
1438 // Create all the vftables at once in order to make sure each vftable has
1439 // a unique mangled name.
1440 llvm::StringSet<> ObservedMangledNames;
1441 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1442 SmallString<256> Name;
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001443 mangleVFTableName(getMangleContext(), RD, VFPtrs[J], Name);
David Blaikie61b86d42014-11-19 02:56:13 +00001444 if (!ObservedMangledNames.insert(Name.str()).second)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001445 llvm_unreachable("Already saw this mangling before?");
1446 }
1447#endif
1448 }
1449
1450 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001451 if (VFPtrs[J]->FullOffsetInMDC != VPtrOffset)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001452 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001453 SmallString<256> VFTableName;
1454 mangleVFTableName(getMangleContext(), RD, VFPtrs[J], VFTableName);
1455 StringRef VTableName = VFTableName;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001456
David Majnemerd905da42014-07-01 20:30:31 +00001457 uint64_t NumVTableSlots =
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001458 VTContext.getVFTableLayout(RD, VFPtrs[J]->FullOffsetInMDC)
David Majnemerd905da42014-07-01 20:30:31 +00001459 .getNumVTableComponents();
1460 llvm::GlobalValue::LinkageTypes VTableLinkage =
1461 llvm::GlobalValue::ExternalLinkage;
1462 llvm::ArrayType *VTableType =
1463 llvm::ArrayType::get(CGM.Int8PtrTy, NumVTableSlots);
David Majnemerf6072342014-07-01 22:24:56 +00001464 if (getContext().getLangOpts().RTTIData) {
David Majnemerd905da42014-07-01 20:30:31 +00001465 VTableLinkage = llvm::GlobalValue::PrivateLinkage;
1466 VTableName = "";
1467 }
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001468
David Majnemerd905da42014-07-01 20:30:31 +00001469 VTable = CGM.getModule().getNamedGlobal(VFTableName);
1470 if (!VTable) {
David Majnemerbb848712014-07-01 22:37:08 +00001471 // Create a backing variable for the contents of VTable. The VTable may
1472 // or may not include space for a pointer to RTTI data.
David Majnemerd905da42014-07-01 20:30:31 +00001473 llvm::GlobalValue *VFTable = VTable = new llvm::GlobalVariable(
1474 CGM.getModule(), VTableType, /*isConstant=*/true, VTableLinkage,
1475 /*Initializer=*/nullptr, VTableName);
1476 VTable->setUnnamedAddr(true);
David Majnemerbb848712014-07-01 22:37:08 +00001477
1478 // Only insert a pointer into the VFTable for RTTI data if we are not
1479 // importing it. We never reference the RTTI data directly so there is no
1480 // need to make room for it.
David Majnemerf6072342014-07-01 22:24:56 +00001481 if (getContext().getLangOpts().RTTIData &&
1482 !RD->hasAttr<DLLImportAttr>()) {
David Majnemerd905da42014-07-01 20:30:31 +00001483 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
1484 llvm::ConstantInt::get(CGM.IntTy, 1)};
David Majnemerbb848712014-07-01 22:37:08 +00001485 // Create a GEP which points just after the first entry in the VFTable,
1486 // this should be the location of the first virtual method.
David Majnemerd905da42014-07-01 20:30:31 +00001487 llvm::Constant *VTableGEP =
1488 llvm::ConstantExpr::getInBoundsGetElementPtr(VTable, GEPIndices);
David Majnemerbb848712014-07-01 22:37:08 +00001489 // The symbol for the VFTable is an alias to the GEP. It is
1490 // transparent, to other modules, what the nature of this symbol is; all
1491 // that matters is that the alias be the address of the first virtual
1492 // method.
David Majnemerd905da42014-07-01 20:30:31 +00001493 VFTable = llvm::GlobalAlias::create(
1494 cast<llvm::SequentialType>(VTableGEP->getType())->getElementType(),
1495 /*AddressSpace=*/0, llvm::GlobalValue::ExternalLinkage,
1496 VFTableName.str(), VTableGEP, &CGM.getModule());
1497 } else {
David Majnemerbb848712014-07-01 22:37:08 +00001498 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1499 // be referencing any RTTI data. The GlobalVariable will end up being
1500 // an appropriate definition of the VFTable.
David Majnemerd905da42014-07-01 20:30:31 +00001501 VTable->setName(VFTableName.str());
1502 }
1503
1504 VFTable->setUnnamedAddr(true);
1505 if (RD->hasAttr<DLLImportAttr>())
1506 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1507 else if (RD->hasAttr<DLLExportAttr>())
1508 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1509
1510 llvm::GlobalValue::LinkageTypes VFTableLinkage = CGM.getVTableLinkage(RD);
1511 if (VFTable != VTable) {
1512 if (llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage)) {
1513 // AvailableExternally implies that we grabbed the data from another
1514 // executable. No need to stick the alias in a Comdat.
David Majnemerb2615aa2014-07-13 05:19:56 +00001515 } else if (llvm::GlobalValue::isInternalLinkage(VFTableLinkage) ||
1516 llvm::GlobalValue::isWeakODRLinkage(VFTableLinkage) ||
David Majnemerd905da42014-07-01 20:30:31 +00001517 llvm::GlobalValue::isLinkOnceODRLinkage(VFTableLinkage)) {
1518 // The alias is going to be dropped into a Comdat, no need to make it
1519 // weak.
David Majnemerb2615aa2014-07-13 05:19:56 +00001520 if (!llvm::GlobalValue::isInternalLinkage(VFTableLinkage))
1521 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
David Majnemerd905da42014-07-01 20:30:31 +00001522 llvm::Comdat *C =
1523 CGM.getModule().getOrInsertComdat(VFTable->getName());
David Majnemerbb848712014-07-01 22:37:08 +00001524 // We must indicate which VFTable is larger to support linking between
1525 // translation units which do and do not have RTTI data. The largest
1526 // VFTable contains the RTTI data; translation units which reference
1527 // the smaller VFTable always reference it relative to the first
1528 // virtual method.
David Majnemerd905da42014-07-01 20:30:31 +00001529 C->setSelectionKind(llvm::Comdat::Largest);
1530 VTable->setComdat(C);
1531 } else {
1532 llvm_unreachable("unexpected linkage for vftable!");
1533 }
Rafael Espindola4af2cdb2015-01-16 21:41:44 +00001534 } else {
1535 if (llvm::GlobalValue::isWeakForLinker(VFTableLinkage))
1536 VTable->setComdat(
1537 CGM.getModule().getOrInsertComdat(VTable->getName()));
David Majnemerd905da42014-07-01 20:30:31 +00001538 }
1539 VFTable->setLinkage(VFTableLinkage);
1540 CGM.setGlobalVisibility(VFTable, RD);
1541 VFTablesMap[ID] = VFTable;
1542 }
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001543 break;
1544 }
1545
1546 return VTable;
1547}
1548
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001549llvm::Value *MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1550 GlobalDecl GD,
1551 llvm::Value *This,
1552 llvm::Type *Ty) {
1553 GD = GD.getCanonicalDecl();
1554 CGBuilderTy &Builder = CGF.Builder;
1555
1556 Ty = Ty->getPointerTo()->getPointerTo();
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001557 llvm::Value *VPtr =
1558 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001559 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty);
1560
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001561 MicrosoftVTableContext::MethodVFTableLocation ML =
1562 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001563 llvm::Value *VFuncPtr =
1564 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1565 return Builder.CreateLoad(VFuncPtr);
1566}
1567
David Majnemer0c0b6d92014-10-31 20:09:12 +00001568llvm::Value *MicrosoftCXXABI::EmitVirtualDestructorCall(
1569 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
1570 llvm::Value *This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001571 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001572 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1573
1574 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001575 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001576 GlobalDecl GD(Dtor, Dtor_Deleting);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001577 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1578 Dtor, StructorType::Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001579 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001580 llvm::Value *Callee = getVirtualFunctionPointer(CGF, GD, This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001581
1582 ASTContext &Context = CGF.getContext();
Nico Weber0a029922015-01-12 21:24:10 +00001583 llvm::Value *ImplicitParam = llvm::ConstantInt::get(
1584 llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
1585 DtorType == Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001586
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001587 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001588 RValue RV = CGF.EmitCXXStructorCall(Dtor, Callee, ReturnValueSlot(), This,
1589 ImplicitParam, Context.IntTy, CE,
1590 StructorType::Deleting);
1591 return RV.getScalarVal();
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001592}
1593
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001594const VBTableGlobals &
1595MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001596 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001597 // easier than caching each vbtable individually.
1598 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1599 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001600 std::tie(Entry, Added) =
1601 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001602 VBTableGlobals &VBGlobals = Entry->second;
1603 if (!Added)
1604 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001605
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001606 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1607 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001608
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001609 // Cache the globals for all vbtables so we don't have to recompute the
1610 // mangled names.
1611 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001612 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1613 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001614 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001615 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001616 }
1617
1618 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001619}
1620
Reid Klecknere4a52202014-02-21 02:27:32 +00001621llvm::Function *MicrosoftCXXABI::EmitVirtualMemPtrThunk(
1622 const CXXMethodDecl *MD,
1623 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001624 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1625 "can't form pointers to ctors or virtual dtors");
1626
Reid Klecknere4a52202014-02-21 02:27:32 +00001627 // Calculate the mangled name.
1628 SmallString<256> ThunkName;
1629 llvm::raw_svector_ostream Out(ThunkName);
1630 getMangleContext().mangleVirtualMemPtrThunk(MD, Out);
1631 Out.flush();
1632
Hans Wennborg88497d62013-11-15 17:24:45 +00001633 // If the thunk has been generated previously, just return it.
1634 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1635 return cast<llvm::Function>(GV);
1636
1637 // Create the llvm::Function.
Reid Klecknerc3473512014-08-29 21:43:29 +00001638 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSMemberPointerThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00001639 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1640 llvm::Function *ThunkFn =
1641 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1642 ThunkName.str(), &CGM.getModule());
1643 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1644
Hans Wennborg88497d62013-11-15 17:24:45 +00001645 ThunkFn->setLinkage(MD->isExternallyVisible()
1646 ? llvm::GlobalValue::LinkOnceODRLinkage
1647 : llvm::GlobalValue::InternalLinkage);
David Majnemer8c9cdb62015-01-21 01:21:31 +00001648 if (MD->isExternallyVisible())
1649 ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
Hans Wennborg88497d62013-11-15 17:24:45 +00001650
1651 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1652 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1653
Reid Kleckner9da94482015-01-21 22:18:17 +00001654 // Add the "thunk" attribute so that LLVM knows that the return type is
1655 // meaningless. These thunks can be used to call functions with differing
1656 // return types, and the caller is required to cast the prototype
1657 // appropriately to extract the correct value.
1658 ThunkFn->addFnAttr("thunk");
1659
Reid Klecknerb9538a62014-08-15 18:12:40 +00001660 // These thunks can be compared, so they are not unnamed.
1661 ThunkFn->setUnnamedAddr(false);
1662
Hans Wennborg88497d62013-11-15 17:24:45 +00001663 // Start codegen.
1664 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00001665 CGF.CurGD = GlobalDecl(MD);
1666 CGF.CurFuncIsThunk = true;
1667
1668 // Build FunctionArgs, but only include the implicit 'this' parameter
1669 // declaration.
1670 FunctionArgList FunctionArgs;
1671 buildThisParam(CGF, FunctionArgs);
1672
1673 // Start defining the function.
1674 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
1675 FunctionArgs, MD->getLocation(), SourceLocation());
1676 EmitThisParam(CGF);
Hans Wennborg88497d62013-11-15 17:24:45 +00001677
Reid Klecknere4a52202014-02-21 02:27:32 +00001678 // Load the vfptr and then callee from the vftable. The callee should have
1679 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00001680 llvm::Value *VTable = CGF.GetVTablePtr(
1681 getThisValue(CGF), ThunkTy->getPointerTo()->getPointerTo());
Reid Klecknere4a52202014-02-21 02:27:32 +00001682 llvm::Value *VFuncPtr =
1683 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1684 llvm::Value *Callee = CGF.Builder.CreateLoad(VFuncPtr);
Hans Wennborg88497d62013-11-15 17:24:45 +00001685
Reid Klecknerc3473512014-08-29 21:43:29 +00001686 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee);
Hans Wennborg88497d62013-11-15 17:24:45 +00001687
1688 return ThunkFn;
1689}
1690
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001691void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001692 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1693 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001694 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001695 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
David Majnemer129f4172015-02-02 10:22:20 +00001696 if (GV->isDeclaration())
1697 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00001698 }
1699}
1700
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001701llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001702MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001703 llvm::GlobalVariable::LinkageTypes Linkage) {
1704 SmallString<256> OutName;
1705 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00001706 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001707 Out.flush();
1708 StringRef Name = OutName.str();
1709
1710 llvm::ArrayType *VBTableType =
1711 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ReusingBase->getNumVBases());
1712
1713 assert(!CGM.getModule().getNamedGlobal(Name) &&
1714 "vbtable with this name already exists: mangling bug?");
1715 llvm::GlobalVariable *GV =
1716 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
1717 GV->setUnnamedAddr(true);
Hans Wennborg853ae942014-05-30 16:59:42 +00001718
1719 if (RD->hasAttr<DLLImportAttr>())
1720 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1721 else if (RD->hasAttr<DLLExportAttr>())
1722 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1723
David Majnemer129f4172015-02-02 10:22:20 +00001724 if (!GV->hasExternalLinkage())
1725 emitVBTableDefinition(VBT, RD, GV);
1726
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001727 return GV;
1728}
1729
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001730void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001731 const CXXRecordDecl *RD,
1732 llvm::GlobalVariable *GV) const {
1733 const CXXRecordDecl *ReusingBase = VBT.ReusingBase;
1734
1735 assert(RD->getNumVBases() && ReusingBase->getNumVBases() &&
1736 "should only emit vbtables for classes with vbtables");
1737
1738 const ASTRecordLayout &BaseLayout =
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001739 CGM.getContext().getASTRecordLayout(VBT.BaseWithVPtr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001740 const ASTRecordLayout &DerivedLayout =
1741 CGM.getContext().getASTRecordLayout(RD);
1742
Craig Topper8a13c412014-05-21 05:09:00 +00001743 SmallVector<llvm::Constant *, 4> Offsets(1 + ReusingBase->getNumVBases(),
1744 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001745
1746 // The offset from ReusingBase's vbptr to itself always leads.
1747 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
1748 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
1749
1750 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Aaron Ballman445a9392014-03-13 16:15:17 +00001751 for (const auto &I : ReusingBase->vbases()) {
1752 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001753 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
1754 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00001755
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001756 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00001757 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001758 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00001759 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001760 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00001761 Offset -= CompleteVBPtrOffset;
1762
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001763 unsigned VBIndex = Context.getVBTableIndex(ReusingBase, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00001764 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001765 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
1766 }
1767
1768 assert(Offsets.size() ==
1769 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
1770 ->getElementType())->getNumElements());
1771 llvm::ArrayType *VBTableType =
1772 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
1773 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
1774 GV->setInitializer(Init);
1775
1776 // Set the right visibility.
John McCall8f80a612014-02-08 00:41:16 +00001777 CGM.setGlobalVisibility(GV, RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001778}
1779
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001780llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
1781 llvm::Value *This,
1782 const ThisAdjustment &TA) {
1783 if (TA.isEmpty())
1784 return This;
1785
1786 llvm::Value *V = CGF.Builder.CreateBitCast(This, CGF.Int8PtrTy);
1787
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00001788 if (!TA.Virtual.isEmpty()) {
1789 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
1790 // Adjust the this argument based on the vtordisp value.
1791 llvm::Value *VtorDispPtr =
1792 CGF.Builder.CreateConstGEP1_32(V, TA.Virtual.Microsoft.VtordispOffset);
1793 VtorDispPtr =
1794 CGF.Builder.CreateBitCast(VtorDispPtr, CGF.Int32Ty->getPointerTo());
1795 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
1796 V = CGF.Builder.CreateGEP(V, CGF.Builder.CreateNeg(VtorDisp));
1797
1798 if (TA.Virtual.Microsoft.VBPtrOffset) {
1799 // If the final overrider is defined in a virtual base other than the one
1800 // that holds the vfptr, we have to use a vtordispex thunk which looks up
1801 // the vbtable of the derived class.
1802 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
1803 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
1804 llvm::Value *VBPtr;
1805 llvm::Value *VBaseOffset =
1806 GetVBaseOffsetFromVBPtr(CGF, V, -TA.Virtual.Microsoft.VBPtrOffset,
1807 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
1808 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
1809 }
1810 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001811
1812 if (TA.NonVirtual) {
1813 // Non-virtual adjustment might result in a pointer outside the allocated
1814 // object, e.g. if the final overrider class is laid out after the virtual
1815 // base that declares a method in the most derived class.
1816 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
1817 }
1818
1819 // Don't need to bitcast back, the call CodeGen will handle this.
1820 return V;
1821}
1822
1823llvm::Value *
1824MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
1825 const ReturnAdjustment &RA) {
1826 if (RA.isEmpty())
1827 return Ret;
1828
1829 llvm::Value *V = CGF.Builder.CreateBitCast(Ret, CGF.Int8PtrTy);
1830
1831 if (RA.Virtual.Microsoft.VBIndex) {
1832 assert(RA.Virtual.Microsoft.VBIndex > 0);
1833 int32_t IntSize =
1834 getContext().getTypeSizeInChars(getContext().IntTy).getQuantity();
1835 llvm::Value *VBPtr;
1836 llvm::Value *VBaseOffset =
1837 GetVBaseOffsetFromVBPtr(CGF, V, RA.Virtual.Microsoft.VBPtrOffset,
1838 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
1839 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
1840 }
1841
1842 if (RA.NonVirtual)
1843 V = CGF.Builder.CreateConstInBoundsGEP1_32(V, RA.NonVirtual);
1844
1845 // Cast back to the original type.
1846 return CGF.Builder.CreateBitCast(V, Ret->getType());
1847}
1848
John McCallb91cd662012-05-01 05:23:51 +00001849bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
1850 QualType elementType) {
1851 // Microsoft seems to completely ignore the possibility of a
1852 // two-argument usual deallocation function.
1853 return elementType.isDestructedType();
1854}
1855
1856bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
1857 // Microsoft seems to completely ignore the possibility of a
1858 // two-argument usual deallocation function.
1859 return expr->getAllocatedType().isDestructedType();
1860}
1861
1862CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
1863 // The array cookie is always a size_t; we then pad that out to the
1864 // alignment of the element type.
1865 ASTContext &Ctx = getContext();
1866 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
1867 Ctx.getTypeAlignInChars(type));
1868}
1869
1870llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
1871 llvm::Value *allocPtr,
1872 CharUnits cookieSize) {
Micah Villmowea2fea22012-10-25 15:39:14 +00001873 unsigned AS = allocPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001874 llvm::Value *numElementsPtr =
1875 CGF.Builder.CreateBitCast(allocPtr, CGF.SizeTy->getPointerTo(AS));
1876 return CGF.Builder.CreateLoad(numElementsPtr);
1877}
1878
1879llvm::Value* MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
1880 llvm::Value *newPtr,
1881 llvm::Value *numElements,
1882 const CXXNewExpr *expr,
1883 QualType elementType) {
1884 assert(requiresArrayCookie(expr));
1885
1886 // The size of the cookie.
1887 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
1888
1889 // Compute an offset to the cookie.
1890 llvm::Value *cookiePtr = newPtr;
1891
1892 // Write the number of elements into the appropriate slot.
Micah Villmowea2fea22012-10-25 15:39:14 +00001893 unsigned AS = newPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001894 llvm::Value *numElementsPtr
1895 = CGF.Builder.CreateBitCast(cookiePtr, CGF.SizeTy->getPointerTo(AS));
1896 CGF.Builder.CreateStore(numElements, numElementsPtr);
1897
1898 // Finally, compute a pointer to the actual data buffer by skipping
1899 // over the cookie completely.
1900 return CGF.Builder.CreateConstInBoundsGEP1_64(newPtr,
1901 cookieSize.getQuantity());
1902}
1903
David Majnemerb3341ea2014-10-05 05:05:40 +00001904static void emitGlobalDtorWithTLRegDtor(CodeGenFunction &CGF, const VarDecl &VD,
1905 llvm::Constant *Dtor,
1906 llvm::Constant *Addr) {
1907 // Create a function which calls the destructor.
1908 llvm::Constant *DtorStub = CGF.createAtExitStub(VD, Dtor, Addr);
1909
1910 // extern "C" int __tlregdtor(void (*f)(void));
1911 llvm::FunctionType *TLRegDtorTy = llvm::FunctionType::get(
1912 CGF.IntTy, DtorStub->getType(), /*IsVarArg=*/false);
1913
1914 llvm::Constant *TLRegDtor =
1915 CGF.CGM.CreateRuntimeFunction(TLRegDtorTy, "__tlregdtor");
1916 if (llvm::Function *TLRegDtorFn = dyn_cast<llvm::Function>(TLRegDtor))
1917 TLRegDtorFn->setDoesNotThrow();
1918
1919 CGF.EmitNounwindRuntimeCall(TLRegDtor, DtorStub);
1920}
1921
1922void MicrosoftCXXABI::registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
1923 llvm::Constant *Dtor,
1924 llvm::Constant *Addr) {
1925 if (D.getTLSKind())
1926 return emitGlobalDtorWithTLRegDtor(CGF, D, Dtor, Addr);
1927
1928 // The default behavior is to use atexit.
1929 CGF.registerGlobalDtorWithAtExit(D, Dtor, Addr);
1930}
1931
1932void MicrosoftCXXABI::EmitThreadLocalInitFuncs(
1933 CodeGenModule &CGM,
1934 ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *>>
1935 CXXThreadLocals,
1936 ArrayRef<llvm::Function *> CXXThreadLocalInits,
1937 ArrayRef<llvm::GlobalVariable *> CXXThreadLocalInitVars) {
1938 // This will create a GV in the .CRT$XDU section. It will point to our
1939 // initialization function. The CRT will call all of these function
1940 // pointers at start-up time and, eventually, at thread-creation time.
1941 auto AddToXDU = [&CGM](llvm::Function *InitFunc) {
1942 llvm::GlobalVariable *InitFuncPtr = new llvm::GlobalVariable(
1943 CGM.getModule(), InitFunc->getType(), /*IsConstant=*/true,
1944 llvm::GlobalVariable::InternalLinkage, InitFunc,
1945 Twine(InitFunc->getName(), "$initializer$"));
1946 InitFuncPtr->setSection(".CRT$XDU");
1947 // This variable has discardable linkage, we have to add it to @llvm.used to
1948 // ensure it won't get discarded.
1949 CGM.addUsedGlobal(InitFuncPtr);
1950 return InitFuncPtr;
1951 };
1952
1953 std::vector<llvm::Function *> NonComdatInits;
1954 for (size_t I = 0, E = CXXThreadLocalInitVars.size(); I != E; ++I) {
1955 llvm::GlobalVariable *GV = CXXThreadLocalInitVars[I];
1956 llvm::Function *F = CXXThreadLocalInits[I];
1957
1958 // If the GV is already in a comdat group, then we have to join it.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00001959 if (llvm::Comdat *C = GV->getComdat())
David Majnemerb3341ea2014-10-05 05:05:40 +00001960 AddToXDU(F)->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00001961 else
David Majnemerb3341ea2014-10-05 05:05:40 +00001962 NonComdatInits.push_back(F);
David Majnemerb3341ea2014-10-05 05:05:40 +00001963 }
1964
1965 if (!NonComdatInits.empty()) {
1966 llvm::FunctionType *FTy =
1967 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Alexey Samsonov1444bb92014-10-17 00:20:19 +00001968 llvm::Function *InitFunc = CGM.CreateGlobalInitOrDestructFunction(
1969 FTy, "__tls_init", SourceLocation(),
1970 /*TLS=*/true);
David Majnemerb3341ea2014-10-05 05:05:40 +00001971 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, NonComdatInits);
1972
1973 AddToXDU(InitFunc);
1974 }
1975}
1976
1977LValue MicrosoftCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
1978 const VarDecl *VD,
1979 QualType LValType) {
1980 CGF.CGM.ErrorUnsupported(VD, "thread wrappers");
1981 return LValue();
1982}
1983
John McCallc84ed6a2012-05-01 06:13:13 +00001984void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00001985 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00001986 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00001987 // MSVC only uses guards for static locals.
1988 if (!D.isStaticLocal()) {
1989 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
1990 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
Rafael Espindola77abc3a2015-01-16 16:04:45 +00001991 llvm::Function *F = CGF.CurFn;
1992 F->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
1993 F->setComdat(CGM.getModule().getOrInsertComdat(F->getName()));
Reid Kleckner563f0e82014-05-23 21:13:45 +00001994 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
1995 return;
1996 }
1997
Reid Klecknerd8110b62013-09-10 20:14:30 +00001998 // MSVC always uses an i32 bitfield to guard initialization, which is *not*
1999 // threadsafe. Since the user may be linking in inline functions compiled by
2000 // cl.exe, there's no reason to provide a false sense of security by using
2001 // critical sections here.
John McCallc84ed6a2012-05-01 06:13:13 +00002002
Richard Smithdbf74ba2013-04-14 23:01:42 +00002003 if (D.getTLSKind())
2004 CGM.ErrorUnsupported(&D, "dynamic TLS initialization");
2005
Reid Klecknerd8110b62013-09-10 20:14:30 +00002006 CGBuilderTy &Builder = CGF.Builder;
2007 llvm::IntegerType *GuardTy = CGF.Int32Ty;
2008 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
2009
2010 // Get the guard variable for this function if we have one already.
Reid Kleckner563f0e82014-05-23 21:13:45 +00002011 GuardInfo *GI = &GuardVariableMap[D.getDeclContext()];
Reid Klecknerd8110b62013-09-10 20:14:30 +00002012
2013 unsigned BitIndex;
Reid Klecknere9591b32014-04-23 18:22:11 +00002014 if (D.isStaticLocal() && D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002015 // Externally visible variables have to be numbered in Sema to properly
2016 // handle unreachable VarDecls.
David Majnemer2206bf52014-03-05 08:57:59 +00002017 BitIndex = getContext().getStaticLocalNumber(&D);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002018 assert(BitIndex > 0);
2019 BitIndex--;
2020 } else {
2021 // Non-externally visible variables are numbered here in CodeGen.
Reid Klecknere9591b32014-04-23 18:22:11 +00002022 BitIndex = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002023 }
2024
2025 if (BitIndex >= 32) {
2026 if (D.isExternallyVisible())
2027 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
2028 BitIndex %= 32;
Craig Topper8a13c412014-05-21 05:09:00 +00002029 GI->Guard = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00002030 }
2031
2032 // Lazily create the i32 bitfield for this function.
Reid Klecknere9591b32014-04-23 18:22:11 +00002033 if (!GI->Guard) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00002034 // Mangle the name for the guard.
2035 SmallString<256> GuardName;
2036 {
2037 llvm::raw_svector_ostream Out(GuardName);
2038 getMangleContext().mangleStaticGuardVariable(&D, Out);
2039 Out.flush();
2040 }
2041
Hans Wennborgef2272c2014-06-18 15:55:13 +00002042 // Create the guard variable with a zero-initializer. Just absorb linkage,
2043 // visibility and dll storage class from the guarded variable.
Reid Klecknere9591b32014-04-23 18:22:11 +00002044 GI->Guard =
2045 new llvm::GlobalVariable(CGM.getModule(), GuardTy, false,
2046 GV->getLinkage(), Zero, GuardName.str());
2047 GI->Guard->setVisibility(GV->getVisibility());
Hans Wennborgef2272c2014-06-18 15:55:13 +00002048 GI->Guard->setDLLStorageClass(GV->getDLLStorageClass());
David Majnemer3072fc82015-01-21 01:04:30 +00002049 if (GI->Guard->isWeakForLinker())
2050 GI->Guard->setComdat(
2051 CGM.getModule().getOrInsertComdat(GI->Guard->getName()));
Reid Klecknerd8110b62013-09-10 20:14:30 +00002052 } else {
Reid Klecknere9591b32014-04-23 18:22:11 +00002053 assert(GI->Guard->getLinkage() == GV->getLinkage() &&
Reid Klecknerd8110b62013-09-10 20:14:30 +00002054 "static local from the same function had different linkage");
2055 }
2056
2057 // Pseudo code for the test:
2058 // if (!(GuardVar & MyGuardBit)) {
2059 // GuardVar |= MyGuardBit;
2060 // ... initialize the object ...;
2061 // }
2062
2063 // Test our bit from the guard variable.
2064 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1U << BitIndex);
Reid Klecknere9591b32014-04-23 18:22:11 +00002065 llvm::LoadInst *LI = Builder.CreateLoad(GI->Guard);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002066 llvm::Value *IsInitialized =
2067 Builder.CreateICmpNE(Builder.CreateAnd(LI, Bit), Zero);
2068 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2069 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
2070 Builder.CreateCondBr(IsInitialized, EndBlock, InitBlock);
2071
2072 // Set our bit in the guard variable and emit the initializer and add a global
2073 // destructor if appropriate.
2074 CGF.EmitBlock(InitBlock);
Reid Klecknere9591b32014-04-23 18:22:11 +00002075 Builder.CreateStore(Builder.CreateOr(LI, Bit), GI->Guard);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002076 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
2077 Builder.CreateBr(EndBlock);
2078
2079 // Continue.
2080 CGF.EmitBlock(EndBlock);
John McCallc84ed6a2012-05-01 06:13:13 +00002081}
2082
Reid Kleckner2341ae32013-04-11 18:13:19 +00002083bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
2084 // Null-ness for function memptrs only depends on the first field, which is
2085 // the function pointer. The rest don't matter, so we can zero initialize.
2086 if (MPT->isMemberFunctionPointer())
2087 return true;
2088
2089 // The virtual base adjustment field is always -1 for null, so if we have one
2090 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
2091 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002092 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2093 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002094 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
2095 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00002096}
2097
2098llvm::Type *
2099MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002100 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2101 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002102 llvm::SmallVector<llvm::Type *, 4> fields;
2103 if (MPT->isMemberFunctionPointer())
2104 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
2105 else
2106 fields.push_back(CGM.IntTy); // FieldOffset
2107
Reid Kleckner96f8f932014-02-05 17:27:08 +00002108 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2109 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002110 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002111 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002112 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002113 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002114 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
2115
2116 if (fields.size() == 1)
2117 return fields[0];
2118 return llvm::StructType::get(CGM.getLLVMContext(), fields);
2119}
2120
2121void MicrosoftCXXABI::
2122GetNullMemberPointerFields(const MemberPointerType *MPT,
2123 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
2124 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00002125 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2126 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002127 if (MPT->isMemberFunctionPointer()) {
2128 // FunctionPointerOrVirtualThunk
2129 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2130 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00002131 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00002132 fields.push_back(getZeroInt()); // FieldOffset
2133 else
2134 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00002135 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00002136
Reid Kleckner96f8f932014-02-05 17:27:08 +00002137 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
2138 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002139 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002140 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002141 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00002142 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002143 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002144}
2145
2146llvm::Constant *
2147MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002148 llvm::SmallVector<llvm::Constant *, 4> fields;
2149 GetNullMemberPointerFields(MPT, fields);
2150 if (fields.size() == 1)
2151 return fields[0];
2152 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
2153 assert(Res->getType() == ConvertMemberPointerType(MPT));
2154 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002155}
2156
2157llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002158MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
2159 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00002160 const CXXRecordDecl *RD,
2161 CharUnits NonVirtualBaseAdjustment)
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002162{
David Majnemer1cdd96d2014-01-17 09:01:00 +00002163 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002164
2165 // Single inheritance class member pointer are represented as scalars instead
2166 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002167 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002168 return FirstField;
2169
Reid Kleckner2341ae32013-04-11 18:13:19 +00002170 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002171 fields.push_back(FirstField);
2172
Reid Kleckner96f8f932014-02-05 17:27:08 +00002173 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002174 fields.push_back(llvm::ConstantInt::get(
2175 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002176
Reid Kleckner96f8f932014-02-05 17:27:08 +00002177 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00002178 CharUnits Offs = CharUnits::Zero();
2179 if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002180 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00002181 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00002182 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002183
2184 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002185 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002186 fields.push_back(getZeroInt());
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002187
Reid Kleckner2341ae32013-04-11 18:13:19 +00002188 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002189}
2190
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002191llvm::Constant *
2192MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
2193 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002194 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002195 llvm::Constant *FirstField =
2196 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00002197 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
2198 CharUnits::Zero());
2199}
2200
2201llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const CXXMethodDecl *MD) {
2202 return BuildMemberPointer(MD->getParent(), MD, CharUnits::Zero());
2203}
2204
2205llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
2206 QualType MPType) {
2207 const MemberPointerType *MPT = MPType->castAs<MemberPointerType>();
2208 const ValueDecl *MPD = MP.getMemberPointerDecl();
2209 if (!MPD)
2210 return EmitNullMemberPointer(MPT);
2211
2212 CharUnits ThisAdjustment = getMemberPointerPathAdjustment(MP);
2213
2214 // FIXME PR15713: Support virtual inheritance paths.
2215
2216 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD))
David Majnemer1cdd96d2014-01-17 09:01:00 +00002217 return BuildMemberPointer(MPT->getMostRecentCXXRecordDecl(), MD,
2218 ThisAdjustment);
Reid Kleckner452abac2013-05-09 21:01:17 +00002219
2220 CharUnits FieldOffset =
2221 getContext().toCharUnitsFromBits(getContext().getFieldOffset(MPD));
2222 return EmitMemberDataPointer(MPT, ThisAdjustment + FieldOffset);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002223}
2224
2225llvm::Constant *
Reid Kleckner452abac2013-05-09 21:01:17 +00002226MicrosoftCXXABI::BuildMemberPointer(const CXXRecordDecl *RD,
2227 const CXXMethodDecl *MD,
2228 CharUnits NonVirtualBaseAdjustment) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002229 assert(MD->isInstance() && "Member function must not be static!");
2230 MD = MD->getCanonicalDecl();
David Majnemer1cdd96d2014-01-17 09:01:00 +00002231 RD = RD->getMostRecentDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002232 CodeGenTypes &Types = CGM.getTypes();
2233
2234 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00002235 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00002236 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002237 llvm::Type *Ty;
2238 // Check whether the function has a computable LLVM signature.
2239 if (Types.isFuncTypeConvertible(FPT)) {
2240 // The function has a computable LLVM signature; use the correct type.
2241 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
2242 } else {
2243 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
2244 // function type is incomplete.
2245 Ty = CGM.PtrDiffTy;
2246 }
2247 FirstField = CGM.GetAddrOfFunction(MD, Ty);
2248 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Hans Wennborg88497d62013-11-15 17:24:45 +00002249 } else {
2250 MicrosoftVTableContext::MethodVFTableLocation ML =
2251 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Reid Klecknerc3473512014-08-29 21:43:29 +00002252 if (!CGM.getTypes().isFuncTypeConvertible(
2253 MD->getType()->castAs<FunctionType>())) {
Hans Wennborg88497d62013-11-15 17:24:45 +00002254 CGM.ErrorUnsupported(MD, "pointer to virtual member function with "
2255 "incomplete return or parameter type");
2256 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
Reid Klecknerc3473512014-08-29 21:43:29 +00002257 } else if (FPT->getCallConv() == CC_X86FastCall) {
2258 CGM.ErrorUnsupported(MD, "pointer to fastcall virtual member function");
2259 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
Hans Wennborg88497d62013-11-15 17:24:45 +00002260 } else if (ML.VBase) {
2261 CGM.ErrorUnsupported(MD, "pointer to virtual member function overriding "
2262 "member function in virtual base class");
2263 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
2264 } else {
Reid Klecknere4a52202014-02-21 02:27:32 +00002265 llvm::Function *Thunk = EmitVirtualMemPtrThunk(MD, ML);
Hans Wennborg88497d62013-11-15 17:24:45 +00002266 FirstField = llvm::ConstantExpr::getBitCast(Thunk, CGM.VoidPtrTy);
Reid Klecknere4a52202014-02-21 02:27:32 +00002267 // Include the vfptr adjustment if the method is in a non-primary vftable.
2268 NonVirtualBaseAdjustment += ML.VFPtrOffset;
Hans Wennborg88497d62013-11-15 17:24:45 +00002269 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002270 }
2271
2272 // The rest of the fields are common with data member pointers.
Reid Kleckner452abac2013-05-09 21:01:17 +00002273 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
2274 NonVirtualBaseAdjustment);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002275}
2276
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002277/// Member pointers are the same if they're either bitwise identical *or* both
2278/// null. Null-ness for function members is determined by the first field,
2279/// while for data member pointers we must compare all fields.
2280llvm::Value *
2281MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
2282 llvm::Value *L,
2283 llvm::Value *R,
2284 const MemberPointerType *MPT,
2285 bool Inequality) {
2286 CGBuilderTy &Builder = CGF.Builder;
2287
2288 // Handle != comparisons by switching the sense of all boolean operations.
2289 llvm::ICmpInst::Predicate Eq;
2290 llvm::Instruction::BinaryOps And, Or;
2291 if (Inequality) {
2292 Eq = llvm::ICmpInst::ICMP_NE;
2293 And = llvm::Instruction::Or;
2294 Or = llvm::Instruction::And;
2295 } else {
2296 Eq = llvm::ICmpInst::ICMP_EQ;
2297 And = llvm::Instruction::And;
2298 Or = llvm::Instruction::Or;
2299 }
2300
2301 // If this is a single field member pointer (single inheritance), this is a
2302 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002303 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2304 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002305 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2306 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002307 return Builder.CreateICmp(Eq, L, R);
2308
2309 // Compare the first field.
2310 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2311 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2312 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2313
2314 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002315 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002316 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2317 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2318 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2319 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2320 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2321 if (Res)
2322 Res = Builder.CreateBinOp(And, Res, Cmp);
2323 else
2324 Res = Cmp;
2325 }
2326
2327 // Check if the first field is 0 if this is a function pointer.
2328 if (MPT->isMemberFunctionPointer()) {
2329 // (l1 == r1 && ...) || l0 == 0
2330 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2331 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2332 Res = Builder.CreateBinOp(Or, Res, IsZero);
2333 }
2334
2335 // Combine the comparison of the first field, which must always be true for
2336 // this comparison to succeeed.
2337 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2338}
2339
Reid Kleckner407e8b62013-03-22 19:02:54 +00002340llvm::Value *
2341MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2342 llvm::Value *MemPtr,
2343 const MemberPointerType *MPT) {
2344 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002345 llvm::SmallVector<llvm::Constant *, 4> fields;
2346 // We only need one field for member functions.
2347 if (MPT->isMemberFunctionPointer())
2348 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2349 else
2350 GetNullMemberPointerFields(MPT, fields);
2351 assert(!fields.empty());
2352 llvm::Value *FirstField = MemPtr;
2353 if (MemPtr->getType()->isStructTy())
2354 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2355 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002356
Reid Kleckner2341ae32013-04-11 18:13:19 +00002357 // For function member pointers, we only need to test the function pointer
2358 // field. The other fields if any can be garbage.
2359 if (MPT->isMemberFunctionPointer())
2360 return Res;
2361
2362 // Otherwise, emit a series of compares and combine the results.
2363 for (int I = 1, E = fields.size(); I < E; ++I) {
2364 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2365 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002366 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002367 }
2368 return Res;
2369}
2370
Reid Kleckner452abac2013-05-09 21:01:17 +00002371bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2372 llvm::Constant *Val) {
2373 // Function pointers are null if the pointer in the first field is null.
2374 if (MPT->isMemberFunctionPointer()) {
2375 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2376 Val->getAggregateElement(0U) : Val;
2377 return FirstField->isNullValue();
2378 }
2379
2380 // If it's not a function pointer and it's zero initializable, we can easily
2381 // check zero.
2382 if (isZeroInitializable(MPT) && Val->isNullValue())
2383 return true;
2384
2385 // Otherwise, break down all the fields for comparison. Hopefully these
2386 // little Constants are reused, while a big null struct might not be.
2387 llvm::SmallVector<llvm::Constant *, 4> Fields;
2388 GetNullMemberPointerFields(MPT, Fields);
2389 if (Fields.size() == 1) {
2390 assert(Val->getType()->isIntegerTy());
2391 return Val == Fields[0];
2392 }
2393
2394 unsigned I, E;
2395 for (I = 0, E = Fields.size(); I != E; ++I) {
2396 if (Val->getAggregateElement(I) != Fields[I])
2397 break;
2398 }
2399 return I == E;
2400}
2401
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002402llvm::Value *
2403MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
2404 llvm::Value *This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002405 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002406 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002407 llvm::Value **VBPtrOut) {
2408 CGBuilderTy &Builder = CGF.Builder;
2409 // Load the vbtable pointer from the vbptr in the instance.
2410 This = Builder.CreateBitCast(This, CGM.Int8PtrTy);
2411 llvm::Value *VBPtr =
2412 Builder.CreateInBoundsGEP(This, VBPtrOffset, "vbptr");
2413 if (VBPtrOut) *VBPtrOut = VBPtr;
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002414 VBPtr = Builder.CreateBitCast(VBPtr,
2415 CGM.Int32Ty->getPointerTo(0)->getPointerTo(0));
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002416 llvm::Value *VBTable = Builder.CreateLoad(VBPtr, "vbtable");
2417
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002418 // Translate from byte offset to table index. It improves analyzability.
2419 llvm::Value *VBTableIndex = Builder.CreateAShr(
2420 VBTableOffset, llvm::ConstantInt::get(VBTableOffset->getType(), 2),
2421 "vbtindex", /*isExact=*/true);
2422
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002423 // Load an i32 offset from the vb-table.
Reid Kleckner0ba8ba42014-10-22 17:26:00 +00002424 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableIndex);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002425 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
2426 return Builder.CreateLoad(VBaseOffs, "vbase_offs");
2427}
2428
Reid Kleckner2341ae32013-04-11 18:13:19 +00002429// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2430// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002431llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2432 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
2433 llvm::Value *Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002434 CGBuilderTy &Builder = CGF.Builder;
2435 Base = Builder.CreateBitCast(Base, CGM.Int8PtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +00002436 llvm::BasicBlock *OriginalBB = nullptr;
2437 llvm::BasicBlock *SkipAdjustBB = nullptr;
2438 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002439
2440 // In the unspecified inheritance model, there might not be a vbtable at all,
2441 // in which case we need to skip the virtual base lookup. If there is a
2442 // vbtable, the first entry is a no-op entry that gives back the original
2443 // base, so look for a virtual base adjustment offset of zero.
2444 if (VBPtrOffset) {
2445 OriginalBB = Builder.GetInsertBlock();
2446 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2447 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2448 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002449 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002450 "memptr.is_vbase");
2451 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2452 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002453 }
2454
Reid Kleckner2341ae32013-04-11 18:13:19 +00002455 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
2456 // know the vbptr offset.
2457 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002458 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00002459 if (!RD->hasDefinition()) {
2460 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
2461 unsigned DiagID = Diags.getCustomDiagID(
2462 DiagnosticsEngine::Error,
2463 "member pointer representation requires a "
2464 "complete class type for %0 to perform this expression");
2465 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
2466 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002467 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002468 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
2469 }
Craig Topper8a13c412014-05-21 05:09:00 +00002470 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002471 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002472 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002473 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
2474
2475 // Merge control flow with the case where we didn't have to adjust.
2476 if (VBaseAdjustBB) {
2477 Builder.CreateBr(SkipAdjustBB);
2478 CGF.EmitBlock(SkipAdjustBB);
2479 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
2480 Phi->addIncoming(Base, OriginalBB);
2481 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
2482 return Phi;
2483 }
2484 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002485}
2486
David Majnemer2b0d66d2014-02-20 23:22:07 +00002487llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
2488 CodeGenFunction &CGF, const Expr *E, llvm::Value *Base, llvm::Value *MemPtr,
2489 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002490 assert(MPT->isMemberDataPointer());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002491 unsigned AS = Base->getType()->getPointerAddressSpace();
2492 llvm::Type *PType =
2493 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
2494 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002495 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2496 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00002497
Reid Kleckner2341ae32013-04-11 18:13:19 +00002498 // Extract the fields we need, regardless of model. We'll apply them if we
2499 // have them.
2500 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002501 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2502 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002503 if (MemPtr->getType()->isStructTy()) {
2504 // We need to extract values.
2505 unsigned I = 0;
2506 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002507 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002508 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002509 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002510 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002511 }
2512
Reid Kleckner2341ae32013-04-11 18:13:19 +00002513 if (VirtualBaseAdjustmentOffset) {
David Majnemer2b0d66d2014-02-20 23:22:07 +00002514 Base = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00002515 VBPtrOffset);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002516 }
Reid Klecknerae945122013-12-05 22:44:07 +00002517
2518 // Cast to char*.
2519 Base = Builder.CreateBitCast(Base, Builder.getInt8Ty()->getPointerTo(AS));
2520
2521 // Apply the offset, which we assume is non-null.
Reid Kleckner2341ae32013-04-11 18:13:19 +00002522 llvm::Value *Addr =
2523 Builder.CreateInBoundsGEP(Base, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002524
2525 // Cast the address to the appropriate pointer type, adopting the address
2526 // space of the base pointer.
2527 return Builder.CreateBitCast(Addr, PType);
2528}
2529
David Majnemer1cdd96d2014-01-17 09:01:00 +00002530static MSInheritanceAttr::Spelling
Reid Kleckner452abac2013-05-09 21:01:17 +00002531getInheritanceFromMemptr(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002532 return MPT->getMostRecentCXXRecordDecl()->getMSInheritanceModel();
Reid Kleckner452abac2013-05-09 21:01:17 +00002533}
2534
2535llvm::Value *
2536MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
2537 const CastExpr *E,
2538 llvm::Value *Src) {
2539 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
2540 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
2541 E->getCastKind() == CK_ReinterpretMemberPointer);
2542
2543 // Use constant emission if we can.
2544 if (isa<llvm::Constant>(Src))
2545 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
2546
2547 // We may be adding or dropping fields from the member pointer, so we need
2548 // both types and the inheritance models of both records.
2549 const MemberPointerType *SrcTy =
2550 E->getSubExpr()->getType()->castAs<MemberPointerType>();
2551 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002552 bool IsFunc = SrcTy->isMemberFunctionPointer();
2553
2554 // If the classes use the same null representation, reinterpret_cast is a nop.
2555 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002556 if (IsReinterpret && IsFunc)
2557 return Src;
2558
2559 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
2560 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
2561 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00002562 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00002563 return Src;
2564
2565 CGBuilderTy &Builder = CGF.Builder;
2566
2567 // Branch past the conversion if Src is null.
2568 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
2569 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
2570
2571 // C++ 5.2.10p9: The null member pointer value is converted to the null member
2572 // pointer value of the destination type.
2573 if (IsReinterpret) {
2574 // For reinterpret casts, sema ensures that src and dst are both functions
2575 // or data and have the same size, which means the LLVM types should match.
2576 assert(Src->getType() == DstNull->getType());
2577 return Builder.CreateSelect(IsNotNull, Src, DstNull);
2578 }
2579
2580 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
2581 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
2582 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
2583 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
2584 CGF.EmitBlock(ConvertBB);
2585
2586 // Decompose src.
2587 llvm::Value *FirstField = Src;
Craig Topper8a13c412014-05-21 05:09:00 +00002588 llvm::Value *NonVirtualBaseAdjustment = nullptr;
2589 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2590 llvm::Value *VBPtrOffset = nullptr;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002591 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002592 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002593 // We need to extract values.
2594 unsigned I = 0;
2595 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002596 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002597 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002598 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002599 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002600 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002601 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
2602 }
2603
2604 // For data pointers, we adjust the field offset directly. For functions, we
2605 // have a separate field.
2606 llvm::Constant *Adj = getMemberPointerAdjustment(E);
2607 if (Adj) {
2608 Adj = llvm::ConstantExpr::getTruncOrBitCast(Adj, CGM.IntTy);
2609 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
2610 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
2611 if (!NVAdjustField) // If this field didn't exist in src, it's zero.
2612 NVAdjustField = getZeroInt();
2613 if (isDerivedToBase)
2614 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, Adj, "adj");
2615 else
2616 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, Adj, "adj");
2617 }
2618
2619 // FIXME PR15713: Support conversions through virtually derived classes.
2620
2621 // Recompose dst from the null struct and the adjusted fields from src.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002622 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
Reid Kleckner452abac2013-05-09 21:01:17 +00002623 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00002624 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002625 Dst = FirstField;
2626 } else {
2627 Dst = llvm::UndefValue::get(DstNull->getType());
2628 unsigned Idx = 0;
2629 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002630 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002631 Dst = Builder.CreateInsertValue(
2632 Dst, getValueOrZeroInt(NonVirtualBaseAdjustment), Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002633 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002634 Dst = Builder.CreateInsertValue(
2635 Dst, getValueOrZeroInt(VBPtrOffset), Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002636 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002637 Dst = Builder.CreateInsertValue(
2638 Dst, getValueOrZeroInt(VirtualBaseAdjustmentOffset), Idx++);
2639 }
2640 Builder.CreateBr(ContinueBB);
2641
2642 // In the continuation, choose between DstNull and Dst.
2643 CGF.EmitBlock(ContinueBB);
2644 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
2645 Phi->addIncoming(DstNull, OriginalBB);
2646 Phi->addIncoming(Dst, ConvertBB);
2647 return Phi;
2648}
2649
2650llvm::Constant *
2651MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
2652 llvm::Constant *Src) {
2653 const MemberPointerType *SrcTy =
2654 E->getSubExpr()->getType()->castAs<MemberPointerType>();
2655 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
2656
2657 // If src is null, emit a new null for dst. We can't return src because dst
2658 // might have a new representation.
2659 if (MemberPointerConstantIsNull(SrcTy, Src))
2660 return EmitNullMemberPointer(DstTy);
2661
2662 // We don't need to do anything for reinterpret_casts of non-null member
2663 // pointers. We should only get here when the two type representations have
2664 // the same size.
2665 if (E->getCastKind() == CK_ReinterpretMemberPointer)
2666 return Src;
2667
David Majnemer1cdd96d2014-01-17 09:01:00 +00002668 MSInheritanceAttr::Spelling SrcInheritance = getInheritanceFromMemptr(SrcTy);
2669 MSInheritanceAttr::Spelling DstInheritance = getInheritanceFromMemptr(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002670
2671 // Decompose src.
2672 llvm::Constant *FirstField = Src;
Craig Topper8a13c412014-05-21 05:09:00 +00002673 llvm::Constant *NonVirtualBaseAdjustment = nullptr;
2674 llvm::Constant *VirtualBaseAdjustmentOffset = nullptr;
2675 llvm::Constant *VBPtrOffset = nullptr;
Reid Kleckner452abac2013-05-09 21:01:17 +00002676 bool IsFunc = SrcTy->isMemberFunctionPointer();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002677 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002678 // We need to extract values.
2679 unsigned I = 0;
2680 FirstField = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002681 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002682 NonVirtualBaseAdjustment = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002683 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002684 VBPtrOffset = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002685 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002686 VirtualBaseAdjustmentOffset = Src->getAggregateElement(I++);
2687 }
2688
2689 // For data pointers, we adjust the field offset directly. For functions, we
2690 // have a separate field.
2691 llvm::Constant *Adj = getMemberPointerAdjustment(E);
2692 if (Adj) {
2693 Adj = llvm::ConstantExpr::getTruncOrBitCast(Adj, CGM.IntTy);
2694 llvm::Constant *&NVAdjustField =
2695 IsFunc ? NonVirtualBaseAdjustment : FirstField;
2696 bool IsDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
2697 if (!NVAdjustField) // If this field didn't exist in src, it's zero.
2698 NVAdjustField = getZeroInt();
2699 if (IsDerivedToBase)
2700 NVAdjustField = llvm::ConstantExpr::getNSWSub(NVAdjustField, Adj);
2701 else
2702 NVAdjustField = llvm::ConstantExpr::getNSWAdd(NVAdjustField, Adj);
2703 }
2704
2705 // FIXME PR15713: Support conversions through virtually derived classes.
2706
2707 // Recompose dst from the null struct and the adjusted fields from src.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002708 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002709 return FirstField;
2710
2711 llvm::SmallVector<llvm::Constant *, 4> Fields;
2712 Fields.push_back(FirstField);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002713 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002714 Fields.push_back(getConstantOrZeroInt(NonVirtualBaseAdjustment));
Reid Kleckner96f8f932014-02-05 17:27:08 +00002715 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002716 Fields.push_back(getConstantOrZeroInt(VBPtrOffset));
Reid Kleckner96f8f932014-02-05 17:27:08 +00002717 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002718 Fields.push_back(getConstantOrZeroInt(VirtualBaseAdjustmentOffset));
2719 return llvm::ConstantStruct::getAnon(Fields);
2720}
2721
David Majnemer2b0d66d2014-02-20 23:22:07 +00002722llvm::Value *MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
2723 CodeGenFunction &CGF, const Expr *E, llvm::Value *&This,
2724 llvm::Value *MemPtr, const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002725 assert(MPT->isMemberFunctionPointer());
2726 const FunctionProtoType *FPT =
2727 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00002728 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002729 llvm::FunctionType *FTy =
2730 CGM.getTypes().GetFunctionType(
2731 CGM.getTypes().arrangeCXXMethodType(RD, FPT));
2732 CGBuilderTy &Builder = CGF.Builder;
2733
David Majnemer1cdd96d2014-01-17 09:01:00 +00002734 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002735
2736 // Extract the fields we need, regardless of model. We'll apply them if we
2737 // have them.
2738 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002739 llvm::Value *NonVirtualBaseAdjustment = nullptr;
2740 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2741 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002742 if (MemPtr->getType()->isStructTy()) {
2743 // We need to extract values.
2744 unsigned I = 0;
2745 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002746 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002747 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002748 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002749 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002750 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002751 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
2752 }
2753
2754 if (VirtualBaseAdjustmentOffset) {
David Majnemer2b0d66d2014-02-20 23:22:07 +00002755 This = AdjustVirtualBase(CGF, E, RD, This, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00002756 VBPtrOffset);
2757 }
2758
2759 if (NonVirtualBaseAdjustment) {
2760 // Apply the adjustment and cast back to the original struct type.
2761 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy());
2762 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
2763 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted");
2764 }
2765
2766 return Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
2767}
2768
Charles Davis53c59df2010-08-16 03:33:14 +00002769CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00002770 return new MicrosoftCXXABI(CGM);
2771}
David Majnemere2cb8d12014-07-07 06:20:47 +00002772
2773// MS RTTI Overview:
2774// The run time type information emitted by cl.exe contains 5 distinct types of
2775// structures. Many of them reference each other.
2776//
2777// TypeInfo: Static classes that are returned by typeid.
2778//
2779// CompleteObjectLocator: Referenced by vftables. They contain information
2780// required for dynamic casting, including OffsetFromTop. They also contain
2781// a reference to the TypeInfo for the type and a reference to the
2782// CompleteHierarchyDescriptor for the type.
2783//
2784// ClassHieararchyDescriptor: Contains information about a class hierarchy.
2785// Used during dynamic_cast to walk a class hierarchy. References a base
2786// class array and the size of said array.
2787//
2788// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
2789// somewhat of a misnomer because the most derived class is also in the list
2790// as well as multiple copies of virtual bases (if they occur multiple times
2791// in the hiearchy.) The BaseClassArray contains one BaseClassDescriptor for
2792// every path in the hierarchy, in pre-order depth first order. Note, we do
2793// not declare a specific llvm type for BaseClassArray, it's merely an array
2794// of BaseClassDescriptor pointers.
2795//
2796// BaseClassDescriptor: Contains information about a class in a class hierarchy.
2797// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
2798// BaseClassArray is. It contains information about a class within a
2799// hierarchy such as: is this base is ambiguous and what is its offset in the
2800// vbtable. The names of the BaseClassDescriptors have all of their fields
2801// mangled into them so they can be aggressively deduplicated by the linker.
2802
David Majnemere2cb8d12014-07-07 06:20:47 +00002803static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
2804 StringRef MangledName("\01??_7type_info@@6B@");
2805 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
2806 return VTable;
2807 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
2808 /*Constant=*/true,
2809 llvm::GlobalVariable::ExternalLinkage,
2810 /*Initializer=*/nullptr, MangledName);
2811}
2812
2813namespace {
2814
2815/// \brief A Helper struct that stores information about a class in a class
2816/// hierarchy. The information stored in these structs struct is used during
2817/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
2818// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
2819// implicit depth first pre-order tree connectivity. getFirstChild and
2820// getNextSibling allow us to walk the tree efficiently.
2821struct MSRTTIClass {
2822 enum {
2823 IsPrivateOnPath = 1 | 8,
2824 IsAmbiguous = 2,
2825 IsPrivate = 4,
2826 IsVirtual = 16,
2827 HasHierarchyDescriptor = 64
2828 };
2829 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
2830 uint32_t initialize(const MSRTTIClass *Parent,
2831 const CXXBaseSpecifier *Specifier);
2832
2833 MSRTTIClass *getFirstChild() { return this + 1; }
2834 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
2835 return Child + 1 + Child->NumBases;
2836 }
2837
2838 const CXXRecordDecl *RD, *VirtualRoot;
2839 uint32_t Flags, NumBases, OffsetInVBase;
2840};
2841
2842/// \brief Recursively initialize the base class array.
2843uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
2844 const CXXBaseSpecifier *Specifier) {
2845 Flags = HasHierarchyDescriptor;
2846 if (!Parent) {
2847 VirtualRoot = nullptr;
2848 OffsetInVBase = 0;
2849 } else {
2850 if (Specifier->getAccessSpecifier() != AS_public)
2851 Flags |= IsPrivate | IsPrivateOnPath;
2852 if (Specifier->isVirtual()) {
2853 Flags |= IsVirtual;
2854 VirtualRoot = RD;
2855 OffsetInVBase = 0;
2856 } else {
2857 if (Parent->Flags & IsPrivateOnPath)
2858 Flags |= IsPrivateOnPath;
2859 VirtualRoot = Parent->VirtualRoot;
2860 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
2861 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
2862 }
2863 }
2864 NumBases = 0;
2865 MSRTTIClass *Child = getFirstChild();
2866 for (const CXXBaseSpecifier &Base : RD->bases()) {
2867 NumBases += Child->initialize(this, &Base) + 1;
2868 Child = getNextChild(Child);
2869 }
2870 return NumBases;
2871}
2872
2873static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
2874 switch (Ty->getLinkage()) {
2875 case NoLinkage:
2876 case InternalLinkage:
2877 case UniqueExternalLinkage:
2878 return llvm::GlobalValue::InternalLinkage;
2879
2880 case VisibleNoLinkage:
2881 case ExternalLinkage:
2882 return llvm::GlobalValue::LinkOnceODRLinkage;
2883 }
2884 llvm_unreachable("Invalid linkage!");
2885}
2886
2887/// \brief An ephemeral helper class for building MS RTTI types. It caches some
2888/// calls to the module and information about the most derived class in a
2889/// hierarchy.
2890struct MSRTTIBuilder {
2891 enum {
2892 HasBranchingHierarchy = 1,
2893 HasVirtualBranchingHierarchy = 2,
2894 HasAmbiguousBases = 4
2895 };
2896
David Majnemer611cdb92014-07-07 08:09:15 +00002897 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
2898 : CGM(ABI.CGM), Context(CGM.getContext()),
2899 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00002900 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00002901 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00002902
2903 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
2904 llvm::GlobalVariable *
2905 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
2906 llvm::GlobalVariable *getClassHierarchyDescriptor();
2907 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo *Info);
2908
2909 CodeGenModule &CGM;
2910 ASTContext &Context;
2911 llvm::LLVMContext &VMContext;
2912 llvm::Module &Module;
2913 const CXXRecordDecl *RD;
2914 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00002915 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00002916};
2917
2918} // namespace
2919
2920/// \brief Recursively serializes a class hierarchy in pre-order depth first
2921/// order.
2922static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
2923 const CXXRecordDecl *RD) {
2924 Classes.push_back(MSRTTIClass(RD));
2925 for (const CXXBaseSpecifier &Base : RD->bases())
2926 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
2927}
2928
2929/// \brief Find ambiguity among base classes.
2930static void
2931detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
2932 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
2933 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
2934 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
2935 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
2936 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
David Blaikie82e95a32014-11-19 07:49:47 +00002937 !VirtualBases.insert(Class->RD).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00002938 Class = MSRTTIClass::getNextChild(Class);
2939 continue;
2940 }
David Blaikie82e95a32014-11-19 07:49:47 +00002941 if (!UniqueBases.insert(Class->RD).second)
David Majnemere2cb8d12014-07-07 06:20:47 +00002942 AmbiguousBases.insert(Class->RD);
2943 Class++;
2944 }
2945 if (AmbiguousBases.empty())
2946 return;
2947 for (MSRTTIClass &Class : Classes)
2948 if (AmbiguousBases.count(Class.RD))
2949 Class.Flags |= MSRTTIClass::IsAmbiguous;
2950}
2951
2952llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
2953 SmallString<256> MangledName;
2954 {
2955 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00002956 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00002957 }
2958
2959 // Check to see if we've already declared this ClassHierarchyDescriptor.
2960 if (auto CHD = Module.getNamedGlobal(MangledName))
2961 return CHD;
2962
2963 // Serialize the class hierarchy and initialize the CHD Fields.
2964 SmallVector<MSRTTIClass, 8> Classes;
2965 serializeClassHierarchy(Classes, RD);
2966 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
2967 detectAmbiguousBases(Classes);
2968 int Flags = 0;
2969 for (auto Class : Classes) {
2970 if (Class.RD->getNumBases() > 1)
2971 Flags |= HasBranchingHierarchy;
2972 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
2973 // believe the field isn't actually used.
2974 if (Class.Flags & MSRTTIClass::IsAmbiguous)
2975 Flags |= HasAmbiguousBases;
2976 }
2977 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
2978 Flags |= HasVirtualBranchingHierarchy;
2979 // These gep indices are used to get the address of the first element of the
2980 // base class array.
2981 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
2982 llvm::ConstantInt::get(CGM.IntTy, 0)};
2983
2984 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00002985 auto Type = ABI.getClassHierarchyDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00002986 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
2987 /*Initializer=*/nullptr,
David Majnemer7c237072015-03-05 00:46:22 +00002988 StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00002989 if (CHD->isWeakForLinker())
2990 CHD->setComdat(CGM.getModule().getOrInsertComdat(CHD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00002991
2992 // Initialize the base class ClassHierarchyDescriptor.
2993 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00002994 llvm::ConstantInt::get(CGM.IntTy, 0), // Unknown
2995 llvm::ConstantInt::get(CGM.IntTy, Flags),
2996 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
2997 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
2998 getBaseClassArray(Classes),
2999 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00003000 };
3001 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3002 return CHD;
3003}
3004
3005llvm::GlobalVariable *
3006MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
3007 SmallString<256> MangledName;
3008 {
3009 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003010 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003011 }
3012
3013 // Forward-declare the base class array.
3014 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
3015 // mode) bytes of padding. We provide a pointer sized amount of padding by
3016 // adding +1 to Classes.size(). The sections have pointer alignment and are
3017 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00003018 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00003019 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00003020 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
David Majnemer7c237072015-03-05 00:46:22 +00003021 auto *BCA =
3022 new llvm::GlobalVariable(Module, ArrType,
3023 /*Constant=*/true, Linkage,
3024 /*Initializer=*/nullptr, StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003025 if (BCA->isWeakForLinker())
3026 BCA->setComdat(CGM.getModule().getOrInsertComdat(BCA->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003027
3028 // Initialize the BaseClassArray.
3029 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
3030 for (MSRTTIClass &Class : Classes)
3031 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00003032 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00003033 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00003034 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00003035 return BCA;
3036}
3037
3038llvm::GlobalVariable *
3039MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
3040 // Compute the fields for the BaseClassDescriptor. They are computed up front
3041 // because they are mangled into the name of the object.
3042 uint32_t OffsetInVBTable = 0;
3043 int32_t VBPtrOffset = -1;
3044 if (Class.VirtualRoot) {
3045 auto &VTableContext = CGM.getMicrosoftVTableContext();
3046 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
3047 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
3048 }
3049
3050 SmallString<256> MangledName;
3051 {
3052 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003053 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
3054 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
3055 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003056 }
3057
David Majnemer26a90f82014-07-07 15:29:10 +00003058 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00003059 if (auto BCD = Module.getNamedGlobal(MangledName))
3060 return BCD;
3061
3062 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00003063 auto Type = ABI.getBaseClassDescriptorType();
David Majnemer7c237072015-03-05 00:46:22 +00003064 auto BCD =
3065 new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
3066 /*Initializer=*/nullptr, StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003067 if (BCD->isWeakForLinker())
3068 BCD->setComdat(CGM.getModule().getOrInsertComdat(BCD->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003069
3070 // Initialize the BaseClassDescriptor.
3071 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003072 ABI.getImageRelativeConstant(
David Majnemerccef89d2014-07-07 15:29:16 +00003073 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00003074 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
3075 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
3076 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
3077 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
3078 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
3079 ABI.getImageRelativeConstant(
3080 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00003081 };
3082 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
3083 return BCD;
3084}
3085
3086llvm::GlobalVariable *
3087MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo *Info) {
3088 SmallString<256> MangledName;
3089 {
3090 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003091 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info->MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003092 }
3093
3094 // Check to see if we've already computed this complete object locator.
3095 if (auto COL = Module.getNamedGlobal(MangledName))
3096 return COL;
3097
3098 // Compute the fields of the complete object locator.
3099 int OffsetToTop = Info->FullOffsetInMDC.getQuantity();
3100 int VFPtrOffset = 0;
3101 // The offset includes the vtordisp if one exists.
3102 if (const CXXRecordDecl *VBase = Info->getVBaseWithVPtr())
3103 if (Context.getASTRecordLayout(RD)
3104 .getVBaseOffsetsMap()
3105 .find(VBase)
3106 ->second.hasVtorDisp())
3107 VFPtrOffset = Info->NonVirtualOffset.getQuantity() + 4;
3108
3109 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00003110 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003111 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
David Majnemer7c237072015-03-05 00:46:22 +00003112 /*Initializer=*/nullptr, StringRef(MangledName));
David Majnemere2cb8d12014-07-07 06:20:47 +00003113
3114 // Initialize the CompleteObjectLocator.
3115 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00003116 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
3117 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
3118 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
3119 ABI.getImageRelativeConstant(
3120 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
3121 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
3122 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00003123 };
3124 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00003125 if (!ABI.isImageRelative())
3126 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00003127 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
Rafael Espindola654542a2015-01-16 19:23:42 +00003128 if (COL->isWeakForLinker())
3129 COL->setComdat(CGM.getModule().getOrInsertComdat(COL->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00003130 return COL;
3131}
3132
3133/// \brief Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
3134/// llvm::GlobalVariable * because different type descriptors have different
3135/// types, and need to be abstracted. They are abstracting by casting the
3136/// address to an Int8PtrTy.
3137llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003138 SmallString<256> MangledName, TypeInfoString;
3139 {
3140 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00003141 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003142 }
3143
3144 // Check to see if we've already declared this TypeDescriptor.
3145 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3146 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3147
3148 // Compute the fields for the TypeDescriptor.
3149 {
3150 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00003151 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00003152 }
3153
3154 // Declare and initialize the TypeDescriptor.
3155 llvm::Constant *Fields[] = {
3156 getTypeInfoVTable(CGM), // VFPtr
3157 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
3158 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
3159 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00003160 getTypeDescriptorType(TypeInfoString);
Rafael Espindola654542a2015-01-16 19:23:42 +00003161 auto *Var = new llvm::GlobalVariable(
3162 CGM.getModule(), TypeDescriptorType, /*Constant=*/false,
3163 getLinkageForRTTI(Type),
3164 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
David Majnemer7c237072015-03-05 00:46:22 +00003165 StringRef(MangledName));
Rafael Espindola654542a2015-01-16 19:23:42 +00003166 if (Var->isWeakForLinker())
3167 Var->setComdat(CGM.getModule().getOrInsertComdat(Var->getName()));
3168 return llvm::ConstantExpr::getBitCast(Var, CGM.Int8PtrTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003169}
3170
3171/// \brief Gets or a creates a Microsoft CompleteObjectLocator.
3172llvm::GlobalVariable *
3173MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
3174 const VPtrInfo *Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00003175 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00003176}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003177
3178static void emitCXXConstructor(CodeGenModule &CGM,
3179 const CXXConstructorDecl *ctor,
3180 StructorType ctorType) {
Rafael Espindolad48b51b2014-09-15 19:24:44 +00003181 // There are no constructor variants, always emit the complete destructor.
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003182 llvm::Function *Fn = CGM.codegenCXXStructor(ctor, StructorType::Complete);
3183 CGM.maybeSetTrivialComdat(*ctor, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003184}
3185
3186static void emitCXXDestructor(CodeGenModule &CGM, const CXXDestructorDecl *dtor,
3187 StructorType dtorType) {
3188 // The complete destructor is equivalent to the base destructor for
3189 // classes with no virtual bases, so try to emit it as an alias.
3190 if (!dtor->getParent()->getNumVBases() &&
3191 (dtorType == StructorType::Complete || dtorType == StructorType::Base)) {
3192 bool ProducedAlias = !CGM.TryEmitDefinitionAsAlias(
3193 GlobalDecl(dtor, Dtor_Complete), GlobalDecl(dtor, Dtor_Base), true);
3194 if (ProducedAlias) {
3195 if (dtorType == StructorType::Complete)
3196 return;
3197 if (dtor->isVirtual())
3198 CGM.getVTables().EmitThunks(GlobalDecl(dtor, Dtor_Complete));
3199 }
3200 }
3201
3202 // The base destructor is equivalent to the base destructor of its
3203 // base class if there is exactly one non-virtual base class with a
3204 // non-trivial destructor, there are no fields with a non-trivial
3205 // destructor, and the body of the destructor is trivial.
3206 if (dtorType == StructorType::Base && !CGM.TryEmitBaseDestructorAsAlias(dtor))
3207 return;
3208
Rafael Espindola694cb5d2015-01-16 15:37:11 +00003209 llvm::Function *Fn = CGM.codegenCXXStructor(dtor, dtorType);
Rafael Espindolad3e04692015-01-17 01:47:39 +00003210 if (Fn->isWeakForLinker())
3211 Fn->setComdat(CGM.getModule().getOrInsertComdat(Fn->getName()));
Rafael Espindola91f68b42014-09-15 19:20:10 +00003212}
3213
3214void MicrosoftCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3215 StructorType Type) {
3216 if (auto *CD = dyn_cast<CXXConstructorDecl>(MD)) {
3217 emitCXXConstructor(CGM, CD, Type);
3218 return;
3219 }
3220 emitCXXDestructor(CGM, cast<CXXDestructorDecl>(MD), Type);
3221}
David Majnemer7c237072015-03-05 00:46:22 +00003222
3223llvm::Constant *MicrosoftCXXABI::getCatchableType(QualType T,
3224 uint32_t NVOffset,
3225 int32_t VBPtrOffset,
3226 uint32_t VBIndex) {
3227 assert(!T->isReferenceType());
3228
David Majnemere7a818f2015-03-06 18:53:55 +00003229 CXXRecordDecl *RD = T->getAsCXXRecordDecl();
3230 const CXXConstructorDecl *CD =
3231 RD ? CGM.getContext().getCopyConstructorForExceptionObject(RD) : nullptr;
David Majnemer7c237072015-03-05 00:46:22 +00003232 uint32_t Size = getContext().getTypeSizeInChars(T).getQuantity();
3233 SmallString<256> MangledName;
3234 {
3235 llvm::raw_svector_ostream Out(MangledName);
David Majnemere7a818f2015-03-06 18:53:55 +00003236 getMangleContext().mangleCXXCatchableType(T, CD, Size, Out);
David Majnemer7c237072015-03-05 00:46:22 +00003237 }
3238 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3239 return getImageRelativeConstant(GV);
3240
3241 // The TypeDescriptor is used by the runtime to determine of a catch handler
3242 // is appropriate for the exception object.
3243 llvm::Constant *TD = getImageRelativeConstant(getAddrOfRTTIDescriptor(T));
3244
3245 // The runtime is responsible for calling the copy constructor if the
3246 // exception is caught by value.
3247 llvm::Constant *CopyCtor =
David Majnemere7a818f2015-03-06 18:53:55 +00003248 CD ? llvm::ConstantExpr::getBitCast(
3249 CGM.getAddrOfCXXStructor(CD, StructorType::Complete),
3250 CGM.Int8PtrTy)
3251 : llvm::Constant::getNullValue(CGM.Int8PtrTy);
3252 CopyCtor = getImageRelativeConstant(CopyCtor);
David Majnemer7c237072015-03-05 00:46:22 +00003253
David Majnemere7a818f2015-03-06 18:53:55 +00003254 bool IsScalar = !RD;
David Majnemer7c237072015-03-05 00:46:22 +00003255 bool HasVirtualBases = false;
3256 bool IsStdBadAlloc = false; // std::bad_alloc is special for some reason.
David Majnemer7c237072015-03-05 00:46:22 +00003257 QualType PointeeType = T;
3258 if (T->isPointerType())
3259 PointeeType = T->getPointeeType();
3260 if (const CXXRecordDecl *RD = PointeeType->getAsCXXRecordDecl()) {
3261 HasVirtualBases = RD->getNumVBases() > 0;
3262 if (IdentifierInfo *II = RD->getIdentifier())
3263 IsStdBadAlloc = II->isStr("bad_alloc") && RD->isInStdNamespace();
3264 }
3265
3266 // Encode the relevant CatchableType properties into the Flags bitfield.
3267 // FIXME: Figure out how bits 2 or 8 can get set.
3268 uint32_t Flags = 0;
3269 if (IsScalar)
3270 Flags |= 1;
3271 if (HasVirtualBases)
3272 Flags |= 4;
3273 if (IsStdBadAlloc)
3274 Flags |= 16;
3275
3276 llvm::Constant *Fields[] = {
3277 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
3278 TD, // TypeDescriptor
3279 llvm::ConstantInt::get(CGM.IntTy, NVOffset), // NonVirtualAdjustment
3280 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset), // OffsetToVBPtr
3281 llvm::ConstantInt::get(CGM.IntTy, VBIndex), // VBTableIndex
3282 llvm::ConstantInt::get(CGM.IntTy, Size), // Size
3283 CopyCtor // CopyCtor
3284 };
3285 llvm::StructType *CTType = getCatchableTypeType();
3286 auto *GV = new llvm::GlobalVariable(
3287 CGM.getModule(), CTType, /*Constant=*/true, getLinkageForRTTI(T),
3288 llvm::ConstantStruct::get(CTType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00003289 GV->setUnnamedAddr(true);
3290 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00003291 if (GV->isWeakForLinker())
3292 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00003293 return getImageRelativeConstant(GV);
3294}
3295
3296llvm::GlobalVariable *MicrosoftCXXABI::getCatchableTypeArray(QualType T) {
3297 assert(!T->isReferenceType());
3298
3299 // See if we've already generated a CatchableTypeArray for this type before.
3300 llvm::GlobalVariable *&CTA = CatchableTypeArrays[T];
3301 if (CTA)
3302 return CTA;
3303
3304 // Ensure that we don't have duplicate entries in our CatchableTypeArray by
3305 // using a SmallSetVector. Duplicates may arise due to virtual bases
3306 // occurring more than once in the hierarchy.
3307 llvm::SmallSetVector<llvm::Constant *, 2> CatchableTypes;
3308
3309 // C++14 [except.handle]p3:
3310 // A handler is a match for an exception object of type E if [...]
3311 // - the handler is of type cv T or cv T& and T is an unambiguous public
3312 // base class of E, or
3313 // - the handler is of type cv T or const T& where T is a pointer type and
3314 // E is a pointer type that can be converted to T by [...]
3315 // - a standard pointer conversion (4.10) not involving conversions to
3316 // pointers to private or protected or ambiguous classes
3317 const CXXRecordDecl *MostDerivedClass = nullptr;
3318 bool IsPointer = T->isPointerType();
3319 if (IsPointer)
3320 MostDerivedClass = T->getPointeeType()->getAsCXXRecordDecl();
3321 else
3322 MostDerivedClass = T->getAsCXXRecordDecl();
3323
3324 // Collect all the unambiguous public bases of the MostDerivedClass.
3325 if (MostDerivedClass) {
3326 const ASTContext &Context = CGM.getContext();
3327 const ASTRecordLayout &MostDerivedLayout =
3328 Context.getASTRecordLayout(MostDerivedClass);
3329 MicrosoftVTableContext &VTableContext = CGM.getMicrosoftVTableContext();
3330 SmallVector<MSRTTIClass, 8> Classes;
3331 serializeClassHierarchy(Classes, MostDerivedClass);
3332 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
3333 detectAmbiguousBases(Classes);
3334 for (const MSRTTIClass &Class : Classes) {
3335 // Skip any ambiguous or private bases.
3336 if (Class.Flags &
3337 (MSRTTIClass::IsPrivateOnPath | MSRTTIClass::IsAmbiguous))
3338 continue;
3339 // Write down how to convert from a derived pointer to a base pointer.
3340 uint32_t OffsetInVBTable = 0;
3341 int32_t VBPtrOffset = -1;
3342 if (Class.VirtualRoot) {
3343 OffsetInVBTable =
3344 VTableContext.getVBTableIndex(MostDerivedClass, Class.VirtualRoot)*4;
3345 VBPtrOffset = MostDerivedLayout.getVBPtrOffset().getQuantity();
3346 }
3347
3348 // Turn our record back into a pointer if the exception object is a
3349 // pointer.
3350 QualType RTTITy = QualType(Class.RD->getTypeForDecl(), 0);
3351 if (IsPointer)
3352 RTTITy = Context.getPointerType(RTTITy);
3353 CatchableTypes.insert(getCatchableType(RTTITy, Class.OffsetInVBase,
3354 VBPtrOffset, OffsetInVBTable));
3355 }
3356 }
3357
3358 // C++14 [except.handle]p3:
3359 // A handler is a match for an exception object of type E if
3360 // - The handler is of type cv T or cv T& and E and T are the same type
3361 // (ignoring the top-level cv-qualifiers)
3362 CatchableTypes.insert(getCatchableType(T));
3363
3364 // C++14 [except.handle]p3:
3365 // A handler is a match for an exception object of type E if
3366 // - the handler is of type cv T or const T& where T is a pointer type and
3367 // E is a pointer type that can be converted to T by [...]
3368 // - a standard pointer conversion (4.10) not involving conversions to
3369 // pointers to private or protected or ambiguous classes
3370 //
David Majnemerd3d76692015-03-06 23:45:20 +00003371 // All pointers are convertible to pointer-to-void so ensure that it is in the
David Majnemer7c237072015-03-05 00:46:22 +00003372 // CatchableTypeArray.
3373 if (IsPointer)
3374 CatchableTypes.insert(getCatchableType(getContext().VoidPtrTy));
3375
3376 uint32_t NumEntries = CatchableTypes.size();
3377 llvm::Type *CTType =
3378 getImageRelativeType(getCatchableTypeType()->getPointerTo());
3379 llvm::ArrayType *AT = llvm::ArrayType::get(CTType, NumEntries);
3380 llvm::StructType *CTAType = getCatchableTypeArrayType(NumEntries);
3381 llvm::Constant *Fields[] = {
3382 llvm::ConstantInt::get(CGM.IntTy, NumEntries), // NumEntries
3383 llvm::ConstantArray::get(
3384 AT, llvm::makeArrayRef(CatchableTypes.begin(),
3385 CatchableTypes.end())) // CatchableTypes
3386 };
3387 SmallString<256> MangledName;
3388 {
3389 llvm::raw_svector_ostream Out(MangledName);
3390 getMangleContext().mangleCXXCatchableTypeArray(T, NumEntries, Out);
3391 }
3392 CTA = new llvm::GlobalVariable(
3393 CGM.getModule(), CTAType, /*Constant=*/true, getLinkageForRTTI(T),
3394 llvm::ConstantStruct::get(CTAType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00003395 CTA->setUnnamedAddr(true);
3396 CTA->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00003397 if (CTA->isWeakForLinker())
3398 CTA->setComdat(CGM.getModule().getOrInsertComdat(CTA->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00003399 return CTA;
3400}
3401
3402llvm::GlobalVariable *MicrosoftCXXABI::getThrowInfo(QualType T) {
David Majnemerd3d76692015-03-06 23:45:20 +00003403 T = getContext().getExceptionObjectType(T);
3404
David Majnemer7c237072015-03-05 00:46:22 +00003405 // C++14 [except.handle]p3:
3406 // A handler is a match for an exception object of type E if [...]
3407 // - the handler is of type cv T or const T& where T is a pointer type and
3408 // E is a pointer type that can be converted to T by [...]
3409 // - a qualification conversion
3410 bool IsConst = false, IsVolatile = false;
3411 QualType PointeeType = T->getPointeeType();
3412 if (!PointeeType.isNull()) {
3413 IsConst = PointeeType.isConstQualified();
3414 IsVolatile = PointeeType.isVolatileQualified();
3415 }
David Majnemerd3d76692015-03-06 23:45:20 +00003416
3417 // Member pointer types like "const int A::*" are represented by having RTTI
3418 // for "int A::*" and separately storing the const qualifier.
3419 if (const auto *MPTy = T->getAs<MemberPointerType>())
3420 T = getContext().getMemberPointerType(PointeeType.getUnqualifiedType(),
3421 MPTy->getClass());
3422
3423 // Pointer types like "const int * const *" are represented by having RTTI
3424 // for "const int **" and separately storing the const qualifier.
3425 if (T->isPointerType())
3426 T = getContext().getPointerType(PointeeType.getUnqualifiedType());
David Majnemer7c237072015-03-05 00:46:22 +00003427
3428 // The CatchableTypeArray enumerates the various (CV-unqualified) types that
3429 // the exception object may be caught as.
3430 llvm::GlobalVariable *CTA = getCatchableTypeArray(T);
3431 // The first field in a CatchableTypeArray is the number of CatchableTypes.
3432 // This is used as a component of the mangled name which means that we need to
3433 // know what it is in order to see if we have previously generated the
3434 // ThrowInfo.
3435 uint32_t NumEntries =
3436 cast<llvm::ConstantInt>(CTA->getInitializer()->getAggregateElement(0U))
3437 ->getLimitedValue();
3438
3439 SmallString<256> MangledName;
3440 {
3441 llvm::raw_svector_ostream Out(MangledName);
3442 getMangleContext().mangleCXXThrowInfo(T, IsConst, IsVolatile, NumEntries,
3443 Out);
3444 }
3445
3446 // Reuse a previously generated ThrowInfo if we have generated an appropriate
3447 // one before.
3448 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
3449 return GV;
3450
3451 // The RTTI TypeDescriptor uses an unqualified type but catch clauses must
3452 // be at least as CV qualified. Encode this requirement into the Flags
3453 // bitfield.
3454 uint32_t Flags = 0;
3455 if (IsConst)
3456 Flags |= 1;
3457 if (IsVolatile)
3458 Flags |= 2;
3459
3460 // The cleanup-function (a destructor) must be called when the exception
3461 // object's lifetime ends.
3462 llvm::Constant *CleanupFn = llvm::Constant::getNullValue(CGM.Int8PtrTy);
3463 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
3464 if (CXXDestructorDecl *DtorD = RD->getDestructor())
3465 if (!DtorD->isTrivial())
3466 CleanupFn = llvm::ConstantExpr::getBitCast(
3467 CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete),
3468 CGM.Int8PtrTy);
3469 // This is unused as far as we can tell, initialize it to null.
3470 llvm::Constant *ForwardCompat =
3471 getImageRelativeConstant(llvm::Constant::getNullValue(CGM.Int8PtrTy));
3472 llvm::Constant *PointerToCatchableTypes = getImageRelativeConstant(
3473 llvm::ConstantExpr::getBitCast(CTA, CGM.Int8PtrTy));
3474 llvm::StructType *TIType = getThrowInfoType();
3475 llvm::Constant *Fields[] = {
3476 llvm::ConstantInt::get(CGM.IntTy, Flags), // Flags
3477 getImageRelativeConstant(CleanupFn), // CleanupFn
3478 ForwardCompat, // ForwardCompat
3479 PointerToCatchableTypes // CatchableTypeArray
3480 };
3481 auto *GV = new llvm::GlobalVariable(
3482 CGM.getModule(), TIType, /*Constant=*/true, getLinkageForRTTI(T),
3483 llvm::ConstantStruct::get(TIType, Fields), StringRef(MangledName));
David Majnemer322fe412015-03-06 23:45:23 +00003484 GV->setUnnamedAddr(true);
3485 GV->setSection(".xdata");
David Majnemer7c237072015-03-05 00:46:22 +00003486 if (GV->isWeakForLinker())
3487 GV->setComdat(CGM.getModule().getOrInsertComdat(GV->getName()));
David Majnemer7c237072015-03-05 00:46:22 +00003488 return GV;
3489}
3490
3491void MicrosoftCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
3492 const Expr *SubExpr = E->getSubExpr();
3493 QualType ThrowType = SubExpr->getType();
3494 // The exception object lives on the stack and it's address is passed to the
3495 // runtime function.
3496 llvm::AllocaInst *AI = CGF.CreateMemTemp(ThrowType);
3497 CGF.EmitAnyExprToMem(SubExpr, AI, ThrowType.getQualifiers(),
3498 /*IsInit=*/true);
3499
3500 // The so-called ThrowInfo is used to describe how the exception object may be
3501 // caught.
3502 llvm::GlobalVariable *TI = getThrowInfo(ThrowType);
3503
3504 // Call into the runtime to throw the exception.
3505 llvm::Value *Args[] = {CGF.Builder.CreateBitCast(AI, CGM.Int8PtrTy), TI};
3506 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(), Args);
3507}