blob: c586e034d17dd3fd8a051f108bf3b0549912105c [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"
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +000023#include "llvm/ADT/StringSet.h"
David Majnemer1162d252014-06-22 19:05:33 +000024#include "llvm/IR/CallSite.h"
Charles Davis74ce8592010-06-09 23:25:41 +000025
26using namespace clang;
27using namespace CodeGen;
28
29namespace {
30
Reid Klecknerb40a27d2014-01-03 00:14:35 +000031/// Holds all the vbtable globals for a given class.
32struct VBTableGlobals {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +000033 const VPtrInfoVector *VBTables;
Reid Klecknerb40a27d2014-01-03 00:14:35 +000034 SmallVector<llvm::GlobalVariable *, 2> Globals;
35};
36
Charles Davis53c59df2010-08-16 03:33:14 +000037class MicrosoftCXXABI : public CGCXXABI {
Charles Davis74ce8592010-06-09 23:25:41 +000038public:
Peter Collingbourne0ff0b372011-01-13 18:57:25 +000039 MicrosoftCXXABI(CodeGenModule &CGM) : CGCXXABI(CGM) {}
John McCall5d865c322010-08-31 07:33:07 +000040
Craig Topper4f12f102014-03-12 06:41:41 +000041 bool HasThisReturn(GlobalDecl GD) const override;
Stephen Lin9dc6eef2013-06-30 20:40:16 +000042
Reid Kleckner40ca9132014-05-13 22:05:45 +000043 bool classifyReturnType(CGFunctionInfo &FI) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000044
Reid Klecknere39ee212014-05-03 00:33:28 +000045 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000046
Reid Kleckner37abaca2014-05-09 22:46:15 +000047 bool isSRetParameterAfterThis() const override { return true; }
48
Craig Topper4f12f102014-03-12 06:41:41 +000049 StringRef GetPureVirtualCallName() override { return "_purecall"; }
David Blaikieeb7d5982012-10-16 22:56:05 +000050 // No known support for deleted functions in MSVC yet, so this choice is
51 // arbitrary.
Craig Topper4f12f102014-03-12 06:41:41 +000052 StringRef GetDeletedVirtualCallName() override { return "_purecall"; }
Joao Matos2ce88ef2012-07-17 17:10:11 +000053
Hans Wennborg905f8062014-05-24 20:18:32 +000054 bool isInlineInitializedStaticDataMemberLinkOnce() override { return true; }
Hans Wennborgfeedf852013-11-21 00:15:56 +000055
John McCall82fb8922012-09-25 10:10:39 +000056 llvm::Value *adjustToCompleteObject(CodeGenFunction &CGF,
57 llvm::Value *ptr,
Craig Topper4f12f102014-03-12 06:41:41 +000058 QualType type) override;
John McCall82fb8922012-09-25 10:10:39 +000059
David Majnemer1162d252014-06-22 19:05:33 +000060 bool shouldTypeidBeNullChecked(bool IsDeref, QualType SrcRecordTy) override;
61 void EmitBadTypeidCall(CodeGenFunction &CGF) override;
62 llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy,
63 llvm::Value *ThisPtr,
64 llvm::Type *StdTypeInfoPtrTy) override;
65
66 bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
67 QualType SrcRecordTy) override;
68
69 llvm::Value *EmitDynamicCastCall(CodeGenFunction &CGF, llvm::Value *Value,
70 QualType SrcRecordTy, QualType DestTy,
71 QualType DestRecordTy,
72 llvm::BasicBlock *CastEnd) override;
73
74 llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF, llvm::Value *Value,
75 QualType SrcRecordTy,
76 QualType DestTy) override;
77
78 bool EmitBadCastCall(CodeGenFunction &CGF) override;
79
Craig Topper4f12f102014-03-12 06:41:41 +000080 llvm::Value *
81 GetVirtualBaseClassOffset(CodeGenFunction &CGF, llvm::Value *This,
82 const CXXRecordDecl *ClassDecl,
83 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +000084
John McCall5d865c322010-08-31 07:33:07 +000085 void BuildConstructorSignature(const CXXConstructorDecl *Ctor,
Craig Topper4f12f102014-03-12 06:41:41 +000086 CXXCtorType Type, CanQualType &ResTy,
87 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +000088
Craig Topper4f12f102014-03-12 06:41:41 +000089 llvm::BasicBlock *
90 EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
91 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +000092
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +000093 void initializeHiddenVirtualInheritanceMembers(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +000094 const CXXRecordDecl *RD) override;
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +000095
Craig Topper4f12f102014-03-12 06:41:41 +000096 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +000097
Reid Klecknere7de47e2013-07-22 13:51:44 +000098 // Background on MSVC destructors
99 // ==============================
100 //
101 // Both Itanium and MSVC ABIs have destructor variants. The variant names
102 // roughly correspond in the following way:
103 // Itanium Microsoft
104 // Base -> no name, just ~Class
105 // Complete -> vbase destructor
106 // Deleting -> scalar deleting destructor
107 // vector deleting destructor
108 //
109 // The base and complete destructors are the same as in Itanium, although the
110 // complete destructor does not accept a VTT parameter when there are virtual
111 // bases. A separate mechanism involving vtordisps is used to ensure that
112 // virtual methods of destroyed subobjects are not called.
113 //
114 // The deleting destructors accept an i32 bitfield as a second parameter. Bit
115 // 1 indicates if the memory should be deleted. Bit 2 indicates if the this
116 // pointer points to an array. The scalar deleting destructor assumes that
117 // bit 2 is zero, and therefore does not contain a loop.
118 //
119 // For virtual destructors, only one entry is reserved in the vftable, and it
120 // always points to the vector deleting destructor. The vector deleting
121 // destructor is the most general, so it can be used to destroy objects in
122 // place, delete single heap objects, or delete arrays.
123 //
124 // A TU defining a non-inline destructor is only guaranteed to emit a base
125 // destructor, and all of the other variants are emitted on an as-needed basis
126 // in COMDATs. Because a non-base destructor can be emitted in a TU that
127 // lacks a definition for the destructor, non-base destructors must always
128 // delegate to or alias the base destructor.
129
130 void BuildDestructorSignature(const CXXDestructorDecl *Dtor,
John McCall5d865c322010-08-31 07:33:07 +0000131 CXXDtorType Type,
132 CanQualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000133 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000134
Reid Klecknere7de47e2013-07-22 13:51:44 +0000135 /// Non-base dtors should be emitted as delegating thunks in this ABI.
136 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000137 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000138 return DT != Dtor_Base;
139 }
140
Craig Topper4f12f102014-03-12 06:41:41 +0000141 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000142
Craig Topper4f12f102014-03-12 06:41:41 +0000143 const CXXRecordDecl *
144 getThisArgumentTypeForMethod(const CXXMethodDecl *MD) override {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000145 MD = MD->getCanonicalDecl();
146 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD)) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000147 MicrosoftVTableContext::MethodVFTableLocation ML =
148 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000149 // The vbases might be ordered differently in the final overrider object
150 // and the complete object, so the "this" argument may sometimes point to
151 // memory that has no particular type (e.g. past the complete object).
152 // In this case, we just use a generic pointer type.
153 // FIXME: might want to have a more precise type in the non-virtual
154 // multiple inheritance case.
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +0000155 if (ML.VBase || !ML.VFPtrOffset.isZero())
Craig Topper8a13c412014-05-21 05:09:00 +0000156 return nullptr;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000157 }
158 return MD->getParent();
159 }
160
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000161 llvm::Value *
162 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD,
163 llvm::Value *This,
164 bool VirtualCall) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000165
Reid Kleckner89077a12013-12-17 19:46:40 +0000166 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000167 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000168
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000169 llvm::Value *adjustThisParameterInVirtualFunctionPrologue(
Craig Topper4f12f102014-03-12 06:41:41 +0000170 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000171
Craig Topper4f12f102014-03-12 06:41:41 +0000172 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall29036752011-01-27 02:46:02 +0000173
Reid Kleckner89077a12013-12-17 19:46:40 +0000174 unsigned addImplicitConstructorArgs(CodeGenFunction &CGF,
175 const CXXConstructorDecl *D,
176 CXXCtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000177 bool Delegating,
178 CallArgList &Args) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000179
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000180 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
181 CXXDtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000182 bool Delegating, llvm::Value *This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000183
Craig Topper4f12f102014-03-12 06:41:41 +0000184 void emitVTableDefinitions(CodeGenVTables &CGVT,
185 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000186
187 llvm::Value *getVTableAddressPointInStructor(
188 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
189 BaseSubobject Base, const CXXRecordDecl *NearestVBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000190 bool &NeedsVirtualOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000191
192 llvm::Constant *
193 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000194 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000195
196 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000197 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000198
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000199 llvm::Value *getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000200 llvm::Value *This,
201 llvm::Type *Ty) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000202
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000203 void EmitVirtualDestructorCall(CodeGenFunction &CGF,
204 const CXXDestructorDecl *Dtor,
205 CXXDtorType DtorType, SourceLocation CallLoc,
Craig Topper4f12f102014-03-12 06:41:41 +0000206 llvm::Value *This) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000207
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000208 void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000209 CallArgList &CallArgs) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000210 assert(GD.getDtorType() == Dtor_Deleting &&
211 "Only deleting destructor thunks are available in this ABI");
212 CallArgs.add(RValue::get(getStructorImplicitParamValue(CGF)),
213 CGM.getContext().IntTy);
214 }
215
Craig Topper4f12f102014-03-12 06:41:41 +0000216 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000217
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000218 llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000219 getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000220 llvm::GlobalVariable::LinkageTypes Linkage);
221
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000222 void emitVBTableDefinition(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000223 llvm::GlobalVariable *GV) const;
224
Hans Wennborgc94391d2014-06-06 20:04:01 +0000225 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
226 GlobalDecl GD, bool ReturnAdjustment) override {
Hans Wennborg853ae942014-05-30 16:59:42 +0000227 // Never dllimport/dllexport thunks.
228 Thunk->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
Hans Wennborgc94391d2014-06-06 20:04:01 +0000229
230 GVALinkage Linkage =
231 getContext().GetGVALinkageForFunction(cast<FunctionDecl>(GD.getDecl()));
232
233 if (Linkage == GVA_Internal)
234 Thunk->setLinkage(llvm::GlobalValue::InternalLinkage);
235 else if (ReturnAdjustment)
236 Thunk->setLinkage(llvm::GlobalValue::WeakODRLinkage);
237 else
238 Thunk->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000239 }
240
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000241 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, llvm::Value *This,
Craig Topper4f12f102014-03-12 06:41:41 +0000242 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000243
244 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000245 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000246
John McCallc84ed6a2012-05-01 06:13:13 +0000247 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
248 llvm::GlobalVariable *DeclPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000249 bool PerformInit) override;
John McCallc84ed6a2012-05-01 06:13:13 +0000250
John McCall29036752011-01-27 02:46:02 +0000251 // ==== Notes on array cookies =========
252 //
253 // MSVC seems to only use cookies when the class has a destructor; a
254 // two-argument usual array deallocation function isn't sufficient.
255 //
256 // For example, this code prints "100" and "1":
257 // struct A {
258 // char x;
259 // void *operator new[](size_t sz) {
260 // printf("%u\n", sz);
261 // return malloc(sz);
262 // }
263 // void operator delete[](void *p, size_t sz) {
264 // printf("%u\n", sz);
265 // free(p);
266 // }
267 // };
268 // int main() {
269 // A *p = new A[100];
270 // delete[] p;
271 // }
272 // Whereas it prints "104" and "104" if you give A a destructor.
John McCallb91cd662012-05-01 05:23:51 +0000273
Craig Topper4f12f102014-03-12 06:41:41 +0000274 bool requiresArrayCookie(const CXXDeleteExpr *expr,
275 QualType elementType) override;
276 bool requiresArrayCookie(const CXXNewExpr *expr) override;
277 CharUnits getArrayCookieSizeImpl(QualType type) override;
John McCallb91cd662012-05-01 05:23:51 +0000278 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
279 llvm::Value *NewPtr,
280 llvm::Value *NumElements,
281 const CXXNewExpr *expr,
Craig Topper4f12f102014-03-12 06:41:41 +0000282 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000283 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
284 llvm::Value *allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000285 CharUnits cookieSize) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000286
287private:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000288 MicrosoftMangleContext &getMangleContext() {
289 return cast<MicrosoftMangleContext>(CodeGen::CGCXXABI::getMangleContext());
290 }
291
Reid Kleckner2341ae32013-04-11 18:13:19 +0000292 llvm::Constant *getZeroInt() {
293 return llvm::ConstantInt::get(CGM.IntTy, 0);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000294 }
295
Reid Kleckner2341ae32013-04-11 18:13:19 +0000296 llvm::Constant *getAllOnesInt() {
297 return llvm::Constant::getAllOnesValue(CGM.IntTy);
Reid Kleckner407e8b62013-03-22 19:02:54 +0000298 }
299
Reid Kleckner452abac2013-05-09 21:01:17 +0000300 llvm::Constant *getConstantOrZeroInt(llvm::Constant *C) {
301 return C ? C : getZeroInt();
302 }
303
304 llvm::Value *getValueOrZeroInt(llvm::Value *C) {
305 return C ? C : getZeroInt();
306 }
307
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000308 CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD);
309
Reid Kleckner2341ae32013-04-11 18:13:19 +0000310 void
311 GetNullMemberPointerFields(const MemberPointerType *MPT,
312 llvm::SmallVectorImpl<llvm::Constant *> &fields);
313
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000314 /// \brief Shared code for virtual base adjustment. Returns the offset from
315 /// the vbptr to the virtual base. Optionally returns the address of the
316 /// vbptr itself.
317 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
318 llvm::Value *Base,
319 llvm::Value *VBPtrOffset,
320 llvm::Value *VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000321 llvm::Value **VBPtr = nullptr);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000322
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000323 llvm::Value *GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
324 llvm::Value *Base,
325 int32_t VBPtrOffset,
326 int32_t VBTableOffset,
Craig Topper8a13c412014-05-21 05:09:00 +0000327 llvm::Value **VBPtr = nullptr) {
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000328 llvm::Value *VBPOffset = llvm::ConstantInt::get(CGM.IntTy, VBPtrOffset),
329 *VBTOffset = llvm::ConstantInt::get(CGM.IntTy, VBTableOffset);
330 return GetVBaseOffsetFromVBPtr(CGF, Base, VBPOffset, VBTOffset, VBPtr);
331 }
332
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000333 /// \brief Performs a full virtual base adjustment. Used to dereference
334 /// pointers to members of virtual bases.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000335 llvm::Value *AdjustVirtualBase(CodeGenFunction &CGF, const Expr *E,
336 const CXXRecordDecl *RD, llvm::Value *Base,
Reid Kleckner2341ae32013-04-11 18:13:19 +0000337 llvm::Value *VirtualBaseAdjustmentOffset,
338 llvm::Value *VBPtrOffset /* optional */);
339
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000340 /// \brief Emits a full member pointer with the fields common to data and
341 /// function member pointers.
342 llvm::Constant *EmitFullMemberPointer(llvm::Constant *FirstField,
343 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +0000344 const CXXRecordDecl *RD,
345 CharUnits NonVirtualBaseAdjustment);
346
347 llvm::Constant *BuildMemberPointer(const CXXRecordDecl *RD,
348 const CXXMethodDecl *MD,
349 CharUnits NonVirtualBaseAdjustment);
350
351 bool MemberPointerConstantIsNull(const MemberPointerType *MPT,
352 llvm::Constant *MP);
Reid Kleckner7d0efb52013-05-03 01:15:11 +0000353
Reid Kleckner7810af02013-06-19 15:20:38 +0000354 /// \brief - Initialize all vbptrs of 'this' with RD as the complete type.
355 void EmitVBPtrStores(CodeGenFunction &CGF, const CXXRecordDecl *RD);
356
357 /// \brief Caching wrapper around VBTableBuilder::enumerateVBTables().
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000358 const VBTableGlobals &enumerateVBTables(const CXXRecordDecl *RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000359
Hans Wennborg88497d62013-11-15 17:24:45 +0000360 /// \brief Generate a thunk for calling a virtual member function MD.
Reid Klecknere4a52202014-02-21 02:27:32 +0000361 llvm::Function *EmitVirtualMemPtrThunk(
362 const CXXMethodDecl *MD,
363 const MicrosoftVTableContext::MethodVFTableLocation &ML);
Hans Wennborg88497d62013-11-15 17:24:45 +0000364
Reid Kleckner407e8b62013-03-22 19:02:54 +0000365public:
Craig Topper4f12f102014-03-12 06:41:41 +0000366 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000367
Craig Topper4f12f102014-03-12 06:41:41 +0000368 bool isZeroInitializable(const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000369
Craig Topper4f12f102014-03-12 06:41:41 +0000370 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000371
Craig Topper4f12f102014-03-12 06:41:41 +0000372 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
373 CharUnits offset) override;
374 llvm::Constant *EmitMemberPointer(const CXXMethodDecl *MD) override;
375 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000376
Craig Topper4f12f102014-03-12 06:41:41 +0000377 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
378 llvm::Value *L,
379 llvm::Value *R,
380 const MemberPointerType *MPT,
381 bool Inequality) override;
Reid Kleckner700c3ee2013-04-30 20:15:14 +0000382
Craig Topper4f12f102014-03-12 06:41:41 +0000383 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
384 llvm::Value *MemPtr,
385 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000386
Craig Topper4f12f102014-03-12 06:41:41 +0000387 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000388 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
389 llvm::Value *Base, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000390 const MemberPointerType *MPT) override;
Reid Kleckner407e8b62013-03-22 19:02:54 +0000391
Craig Topper4f12f102014-03-12 06:41:41 +0000392 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
393 const CastExpr *E,
394 llvm::Value *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000395
Craig Topper4f12f102014-03-12 06:41:41 +0000396 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
397 llvm::Constant *Src) override;
Reid Kleckner452abac2013-05-09 21:01:17 +0000398
Craig Topper4f12f102014-03-12 06:41:41 +0000399 llvm::Value *
David Majnemer2b0d66d2014-02-20 23:22:07 +0000400 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF, const Expr *E,
401 llvm::Value *&This, llvm::Value *MemPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000402 const MemberPointerType *MPT) override;
Reid Kleckner2341ae32013-04-11 18:13:19 +0000403
Reid Kleckner7810af02013-06-19 15:20:38 +0000404private:
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000405 typedef std::pair<const CXXRecordDecl *, CharUnits> VFTableIdTy;
David Majnemerd905da42014-07-01 20:30:31 +0000406 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalVariable *> VTablesMapTy;
407 typedef llvm::DenseMap<VFTableIdTy, llvm::GlobalValue *> VFTablesMapTy;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000408 /// \brief All the vftables that have been referenced.
409 VFTablesMapTy VFTablesMap;
David Majnemerd905da42014-07-01 20:30:31 +0000410 VTablesMapTy VTablesMap;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000411
412 /// \brief This set holds the record decls we've deferred vtable emission for.
413 llvm::SmallPtrSet<const CXXRecordDecl *, 4> DeferredVFTables;
414
415
416 /// \brief All the vbtables which have been referenced.
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000417 llvm::DenseMap<const CXXRecordDecl *, VBTableGlobals> VBTablesMap;
Reid Klecknerd8110b62013-09-10 20:14:30 +0000418
419 /// Info on the global variable used to guard initialization of static locals.
420 /// The BitIndex field is only used for externally invisible declarations.
421 struct GuardInfo {
Craig Topper8a13c412014-05-21 05:09:00 +0000422 GuardInfo() : Guard(nullptr), BitIndex(0) {}
Reid Klecknerd8110b62013-09-10 20:14:30 +0000423 llvm::GlobalVariable *Guard;
424 unsigned BitIndex;
425 };
426
427 /// Map from DeclContext to the current guard variable. We assume that the
428 /// AST is visited in source code order.
429 llvm::DenseMap<const DeclContext *, GuardInfo> GuardVariableMap;
Charles Davis74ce8592010-06-09 23:25:41 +0000430};
431
432}
433
Reid Klecknere39ee212014-05-03 00:33:28 +0000434CGCXXABI::RecordArgABI
435MicrosoftCXXABI::getRecordArgABI(const CXXRecordDecl *RD) const {
436 switch (CGM.getTarget().getTriple().getArch()) {
437 default:
438 // FIXME: Implement for other architectures.
439 return RAA_Default;
440
441 case llvm::Triple::x86:
Reid Klecknercf87e102014-05-14 16:02:09 +0000442 // All record arguments are passed in memory on x86. Decide whether to
443 // construct the object directly in argument memory, or to construct the
444 // argument elsewhere and copy the bytes during the call.
445
446 // If C++ prohibits us from making a copy, construct the arguments directly
447 // into argument memory.
448 if (!canCopyArgument(RD))
Reid Klecknere39ee212014-05-03 00:33:28 +0000449 return RAA_DirectInMemory;
Reid Klecknercf87e102014-05-14 16:02:09 +0000450
451 // Otherwise, construct the argument into a temporary and copy the bytes
452 // into the outgoing argument memory.
Reid Klecknere39ee212014-05-03 00:33:28 +0000453 return RAA_Default;
454
455 case llvm::Triple::x86_64:
456 // Win64 passes objects with non-trivial copy ctors indirectly.
457 if (RD->hasNonTrivialCopyConstructor())
458 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000459
Reid Klecknere39ee212014-05-03 00:33:28 +0000460 // Win64 passes objects larger than 8 bytes indirectly.
461 if (getContext().getTypeSize(RD->getTypeForDecl()) > 64)
462 return RAA_Indirect;
Reid Klecknercf87e102014-05-14 16:02:09 +0000463
464 // We have a trivial copy constructor or no copy constructors, but we have
465 // to make sure it isn't deleted.
466 bool CopyDeleted = false;
467 for (const CXXConstructorDecl *CD : RD->ctors()) {
468 if (CD->isCopyConstructor()) {
469 assert(CD->isTrivial());
470 // We had at least one undeleted trivial copy ctor. Return directly.
471 if (!CD->isDeleted())
472 return RAA_Default;
473 CopyDeleted = true;
474 }
475 }
476
477 // The trivial copy constructor was deleted. Return indirectly.
478 if (CopyDeleted)
479 return RAA_Indirect;
480
481 // There were no copy ctors. Return in RAX.
Reid Klecknere39ee212014-05-03 00:33:28 +0000482 return RAA_Default;
483 }
484
485 llvm_unreachable("invalid enum");
486}
487
John McCall82fb8922012-09-25 10:10:39 +0000488llvm::Value *MicrosoftCXXABI::adjustToCompleteObject(CodeGenFunction &CGF,
489 llvm::Value *ptr,
490 QualType type) {
491 // FIXME: implement
492 return ptr;
493}
494
David Majnemer1162d252014-06-22 19:05:33 +0000495/// \brief Gets the offset to the virtual base that contains the vfptr for
496/// MS-ABI polymorphic types.
497static llvm::Value *getPolymorphicOffset(CodeGenFunction &CGF,
498 const CXXRecordDecl *RD,
499 llvm::Value *Value) {
500 const ASTContext &Context = RD->getASTContext();
501 for (const CXXBaseSpecifier &Base : RD->vbases())
502 if (Context.getASTRecordLayout(Base.getType()->getAsCXXRecordDecl())
503 .hasExtendableVFPtr())
504 return CGF.CGM.getCXXABI().GetVirtualBaseClassOffset(
505 CGF, Value, RD, Base.getType()->getAsCXXRecordDecl());
506 llvm_unreachable("One of our vbases should be polymorphic.");
507}
508
509static std::pair<llvm::Value *, llvm::Value *>
510performBaseAdjustment(CodeGenFunction &CGF, llvm::Value *Value,
511 QualType SrcRecordTy) {
512 Value = CGF.Builder.CreateBitCast(Value, CGF.Int8PtrTy);
513 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
514
515 if (CGF.getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr())
516 return std::make_pair(Value, llvm::ConstantInt::get(CGF.Int32Ty, 0));
517
518 // Perform a base adjustment.
519 llvm::Value *Offset = getPolymorphicOffset(CGF, SrcDecl, Value);
520 Value = CGF.Builder.CreateInBoundsGEP(Value, Offset);
521 Offset = CGF.Builder.CreateTrunc(Offset, CGF.Int32Ty);
522 return std::make_pair(Value, Offset);
523}
524
525bool MicrosoftCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
526 QualType SrcRecordTy) {
527 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
528 return IsDeref &&
529 !CGM.getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
530}
531
532static llvm::CallSite emitRTtypeidCall(CodeGenFunction &CGF,
533 llvm::Value *Argument) {
534 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
535 llvm::FunctionType *FTy =
536 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false);
537 llvm::Value *Args[] = {Argument};
538 llvm::Constant *Fn = CGF.CGM.CreateRuntimeFunction(FTy, "__RTtypeid");
539 return CGF.EmitRuntimeCallOrInvoke(Fn, Args);
540}
541
542void MicrosoftCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
543 llvm::CallSite Call =
544 emitRTtypeidCall(CGF, llvm::Constant::getNullValue(CGM.VoidPtrTy));
545 Call.setDoesNotReturn();
546 CGF.Builder.CreateUnreachable();
547}
548
549llvm::Value *MicrosoftCXXABI::EmitTypeid(CodeGenFunction &CGF,
550 QualType SrcRecordTy,
551 llvm::Value *ThisPtr,
552 llvm::Type *StdTypeInfoPtrTy) {
553 llvm::Value *Offset;
554 std::tie(ThisPtr, Offset) = performBaseAdjustment(CGF, ThisPtr, SrcRecordTy);
555 return CGF.Builder.CreateBitCast(
556 emitRTtypeidCall(CGF, ThisPtr).getInstruction(), StdTypeInfoPtrTy);
557}
558
559bool MicrosoftCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
560 QualType SrcRecordTy) {
561 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
562 return SrcIsPtr &&
563 !CGM.getContext().getASTRecordLayout(SrcDecl).hasExtendableVFPtr();
564}
565
566llvm::Value *MicrosoftCXXABI::EmitDynamicCastCall(
567 CodeGenFunction &CGF, llvm::Value *Value, QualType SrcRecordTy,
568 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
569 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
570
571 llvm::Value *SrcRTTI =
572 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
573 llvm::Value *DestRTTI =
574 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
575
576 llvm::Value *Offset;
577 std::tie(Value, Offset) = performBaseAdjustment(CGF, Value, SrcRecordTy);
578
579 // PVOID __RTDynamicCast(
580 // PVOID inptr,
581 // LONG VfDelta,
582 // PVOID SrcType,
583 // PVOID TargetType,
584 // BOOL isReference)
585 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy, CGF.Int32Ty, CGF.Int8PtrTy,
586 CGF.Int8PtrTy, CGF.Int32Ty};
587 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
588 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
589 "__RTDynamicCast");
590 llvm::Value *Args[] = {
591 Value, Offset, SrcRTTI, DestRTTI,
592 llvm::ConstantInt::get(CGF.Int32Ty, DestTy->isReferenceType())};
593 Value = CGF.EmitRuntimeCallOrInvoke(Function, Args).getInstruction();
594 return CGF.Builder.CreateBitCast(Value, DestLTy);
595}
596
597llvm::Value *
598MicrosoftCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF, llvm::Value *Value,
599 QualType SrcRecordTy,
600 QualType DestTy) {
601 llvm::Value *Offset;
602 std::tie(Value, Offset) = performBaseAdjustment(CGF, Value, SrcRecordTy);
603
604 // PVOID __RTCastToVoid(
605 // PVOID inptr)
606 llvm::Type *ArgTypes[] = {CGF.Int8PtrTy};
607 llvm::Constant *Function = CGF.CGM.CreateRuntimeFunction(
608 llvm::FunctionType::get(CGF.Int8PtrTy, ArgTypes, false),
609 "__RTCastToVoid");
610 llvm::Value *Args[] = {Value};
611 return CGF.EmitRuntimeCall(Function, Args);
612}
613
614bool MicrosoftCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
615 return false;
616}
617
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000618llvm::Value *
619MicrosoftCXXABI::GetVirtualBaseClassOffset(CodeGenFunction &CGF,
620 llvm::Value *This,
621 const CXXRecordDecl *ClassDecl,
622 const CXXRecordDecl *BaseClassDecl) {
Reid Kleckner5b1b5d52014-01-14 00:50:39 +0000623 int64_t VBPtrChars =
624 getContext().getASTRecordLayout(ClassDecl).getVBPtrOffset().getQuantity();
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000625 llvm::Value *VBPtrOffset = llvm::ConstantInt::get(CGM.PtrDiffTy, VBPtrChars);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000626 CharUnits IntSize = getContext().getTypeSizeInChars(getContext().IntTy);
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000627 CharUnits VBTableChars =
628 IntSize *
629 CGM.getMicrosoftVTableContext().getVBTableIndex(ClassDecl, BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000630 llvm::Value *VBTableOffset =
631 llvm::ConstantInt::get(CGM.IntTy, VBTableChars.getQuantity());
632
633 llvm::Value *VBPtrToNewBase =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +0000634 GetVBaseOffsetFromVBPtr(CGF, This, VBPtrOffset, VBTableOffset);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000635 VBPtrToNewBase =
636 CGF.Builder.CreateSExtOrBitCast(VBPtrToNewBase, CGM.PtrDiffTy);
637 return CGF.Builder.CreateNSWAdd(VBPtrOffset, VBPtrToNewBase);
638}
639
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000640bool MicrosoftCXXABI::HasThisReturn(GlobalDecl GD) const {
641 return isa<CXXConstructorDecl>(GD.getDecl());
John McCall0f999f32012-09-25 08:00:39 +0000642}
643
Reid Kleckner40ca9132014-05-13 22:05:45 +0000644bool MicrosoftCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
645 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
646 if (!RD)
647 return false;
648
649 if (FI.isInstanceMethod()) {
650 // If it's an instance method, aggregates are always returned indirectly via
651 // the second parameter.
652 FI.getReturnInfo() = ABIArgInfo::getIndirect(0, /*ByVal=*/false);
653 FI.getReturnInfo().setSRetAfterThis(FI.isInstanceMethod());
654 return true;
655 } else if (!RD->isPOD()) {
656 // If it's a free function, non-POD types are returned indirectly.
657 FI.getReturnInfo() = ABIArgInfo::getIndirect(0, /*ByVal=*/false);
658 return true;
659 }
660
661 // Otherwise, use the C ABI rules.
662 return false;
663}
664
Reid Kleckner89077a12013-12-17 19:46:40 +0000665void MicrosoftCXXABI::BuildConstructorSignature(
666 const CXXConstructorDecl *Ctor, CXXCtorType Type, CanQualType &ResTy,
667 SmallVectorImpl<CanQualType> &ArgTys) {
668
669 // All parameters are already in place except is_most_derived, which goes
670 // after 'this' if it's variadic and last if it's not.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000671
672 const CXXRecordDecl *Class = Ctor->getParent();
Reid Kleckner89077a12013-12-17 19:46:40 +0000673 const FunctionProtoType *FPT = Ctor->getType()->castAs<FunctionProtoType>();
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000674 if (Class->getNumVBases()) {
Reid Kleckner89077a12013-12-17 19:46:40 +0000675 if (FPT->isVariadic())
676 ArgTys.insert(ArgTys.begin() + 1, CGM.getContext().IntTy);
677 else
678 ArgTys.push_back(CGM.getContext().IntTy);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000679 }
680}
681
Reid Kleckner7810af02013-06-19 15:20:38 +0000682llvm::BasicBlock *
683MicrosoftCXXABI::EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
684 const CXXRecordDecl *RD) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000685 llvm::Value *IsMostDerivedClass = getStructorImplicitParamValue(CGF);
686 assert(IsMostDerivedClass &&
687 "ctor for a class with virtual bases must have an implicit parameter");
Reid Kleckner7810af02013-06-19 15:20:38 +0000688 llvm::Value *IsCompleteObject =
689 CGF.Builder.CreateIsNotNull(IsMostDerivedClass, "is_complete_object");
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000690
691 llvm::BasicBlock *CallVbaseCtorsBB = CGF.createBasicBlock("ctor.init_vbases");
692 llvm::BasicBlock *SkipVbaseCtorsBB = CGF.createBasicBlock("ctor.skip_vbases");
693 CGF.Builder.CreateCondBr(IsCompleteObject,
694 CallVbaseCtorsBB, SkipVbaseCtorsBB);
695
696 CGF.EmitBlock(CallVbaseCtorsBB);
Reid Kleckner7810af02013-06-19 15:20:38 +0000697
698 // Fill in the vbtable pointers here.
699 EmitVBPtrStores(CGF, RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000700
701 // CGF will put the base ctor calls in this basic block for us later.
702
703 return SkipVbaseCtorsBB;
John McCall0f999f32012-09-25 08:00:39 +0000704}
705
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000706void MicrosoftCXXABI::initializeHiddenVirtualInheritanceMembers(
707 CodeGenFunction &CGF, const CXXRecordDecl *RD) {
708 // In most cases, an override for a vbase virtual method can adjust
709 // the "this" parameter by applying a constant offset.
710 // However, this is not enough while a constructor or a destructor of some
711 // class X is being executed if all the following conditions are met:
712 // - X has virtual bases, (1)
713 // - X overrides a virtual method M of a vbase Y, (2)
714 // - X itself is a vbase of the most derived class.
715 //
716 // If (1) and (2) are true, the vtorDisp for vbase Y is a hidden member of X
717 // which holds the extra amount of "this" adjustment we must do when we use
718 // the X vftables (i.e. during X ctor or dtor).
719 // Outside the ctors and dtors, the values of vtorDisps are zero.
720
721 const ASTRecordLayout &Layout = getContext().getASTRecordLayout(RD);
722 typedef ASTRecordLayout::VBaseOffsetsMapTy VBOffsets;
723 const VBOffsets &VBaseMap = Layout.getVBaseOffsetsMap();
724 CGBuilderTy &Builder = CGF.Builder;
725
726 unsigned AS =
727 cast<llvm::PointerType>(getThisValue(CGF)->getType())->getAddressSpace();
Craig Topper8a13c412014-05-21 05:09:00 +0000728 llvm::Value *Int8This = nullptr; // Initialize lazily.
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000729
730 for (VBOffsets::const_iterator I = VBaseMap.begin(), E = VBaseMap.end();
731 I != E; ++I) {
732 if (!I->second.hasVtorDisp())
733 continue;
734
Timur Iskhodzhanov4ddf5922013-11-13 16:03:43 +0000735 llvm::Value *VBaseOffset =
736 GetVirtualBaseClassOffset(CGF, getThisValue(CGF), RD, I->first);
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000737 // FIXME: it doesn't look right that we SExt in GetVirtualBaseClassOffset()
738 // just to Trunc back immediately.
739 VBaseOffset = Builder.CreateTruncOrBitCast(VBaseOffset, CGF.Int32Ty);
740 uint64_t ConstantVBaseOffset =
741 Layout.getVBaseClassOffset(I->first).getQuantity();
742
743 // vtorDisp_for_vbase = vbptr[vbase_idx] - offsetof(RD, vbase).
744 llvm::Value *VtorDispValue = Builder.CreateSub(
745 VBaseOffset, llvm::ConstantInt::get(CGM.Int32Ty, ConstantVBaseOffset),
746 "vtordisp.value");
747
748 if (!Int8This)
749 Int8This = Builder.CreateBitCast(getThisValue(CGF),
750 CGF.Int8Ty->getPointerTo(AS));
751 llvm::Value *VtorDispPtr = Builder.CreateInBoundsGEP(Int8This, VBaseOffset);
752 // vtorDisp is always the 32-bits before the vbase in the class layout.
753 VtorDispPtr = Builder.CreateConstGEP1_32(VtorDispPtr, -4);
754 VtorDispPtr = Builder.CreateBitCast(
755 VtorDispPtr, CGF.Int32Ty->getPointerTo(AS), "vtordisp.ptr");
756
757 Builder.CreateStore(VtorDispValue, VtorDispPtr);
758 }
759}
760
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000761void MicrosoftCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
762 // There's only one constructor type in this ABI.
763 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
764}
765
Reid Kleckner7810af02013-06-19 15:20:38 +0000766void MicrosoftCXXABI::EmitVBPtrStores(CodeGenFunction &CGF,
767 const CXXRecordDecl *RD) {
768 llvm::Value *ThisInt8Ptr =
769 CGF.Builder.CreateBitCast(getThisValue(CGF), CGM.Int8PtrTy, "this.int8");
Reid Kleckner5f080942014-01-03 23:42:00 +0000770 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +0000771
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000772 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
773 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000774 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000775 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner7810af02013-06-19 15:20:38 +0000776 const ASTRecordLayout &SubobjectLayout =
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000777 CGM.getContext().getASTRecordLayout(VBT->BaseWithVPtr);
Reid Kleckner5f080942014-01-03 23:42:00 +0000778 CharUnits Offs = VBT->NonVirtualOffset;
779 Offs += SubobjectLayout.getVBPtrOffset();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +0000780 if (VBT->getVBaseWithVPtr())
781 Offs += Layout.getVBaseClassOffset(VBT->getVBaseWithVPtr());
Reid Kleckner7810af02013-06-19 15:20:38 +0000782 llvm::Value *VBPtr =
Reid Kleckner5f080942014-01-03 23:42:00 +0000783 CGF.Builder.CreateConstInBoundsGEP1_64(ThisInt8Ptr, Offs.getQuantity());
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000784 VBPtr = CGF.Builder.CreateBitCast(VBPtr, GV->getType()->getPointerTo(0),
Reid Kleckner5f080942014-01-03 23:42:00 +0000785 "vbptr." + VBT->ReusingBase->getName());
Reid Klecknerb40a27d2014-01-03 00:14:35 +0000786 CGF.Builder.CreateStore(GV, VBPtr);
Reid Kleckner7810af02013-06-19 15:20:38 +0000787 }
788}
789
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000790void MicrosoftCXXABI::BuildDestructorSignature(const CXXDestructorDecl *Dtor,
791 CXXDtorType Type,
792 CanQualType &ResTy,
793 SmallVectorImpl<CanQualType> &ArgTys) {
794 // 'this' is already in place
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000795
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000796 // TODO: 'for base' flag
797
798 if (Type == Dtor_Deleting) {
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +0000799 // The scalar deleting destructor takes an implicit int parameter.
800 ArgTys.push_back(CGM.getContext().IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000801 }
802}
803
Reid Klecknere7de47e2013-07-22 13:51:44 +0000804void MicrosoftCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
805 // The TU defining a dtor is only guaranteed to emit a base destructor. All
806 // other destructor variants are delegating thunks.
807 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
808}
809
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000810CharUnits
811MicrosoftCXXABI::getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000812 GD = GD.getCanonicalDecl();
813 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000814
815 GlobalDecl LookupGD = GD;
816 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
817 // Complete destructors take a pointer to the complete object as a
818 // parameter, thus don't need this adjustment.
819 if (GD.getDtorType() == Dtor_Complete)
820 return CharUnits();
821
822 // There's no Dtor_Base in vftable but it shares the this adjustment with
823 // the deleting one, so look it up instead.
824 LookupGD = GlobalDecl(DD, Dtor_Deleting);
825 }
826
827 MicrosoftVTableContext::MethodVFTableLocation ML =
828 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
829 CharUnits Adjustment = ML.VFPtrOffset;
830
831 // Normal virtual instance methods need to adjust from the vfptr that first
832 // defined the virtual method to the virtual base subobject, but destructors
833 // do not. The vector deleting destructor thunk applies this adjustment for
834 // us if necessary.
835 if (isa<CXXDestructorDecl>(MD))
836 Adjustment = CharUnits::Zero();
837
838 if (ML.VBase) {
839 const ASTRecordLayout &DerivedLayout =
840 CGM.getContext().getASTRecordLayout(MD->getParent());
841 Adjustment += DerivedLayout.getVBaseClassOffset(ML.VBase);
842 }
843
844 return Adjustment;
845}
846
847llvm::Value *MicrosoftCXXABI::adjustThisArgumentForVirtualFunctionCall(
848 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This, bool VirtualCall) {
849 if (!VirtualCall) {
850 // If the call of a virtual function is not virtual, we just have to
851 // compensate for the adjustment the virtual function does in its prologue.
852 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
853 if (Adjustment.isZero())
854 return This;
855
856 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
857 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS);
858 This = CGF.Builder.CreateBitCast(This, charPtrTy);
859 assert(Adjustment.isPositive());
860 return CGF.Builder.CreateConstGEP1_32(This, Adjustment.getQuantity());
861 }
862
863 GD = GD.getCanonicalDecl();
864 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000865
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +0000866 GlobalDecl LookupGD = GD;
867 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
868 // Complete dtors take a pointer to the complete object,
869 // thus don't need adjustment.
870 if (GD.getDtorType() == Dtor_Complete)
871 return This;
872
873 // There's only Dtor_Deleting in vftable but it shares the this adjustment
874 // with the base one, so look up the deleting one instead.
875 LookupGD = GlobalDecl(DD, Dtor_Deleting);
876 }
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000877 MicrosoftVTableContext::MethodVFTableLocation ML =
878 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(LookupGD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000879
880 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
881 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS);
Timur Iskhodzhanov9e7f5052013-11-07 13:34:02 +0000882 CharUnits StaticOffset = ML.VFPtrOffset;
Reid Kleckner0c12b362014-02-18 22:51:52 +0000883
884 // Base destructors expect 'this' to point to the beginning of the base
885 // subobject, not the first vfptr that happens to contain the virtual dtor.
886 // However, we still need to apply the virtual base adjustment.
887 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
888 StaticOffset = CharUnits::Zero();
889
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +0000890 if (ML.VBase) {
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000891 This = CGF.Builder.CreateBitCast(This, charPtrTy);
892 llvm::Value *VBaseOffset =
893 GetVirtualBaseClassOffset(CGF, This, MD->getParent(), ML.VBase);
894 This = CGF.Builder.CreateInBoundsGEP(This, VBaseOffset);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +0000895 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000896 if (!StaticOffset.isZero()) {
897 assert(StaticOffset.isPositive());
898 This = CGF.Builder.CreateBitCast(This, charPtrTy);
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +0000899 if (ML.VBase) {
900 // Non-virtual adjustment might result in a pointer outside the allocated
901 // object, e.g. if the final overrider class is laid out after the virtual
902 // base that declares a method in the most derived class.
903 // FIXME: Update the code that emits this adjustment in thunks prologues.
904 This = CGF.Builder.CreateConstGEP1_32(This, StaticOffset.getQuantity());
905 } else {
906 This = CGF.Builder.CreateConstInBoundsGEP1_32(This,
907 StaticOffset.getQuantity());
908 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000909 }
910 return This;
911}
912
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000913static bool IsDeletingDtor(GlobalDecl GD) {
914 const CXXMethodDecl* MD = cast<CXXMethodDecl>(GD.getDecl());
915 if (isa<CXXDestructorDecl>(MD)) {
916 return GD.getDtorType() == Dtor_Deleting;
917 }
918 return false;
919}
920
Reid Kleckner89077a12013-12-17 19:46:40 +0000921void MicrosoftCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
922 QualType &ResTy,
923 FunctionArgList &Params) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000924 ASTContext &Context = getContext();
925 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +0000926 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000927 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
928 ImplicitParamDecl *IsMostDerived
Craig Topper8a13c412014-05-21 05:09:00 +0000929 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000930 CGF.CurGD.getDecl()->getLocation(),
931 &Context.Idents.get("is_most_derived"),
932 Context.IntTy);
Reid Kleckner89077a12013-12-17 19:46:40 +0000933 // The 'most_derived' parameter goes second if the ctor is variadic and last
934 // if it's not. Dtors can't be variadic.
935 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
936 if (FPT->isVariadic())
937 Params.insert(Params.begin() + 1, IsMostDerived);
938 else
939 Params.push_back(IsMostDerived);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000940 getStructorImplicitParamDecl(CGF) = IsMostDerived;
941 } else if (IsDeletingDtor(CGF.CurGD)) {
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000942 ImplicitParamDecl *ShouldDelete
Craig Topper8a13c412014-05-21 05:09:00 +0000943 = ImplicitParamDecl::Create(Context, nullptr,
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000944 CGF.CurGD.getDecl()->getLocation(),
945 &Context.Idents.get("should_call_delete"),
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +0000946 Context.IntTy);
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000947 Params.push_back(ShouldDelete);
948 getStructorImplicitParamDecl(CGF) = ShouldDelete;
949 }
John McCall0f999f32012-09-25 08:00:39 +0000950}
951
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000952llvm::Value *MicrosoftCXXABI::adjustThisParameterInVirtualFunctionPrologue(
953 CodeGenFunction &CGF, GlobalDecl GD, llvm::Value *This) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000954 // In this ABI, every virtual function takes a pointer to one of the
955 // subobjects that first defines it as the 'this' parameter, rather than a
Alp Tokerf6a24ce2013-12-05 16:25:25 +0000956 // pointer to the final overrider subobject. Thus, we need to adjust it back
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000957 // to the final overrider subobject before use.
958 // See comments in the MicrosoftVFTableContext implementation for the details.
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000959 CharUnits Adjustment = getVirtualFunctionPrologueThisAdjustment(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000960 if (Adjustment.isZero())
961 return This;
962
963 unsigned AS = cast<llvm::PointerType>(This->getType())->getAddressSpace();
964 llvm::Type *charPtrTy = CGF.Int8Ty->getPointerTo(AS),
965 *thisTy = This->getType();
966
967 This = CGF.Builder.CreateBitCast(This, charPtrTy);
968 assert(Adjustment.isPositive());
Timur Iskhodzhanov827365e2013-10-22 18:15:24 +0000969 This =
970 CGF.Builder.CreateConstInBoundsGEP1_32(This, -Adjustment.getQuantity());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000971 return CGF.Builder.CreateBitCast(This, thisTy);
972}
973
John McCall0f999f32012-09-25 08:00:39 +0000974void MicrosoftCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
975 EmitThisParam(CGF);
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000976
977 /// If this is a function that the ABI specifies returns 'this', initialize
978 /// the return slot to 'this' at the start of the function.
979 ///
980 /// Unlike the setting of return types, this is done within the ABI
981 /// implementation instead of by clients of CGCXXABI because:
982 /// 1) getThisValue is currently protected
983 /// 2) in theory, an ABI could implement 'this' returns some other way;
984 /// HasThisReturn only specifies a contract, not the implementation
985 if (HasThisReturn(CGF.CurGD))
John McCall0f999f32012-09-25 08:00:39 +0000986 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000987
988 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
989 if (isa<CXXConstructorDecl>(MD) && MD->getParent()->getNumVBases()) {
990 assert(getStructorImplicitParamDecl(CGF) &&
991 "no implicit parameter for a constructor with virtual bases?");
992 getStructorImplicitParamValue(CGF)
993 = CGF.Builder.CreateLoad(
994 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
995 "is_most_derived");
996 }
997
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000998 if (IsDeletingDtor(CGF.CurGD)) {
999 assert(getStructorImplicitParamDecl(CGF) &&
1000 "no implicit parameter for a deleting destructor?");
1001 getStructorImplicitParamValue(CGF)
1002 = CGF.Builder.CreateLoad(
1003 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)),
1004 "should_call_delete");
1005 }
John McCall0f999f32012-09-25 08:00:39 +00001006}
1007
Reid Kleckner89077a12013-12-17 19:46:40 +00001008unsigned MicrosoftCXXABI::addImplicitConstructorArgs(
1009 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1010 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001011 assert(Type == Ctor_Complete || Type == Ctor_Base);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001012
Reid Kleckner89077a12013-12-17 19:46:40 +00001013 // Check if we need a 'most_derived' parameter.
1014 if (!D->getParent()->getNumVBases())
1015 return 0;
1016
1017 // Add the 'most_derived' argument second if we are variadic or last if not.
1018 const FunctionProtoType *FPT = D->getType()->castAs<FunctionProtoType>();
1019 llvm::Value *MostDerivedArg =
1020 llvm::ConstantInt::get(CGM.Int32Ty, Type == Ctor_Complete);
1021 RValue RV = RValue::get(MostDerivedArg);
1022 if (MostDerivedArg) {
1023 if (FPT->isVariadic())
1024 Args.insert(Args.begin() + 1,
1025 CallArg(RV, getContext().IntTy, /*needscopy=*/false));
1026 else
1027 Args.add(RV, getContext().IntTy);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001028 }
1029
Reid Kleckner89077a12013-12-17 19:46:40 +00001030 return 1; // Added one arg.
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001031}
1032
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001033void MicrosoftCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1034 const CXXDestructorDecl *DD,
1035 CXXDtorType Type, bool ForVirtualBase,
1036 bool Delegating, llvm::Value *This) {
1037 llvm::Value *Callee = CGM.GetAddrOfCXXDestructor(DD, Type);
1038
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001039 if (DD->isVirtual()) {
1040 assert(Type != CXXDtorType::Dtor_Deleting &&
1041 "The deleting destructor should only be called via a virtual call");
1042 This = adjustThisArgumentForVirtualFunctionCall(CGF, GlobalDecl(DD, Type),
1043 This, false);
1044 }
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001045
1046 // FIXME: Provide a source location here.
1047 CGF.EmitCXXMemberCall(DD, SourceLocation(), Callee, ReturnValueSlot(), This,
Craig Topper8a13c412014-05-21 05:09:00 +00001048 /*ImplicitParam=*/nullptr,
1049 /*ImplicitParamTy=*/QualType(), nullptr, nullptr);
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001050}
1051
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001052void MicrosoftCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1053 const CXXRecordDecl *RD) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001054 MicrosoftVTableContext &VFTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001055 VPtrInfoVector VFPtrs = VFTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001056
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001057 for (VPtrInfo *Info : VFPtrs) {
1058 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001059 if (VTable->hasInitializer())
1060 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001061
1062 llvm::Constant *RTTI = CGM.getMSCompleteObjectLocator(RD, Info);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001063
1064 const VTableLayout &VTLayout =
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00001065 VFTContext.getVFTableLayout(RD, Info->FullOffsetInMDC);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001066 llvm::Constant *Init = CGVT.CreateVTableInitializer(
1067 RD, VTLayout.vtable_component_begin(),
1068 VTLayout.getNumVTableComponents(), VTLayout.vtable_thunk_begin(),
David Majnemerd905da42014-07-01 20:30:31 +00001069 VTLayout.getNumVTableThunks(), RTTI);
1070
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001071 VTable->setInitializer(Init);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001072 }
1073}
1074
1075llvm::Value *MicrosoftCXXABI::getVTableAddressPointInStructor(
1076 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
1077 const CXXRecordDecl *NearestVBase, bool &NeedsVirtualOffset) {
Craig Topper8a13c412014-05-21 05:09:00 +00001078 NeedsVirtualOffset = (NearestVBase != nullptr);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001079
David Majnemerd905da42014-07-01 20:30:31 +00001080 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1081 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1082 llvm::GlobalValue *VTableAddressPoint = VFTablesMap[ID];
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001083 if (!VTableAddressPoint) {
1084 assert(Base.getBase()->getNumVBases() &&
1085 !CGM.getContext().getASTRecordLayout(Base.getBase()).hasOwnVFPtr());
1086 }
1087 return VTableAddressPoint;
1088}
1089
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001090static void mangleVFTableName(MicrosoftMangleContext &MangleContext,
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001091 const CXXRecordDecl *RD, const VPtrInfo *VFPtr,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001092 SmallString<256> &Name) {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001093 llvm::raw_svector_ostream Out(Name);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001094 MangleContext.mangleCXXVFTable(RD, VFPtr->MangledPath, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001095}
1096
1097llvm::Constant *MicrosoftCXXABI::getVTableAddressPointForConstExpr(
1098 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
David Majnemerd905da42014-07-01 20:30:31 +00001099 (void)getAddrOfVTable(VTableClass, Base.getBaseOffset());
1100 VFTableIdTy ID(VTableClass, Base.getBaseOffset());
1101 llvm::GlobalValue *VFTable = VFTablesMap[ID];
1102 assert(VFTable && "Couldn't find a vftable for the given base?");
1103 return VFTable;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001104}
1105
1106llvm::GlobalVariable *MicrosoftCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1107 CharUnits VPtrOffset) {
1108 // getAddrOfVTable may return 0 if asked to get an address of a vtable which
1109 // shouldn't be used in the given record type. We want to cache this result in
1110 // VFTablesMap, thus a simple zero check is not sufficient.
1111 VFTableIdTy ID(RD, VPtrOffset);
David Majnemerd905da42014-07-01 20:30:31 +00001112 VTablesMapTy::iterator I;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001113 bool Inserted;
David Majnemerd905da42014-07-01 20:30:31 +00001114 std::tie(I, Inserted) = VTablesMap.insert(std::make_pair(ID, nullptr));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001115 if (!Inserted)
1116 return I->second;
1117
1118 llvm::GlobalVariable *&VTable = I->second;
1119
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001120 MicrosoftVTableContext &VTContext = CGM.getMicrosoftVTableContext();
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001121 const VPtrInfoVector &VFPtrs = VTContext.getVFPtrOffsets(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001122
1123 if (DeferredVFTables.insert(RD)) {
1124 // We haven't processed this record type before.
1125 // Queue up this v-table for possible deferred emission.
1126 CGM.addDeferredVTable(RD);
1127
1128#ifndef NDEBUG
1129 // Create all the vftables at once in order to make sure each vftable has
1130 // a unique mangled name.
1131 llvm::StringSet<> ObservedMangledNames;
1132 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
1133 SmallString<256> Name;
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001134 mangleVFTableName(getMangleContext(), RD, VFPtrs[J], Name);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001135 if (!ObservedMangledNames.insert(Name.str()))
1136 llvm_unreachable("Already saw this mangling before?");
1137 }
1138#endif
1139 }
1140
1141 for (size_t J = 0, F = VFPtrs.size(); J != F; ++J) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001142 if (VFPtrs[J]->FullOffsetInMDC != VPtrOffset)
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001143 continue;
David Majnemerd905da42014-07-01 20:30:31 +00001144 SmallString<256> VFTableName;
1145 mangleVFTableName(getMangleContext(), RD, VFPtrs[J], VFTableName);
1146 StringRef VTableName = VFTableName;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001147
David Majnemerd905da42014-07-01 20:30:31 +00001148 uint64_t NumVTableSlots =
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001149 VTContext.getVFTableLayout(RD, VFPtrs[J]->FullOffsetInMDC)
David Majnemerd905da42014-07-01 20:30:31 +00001150 .getNumVTableComponents();
1151 llvm::GlobalValue::LinkageTypes VTableLinkage =
1152 llvm::GlobalValue::ExternalLinkage;
1153 llvm::ArrayType *VTableType =
1154 llvm::ArrayType::get(CGM.Int8PtrTy, NumVTableSlots);
David Majnemerf6072342014-07-01 22:24:56 +00001155 if (getContext().getLangOpts().RTTIData) {
David Majnemerd905da42014-07-01 20:30:31 +00001156 VTableLinkage = llvm::GlobalValue::PrivateLinkage;
1157 VTableName = "";
1158 }
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001159
David Majnemerd905da42014-07-01 20:30:31 +00001160 VTable = CGM.getModule().getNamedGlobal(VFTableName);
1161 if (!VTable) {
David Majnemerbb848712014-07-01 22:37:08 +00001162 // Create a backing variable for the contents of VTable. The VTable may
1163 // or may not include space for a pointer to RTTI data.
David Majnemerd905da42014-07-01 20:30:31 +00001164 llvm::GlobalValue *VFTable = VTable = new llvm::GlobalVariable(
1165 CGM.getModule(), VTableType, /*isConstant=*/true, VTableLinkage,
1166 /*Initializer=*/nullptr, VTableName);
1167 VTable->setUnnamedAddr(true);
David Majnemerbb848712014-07-01 22:37:08 +00001168
1169 // Only insert a pointer into the VFTable for RTTI data if we are not
1170 // importing it. We never reference the RTTI data directly so there is no
1171 // need to make room for it.
David Majnemerf6072342014-07-01 22:24:56 +00001172 if (getContext().getLangOpts().RTTIData &&
1173 !RD->hasAttr<DLLImportAttr>()) {
David Majnemerd905da42014-07-01 20:30:31 +00001174 llvm::Value *GEPIndices[] = {llvm::ConstantInt::get(CGM.IntTy, 0),
1175 llvm::ConstantInt::get(CGM.IntTy, 1)};
David Majnemerbb848712014-07-01 22:37:08 +00001176 // Create a GEP which points just after the first entry in the VFTable,
1177 // this should be the location of the first virtual method.
David Majnemerd905da42014-07-01 20:30:31 +00001178 llvm::Constant *VTableGEP =
1179 llvm::ConstantExpr::getInBoundsGetElementPtr(VTable, GEPIndices);
David Majnemerbb848712014-07-01 22:37:08 +00001180 // The symbol for the VFTable is an alias to the GEP. It is
1181 // transparent, to other modules, what the nature of this symbol is; all
1182 // that matters is that the alias be the address of the first virtual
1183 // method.
David Majnemerd905da42014-07-01 20:30:31 +00001184 VFTable = llvm::GlobalAlias::create(
1185 cast<llvm::SequentialType>(VTableGEP->getType())->getElementType(),
1186 /*AddressSpace=*/0, llvm::GlobalValue::ExternalLinkage,
1187 VFTableName.str(), VTableGEP, &CGM.getModule());
1188 } else {
David Majnemerbb848712014-07-01 22:37:08 +00001189 // We don't need a GlobalAlias to be a symbol for the VTable if we won't
1190 // be referencing any RTTI data. The GlobalVariable will end up being
1191 // an appropriate definition of the VFTable.
David Majnemerd905da42014-07-01 20:30:31 +00001192 VTable->setName(VFTableName.str());
1193 }
1194
1195 VFTable->setUnnamedAddr(true);
1196 if (RD->hasAttr<DLLImportAttr>())
1197 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1198 else if (RD->hasAttr<DLLExportAttr>())
1199 VFTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1200
1201 llvm::GlobalValue::LinkageTypes VFTableLinkage = CGM.getVTableLinkage(RD);
1202 if (VFTable != VTable) {
1203 if (llvm::GlobalValue::isAvailableExternallyLinkage(VFTableLinkage)) {
1204 // AvailableExternally implies that we grabbed the data from another
1205 // executable. No need to stick the alias in a Comdat.
1206 } else if (llvm::GlobalValue::isLocalLinkage(VFTableLinkage)) {
1207 // If it's local, it means that the virtual function table can't be
1208 // referenced in another translation unit. No need to stick the alias
1209 // in a Comdat.
1210 } else if (llvm::GlobalValue::isWeakODRLinkage(VFTableLinkage) ||
1211 llvm::GlobalValue::isLinkOnceODRLinkage(VFTableLinkage)) {
1212 // The alias is going to be dropped into a Comdat, no need to make it
1213 // weak.
1214 VFTableLinkage = llvm::GlobalValue::ExternalLinkage;
1215 llvm::Comdat *C =
1216 CGM.getModule().getOrInsertComdat(VFTable->getName());
David Majnemerbb848712014-07-01 22:37:08 +00001217 // We must indicate which VFTable is larger to support linking between
1218 // translation units which do and do not have RTTI data. The largest
1219 // VFTable contains the RTTI data; translation units which reference
1220 // the smaller VFTable always reference it relative to the first
1221 // virtual method.
David Majnemerd905da42014-07-01 20:30:31 +00001222 C->setSelectionKind(llvm::Comdat::Largest);
1223 VTable->setComdat(C);
1224 } else {
1225 llvm_unreachable("unexpected linkage for vftable!");
1226 }
1227 }
1228 VFTable->setLinkage(VFTableLinkage);
1229 CGM.setGlobalVisibility(VFTable, RD);
1230 VFTablesMap[ID] = VFTable;
1231 }
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001232 break;
1233 }
1234
1235 return VTable;
1236}
1237
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001238llvm::Value *MicrosoftCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1239 GlobalDecl GD,
1240 llvm::Value *This,
1241 llvm::Type *Ty) {
1242 GD = GD.getCanonicalDecl();
1243 CGBuilderTy &Builder = CGF.Builder;
1244
1245 Ty = Ty->getPointerTo()->getPointerTo();
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001246 llvm::Value *VPtr =
1247 adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001248 llvm::Value *VTable = CGF.GetVTablePtr(VPtr, Ty);
1249
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001250 MicrosoftVTableContext::MethodVFTableLocation ML =
1251 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001252 llvm::Value *VFuncPtr =
1253 Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1254 return Builder.CreateLoad(VFuncPtr);
1255}
1256
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001257void MicrosoftCXXABI::EmitVirtualDestructorCall(CodeGenFunction &CGF,
1258 const CXXDestructorDecl *Dtor,
1259 CXXDtorType DtorType,
1260 SourceLocation CallLoc,
1261 llvm::Value *This) {
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001262 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1263
1264 // We have only one destructor in the vftable but can get both behaviors
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001265 // by passing an implicit int parameter.
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001266 GlobalDecl GD(Dtor, Dtor_Deleting);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001267 const CGFunctionInfo *FInfo =
1268 &CGM.getTypes().arrangeCXXDestructor(Dtor, Dtor_Deleting);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001269 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Timur Iskhodzhanov62082b72013-10-16 18:24:06 +00001270 llvm::Value *Callee = getVirtualFunctionPointer(CGF, GD, This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001271
1272 ASTContext &Context = CGF.getContext();
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001273 llvm::Value *ImplicitParam =
Timur Iskhodzhanov701981f2013-08-27 10:38:19 +00001274 llvm::ConstantInt::get(llvm::IntegerType::getInt32Ty(CGF.getLLVMContext()),
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001275 DtorType == Dtor_Deleting);
1276
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +00001277 This = adjustThisArgumentForVirtualFunctionCall(CGF, GD, This, true);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001278 CGF.EmitCXXMemberCall(Dtor, CallLoc, Callee, ReturnValueSlot(), This,
Craig Topper8a13c412014-05-21 05:09:00 +00001279 ImplicitParam, Context.IntTy, nullptr, nullptr);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001280}
1281
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001282const VBTableGlobals &
1283MicrosoftCXXABI::enumerateVBTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001284 // At this layer, we can key the cache off of a single class, which is much
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001285 // easier than caching each vbtable individually.
1286 llvm::DenseMap<const CXXRecordDecl*, VBTableGlobals>::iterator Entry;
1287 bool Added;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001288 std::tie(Entry, Added) =
1289 VBTablesMap.insert(std::make_pair(RD, VBTableGlobals()));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001290 VBTableGlobals &VBGlobals = Entry->second;
1291 if (!Added)
1292 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001293
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001294 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
1295 VBGlobals.VBTables = &Context.enumerateVBTables(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001296
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001297 // Cache the globals for all vbtables so we don't have to recompute the
1298 // mangled names.
1299 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001300 for (VPtrInfoVector::const_iterator I = VBGlobals.VBTables->begin(),
1301 E = VBGlobals.VBTables->end();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001302 I != E; ++I) {
Reid Kleckner5f080942014-01-03 23:42:00 +00001303 VBGlobals.Globals.push_back(getAddrOfVBTable(**I, RD, Linkage));
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001304 }
1305
1306 return VBGlobals;
Reid Kleckner7810af02013-06-19 15:20:38 +00001307}
1308
Reid Klecknere4a52202014-02-21 02:27:32 +00001309llvm::Function *MicrosoftCXXABI::EmitVirtualMemPtrThunk(
1310 const CXXMethodDecl *MD,
1311 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
1312 // Calculate the mangled name.
1313 SmallString<256> ThunkName;
1314 llvm::raw_svector_ostream Out(ThunkName);
1315 getMangleContext().mangleVirtualMemPtrThunk(MD, Out);
1316 Out.flush();
1317
Hans Wennborg88497d62013-11-15 17:24:45 +00001318 // If the thunk has been generated previously, just return it.
1319 if (llvm::GlobalValue *GV = CGM.getModule().getNamedValue(ThunkName))
1320 return cast<llvm::Function>(GV);
1321
1322 // Create the llvm::Function.
1323 const CGFunctionInfo &FnInfo = CGM.getTypes().arrangeGlobalDeclaration(MD);
1324 llvm::FunctionType *ThunkTy = CGM.getTypes().GetFunctionType(FnInfo);
1325 llvm::Function *ThunkFn =
1326 llvm::Function::Create(ThunkTy, llvm::Function::ExternalLinkage,
1327 ThunkName.str(), &CGM.getModule());
1328 assert(ThunkFn->getName() == ThunkName && "name was uniqued!");
1329
Hans Wennborg88497d62013-11-15 17:24:45 +00001330 ThunkFn->setLinkage(MD->isExternallyVisible()
1331 ? llvm::GlobalValue::LinkOnceODRLinkage
1332 : llvm::GlobalValue::InternalLinkage);
1333
1334 CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
1335 CGM.SetLLVMFunctionAttributesForDefinition(MD, ThunkFn);
1336
1337 // Start codegen.
1338 CodeGenFunction CGF(CGM);
1339 CGF.StartThunk(ThunkFn, MD, FnInfo);
1340
Reid Klecknere4a52202014-02-21 02:27:32 +00001341 // Load the vfptr and then callee from the vftable. The callee should have
1342 // adjusted 'this' so that the vfptr is at offset zero.
Hans Wennborg88497d62013-11-15 17:24:45 +00001343 llvm::Value *This = CGF.LoadCXXThis();
Reid Klecknere4a52202014-02-21 02:27:32 +00001344 llvm::Value *VTable =
1345 CGF.GetVTablePtr(This, ThunkTy->getPointerTo()->getPointerTo());
1346 llvm::Value *VFuncPtr =
1347 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, ML.Index, "vfn");
1348 llvm::Value *Callee = CGF.Builder.CreateLoad(VFuncPtr);
Hans Wennborg88497d62013-11-15 17:24:45 +00001349
Reid Kleckner966abe72014-05-15 23:01:46 +00001350 unsigned CallingConv;
1351 CodeGen::AttributeListType AttributeList;
1352 CGM.ConstructAttributeList(FnInfo, MD, AttributeList, CallingConv, true);
1353 llvm::AttributeSet Attrs =
1354 llvm::AttributeSet::get(CGF.getLLVMContext(), AttributeList);
1355
1356 // Do a musttail call with perfect argument forwarding. Any inalloca argument
1357 // will be forwarded in place without any copy.
1358 SmallVector<llvm::Value *, 8> Args;
1359 for (llvm::Argument &A : ThunkFn->args())
1360 Args.push_back(&A);
1361 llvm::CallInst *Call = CGF.Builder.CreateCall(Callee, Args);
1362 Call->setTailCallKind(llvm::CallInst::TCK_MustTail);
1363 Call->setAttributes(Attrs);
1364 Call->setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
1365
1366 if (Call->getType()->isVoidTy())
1367 CGF.Builder.CreateRetVoid();
1368 else
1369 CGF.Builder.CreateRet(Call);
1370
1371 // Finish the function to maintain CodeGenFunction invariants.
1372 // FIXME: Don't emit unreachable code.
1373 CGF.EmitBlock(CGF.createBasicBlock());
1374 CGF.FinishFunction();
Hans Wennborg88497d62013-11-15 17:24:45 +00001375
1376 return ThunkFn;
1377}
1378
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001379void MicrosoftCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001380 const VBTableGlobals &VBGlobals = enumerateVBTables(RD);
1381 for (unsigned I = 0, E = VBGlobals.VBTables->size(); I != E; ++I) {
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001382 const VPtrInfo *VBT = (*VBGlobals.VBTables)[I];
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001383 llvm::GlobalVariable *GV = VBGlobals.Globals[I];
Reid Kleckner5f080942014-01-03 23:42:00 +00001384 emitVBTableDefinition(*VBT, RD, GV);
Reid Kleckner7810af02013-06-19 15:20:38 +00001385 }
1386}
1387
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001388llvm::GlobalVariable *
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001389MicrosoftCXXABI::getAddrOfVBTable(const VPtrInfo &VBT, const CXXRecordDecl *RD,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001390 llvm::GlobalVariable::LinkageTypes Linkage) {
1391 SmallString<256> OutName;
1392 llvm::raw_svector_ostream Out(OutName);
1393 MicrosoftMangleContext &Mangler =
1394 cast<MicrosoftMangleContext>(CGM.getCXXABI().getMangleContext());
1395 Mangler.mangleCXXVBTable(RD, VBT.MangledPath, Out);
1396 Out.flush();
1397 StringRef Name = OutName.str();
1398
1399 llvm::ArrayType *VBTableType =
1400 llvm::ArrayType::get(CGM.IntTy, 1 + VBT.ReusingBase->getNumVBases());
1401
1402 assert(!CGM.getModule().getNamedGlobal(Name) &&
1403 "vbtable with this name already exists: mangling bug?");
1404 llvm::GlobalVariable *GV =
1405 CGM.CreateOrReplaceCXXRuntimeVariable(Name, VBTableType, Linkage);
1406 GV->setUnnamedAddr(true);
Hans Wennborg853ae942014-05-30 16:59:42 +00001407
1408 if (RD->hasAttr<DLLImportAttr>())
1409 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1410 else if (RD->hasAttr<DLLExportAttr>())
1411 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1412
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001413 return GV;
1414}
1415
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001416void MicrosoftCXXABI::emitVBTableDefinition(const VPtrInfo &VBT,
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001417 const CXXRecordDecl *RD,
1418 llvm::GlobalVariable *GV) const {
1419 const CXXRecordDecl *ReusingBase = VBT.ReusingBase;
1420
1421 assert(RD->getNumVBases() && ReusingBase->getNumVBases() &&
1422 "should only emit vbtables for classes with vbtables");
1423
1424 const ASTRecordLayout &BaseLayout =
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001425 CGM.getContext().getASTRecordLayout(VBT.BaseWithVPtr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001426 const ASTRecordLayout &DerivedLayout =
1427 CGM.getContext().getASTRecordLayout(RD);
1428
Craig Topper8a13c412014-05-21 05:09:00 +00001429 SmallVector<llvm::Constant *, 4> Offsets(1 + ReusingBase->getNumVBases(),
1430 nullptr);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001431
1432 // The offset from ReusingBase's vbptr to itself always leads.
1433 CharUnits VBPtrOffset = BaseLayout.getVBPtrOffset();
1434 Offsets[0] = llvm::ConstantInt::get(CGM.IntTy, -VBPtrOffset.getQuantity());
1435
1436 MicrosoftVTableContext &Context = CGM.getMicrosoftVTableContext();
Aaron Ballman445a9392014-03-13 16:15:17 +00001437 for (const auto &I : ReusingBase->vbases()) {
1438 const CXXRecordDecl *VBase = I.getType()->getAsCXXRecordDecl();
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001439 CharUnits Offset = DerivedLayout.getVBaseClassOffset(VBase);
1440 assert(!Offset.isNegative());
Reid Kleckner5f080942014-01-03 23:42:00 +00001441
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001442 // Make it relative to the subobject vbptr.
Reid Kleckner5f080942014-01-03 23:42:00 +00001443 CharUnits CompleteVBPtrOffset = VBT.NonVirtualOffset + VBPtrOffset;
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001444 if (VBT.getVBaseWithVPtr())
Reid Kleckner5f080942014-01-03 23:42:00 +00001445 CompleteVBPtrOffset +=
Reid Kleckner9c6e9e32014-02-27 19:40:09 +00001446 DerivedLayout.getVBaseClassOffset(VBT.getVBaseWithVPtr());
Reid Kleckner5f080942014-01-03 23:42:00 +00001447 Offset -= CompleteVBPtrOffset;
1448
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001449 unsigned VBIndex = Context.getVBTableIndex(ReusingBase, VBase);
Craig Topper8a13c412014-05-21 05:09:00 +00001450 assert(Offsets[VBIndex] == nullptr && "The same vbindex seen twice?");
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001451 Offsets[VBIndex] = llvm::ConstantInt::get(CGM.IntTy, Offset.getQuantity());
1452 }
1453
1454 assert(Offsets.size() ==
1455 cast<llvm::ArrayType>(cast<llvm::PointerType>(GV->getType())
1456 ->getElementType())->getNumElements());
1457 llvm::ArrayType *VBTableType =
1458 llvm::ArrayType::get(CGM.IntTy, Offsets.size());
1459 llvm::Constant *Init = llvm::ConstantArray::get(VBTableType, Offsets);
1460 GV->setInitializer(Init);
1461
1462 // Set the right visibility.
John McCall8f80a612014-02-08 00:41:16 +00001463 CGM.setGlobalVisibility(GV, RD);
Reid Klecknerb40a27d2014-01-03 00:14:35 +00001464}
1465
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001466llvm::Value *MicrosoftCXXABI::performThisAdjustment(CodeGenFunction &CGF,
1467 llvm::Value *This,
1468 const ThisAdjustment &TA) {
1469 if (TA.isEmpty())
1470 return This;
1471
1472 llvm::Value *V = CGF.Builder.CreateBitCast(This, CGF.Int8PtrTy);
1473
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00001474 if (!TA.Virtual.isEmpty()) {
1475 assert(TA.Virtual.Microsoft.VtordispOffset < 0);
1476 // Adjust the this argument based on the vtordisp value.
1477 llvm::Value *VtorDispPtr =
1478 CGF.Builder.CreateConstGEP1_32(V, TA.Virtual.Microsoft.VtordispOffset);
1479 VtorDispPtr =
1480 CGF.Builder.CreateBitCast(VtorDispPtr, CGF.Int32Ty->getPointerTo());
1481 llvm::Value *VtorDisp = CGF.Builder.CreateLoad(VtorDispPtr, "vtordisp");
1482 V = CGF.Builder.CreateGEP(V, CGF.Builder.CreateNeg(VtorDisp));
1483
1484 if (TA.Virtual.Microsoft.VBPtrOffset) {
1485 // If the final overrider is defined in a virtual base other than the one
1486 // that holds the vfptr, we have to use a vtordispex thunk which looks up
1487 // the vbtable of the derived class.
1488 assert(TA.Virtual.Microsoft.VBPtrOffset > 0);
1489 assert(TA.Virtual.Microsoft.VBOffsetOffset >= 0);
1490 llvm::Value *VBPtr;
1491 llvm::Value *VBaseOffset =
1492 GetVBaseOffsetFromVBPtr(CGF, V, -TA.Virtual.Microsoft.VBPtrOffset,
1493 TA.Virtual.Microsoft.VBOffsetOffset, &VBPtr);
1494 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
1495 }
1496 }
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001497
1498 if (TA.NonVirtual) {
1499 // Non-virtual adjustment might result in a pointer outside the allocated
1500 // object, e.g. if the final overrider class is laid out after the virtual
1501 // base that declares a method in the most derived class.
1502 V = CGF.Builder.CreateConstGEP1_32(V, TA.NonVirtual);
1503 }
1504
1505 // Don't need to bitcast back, the call CodeGen will handle this.
1506 return V;
1507}
1508
1509llvm::Value *
1510MicrosoftCXXABI::performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
1511 const ReturnAdjustment &RA) {
1512 if (RA.isEmpty())
1513 return Ret;
1514
1515 llvm::Value *V = CGF.Builder.CreateBitCast(Ret, CGF.Int8PtrTy);
1516
1517 if (RA.Virtual.Microsoft.VBIndex) {
1518 assert(RA.Virtual.Microsoft.VBIndex > 0);
1519 int32_t IntSize =
1520 getContext().getTypeSizeInChars(getContext().IntTy).getQuantity();
1521 llvm::Value *VBPtr;
1522 llvm::Value *VBaseOffset =
1523 GetVBaseOffsetFromVBPtr(CGF, V, RA.Virtual.Microsoft.VBPtrOffset,
1524 IntSize * RA.Virtual.Microsoft.VBIndex, &VBPtr);
1525 V = CGF.Builder.CreateInBoundsGEP(VBPtr, VBaseOffset);
1526 }
1527
1528 if (RA.NonVirtual)
1529 V = CGF.Builder.CreateConstInBoundsGEP1_32(V, RA.NonVirtual);
1530
1531 // Cast back to the original type.
1532 return CGF.Builder.CreateBitCast(V, Ret->getType());
1533}
1534
John McCallb91cd662012-05-01 05:23:51 +00001535bool MicrosoftCXXABI::requiresArrayCookie(const CXXDeleteExpr *expr,
1536 QualType elementType) {
1537 // Microsoft seems to completely ignore the possibility of a
1538 // two-argument usual deallocation function.
1539 return elementType.isDestructedType();
1540}
1541
1542bool MicrosoftCXXABI::requiresArrayCookie(const CXXNewExpr *expr) {
1543 // Microsoft seems to completely ignore the possibility of a
1544 // two-argument usual deallocation function.
1545 return expr->getAllocatedType().isDestructedType();
1546}
1547
1548CharUnits MicrosoftCXXABI::getArrayCookieSizeImpl(QualType type) {
1549 // The array cookie is always a size_t; we then pad that out to the
1550 // alignment of the element type.
1551 ASTContext &Ctx = getContext();
1552 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
1553 Ctx.getTypeAlignInChars(type));
1554}
1555
1556llvm::Value *MicrosoftCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
1557 llvm::Value *allocPtr,
1558 CharUnits cookieSize) {
Micah Villmowea2fea22012-10-25 15:39:14 +00001559 unsigned AS = allocPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001560 llvm::Value *numElementsPtr =
1561 CGF.Builder.CreateBitCast(allocPtr, CGF.SizeTy->getPointerTo(AS));
1562 return CGF.Builder.CreateLoad(numElementsPtr);
1563}
1564
1565llvm::Value* MicrosoftCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
1566 llvm::Value *newPtr,
1567 llvm::Value *numElements,
1568 const CXXNewExpr *expr,
1569 QualType elementType) {
1570 assert(requiresArrayCookie(expr));
1571
1572 // The size of the cookie.
1573 CharUnits cookieSize = getArrayCookieSizeImpl(elementType);
1574
1575 // Compute an offset to the cookie.
1576 llvm::Value *cookiePtr = newPtr;
1577
1578 // Write the number of elements into the appropriate slot.
Micah Villmowea2fea22012-10-25 15:39:14 +00001579 unsigned AS = newPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001580 llvm::Value *numElementsPtr
1581 = CGF.Builder.CreateBitCast(cookiePtr, CGF.SizeTy->getPointerTo(AS));
1582 CGF.Builder.CreateStore(numElements, numElementsPtr);
1583
1584 // Finally, compute a pointer to the actual data buffer by skipping
1585 // over the cookie completely.
1586 return CGF.Builder.CreateConstInBoundsGEP1_64(newPtr,
1587 cookieSize.getQuantity());
1588}
1589
John McCallc84ed6a2012-05-01 06:13:13 +00001590void MicrosoftCXXABI::EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +00001591 llvm::GlobalVariable *GV,
John McCallc84ed6a2012-05-01 06:13:13 +00001592 bool PerformInit) {
Reid Kleckner563f0e82014-05-23 21:13:45 +00001593 // MSVC only uses guards for static locals.
1594 if (!D.isStaticLocal()) {
1595 assert(GV->hasWeakLinkage() || GV->hasLinkOnceLinkage());
1596 // GlobalOpt is allowed to discard the initializer, so use linkonce_odr.
1597 CGF.CurFn->setLinkage(llvm::GlobalValue::LinkOnceODRLinkage);
1598 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
1599 return;
1600 }
1601
Reid Klecknerd8110b62013-09-10 20:14:30 +00001602 // MSVC always uses an i32 bitfield to guard initialization, which is *not*
1603 // threadsafe. Since the user may be linking in inline functions compiled by
1604 // cl.exe, there's no reason to provide a false sense of security by using
1605 // critical sections here.
John McCallc84ed6a2012-05-01 06:13:13 +00001606
Richard Smithdbf74ba2013-04-14 23:01:42 +00001607 if (D.getTLSKind())
1608 CGM.ErrorUnsupported(&D, "dynamic TLS initialization");
1609
Reid Klecknerd8110b62013-09-10 20:14:30 +00001610 CGBuilderTy &Builder = CGF.Builder;
1611 llvm::IntegerType *GuardTy = CGF.Int32Ty;
1612 llvm::ConstantInt *Zero = llvm::ConstantInt::get(GuardTy, 0);
1613
1614 // Get the guard variable for this function if we have one already.
Reid Kleckner563f0e82014-05-23 21:13:45 +00001615 GuardInfo *GI = &GuardVariableMap[D.getDeclContext()];
Reid Klecknerd8110b62013-09-10 20:14:30 +00001616
1617 unsigned BitIndex;
Reid Klecknere9591b32014-04-23 18:22:11 +00001618 if (D.isStaticLocal() && D.isExternallyVisible()) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00001619 // Externally visible variables have to be numbered in Sema to properly
1620 // handle unreachable VarDecls.
David Majnemer2206bf52014-03-05 08:57:59 +00001621 BitIndex = getContext().getStaticLocalNumber(&D);
Reid Klecknerd8110b62013-09-10 20:14:30 +00001622 assert(BitIndex > 0);
1623 BitIndex--;
1624 } else {
1625 // Non-externally visible variables are numbered here in CodeGen.
Reid Klecknere9591b32014-04-23 18:22:11 +00001626 BitIndex = GI->BitIndex++;
Reid Klecknerd8110b62013-09-10 20:14:30 +00001627 }
1628
1629 if (BitIndex >= 32) {
1630 if (D.isExternallyVisible())
1631 ErrorUnsupportedABI(CGF, "more than 32 guarded initializations");
1632 BitIndex %= 32;
Craig Topper8a13c412014-05-21 05:09:00 +00001633 GI->Guard = nullptr;
Reid Klecknerd8110b62013-09-10 20:14:30 +00001634 }
1635
1636 // Lazily create the i32 bitfield for this function.
Reid Klecknere9591b32014-04-23 18:22:11 +00001637 if (!GI->Guard) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00001638 // Mangle the name for the guard.
1639 SmallString<256> GuardName;
1640 {
1641 llvm::raw_svector_ostream Out(GuardName);
1642 getMangleContext().mangleStaticGuardVariable(&D, Out);
1643 Out.flush();
1644 }
1645
Hans Wennborgef2272c2014-06-18 15:55:13 +00001646 // Create the guard variable with a zero-initializer. Just absorb linkage,
1647 // visibility and dll storage class from the guarded variable.
Reid Klecknere9591b32014-04-23 18:22:11 +00001648 GI->Guard =
1649 new llvm::GlobalVariable(CGM.getModule(), GuardTy, false,
1650 GV->getLinkage(), Zero, GuardName.str());
1651 GI->Guard->setVisibility(GV->getVisibility());
Hans Wennborgef2272c2014-06-18 15:55:13 +00001652 GI->Guard->setDLLStorageClass(GV->getDLLStorageClass());
Reid Klecknerd8110b62013-09-10 20:14:30 +00001653 } else {
Reid Klecknere9591b32014-04-23 18:22:11 +00001654 assert(GI->Guard->getLinkage() == GV->getLinkage() &&
Reid Klecknerd8110b62013-09-10 20:14:30 +00001655 "static local from the same function had different linkage");
1656 }
1657
1658 // Pseudo code for the test:
1659 // if (!(GuardVar & MyGuardBit)) {
1660 // GuardVar |= MyGuardBit;
1661 // ... initialize the object ...;
1662 // }
1663
1664 // Test our bit from the guard variable.
1665 llvm::ConstantInt *Bit = llvm::ConstantInt::get(GuardTy, 1U << BitIndex);
Reid Klecknere9591b32014-04-23 18:22:11 +00001666 llvm::LoadInst *LI = Builder.CreateLoad(GI->Guard);
Reid Klecknerd8110b62013-09-10 20:14:30 +00001667 llvm::Value *IsInitialized =
1668 Builder.CreateICmpNE(Builder.CreateAnd(LI, Bit), Zero);
1669 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
1670 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
1671 Builder.CreateCondBr(IsInitialized, EndBlock, InitBlock);
1672
1673 // Set our bit in the guard variable and emit the initializer and add a global
1674 // destructor if appropriate.
1675 CGF.EmitBlock(InitBlock);
Reid Klecknere9591b32014-04-23 18:22:11 +00001676 Builder.CreateStore(Builder.CreateOr(LI, Bit), GI->Guard);
Reid Klecknerd8110b62013-09-10 20:14:30 +00001677 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
1678 Builder.CreateBr(EndBlock);
1679
1680 // Continue.
1681 CGF.EmitBlock(EndBlock);
John McCallc84ed6a2012-05-01 06:13:13 +00001682}
1683
Reid Kleckner2341ae32013-04-11 18:13:19 +00001684bool MicrosoftCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
1685 // Null-ness for function memptrs only depends on the first field, which is
1686 // the function pointer. The rest don't matter, so we can zero initialize.
1687 if (MPT->isMemberFunctionPointer())
1688 return true;
1689
1690 // The virtual base adjustment field is always -1 for null, so if we have one
1691 // we can't zero initialize. The field offset is sometimes also -1 if 0 is a
1692 // valid field offset.
David Majnemer1cdd96d2014-01-17 09:01:00 +00001693 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
1694 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00001695 return (!MSInheritanceAttr::hasVBTableOffsetField(Inheritance) &&
1696 RD->nullFieldOffsetIsZero());
Reid Kleckner2341ae32013-04-11 18:13:19 +00001697}
1698
1699llvm::Type *
1700MicrosoftCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00001701 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
1702 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00001703 llvm::SmallVector<llvm::Type *, 4> fields;
1704 if (MPT->isMemberFunctionPointer())
1705 fields.push_back(CGM.VoidPtrTy); // FunctionPointerOrVirtualThunk
1706 else
1707 fields.push_back(CGM.IntTy); // FieldOffset
1708
Reid Kleckner96f8f932014-02-05 17:27:08 +00001709 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
1710 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001711 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00001712 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001713 fields.push_back(CGM.IntTy);
Reid Kleckner96f8f932014-02-05 17:27:08 +00001714 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001715 fields.push_back(CGM.IntTy); // VirtualBaseAdjustmentOffset
1716
1717 if (fields.size() == 1)
1718 return fields[0];
1719 return llvm::StructType::get(CGM.getLLVMContext(), fields);
1720}
1721
1722void MicrosoftCXXABI::
1723GetNullMemberPointerFields(const MemberPointerType *MPT,
1724 llvm::SmallVectorImpl<llvm::Constant *> &fields) {
1725 assert(fields.empty());
David Majnemer1cdd96d2014-01-17 09:01:00 +00001726 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
1727 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00001728 if (MPT->isMemberFunctionPointer()) {
1729 // FunctionPointerOrVirtualThunk
1730 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
1731 } else {
Reid Kleckner96f8f932014-02-05 17:27:08 +00001732 if (RD->nullFieldOffsetIsZero())
Reid Kleckner2341ae32013-04-11 18:13:19 +00001733 fields.push_back(getZeroInt()); // FieldOffset
1734 else
1735 fields.push_back(getAllOnesInt()); // FieldOffset
Reid Kleckner407e8b62013-03-22 19:02:54 +00001736 }
Reid Kleckner2341ae32013-04-11 18:13:19 +00001737
Reid Kleckner96f8f932014-02-05 17:27:08 +00001738 if (MSInheritanceAttr::hasNVOffsetField(MPT->isMemberFunctionPointer(),
1739 Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001740 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00001741 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001742 fields.push_back(getZeroInt());
Reid Kleckner96f8f932014-02-05 17:27:08 +00001743 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001744 fields.push_back(getAllOnesInt());
Reid Kleckner407e8b62013-03-22 19:02:54 +00001745}
1746
1747llvm::Constant *
1748MicrosoftCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00001749 llvm::SmallVector<llvm::Constant *, 4> fields;
1750 GetNullMemberPointerFields(MPT, fields);
1751 if (fields.size() == 1)
1752 return fields[0];
1753 llvm::Constant *Res = llvm::ConstantStruct::getAnon(fields);
1754 assert(Res->getType() == ConvertMemberPointerType(MPT));
1755 return Res;
Reid Kleckner407e8b62013-03-22 19:02:54 +00001756}
1757
1758llvm::Constant *
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001759MicrosoftCXXABI::EmitFullMemberPointer(llvm::Constant *FirstField,
1760 bool IsMemberFunction,
Reid Kleckner452abac2013-05-09 21:01:17 +00001761 const CXXRecordDecl *RD,
1762 CharUnits NonVirtualBaseAdjustment)
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001763{
David Majnemer1cdd96d2014-01-17 09:01:00 +00001764 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001765
1766 // Single inheritance class member pointer are represented as scalars instead
1767 // of aggregates.
Reid Kleckner96f8f932014-02-05 17:27:08 +00001768 if (MSInheritanceAttr::hasOnlyOneField(IsMemberFunction, Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001769 return FirstField;
1770
Reid Kleckner2341ae32013-04-11 18:13:19 +00001771 llvm::SmallVector<llvm::Constant *, 4> fields;
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001772 fields.push_back(FirstField);
1773
Reid Kleckner96f8f932014-02-05 17:27:08 +00001774 if (MSInheritanceAttr::hasNVOffsetField(IsMemberFunction, Inheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00001775 fields.push_back(llvm::ConstantInt::get(
1776 CGM.IntTy, NonVirtualBaseAdjustment.getQuantity()));
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001777
Reid Kleckner96f8f932014-02-05 17:27:08 +00001778 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance)) {
Reid Kleckneraec44092013-10-15 01:18:02 +00001779 CharUnits Offs = CharUnits::Zero();
1780 if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00001781 Offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckneraec44092013-10-15 01:18:02 +00001782 fields.push_back(llvm::ConstantInt::get(CGM.IntTy, Offs.getQuantity()));
Reid Kleckner2341ae32013-04-11 18:13:19 +00001783 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001784
1785 // The rest of the fields are adjusted by conversions to a more derived class.
Reid Kleckner96f8f932014-02-05 17:27:08 +00001786 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00001787 fields.push_back(getZeroInt());
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001788
Reid Kleckner2341ae32013-04-11 18:13:19 +00001789 return llvm::ConstantStruct::getAnon(fields);
Reid Kleckner407e8b62013-03-22 19:02:54 +00001790}
1791
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001792llvm::Constant *
1793MicrosoftCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
1794 CharUnits offset) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00001795 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001796 llvm::Constant *FirstField =
1797 llvm::ConstantInt::get(CGM.IntTy, offset.getQuantity());
Reid Kleckner452abac2013-05-09 21:01:17 +00001798 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/false, RD,
1799 CharUnits::Zero());
1800}
1801
1802llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const CXXMethodDecl *MD) {
1803 return BuildMemberPointer(MD->getParent(), MD, CharUnits::Zero());
1804}
1805
1806llvm::Constant *MicrosoftCXXABI::EmitMemberPointer(const APValue &MP,
1807 QualType MPType) {
1808 const MemberPointerType *MPT = MPType->castAs<MemberPointerType>();
1809 const ValueDecl *MPD = MP.getMemberPointerDecl();
1810 if (!MPD)
1811 return EmitNullMemberPointer(MPT);
1812
1813 CharUnits ThisAdjustment = getMemberPointerPathAdjustment(MP);
1814
1815 // FIXME PR15713: Support virtual inheritance paths.
1816
1817 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD))
David Majnemer1cdd96d2014-01-17 09:01:00 +00001818 return BuildMemberPointer(MPT->getMostRecentCXXRecordDecl(), MD,
1819 ThisAdjustment);
Reid Kleckner452abac2013-05-09 21:01:17 +00001820
1821 CharUnits FieldOffset =
1822 getContext().toCharUnitsFromBits(getContext().getFieldOffset(MPD));
1823 return EmitMemberDataPointer(MPT, ThisAdjustment + FieldOffset);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001824}
1825
1826llvm::Constant *
Reid Kleckner452abac2013-05-09 21:01:17 +00001827MicrosoftCXXABI::BuildMemberPointer(const CXXRecordDecl *RD,
1828 const CXXMethodDecl *MD,
1829 CharUnits NonVirtualBaseAdjustment) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001830 assert(MD->isInstance() && "Member function must not be static!");
1831 MD = MD->getCanonicalDecl();
David Majnemer1cdd96d2014-01-17 09:01:00 +00001832 RD = RD->getMostRecentDecl();
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001833 CodeGenTypes &Types = CGM.getTypes();
1834
1835 llvm::Constant *FirstField;
Hans Wennborg88497d62013-11-15 17:24:45 +00001836 if (!MD->isVirtual()) {
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001837 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
1838 llvm::Type *Ty;
1839 // Check whether the function has a computable LLVM signature.
1840 if (Types.isFuncTypeConvertible(FPT)) {
1841 // The function has a computable LLVM signature; use the correct type.
1842 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
1843 } else {
1844 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
1845 // function type is incomplete.
1846 Ty = CGM.PtrDiffTy;
1847 }
1848 FirstField = CGM.GetAddrOfFunction(MD, Ty);
1849 FirstField = llvm::ConstantExpr::getBitCast(FirstField, CGM.VoidPtrTy);
Hans Wennborg88497d62013-11-15 17:24:45 +00001850 } else {
1851 MicrosoftVTableContext::MethodVFTableLocation ML =
1852 CGM.getMicrosoftVTableContext().getMethodVFTableLocation(MD);
1853 if (MD->isVariadic()) {
1854 CGM.ErrorUnsupported(MD, "pointer to variadic virtual member function");
1855 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
1856 } else if (!CGM.getTypes().isFuncTypeConvertible(
1857 MD->getType()->castAs<FunctionType>())) {
1858 CGM.ErrorUnsupported(MD, "pointer to virtual member function with "
1859 "incomplete return or parameter type");
1860 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
1861 } else if (ML.VBase) {
1862 CGM.ErrorUnsupported(MD, "pointer to virtual member function overriding "
1863 "member function in virtual base class");
1864 FirstField = llvm::Constant::getNullValue(CGM.VoidPtrTy);
1865 } else {
Reid Klecknere4a52202014-02-21 02:27:32 +00001866 llvm::Function *Thunk = EmitVirtualMemPtrThunk(MD, ML);
Hans Wennborg88497d62013-11-15 17:24:45 +00001867 FirstField = llvm::ConstantExpr::getBitCast(Thunk, CGM.VoidPtrTy);
Reid Klecknere4a52202014-02-21 02:27:32 +00001868 // Include the vfptr adjustment if the method is in a non-primary vftable.
1869 NonVirtualBaseAdjustment += ML.VFPtrOffset;
Hans Wennborg88497d62013-11-15 17:24:45 +00001870 }
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001871 }
1872
1873 // The rest of the fields are common with data member pointers.
Reid Kleckner452abac2013-05-09 21:01:17 +00001874 return EmitFullMemberPointer(FirstField, /*IsMemberFunction=*/true, RD,
1875 NonVirtualBaseAdjustment);
Reid Kleckner7d0efb52013-05-03 01:15:11 +00001876}
1877
Reid Kleckner700c3ee2013-04-30 20:15:14 +00001878/// Member pointers are the same if they're either bitwise identical *or* both
1879/// null. Null-ness for function members is determined by the first field,
1880/// while for data member pointers we must compare all fields.
1881llvm::Value *
1882MicrosoftCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
1883 llvm::Value *L,
1884 llvm::Value *R,
1885 const MemberPointerType *MPT,
1886 bool Inequality) {
1887 CGBuilderTy &Builder = CGF.Builder;
1888
1889 // Handle != comparisons by switching the sense of all boolean operations.
1890 llvm::ICmpInst::Predicate Eq;
1891 llvm::Instruction::BinaryOps And, Or;
1892 if (Inequality) {
1893 Eq = llvm::ICmpInst::ICMP_NE;
1894 And = llvm::Instruction::Or;
1895 Or = llvm::Instruction::And;
1896 } else {
1897 Eq = llvm::ICmpInst::ICMP_EQ;
1898 And = llvm::Instruction::And;
1899 Or = llvm::Instruction::Or;
1900 }
1901
1902 // If this is a single field member pointer (single inheritance), this is a
1903 // single icmp.
David Majnemer1cdd96d2014-01-17 09:01:00 +00001904 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
1905 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00001906 if (MSInheritanceAttr::hasOnlyOneField(MPT->isMemberFunctionPointer(),
1907 Inheritance))
Reid Kleckner700c3ee2013-04-30 20:15:14 +00001908 return Builder.CreateICmp(Eq, L, R);
1909
1910 // Compare the first field.
1911 llvm::Value *L0 = Builder.CreateExtractValue(L, 0, "lhs.0");
1912 llvm::Value *R0 = Builder.CreateExtractValue(R, 0, "rhs.0");
1913 llvm::Value *Cmp0 = Builder.CreateICmp(Eq, L0, R0, "memptr.cmp.first");
1914
1915 // Compare everything other than the first field.
Craig Topper8a13c412014-05-21 05:09:00 +00001916 llvm::Value *Res = nullptr;
Reid Kleckner700c3ee2013-04-30 20:15:14 +00001917 llvm::StructType *LType = cast<llvm::StructType>(L->getType());
1918 for (unsigned I = 1, E = LType->getNumElements(); I != E; ++I) {
1919 llvm::Value *LF = Builder.CreateExtractValue(L, I);
1920 llvm::Value *RF = Builder.CreateExtractValue(R, I);
1921 llvm::Value *Cmp = Builder.CreateICmp(Eq, LF, RF, "memptr.cmp.rest");
1922 if (Res)
1923 Res = Builder.CreateBinOp(And, Res, Cmp);
1924 else
1925 Res = Cmp;
1926 }
1927
1928 // Check if the first field is 0 if this is a function pointer.
1929 if (MPT->isMemberFunctionPointer()) {
1930 // (l1 == r1 && ...) || l0 == 0
1931 llvm::Value *Zero = llvm::Constant::getNullValue(L0->getType());
1932 llvm::Value *IsZero = Builder.CreateICmp(Eq, L0, Zero, "memptr.cmp.iszero");
1933 Res = Builder.CreateBinOp(Or, Res, IsZero);
1934 }
1935
1936 // Combine the comparison of the first field, which must always be true for
1937 // this comparison to succeeed.
1938 return Builder.CreateBinOp(And, Res, Cmp0, "memptr.cmp");
1939}
1940
Reid Kleckner407e8b62013-03-22 19:02:54 +00001941llvm::Value *
1942MicrosoftCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
1943 llvm::Value *MemPtr,
1944 const MemberPointerType *MPT) {
1945 CGBuilderTy &Builder = CGF.Builder;
Reid Kleckner2341ae32013-04-11 18:13:19 +00001946 llvm::SmallVector<llvm::Constant *, 4> fields;
1947 // We only need one field for member functions.
1948 if (MPT->isMemberFunctionPointer())
1949 fields.push_back(llvm::Constant::getNullValue(CGM.VoidPtrTy));
1950 else
1951 GetNullMemberPointerFields(MPT, fields);
1952 assert(!fields.empty());
1953 llvm::Value *FirstField = MemPtr;
1954 if (MemPtr->getType()->isStructTy())
1955 FirstField = Builder.CreateExtractValue(MemPtr, 0);
1956 llvm::Value *Res = Builder.CreateICmpNE(FirstField, fields[0], "memptr.cmp0");
Reid Kleckner407e8b62013-03-22 19:02:54 +00001957
Reid Kleckner2341ae32013-04-11 18:13:19 +00001958 // For function member pointers, we only need to test the function pointer
1959 // field. The other fields if any can be garbage.
1960 if (MPT->isMemberFunctionPointer())
1961 return Res;
1962
1963 // Otherwise, emit a series of compares and combine the results.
1964 for (int I = 1, E = fields.size(); I < E; ++I) {
1965 llvm::Value *Field = Builder.CreateExtractValue(MemPtr, I);
1966 llvm::Value *Next = Builder.CreateICmpNE(Field, fields[I], "memptr.cmp");
Reid Kleckner34a38d82014-05-02 00:05:16 +00001967 Res = Builder.CreateOr(Res, Next, "memptr.tobool");
Reid Kleckner2341ae32013-04-11 18:13:19 +00001968 }
1969 return Res;
1970}
1971
Reid Kleckner452abac2013-05-09 21:01:17 +00001972bool MicrosoftCXXABI::MemberPointerConstantIsNull(const MemberPointerType *MPT,
1973 llvm::Constant *Val) {
1974 // Function pointers are null if the pointer in the first field is null.
1975 if (MPT->isMemberFunctionPointer()) {
1976 llvm::Constant *FirstField = Val->getType()->isStructTy() ?
1977 Val->getAggregateElement(0U) : Val;
1978 return FirstField->isNullValue();
1979 }
1980
1981 // If it's not a function pointer and it's zero initializable, we can easily
1982 // check zero.
1983 if (isZeroInitializable(MPT) && Val->isNullValue())
1984 return true;
1985
1986 // Otherwise, break down all the fields for comparison. Hopefully these
1987 // little Constants are reused, while a big null struct might not be.
1988 llvm::SmallVector<llvm::Constant *, 4> Fields;
1989 GetNullMemberPointerFields(MPT, Fields);
1990 if (Fields.size() == 1) {
1991 assert(Val->getType()->isIntegerTy());
1992 return Val == Fields[0];
1993 }
1994
1995 unsigned I, E;
1996 for (I = 0, E = Fields.size(); I != E; ++I) {
1997 if (Val->getAggregateElement(I) != Fields[I])
1998 break;
1999 }
2000 return I == E;
2001}
2002
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002003llvm::Value *
2004MicrosoftCXXABI::GetVBaseOffsetFromVBPtr(CodeGenFunction &CGF,
2005 llvm::Value *This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002006 llvm::Value *VBPtrOffset,
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002007 llvm::Value *VBTableOffset,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002008 llvm::Value **VBPtrOut) {
2009 CGBuilderTy &Builder = CGF.Builder;
2010 // Load the vbtable pointer from the vbptr in the instance.
2011 This = Builder.CreateBitCast(This, CGM.Int8PtrTy);
2012 llvm::Value *VBPtr =
2013 Builder.CreateInBoundsGEP(This, VBPtrOffset, "vbptr");
2014 if (VBPtrOut) *VBPtrOut = VBPtr;
2015 VBPtr = Builder.CreateBitCast(VBPtr, CGM.Int8PtrTy->getPointerTo(0));
2016 llvm::Value *VBTable = Builder.CreateLoad(VBPtr, "vbtable");
2017
2018 // Load an i32 offset from the vb-table.
2019 llvm::Value *VBaseOffs = Builder.CreateInBoundsGEP(VBTable, VBTableOffset);
2020 VBaseOffs = Builder.CreateBitCast(VBaseOffs, CGM.Int32Ty->getPointerTo(0));
2021 return Builder.CreateLoad(VBaseOffs, "vbase_offs");
2022}
2023
Reid Kleckner2341ae32013-04-11 18:13:19 +00002024// Returns an adjusted base cast to i8*, since we do more address arithmetic on
2025// it.
David Majnemer2b0d66d2014-02-20 23:22:07 +00002026llvm::Value *MicrosoftCXXABI::AdjustVirtualBase(
2027 CodeGenFunction &CGF, const Expr *E, const CXXRecordDecl *RD,
2028 llvm::Value *Base, llvm::Value *VBTableOffset, llvm::Value *VBPtrOffset) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002029 CGBuilderTy &Builder = CGF.Builder;
2030 Base = Builder.CreateBitCast(Base, CGM.Int8PtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +00002031 llvm::BasicBlock *OriginalBB = nullptr;
2032 llvm::BasicBlock *SkipAdjustBB = nullptr;
2033 llvm::BasicBlock *VBaseAdjustBB = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002034
2035 // In the unspecified inheritance model, there might not be a vbtable at all,
2036 // in which case we need to skip the virtual base lookup. If there is a
2037 // vbtable, the first entry is a no-op entry that gives back the original
2038 // base, so look for a virtual base adjustment offset of zero.
2039 if (VBPtrOffset) {
2040 OriginalBB = Builder.GetInsertBlock();
2041 VBaseAdjustBB = CGF.createBasicBlock("memptr.vadjust");
2042 SkipAdjustBB = CGF.createBasicBlock("memptr.skip_vadjust");
2043 llvm::Value *IsVirtual =
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002044 Builder.CreateICmpNE(VBTableOffset, getZeroInt(),
Reid Kleckner2341ae32013-04-11 18:13:19 +00002045 "memptr.is_vbase");
2046 Builder.CreateCondBr(IsVirtual, VBaseAdjustBB, SkipAdjustBB);
2047 CGF.EmitBlock(VBaseAdjustBB);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002048 }
2049
Reid Kleckner2341ae32013-04-11 18:13:19 +00002050 // If we weren't given a dynamic vbptr offset, RD should be complete and we'll
2051 // know the vbptr offset.
2052 if (!VBPtrOffset) {
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00002053 CharUnits offs = CharUnits::Zero();
David Majnemer2b0d66d2014-02-20 23:22:07 +00002054 if (!RD->hasDefinition()) {
2055 DiagnosticsEngine &Diags = CGF.CGM.getDiags();
2056 unsigned DiagID = Diags.getCustomDiagID(
2057 DiagnosticsEngine::Error,
2058 "member pointer representation requires a "
2059 "complete class type for %0 to perform this expression");
2060 Diags.Report(E->getExprLoc(), DiagID) << RD << E->getSourceRange();
2061 } else if (RD->getNumVBases())
Reid Kleckner5b1b5d52014-01-14 00:50:39 +00002062 offs = getContext().getASTRecordLayout(RD).getVBPtrOffset();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002063 VBPtrOffset = llvm::ConstantInt::get(CGM.IntTy, offs.getQuantity());
2064 }
Craig Topper8a13c412014-05-21 05:09:00 +00002065 llvm::Value *VBPtr = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002066 llvm::Value *VBaseOffs =
Timur Iskhodzhanov07e6eff2013-10-27 17:10:27 +00002067 GetVBaseOffsetFromVBPtr(CGF, Base, VBPtrOffset, VBTableOffset, &VBPtr);
Reid Kleckner2341ae32013-04-11 18:13:19 +00002068 llvm::Value *AdjustedBase = Builder.CreateInBoundsGEP(VBPtr, VBaseOffs);
2069
2070 // Merge control flow with the case where we didn't have to adjust.
2071 if (VBaseAdjustBB) {
2072 Builder.CreateBr(SkipAdjustBB);
2073 CGF.EmitBlock(SkipAdjustBB);
2074 llvm::PHINode *Phi = Builder.CreatePHI(CGM.Int8PtrTy, 2, "memptr.base");
2075 Phi->addIncoming(Base, OriginalBB);
2076 Phi->addIncoming(AdjustedBase, VBaseAdjustBB);
2077 return Phi;
2078 }
2079 return AdjustedBase;
Reid Kleckner407e8b62013-03-22 19:02:54 +00002080}
2081
David Majnemer2b0d66d2014-02-20 23:22:07 +00002082llvm::Value *MicrosoftCXXABI::EmitMemberDataPointerAddress(
2083 CodeGenFunction &CGF, const Expr *E, llvm::Value *Base, llvm::Value *MemPtr,
2084 const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002085 assert(MPT->isMemberDataPointer());
Reid Kleckner407e8b62013-03-22 19:02:54 +00002086 unsigned AS = Base->getType()->getPointerAddressSpace();
2087 llvm::Type *PType =
2088 CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
2089 CGBuilderTy &Builder = CGF.Builder;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002090 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
2091 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner407e8b62013-03-22 19:02:54 +00002092
Reid Kleckner2341ae32013-04-11 18:13:19 +00002093 // Extract the fields we need, regardless of model. We'll apply them if we
2094 // have them.
2095 llvm::Value *FieldOffset = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002096 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2097 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002098 if (MemPtr->getType()->isStructTy()) {
2099 // We need to extract values.
2100 unsigned I = 0;
2101 FieldOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002102 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002103 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002104 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002105 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002106 }
2107
Reid Kleckner2341ae32013-04-11 18:13:19 +00002108 if (VirtualBaseAdjustmentOffset) {
David Majnemer2b0d66d2014-02-20 23:22:07 +00002109 Base = AdjustVirtualBase(CGF, E, RD, Base, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00002110 VBPtrOffset);
Reid Kleckner407e8b62013-03-22 19:02:54 +00002111 }
Reid Klecknerae945122013-12-05 22:44:07 +00002112
2113 // Cast to char*.
2114 Base = Builder.CreateBitCast(Base, Builder.getInt8Ty()->getPointerTo(AS));
2115
2116 // Apply the offset, which we assume is non-null.
Reid Kleckner2341ae32013-04-11 18:13:19 +00002117 llvm::Value *Addr =
2118 Builder.CreateInBoundsGEP(Base, FieldOffset, "memptr.offset");
Reid Kleckner407e8b62013-03-22 19:02:54 +00002119
2120 // Cast the address to the appropriate pointer type, adopting the address
2121 // space of the base pointer.
2122 return Builder.CreateBitCast(Addr, PType);
2123}
2124
David Majnemer1cdd96d2014-01-17 09:01:00 +00002125static MSInheritanceAttr::Spelling
Reid Kleckner452abac2013-05-09 21:01:17 +00002126getInheritanceFromMemptr(const MemberPointerType *MPT) {
David Majnemer1cdd96d2014-01-17 09:01:00 +00002127 return MPT->getMostRecentCXXRecordDecl()->getMSInheritanceModel();
Reid Kleckner452abac2013-05-09 21:01:17 +00002128}
2129
2130llvm::Value *
2131MicrosoftCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
2132 const CastExpr *E,
2133 llvm::Value *Src) {
2134 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
2135 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
2136 E->getCastKind() == CK_ReinterpretMemberPointer);
2137
2138 // Use constant emission if we can.
2139 if (isa<llvm::Constant>(Src))
2140 return EmitMemberPointerConversion(E, cast<llvm::Constant>(Src));
2141
2142 // We may be adding or dropping fields from the member pointer, so we need
2143 // both types and the inheritance models of both records.
2144 const MemberPointerType *SrcTy =
2145 E->getSubExpr()->getType()->castAs<MemberPointerType>();
2146 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
Reid Kleckner452abac2013-05-09 21:01:17 +00002147 bool IsFunc = SrcTy->isMemberFunctionPointer();
2148
2149 // If the classes use the same null representation, reinterpret_cast is a nop.
2150 bool IsReinterpret = E->getCastKind() == CK_ReinterpretMemberPointer;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002151 if (IsReinterpret && IsFunc)
2152 return Src;
2153
2154 CXXRecordDecl *SrcRD = SrcTy->getMostRecentCXXRecordDecl();
2155 CXXRecordDecl *DstRD = DstTy->getMostRecentCXXRecordDecl();
2156 if (IsReinterpret &&
Reid Kleckner96f8f932014-02-05 17:27:08 +00002157 SrcRD->nullFieldOffsetIsZero() == DstRD->nullFieldOffsetIsZero())
Reid Kleckner452abac2013-05-09 21:01:17 +00002158 return Src;
2159
2160 CGBuilderTy &Builder = CGF.Builder;
2161
2162 // Branch past the conversion if Src is null.
2163 llvm::Value *IsNotNull = EmitMemberPointerIsNotNull(CGF, Src, SrcTy);
2164 llvm::Constant *DstNull = EmitNullMemberPointer(DstTy);
2165
2166 // C++ 5.2.10p9: The null member pointer value is converted to the null member
2167 // pointer value of the destination type.
2168 if (IsReinterpret) {
2169 // For reinterpret casts, sema ensures that src and dst are both functions
2170 // or data and have the same size, which means the LLVM types should match.
2171 assert(Src->getType() == DstNull->getType());
2172 return Builder.CreateSelect(IsNotNull, Src, DstNull);
2173 }
2174
2175 llvm::BasicBlock *OriginalBB = Builder.GetInsertBlock();
2176 llvm::BasicBlock *ConvertBB = CGF.createBasicBlock("memptr.convert");
2177 llvm::BasicBlock *ContinueBB = CGF.createBasicBlock("memptr.converted");
2178 Builder.CreateCondBr(IsNotNull, ConvertBB, ContinueBB);
2179 CGF.EmitBlock(ConvertBB);
2180
2181 // Decompose src.
2182 llvm::Value *FirstField = Src;
Craig Topper8a13c412014-05-21 05:09:00 +00002183 llvm::Value *NonVirtualBaseAdjustment = nullptr;
2184 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2185 llvm::Value *VBPtrOffset = nullptr;
David Majnemer1cdd96d2014-01-17 09:01:00 +00002186 MSInheritanceAttr::Spelling SrcInheritance = SrcRD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002187 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002188 // We need to extract values.
2189 unsigned I = 0;
2190 FirstField = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002191 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002192 NonVirtualBaseAdjustment = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002193 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002194 VBPtrOffset = Builder.CreateExtractValue(Src, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002195 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002196 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(Src, I++);
2197 }
2198
2199 // For data pointers, we adjust the field offset directly. For functions, we
2200 // have a separate field.
2201 llvm::Constant *Adj = getMemberPointerAdjustment(E);
2202 if (Adj) {
2203 Adj = llvm::ConstantExpr::getTruncOrBitCast(Adj, CGM.IntTy);
2204 llvm::Value *&NVAdjustField = IsFunc ? NonVirtualBaseAdjustment : FirstField;
2205 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
2206 if (!NVAdjustField) // If this field didn't exist in src, it's zero.
2207 NVAdjustField = getZeroInt();
2208 if (isDerivedToBase)
2209 NVAdjustField = Builder.CreateNSWSub(NVAdjustField, Adj, "adj");
2210 else
2211 NVAdjustField = Builder.CreateNSWAdd(NVAdjustField, Adj, "adj");
2212 }
2213
2214 // FIXME PR15713: Support conversions through virtually derived classes.
2215
2216 // Recompose dst from the null struct and the adjusted fields from src.
David Majnemer1cdd96d2014-01-17 09:01:00 +00002217 MSInheritanceAttr::Spelling DstInheritance = DstRD->getMSInheritanceModel();
Reid Kleckner452abac2013-05-09 21:01:17 +00002218 llvm::Value *Dst;
Reid Kleckner96f8f932014-02-05 17:27:08 +00002219 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002220 Dst = FirstField;
2221 } else {
2222 Dst = llvm::UndefValue::get(DstNull->getType());
2223 unsigned Idx = 0;
2224 Dst = Builder.CreateInsertValue(Dst, FirstField, Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002225 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002226 Dst = Builder.CreateInsertValue(
2227 Dst, getValueOrZeroInt(NonVirtualBaseAdjustment), Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002228 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002229 Dst = Builder.CreateInsertValue(
2230 Dst, getValueOrZeroInt(VBPtrOffset), Idx++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002231 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002232 Dst = Builder.CreateInsertValue(
2233 Dst, getValueOrZeroInt(VirtualBaseAdjustmentOffset), Idx++);
2234 }
2235 Builder.CreateBr(ContinueBB);
2236
2237 // In the continuation, choose between DstNull and Dst.
2238 CGF.EmitBlock(ContinueBB);
2239 llvm::PHINode *Phi = Builder.CreatePHI(DstNull->getType(), 2, "memptr.converted");
2240 Phi->addIncoming(DstNull, OriginalBB);
2241 Phi->addIncoming(Dst, ConvertBB);
2242 return Phi;
2243}
2244
2245llvm::Constant *
2246MicrosoftCXXABI::EmitMemberPointerConversion(const CastExpr *E,
2247 llvm::Constant *Src) {
2248 const MemberPointerType *SrcTy =
2249 E->getSubExpr()->getType()->castAs<MemberPointerType>();
2250 const MemberPointerType *DstTy = E->getType()->castAs<MemberPointerType>();
2251
2252 // If src is null, emit a new null for dst. We can't return src because dst
2253 // might have a new representation.
2254 if (MemberPointerConstantIsNull(SrcTy, Src))
2255 return EmitNullMemberPointer(DstTy);
2256
2257 // We don't need to do anything for reinterpret_casts of non-null member
2258 // pointers. We should only get here when the two type representations have
2259 // the same size.
2260 if (E->getCastKind() == CK_ReinterpretMemberPointer)
2261 return Src;
2262
David Majnemer1cdd96d2014-01-17 09:01:00 +00002263 MSInheritanceAttr::Spelling SrcInheritance = getInheritanceFromMemptr(SrcTy);
2264 MSInheritanceAttr::Spelling DstInheritance = getInheritanceFromMemptr(DstTy);
Reid Kleckner452abac2013-05-09 21:01:17 +00002265
2266 // Decompose src.
2267 llvm::Constant *FirstField = Src;
Craig Topper8a13c412014-05-21 05:09:00 +00002268 llvm::Constant *NonVirtualBaseAdjustment = nullptr;
2269 llvm::Constant *VirtualBaseAdjustmentOffset = nullptr;
2270 llvm::Constant *VBPtrOffset = nullptr;
Reid Kleckner452abac2013-05-09 21:01:17 +00002271 bool IsFunc = SrcTy->isMemberFunctionPointer();
Reid Kleckner96f8f932014-02-05 17:27:08 +00002272 if (!MSInheritanceAttr::hasOnlyOneField(IsFunc, SrcInheritance)) {
Reid Kleckner452abac2013-05-09 21:01:17 +00002273 // We need to extract values.
2274 unsigned I = 0;
2275 FirstField = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002276 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002277 NonVirtualBaseAdjustment = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002278 if (MSInheritanceAttr::hasVBPtrOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002279 VBPtrOffset = Src->getAggregateElement(I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002280 if (MSInheritanceAttr::hasVBTableOffsetField(SrcInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002281 VirtualBaseAdjustmentOffset = Src->getAggregateElement(I++);
2282 }
2283
2284 // For data pointers, we adjust the field offset directly. For functions, we
2285 // have a separate field.
2286 llvm::Constant *Adj = getMemberPointerAdjustment(E);
2287 if (Adj) {
2288 Adj = llvm::ConstantExpr::getTruncOrBitCast(Adj, CGM.IntTy);
2289 llvm::Constant *&NVAdjustField =
2290 IsFunc ? NonVirtualBaseAdjustment : FirstField;
2291 bool IsDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
2292 if (!NVAdjustField) // If this field didn't exist in src, it's zero.
2293 NVAdjustField = getZeroInt();
2294 if (IsDerivedToBase)
2295 NVAdjustField = llvm::ConstantExpr::getNSWSub(NVAdjustField, Adj);
2296 else
2297 NVAdjustField = llvm::ConstantExpr::getNSWAdd(NVAdjustField, Adj);
2298 }
2299
2300 // FIXME PR15713: Support conversions through virtually derived classes.
2301
2302 // Recompose dst from the null struct and the adjusted fields from src.
Reid Kleckner96f8f932014-02-05 17:27:08 +00002303 if (MSInheritanceAttr::hasOnlyOneField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002304 return FirstField;
2305
2306 llvm::SmallVector<llvm::Constant *, 4> Fields;
2307 Fields.push_back(FirstField);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002308 if (MSInheritanceAttr::hasNVOffsetField(IsFunc, DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002309 Fields.push_back(getConstantOrZeroInt(NonVirtualBaseAdjustment));
Reid Kleckner96f8f932014-02-05 17:27:08 +00002310 if (MSInheritanceAttr::hasVBPtrOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002311 Fields.push_back(getConstantOrZeroInt(VBPtrOffset));
Reid Kleckner96f8f932014-02-05 17:27:08 +00002312 if (MSInheritanceAttr::hasVBTableOffsetField(DstInheritance))
Reid Kleckner452abac2013-05-09 21:01:17 +00002313 Fields.push_back(getConstantOrZeroInt(VirtualBaseAdjustmentOffset));
2314 return llvm::ConstantStruct::getAnon(Fields);
2315}
2316
David Majnemer2b0d66d2014-02-20 23:22:07 +00002317llvm::Value *MicrosoftCXXABI::EmitLoadOfMemberFunctionPointer(
2318 CodeGenFunction &CGF, const Expr *E, llvm::Value *&This,
2319 llvm::Value *MemPtr, const MemberPointerType *MPT) {
Reid Kleckner2341ae32013-04-11 18:13:19 +00002320 assert(MPT->isMemberFunctionPointer());
2321 const FunctionProtoType *FPT =
2322 MPT->getPointeeType()->castAs<FunctionProtoType>();
David Majnemer1cdd96d2014-01-17 09:01:00 +00002323 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002324 llvm::FunctionType *FTy =
2325 CGM.getTypes().GetFunctionType(
2326 CGM.getTypes().arrangeCXXMethodType(RD, FPT));
2327 CGBuilderTy &Builder = CGF.Builder;
2328
David Majnemer1cdd96d2014-01-17 09:01:00 +00002329 MSInheritanceAttr::Spelling Inheritance = RD->getMSInheritanceModel();
Reid Kleckner2341ae32013-04-11 18:13:19 +00002330
2331 // Extract the fields we need, regardless of model. We'll apply them if we
2332 // have them.
2333 llvm::Value *FunctionPointer = MemPtr;
Craig Topper8a13c412014-05-21 05:09:00 +00002334 llvm::Value *NonVirtualBaseAdjustment = nullptr;
2335 llvm::Value *VirtualBaseAdjustmentOffset = nullptr;
2336 llvm::Value *VBPtrOffset = nullptr;
Reid Kleckner2341ae32013-04-11 18:13:19 +00002337 if (MemPtr->getType()->isStructTy()) {
2338 // We need to extract values.
2339 unsigned I = 0;
2340 FunctionPointer = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002341 if (MSInheritanceAttr::hasNVOffsetField(MPT, Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002342 NonVirtualBaseAdjustment = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002343 if (MSInheritanceAttr::hasVBPtrOffsetField(Inheritance))
Reid Kleckner7d0efb52013-05-03 01:15:11 +00002344 VBPtrOffset = Builder.CreateExtractValue(MemPtr, I++);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002345 if (MSInheritanceAttr::hasVBTableOffsetField(Inheritance))
Reid Kleckner2341ae32013-04-11 18:13:19 +00002346 VirtualBaseAdjustmentOffset = Builder.CreateExtractValue(MemPtr, I++);
2347 }
2348
2349 if (VirtualBaseAdjustmentOffset) {
David Majnemer2b0d66d2014-02-20 23:22:07 +00002350 This = AdjustVirtualBase(CGF, E, RD, This, VirtualBaseAdjustmentOffset,
Reid Kleckner2341ae32013-04-11 18:13:19 +00002351 VBPtrOffset);
2352 }
2353
2354 if (NonVirtualBaseAdjustment) {
2355 // Apply the adjustment and cast back to the original struct type.
2356 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy());
2357 Ptr = Builder.CreateInBoundsGEP(Ptr, NonVirtualBaseAdjustment);
2358 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted");
2359 }
2360
2361 return Builder.CreateBitCast(FunctionPointer, FTy->getPointerTo());
2362}
2363
Charles Davis53c59df2010-08-16 03:33:14 +00002364CGCXXABI *clang::CodeGen::CreateMicrosoftCXXABI(CodeGenModule &CGM) {
Charles Davis74ce8592010-06-09 23:25:41 +00002365 return new MicrosoftCXXABI(CGM);
2366}