blob: 553112110c96edfaa6675bc9c076bdefc3cd07b5 [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"
Charles Davis74ce8592010-06-09 23:25:41 +000020#include "clang/AST/Decl.h"
21#include "clang/AST/DeclCXX.h"
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +000022#include "clang/AST/VTableBuilder.h"
David Majnemer611cdb92014-07-07 08:09:15 +000023#include "llvm/ADT/StringExtras.h"
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +000024#include "llvm/ADT/StringSet.h"
David Majnemer1162d252014-06-22 19:05:33 +000025#include "llvm/IR/CallSite.h"
Charles Davis74ce8592010-06-09 23:25:41 +000026
27using namespace clang;
28using namespace CodeGen;
29
30namespace {
31
Reid Klecknerb40a27d2014-01-03 00:14:35 +000032/// Holds all the vbtable globals for a given class.
33struct VBTableGlobals {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +000034 const VPtrInfoVector *VBTables;
Reid Klecknerb40a27d2014-01-03 00:14:35 +000035 SmallVector<llvm::GlobalVariable *, 2> Globals;
36};
37
Charles Davis53c59df2010-08-16 03:33:14 +000038class MicrosoftCXXABI : public CGCXXABI {
Charles Davis74ce8592010-06-09 23:25:41 +000039public:
David Majnemer611cdb92014-07-07 08:09:15 +000040 MicrosoftCXXABI(CodeGenModule &CGM)
41 : CGCXXABI(CGM), BaseClassDescriptorType(nullptr),
42 ClassHierarchyDescriptorType(nullptr),
43 CompleteObjectLocatorType(nullptr) {}
John McCall5d865c322010-08-31 07:33:07 +000044
Craig Topper4f12f102014-03-12 06:41:41 +000045 bool HasThisReturn(GlobalDecl GD) const override;
Stephen Lin9dc6eef2013-06-30 20:40:16 +000046
Reid Kleckner40ca9132014-05-13 22:05:45 +000047 bool classifyReturnType(CGFunctionInfo &FI) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000048
Reid Klecknere39ee212014-05-03 00:33:28 +000049 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000050
Reid Kleckner37abaca2014-05-09 22:46:15 +000051 bool isSRetParameterAfterThis() const override { return true; }
52
David Majnemer196ac332014-09-11 23:05:02 +000053 size_t getSrcArgforCopyCtor(const CXXConstructorDecl *CD,
54 FunctionArgList &Args) const override {
55 assert(Args.size() >= 2 &&
56 "expected the arglist to have at least two args!");
57 // The 'most_derived' parameter goes second if the ctor is variadic and
58 // has v-bases.
59 if (CD->getParent()->getNumVBases() > 0 &&
60 CD->getType()->castAs<FunctionProtoType>()->isVariadic())
61 return 2;
62 return 1;
63 }
64
Craig Topper4f12f102014-03-12 06:41:41 +000065 StringRef GetPureVirtualCallName() override { return "_purecall"; }
Craig Topper4f12f102014-03-12 06:41:41 +000066 StringRef GetDeletedVirtualCallName() override { return "_purecall"; }
Joao Matos2ce88ef2012-07-17 17:10:11 +000067
John McCall82fb8922012-09-25 10:10:39 +000068 llvm::Value *adjustToCompleteObject(CodeGenFunction &CGF,
69 llvm::Value *ptr,
Craig Topper4f12f102014-03-12 06:41:41 +000070 QualType type) override;
John McCall82fb8922012-09-25 10:10:39 +000071
David Majnemere2cb8d12014-07-07 06:20:47 +000072 llvm::GlobalVariable *getMSCompleteObjectLocator(const CXXRecordDecl *RD,
73 const VPtrInfo *Info);
74
75 llvm::Constant *getAddrOfRTTIDescriptor(QualType Ty) override;
76
David Majnemer1162d252014-06-22 19:05:33 +000077 bool shouldTypeidBeNullChecked(bool IsDeref, QualType SrcRecordTy) override;
78 void EmitBadTypeidCall(CodeGenFunction &CGF) override;
79 llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy,
80 llvm::Value *ThisPtr,
81 llvm::Type *StdTypeInfoPtrTy) override;
82
83 bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
84 QualType SrcRecordTy) override;
85
86 llvm::Value *EmitDynamicCastCall(CodeGenFunction &CGF, llvm::Value *Value,
87 QualType SrcRecordTy, QualType DestTy,
88 QualType DestRecordTy,
89 llvm::BasicBlock *CastEnd) override;
90
91 llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF, llvm::Value *Value,
92 QualType SrcRecordTy,
93 QualType DestTy) override;
94
95 bool EmitBadCastCall(CodeGenFunction &CGF) override;
96
Craig Topper4f12f102014-03-12 06:41:41 +000097 llvm::Value *
98 GetVirtualBaseClassOffset(CodeGenFunction &CGF, llvm::Value *This,
99 const CXXRecordDecl *ClassDecl,
100 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000101
Craig Topper4f12f102014-03-12 06:41:41 +0000102 llvm::BasicBlock *
103 EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
104 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000105
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000106 void initializeHiddenVirtualInheritanceMembers(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000107 const CXXRecordDecl *RD) override;
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000108
Craig Topper4f12f102014-03-12 06:41:41 +0000109 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000110
Reid Klecknere7de47e2013-07-22 13:51:44 +0000111 // Background on MSVC destructors
112 // ==============================
113 //
114 // Both Itanium and MSVC ABIs have destructor variants. The variant names
115 // roughly correspond in the following way:
116 // Itanium Microsoft
117 // Base -> no name, just ~Class
118 // Complete -> vbase destructor
119 // Deleting -> scalar deleting destructor
120 // vector deleting destructor
121 //
122 // The base and complete destructors are the same as in Itanium, although the
123 // complete destructor does not accept a VTT parameter when there are virtual
124 // bases. A separate mechanism involving vtordisps is used to ensure that
125 // virtual methods of destroyed subobjects are not called.
126 //
127 // The deleting destructors accept an i32 bitfield as a second parameter. Bit
128 // 1 indicates if the memory should be deleted. Bit 2 indicates if the this
129 // pointer points to an array. The scalar deleting destructor assumes that
130 // bit 2 is zero, and therefore does not contain a loop.
131 //
132 // For virtual destructors, only one entry is reserved in the vftable, and it
133 // always points to the vector deleting destructor. The vector deleting
134 // destructor is the most general, so it can be used to destroy objects in
135 // place, delete single heap objects, or delete arrays.
136 //
137 // A TU defining a non-inline destructor is only guaranteed to emit a base
138 // destructor, and all of the other variants are emitted on an as-needed basis
139 // in COMDATs. Because a non-base destructor can be emitted in a TU that
140 // lacks a definition for the destructor, non-base destructors must always
141 // delegate to or alias the base destructor.
142
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000143 void buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
144 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000145
Reid Klecknere7de47e2013-07-22 13:51:44 +0000146 /// Non-base dtors should be emitted as delegating thunks in this ABI.
147 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000148 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000149 return DT != Dtor_Base;
150 }
151
Craig Topper4f12f102014-03-12 06:41:41 +0000152 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000153
Craig Topper4f12f102014-03-12 06:41:41 +0000154 const CXXRecordDecl *
155 getThisArgumentTypeForMethod(const CXXMethodDecl *MD) override {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000156 MD = MD->getCanonicalDecl();
157 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD)) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000158 MicrosoftVTableContext::MethodVFTableLocation ML =
159 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000160 // The vbases might be ordered differently in the final overrider object
161 // and the complete object, so the "this" argument may sometimes point to
162 // memory that has no particular type (e.g. past the complete object).
163 // In this case, we just use a generic pointer type.
164 // FIXME: might want to have a more precise type in the non-virtual
165 // multiple inheritance case.
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +0000166 if (ML.VBase || !ML.VFPtrOffset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000167 return nullptr;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000168 }
169 return MD->getParent();
170 }
171
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000172 llvm::Value *
173 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD,
174 llvm::Value *This,
175 bool VirtualCall) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000176
Reid Kleckner89077a12013-12-17 19:46:40 +0000177 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000178 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000179
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000180 llvm::Value *adjustThisParameterInVirtualFunctionPrologue(
Craig Topper4f12f102014-03-12 06:41:41 +0000181 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000182
Craig Topper4f12f102014-03-12 06:41:41 +0000183 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall29036752011-01-27 02:46:02 +0000184
Reid Kleckner89077a12013-12-17 19:46:40 +0000185 unsigned addImplicitConstructorArgs(CodeGenFunction &CGF,
186 const CXXConstructorDecl *D,
187 CXXCtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000188 bool Delegating,
189 CallArgList &Args) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000190
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000191 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
192 CXXDtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000193 bool Delegating, llvm::Value *This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000194
Craig Topper4f12f102014-03-12 06:41:41 +0000195 void emitVTableDefinitions(CodeGenVTables &CGVT,
196 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000197
198 llvm::Value *getVTableAddressPointInStructor(
199 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
200 BaseSubobject Base, const CXXRecordDecl *NearestVBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000201 bool &NeedsVirtualOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000202
203 llvm::Constant *
204 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000205 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000206
207 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000208 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000209
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000210 llvm::Value *getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000211 llvm::Value *This,
212 llvm::Type *Ty) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000213
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000214 void EmitVirtualDestructorCall(CodeGenFunction &CGF,
215 const CXXDestructorDecl *Dtor,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +0000216 CXXDtorType DtorType, llvm::Value *This,
217 const CXXMemberCallExpr *CE) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000218
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000219 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000220 CallArgList &CallArgs) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000221 assert(GD.getDtorType() == Dtor_Deleting &&
222 "Only deleting destructor thunks are available in this ABI");
223 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)),
224 CGM.getContext().IntTy);
225 }
226
Craig Topper4f12f102014-03-12 06:41:41 +0000227 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000228
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000229 llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000230 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000231 llvm::GlobalVariable::LinkageTypes Linkage);
232
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000233 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000234 llvm::GlobalVariable *GV) const;
235
Hans Wennborgc94391d2014-06-06 20:04:01 +0000236 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
237 GlobalDecl GD, bool ReturnAdjustment) override {
Hans Wennborg853ae942014-05-30 16:59:42 +0000238 // Never dllimport/dllexport thunks.
239 Thunk->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
Hans Wennborgc94391d2014-06-06 20:04:01 +0000240
241 GVALinkage Linkage =
242 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
243
244 if (Linkage == GVA_Internal)
245 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
246 else if (ReturnAdjustment)
247 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
248 else
249 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000250 }
251
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000252 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, llvm::Value *This,
Craig Topper4f12f102014-03-12 06:41:41 +0000253 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000254
255 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000256 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000257
John McCallc84ed6a2012-05-01 06:13:13 +0000258 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
259 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000260 bool PerformInit) override;
John McCallc84ed6a2012-05-01 06:13:13 +0000261
John McCall29036752011-01-27 02:46:02 +0000262 // ==== Notes on array cookies =========
263 //
264 // MSVC seems to only use cookies when the class has a destructor; a
265 // two-argument usual array deallocation function isn't sufficient.
266 //
267 // For example, this code prints "100" and "1":
268 // struct A {
269 // char x;
270 // void *operator new[](size_t sz) {
271 // printf("%u\n", sz);
272 // return malloc(sz);
273 // }
274 // void operator delete[](void *p, size_t sz) {
275 // printf("%u\n", sz);
276 // free(p);
277 // }
278 // };
279 // int main() {
280 // A *p = new A[100];
281 // delete[] p;
282 // }
283 // Whereas it prints "104" and "104" if you give A a destructor.
John McCallb91cd662012-05-01 05:23:51 +0000284
Craig Topper4f12f102014-03-12 06:41:41 +0000285 bool requiresArrayCookie(const CXXDeleteExpr *expr,
286 QualType elementType) override;
287 bool requiresArrayCookie(const CXXNewExpr *expr) override;
288 CharUnits getArrayCookieSizeImpl(QualType type) override;
John McCallb91cd662012-05-01 05:23:51 +0000289 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
290 llvm::Value *NewPtr,
291 llvm::Value *NumElements,
292 const CXXNewExpr *expr,
Craig Topper4f12f102014-03-12 06:41:41 +0000293 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000294 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
295 llvm::Value *allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000296 CharUnits cookieSize) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000297
David Majnemer611cdb92014-07-07 08:09:15 +0000298 friend struct MSRTTIBuilder;
299
300 bool isImageRelative() const {
301 return CGM.getTarget().getPointerWidth(/*AddressSpace=*/0) == 64;
302 }
303
304 // 5 routines for constructing the llvm types for MS RTTI structs.
305 llvm::StructType *getTypeDescriptorType(StringRef TypeInfoString) {
306 llvm::SmallString<32> TDTypeName("rtti.TypeDescriptor");
307 TDTypeName += llvm::utostr(TypeInfoString.size());
308 llvm::StructType *&TypeDescriptorType =
309 TypeDescriptorTypeMap[TypeInfoString.size()];
310 if (TypeDescriptorType)
311 return TypeDescriptorType;
312 llvm::Type *FieldTypes[] = {
313 CGM.Int8PtrPtrTy,
314 CGM.Int8PtrTy,
315 llvm::ArrayType::get(CGM.Int8Ty, TypeInfoString.size() + 1)};
316 TypeDescriptorType =
317 llvm::StructType::create(CGM.getLLVMContext(), FieldTypes, TDTypeName);
318 return TypeDescriptorType;
319 }
320
321 llvm::Type *getImageRelativeType(llvm::Type *PtrType) {
322 if (!isImageRelative())
323 return PtrType;
324 return CGM.IntTy;
325 }
326
327 llvm::StructType *getBaseClassDescriptorType() {
328 if (BaseClassDescriptorType)
329 return BaseClassDescriptorType;
330 llvm::Type *FieldTypes[] = {
331 getImageRelativeType(CGM.Int8PtrTy),
332 CGM.IntTy,
333 CGM.IntTy,
334 CGM.IntTy,
335 CGM.IntTy,
336 CGM.IntTy,
337 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
338 };
339 BaseClassDescriptorType = llvm::StructType::create(
340 CGM.getLLVMContext(), FieldTypes, "rtti.BaseClassDescriptor");
341 return BaseClassDescriptorType;
342 }
343
344 llvm::StructType *getClassHierarchyDescriptorType() {
345 if (ClassHierarchyDescriptorType)
346 return ClassHierarchyDescriptorType;
347 // Forward-declare RTTIClassHierarchyDescriptor to break a cycle.
348 ClassHierarchyDescriptorType = llvm::StructType::create(
349 CGM.getLLVMContext(), "rtti.ClassHierarchyDescriptor");
350 llvm::Type *FieldTypes[] = {
351 CGM.IntTy,
352 CGM.IntTy,
353 CGM.IntTy,
354 getImageRelativeType(
355 getBaseClassDescriptorType()->getPointerTo()->getPointerTo()),
356 };
357 ClassHierarchyDescriptorType->setBody(FieldTypes);
358 return ClassHierarchyDescriptorType;
359 }
360
361 llvm::StructType *getCompleteObjectLocatorType() {
362 if (CompleteObjectLocatorType)
363 return CompleteObjectLocatorType;
364 CompleteObjectLocatorType = llvm::StructType::create(
365 CGM.getLLVMContext(), "rtti.CompleteObjectLocator");
366 llvm::Type *FieldTypes[] = {
367 CGM.IntTy,
368 CGM.IntTy,
369 CGM.IntTy,
370 getImageRelativeType(CGM.Int8PtrTy),
371 getImageRelativeType(getClassHierarchyDescriptorType()->getPointerTo()),
372 getImageRelativeType(CompleteObjectLocatorType),
373 };
374 llvm::ArrayRef<llvm::Type *> FieldTypesRef(FieldTypes);
375 if (!isImageRelative())
376 FieldTypesRef = FieldTypesRef.drop_back();
377 CompleteObjectLocatorType->setBody(FieldTypesRef);
378 return CompleteObjectLocatorType;
379 }
380
381 llvm::GlobalVariable *getImageBase() {
382 StringRef Name = "__ImageBase";
383 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name))
384 return GV;
385
386 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8Ty,
387 /*isConstant=*/true,
388 llvm::GlobalValue::ExternalLinkage,
389 /*Initializer=*/nullptr, Name);
390 }
391
392 llvm::Constant *getImageRelativeConstant(llvm::Constant *PtrVal) {
393 if (!isImageRelative())
394 return PtrVal;
395
396 llvm::Constant *ImageBaseAsInt =
397 llvm::ConstantExpr::getPtrToInt(getImageBase(), CGM.IntPtrTy);
398 llvm::Constant *PtrValAsInt =
399 llvm::ConstantExpr::getPtrToInt(PtrVal, CGM.IntPtrTy);
400 llvm::Constant *Diff =
401 llvm::ConstantExpr::getSub(PtrValAsInt, ImageBaseAsInt,
402 /*HasNUW=*/true, /*HasNSW=*/true);
403 return llvm::ConstantExpr::getTrunc(Diff, CGM.IntTy);
404 }
405
Reid Kleckner407e8b62013-03-22 19:02:54 +0000406private:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000407 MicrosoftMangleContext &getMangleContext() {
408 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext());
409 }
410
Reid Kleckner2341ae32013-04-11 18:13:19 +0000411 llvm::Constant *getZeroInt() {
412 return llvm::ConstantInt::get(CGM.IntTy, 0);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000413 }
414
Reid Kleckner2341ae32013-04-11 18:13:19 +0000415 llvm::Constant *getAllOnesInt() {
416 return llvm::Constant::getAllOnesValue(CGM.IntTy);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000417 }
418
Reid Kleckner452abac2013-05-09 21:01:17 +0000419 llvm::Constant *getConstantOrZeroInt(llvm::Constant *C) {
420 return C ? C : getZeroInt();
421 }
422
423 llvm::Value *getValueOrZeroInt(llvm::Value *C) {
424 return C ? C : getZeroInt();
425 }
426
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000427 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD);
428
Reid Kleckner2341ae32013-04-11 18:13:19 +0000429 void
430 GetNullMemberPointerFields(const MemberPointerType *MPT,
431 llvm::SmallVectorImpl<llvm::Constant *> &fields);
432
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000433 /// \brief Shared code for virtual base adjustment. Returns the offset from
434 /// the vbptr to the virtual base. Optionally returns the address of the
435 /// vbptr itself.
436 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
437 llvm::Value *Base,
438 llvm::Value *VBPtrOffset,
439 llvm::Value *VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000440 llvm::Value **VBPtr = nullptr);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000441
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000442 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
443 llvm::Value *Base,
444 int32_t VBPtrOffset,
445 int32_t VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000446 llvm::Value **VBPtr = nullptr) {
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000447 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
448 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset);
449 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr);
450 }
451
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000452 /// \brief Performs a full virtual base adjustment. Used to dereference
453 /// pointers to members of virtual bases.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000454 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E,
455 const CXXRecordDecl *RD, llvm::Value *Base,
Reid Kleckner2341ae32013-04-11 18:13:19 +0000456 llvm::Value *VirtualBaseAdjustmentOffset,
457 llvm::Value *VBPtrOffset /* optional */);
458
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000459 /// \brief Emits a full member pointer with the fields common to data and
460 /// function member pointers.
461 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField,
462 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +0000463 const CXXRecordDecl *RD,
464 CharUnits NonVirtualBaseAdjustment);
465
466 llvm::Constant *BuildMemberPointer(const CXXRecordDecl *RD,
467 const CXXMethodDecl *MD,
468 CharUnits NonVirtualBaseAdjustment);
469
470 bool MemberPointerConstantIsNull(const MemberPointerType *MPT,
471 llvm::Constant *MP);
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000472
Reid Kleckner7810af02013-06-19 15:20:38 +0000473 /// \brief - Initialize all vbptrs of 'this' with RD as the complete type.
474 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
475
476 /// \brief Caching wrapper around VBTableBuilder::enumerateVBTables().
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000477 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000478
Hans Wennborg88497d62013-11-15 17:24:45 +0000479 /// \brief Generate a thunk for calling a virtual member function MD.
Reid Klecknere4a52202014-02-21 02:27:32 +0000480 llvm::Function *EmitVirtualMemPtrThunk(
481 const CXXMethodDecl *MD,
482 const MicrosoftVTableContext::MethodVFTableLocation &ML);
Hans Wennborg88497d62013-11-15 17:24:45 +0000483
Reid Kleckner407e8b62013-03-22 19:02:54 +0000484public:
Craig Topper4f12f102014-03-12 06:41:41 +0000485 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000486
Craig Topper4f12f102014-03-12 06:41:41 +0000487 bool isZeroInitializable(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000488
David Majnemerb3e56542014-08-07 22:56:13 +0000489 bool isMemberPointerConvertible(const MemberPointerType *MPT) const override {
490 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
491 return RD->getAttr<MSInheritanceAttr>() != nullptr;
492 }
493
Craig Topper4f12f102014-03-12 06:41:41 +0000494 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000495
Craig Topper4f12f102014-03-12 06:41:41 +0000496 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
497 CharUnits offset) override;
498 llvm::Constant *EmitMemberPointer(const CXXMethodDecl *MD) override;
499 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000500
Craig Topper4f12f102014-03-12 06:41:41 +0000501 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
502 llvm::Value *L,
503 llvm::Value *R,
504 const MemberPointerType *MPT,
505 bool Inequality) override;
Reid Kleckner700c3ee2013-04-30 20:15:14 +0000506
Craig Topper4f12f102014-03-12 06:41:41 +0000507 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
508 llvm::Value *MemPtr,
509 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000510
Craig Topper4f12f102014-03-12 06:41:41 +0000511 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000512 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
513 llvm::Value *Base, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000514 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000515
Craig Topper4f12f102014-03-12 06:41:41 +0000516 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
517 const CastExpr *E,
518 llvm::Value *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000519
Craig Topper4f12f102014-03-12 06:41:41 +0000520 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
521 llvm::Constant *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000522
Craig Topper4f12f102014-03-12 06:41:41 +0000523 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000524 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E,
525 llvm::Value *&This, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000526 const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000527
Reid Kleckner7810af02013-06-19 15:20:38 +0000528private:
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000529 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy;
David Majnemerd905da42014-07-01 20:30:31 +0000530 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy;
531 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000532 /// \brief All the vftables that have been referenced.
533 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000534 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000535
536 /// \brief This set holds the record decls we've deferred vtable emission for.
537 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
538
539
540 /// \brief All the vbtables which have been referenced.
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000541 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap;
Reid Klecknerd8110b62013-09-10 20:14:30 +0000542
543 /// Info on the global variable used to guard initialization of static locals.
544 /// The BitIndex field is only used for externally invisible declarations.
545 struct GuardInfo {
Craig Topper8a13c412014-05-21 05:09:00 +0000546 GuardInfo() : Guard(nullptr), BitIndex(0) {}
Reid Klecknerd8110b62013-09-10 20:14:30 +0000547 llvm::GlobalVariable *Guard;
548 unsigned BitIndex;
549 };
550
551 /// Map from DeclContext to the current guard variable. We assume that the
552 /// AST is visited in source code order.
553 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap;
David Majnemer611cdb92014-07-07 08:09:15 +0000554
555 llvm::DenseMap<size_t, llvm::StructType *> TypeDescriptorTypeMap;
556 llvm::StructType *BaseClassDescriptorType;
557 llvm::StructType *ClassHierarchyDescriptorType;
558 llvm::StructType *CompleteObjectLocatorType;
Charles Davis74ce8592010-06-09 23:25:41 +0000559};
560
561}
562
Reid Klecknere39ee212014-05-03 00:33:28 +0000563CGCXXABI::RecordArgABI
564MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const {
565 switch (CGM.getTarget().getTriple().getArch()) {
566 default:
567 // FIXME: Implement for other architectures.
568 return RAA_Default;
569
570 case llvm::Triple::x86:
Reid Klecknercf87e102014-05-14 16:02:09 +0000571 // All record arguments are passed in memory on x86. Decide whether to
572 // construct the object directly in argument memory, or to construct the
573 // argument elsewhere and copy the bytes during the call.
574
575 // If C++ prohibits us from making a copy, construct the arguments directly
576 // into argument memory.
577 if (!canCopyArgument(RD))
Reid Klecknere39ee212014-05-03 00:33:28 +0000578 return RAA_DirectInMemory;
Reid Klecknercf87e102014-05-14 16:02:09 +0000579
580 // Otherwise, construct the argument into a temporary and copy the bytes
581 // into the outgoing argument memory.
Reid Klecknere39ee212014-05-03 00:33:28 +0000582 return RAA_Default;
583
584 case llvm::Triple::x86_64:
585 // Win64 passes objects with non-trivial copy ctors indirectly.
586 if (RD->hasNonTrivialCopyConstructor())
587 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000588
Reid Klecknere39ee212014-05-03 00:33:28 +0000589 // Win64 passes objects larger than 8 bytes indirectly.
590 if (getContext().getTypeSize(RD->getTypeForDecl()) > 64)
591 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000592
593 // We have a trivial copy constructor or no copy constructors, but we have
594 // to make sure it isn't deleted.
595 bool CopyDeleted = false;
596 for (const CXXConstructorDecl *CD : RD->ctors()) {
597 if (CD->isCopyConstructor()) {
598 assert(CD->isTrivial());
599 // We had at least one undeleted trivial copy ctor. Return directly.
600 if (!CD->isDeleted())
601 return RAA_Default;
602 CopyDeleted = true;
603 }
604 }
605
606 // The trivial copy constructor was deleted. Return indirectly.
607 if (CopyDeleted)
608 return RAA_Indirect;
609
610 // There were no copy ctors. Return in RAX.
Reid Klecknere39ee212014-05-03 00:33:28 +0000611 return RAA_Default;
612 }
613
614 llvm_unreachable("invalid enum");
615}
616
John McCall82fb8922012-09-25 10:10:39 +0000617llvm::Value *MicrosoftCXXABI::adjustToCompleteObject(CodeGenFunction &CGF,
618 llvm::Value *ptr,
619 QualType type) {
620 // FIXME: implement
621 return ptr;
622}
623
David Majnemer1162d252014-06-22 19:05:33 +0000624/// \brief Gets the offset to the virtual base that contains the vfptr for
625/// MS-ABI polymorphic types.
626static llvm::Value *getPolymorphicOffset(CodeGenFunction &CGF,
627 const CXXRecordDecl *RD,
628 llvm::Value *Value) {
629 const ASTContext &Context = RD->getASTContext();
630 for (const CXXBaseSpecifier &Base : RD->vbases())
631 if (Context.getASTRecordLayout(Base.getType()->getAsCXXRecordDecl())
632 .hasExtendableVFPtr())
633 return CGF.CGM.getCXXABI().GetVirtualBaseClassOffset(
634 CGF, Value, RD, Base.getType()->getAsCXXRecordDecl());
635 llvm_unreachable("One of our vbases should be polymorphic.");
636}
637
638static std::pair<llvm::Value *, llvm::Value *>
639performBaseAdjustment(CodeGenFunction &CGF, llvm::Value *Value,
640 QualType SrcRecordTy) {
641 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
642 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
643
644 if (CGF.getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
645 return std::make_pair(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0));
646
647 // Perform a base adjustment.
648 llvm::Value *Offset = getPolymorphicOffset(CGF, SrcDecl, Value);
649 Value = CGF.Builder.CreateInBoundsGEP(Value, Offset);
650 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
651 return std::make_pair(Value, Offset);
652}
653
654bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
655 QualType SrcRecordTy) {
656 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
657 return IsDeref &&
658 !CGM.getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
659}
660
661static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF,
662 llvm::Value *Argument) {
663 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
664 llvm::FunctionType *FTy =
665 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
666 llvm::Value *Args[] = {Argument};
667 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
668 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
669}
670
671void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
672 llvm::CallSite Call =
673 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
674 Call.setDoesNotReturn();
675 CGF.Builder.CreateUnreachable();
676}
677
678llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
679 QualType SrcRecordTy,
680 llvm::Value *ThisPtr,
681 llvm::Type *StdTypeInfoPtrTy) {
682 llvm::Value *Offset;
683 std::tie(ThisPtr, Offset) = performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
684 return CGF.Builder.CreateBitCast(
685 emitRTtypeidCall(CGF, ThisPtr).getInstruction(), StdTypeInfoPtrTy);
686}
687
688bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
689 QualType SrcRecordTy) {
690 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
691 return SrcIsPtr &&
692 !CGM.getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
693}
694
695llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
696 CodeGenFunction &CGF, llvm::Value *Value, QualType SrcRecordTy,
697 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
698 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
699
700 llvm::Value *SrcRTTI =
701 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
702 llvm::Value *DestRTTI =
703 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
704
705 llvm::Value *Offset;
706 std::tie(Value, Offset) = performBaseAdjustment(CGF, Value, SrcRecordTy);
707
708 // PVOID __RTDynamicCast(
709 // PVOID inptr,
710 // LONG VfDelta,
711 // PVOID SrcType,
712 // PVOID TargetType,
713 // BOOL isReference)
714 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
715 CGF.Int8PtrTy, CGF.Int32Ty};
716 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
717 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
718 "__RTDynamicCast");
719 llvm::Value *Args[] = {
720 Value, Offset, SrcRTTI, DestRTTI,
721 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
722 Value = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction();
723 return CGF.Builder.CreateBitCast(Value, DestLTy);
724}
725
726llvm::Value *
727MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, llvm::Value *Value,
728 QualType SrcRecordTy,
729 QualType DestTy) {
730 llvm::Value *Offset;
731 std::tie(Value, Offset) = performBaseAdjustment(CGF, Value, SrcRecordTy);
732
733 // PVOID __RTCastToVoid(
734 // PVOID inptr)
735 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
736 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
737 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
738 "__RTCastToVoid");
739 llvm::Value *Args[] = {Value};
740 return CGF.EmitRuntimeCall(Function, Args);
741}
742
743bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
744 return false;
745}
746
David Majnemerca32f932014-09-01 18:50:02 +0000747llvm::Value *MicrosoftCXXABI::GetVirtualBaseClassOffset(
748 CodeGenFunction &CGF, llvm::Value *This, const CXXRecordDecl *ClassDecl,
749 const CXXRecordDecl *BaseClassDecl) {
Reid Kleckner5b1b5d52014-01-14 00:50:39 +0000750 int64_t VBPtrChars =
751 getContext().getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000752 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000753 CharUnits IntSize = getContext().getTypeSizeInChars(getContext().IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000754 CharUnits VBTableChars =
755 IntSize *
756 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000757 llvm::Value *VBTableOffset =
David Majnemerca32f932014-09-01 18:50:02 +0000758 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000759
760 llvm::Value *VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +0000761 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000762 VBPtrToNewBase =
David Majnemerca32f932014-09-01 18:50:02 +0000763 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000764 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
765}
766
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000767bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
768 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +0000769}
770
Reid Kleckner40ca9132014-05-13 22:05:45 +0000771bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
772 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
773 if (!RD)
774 return false;
775
776 if (FI.isInstanceMethod()) {
777 // If it's an instance method, aggregates are always returned indirectly via
778 // the second parameter.
779 FI.getReturnInfo() = ABIArgInfo::getIndirect(0, /*ByVal=*/false);
780 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod());
781 return true;
782 } else if (!RD->isPOD()) {
783 // If it's a free function, non-POD types are returned indirectly.
784 FI.getReturnInfo() = ABIArgInfo::getIndirect(0, /*ByVal=*/false);
785 return true;
786 }
787
788 // Otherwise, use the C ABI rules.
789 return false;
790}
791
Reid Kleckner7810af02013-06-19 15:20:38 +0000792llvm::BasicBlock *
793MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
794 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000795 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
796 assert(IsMostDerivedClass &&
797 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +0000798 llvm::Value *IsCompleteObject =
799 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000800
801 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
802 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
803 CGF.Builder.CreateCondBr(IsCompleteObject,
804 CallVbaseCtorsBB, SkipVbaseCtorsBB);
805
806 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +0000807
808 // Fill in the vbtable pointers here.
809 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000810
811 // CGF will put the base ctor calls in this basic block for us later.
812
813 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +0000814}
815
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000816void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
817 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
818 // In most cases, an override for a vbase virtual method can adjust
819 // the "this" parameter by applying a constant offset.
820 // However, this is not enough while a constructor or a destructor of some
821 // class X is being executed if all the following conditions are met:
822 // - X has virtual bases, (1)
823 // - X overrides a virtual method M of a vbase Y, (2)
824 // - X itself is a vbase of the most derived class.
825 //
826 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
827 // which holds the extra amount of "this" adjustment we must do when we use
828 // the X vftables (i.e. during X ctor or dtor).
829 // Outside the ctors and dtors, the values of vtorDisps are zero.
830
831 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
832 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
833 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
834 CGBuilderTy &Builder = CGF.Builder;
835
836 unsigned AS =
837 cast<llvm::PointerType>(getThisValue(CGF)->getType())->getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +0000838 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000839
840 for (VBOffsets::const_iterator I = VBaseMap.begin(), E = VBaseMap.end();
841 I != E; ++I) {
842 if (!I->second.hasVtorDisp())
843 continue;
844
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +0000845 llvm::Value *VBaseOffset =
846 GetVirtualBaseClassOffset(CGF, getThisValue(CGF), RD, I->first);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000847 // FIXME: it doesn't look right that we SExt in GetVirtualBaseClassOffset()
848 // just to Trunc back immediately.
849 VBaseOffset = Builder.CreateTruncOrBitCast(VBaseOffset, CGF.Int32Ty);
850 uint64_t ConstantVBaseOffset =
851 Layout.getVBaseClassOffset(I->first).getQuantity();
852
853 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
854 llvm::Value *VtorDispValue = Builder.CreateSub(
855 VBaseOffset, llvm::ConstantInt::get(CGM.Int32Ty, ConstantVBaseOffset),
856 "vtordisp.value");
857
858 if (!Int8This)
859 Int8This = Builder.CreateBitCast(getThisValue(CGF),
860 CGF.Int8Ty->getPointerTo(AS));
861 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
862 // vtorDisp is always the 32-bits before the vbase in the class layout.
863 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
864 VtorDispPtr = Builder.CreateBitCast(
865 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
866
867 Builder.CreateStore(VtorDispValue, VtorDispPtr);
868 }
869}
870
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000871void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
872 // There's only one constructor type in this ABI.
873 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
874}
875
Reid Kleckner7810af02013-06-19 15:20:38 +0000876void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
877 const CXXRecordDecl *RD) {
878 llvm::Value *ThisInt8Ptr =
879 CGF.Builder.CreateBitCast(getThisValue(CGF), CGM.Int8PtrTy, "this.int8");
Reid Kleckner5f080942014-01-03 23:42:00 +0000880 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000881
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000882 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
883 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000884 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000885 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +0000886 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000887 CGM.getContext().getASTRecordLayout(VBT->BaseWithVPtr);
Reid Kleckner5f080942014-01-03 23:42:00 +0000888 CharUnits Offs = VBT->NonVirtualOffset;
889 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000890 if (VBT->getVBaseWithVPtr())
891 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
Reid Kleckner7810af02013-06-19 15:20:38 +0000892 llvm::Value *VBPtr =
Reid Kleckner5f080942014-01-03 23:42:00 +0000893 CGF.Builder.CreateConstInBoundsGEP1_64(ThisInt8Ptr, Offs.getQuantity());
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000894 VBPtr = CGF.Builder.CreateBitCast(VBPtr, GV->getType()->getPointerTo(0),
Reid Kleckner5f080942014-01-03 23:42:00 +0000895 "vbptr." + VBT->ReusingBase->getName());
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000896 CGF.Builder.CreateStore(GV, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +0000897 }
898}
899
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000900void
901MicrosoftCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000902 SmallVectorImpl<CanQualType> &ArgTys) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000903 // TODO: 'for base' flag
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000904 if (T == StructorType::Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +0000905 // The scalar deleting destructor takes an implicit int parameter.
906 ArgTys.push_back(CGM.getContext().IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000907 }
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000908 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
909 if (!CD)
910 return;
911
912 // All parameters are already in place except is_most_derived, which goes
913 // after 'this' if it's variadic and last if it's not.
914
915 const CXXRecordDecl *Class = CD->getParent();
916 const FunctionProtoType *FPT = CD->getType()->castAs<FunctionProtoType>();
917 if (Class->getNumVBases()) {
918 if (FPT->isVariadic())
919 ArgTys.insert(ArgTys.begin() + 1, CGM.getContext().IntTy);
920 else
921 ArgTys.push_back(CGM.getContext().IntTy);
922 }
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000923}
924
Reid Klecknere7de47e2013-07-22 13:51:44 +0000925void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
926 // The TU defining a dtor is only guaranteed to emit a base destructor. All
927 // other destructor variants are delegating thunks.
928 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
929}
930
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000931CharUnits
932MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000933 GD = GD.getCanonicalDecl();
934 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000935
936 GlobalDecl LookupGD = GD;
937 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
938 // Complete destructors take a pointer to the complete object as a
939 // parameter, thus don't need this adjustment.
940 if (GD.getDtorType() == Dtor_Complete)
941 return CharUnits();
942
943 // There's no Dtor_Base in vftable but it shares the this adjustment with
944 // the deleting one, so look it up instead.
945 LookupGD = GlobalDecl(DD, Dtor_Deleting);
946 }
947
948 MicrosoftVTableContext::MethodVFTableLocation ML =
949 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
950 CharUnits Adjustment = ML.VFPtrOffset;
951
952 // Normal virtual instance methods need to adjust from the vfptr that first
953 // defined the virtual method to the virtual base subobject, but destructors
954 // do not. The vector deleting destructor thunk applies this adjustment for
955 // us if necessary.
956 if (isa<CXXDestructorDecl>(MD))
957 Adjustment = CharUnits::Zero();
958
959 if (ML.VBase) {
960 const ASTRecordLayout &DerivedLayout =
961 CGM.getContext().getASTRecordLayout(MD->getParent());
962 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
963 }
964
965 return Adjustment;
966}
967
968llvm::Value *MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
969 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This, bool VirtualCall) {
970 if (!VirtualCall) {
971 // If the call of a virtual function is not virtual, we just have to
972 // compensate for the adjustment the virtual function does in its prologue.
973 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
974 if (Adjustment.isZero())
975 return This;
976
977 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
978 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS);
979 This = CGF.Builder.CreateBitCast(This, charPtrTy);
980 assert(Adjustment.isPositive());
981 return CGF.Builder.CreateConstGEP1_32(This, Adjustment.getQuantity());
982 }
983
984 GD = GD.getCanonicalDecl();
985 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000986
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +0000987 GlobalDecl LookupGD = GD;
988 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
989 // Complete dtors take a pointer to the complete object,
990 // thus don't need adjustment.
991 if (GD.getDtorType() == Dtor_Complete)
992 return This;
993
994 // There's only Dtor_Deleting in vftable but it shares the this adjustment
995 // with the base one, so look up the deleting one instead.
996 LookupGD = GlobalDecl(DD, Dtor_Deleting);
997 }
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000998 MicrosoftVTableContext::MethodVFTableLocation ML =
999 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001000
1001 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1002 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS);
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +00001003 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +00001004
1005 // Base destructors expect 'this' to point to the beginning of the base
1006 // subobject, not the first vfptr that happens to contain the virtual dtor.
1007 // However, we still need to apply the virtual base adjustment.
1008 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1009 StaticOffset = CharUnits::Zero();
1010
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001011 if (ML.VBase) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001012 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1013 llvm::Value *VBaseOffset =
1014 GetVirtualBaseClassOffset(CGF, This, MD->getParent(), ML.VBase);
1015 This = CGF.Builder.CreateInBoundsGEP(This, VBaseOffset);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001016 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001017 if (!StaticOffset.isZero()) {
1018 assert(StaticOffset.isPositive());
1019 This = CGF.Builder.CreateBitCast(This, charPtrTy);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001020 if (ML.VBase) {
1021 // Non-virtual adjustment might result in a pointer outside the allocated
1022 // object, e.g. if the final overrider class is laid out after the virtual
1023 // base that declares a method in the most derived class.
1024 // FIXME: Update the code that emits this adjustment in thunks prologues.
1025 This = CGF.Builder.CreateConstGEP1_32(This, StaticOffset.getQuantity());
1026 } else {
1027 This = CGF.Builder.CreateConstInBoundsGEP1_32(This,
1028 StaticOffset.getQuantity());
1029 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001030 }
1031 return This;
1032}
1033
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001034static bool IsDeletingDtor(GlobalDecl GD) {
1035 const CXXMethodDecl* MD = cast<CXXMethodDecl>(GD.getDecl());
1036 if (isa<CXXDestructorDecl>(MD)) {
1037 return GD.getDtorType() == Dtor_Deleting;
1038 }
1039 return false;
1040}
1041
Reid Kleckner89077a12013-12-17 19:46:40 +00001042void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1043 QualType &ResTy,
1044 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001045 ASTContext &Context = getContext();
1046 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001047 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001048 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1049 ImplicitParamDecl *IsMostDerived
Craig Topper8a13c412014-05-21 05:09:00 +00001050 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001051 CGF.CurGD.getDecl()->getLocation(),
1052 &Context.Idents.get("is_most_derived"),
1053 Context.IntTy);
Reid Kleckner89077a12013-12-17 19:46:40 +00001054 // The 'most_derived' parameter goes second if the ctor is variadic and last
1055 // if it's not. Dtors can't be variadic.
1056 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1057 if (FPT->isVariadic())
1058 Params.insert(Params.begin() + 1, IsMostDerived);
1059 else
1060 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001061 getStructorImplicitParamDecl(CGF) = IsMostDerived;
1062 } else if (IsDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001063 ImplicitParamDecl *ShouldDelete
Craig Topper8a13c412014-05-21 05:09:00 +00001064 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001065 CGF.CurGD.getDecl()->getLocation(),
1066 &Context.Idents.get("should_call_delete"),
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001067 Context.IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001068 Params.push_back(ShouldDelete);
1069 getStructorImplicitParamDecl(CGF) = ShouldDelete;
1070 }
John McCall0f999f32012-09-25 08:00:39 +00001071}
1072
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001073llvm::Value *MicrosoftCXXABI::adjustThisParameterInVirtualFunctionPrologue(
1074 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001075 // In this ABI, every virtual function takes a pointer to one of the
1076 // subobjects that first defines it as the 'this' parameter, rather than a
Alp Tokerf6a24ce2013-12-05 16:25:25 +00001077 // pointer to the final overrider subobject. Thus, we need to adjust it back
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001078 // to the final overrider subobject before use.
1079 // See comments in the MicrosoftVFTableContext implementation for the details.
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001080 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001081 if (Adjustment.isZero())
1082 return This;
1083
1084 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
1085 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
1086 *thisTy = This->getType();
1087
1088 This = CGF.Builder.CreateBitCast(This, charPtrTy);
1089 assert(Adjustment.isPositive());
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +00001090 This =
1091 CGF.Builder.CreateConstInBoundsGEP1_32(This, -Adjustment.getQuantity());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001092 return CGF.Builder.CreateBitCast(This, thisTy);
1093}
1094
John McCall0f999f32012-09-25 08:00:39 +00001095void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
1096 EmitThisParam(CGF);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001097
1098 /// If this is a function that the ABI specifies returns 'this', initialize
1099 /// the return slot to 'this' at the start of the function.
1100 ///
1101 /// Unlike the setting of return types, this is done within the ABI
1102 /// implementation instead of by clients of CGCXXABI because:
1103 /// 1) getThisValue is currently protected
1104 /// 2) in theory, an ABI could implement 'this' returns some other way;
1105 /// HasThisReturn only specifies a contract, not the implementation
1106 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +00001107 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001108
1109 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
1110 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
1111 assert(getStructorImplicitParamDecl(CGF) &&
1112 "no implicit parameter for a constructor with virtual bases?");
1113 getStructorImplicitParamValue(CGF)
1114 = CGF.Builder.CreateLoad(
1115 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1116 "is_most_derived");
1117 }
1118
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001119 if (IsDeletingDtor(CGF.CurGD)) {
1120 assert(getStructorImplicitParamDecl(CGF) &&
1121 "no implicit parameter for a deleting destructor?");
1122 getStructorImplicitParamValue(CGF)
1123 = CGF.Builder.CreateLoad(
1124 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1125 "should_call_delete");
1126 }
John McCall0f999f32012-09-25 08:00:39 +00001127}
1128
Reid Kleckner89077a12013-12-17 19:46:40 +00001129unsigned MicrosoftCXXABI::addImplicitConstructorArgs(
1130 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1131 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001132 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001133
Reid Kleckner89077a12013-12-17 19:46:40 +00001134 // Check if we need a 'most_derived' parameter.
1135 if (!D->getParent()->getNumVBases())
1136 return 0;
1137
1138 // Add the 'most_derived' argument second if we are variadic or last if not.
1139 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
1140 llvm::Value *MostDerivedArg =
1141 llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
1142 RValue RV = RValue::get(MostDerivedArg);
1143 if (MostDerivedArg) {
1144 if (FPT->isVariadic())
1145 Args.insert(Args.begin() + 1,
1146 CallArg(RV, getContext().IntTy, /*needscopy=*/false));
1147 else
1148 Args.add(RV, getContext().IntTy);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001149 }
1150
Reid Kleckner89077a12013-12-17 19:46:40 +00001151 return 1; // Added one arg.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001152}
1153
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001154void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1155 const CXXDestructorDecl *DD,
1156 CXXDtorType Type, bool ForVirtualBase,
1157 bool Delegating, llvm::Value *This) {
Rafael Espindola1ac0ec82014-09-11 15:42:06 +00001158 llvm::Value *Callee = CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type));
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001159
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001160 if (DD->isVirtual()) {
1161 assert(Type != CXXDtorType::Dtor_Deleting &&
1162 "The deleting destructor should only be called via a virtual call");
1163 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1164 This, false);
1165 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001166
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001167 CGF.EmitCXXMemberOrOperatorCall(DD, Callee, ReturnValueSlot(), This,
1168 /*ImplicitParam=*/nullptr,
1169 /*ImplicitParamTy=*/QualType(), nullptr);
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001170}
1171
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001172void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1173 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001174 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Benjamin Kramer22c68ef2014-09-11 14:13:49 +00001175 const VPtrInfoVector &VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001176
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001177 for (VPtrInfo *Info : VFPtrs) {
1178 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001179 if (VTable->hasInitializer())
1180 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001181
David Majnemer65f87322014-07-24 06:09:19 +00001182 llvm::Constant *RTTI = getContext().getLangOpts().RTTIData
1183 ? getMSCompleteObjectLocator(RD, Info)
1184 : nullptr;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001185
1186 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001187 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001188 llvm::Constant *Init = CGVT.CreateVTableInitializer(
1189 RD, VTLayout.vtable_component_begin(),
1190 VTLayout.getNumVTableComponents(), VTLayout.vtable_thunk_begin(),
David Majnemerd905da42014-07-01 20:30:31 +00001191 VTLayout.getNumVTableThunks(), RTTI);
1192
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001193 VTable->setInitializer(Init);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001194 }
1195}
1196
1197llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1198 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
1199 const CXXRecordDecl *NearestVBase, bool &NeedsVirtualOffset) {
Craig Topper8a13c412014-05-21 05:09:00 +00001200 NeedsVirtualOffset = (NearestVBase != nullptr);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001201
David Majnemerd905da42014-07-01 20:30:31 +00001202 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1203 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1204 llvm::GlobalValue *VTableAddressPoint = VFTablesMap[ID];
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001205 if (!VTableAddressPoint) {
1206 assert(Base.getBase()->getNumVBases() &&
1207 !CGM.getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
1208 }
1209 return VTableAddressPoint;
1210}
1211
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001212static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001213 const CXXRecordDecl *RD, const VPtrInfo *VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001214 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001215 llvm::raw_svector_ostream Out(Name);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001216 MangleContext.mangleCXXVFTable(RD, VFPtr->MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001217}
1218
1219llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1220 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
David Majnemerd905da42014-07-01 20:30:31 +00001221 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1222 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1223 llvm::GlobalValue *VFTable = VFTablesMap[ID];
1224 assert(VFTable && "Couldn't find a vftable for the given base?");
1225 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001226}
1227
1228llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1229 CharUnits VPtrOffset) {
1230 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1231 // shouldn't be used in the given record type. We want to cache this result in
1232 // VFTablesMap, thus a simple zero check is not sufficient.
1233 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001234 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001235 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001236 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001237 if (!Inserted)
1238 return I->second;
1239
1240 llvm::GlobalVariable *&VTable = I->second;
1241
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001242 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001243 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001244
1245 if (DeferredVFTables.insert(RD)) {
1246 // We haven't processed this record type before.
1247 // Queue up this v-table for possible deferred emission.
1248 CGM.addDeferredVTable(RD);
1249
1250#ifndef NDEBUG
1251 // Create all the vftables at once in order to make sure each vftable has
1252 // a unique mangled name.
1253 llvm::StringSet<> ObservedMangledNames;
1254 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1255 SmallString<256> Name;
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001256 mangleVFTableName(getMangleContext(), RD, VFPtrs[J], Name);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001257 if (!ObservedMangledNames.insert(Name.str()))
1258 llvm_unreachable("Already saw this mangling before?");
1259 }
1260#endif
1261 }
1262
1263 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001264 if (VFPtrs[J]->FullOffsetInMDC != VPtrOffset)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001265 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001266 SmallString<256> VFTableName;
1267 mangleVFTableName(getMangleContext(), RD, VFPtrs[J], VFTableName);
1268 StringRef VTableName = VFTableName;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001269
David Majnemerd905da42014-07-01 20:30:31 +00001270 uint64_t NumVTableSlots =
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001271 VTContext.getVFTableLayout(RD, VFPtrs[J]->FullOffsetInMDC)
David Majnemerd905da42014-07-01 20:30:31 +00001272 .getNumVTableComponents();
1273 llvm::GlobalValue::LinkageTypes VTableLinkage =
1274 llvm::GlobalValue::ExternalLinkage;
1275 llvm::ArrayType *VTableType =
1276 llvm::ArrayType::get(CGM.Int8PtrTy, NumVTableSlots);
David Majnemerf6072342014-07-01 22:24:56 +00001277 if (getContext().getLangOpts().RTTIData) {
David Majnemerd905da42014-07-01 20:30:31 +00001278 VTableLinkage = llvm::GlobalValue::PrivateLinkage;
1279 VTableName = "";
1280 }
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001281
David Majnemerd905da42014-07-01 20:30:31 +00001282 VTable = CGM.getModule().getNamedGlobal(VFTableName);
1283 if (!VTable) {
David Majnemerbb848712014-07-01 22:37:08 +00001284 // Create a backing variable for the contents of VTable. The VTable may
1285 // or may not include space for a pointer to RTTI data.
David Majnemerd905da42014-07-01 20:30:31 +00001286 llvm::GlobalValue *VFTable = VTable = new llvm::GlobalVariable(
1287 CGM.getModule(), VTableType, /*isConstant=*/true, VTableLinkage,
1288 /*Initializer=*/nullptr, VTableName);
1289 VTable->setUnnamedAddr(true);
David Majnemerbb848712014-07-01 22:37:08 +00001290
1291 // Only insert a pointer into the VFTable for RTTI data if we are not
1292 // importing it. We never reference the RTTI data directly so there is no
1293 // need to make room for it.
David Majnemerf6072342014-07-01 22:24:56 +00001294 if (getContext().getLangOpts().RTTIData &&
1295 !RD->hasAttr<DLLImportAttr>()) {
David Majnemerd905da42014-07-01 20:30:31 +00001296 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
1297 llvm::ConstantInt::get(CGM.IntTy, 1)};
David Majnemerbb848712014-07-01 22:37:08 +00001298 // Create a GEP which points just after the first entry in the VFTable,
1299 // this should be the location of the first virtual method.
David Majnemerd905da42014-07-01 20:30:31 +00001300 llvm::Constant *VTableGEP =
1301 llvm::ConstantExpr::getInBoundsGetElementPtr(VTable, GEPIndices);
David Majnemerbb848712014-07-01 22:37:08 +00001302 // The symbol for the VFTable is an alias to the GEP. It is
1303 // transparent, to other modules, what the nature of this symbol is; all
1304 // that matters is that the alias be the address of the first virtual
1305 // method.
David Majnemerd905da42014-07-01 20:30:31 +00001306 VFTable = llvm::GlobalAlias::create(
1307 cast<llvm::SequentialType>(VTableGEP->getType())->getElementType(),
1308 /*AddressSpace=*/0, llvm::GlobalValue::ExternalLinkage,
1309 VFTableName.str(), VTableGEP, &CGM.getModule());
1310 } else {
David Majnemerbb848712014-07-01 22:37:08 +00001311 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1312 // be referencing any RTTI data. The GlobalVariable will end up being
1313 // an appropriate definition of the VFTable.
David Majnemerd905da42014-07-01 20:30:31 +00001314 VTable->setName(VFTableName.str());
1315 }
1316
1317 VFTable->setUnnamedAddr(true);
1318 if (RD->hasAttr<DLLImportAttr>())
1319 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1320 else if (RD->hasAttr<DLLExportAttr>())
1321 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1322
1323 llvm::GlobalValue::LinkageTypes VFTableLinkage = CGM.getVTableLinkage(RD);
1324 if (VFTable != VTable) {
1325 if (llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage)) {
1326 // AvailableExternally implies that we grabbed the data from another
1327 // executable. No need to stick the alias in a Comdat.
David Majnemerb2615aa2014-07-13 05:19:56 +00001328 } else if (llvm::GlobalValue::isInternalLinkage(VFTableLinkage) ||
1329 llvm::GlobalValue::isWeakODRLinkage(VFTableLinkage) ||
David Majnemerd905da42014-07-01 20:30:31 +00001330 llvm::GlobalValue::isLinkOnceODRLinkage(VFTableLinkage)) {
1331 // The alias is going to be dropped into a Comdat, no need to make it
1332 // weak.
David Majnemerb2615aa2014-07-13 05:19:56 +00001333 if (!llvm::GlobalValue::isInternalLinkage(VFTableLinkage))
1334 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
David Majnemerd905da42014-07-01 20:30:31 +00001335 llvm::Comdat *C =
1336 CGM.getModule().getOrInsertComdat(VFTable->getName());
David Majnemerbb848712014-07-01 22:37:08 +00001337 // We must indicate which VFTable is larger to support linking between
1338 // translation units which do and do not have RTTI data. The largest
1339 // VFTable contains the RTTI data; translation units which reference
1340 // the smaller VFTable always reference it relative to the first
1341 // virtual method.
David Majnemerd905da42014-07-01 20:30:31 +00001342 C->setSelectionKind(llvm::Comdat::Largest);
1343 VTable->setComdat(C);
1344 } else {
1345 llvm_unreachable("unexpected linkage for vftable!");
1346 }
1347 }
1348 VFTable->setLinkage(VFTableLinkage);
1349 CGM.setGlobalVisibility(VFTable, RD);
1350 VFTablesMap[ID] = VFTable;
1351 }
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001352 break;
1353 }
1354
1355 return VTable;
1356}
1357
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001358llvm::Value *MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1359 GlobalDecl GD,
1360 llvm::Value *This,
1361 llvm::Type *Ty) {
1362 GD = GD.getCanonicalDecl();
1363 CGBuilderTy &Builder = CGF.Builder;
1364
1365 Ty = Ty->getPointerTo()->getPointerTo();
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001366 llvm::Value *VPtr =
1367 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001368 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty);
1369
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001370 MicrosoftVTableContext::MethodVFTableLocation ML =
1371 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001372 llvm::Value *VFuncPtr =
1373 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1374 return Builder.CreateLoad(VFuncPtr);
1375}
1376
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001377void MicrosoftCXXABI::EmitVirtualDestructorCall(CodeGenFunction &CGF,
1378 const CXXDestructorDecl *Dtor,
1379 CXXDtorType DtorType,
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001380 llvm::Value *This,
1381 const CXXMemberCallExpr *CE) {
1382 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001383 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1384
1385 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001386 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001387 GlobalDecl GD(Dtor, Dtor_Deleting);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001388 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1389 Dtor, StructorType::Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001390 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001391 llvm::Value *Callee = getVirtualFunctionPointer(CGF, GD, This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001392
1393 ASTContext &Context = CGF.getContext();
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001394 llvm::Value *ImplicitParam =
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001395 llvm::ConstantInt::get(llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001396 DtorType == Dtor_Deleting);
1397
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001398 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001399 CGF.EmitCXXMemberOrOperatorCall(Dtor, Callee, ReturnValueSlot(), This,
1400 ImplicitParam, Context.IntTy, CE);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001401}
1402
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001403const VBTableGlobals &
1404MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001405 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001406 // easier than caching each vbtable individually.
1407 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1408 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001409 std::tie(Entry, Added) =
1410 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001411 VBTableGlobals &VBGlobals = Entry->second;
1412 if (!Added)
1413 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001414
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001415 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1416 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001417
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001418 // Cache the globals for all vbtables so we don't have to recompute the
1419 // mangled names.
1420 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001421 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1422 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001423 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001424 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001425 }
1426
1427 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001428}
1429
Reid Klecknere4a52202014-02-21 02:27:32 +00001430llvm::Function *MicrosoftCXXABI::EmitVirtualMemPtrThunk(
1431 const CXXMethodDecl *MD,
1432 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
Reid Klecknerc3473512014-08-29 21:43:29 +00001433 assert(!isa<CXXConstructorDecl>(MD) && !isa<CXXDestructorDecl>(MD) &&
1434 "can't form pointers to ctors or virtual dtors");
1435
Reid Klecknere4a52202014-02-21 02:27:32 +00001436 // Calculate the mangled name.
1437 SmallString<256> ThunkName;
1438 llvm::raw_svector_ostream Out(ThunkName);
1439 getMangleContext().mangleVirtualMemPtrThunk(MD, Out);
1440 Out.flush();
1441
Hans Wennborg88497d62013-11-15 17:24:45 +00001442 // If the thunk has been generated previously, just return it.
1443 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1444 return cast<llvm::Function>(GV);
1445
1446 // Create the llvm::Function.
Reid Klecknerc3473512014-08-29 21:43:29 +00001447 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeMSMemberPointerThunk(MD);
Hans Wennborg88497d62013-11-15 17:24:45 +00001448 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1449 llvm::Function *ThunkFn =
1450 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1451 ThunkName.str(), &CGM.getModule());
1452 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1453
Hans Wennborg88497d62013-11-15 17:24:45 +00001454 ThunkFn->setLinkage(MD->isExternallyVisible()
1455 ? llvm::GlobalValue::LinkOnceODRLinkage
1456 : llvm::GlobalValue::InternalLinkage);
1457
1458 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1459 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1460
Reid Klecknerb9538a62014-08-15 18:12:40 +00001461 // These thunks can be compared, so they are not unnamed.
1462 ThunkFn->setUnnamedAddr(false);
1463
Hans Wennborg88497d62013-11-15 17:24:45 +00001464 // Start codegen.
1465 CodeGenFunction CGF(CGM);
Reid Klecknerc3473512014-08-29 21:43:29 +00001466 CGF.CurGD = GlobalDecl(MD);
1467 CGF.CurFuncIsThunk = true;
1468
1469 // Build FunctionArgs, but only include the implicit 'this' parameter
1470 // declaration.
1471 FunctionArgList FunctionArgs;
1472 buildThisParam(CGF, FunctionArgs);
1473
1474 // Start defining the function.
1475 CGF.StartFunction(GlobalDecl(), FnInfo.getReturnType(), ThunkFn, FnInfo,
1476 FunctionArgs, MD->getLocation(), SourceLocation());
1477 EmitThisParam(CGF);
Hans Wennborg88497d62013-11-15 17:24:45 +00001478
Reid Klecknere4a52202014-02-21 02:27:32 +00001479 // Load the vfptr and then callee from the vftable. The callee should have
1480 // adjusted 'this' so that the vfptr is at offset zero.
Reid Klecknerc3473512014-08-29 21:43:29 +00001481 llvm::Value *VTable = CGF.GetVTablePtr(
1482 getThisValue(CGF), ThunkTy->getPointerTo()->getPointerTo());
Reid Klecknere4a52202014-02-21 02:27:32 +00001483 llvm::Value *VFuncPtr =
1484 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1485 llvm::Value *Callee = CGF.Builder.CreateLoad(VFuncPtr);
Hans Wennborg88497d62013-11-15 17:24:45 +00001486
Reid Klecknerc3473512014-08-29 21:43:29 +00001487 CGF.EmitMustTailThunk(MD, getThisValue(CGF), Callee);
Hans Wennborg88497d62013-11-15 17:24:45 +00001488
1489 return ThunkFn;
1490}
1491
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001492void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001493 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1494 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001495 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001496 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner5f080942014-01-03 23:42:00 +00001497 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00001498 }
1499}
1500
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001501llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001502MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001503 llvm::GlobalVariable::LinkageTypes Linkage) {
1504 SmallString<256> OutName;
1505 llvm::raw_svector_ostream Out(OutName);
David Majnemer611cdb92014-07-07 08:09:15 +00001506 getMangleContext().mangleCXXVBTable(RD, VBT.MangledPath, Out);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001507 Out.flush();
1508 StringRef Name = OutName.str();
1509
1510 llvm::ArrayType *VBTableType =
1511 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ReusingBase->getNumVBases());
1512
1513 assert(!CGM.getModule().getNamedGlobal(Name) &&
1514 "vbtable with this name already exists: mangling bug?");
1515 llvm::GlobalVariable *GV =
1516 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
1517 GV->setUnnamedAddr(true);
Hans Wennborg853ae942014-05-30 16:59:42 +00001518
1519 if (RD->hasAttr<DLLImportAttr>())
1520 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1521 else if (RD->hasAttr<DLLExportAttr>())
1522 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1523
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001524 return GV;
1525}
1526
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001527void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001528 const CXXRecordDecl *RD,
1529 llvm::GlobalVariable *GV) const {
1530 const CXXRecordDecl *ReusingBase = VBT.ReusingBase;
1531
1532 assert(RD->getNumVBases() && ReusingBase->getNumVBases() &&
1533 "should only emit vbtables for classes with vbtables");
1534
1535 const ASTRecordLayout &BaseLayout =
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001536 CGM.getContext().getASTRecordLayout(VBT.BaseWithVPtr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001537 const ASTRecordLayout &DerivedLayout =
1538 CGM.getContext().getASTRecordLayout(RD);
1539
Craig Topper8a13c412014-05-21 05:09:00 +00001540 SmallVector<llvm::Constant *, 4> Offsets(1 + ReusingBase->getNumVBases(),
1541 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001542
1543 // The offset from ReusingBase's vbptr to itself always leads.
1544 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
1545 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
1546
1547 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Aaron Ballman445a9392014-03-13 16:15:17 +00001548 for (const auto &I : ReusingBase->vbases()) {
1549 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001550 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
1551 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00001552
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001553 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00001554 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001555 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00001556 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001557 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00001558 Offset -= CompleteVBPtrOffset;
1559
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001560 unsigned VBIndex = Context.getVBTableIndex(ReusingBase, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00001561 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001562 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
1563 }
1564
1565 assert(Offsets.size() ==
1566 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
1567 ->getElementType())->getNumElements());
1568 llvm::ArrayType *VBTableType =
1569 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
1570 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
1571 GV->setInitializer(Init);
1572
1573 // Set the right visibility.
John McCall8f80a612014-02-08 00:41:16 +00001574 CGM.setGlobalVisibility(GV, RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001575}
1576
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001577llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
1578 llvm::Value *This,
1579 const ThisAdjustment &TA) {
1580 if (TA.isEmpty())
1581 return This;
1582
1583 llvm::Value *V = CGF.Builder.CreateBitCast(This, CGF.Int8PtrTy);
1584
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00001585 if (!TA.Virtual.isEmpty()) {
1586 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
1587 // Adjust the this argument based on the vtordisp value.
1588 llvm::Value *VtorDispPtr =
1589 CGF.Builder.CreateConstGEP1_32(V, TA.Virtual.Microsoft.VtordispOffset);
1590 VtorDispPtr =
1591 CGF.Builder.CreateBitCast(VtorDispPtr, CGF.Int32Ty->getPointerTo());
1592 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
1593 V = CGF.Builder.CreateGEP(V, CGF.Builder.CreateNeg(VtorDisp));
1594
1595 if (TA.Virtual.Microsoft.VBPtrOffset) {
1596 // If the final overrider is defined in a virtual base other than the one
1597 // that holds the vfptr, we have to use a vtordispex thunk which looks up
1598 // the vbtable of the derived class.
1599 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
1600 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
1601 llvm::Value *VBPtr;
1602 llvm::Value *VBaseOffset =
1603 GetVBaseOffsetFromVBPtr(CGF, V, -TA.Virtual.Microsoft.VBPtrOffset,
1604 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
1605 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
1606 }
1607 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001608
1609 if (TA.NonVirtual) {
1610 // Non-virtual adjustment might result in a pointer outside the allocated
1611 // object, e.g. if the final overrider class is laid out after the virtual
1612 // base that declares a method in the most derived class.
1613 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
1614 }
1615
1616 // Don't need to bitcast back, the call CodeGen will handle this.
1617 return V;
1618}
1619
1620llvm::Value *
1621MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
1622 const ReturnAdjustment &RA) {
1623 if (RA.isEmpty())
1624 return Ret;
1625
1626 llvm::Value *V = CGF.Builder.CreateBitCast(Ret, CGF.Int8PtrTy);
1627
1628 if (RA.Virtual.Microsoft.VBIndex) {
1629 assert(RA.Virtual.Microsoft.VBIndex > 0);
1630 int32_t IntSize =
1631 getContext().getTypeSizeInChars(getContext().IntTy).getQuantity();
1632 llvm::Value *VBPtr;
1633 llvm::Value *VBaseOffset =
1634 GetVBaseOffsetFromVBPtr(CGF, V, RA.Virtual.Microsoft.VBPtrOffset,
1635 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
1636 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
1637 }
1638
1639 if (RA.NonVirtual)
1640 V = CGF.Builder.CreateConstInBoundsGEP1_32(V, RA.NonVirtual);
1641
1642 // Cast back to the original type.
1643 return CGF.Builder.CreateBitCast(V, Ret->getType());
1644}
1645
John McCallb91cd662012-05-01 05:23:51 +00001646bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
1647 QualType elementType) {
1648 // Microsoft seems to completely ignore the possibility of a
1649 // two-argument usual deallocation function.
1650 return elementType.isDestructedType();
1651}
1652
1653bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
1654 // Microsoft seems to completely ignore the possibility of a
1655 // two-argument usual deallocation function.
1656 return expr->getAllocatedType().isDestructedType();
1657}
1658
1659CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
1660 // The array cookie is always a size_t; we then pad that out to the
1661 // alignment of the element type.
1662 ASTContext &Ctx = getContext();
1663 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
1664 Ctx.getTypeAlignInChars(type));
1665}
1666
1667llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
1668 llvm::Value *allocPtr,
1669 CharUnits cookieSize) {
Micah Villmowea2fea22012-10-25 15:39:14 +00001670 unsigned AS = allocPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001671 llvm::Value *numElementsPtr =
1672 CGF.Builder.CreateBitCast(allocPtr, CGF.SizeTy->getPointerTo(AS));
1673 return CGF.Builder.CreateLoad(numElementsPtr);
1674}
1675
1676llvm::Value* MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
1677 llvm::Value *newPtr,
1678 llvm::Value *numElements,
1679 const CXXNewExpr *expr,
1680 QualType elementType) {
1681 assert(requiresArrayCookie(expr));
1682
1683 // The size of the cookie.
1684 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
1685
1686 // Compute an offset to the cookie.
1687 llvm::Value *cookiePtr = newPtr;
1688
1689 // Write the number of elements into the appropriate slot.
Micah Villmowea2fea22012-10-25 15:39:14 +00001690 unsigned AS = newPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001691 llvm::Value *numElementsPtr
1692 = CGF.Builder.CreateBitCast(cookiePtr, CGF.SizeTy->getPointerTo(AS));
1693 CGF.Builder.CreateStore(numElements, numElementsPtr);
1694
1695 // Finally, compute a pointer to the actual data buffer by skipping
1696 // over the cookie completely.
1697 return CGF.Builder.CreateConstInBoundsGEP1_64(newPtr,
1698 cookieSize.getQuantity());
1699}
1700
John McCallc84ed6a2012-05-01 06:13:13 +00001701void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00001702 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00001703 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00001704 // MSVC only uses guards for static locals.
1705 if (!D.isStaticLocal()) {
1706 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
1707 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
1708 CGF.CurFn->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
1709 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
1710 return;
1711 }
1712
Reid Klecknerd8110b62013-09-10 20:14:30 +00001713 // MSVC always uses an i32 bitfield to guard initialization, which is *not*
1714 // threadsafe. Since the user may be linking in inline functions compiled by
1715 // cl.exe, there's no reason to provide a false sense of security by using
1716 // critical sections here.
John McCallc84ed6a2012-05-01 06:13:13 +00001717
Richard Smithdbf74ba2013-04-14 23:01:42 +00001718 if (D.getTLSKind())
1719 CGM.ErrorUnsupported(&D, "dynamic TLS initialization");
1720
Reid Klecknerd8110b62013-09-10 20:14:30 +00001721 CGBuilderTy &Builder = CGF.Builder;
1722 llvm::IntegerType *GuardTy = CGF.Int32Ty;
1723 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
1724
1725 // Get the guard variable for this function if we have one already.
Reid Kleckner563f0e82014-05-23 21:13:45 +00001726 GuardInfo *GI = &GuardVariableMap[D.getDeclContext()];
Reid Klecknerd8110b62013-09-10 20:14:30 +00001727
1728 unsigned BitIndex;
Reid Klecknere9591b32014-04-23 18:22:11 +00001729 if (D.isStaticLocal() && D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00001730 // Externally visible variables have to be numbered in Sema to properly
1731 // handle unreachable VarDecls.
David Majnemer2206bf52014-03-05 08:57:59 +00001732 BitIndex = getContext().getStaticLocalNumber(&D);
Reid Klecknerd8110b62013-09-10 20:14:30 +00001733 assert(BitIndex > 0);
1734 BitIndex--;
1735 } else {
1736 // Non-externally visible variables are numbered here in CodeGen.
Reid Klecknere9591b32014-04-23 18:22:11 +00001737 BitIndex = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00001738 }
1739
1740 if (BitIndex >= 32) {
1741 if (D.isExternallyVisible())
1742 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
1743 BitIndex %= 32;
Craig Topper8a13c412014-05-21 05:09:00 +00001744 GI->Guard = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00001745 }
1746
1747 // Lazily create the i32 bitfield for this function.
Reid Klecknere9591b32014-04-23 18:22:11 +00001748 if (!GI->Guard) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00001749 // Mangle the name for the guard.
1750 SmallString<256> GuardName;
1751 {
1752 llvm::raw_svector_ostream Out(GuardName);
1753 getMangleContext().mangleStaticGuardVariable(&D, Out);
1754 Out.flush();
1755 }
1756
Hans Wennborgef2272c2014-06-18 15:55:13 +00001757 // Create the guard variable with a zero-initializer. Just absorb linkage,
1758 // visibility and dll storage class from the guarded variable.
Reid Klecknere9591b32014-04-23 18:22:11 +00001759 GI->Guard =
1760 new llvm::GlobalVariable(CGM.getModule(), GuardTy, false,
1761 GV->getLinkage(), Zero, GuardName.str());
1762 GI->Guard->setVisibility(GV->getVisibility());
Hans Wennborgef2272c2014-06-18 15:55:13 +00001763 GI->Guard->setDLLStorageClass(GV->getDLLStorageClass());
Reid Klecknerd8110b62013-09-10 20:14:30 +00001764 } else {
Reid Klecknere9591b32014-04-23 18:22:11 +00001765 assert(GI->Guard->getLinkage() == GV->getLinkage() &&
Reid Klecknerd8110b62013-09-10 20:14:30 +00001766 "static local from the same function had different linkage");
1767 }
1768
1769 // Pseudo code for the test:
1770 // if (!(GuardVar & MyGuardBit)) {
1771 // GuardVar |= MyGuardBit;
1772 // ... initialize the object ...;
1773 // }
1774
1775 // Test our bit from the guard variable.
1776 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1U << BitIndex);
Reid Klecknere9591b32014-04-23 18:22:11 +00001777 llvm::LoadInst *LI = Builder.CreateLoad(GI->Guard);
Reid Klecknerd8110b62013-09-10 20:14:30 +00001778 llvm::Value *IsInitialized =
1779 Builder.CreateICmpNE(Builder.CreateAnd(LI, Bit), Zero);
1780 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
1781 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
1782 Builder.CreateCondBr(IsInitialized, EndBlock, InitBlock);
1783
1784 // Set our bit in the guard variable and emit the initializer and add a global
1785 // destructor if appropriate.
1786 CGF.EmitBlock(InitBlock);
Reid Klecknere9591b32014-04-23 18:22:11 +00001787 Builder.CreateStore(Builder.CreateOr(LI, Bit), GI->Guard);
Reid Klecknerd8110b62013-09-10 20:14:30 +00001788 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
1789 Builder.CreateBr(EndBlock);
1790
1791 // Continue.
1792 CGF.EmitBlock(EndBlock);
John McCallc84ed6a2012-05-01 06:13:13 +00001793}
1794
Reid Kleckner2341ae32013-04-11 18:13:19 +00001795bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
1796 // Null-ness for function memptrs only depends on the first field, which is
1797 // the function pointer. The rest don't matter, so we can zero initialize.
1798 if (MPT->isMemberFunctionPointer())
1799 return true;
1800
1801 // The virtual base adjustment field is always -1 for null, so if we have one
1802 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
1803 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00001804 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
1805 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00001806 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
1807 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00001808}
1809
1810llvm::Type *
1811MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00001812 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
1813 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00001814 llvm::SmallVector<llvm::Type *, 4> fields;
1815 if (MPT->isMemberFunctionPointer())
1816 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
1817 else
1818 fields.push_back(CGM.IntTy); // FieldOffset
1819
Reid Kleckner96f8f932014-02-05 17:27:08 +00001820 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
1821 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001822 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00001823 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001824 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00001825 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001826 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
1827
1828 if (fields.size() == 1)
1829 return fields[0];
1830 return llvm::StructType::get(CGM.getLLVMContext(), fields);
1831}
1832
1833void MicrosoftCXXABI::
1834GetNullMemberPointerFields(const MemberPointerType *MPT,
1835 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
1836 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00001837 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
1838 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00001839 if (MPT->isMemberFunctionPointer()) {
1840 // FunctionPointerOrVirtualThunk
1841 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
1842 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00001843 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00001844 fields.push_back(getZeroInt()); // FieldOffset
1845 else
1846 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00001847 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00001848
Reid Kleckner96f8f932014-02-05 17:27:08 +00001849 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
1850 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001851 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00001852 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001853 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00001854 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001855 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00001856}
1857
1858llvm::Constant *
1859MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00001860 llvm::SmallVector<llvm::Constant *, 4> fields;
1861 GetNullMemberPointerFields(MPT, fields);
1862 if (fields.size() == 1)
1863 return fields[0];
1864 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
1865 assert(Res->getType() == ConvertMemberPointerType(MPT));
1866 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00001867}
1868
1869llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001870MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
1871 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00001872 const CXXRecordDecl *RD,
1873 CharUnits NonVirtualBaseAdjustment)
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001874{
David Majnemer1cdd96d2014-01-17 09:01:00 +00001875 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001876
1877 // Single inheritance class member pointer are represented as scalars instead
1878 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00001879 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001880 return FirstField;
1881
Reid Kleckner2341ae32013-04-11 18:13:19 +00001882 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001883 fields.push_back(FirstField);
1884
Reid Kleckner96f8f932014-02-05 17:27:08 +00001885 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00001886 fields.push_back(llvm::ConstantInt::get(
1887 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001888
Reid Kleckner96f8f932014-02-05 17:27:08 +00001889 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00001890 CharUnits Offs = CharUnits::Zero();
1891 if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00001892 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00001893 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00001894 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001895
1896 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00001897 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001898 fields.push_back(getZeroInt());
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001899
Reid Kleckner2341ae32013-04-11 18:13:19 +00001900 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00001901}
1902
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001903llvm::Constant *
1904MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
1905 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00001906 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001907 llvm::Constant *FirstField =
1908 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00001909 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
1910 CharUnits::Zero());
1911}
1912
1913llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const CXXMethodDecl *MD) {
1914 return BuildMemberPointer(MD->getParent(), MD, CharUnits::Zero());
1915}
1916
1917llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
1918 QualType MPType) {
1919 const MemberPointerType *MPT = MPType->castAs<MemberPointerType>();
1920 const ValueDecl *MPD = MP.getMemberPointerDecl();
1921 if (!MPD)
1922 return EmitNullMemberPointer(MPT);
1923
1924 CharUnits ThisAdjustment = getMemberPointerPathAdjustment(MP);
1925
1926 // FIXME PR15713: Support virtual inheritance paths.
1927
1928 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD))
David Majnemer1cdd96d2014-01-17 09:01:00 +00001929 return BuildMemberPointer(MPT->getMostRecentCXXRecordDecl(), MD,
1930 ThisAdjustment);
Reid Kleckner452abac2013-05-09 21:01:17 +00001931
1932 CharUnits FieldOffset =
1933 getContext().toCharUnitsFromBits(getContext().getFieldOffset(MPD));
1934 return EmitMemberDataPointer(MPT, ThisAdjustment + FieldOffset);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001935}
1936
1937llvm::Constant *
Reid Kleckner452abac2013-05-09 21:01:17 +00001938MicrosoftCXXABI::BuildMemberPointer(const CXXRecordDecl *RD,
1939 const CXXMethodDecl *MD,
1940 CharUnits NonVirtualBaseAdjustment) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001941 assert(MD->isInstance() && "Member function must not be static!");
1942 MD = MD->getCanonicalDecl();
David Majnemer1cdd96d2014-01-17 09:01:00 +00001943 RD = RD->getMostRecentDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001944 CodeGenTypes &Types = CGM.getTypes();
1945
1946 llvm::Constant *FirstField;
Reid Klecknerc3473512014-08-29 21:43:29 +00001947 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Hans Wennborg88497d62013-11-15 17:24:45 +00001948 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001949 llvm::Type *Ty;
1950 // Check whether the function has a computable LLVM signature.
1951 if (Types.isFuncTypeConvertible(FPT)) {
1952 // The function has a computable LLVM signature; use the correct type.
1953 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
1954 } else {
1955 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
1956 // function type is incomplete.
1957 Ty = CGM.PtrDiffTy;
1958 }
1959 FirstField = CGM.GetAddrOfFunction(MD, Ty);
1960 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Hans Wennborg88497d62013-11-15 17:24:45 +00001961 } else {
1962 MicrosoftVTableContext::MethodVFTableLocation ML =
1963 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Reid Klecknerc3473512014-08-29 21:43:29 +00001964 if (!CGM.getTypes().isFuncTypeConvertible(
1965 MD->getType()->castAs<FunctionType>())) {
Hans Wennborg88497d62013-11-15 17:24:45 +00001966 CGM.ErrorUnsupported(MD, "pointer to virtual member function with "
1967 "incomplete return or parameter type");
1968 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
Reid Klecknerc3473512014-08-29 21:43:29 +00001969 } else if (FPT->getCallConv() == CC_X86FastCall) {
1970 CGM.ErrorUnsupported(MD, "pointer to fastcall virtual member function");
1971 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
Hans Wennborg88497d62013-11-15 17:24:45 +00001972 } else if (ML.VBase) {
1973 CGM.ErrorUnsupported(MD, "pointer to virtual member function overriding "
1974 "member function in virtual base class");
1975 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
1976 } else {
Reid Klecknere4a52202014-02-21 02:27:32 +00001977 llvm::Function *Thunk = EmitVirtualMemPtrThunk(MD, ML);
Hans Wennborg88497d62013-11-15 17:24:45 +00001978 FirstField = llvm::ConstantExpr::getBitCast(Thunk, CGM.VoidPtrTy);
Reid Klecknere4a52202014-02-21 02:27:32 +00001979 // Include the vfptr adjustment if the method is in a non-primary vftable.
1980 NonVirtualBaseAdjustment += ML.VFPtrOffset;
Hans Wennborg88497d62013-11-15 17:24:45 +00001981 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001982 }
1983
1984 // The rest of the fields are common with data member pointers.
Reid Kleckner452abac2013-05-09 21:01:17 +00001985 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
1986 NonVirtualBaseAdjustment);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001987}
1988
Reid Kleckner700c3ee2013-04-30 20:15:14 +00001989/// Member pointers are the same if they're either bitwise identical *or* both
1990/// null. Null-ness for function members is determined by the first field,
1991/// while for data member pointers we must compare all fields.
1992llvm::Value *
1993MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
1994 llvm::Value *L,
1995 llvm::Value *R,
1996 const MemberPointerType *MPT,
1997 bool Inequality) {
1998 CGBuilderTy &Builder = CGF.Builder;
1999
2000 // Handle != comparisons by switching the sense of all boolean operations.
2001 llvm::ICmpInst::Predicate Eq;
2002 llvm::Instruction::BinaryOps And, Or;
2003 if (Inequality) {
2004 Eq = llvm::ICmpInst::ICMP_NE;
2005 And = llvm::Instruction::Or;
2006 Or = llvm::Instruction::And;
2007 } else {
2008 Eq = llvm::ICmpInst::ICMP_EQ;
2009 And = llvm::Instruction::And;
2010 Or = llvm::Instruction::Or;
2011 }
2012
2013 // If this is a single field member pointer (single inheritance), this is a
2014 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002015 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2016 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002017 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
2018 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002019 return Builder.CreateICmp(Eq, L, R);
2020
2021 // Compare the first field.
2022 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
2023 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
2024 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
2025
2026 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00002027 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00002028 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
2029 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
2030 llvm::Value *LF = Builder.CreateExtractValue(L, I);
2031 llvm::Value *RF = Builder.CreateExtractValue(R, I);
2032 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
2033 if (Res)
2034 Res = Builder.CreateBinOp(And, Res, Cmp);
2035 else
2036 Res = Cmp;
2037 }
2038
2039 // Check if the first field is 0 if this is a function pointer.
2040 if (MPT->isMemberFunctionPointer()) {
2041 // (l1 == r1 && ...) || l0 == 0
2042 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
2043 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
2044 Res = Builder.CreateBinOp(Or, Res, IsZero);
2045 }
2046
2047 // Combine the comparison of the first field, which must always be true for
2048 // this comparison to succeeed.
2049 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
2050}
2051
Reid Kleckner407e8b62013-03-22 19:02:54 +00002052llvm::Value *
2053MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
2054 llvm::Value *MemPtr,
2055 const MemberPointerType *MPT) {
2056 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002057 llvm::SmallVector<llvm::Constant *, 4> fields;
2058 // We only need one field for member functions.
2059 if (MPT->isMemberFunctionPointer())
2060 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
2061 else
2062 GetNullMemberPointerFields(MPT, fields);
2063 assert(!fields.empty());
2064 llvm::Value *FirstField = MemPtr;
2065 if (MemPtr->getType()->isStructTy())
2066 FirstField = Builder.CreateExtractValue(MemPtr, 0);
2067 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002068
Reid Kleckner2341ae32013-04-11 18:13:19 +00002069 // For function member pointers, we only need to test the function pointer
2070 // field. The other fields if any can be garbage.
2071 if (MPT->isMemberFunctionPointer())
2072 return Res;
2073
2074 // Otherwise, emit a series of compares and combine the results.
2075 for (int I = 1, E = fields.size(); I < E; ++I) {
2076 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
2077 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00002078 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00002079 }
2080 return Res;
2081}
2082
Reid Kleckner452abac2013-05-09 21:01:17 +00002083bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
2084 llvm::Constant *Val) {
2085 // Function pointers are null if the pointer in the first field is null.
2086 if (MPT->isMemberFunctionPointer()) {
2087 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
2088 Val->getAggregateElement(0U) : Val;
2089 return FirstField->isNullValue();
2090 }
2091
2092 // If it's not a function pointer and it's zero initializable, we can easily
2093 // check zero.
2094 if (isZeroInitializable(MPT) && Val->isNullValue())
2095 return true;
2096
2097 // Otherwise, break down all the fields for comparison. Hopefully these
2098 // little Constants are reused, while a big null struct might not be.
2099 llvm::SmallVector<llvm::Constant *, 4> Fields;
2100 GetNullMemberPointerFields(MPT, Fields);
2101 if (Fields.size() == 1) {
2102 assert(Val->getType()->isIntegerTy());
2103 return Val == Fields[0];
2104 }
2105
2106 unsigned I, E;
2107 for (I = 0, E = Fields.size(); I != E; ++I) {
2108 if (Val->getAggregateElement(I) != Fields[I])
2109 break;
2110 }
2111 return I == E;
2112}
2113
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002114llvm::Value *
2115MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
2116 llvm::Value *This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002117 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002118 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002119 llvm::Value **VBPtrOut) {
2120 CGBuilderTy &Builder = CGF.Builder;
2121 // Load the vbtable pointer from the vbptr in the instance.
2122 This = Builder.CreateBitCast(This, CGM.Int8PtrTy);
2123 llvm::Value *VBPtr =
2124 Builder.CreateInBoundsGEP(This, VBPtrOffset, "vbptr");
2125 if (VBPtrOut) *VBPtrOut = VBPtr;
2126 VBPtr = Builder.CreateBitCast(VBPtr, CGM.Int8PtrTy->getPointerTo(0));
2127 llvm::Value *VBTable = Builder.CreateLoad(VBPtr, "vbtable");
2128
2129 // Load an i32 offset from the vb-table.
2130 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableOffset);
2131 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
2132 return Builder.CreateLoad(VBaseOffs, "vbase_offs");
2133}
2134
Reid Kleckner2341ae32013-04-11 18:13:19 +00002135// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2136// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002137llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2138 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
2139 llvm::Value *Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002140 CGBuilderTy &Builder = CGF.Builder;
2141 Base = Builder.CreateBitCast(Base, CGM.Int8PtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +00002142 llvm::BasicBlock *OriginalBB = nullptr;
2143 llvm::BasicBlock *SkipAdjustBB = nullptr;
2144 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002145
2146 // In the unspecified inheritance model, there might not be a vbtable at all,
2147 // in which case we need to skip the virtual base lookup. If there is a
2148 // vbtable, the first entry is a no-op entry that gives back the original
2149 // base, so look for a virtual base adjustment offset of zero.
2150 if (VBPtrOffset) {
2151 OriginalBB = Builder.GetInsertBlock();
2152 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2153 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2154 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002155 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002156 "memptr.is_vbase");
2157 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2158 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002159 }
2160
Reid Kleckner2341ae32013-04-11 18:13:19 +00002161 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
2162 // know the vbptr offset.
2163 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002164 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00002165 if (!RD->hasDefinition()) {
2166 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
2167 unsigned DiagID = Diags.getCustomDiagID(
2168 DiagnosticsEngine::Error,
2169 "member pointer representation requires a "
2170 "complete class type for %0 to perform this expression");
2171 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
2172 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002173 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002174 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
2175 }
Craig Topper8a13c412014-05-21 05:09:00 +00002176 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002177 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002178 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002179 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
2180
2181 // Merge control flow with the case where we didn't have to adjust.
2182 if (VBaseAdjustBB) {
2183 Builder.CreateBr(SkipAdjustBB);
2184 CGF.EmitBlock(SkipAdjustBB);
2185 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
2186 Phi->addIncoming(Base, OriginalBB);
2187 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
2188 return Phi;
2189 }
2190 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002191}
2192
David Majnemer2b0d66d2014-02-20 23:22:07 +00002193llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
2194 CodeGenFunction &CGF, const Expr *E, llvm::Value *Base, llvm::Value *MemPtr,
2195 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002196 assert(MPT->isMemberDataPointer());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002197 unsigned AS = Base->getType()->getPointerAddressSpace();
2198 llvm::Type *PType =
2199 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
2200 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002201 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2202 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00002203
Reid Kleckner2341ae32013-04-11 18:13:19 +00002204 // Extract the fields we need, regardless of model. We'll apply them if we
2205 // have them.
2206 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002207 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2208 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002209 if (MemPtr->getType()->isStructTy()) {
2210 // We need to extract values.
2211 unsigned I = 0;
2212 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002213 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002214 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002215 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002216 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002217 }
2218
Reid Kleckner2341ae32013-04-11 18:13:19 +00002219 if (VirtualBaseAdjustmentOffset) {
David Majnemer2b0d66d2014-02-20 23:22:07 +00002220 Base = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00002221 VBPtrOffset);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002222 }
Reid Klecknerae945122013-12-05 22:44:07 +00002223
2224 // Cast to char*.
2225 Base = Builder.CreateBitCast(Base, Builder.getInt8Ty()->getPointerTo(AS));
2226
2227 // Apply the offset, which we assume is non-null.
Reid Kleckner2341ae32013-04-11 18:13:19 +00002228 llvm::Value *Addr =
2229 Builder.CreateInBoundsGEP(Base, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002230
2231 // Cast the address to the appropriate pointer type, adopting the address
2232 // space of the base pointer.
2233 return Builder.CreateBitCast(Addr, PType);
2234}
2235
David Majnemer1cdd96d2014-01-17 09:01:00 +00002236static MSInheritanceAttr::Spelling
Reid Kleckner452abac2013-05-09 21:01:17 +00002237getInheritanceFromMemptr(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002238 return MPT->getMostRecentCXXRecordDecl()->getMSInheritanceModel();
Reid Kleckner452abac2013-05-09 21:01:17 +00002239}
2240
2241llvm::Value *
2242MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
2243 const CastExpr *E,
2244 llvm::Value *Src) {
2245 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
2246 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
2247 E->getCastKind() == CK_ReinterpretMemberPointer);
2248
2249 // Use constant emission if we can.
2250 if (isa<llvm::Constant>(Src))
2251 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
2252
2253 // We may be adding or dropping fields from the member pointer, so we need
2254 // both types and the inheritance models of both records.
2255 const MemberPointerType *SrcTy =
2256 E->getSubExpr()->getType()->castAs<MemberPointerType>();
2257 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002258 bool IsFunc = SrcTy->isMemberFunctionPointer();
2259
2260 // If the classes use the same null representation, reinterpret_cast is a nop.
2261 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002262 if (IsReinterpret && IsFunc)
2263 return Src;
2264
2265 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
2266 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
2267 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00002268 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00002269 return Src;
2270
2271 CGBuilderTy &Builder = CGF.Builder;
2272
2273 // Branch past the conversion if Src is null.
2274 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
2275 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
2276
2277 // C++ 5.2.10p9: The null member pointer value is converted to the null member
2278 // pointer value of the destination type.
2279 if (IsReinterpret) {
2280 // For reinterpret casts, sema ensures that src and dst are both functions
2281 // or data and have the same size, which means the LLVM types should match.
2282 assert(Src->getType() == DstNull->getType());
2283 return Builder.CreateSelect(IsNotNull, Src, DstNull);
2284 }
2285
2286 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
2287 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
2288 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
2289 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
2290 CGF.EmitBlock(ConvertBB);
2291
2292 // Decompose src.
2293 llvm::Value *FirstField = Src;
Craig Topper8a13c412014-05-21 05:09:00 +00002294 llvm::Value *NonVirtualBaseAdjustment = nullptr;
2295 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2296 llvm::Value *VBPtrOffset = nullptr;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002297 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002298 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002299 // We need to extract values.
2300 unsigned I = 0;
2301 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002302 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002303 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002304 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002305 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002306 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002307 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
2308 }
2309
2310 // For data pointers, we adjust the field offset directly. For functions, we
2311 // have a separate field.
2312 llvm::Constant *Adj = getMemberPointerAdjustment(E);
2313 if (Adj) {
2314 Adj = llvm::ConstantExpr::getTruncOrBitCast(Adj, CGM.IntTy);
2315 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
2316 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
2317 if (!NVAdjustField) // If this field didn't exist in src, it's zero.
2318 NVAdjustField = getZeroInt();
2319 if (isDerivedToBase)
2320 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, Adj, "adj");
2321 else
2322 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, Adj, "adj");
2323 }
2324
2325 // FIXME PR15713: Support conversions through virtually derived classes.
2326
2327 // Recompose dst from the null struct and the adjusted fields from src.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002328 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
Reid Kleckner452abac2013-05-09 21:01:17 +00002329 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00002330 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002331 Dst = FirstField;
2332 } else {
2333 Dst = llvm::UndefValue::get(DstNull->getType());
2334 unsigned Idx = 0;
2335 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002336 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002337 Dst = Builder.CreateInsertValue(
2338 Dst, getValueOrZeroInt(NonVirtualBaseAdjustment), Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002339 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002340 Dst = Builder.CreateInsertValue(
2341 Dst, getValueOrZeroInt(VBPtrOffset), Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002342 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002343 Dst = Builder.CreateInsertValue(
2344 Dst, getValueOrZeroInt(VirtualBaseAdjustmentOffset), Idx++);
2345 }
2346 Builder.CreateBr(ContinueBB);
2347
2348 // In the continuation, choose between DstNull and Dst.
2349 CGF.EmitBlock(ContinueBB);
2350 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
2351 Phi->addIncoming(DstNull, OriginalBB);
2352 Phi->addIncoming(Dst, ConvertBB);
2353 return Phi;
2354}
2355
2356llvm::Constant *
2357MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
2358 llvm::Constant *Src) {
2359 const MemberPointerType *SrcTy =
2360 E->getSubExpr()->getType()->castAs<MemberPointerType>();
2361 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
2362
2363 // If src is null, emit a new null for dst. We can't return src because dst
2364 // might have a new representation.
2365 if (MemberPointerConstantIsNull(SrcTy, Src))
2366 return EmitNullMemberPointer(DstTy);
2367
2368 // We don't need to do anything for reinterpret_casts of non-null member
2369 // pointers. We should only get here when the two type representations have
2370 // the same size.
2371 if (E->getCastKind() == CK_ReinterpretMemberPointer)
2372 return Src;
2373
David Majnemer1cdd96d2014-01-17 09:01:00 +00002374 MSInheritanceAttr::Spelling SrcInheritance = getInheritanceFromMemptr(SrcTy);
2375 MSInheritanceAttr::Spelling DstInheritance = getInheritanceFromMemptr(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002376
2377 // Decompose src.
2378 llvm::Constant *FirstField = Src;
Craig Topper8a13c412014-05-21 05:09:00 +00002379 llvm::Constant *NonVirtualBaseAdjustment = nullptr;
2380 llvm::Constant *VirtualBaseAdjustmentOffset = nullptr;
2381 llvm::Constant *VBPtrOffset = nullptr;
Reid Kleckner452abac2013-05-09 21:01:17 +00002382 bool IsFunc = SrcTy->isMemberFunctionPointer();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002383 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002384 // We need to extract values.
2385 unsigned I = 0;
2386 FirstField = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002387 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002388 NonVirtualBaseAdjustment = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002389 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002390 VBPtrOffset = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002391 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002392 VirtualBaseAdjustmentOffset = Src->getAggregateElement(I++);
2393 }
2394
2395 // For data pointers, we adjust the field offset directly. For functions, we
2396 // have a separate field.
2397 llvm::Constant *Adj = getMemberPointerAdjustment(E);
2398 if (Adj) {
2399 Adj = llvm::ConstantExpr::getTruncOrBitCast(Adj, CGM.IntTy);
2400 llvm::Constant *&NVAdjustField =
2401 IsFunc ? NonVirtualBaseAdjustment : FirstField;
2402 bool IsDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
2403 if (!NVAdjustField) // If this field didn't exist in src, it's zero.
2404 NVAdjustField = getZeroInt();
2405 if (IsDerivedToBase)
2406 NVAdjustField = llvm::ConstantExpr::getNSWSub(NVAdjustField, Adj);
2407 else
2408 NVAdjustField = llvm::ConstantExpr::getNSWAdd(NVAdjustField, Adj);
2409 }
2410
2411 // FIXME PR15713: Support conversions through virtually derived classes.
2412
2413 // Recompose dst from the null struct and the adjusted fields from src.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002414 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002415 return FirstField;
2416
2417 llvm::SmallVector<llvm::Constant *, 4> Fields;
2418 Fields.push_back(FirstField);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002419 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002420 Fields.push_back(getConstantOrZeroInt(NonVirtualBaseAdjustment));
Reid Kleckner96f8f932014-02-05 17:27:08 +00002421 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002422 Fields.push_back(getConstantOrZeroInt(VBPtrOffset));
Reid Kleckner96f8f932014-02-05 17:27:08 +00002423 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002424 Fields.push_back(getConstantOrZeroInt(VirtualBaseAdjustmentOffset));
2425 return llvm::ConstantStruct::getAnon(Fields);
2426}
2427
David Majnemer2b0d66d2014-02-20 23:22:07 +00002428llvm::Value *MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
2429 CodeGenFunction &CGF, const Expr *E, llvm::Value *&This,
2430 llvm::Value *MemPtr, const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002431 assert(MPT->isMemberFunctionPointer());
2432 const FunctionProtoType *FPT =
2433 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00002434 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002435 llvm::FunctionType *FTy =
2436 CGM.getTypes().GetFunctionType(
2437 CGM.getTypes().arrangeCXXMethodType(RD, FPT));
2438 CGBuilderTy &Builder = CGF.Builder;
2439
David Majnemer1cdd96d2014-01-17 09:01:00 +00002440 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002441
2442 // Extract the fields we need, regardless of model. We'll apply them if we
2443 // have them.
2444 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002445 llvm::Value *NonVirtualBaseAdjustment = nullptr;
2446 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2447 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002448 if (MemPtr->getType()->isStructTy()) {
2449 // We need to extract values.
2450 unsigned I = 0;
2451 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002452 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002453 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002454 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002455 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002456 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002457 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
2458 }
2459
2460 if (VirtualBaseAdjustmentOffset) {
David Majnemer2b0d66d2014-02-20 23:22:07 +00002461 This = AdjustVirtualBase(CGF, E, RD, This, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00002462 VBPtrOffset);
2463 }
2464
2465 if (NonVirtualBaseAdjustment) {
2466 // Apply the adjustment and cast back to the original struct type.
2467 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy());
2468 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
2469 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted");
2470 }
2471
2472 return Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
2473}
2474
Charles Davis53c59df2010-08-16 03:33:14 +00002475CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00002476 return new MicrosoftCXXABI(CGM);
2477}
David Majnemere2cb8d12014-07-07 06:20:47 +00002478
2479// MS RTTI Overview:
2480// The run time type information emitted by cl.exe contains 5 distinct types of
2481// structures. Many of them reference each other.
2482//
2483// TypeInfo: Static classes that are returned by typeid.
2484//
2485// CompleteObjectLocator: Referenced by vftables. They contain information
2486// required for dynamic casting, including OffsetFromTop. They also contain
2487// a reference to the TypeInfo for the type and a reference to the
2488// CompleteHierarchyDescriptor for the type.
2489//
2490// ClassHieararchyDescriptor: Contains information about a class hierarchy.
2491// Used during dynamic_cast to walk a class hierarchy. References a base
2492// class array and the size of said array.
2493//
2494// BaseClassArray: Contains a list of classes in a hierarchy. BaseClassArray is
2495// somewhat of a misnomer because the most derived class is also in the list
2496// as well as multiple copies of virtual bases (if they occur multiple times
2497// in the hiearchy.) The BaseClassArray contains one BaseClassDescriptor for
2498// every path in the hierarchy, in pre-order depth first order. Note, we do
2499// not declare a specific llvm type for BaseClassArray, it's merely an array
2500// of BaseClassDescriptor pointers.
2501//
2502// BaseClassDescriptor: Contains information about a class in a class hierarchy.
2503// BaseClassDescriptor is also somewhat of a misnomer for the same reason that
2504// BaseClassArray is. It contains information about a class within a
2505// hierarchy such as: is this base is ambiguous and what is its offset in the
2506// vbtable. The names of the BaseClassDescriptors have all of their fields
2507// mangled into them so they can be aggressively deduplicated by the linker.
2508
David Majnemere2cb8d12014-07-07 06:20:47 +00002509static llvm::GlobalVariable *getTypeInfoVTable(CodeGenModule &CGM) {
2510 StringRef MangledName("\01??_7type_info@@6B@");
2511 if (auto VTable = CGM.getModule().getNamedGlobal(MangledName))
2512 return VTable;
2513 return new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
2514 /*Constant=*/true,
2515 llvm::GlobalVariable::ExternalLinkage,
2516 /*Initializer=*/nullptr, MangledName);
2517}
2518
2519namespace {
2520
2521/// \brief A Helper struct that stores information about a class in a class
2522/// hierarchy. The information stored in these structs struct is used during
2523/// the generation of ClassHierarchyDescriptors and BaseClassDescriptors.
2524// During RTTI creation, MSRTTIClasses are stored in a contiguous array with
2525// implicit depth first pre-order tree connectivity. getFirstChild and
2526// getNextSibling allow us to walk the tree efficiently.
2527struct MSRTTIClass {
2528 enum {
2529 IsPrivateOnPath = 1 | 8,
2530 IsAmbiguous = 2,
2531 IsPrivate = 4,
2532 IsVirtual = 16,
2533 HasHierarchyDescriptor = 64
2534 };
2535 MSRTTIClass(const CXXRecordDecl *RD) : RD(RD) {}
2536 uint32_t initialize(const MSRTTIClass *Parent,
2537 const CXXBaseSpecifier *Specifier);
2538
2539 MSRTTIClass *getFirstChild() { return this + 1; }
2540 static MSRTTIClass *getNextChild(MSRTTIClass *Child) {
2541 return Child + 1 + Child->NumBases;
2542 }
2543
2544 const CXXRecordDecl *RD, *VirtualRoot;
2545 uint32_t Flags, NumBases, OffsetInVBase;
2546};
2547
2548/// \brief Recursively initialize the base class array.
2549uint32_t MSRTTIClass::initialize(const MSRTTIClass *Parent,
2550 const CXXBaseSpecifier *Specifier) {
2551 Flags = HasHierarchyDescriptor;
2552 if (!Parent) {
2553 VirtualRoot = nullptr;
2554 OffsetInVBase = 0;
2555 } else {
2556 if (Specifier->getAccessSpecifier() != AS_public)
2557 Flags |= IsPrivate | IsPrivateOnPath;
2558 if (Specifier->isVirtual()) {
2559 Flags |= IsVirtual;
2560 VirtualRoot = RD;
2561 OffsetInVBase = 0;
2562 } else {
2563 if (Parent->Flags & IsPrivateOnPath)
2564 Flags |= IsPrivateOnPath;
2565 VirtualRoot = Parent->VirtualRoot;
2566 OffsetInVBase = Parent->OffsetInVBase + RD->getASTContext()
2567 .getASTRecordLayout(Parent->RD).getBaseClassOffset(RD).getQuantity();
2568 }
2569 }
2570 NumBases = 0;
2571 MSRTTIClass *Child = getFirstChild();
2572 for (const CXXBaseSpecifier &Base : RD->bases()) {
2573 NumBases += Child->initialize(this, &Base) + 1;
2574 Child = getNextChild(Child);
2575 }
2576 return NumBases;
2577}
2578
2579static llvm::GlobalValue::LinkageTypes getLinkageForRTTI(QualType Ty) {
2580 switch (Ty->getLinkage()) {
2581 case NoLinkage:
2582 case InternalLinkage:
2583 case UniqueExternalLinkage:
2584 return llvm::GlobalValue::InternalLinkage;
2585
2586 case VisibleNoLinkage:
2587 case ExternalLinkage:
2588 return llvm::GlobalValue::LinkOnceODRLinkage;
2589 }
2590 llvm_unreachable("Invalid linkage!");
2591}
2592
2593/// \brief An ephemeral helper class for building MS RTTI types. It caches some
2594/// calls to the module and information about the most derived class in a
2595/// hierarchy.
2596struct MSRTTIBuilder {
2597 enum {
2598 HasBranchingHierarchy = 1,
2599 HasVirtualBranchingHierarchy = 2,
2600 HasAmbiguousBases = 4
2601 };
2602
David Majnemer611cdb92014-07-07 08:09:15 +00002603 MSRTTIBuilder(MicrosoftCXXABI &ABI, const CXXRecordDecl *RD)
2604 : CGM(ABI.CGM), Context(CGM.getContext()),
2605 VMContext(CGM.getLLVMContext()), Module(CGM.getModule()), RD(RD),
David Majnemere2cb8d12014-07-07 06:20:47 +00002606 Linkage(getLinkageForRTTI(CGM.getContext().getTagDeclType(RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00002607 ABI(ABI) {}
David Majnemere2cb8d12014-07-07 06:20:47 +00002608
2609 llvm::GlobalVariable *getBaseClassDescriptor(const MSRTTIClass &Classes);
2610 llvm::GlobalVariable *
2611 getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes);
2612 llvm::GlobalVariable *getClassHierarchyDescriptor();
2613 llvm::GlobalVariable *getCompleteObjectLocator(const VPtrInfo *Info);
2614
2615 CodeGenModule &CGM;
2616 ASTContext &Context;
2617 llvm::LLVMContext &VMContext;
2618 llvm::Module &Module;
2619 const CXXRecordDecl *RD;
2620 llvm::GlobalVariable::LinkageTypes Linkage;
David Majnemer611cdb92014-07-07 08:09:15 +00002621 MicrosoftCXXABI &ABI;
David Majnemere2cb8d12014-07-07 06:20:47 +00002622};
2623
2624} // namespace
2625
2626/// \brief Recursively serializes a class hierarchy in pre-order depth first
2627/// order.
2628static void serializeClassHierarchy(SmallVectorImpl<MSRTTIClass> &Classes,
2629 const CXXRecordDecl *RD) {
2630 Classes.push_back(MSRTTIClass(RD));
2631 for (const CXXBaseSpecifier &Base : RD->bases())
2632 serializeClassHierarchy(Classes, Base.getType()->getAsCXXRecordDecl());
2633}
2634
2635/// \brief Find ambiguity among base classes.
2636static void
2637detectAmbiguousBases(SmallVectorImpl<MSRTTIClass> &Classes) {
2638 llvm::SmallPtrSet<const CXXRecordDecl *, 8> VirtualBases;
2639 llvm::SmallPtrSet<const CXXRecordDecl *, 8> UniqueBases;
2640 llvm::SmallPtrSet<const CXXRecordDecl *, 8> AmbiguousBases;
2641 for (MSRTTIClass *Class = &Classes.front(); Class <= &Classes.back();) {
2642 if ((Class->Flags & MSRTTIClass::IsVirtual) &&
2643 !VirtualBases.insert(Class->RD)) {
2644 Class = MSRTTIClass::getNextChild(Class);
2645 continue;
2646 }
2647 if (!UniqueBases.insert(Class->RD))
2648 AmbiguousBases.insert(Class->RD);
2649 Class++;
2650 }
2651 if (AmbiguousBases.empty())
2652 return;
2653 for (MSRTTIClass &Class : Classes)
2654 if (AmbiguousBases.count(Class.RD))
2655 Class.Flags |= MSRTTIClass::IsAmbiguous;
2656}
2657
2658llvm::GlobalVariable *MSRTTIBuilder::getClassHierarchyDescriptor() {
2659 SmallString<256> MangledName;
2660 {
2661 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00002662 ABI.getMangleContext().mangleCXXRTTIClassHierarchyDescriptor(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00002663 }
2664
2665 // Check to see if we've already declared this ClassHierarchyDescriptor.
2666 if (auto CHD = Module.getNamedGlobal(MangledName))
2667 return CHD;
2668
2669 // Serialize the class hierarchy and initialize the CHD Fields.
2670 SmallVector<MSRTTIClass, 8> Classes;
2671 serializeClassHierarchy(Classes, RD);
2672 Classes.front().initialize(/*Parent=*/nullptr, /*Specifier=*/nullptr);
2673 detectAmbiguousBases(Classes);
2674 int Flags = 0;
2675 for (auto Class : Classes) {
2676 if (Class.RD->getNumBases() > 1)
2677 Flags |= HasBranchingHierarchy;
2678 // Note: cl.exe does not calculate "HasAmbiguousBases" correctly. We
2679 // believe the field isn't actually used.
2680 if (Class.Flags & MSRTTIClass::IsAmbiguous)
2681 Flags |= HasAmbiguousBases;
2682 }
2683 if ((Flags & HasBranchingHierarchy) && RD->getNumVBases() != 0)
2684 Flags |= HasVirtualBranchingHierarchy;
2685 // These gep indices are used to get the address of the first element of the
2686 // base class array.
2687 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
2688 llvm::ConstantInt::get(CGM.IntTy, 0)};
2689
2690 // Forward-declare the class hierarchy descriptor
David Majnemer611cdb92014-07-07 08:09:15 +00002691 auto Type = ABI.getClassHierarchyDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00002692 auto CHD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
2693 /*Initializer=*/nullptr,
2694 MangledName.c_str());
2695
2696 // Initialize the base class ClassHierarchyDescriptor.
2697 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00002698 llvm::ConstantInt::get(CGM.IntTy, 0), // Unknown
2699 llvm::ConstantInt::get(CGM.IntTy, Flags),
2700 llvm::ConstantInt::get(CGM.IntTy, Classes.size()),
2701 ABI.getImageRelativeConstant(llvm::ConstantExpr::getInBoundsGetElementPtr(
2702 getBaseClassArray(Classes),
2703 llvm::ArrayRef<llvm::Value *>(GEPIndices))),
David Majnemere2cb8d12014-07-07 06:20:47 +00002704 };
2705 CHD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
2706 return CHD;
2707}
2708
2709llvm::GlobalVariable *
2710MSRTTIBuilder::getBaseClassArray(SmallVectorImpl<MSRTTIClass> &Classes) {
2711 SmallString<256> MangledName;
2712 {
2713 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00002714 ABI.getMangleContext().mangleCXXRTTIBaseClassArray(RD, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00002715 }
2716
2717 // Forward-declare the base class array.
2718 // cl.exe pads the base class array with 1 (in 32 bit mode) or 4 (in 64 bit
2719 // mode) bytes of padding. We provide a pointer sized amount of padding by
2720 // adding +1 to Classes.size(). The sections have pointer alignment and are
2721 // marked pick-any so it shouldn't matter.
David Majnemer26a90f82014-07-07 15:29:10 +00002722 llvm::Type *PtrType = ABI.getImageRelativeType(
David Majnemer611cdb92014-07-07 08:09:15 +00002723 ABI.getBaseClassDescriptorType()->getPointerTo());
David Majnemer26a90f82014-07-07 15:29:10 +00002724 auto *ArrType = llvm::ArrayType::get(PtrType, Classes.size() + 1);
2725 auto *BCA = new llvm::GlobalVariable(
2726 Module, ArrType,
David Majnemere2cb8d12014-07-07 06:20:47 +00002727 /*Constant=*/true, Linkage, /*Initializer=*/nullptr, MangledName.c_str());
2728
2729 // Initialize the BaseClassArray.
2730 SmallVector<llvm::Constant *, 8> BaseClassArrayData;
2731 for (MSRTTIClass &Class : Classes)
2732 BaseClassArrayData.push_back(
David Majnemer611cdb92014-07-07 08:09:15 +00002733 ABI.getImageRelativeConstant(getBaseClassDescriptor(Class)));
David Majnemere2cb8d12014-07-07 06:20:47 +00002734 BaseClassArrayData.push_back(llvm::Constant::getNullValue(PtrType));
David Majnemer26a90f82014-07-07 15:29:10 +00002735 BCA->setInitializer(llvm::ConstantArray::get(ArrType, BaseClassArrayData));
David Majnemere2cb8d12014-07-07 06:20:47 +00002736 return BCA;
2737}
2738
2739llvm::GlobalVariable *
2740MSRTTIBuilder::getBaseClassDescriptor(const MSRTTIClass &Class) {
2741 // Compute the fields for the BaseClassDescriptor. They are computed up front
2742 // because they are mangled into the name of the object.
2743 uint32_t OffsetInVBTable = 0;
2744 int32_t VBPtrOffset = -1;
2745 if (Class.VirtualRoot) {
2746 auto &VTableContext = CGM.getMicrosoftVTableContext();
2747 OffsetInVBTable = VTableContext.getVBTableIndex(RD, Class.VirtualRoot) * 4;
2748 VBPtrOffset = Context.getASTRecordLayout(RD).getVBPtrOffset().getQuantity();
2749 }
2750
2751 SmallString<256> MangledName;
2752 {
2753 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00002754 ABI.getMangleContext().mangleCXXRTTIBaseClassDescriptor(
2755 Class.RD, Class.OffsetInVBase, VBPtrOffset, OffsetInVBTable,
2756 Class.Flags, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00002757 }
2758
David Majnemer26a90f82014-07-07 15:29:10 +00002759 // Check to see if we've already declared this object.
David Majnemere2cb8d12014-07-07 06:20:47 +00002760 if (auto BCD = Module.getNamedGlobal(MangledName))
2761 return BCD;
2762
2763 // Forward-declare the base class descriptor.
David Majnemer611cdb92014-07-07 08:09:15 +00002764 auto Type = ABI.getBaseClassDescriptorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00002765 auto BCD = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
2766 /*Initializer=*/nullptr,
2767 MangledName.c_str());
2768
2769 // Initialize the BaseClassDescriptor.
2770 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00002771 ABI.getImageRelativeConstant(
David Majnemerccef89d2014-07-07 15:29:16 +00002772 ABI.getAddrOfRTTIDescriptor(Context.getTypeDeclType(Class.RD))),
David Majnemer611cdb92014-07-07 08:09:15 +00002773 llvm::ConstantInt::get(CGM.IntTy, Class.NumBases),
2774 llvm::ConstantInt::get(CGM.IntTy, Class.OffsetInVBase),
2775 llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
2776 llvm::ConstantInt::get(CGM.IntTy, OffsetInVBTable),
2777 llvm::ConstantInt::get(CGM.IntTy, Class.Flags),
2778 ABI.getImageRelativeConstant(
2779 MSRTTIBuilder(ABI, Class.RD).getClassHierarchyDescriptor()),
David Majnemere2cb8d12014-07-07 06:20:47 +00002780 };
2781 BCD->setInitializer(llvm::ConstantStruct::get(Type, Fields));
2782 return BCD;
2783}
2784
2785llvm::GlobalVariable *
2786MSRTTIBuilder::getCompleteObjectLocator(const VPtrInfo *Info) {
2787 SmallString<256> MangledName;
2788 {
2789 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00002790 ABI.getMangleContext().mangleCXXRTTICompleteObjectLocator(RD, Info->MangledPath, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00002791 }
2792
2793 // Check to see if we've already computed this complete object locator.
2794 if (auto COL = Module.getNamedGlobal(MangledName))
2795 return COL;
2796
2797 // Compute the fields of the complete object locator.
2798 int OffsetToTop = Info->FullOffsetInMDC.getQuantity();
2799 int VFPtrOffset = 0;
2800 // The offset includes the vtordisp if one exists.
2801 if (const CXXRecordDecl *VBase = Info->getVBaseWithVPtr())
2802 if (Context.getASTRecordLayout(RD)
2803 .getVBaseOffsetsMap()
2804 .find(VBase)
2805 ->second.hasVtorDisp())
2806 VFPtrOffset = Info->NonVirtualOffset.getQuantity() + 4;
2807
2808 // Forward-declare the complete object locator.
David Majnemer611cdb92014-07-07 08:09:15 +00002809 llvm::StructType *Type = ABI.getCompleteObjectLocatorType();
David Majnemere2cb8d12014-07-07 06:20:47 +00002810 auto COL = new llvm::GlobalVariable(Module, Type, /*Constant=*/true, Linkage,
2811 /*Initializer=*/nullptr, MangledName.c_str());
2812
2813 // Initialize the CompleteObjectLocator.
2814 llvm::Constant *Fields[] = {
David Majnemer611cdb92014-07-07 08:09:15 +00002815 llvm::ConstantInt::get(CGM.IntTy, ABI.isImageRelative()),
2816 llvm::ConstantInt::get(CGM.IntTy, OffsetToTop),
2817 llvm::ConstantInt::get(CGM.IntTy, VFPtrOffset),
2818 ABI.getImageRelativeConstant(
2819 CGM.GetAddrOfRTTIDescriptor(Context.getTypeDeclType(RD))),
2820 ABI.getImageRelativeConstant(getClassHierarchyDescriptor()),
2821 ABI.getImageRelativeConstant(COL),
David Majnemere2cb8d12014-07-07 06:20:47 +00002822 };
2823 llvm::ArrayRef<llvm::Constant *> FieldsRef(Fields);
David Majnemer611cdb92014-07-07 08:09:15 +00002824 if (!ABI.isImageRelative())
2825 FieldsRef = FieldsRef.drop_back();
David Majnemere2cb8d12014-07-07 06:20:47 +00002826 COL->setInitializer(llvm::ConstantStruct::get(Type, FieldsRef));
2827 return COL;
2828}
2829
2830/// \brief Gets a TypeDescriptor. Returns a llvm::Constant * rather than a
2831/// llvm::GlobalVariable * because different type descriptors have different
2832/// types, and need to be abstracted. They are abstracting by casting the
2833/// address to an Int8PtrTy.
2834llvm::Constant *MicrosoftCXXABI::getAddrOfRTTIDescriptor(QualType Type) {
David Majnemere2cb8d12014-07-07 06:20:47 +00002835 SmallString<256> MangledName, TypeInfoString;
2836 {
2837 llvm::raw_svector_ostream Out(MangledName);
David Majnemer611cdb92014-07-07 08:09:15 +00002838 getMangleContext().mangleCXXRTTI(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00002839 }
2840
2841 // Check to see if we've already declared this TypeDescriptor.
2842 if (llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(MangledName))
2843 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
2844
2845 // Compute the fields for the TypeDescriptor.
2846 {
2847 llvm::raw_svector_ostream Out(TypeInfoString);
David Majnemer611cdb92014-07-07 08:09:15 +00002848 getMangleContext().mangleCXXRTTIName(Type, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00002849 }
2850
2851 // Declare and initialize the TypeDescriptor.
2852 llvm::Constant *Fields[] = {
2853 getTypeInfoVTable(CGM), // VFPtr
2854 llvm::ConstantPointerNull::get(CGM.Int8PtrTy), // Runtime data
2855 llvm::ConstantDataArray::getString(CGM.getLLVMContext(), TypeInfoString)};
2856 llvm::StructType *TypeDescriptorType =
David Majnemer611cdb92014-07-07 08:09:15 +00002857 getTypeDescriptorType(TypeInfoString);
David Majnemere2cb8d12014-07-07 06:20:47 +00002858 return llvm::ConstantExpr::getBitCast(
2859 new llvm::GlobalVariable(
2860 CGM.getModule(), TypeDescriptorType, /*Constant=*/false,
2861 getLinkageForRTTI(Type),
2862 llvm::ConstantStruct::get(TypeDescriptorType, Fields),
2863 MangledName.c_str()),
2864 CGM.Int8PtrTy);
2865}
2866
2867/// \brief Gets or a creates a Microsoft CompleteObjectLocator.
2868llvm::GlobalVariable *
2869MicrosoftCXXABI::getMSCompleteObjectLocator(const CXXRecordDecl *RD,
2870 const VPtrInfo *Info) {
David Majnemer611cdb92014-07-07 08:09:15 +00002871 return MSRTTIBuilder(*this, RD).getCompleteObjectLocator(Info);
David Majnemere2cb8d12014-07-07 06:20:47 +00002872}