blob: 4b1c1c255af0e51bab46284cb4fb8b1f7bacee99 [file] [log] [blame]
Charles Davis4e786dd2010-05-25 19:52:27 +00001//===------- ItaniumCXXABI.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 Itanium C++ ABI. The class
Charles Davis4e786dd2010-05-25 19:52:27 +000011// in this file generates structures that follow the Itanium C++ ABI, which is
12// documented at:
13// http://www.codesourcery.com/public/cxx-abi/abi.html
14// http://www.codesourcery.com/public/cxx-abi/abi-eh.html
John McCall86353412010-08-21 22:46:04 +000015//
16// It also supports the closely-related ARM ABI, documented at:
17// http://infocenter.arm.com/help/topic/com.arm.doc.ihi0041c/IHI0041C_cppabi.pdf
18//
Charles Davis4e786dd2010-05-25 19:52:27 +000019//===----------------------------------------------------------------------===//
20
21#include "CGCXXABI.h"
John McCall7a9aac22010-08-23 01:21:21 +000022#include "CGRecordLayout.h"
Charles Davisa325a6e2012-06-23 23:44:00 +000023#include "CGVTables.h"
John McCall475999d2010-08-22 00:05:51 +000024#include "CodeGenFunction.h"
Charles Davis4e786dd2010-05-25 19:52:27 +000025#include "CodeGenModule.h"
Craig Topperc9ee1d02012-09-15 18:47:51 +000026#include "clang/AST/Mangle.h"
27#include "clang/AST/Type.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000028#include "llvm/IR/DataLayout.h"
29#include "llvm/IR/Intrinsics.h"
30#include "llvm/IR/Value.h"
Charles Davis4e786dd2010-05-25 19:52:27 +000031
32using namespace clang;
John McCall475999d2010-08-22 00:05:51 +000033using namespace CodeGen;
Charles Davis4e786dd2010-05-25 19:52:27 +000034
35namespace {
Charles Davis53c59df2010-08-16 03:33:14 +000036class ItaniumCXXABI : public CodeGen::CGCXXABI {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +000037 /// VTables - All the vtables which have been defined.
38 llvm::DenseMap<const CXXRecordDecl *, llvm::GlobalVariable *> VTables;
39
John McCall475999d2010-08-22 00:05:51 +000040protected:
Mark Seabornedf0d382013-07-24 16:25:13 +000041 bool UseARMMethodPtrABI;
42 bool UseARMGuardVarABI;
John McCall7a9aac22010-08-23 01:21:21 +000043
Timur Iskhodzhanov67455222013-10-03 06:26:13 +000044 ItaniumMangleContext &getMangleContext() {
45 return cast<ItaniumMangleContext>(CodeGen::CGCXXABI::getMangleContext());
46 }
47
Charles Davis4e786dd2010-05-25 19:52:27 +000048public:
Mark Seabornedf0d382013-07-24 16:25:13 +000049 ItaniumCXXABI(CodeGen::CodeGenModule &CGM,
50 bool UseARMMethodPtrABI = false,
51 bool UseARMGuardVarABI = false) :
52 CGCXXABI(CGM), UseARMMethodPtrABI(UseARMMethodPtrABI),
53 UseARMGuardVarABI(UseARMGuardVarABI) { }
John McCall475999d2010-08-22 00:05:51 +000054
Craig Topper4f12f102014-03-12 06:41:41 +000055 bool isReturnTypeIndirect(const CXXRecordDecl *RD) const override {
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000056 // Structures with either a non-trivial destructor or a non-trivial
57 // copy constructor are always indirect.
58 return !RD->hasTrivialDestructor() || RD->hasNonTrivialCopyConstructor();
59 }
60
Craig Topper4f12f102014-03-12 06:41:41 +000061 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override {
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000062 // Structures with either a non-trivial destructor or a non-trivial
63 // copy constructor are always indirect.
64 if (!RD->hasTrivialDestructor() || RD->hasNonTrivialCopyConstructor())
65 return RAA_Indirect;
66 return RAA_Default;
67 }
68
Craig Topper4f12f102014-03-12 06:41:41 +000069 bool isZeroInitializable(const MemberPointerType *MPT) override;
John McCall84fa5102010-08-22 04:16:24 +000070
Craig Topper4f12f102014-03-12 06:41:41 +000071 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
John McCall7a9aac22010-08-23 01:21:21 +000072
Craig Topper4f12f102014-03-12 06:41:41 +000073 llvm::Value *
74 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF,
75 const Expr *E,
76 llvm::Value *&This,
77 llvm::Value *MemFnPtr,
78 const MemberPointerType *MPT) override;
John McCalla8bbb822010-08-22 03:04:22 +000079
Craig Topper4f12f102014-03-12 06:41:41 +000080 llvm::Value *
81 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
82 llvm::Value *Base,
83 llvm::Value *MemPtr,
84 const MemberPointerType *MPT) override;
John McCallc134eb52010-08-31 21:07:20 +000085
John McCall7a9aac22010-08-23 01:21:21 +000086 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
87 const CastExpr *E,
Craig Topper4f12f102014-03-12 06:41:41 +000088 llvm::Value *Src) override;
John McCallc62bb392012-02-15 01:22:51 +000089 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
Craig Topper4f12f102014-03-12 06:41:41 +000090 llvm::Constant *Src) override;
John McCall84fa5102010-08-22 04:16:24 +000091
Craig Topper4f12f102014-03-12 06:41:41 +000092 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
John McCall84fa5102010-08-22 04:16:24 +000093
Craig Topper4f12f102014-03-12 06:41:41 +000094 llvm::Constant *EmitMemberPointer(const CXXMethodDecl *MD) override;
John McCallf3a88602011-02-03 08:15:49 +000095 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
Craig Topper4f12f102014-03-12 06:41:41 +000096 CharUnits offset) override;
97 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Richard Smithdafff942012-01-14 04:30:29 +000098 llvm::Constant *BuildMemberPointer(const CXXMethodDecl *MD,
99 CharUnits ThisAdjustment);
John McCall1c456c82010-08-22 06:43:33 +0000100
John McCall7a9aac22010-08-23 01:21:21 +0000101 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000102 llvm::Value *L, llvm::Value *R,
John McCall7a9aac22010-08-23 01:21:21 +0000103 const MemberPointerType *MPT,
Craig Topper4f12f102014-03-12 06:41:41 +0000104 bool Inequality) override;
John McCall131d97d2010-08-22 08:30:07 +0000105
John McCall7a9aac22010-08-23 01:21:21 +0000106 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000107 llvm::Value *Addr,
108 const MemberPointerType *MPT) override;
John McCall5d865c322010-08-31 07:33:07 +0000109
Craig Topper4f12f102014-03-12 06:41:41 +0000110 llvm::Value *adjustToCompleteObject(CodeGenFunction &CGF, llvm::Value *ptr,
111 QualType type) override;
John McCall82fb8922012-09-25 10:10:39 +0000112
Craig Topper4f12f102014-03-12 06:41:41 +0000113 llvm::Value *
114 GetVirtualBaseClassOffset(CodeGenFunction &CGF, llvm::Value *This,
115 const CXXRecordDecl *ClassDecl,
116 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000117
John McCall5d865c322010-08-31 07:33:07 +0000118 void BuildConstructorSignature(const CXXConstructorDecl *Ctor,
Craig Topper4f12f102014-03-12 06:41:41 +0000119 CXXCtorType T, CanQualType &ResTy,
120 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000121
Craig Topper4f12f102014-03-12 06:41:41 +0000122 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000123
John McCall5d865c322010-08-31 07:33:07 +0000124 void BuildDestructorSignature(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000125 CXXDtorType T, CanQualType &ResTy,
126 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000127
Reid Klecknere7de47e2013-07-22 13:51:44 +0000128 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000129 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000130 // Itanium does not emit any destructor variant as an inline thunk.
131 // Delegating may occur as an optimization, but all variants are either
132 // emitted with external linkage or as linkonce if they are inline and used.
133 return false;
134 }
135
Craig Topper4f12f102014-03-12 06:41:41 +0000136 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000137
Reid Kleckner89077a12013-12-17 19:46:40 +0000138 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000139 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000140
Craig Topper4f12f102014-03-12 06:41:41 +0000141 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall8ed55a52010-09-02 09:58:18 +0000142
Reid Kleckner89077a12013-12-17 19:46:40 +0000143 unsigned addImplicitConstructorArgs(CodeGenFunction &CGF,
144 const CXXConstructorDecl *D,
145 CXXCtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000146 bool Delegating,
147 CallArgList &Args) override;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000148
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000149 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
150 CXXDtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000151 bool Delegating, llvm::Value *This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000152
Craig Topper4f12f102014-03-12 06:41:41 +0000153 void emitVTableDefinitions(CodeGenVTables &CGVT,
154 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000155
156 llvm::Value *getVTableAddressPointInStructor(
157 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
158 BaseSubobject Base, const CXXRecordDecl *NearestVBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000159 bool &NeedsVirtualOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000160
161 llvm::Constant *
162 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000163 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000164
165 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000166 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000167
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000168 llvm::Value *getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000169 llvm::Value *This,
170 llvm::Type *Ty) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000171
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000172 void EmitVirtualDestructorCall(CodeGenFunction &CGF,
173 const CXXDestructorDecl *Dtor,
174 CXXDtorType DtorType, SourceLocation CallLoc,
Craig Topper4f12f102014-03-12 06:41:41 +0000175 llvm::Value *This) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000176
Craig Topper4f12f102014-03-12 06:41:41 +0000177 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000178
Craig Topper4f12f102014-03-12 06:41:41 +0000179 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000180 // Allow inlining of thunks by emitting them with available_externally
181 // linkage together with vtables when needed.
182 if (ForVTable)
183 Thunk->setLinkage(llvm::GlobalValue::AvailableExternallyLinkage);
184 }
185
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000186 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, llvm::Value *This,
Craig Topper4f12f102014-03-12 06:41:41 +0000187 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000188
189 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000190 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000191
Craig Topper4f12f102014-03-12 06:41:41 +0000192 StringRef GetPureVirtualCallName() override { return "__cxa_pure_virtual"; }
193 StringRef GetDeletedVirtualCallName() override
194 { return "__cxa_deleted_virtual"; }
Joao Matos2ce88ef2012-07-17 17:10:11 +0000195
Craig Topper4f12f102014-03-12 06:41:41 +0000196 CharUnits getArrayCookieSizeImpl(QualType elementType) override;
John McCall8ed55a52010-09-02 09:58:18 +0000197 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
198 llvm::Value *NewPtr,
199 llvm::Value *NumElements,
John McCall284c48f2011-01-27 09:37:56 +0000200 const CXXNewExpr *expr,
Craig Topper4f12f102014-03-12 06:41:41 +0000201 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000202 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
203 llvm::Value *allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000204 CharUnits cookieSize) override;
John McCall68ff0372010-09-08 01:44:27 +0000205
John McCallcdf7ef52010-11-06 09:44:32 +0000206 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Craig Topper4f12f102014-03-12 06:41:41 +0000207 llvm::GlobalVariable *DeclPtr,
208 bool PerformInit) override;
Richard Smithdbf74ba2013-04-14 23:01:42 +0000209 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
Craig Topper4f12f102014-03-12 06:41:41 +0000210 llvm::Constant *dtor, llvm::Constant *addr) override;
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000211
212 llvm::Function *getOrCreateThreadLocalWrapper(const VarDecl *VD,
213 llvm::GlobalVariable *Var);
214 void EmitThreadLocalInitFuncs(
215 llvm::ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *> > Decls,
Craig Topper4f12f102014-03-12 06:41:41 +0000216 llvm::Function *InitFunc) override;
Richard Smith0f383742014-03-26 22:48:22 +0000217 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
218 QualType LValType) override;
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000219
Craig Topper4f12f102014-03-12 06:41:41 +0000220 bool NeedsVTTParameter(GlobalDecl GD) override;
Charles Davis4e786dd2010-05-25 19:52:27 +0000221};
John McCall86353412010-08-21 22:46:04 +0000222
223class ARMCXXABI : public ItaniumCXXABI {
224public:
Mark Seabornedf0d382013-07-24 16:25:13 +0000225 ARMCXXABI(CodeGen::CodeGenModule &CGM) :
226 ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true,
227 /* UseARMGuardVarABI = */ true) {}
John McCall5d865c322010-08-31 07:33:07 +0000228
Craig Topper4f12f102014-03-12 06:41:41 +0000229 bool HasThisReturn(GlobalDecl GD) const override {
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000230 return (isa<CXXConstructorDecl>(GD.getDecl()) || (
231 isa<CXXDestructorDecl>(GD.getDecl()) &&
232 GD.getDtorType() != Dtor_Deleting));
233 }
John McCall5d865c322010-08-31 07:33:07 +0000234
Craig Topper4f12f102014-03-12 06:41:41 +0000235 void EmitReturnFromThunk(CodeGenFunction &CGF, RValue RV,
236 QualType ResTy) override;
John McCall5d865c322010-08-31 07:33:07 +0000237
Craig Topper4f12f102014-03-12 06:41:41 +0000238 CharUnits getArrayCookieSizeImpl(QualType elementType) override;
John McCall8ed55a52010-09-02 09:58:18 +0000239 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
240 llvm::Value *NewPtr,
241 llvm::Value *NumElements,
John McCall284c48f2011-01-27 09:37:56 +0000242 const CXXNewExpr *expr,
Craig Topper4f12f102014-03-12 06:41:41 +0000243 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000244 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF, llvm::Value *allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000245 CharUnits cookieSize) override;
John McCall86353412010-08-21 22:46:04 +0000246};
Tim Northovera2ee4332014-03-29 15:09:45 +0000247
248class iOS64CXXABI : public ARMCXXABI {
249public:
250 iOS64CXXABI(CodeGen::CodeGenModule &CGM) : ARMCXXABI(CGM) {}
Tim Northover65f582f2014-03-30 17:32:48 +0000251
252 // ARM64 libraries are prepared for non-unique RTTI.
253 bool shouldRTTIBeUnique() override { return false; }
Tim Northovera2ee4332014-03-29 15:09:45 +0000254};
Charles Davis4e786dd2010-05-25 19:52:27 +0000255}
256
Charles Davis53c59df2010-08-16 03:33:14 +0000257CodeGen::CGCXXABI *CodeGen::CreateItaniumCXXABI(CodeGenModule &CGM) {
John McCallc8e01702013-04-16 22:48:15 +0000258 switch (CGM.getTarget().getCXXABI().getKind()) {
John McCall57625922013-01-25 23:36:14 +0000259 // For IR-generation purposes, there's no significant difference
260 // between the ARM and iOS ABIs.
261 case TargetCXXABI::GenericARM:
262 case TargetCXXABI::iOS:
263 return new ARMCXXABI(CGM);
Charles Davis4e786dd2010-05-25 19:52:27 +0000264
Tim Northovera2ee4332014-03-29 15:09:45 +0000265 case TargetCXXABI::iOS64:
266 return new iOS64CXXABI(CGM);
267
Tim Northover9bb857a2013-01-31 12:13:10 +0000268 // Note that AArch64 uses the generic ItaniumCXXABI class since it doesn't
269 // include the other 32-bit ARM oddities: constructor/destructor return values
270 // and array cookies.
271 case TargetCXXABI::GenericAArch64:
Mark Seabornedf0d382013-07-24 16:25:13 +0000272 return new ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true,
273 /* UseARMGuardVarABI = */ true);
Tim Northover9bb857a2013-01-31 12:13:10 +0000274
John McCall57625922013-01-25 23:36:14 +0000275 case TargetCXXABI::GenericItanium:
Mark Seabornedf0d382013-07-24 16:25:13 +0000276 if (CGM.getContext().getTargetInfo().getTriple().getArch()
277 == llvm::Triple::le32) {
278 // For PNaCl, use ARM-style method pointers so that PNaCl code
279 // does not assume anything about the alignment of function
280 // pointers.
281 return new ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true,
282 /* UseARMGuardVarABI = */ false);
283 }
John McCall57625922013-01-25 23:36:14 +0000284 return new ItaniumCXXABI(CGM);
285
286 case TargetCXXABI::Microsoft:
287 llvm_unreachable("Microsoft ABI is not Itanium-based");
288 }
289 llvm_unreachable("bad ABI kind");
John McCall86353412010-08-21 22:46:04 +0000290}
291
Chris Lattnera5f58b02011-07-09 17:41:47 +0000292llvm::Type *
John McCall7a9aac22010-08-23 01:21:21 +0000293ItaniumCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
294 if (MPT->isMemberDataPointer())
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000295 return CGM.PtrDiffTy;
296 return llvm::StructType::get(CGM.PtrDiffTy, CGM.PtrDiffTy, NULL);
John McCall1c456c82010-08-22 06:43:33 +0000297}
298
John McCalld9c6c0b2010-08-22 00:59:17 +0000299/// In the Itanium and ARM ABIs, method pointers have the form:
300/// struct { ptrdiff_t ptr; ptrdiff_t adj; } memptr;
301///
302/// In the Itanium ABI:
303/// - method pointers are virtual if (memptr.ptr & 1) is nonzero
304/// - the this-adjustment is (memptr.adj)
305/// - the virtual offset is (memptr.ptr - 1)
306///
307/// In the ARM ABI:
308/// - method pointers are virtual if (memptr.adj & 1) is nonzero
309/// - the this-adjustment is (memptr.adj >> 1)
310/// - the virtual offset is (memptr.ptr)
311/// ARM uses 'adj' for the virtual flag because Thumb functions
312/// may be only single-byte aligned.
313///
314/// If the member is virtual, the adjusted 'this' pointer points
315/// to a vtable pointer from which the virtual offset is applied.
316///
317/// If the member is non-virtual, memptr.ptr is the address of
318/// the function to call.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000319llvm::Value *ItaniumCXXABI::EmitLoadOfMemberFunctionPointer(
320 CodeGenFunction &CGF, const Expr *E, llvm::Value *&This,
321 llvm::Value *MemFnPtr, const MemberPointerType *MPT) {
John McCall475999d2010-08-22 00:05:51 +0000322 CGBuilderTy &Builder = CGF.Builder;
323
324 const FunctionProtoType *FPT =
325 MPT->getPointeeType()->getAs<FunctionProtoType>();
326 const CXXRecordDecl *RD =
327 cast<CXXRecordDecl>(MPT->getClass()->getAs<RecordType>()->getDecl());
328
Chris Lattner2192fe52011-07-18 04:24:23 +0000329 llvm::FunctionType *FTy =
John McCalla729c622012-02-17 03:33:10 +0000330 CGM.getTypes().GetFunctionType(
331 CGM.getTypes().arrangeCXXMethodType(RD, FPT));
John McCall475999d2010-08-22 00:05:51 +0000332
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000333 llvm::Constant *ptrdiff_1 = llvm::ConstantInt::get(CGM.PtrDiffTy, 1);
John McCall475999d2010-08-22 00:05:51 +0000334
John McCalld9c6c0b2010-08-22 00:59:17 +0000335 llvm::BasicBlock *FnVirtual = CGF.createBasicBlock("memptr.virtual");
336 llvm::BasicBlock *FnNonVirtual = CGF.createBasicBlock("memptr.nonvirtual");
337 llvm::BasicBlock *FnEnd = CGF.createBasicBlock("memptr.end");
338
John McCalla1dee5302010-08-22 10:59:02 +0000339 // Extract memptr.adj, which is in the second field.
340 llvm::Value *RawAdj = Builder.CreateExtractValue(MemFnPtr, 1, "memptr.adj");
John McCalld9c6c0b2010-08-22 00:59:17 +0000341
342 // Compute the true adjustment.
343 llvm::Value *Adj = RawAdj;
Mark Seabornedf0d382013-07-24 16:25:13 +0000344 if (UseARMMethodPtrABI)
John McCalld9c6c0b2010-08-22 00:59:17 +0000345 Adj = Builder.CreateAShr(Adj, ptrdiff_1, "memptr.adj.shifted");
John McCall475999d2010-08-22 00:05:51 +0000346
347 // Apply the adjustment and cast back to the original struct type
348 // for consistency.
John McCalld9c6c0b2010-08-22 00:59:17 +0000349 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy());
350 Ptr = Builder.CreateInBoundsGEP(Ptr, Adj);
351 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted");
John McCall475999d2010-08-22 00:05:51 +0000352
353 // Load the function pointer.
John McCalla1dee5302010-08-22 10:59:02 +0000354 llvm::Value *FnAsInt = Builder.CreateExtractValue(MemFnPtr, 0, "memptr.ptr");
John McCall475999d2010-08-22 00:05:51 +0000355
356 // If the LSB in the function pointer is 1, the function pointer points to
357 // a virtual function.
John McCalld9c6c0b2010-08-22 00:59:17 +0000358 llvm::Value *IsVirtual;
Mark Seabornedf0d382013-07-24 16:25:13 +0000359 if (UseARMMethodPtrABI)
John McCalld9c6c0b2010-08-22 00:59:17 +0000360 IsVirtual = Builder.CreateAnd(RawAdj, ptrdiff_1);
361 else
362 IsVirtual = Builder.CreateAnd(FnAsInt, ptrdiff_1);
363 IsVirtual = Builder.CreateIsNotNull(IsVirtual, "memptr.isvirtual");
John McCall475999d2010-08-22 00:05:51 +0000364 Builder.CreateCondBr(IsVirtual, FnVirtual, FnNonVirtual);
365
366 // In the virtual path, the adjustment left 'This' pointing to the
367 // vtable of the correct base subobject. The "function pointer" is an
John McCalld9c6c0b2010-08-22 00:59:17 +0000368 // offset within the vtable (+1 for the virtual flag on non-ARM).
John McCall475999d2010-08-22 00:05:51 +0000369 CGF.EmitBlock(FnVirtual);
370
371 // Cast the adjusted this to a pointer to vtable pointer and load.
Chris Lattner2192fe52011-07-18 04:24:23 +0000372 llvm::Type *VTableTy = Builder.getInt8PtrTy();
Richard Smith0fc7bdc2014-03-12 18:26:14 +0000373 llvm::Value *VTable = CGF.GetVTablePtr(This, VTableTy);
John McCall475999d2010-08-22 00:05:51 +0000374
375 // Apply the offset.
John McCalld9c6c0b2010-08-22 00:59:17 +0000376 llvm::Value *VTableOffset = FnAsInt;
Mark Seabornedf0d382013-07-24 16:25:13 +0000377 if (!UseARMMethodPtrABI)
378 VTableOffset = Builder.CreateSub(VTableOffset, ptrdiff_1);
John McCalld9c6c0b2010-08-22 00:59:17 +0000379 VTable = Builder.CreateGEP(VTable, VTableOffset);
John McCall475999d2010-08-22 00:05:51 +0000380
381 // Load the virtual function to call.
382 VTable = Builder.CreateBitCast(VTable, FTy->getPointerTo()->getPointerTo());
John McCalld9c6c0b2010-08-22 00:59:17 +0000383 llvm::Value *VirtualFn = Builder.CreateLoad(VTable, "memptr.virtualfn");
John McCall475999d2010-08-22 00:05:51 +0000384 CGF.EmitBranch(FnEnd);
385
386 // In the non-virtual path, the function pointer is actually a
387 // function pointer.
388 CGF.EmitBlock(FnNonVirtual);
389 llvm::Value *NonVirtualFn =
John McCalld9c6c0b2010-08-22 00:59:17 +0000390 Builder.CreateIntToPtr(FnAsInt, FTy->getPointerTo(), "memptr.nonvirtualfn");
John McCall475999d2010-08-22 00:05:51 +0000391
392 // We're done.
393 CGF.EmitBlock(FnEnd);
Jay Foad20c0f022011-03-30 11:28:58 +0000394 llvm::PHINode *Callee = Builder.CreatePHI(FTy->getPointerTo(), 2);
John McCall475999d2010-08-22 00:05:51 +0000395 Callee->addIncoming(VirtualFn, FnVirtual);
396 Callee->addIncoming(NonVirtualFn, FnNonVirtual);
397 return Callee;
398}
John McCalla8bbb822010-08-22 03:04:22 +0000399
John McCallc134eb52010-08-31 21:07:20 +0000400/// Compute an l-value by applying the given pointer-to-member to a
401/// base object.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000402llvm::Value *ItaniumCXXABI::EmitMemberDataPointerAddress(
403 CodeGenFunction &CGF, const Expr *E, llvm::Value *Base, llvm::Value *MemPtr,
404 const MemberPointerType *MPT) {
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000405 assert(MemPtr->getType() == CGM.PtrDiffTy);
John McCallc134eb52010-08-31 21:07:20 +0000406
407 CGBuilderTy &Builder = CGF.Builder;
408
Micah Villmowea2fea22012-10-25 15:39:14 +0000409 unsigned AS = Base->getType()->getPointerAddressSpace();
John McCallc134eb52010-08-31 21:07:20 +0000410
411 // Cast to char*.
412 Base = Builder.CreateBitCast(Base, Builder.getInt8Ty()->getPointerTo(AS));
413
414 // Apply the offset, which we assume is non-null.
415 llvm::Value *Addr = Builder.CreateInBoundsGEP(Base, MemPtr, "memptr.offset");
416
417 // Cast the address to the appropriate pointer type, adopting the
418 // address space of the base pointer.
Chris Lattner2192fe52011-07-18 04:24:23 +0000419 llvm::Type *PType
Douglas Gregor04f36212010-09-02 17:38:50 +0000420 = CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
John McCallc134eb52010-08-31 21:07:20 +0000421 return Builder.CreateBitCast(Addr, PType);
422}
423
John McCallc62bb392012-02-15 01:22:51 +0000424/// Perform a bitcast, derived-to-base, or base-to-derived member pointer
425/// conversion.
426///
427/// Bitcast conversions are always a no-op under Itanium.
John McCall7a9aac22010-08-23 01:21:21 +0000428///
429/// Obligatory offset/adjustment diagram:
430/// <-- offset --> <-- adjustment -->
431/// |--------------------------|----------------------|--------------------|
432/// ^Derived address point ^Base address point ^Member address point
433///
434/// So when converting a base member pointer to a derived member pointer,
435/// we add the offset to the adjustment because the address point has
436/// decreased; and conversely, when converting a derived MP to a base MP
437/// we subtract the offset from the adjustment because the address point
438/// has increased.
439///
440/// The standard forbids (at compile time) conversion to and from
441/// virtual bases, which is why we don't have to consider them here.
442///
443/// The standard forbids (at run time) casting a derived MP to a base
444/// MP when the derived MP does not point to a member of the base.
445/// This is why -1 is a reasonable choice for null data member
446/// pointers.
John McCalla1dee5302010-08-22 10:59:02 +0000447llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000448ItaniumCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
449 const CastExpr *E,
John McCallc62bb392012-02-15 01:22:51 +0000450 llvm::Value *src) {
John McCalle3027922010-08-25 11:45:40 +0000451 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
John McCallc62bb392012-02-15 01:22:51 +0000452 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
453 E->getCastKind() == CK_ReinterpretMemberPointer);
454
455 // Under Itanium, reinterprets don't require any additional processing.
456 if (E->getCastKind() == CK_ReinterpretMemberPointer) return src;
457
458 // Use constant emission if we can.
459 if (isa<llvm::Constant>(src))
460 return EmitMemberPointerConversion(E, cast<llvm::Constant>(src));
461
462 llvm::Constant *adj = getMemberPointerAdjustment(E);
463 if (!adj) return src;
John McCalla8bbb822010-08-22 03:04:22 +0000464
465 CGBuilderTy &Builder = CGF.Builder;
John McCallc62bb392012-02-15 01:22:51 +0000466 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
John McCalla8bbb822010-08-22 03:04:22 +0000467
John McCallc62bb392012-02-15 01:22:51 +0000468 const MemberPointerType *destTy =
469 E->getType()->castAs<MemberPointerType>();
John McCall1c456c82010-08-22 06:43:33 +0000470
John McCall7a9aac22010-08-23 01:21:21 +0000471 // For member data pointers, this is just a matter of adding the
472 // offset if the source is non-null.
John McCallc62bb392012-02-15 01:22:51 +0000473 if (destTy->isMemberDataPointer()) {
474 llvm::Value *dst;
475 if (isDerivedToBase)
476 dst = Builder.CreateNSWSub(src, adj, "adj");
John McCall7a9aac22010-08-23 01:21:21 +0000477 else
John McCallc62bb392012-02-15 01:22:51 +0000478 dst = Builder.CreateNSWAdd(src, adj, "adj");
John McCall7a9aac22010-08-23 01:21:21 +0000479
480 // Null check.
John McCallc62bb392012-02-15 01:22:51 +0000481 llvm::Value *null = llvm::Constant::getAllOnesValue(src->getType());
482 llvm::Value *isNull = Builder.CreateICmpEQ(src, null, "memptr.isnull");
483 return Builder.CreateSelect(isNull, src, dst);
John McCall7a9aac22010-08-23 01:21:21 +0000484 }
485
John McCalla1dee5302010-08-22 10:59:02 +0000486 // The this-adjustment is left-shifted by 1 on ARM.
Mark Seabornedf0d382013-07-24 16:25:13 +0000487 if (UseARMMethodPtrABI) {
John McCallc62bb392012-02-15 01:22:51 +0000488 uint64_t offset = cast<llvm::ConstantInt>(adj)->getZExtValue();
489 offset <<= 1;
490 adj = llvm::ConstantInt::get(adj->getType(), offset);
John McCalla1dee5302010-08-22 10:59:02 +0000491 }
492
John McCallc62bb392012-02-15 01:22:51 +0000493 llvm::Value *srcAdj = Builder.CreateExtractValue(src, 1, "src.adj");
494 llvm::Value *dstAdj;
495 if (isDerivedToBase)
496 dstAdj = Builder.CreateNSWSub(srcAdj, adj, "adj");
John McCalla1dee5302010-08-22 10:59:02 +0000497 else
John McCallc62bb392012-02-15 01:22:51 +0000498 dstAdj = Builder.CreateNSWAdd(srcAdj, adj, "adj");
John McCalla1dee5302010-08-22 10:59:02 +0000499
John McCallc62bb392012-02-15 01:22:51 +0000500 return Builder.CreateInsertValue(src, dstAdj, 1);
501}
502
503llvm::Constant *
504ItaniumCXXABI::EmitMemberPointerConversion(const CastExpr *E,
505 llvm::Constant *src) {
506 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
507 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
508 E->getCastKind() == CK_ReinterpretMemberPointer);
509
510 // Under Itanium, reinterprets don't require any additional processing.
511 if (E->getCastKind() == CK_ReinterpretMemberPointer) return src;
512
513 // If the adjustment is trivial, we don't need to do anything.
514 llvm::Constant *adj = getMemberPointerAdjustment(E);
515 if (!adj) return src;
516
517 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
518
519 const MemberPointerType *destTy =
520 E->getType()->castAs<MemberPointerType>();
521
522 // For member data pointers, this is just a matter of adding the
523 // offset if the source is non-null.
524 if (destTy->isMemberDataPointer()) {
525 // null maps to null.
526 if (src->isAllOnesValue()) return src;
527
528 if (isDerivedToBase)
529 return llvm::ConstantExpr::getNSWSub(src, adj);
530 else
531 return llvm::ConstantExpr::getNSWAdd(src, adj);
532 }
533
534 // The this-adjustment is left-shifted by 1 on ARM.
Mark Seabornedf0d382013-07-24 16:25:13 +0000535 if (UseARMMethodPtrABI) {
John McCallc62bb392012-02-15 01:22:51 +0000536 uint64_t offset = cast<llvm::ConstantInt>(adj)->getZExtValue();
537 offset <<= 1;
538 adj = llvm::ConstantInt::get(adj->getType(), offset);
539 }
540
541 llvm::Constant *srcAdj = llvm::ConstantExpr::getExtractValue(src, 1);
542 llvm::Constant *dstAdj;
543 if (isDerivedToBase)
544 dstAdj = llvm::ConstantExpr::getNSWSub(srcAdj, adj);
545 else
546 dstAdj = llvm::ConstantExpr::getNSWAdd(srcAdj, adj);
547
548 return llvm::ConstantExpr::getInsertValue(src, dstAdj, 1);
John McCalla8bbb822010-08-22 03:04:22 +0000549}
John McCall84fa5102010-08-22 04:16:24 +0000550
551llvm::Constant *
John McCall7a9aac22010-08-23 01:21:21 +0000552ItaniumCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
John McCall7a9aac22010-08-23 01:21:21 +0000553 // Itanium C++ ABI 2.3:
554 // A NULL pointer is represented as -1.
555 if (MPT->isMemberDataPointer())
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000556 return llvm::ConstantInt::get(CGM.PtrDiffTy, -1ULL, /*isSigned=*/true);
John McCalla1dee5302010-08-22 10:59:02 +0000557
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000558 llvm::Constant *Zero = llvm::ConstantInt::get(CGM.PtrDiffTy, 0);
John McCalla1dee5302010-08-22 10:59:02 +0000559 llvm::Constant *Values[2] = { Zero, Zero };
Chris Lattnere64d7ba2011-06-20 04:01:35 +0000560 return llvm::ConstantStruct::getAnon(Values);
John McCall84fa5102010-08-22 04:16:24 +0000561}
562
John McCallf3a88602011-02-03 08:15:49 +0000563llvm::Constant *
564ItaniumCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
565 CharUnits offset) {
John McCall7a9aac22010-08-23 01:21:21 +0000566 // Itanium C++ ABI 2.3:
567 // A pointer to data member is an offset from the base address of
568 // the class object containing it, represented as a ptrdiff_t
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000569 return llvm::ConstantInt::get(CGM.PtrDiffTy, offset.getQuantity());
John McCall7a9aac22010-08-23 01:21:21 +0000570}
571
John McCall2979fe02011-04-12 00:42:48 +0000572llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const CXXMethodDecl *MD) {
Richard Smithdafff942012-01-14 04:30:29 +0000573 return BuildMemberPointer(MD, CharUnits::Zero());
574}
575
576llvm::Constant *ItaniumCXXABI::BuildMemberPointer(const CXXMethodDecl *MD,
577 CharUnits ThisAdjustment) {
John McCalla1dee5302010-08-22 10:59:02 +0000578 assert(MD->isInstance() && "Member function must not be static!");
579 MD = MD->getCanonicalDecl();
580
581 CodeGenTypes &Types = CGM.getTypes();
John McCalla1dee5302010-08-22 10:59:02 +0000582
583 // Get the function pointer (or index if this is a virtual function).
584 llvm::Constant *MemPtr[2];
585 if (MD->isVirtual()) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000586 uint64_t Index = CGM.getItaniumVTableContext().getMethodVTableIndex(MD);
John McCalla1dee5302010-08-22 10:59:02 +0000587
Ken Dyckdf016282011-04-09 01:30:02 +0000588 const ASTContext &Context = getContext();
589 CharUnits PointerWidth =
Douglas Gregore8bbc122011-09-02 00:18:52 +0000590 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
Ken Dyckdf016282011-04-09 01:30:02 +0000591 uint64_t VTableOffset = (Index * PointerWidth.getQuantity());
John McCalla1dee5302010-08-22 10:59:02 +0000592
Mark Seabornedf0d382013-07-24 16:25:13 +0000593 if (UseARMMethodPtrABI) {
John McCalla1dee5302010-08-22 10:59:02 +0000594 // ARM C++ ABI 3.2.1:
595 // This ABI specifies that adj contains twice the this
596 // adjustment, plus 1 if the member function is virtual. The
597 // least significant bit of adj then makes exactly the same
598 // discrimination as the least significant bit of ptr does for
599 // Itanium.
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000600 MemPtr[0] = llvm::ConstantInt::get(CGM.PtrDiffTy, VTableOffset);
601 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy,
Richard Smithdafff942012-01-14 04:30:29 +0000602 2 * ThisAdjustment.getQuantity() + 1);
John McCalla1dee5302010-08-22 10:59:02 +0000603 } else {
604 // Itanium C++ ABI 2.3:
605 // For a virtual function, [the pointer field] is 1 plus the
606 // virtual table offset (in bytes) of the function,
607 // represented as a ptrdiff_t.
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000608 MemPtr[0] = llvm::ConstantInt::get(CGM.PtrDiffTy, VTableOffset + 1);
609 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy,
Richard Smithdafff942012-01-14 04:30:29 +0000610 ThisAdjustment.getQuantity());
John McCalla1dee5302010-08-22 10:59:02 +0000611 }
612 } else {
John McCall2979fe02011-04-12 00:42:48 +0000613 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Chris Lattner2192fe52011-07-18 04:24:23 +0000614 llvm::Type *Ty;
John McCall2979fe02011-04-12 00:42:48 +0000615 // Check whether the function has a computable LLVM signature.
Chris Lattner8806e322011-07-10 00:18:59 +0000616 if (Types.isFuncTypeConvertible(FPT)) {
John McCall2979fe02011-04-12 00:42:48 +0000617 // The function has a computable LLVM signature; use the correct type.
John McCalla729c622012-02-17 03:33:10 +0000618 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
John McCalla1dee5302010-08-22 10:59:02 +0000619 } else {
John McCall2979fe02011-04-12 00:42:48 +0000620 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
621 // function type is incomplete.
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000622 Ty = CGM.PtrDiffTy;
John McCalla1dee5302010-08-22 10:59:02 +0000623 }
John McCall2979fe02011-04-12 00:42:48 +0000624 llvm::Constant *addr = CGM.GetAddrOfFunction(MD, Ty);
John McCalla1dee5302010-08-22 10:59:02 +0000625
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000626 MemPtr[0] = llvm::ConstantExpr::getPtrToInt(addr, CGM.PtrDiffTy);
Mark Seabornedf0d382013-07-24 16:25:13 +0000627 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy,
628 (UseARMMethodPtrABI ? 2 : 1) *
Richard Smithdafff942012-01-14 04:30:29 +0000629 ThisAdjustment.getQuantity());
John McCalla1dee5302010-08-22 10:59:02 +0000630 }
John McCall1c456c82010-08-22 06:43:33 +0000631
Chris Lattnere64d7ba2011-06-20 04:01:35 +0000632 return llvm::ConstantStruct::getAnon(MemPtr);
John McCall1c456c82010-08-22 06:43:33 +0000633}
634
Richard Smithdafff942012-01-14 04:30:29 +0000635llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const APValue &MP,
636 QualType MPType) {
637 const MemberPointerType *MPT = MPType->castAs<MemberPointerType>();
638 const ValueDecl *MPD = MP.getMemberPointerDecl();
639 if (!MPD)
640 return EmitNullMemberPointer(MPT);
641
Reid Kleckner452abac2013-05-09 21:01:17 +0000642 CharUnits ThisAdjustment = getMemberPointerPathAdjustment(MP);
Richard Smithdafff942012-01-14 04:30:29 +0000643
644 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD))
645 return BuildMemberPointer(MD, ThisAdjustment);
646
647 CharUnits FieldOffset =
648 getContext().toCharUnitsFromBits(getContext().getFieldOffset(MPD));
649 return EmitMemberDataPointer(MPT, ThisAdjustment + FieldOffset);
650}
651
John McCall131d97d2010-08-22 08:30:07 +0000652/// The comparison algorithm is pretty easy: the member pointers are
653/// the same if they're either bitwise identical *or* both null.
654///
655/// ARM is different here only because null-ness is more complicated.
656llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000657ItaniumCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
658 llvm::Value *L,
659 llvm::Value *R,
660 const MemberPointerType *MPT,
661 bool Inequality) {
John McCall131d97d2010-08-22 08:30:07 +0000662 CGBuilderTy &Builder = CGF.Builder;
663
John McCall131d97d2010-08-22 08:30:07 +0000664 llvm::ICmpInst::Predicate Eq;
665 llvm::Instruction::BinaryOps And, Or;
666 if (Inequality) {
667 Eq = llvm::ICmpInst::ICMP_NE;
668 And = llvm::Instruction::Or;
669 Or = llvm::Instruction::And;
670 } else {
671 Eq = llvm::ICmpInst::ICMP_EQ;
672 And = llvm::Instruction::And;
673 Or = llvm::Instruction::Or;
674 }
675
John McCall7a9aac22010-08-23 01:21:21 +0000676 // Member data pointers are easy because there's a unique null
677 // value, so it just comes down to bitwise equality.
678 if (MPT->isMemberDataPointer())
679 return Builder.CreateICmp(Eq, L, R);
680
681 // For member function pointers, the tautologies are more complex.
682 // The Itanium tautology is:
John McCall61a14882010-08-23 06:56:36 +0000683 // (L == R) <==> (L.ptr == R.ptr && (L.ptr == 0 || L.adj == R.adj))
John McCall7a9aac22010-08-23 01:21:21 +0000684 // The ARM tautology is:
John McCall61a14882010-08-23 06:56:36 +0000685 // (L == R) <==> (L.ptr == R.ptr &&
686 // (L.adj == R.adj ||
687 // (L.ptr == 0 && ((L.adj|R.adj) & 1) == 0)))
John McCall7a9aac22010-08-23 01:21:21 +0000688 // The inequality tautologies have exactly the same structure, except
689 // applying De Morgan's laws.
690
691 llvm::Value *LPtr = Builder.CreateExtractValue(L, 0, "lhs.memptr.ptr");
692 llvm::Value *RPtr = Builder.CreateExtractValue(R, 0, "rhs.memptr.ptr");
693
John McCall131d97d2010-08-22 08:30:07 +0000694 // This condition tests whether L.ptr == R.ptr. This must always be
695 // true for equality to hold.
696 llvm::Value *PtrEq = Builder.CreateICmp(Eq, LPtr, RPtr, "cmp.ptr");
697
698 // This condition, together with the assumption that L.ptr == R.ptr,
699 // tests whether the pointers are both null. ARM imposes an extra
700 // condition.
701 llvm::Value *Zero = llvm::Constant::getNullValue(LPtr->getType());
702 llvm::Value *EqZero = Builder.CreateICmp(Eq, LPtr, Zero, "cmp.ptr.null");
703
704 // This condition tests whether L.adj == R.adj. If this isn't
705 // true, the pointers are unequal unless they're both null.
John McCalla1dee5302010-08-22 10:59:02 +0000706 llvm::Value *LAdj = Builder.CreateExtractValue(L, 1, "lhs.memptr.adj");
707 llvm::Value *RAdj = Builder.CreateExtractValue(R, 1, "rhs.memptr.adj");
John McCall131d97d2010-08-22 08:30:07 +0000708 llvm::Value *AdjEq = Builder.CreateICmp(Eq, LAdj, RAdj, "cmp.adj");
709
710 // Null member function pointers on ARM clear the low bit of Adj,
711 // so the zero condition has to check that neither low bit is set.
Mark Seabornedf0d382013-07-24 16:25:13 +0000712 if (UseARMMethodPtrABI) {
John McCall131d97d2010-08-22 08:30:07 +0000713 llvm::Value *One = llvm::ConstantInt::get(LPtr->getType(), 1);
714
715 // Compute (l.adj | r.adj) & 1 and test it against zero.
716 llvm::Value *OrAdj = Builder.CreateOr(LAdj, RAdj, "or.adj");
717 llvm::Value *OrAdjAnd1 = Builder.CreateAnd(OrAdj, One);
718 llvm::Value *OrAdjAnd1EqZero = Builder.CreateICmp(Eq, OrAdjAnd1, Zero,
719 "cmp.or.adj");
720 EqZero = Builder.CreateBinOp(And, EqZero, OrAdjAnd1EqZero);
721 }
722
723 // Tie together all our conditions.
724 llvm::Value *Result = Builder.CreateBinOp(Or, EqZero, AdjEq);
725 Result = Builder.CreateBinOp(And, PtrEq, Result,
726 Inequality ? "memptr.ne" : "memptr.eq");
727 return Result;
728}
729
730llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000731ItaniumCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
732 llvm::Value *MemPtr,
733 const MemberPointerType *MPT) {
John McCall131d97d2010-08-22 08:30:07 +0000734 CGBuilderTy &Builder = CGF.Builder;
John McCall7a9aac22010-08-23 01:21:21 +0000735
736 /// For member data pointers, this is just a check against -1.
737 if (MPT->isMemberDataPointer()) {
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000738 assert(MemPtr->getType() == CGM.PtrDiffTy);
John McCall7a9aac22010-08-23 01:21:21 +0000739 llvm::Value *NegativeOne =
740 llvm::Constant::getAllOnesValue(MemPtr->getType());
741 return Builder.CreateICmpNE(MemPtr, NegativeOne, "memptr.tobool");
742 }
John McCall131d97d2010-08-22 08:30:07 +0000743
Daniel Dunbar914bc412011-04-19 23:10:47 +0000744 // In Itanium, a member function pointer is not null if 'ptr' is not null.
John McCalla1dee5302010-08-22 10:59:02 +0000745 llvm::Value *Ptr = Builder.CreateExtractValue(MemPtr, 0, "memptr.ptr");
John McCall131d97d2010-08-22 08:30:07 +0000746
747 llvm::Constant *Zero = llvm::ConstantInt::get(Ptr->getType(), 0);
748 llvm::Value *Result = Builder.CreateICmpNE(Ptr, Zero, "memptr.tobool");
749
Daniel Dunbar914bc412011-04-19 23:10:47 +0000750 // On ARM, a member function pointer is also non-null if the low bit of 'adj'
751 // (the virtual bit) is set.
Mark Seabornedf0d382013-07-24 16:25:13 +0000752 if (UseARMMethodPtrABI) {
John McCall131d97d2010-08-22 08:30:07 +0000753 llvm::Constant *One = llvm::ConstantInt::get(Ptr->getType(), 1);
John McCalla1dee5302010-08-22 10:59:02 +0000754 llvm::Value *Adj = Builder.CreateExtractValue(MemPtr, 1, "memptr.adj");
John McCall131d97d2010-08-22 08:30:07 +0000755 llvm::Value *VirtualBit = Builder.CreateAnd(Adj, One, "memptr.virtualbit");
Daniel Dunbar914bc412011-04-19 23:10:47 +0000756 llvm::Value *IsVirtual = Builder.CreateICmpNE(VirtualBit, Zero,
757 "memptr.isvirtual");
758 Result = Builder.CreateOr(Result, IsVirtual);
John McCall131d97d2010-08-22 08:30:07 +0000759 }
760
761 return Result;
762}
John McCall1c456c82010-08-22 06:43:33 +0000763
John McCall614dbdc2010-08-22 21:01:12 +0000764/// The Itanium ABI requires non-zero initialization only for data
765/// member pointers, for which '0' is a valid offset.
766bool ItaniumCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
767 return MPT->getPointeeType()->isFunctionType();
John McCall84fa5102010-08-22 04:16:24 +0000768}
John McCall5d865c322010-08-31 07:33:07 +0000769
John McCall82fb8922012-09-25 10:10:39 +0000770/// The Itanium ABI always places an offset to the complete object
771/// at entry -2 in the vtable.
772llvm::Value *ItaniumCXXABI::adjustToCompleteObject(CodeGenFunction &CGF,
773 llvm::Value *ptr,
774 QualType type) {
775 // Grab the vtable pointer as an intptr_t*.
776 llvm::Value *vtable = CGF.GetVTablePtr(ptr, CGF.IntPtrTy->getPointerTo());
777
778 // Track back to entry -2 and pull out the offset there.
779 llvm::Value *offsetPtr =
780 CGF.Builder.CreateConstInBoundsGEP1_64(vtable, -2, "complete-offset.ptr");
781 llvm::LoadInst *offset = CGF.Builder.CreateLoad(offsetPtr);
782 offset->setAlignment(CGF.PointerAlignInBytes);
783
784 // Apply the offset.
785 ptr = CGF.Builder.CreateBitCast(ptr, CGF.Int8PtrTy);
786 return CGF.Builder.CreateInBoundsGEP(ptr, offset);
787}
788
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000789llvm::Value *
790ItaniumCXXABI::GetVirtualBaseClassOffset(CodeGenFunction &CGF,
791 llvm::Value *This,
792 const CXXRecordDecl *ClassDecl,
793 const CXXRecordDecl *BaseClassDecl) {
794 llvm::Value *VTablePtr = CGF.GetVTablePtr(This, CGM.Int8PtrTy);
795 CharUnits VBaseOffsetOffset =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000796 CGM.getItaniumVTableContext().getVirtualBaseOffsetOffset(ClassDecl,
797 BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000798
799 llvm::Value *VBaseOffsetPtr =
800 CGF.Builder.CreateConstGEP1_64(VTablePtr, VBaseOffsetOffset.getQuantity(),
801 "vbase.offset.ptr");
802 VBaseOffsetPtr = CGF.Builder.CreateBitCast(VBaseOffsetPtr,
803 CGM.PtrDiffTy->getPointerTo());
804
805 llvm::Value *VBaseOffset =
806 CGF.Builder.CreateLoad(VBaseOffsetPtr, "vbase.offset");
807
808 return VBaseOffset;
809}
810
John McCall5d865c322010-08-31 07:33:07 +0000811/// The generic ABI passes 'this', plus a VTT if it's initializing a
812/// base subobject.
Reid Kleckner89077a12013-12-17 19:46:40 +0000813void
814ItaniumCXXABI::BuildConstructorSignature(const CXXConstructorDecl *Ctor,
815 CXXCtorType Type, CanQualType &ResTy,
816 SmallVectorImpl<CanQualType> &ArgTys) {
John McCall9bca9232010-09-02 10:25:57 +0000817 ASTContext &Context = getContext();
John McCall5d865c322010-08-31 07:33:07 +0000818
Reid Kleckner89077a12013-12-17 19:46:40 +0000819 // All parameters are already in place except VTT, which goes after 'this'.
820 // These are Clang types, so we don't need to worry about sret yet.
John McCall5d865c322010-08-31 07:33:07 +0000821
822 // Check if we need to add a VTT parameter (which has type void **).
823 if (Type == Ctor_Base && Ctor->getParent()->getNumVBases() != 0)
Reid Kleckner89077a12013-12-17 19:46:40 +0000824 ArgTys.insert(ArgTys.begin() + 1,
825 Context.getPointerType(Context.VoidPtrTy));
John McCall5d865c322010-08-31 07:33:07 +0000826}
827
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000828void ItaniumCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
829 // Just make sure we're in sync with TargetCXXABI.
830 assert(CGM.getTarget().getCXXABI().hasConstructorVariants());
831
Rafael Espindolac3cde362013-12-09 14:51:17 +0000832 // The constructor used for constructing this as a base class;
833 // ignores virtual bases.
834 CGM.EmitGlobal(GlobalDecl(D, Ctor_Base));
835
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000836 // The constructor used for constructing this as a complete class;
837 // constucts the virtual bases, then calls the base constructor.
838 if (!D->getParent()->isAbstract()) {
839 // We don't need to emit the complete ctor if the class is abstract.
840 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
841 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000842}
843
John McCall5d865c322010-08-31 07:33:07 +0000844/// The generic ABI passes 'this', plus a VTT if it's destroying a
845/// base subobject.
846void ItaniumCXXABI::BuildDestructorSignature(const CXXDestructorDecl *Dtor,
847 CXXDtorType Type,
848 CanQualType &ResTy,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000849 SmallVectorImpl<CanQualType> &ArgTys) {
John McCall9bca9232010-09-02 10:25:57 +0000850 ASTContext &Context = getContext();
John McCall5d865c322010-08-31 07:33:07 +0000851
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000852 // 'this' parameter is already there, as well as 'this' return if
853 // HasThisReturn(GlobalDecl(Dtor, Type)) is true
John McCall5d865c322010-08-31 07:33:07 +0000854
855 // Check if we need to add a VTT parameter (which has type void **).
856 if (Type == Dtor_Base && Dtor->getParent()->getNumVBases() != 0)
857 ArgTys.push_back(Context.getPointerType(Context.VoidPtrTy));
858}
859
Reid Klecknere7de47e2013-07-22 13:51:44 +0000860void ItaniumCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
Rafael Espindolac3cde362013-12-09 14:51:17 +0000861 // The destructor used for destructing this as a base class; ignores
862 // virtual bases.
863 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
Reid Klecknere7de47e2013-07-22 13:51:44 +0000864
865 // The destructor used for destructing this as a most-derived class;
866 // call the base destructor and then destructs any virtual bases.
867 CGM.EmitGlobal(GlobalDecl(D, Dtor_Complete));
868
Rafael Espindolac3cde362013-12-09 14:51:17 +0000869 // The destructor in a virtual table is always a 'deleting'
870 // destructor, which calls the complete destructor and then uses the
871 // appropriate operator delete.
872 if (D->isVirtual())
873 CGM.EmitGlobal(GlobalDecl(D, Dtor_Deleting));
Reid Klecknere7de47e2013-07-22 13:51:44 +0000874}
875
Reid Kleckner89077a12013-12-17 19:46:40 +0000876void ItaniumCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
877 QualType &ResTy,
878 FunctionArgList &Params) {
John McCall5d865c322010-08-31 07:33:07 +0000879 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +0000880 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
John McCall5d865c322010-08-31 07:33:07 +0000881
882 // Check if we need a VTT parameter as well.
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000883 if (NeedsVTTParameter(CGF.CurGD)) {
John McCall9bca9232010-09-02 10:25:57 +0000884 ASTContext &Context = getContext();
John McCall5d865c322010-08-31 07:33:07 +0000885
886 // FIXME: avoid the fake decl
887 QualType T = Context.getPointerType(Context.VoidPtrTy);
888 ImplicitParamDecl *VTTDecl
889 = ImplicitParamDecl::Create(Context, 0, MD->getLocation(),
890 &Context.Idents.get("vtt"), T);
Reid Kleckner89077a12013-12-17 19:46:40 +0000891 Params.insert(Params.begin() + 1, VTTDecl);
Reid Kleckner2af6d732013-12-13 00:09:59 +0000892 getStructorImplicitParamDecl(CGF) = VTTDecl;
John McCall5d865c322010-08-31 07:33:07 +0000893 }
894}
895
John McCall5d865c322010-08-31 07:33:07 +0000896void ItaniumCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
897 /// Initialize the 'this' slot.
898 EmitThisParam(CGF);
899
900 /// Initialize the 'vtt' slot if needed.
Reid Kleckner2af6d732013-12-13 00:09:59 +0000901 if (getStructorImplicitParamDecl(CGF)) {
902 getStructorImplicitParamValue(CGF) = CGF.Builder.CreateLoad(
903 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)), "vtt");
John McCall5d865c322010-08-31 07:33:07 +0000904 }
John McCall5d865c322010-08-31 07:33:07 +0000905
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000906 /// If this is a function that the ABI specifies returns 'this', initialize
907 /// the return slot to 'this' at the start of the function.
908 ///
909 /// Unlike the setting of return types, this is done within the ABI
910 /// implementation instead of by clients of CGCXXABI because:
911 /// 1) getThisValue is currently protected
912 /// 2) in theory, an ABI could implement 'this' returns some other way;
913 /// HasThisReturn only specifies a contract, not the implementation
John McCall5d865c322010-08-31 07:33:07 +0000914 if (HasThisReturn(CGF.CurGD))
Eli Friedman9fbeba02012-02-11 02:57:39 +0000915 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
John McCall5d865c322010-08-31 07:33:07 +0000916}
917
Reid Kleckner89077a12013-12-17 19:46:40 +0000918unsigned ItaniumCXXABI::addImplicitConstructorArgs(
919 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
920 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
921 if (!NeedsVTTParameter(GlobalDecl(D, Type)))
922 return 0;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000923
Reid Kleckner89077a12013-12-17 19:46:40 +0000924 // Insert the implicit 'vtt' argument as the second argument.
925 llvm::Value *VTT =
926 CGF.GetVTTParameter(GlobalDecl(D, Type), ForVirtualBase, Delegating);
927 QualType VTTTy = getContext().getPointerType(getContext().VoidPtrTy);
928 Args.insert(Args.begin() + 1,
929 CallArg(RValue::get(VTT), VTTTy, /*needscopy=*/false));
930 return 1; // Added one arg.
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000931}
932
933void ItaniumCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
934 const CXXDestructorDecl *DD,
935 CXXDtorType Type, bool ForVirtualBase,
936 bool Delegating, llvm::Value *This) {
937 GlobalDecl GD(DD, Type);
938 llvm::Value *VTT = CGF.GetVTTParameter(GD, ForVirtualBase, Delegating);
939 QualType VTTTy = getContext().getPointerType(getContext().VoidPtrTy);
940
941 llvm::Value *Callee = 0;
942 if (getContext().getLangOpts().AppleKext)
943 Callee = CGF.BuildAppleKextVirtualDestructorCall(DD, Type, DD->getParent());
944
945 if (!Callee)
946 Callee = CGM.GetAddrOfCXXDestructor(DD, Type);
947
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000948 // FIXME: Provide a source location here.
949 CGF.EmitCXXMemberCall(DD, SourceLocation(), Callee, ReturnValueSlot(), This,
950 VTT, VTTTy, 0, 0);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000951}
952
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000953void ItaniumCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
954 const CXXRecordDecl *RD) {
955 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, CharUnits());
956 if (VTable->hasInitializer())
957 return;
958
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000959 ItaniumVTableContext &VTContext = CGM.getItaniumVTableContext();
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000960 const VTableLayout &VTLayout = VTContext.getVTableLayout(RD);
961 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
962
963 // Create and set the initializer.
964 llvm::Constant *Init = CGVT.CreateVTableInitializer(
965 RD, VTLayout.vtable_component_begin(), VTLayout.getNumVTableComponents(),
966 VTLayout.vtable_thunk_begin(), VTLayout.getNumVTableThunks());
967 VTable->setInitializer(Init);
968
969 // Set the correct linkage.
970 VTable->setLinkage(Linkage);
971
972 // Set the right visibility.
John McCall8f80a612014-02-08 00:41:16 +0000973 CGM.setGlobalVisibility(VTable, RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000974
975 // If this is the magic class __cxxabiv1::__fundamental_type_info,
976 // we will emit the typeinfo for the fundamental types. This is the
977 // same behaviour as GCC.
978 const DeclContext *DC = RD->getDeclContext();
979 if (RD->getIdentifier() &&
980 RD->getIdentifier()->isStr("__fundamental_type_info") &&
981 isa<NamespaceDecl>(DC) && cast<NamespaceDecl>(DC)->getIdentifier() &&
982 cast<NamespaceDecl>(DC)->getIdentifier()->isStr("__cxxabiv1") &&
983 DC->getParent()->isTranslationUnit())
984 CGM.EmitFundamentalRTTIDescriptors();
985}
986
987llvm::Value *ItaniumCXXABI::getVTableAddressPointInStructor(
988 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
989 const CXXRecordDecl *NearestVBase, bool &NeedsVirtualOffset) {
990 bool NeedsVTTParam = CGM.getCXXABI().NeedsVTTParameter(CGF.CurGD);
991 NeedsVirtualOffset = (NeedsVTTParam && NearestVBase);
992
993 llvm::Value *VTableAddressPoint;
994 if (NeedsVTTParam && (Base.getBase()->getNumVBases() || NearestVBase)) {
995 // Get the secondary vpointer index.
996 uint64_t VirtualPointerIndex =
997 CGM.getVTables().getSecondaryVirtualPointerIndex(VTableClass, Base);
998
999 /// Load the VTT.
1000 llvm::Value *VTT = CGF.LoadCXXVTT();
1001 if (VirtualPointerIndex)
1002 VTT = CGF.Builder.CreateConstInBoundsGEP1_64(VTT, VirtualPointerIndex);
1003
1004 // And load the address point from the VTT.
1005 VTableAddressPoint = CGF.Builder.CreateLoad(VTT);
1006 } else {
1007 llvm::Constant *VTable =
1008 CGM.getCXXABI().getAddrOfVTable(VTableClass, CharUnits());
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001009 uint64_t AddressPoint = CGM.getItaniumVTableContext()
1010 .getVTableLayout(VTableClass)
1011 .getAddressPoint(Base);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001012 VTableAddressPoint =
1013 CGF.Builder.CreateConstInBoundsGEP2_64(VTable, 0, AddressPoint);
1014 }
1015
1016 return VTableAddressPoint;
1017}
1018
1019llvm::Constant *ItaniumCXXABI::getVTableAddressPointForConstExpr(
1020 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1021 llvm::Constant *VTable = getAddrOfVTable(VTableClass, CharUnits());
1022
1023 // Find the appropriate vtable within the vtable group.
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001024 uint64_t AddressPoint = CGM.getItaniumVTableContext()
1025 .getVTableLayout(VTableClass)
1026 .getAddressPoint(Base);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001027 llvm::Value *Indices[] = {
1028 llvm::ConstantInt::get(CGM.Int64Ty, 0),
1029 llvm::ConstantInt::get(CGM.Int64Ty, AddressPoint)
1030 };
1031
1032 return llvm::ConstantExpr::getInBoundsGetElementPtr(VTable, Indices);
1033}
1034
1035llvm::GlobalVariable *ItaniumCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1036 CharUnits VPtrOffset) {
1037 assert(VPtrOffset.isZero() && "Itanium ABI only supports zero vptr offsets");
1038
1039 llvm::GlobalVariable *&VTable = VTables[RD];
1040 if (VTable)
1041 return VTable;
1042
1043 // Queue up this v-table for possible deferred emission.
1044 CGM.addDeferredVTable(RD);
1045
1046 SmallString<256> OutName;
1047 llvm::raw_svector_ostream Out(OutName);
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001048 getMangleContext().mangleCXXVTable(RD, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001049 Out.flush();
1050 StringRef Name = OutName.str();
1051
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001052 ItaniumVTableContext &VTContext = CGM.getItaniumVTableContext();
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001053 llvm::ArrayType *ArrayType = llvm::ArrayType::get(
1054 CGM.Int8PtrTy, VTContext.getVTableLayout(RD).getNumVTableComponents());
1055
1056 VTable = CGM.CreateOrReplaceCXXRuntimeVariable(
1057 Name, ArrayType, llvm::GlobalValue::ExternalLinkage);
1058 VTable->setUnnamedAddr(true);
1059 return VTable;
1060}
1061
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001062llvm::Value *ItaniumCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1063 GlobalDecl GD,
1064 llvm::Value *This,
1065 llvm::Type *Ty) {
1066 GD = GD.getCanonicalDecl();
1067 Ty = Ty->getPointerTo()->getPointerTo();
1068 llvm::Value *VTable = CGF.GetVTablePtr(This, Ty);
1069
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001070 uint64_t VTableIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001071 llvm::Value *VFuncPtr =
1072 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, VTableIndex, "vfn");
1073 return CGF.Builder.CreateLoad(VFuncPtr);
1074}
1075
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001076void ItaniumCXXABI::EmitVirtualDestructorCall(CodeGenFunction &CGF,
1077 const CXXDestructorDecl *Dtor,
1078 CXXDtorType DtorType,
1079 SourceLocation CallLoc,
1080 llvm::Value *This) {
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001081 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1082
1083 const CGFunctionInfo *FInfo
1084 = &CGM.getTypes().arrangeCXXDestructor(Dtor, DtorType);
1085 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001086 llvm::Value *Callee =
1087 getVirtualFunctionPointer(CGF, GlobalDecl(Dtor, DtorType), This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001088
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001089 CGF.EmitCXXMemberCall(Dtor, CallLoc, Callee, ReturnValueSlot(), This,
1090 /*ImplicitParam=*/0, QualType(), 0, 0);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001091}
1092
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001093void ItaniumCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001094 CodeGenVTables &VTables = CGM.getVTables();
1095 llvm::GlobalVariable *VTT = VTables.GetAddrOfVTT(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001096 VTables.EmitVTTDefinition(VTT, CGM.getVTableLinkage(RD), RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001097}
1098
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001099static llvm::Value *performTypeAdjustment(CodeGenFunction &CGF,
1100 llvm::Value *Ptr,
1101 int64_t NonVirtualAdjustment,
1102 int64_t VirtualAdjustment,
1103 bool IsReturnAdjustment) {
1104 if (!NonVirtualAdjustment && !VirtualAdjustment)
1105 return Ptr;
1106
1107 llvm::Type *Int8PtrTy = CGF.Int8PtrTy;
1108 llvm::Value *V = CGF.Builder.CreateBitCast(Ptr, Int8PtrTy);
1109
1110 if (NonVirtualAdjustment && !IsReturnAdjustment) {
1111 // Perform the non-virtual adjustment for a base-to-derived cast.
1112 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
1113 }
1114
1115 if (VirtualAdjustment) {
1116 llvm::Type *PtrDiffTy =
1117 CGF.ConvertType(CGF.getContext().getPointerDiffType());
1118
1119 // Perform the virtual adjustment.
1120 llvm::Value *VTablePtrPtr =
1121 CGF.Builder.CreateBitCast(V, Int8PtrTy->getPointerTo());
1122
1123 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr);
1124
1125 llvm::Value *OffsetPtr =
1126 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment);
1127
1128 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo());
1129
1130 // Load the adjustment offset from the vtable.
1131 llvm::Value *Offset = CGF.Builder.CreateLoad(OffsetPtr);
1132
1133 // Adjust our pointer.
1134 V = CGF.Builder.CreateInBoundsGEP(V, Offset);
1135 }
1136
1137 if (NonVirtualAdjustment && IsReturnAdjustment) {
1138 // Perform the non-virtual adjustment for a derived-to-base cast.
1139 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
1140 }
1141
1142 // Cast back to the original type.
1143 return CGF.Builder.CreateBitCast(V, Ptr->getType());
1144}
1145
1146llvm::Value *ItaniumCXXABI::performThisAdjustment(CodeGenFunction &CGF,
1147 llvm::Value *This,
1148 const ThisAdjustment &TA) {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00001149 return performTypeAdjustment(CGF, This, TA.NonVirtual,
1150 TA.Virtual.Itanium.VCallOffsetOffset,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001151 /*IsReturnAdjustment=*/false);
1152}
1153
1154llvm::Value *
1155ItaniumCXXABI::performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
1156 const ReturnAdjustment &RA) {
1157 return performTypeAdjustment(CGF, Ret, RA.NonVirtual,
1158 RA.Virtual.Itanium.VBaseOffsetOffset,
1159 /*IsReturnAdjustment=*/true);
1160}
1161
John McCall5d865c322010-08-31 07:33:07 +00001162void ARMCXXABI::EmitReturnFromThunk(CodeGenFunction &CGF,
1163 RValue RV, QualType ResultType) {
1164 if (!isa<CXXDestructorDecl>(CGF.CurGD.getDecl()))
1165 return ItaniumCXXABI::EmitReturnFromThunk(CGF, RV, ResultType);
1166
1167 // Destructor thunks in the ARM ABI have indeterminate results.
Chris Lattner2192fe52011-07-18 04:24:23 +00001168 llvm::Type *T =
John McCall5d865c322010-08-31 07:33:07 +00001169 cast<llvm::PointerType>(CGF.ReturnValue->getType())->getElementType();
1170 RValue Undef = RValue::get(llvm::UndefValue::get(T));
1171 return ItaniumCXXABI::EmitReturnFromThunk(CGF, Undef, ResultType);
1172}
John McCall8ed55a52010-09-02 09:58:18 +00001173
1174/************************** Array allocation cookies **************************/
1175
John McCallb91cd662012-05-01 05:23:51 +00001176CharUnits ItaniumCXXABI::getArrayCookieSizeImpl(QualType elementType) {
1177 // The array cookie is a size_t; pad that up to the element alignment.
1178 // The cookie is actually right-justified in that space.
1179 return std::max(CharUnits::fromQuantity(CGM.SizeSizeInBytes),
1180 CGM.getContext().getTypeAlignInChars(elementType));
John McCall8ed55a52010-09-02 09:58:18 +00001181}
1182
1183llvm::Value *ItaniumCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
1184 llvm::Value *NewPtr,
1185 llvm::Value *NumElements,
John McCall284c48f2011-01-27 09:37:56 +00001186 const CXXNewExpr *expr,
John McCall8ed55a52010-09-02 09:58:18 +00001187 QualType ElementType) {
John McCallb91cd662012-05-01 05:23:51 +00001188 assert(requiresArrayCookie(expr));
John McCall8ed55a52010-09-02 09:58:18 +00001189
Micah Villmowea2fea22012-10-25 15:39:14 +00001190 unsigned AS = NewPtr->getType()->getPointerAddressSpace();
John McCall8ed55a52010-09-02 09:58:18 +00001191
John McCall9bca9232010-09-02 10:25:57 +00001192 ASTContext &Ctx = getContext();
John McCall8ed55a52010-09-02 09:58:18 +00001193 QualType SizeTy = Ctx.getSizeType();
1194 CharUnits SizeSize = Ctx.getTypeSizeInChars(SizeTy);
1195
1196 // The size of the cookie.
1197 CharUnits CookieSize =
1198 std::max(SizeSize, Ctx.getTypeAlignInChars(ElementType));
John McCallb91cd662012-05-01 05:23:51 +00001199 assert(CookieSize == getArrayCookieSizeImpl(ElementType));
John McCall8ed55a52010-09-02 09:58:18 +00001200
1201 // Compute an offset to the cookie.
1202 llvm::Value *CookiePtr = NewPtr;
1203 CharUnits CookieOffset = CookieSize - SizeSize;
1204 if (!CookieOffset.isZero())
1205 CookiePtr = CGF.Builder.CreateConstInBoundsGEP1_64(CookiePtr,
1206 CookieOffset.getQuantity());
1207
1208 // Write the number of elements into the appropriate slot.
1209 llvm::Value *NumElementsPtr
1210 = CGF.Builder.CreateBitCast(CookiePtr,
1211 CGF.ConvertType(SizeTy)->getPointerTo(AS));
1212 CGF.Builder.CreateStore(NumElements, NumElementsPtr);
1213
1214 // Finally, compute a pointer to the actual data buffer by skipping
1215 // over the cookie completely.
1216 return CGF.Builder.CreateConstInBoundsGEP1_64(NewPtr,
1217 CookieSize.getQuantity());
1218}
1219
John McCallb91cd662012-05-01 05:23:51 +00001220llvm::Value *ItaniumCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
1221 llvm::Value *allocPtr,
1222 CharUnits cookieSize) {
1223 // The element size is right-justified in the cookie.
1224 llvm::Value *numElementsPtr = allocPtr;
1225 CharUnits numElementsOffset =
1226 cookieSize - CharUnits::fromQuantity(CGF.SizeSizeInBytes);
1227 if (!numElementsOffset.isZero())
1228 numElementsPtr =
1229 CGF.Builder.CreateConstInBoundsGEP1_64(numElementsPtr,
1230 numElementsOffset.getQuantity());
John McCall8ed55a52010-09-02 09:58:18 +00001231
Micah Villmowea2fea22012-10-25 15:39:14 +00001232 unsigned AS = allocPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001233 numElementsPtr =
1234 CGF.Builder.CreateBitCast(numElementsPtr, CGF.SizeTy->getPointerTo(AS));
1235 return CGF.Builder.CreateLoad(numElementsPtr);
John McCall8ed55a52010-09-02 09:58:18 +00001236}
1237
John McCallb91cd662012-05-01 05:23:51 +00001238CharUnits ARMCXXABI::getArrayCookieSizeImpl(QualType elementType) {
John McCallc19c7062013-01-25 23:36:19 +00001239 // ARM says that the cookie is always:
John McCall8ed55a52010-09-02 09:58:18 +00001240 // struct array_cookie {
1241 // std::size_t element_size; // element_size != 0
1242 // std::size_t element_count;
1243 // };
John McCallc19c7062013-01-25 23:36:19 +00001244 // But the base ABI doesn't give anything an alignment greater than
1245 // 8, so we can dismiss this as typical ABI-author blindness to
1246 // actual language complexity and round up to the element alignment.
1247 return std::max(CharUnits::fromQuantity(2 * CGM.SizeSizeInBytes),
1248 CGM.getContext().getTypeAlignInChars(elementType));
John McCall8ed55a52010-09-02 09:58:18 +00001249}
1250
1251llvm::Value *ARMCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
John McCallc19c7062013-01-25 23:36:19 +00001252 llvm::Value *newPtr,
1253 llvm::Value *numElements,
John McCall284c48f2011-01-27 09:37:56 +00001254 const CXXNewExpr *expr,
John McCallc19c7062013-01-25 23:36:19 +00001255 QualType elementType) {
John McCallb91cd662012-05-01 05:23:51 +00001256 assert(requiresArrayCookie(expr));
John McCall8ed55a52010-09-02 09:58:18 +00001257
John McCallc19c7062013-01-25 23:36:19 +00001258 // NewPtr is a char*, but we generalize to arbitrary addrspaces.
1259 unsigned AS = newPtr->getType()->getPointerAddressSpace();
John McCall8ed55a52010-09-02 09:58:18 +00001260
1261 // The cookie is always at the start of the buffer.
John McCallc19c7062013-01-25 23:36:19 +00001262 llvm::Value *cookie = newPtr;
John McCall8ed55a52010-09-02 09:58:18 +00001263
1264 // The first element is the element size.
John McCallc19c7062013-01-25 23:36:19 +00001265 cookie = CGF.Builder.CreateBitCast(cookie, CGF.SizeTy->getPointerTo(AS));
1266 llvm::Value *elementSize = llvm::ConstantInt::get(CGF.SizeTy,
1267 getContext().getTypeSizeInChars(elementType).getQuantity());
1268 CGF.Builder.CreateStore(elementSize, cookie);
John McCall8ed55a52010-09-02 09:58:18 +00001269
1270 // The second element is the element count.
John McCallc19c7062013-01-25 23:36:19 +00001271 cookie = CGF.Builder.CreateConstInBoundsGEP1_32(cookie, 1);
1272 CGF.Builder.CreateStore(numElements, cookie);
John McCall8ed55a52010-09-02 09:58:18 +00001273
1274 // Finally, compute a pointer to the actual data buffer by skipping
1275 // over the cookie completely.
John McCallc19c7062013-01-25 23:36:19 +00001276 CharUnits cookieSize = ARMCXXABI::getArrayCookieSizeImpl(elementType);
1277 return CGF.Builder.CreateConstInBoundsGEP1_64(newPtr,
1278 cookieSize.getQuantity());
John McCall8ed55a52010-09-02 09:58:18 +00001279}
1280
John McCallb91cd662012-05-01 05:23:51 +00001281llvm::Value *ARMCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
1282 llvm::Value *allocPtr,
1283 CharUnits cookieSize) {
1284 // The number of elements is at offset sizeof(size_t) relative to
1285 // the allocated pointer.
1286 llvm::Value *numElementsPtr
1287 = CGF.Builder.CreateConstInBoundsGEP1_64(allocPtr, CGF.SizeSizeInBytes);
John McCall8ed55a52010-09-02 09:58:18 +00001288
Micah Villmowea2fea22012-10-25 15:39:14 +00001289 unsigned AS = allocPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001290 numElementsPtr =
1291 CGF.Builder.CreateBitCast(numElementsPtr, CGF.SizeTy->getPointerTo(AS));
1292 return CGF.Builder.CreateLoad(numElementsPtr);
John McCall8ed55a52010-09-02 09:58:18 +00001293}
1294
John McCall68ff0372010-09-08 01:44:27 +00001295/*********************** Static local initialization **************************/
1296
1297static llvm::Constant *getGuardAcquireFn(CodeGenModule &CGM,
Chris Lattnera5f58b02011-07-09 17:41:47 +00001298 llvm::PointerType *GuardPtrTy) {
John McCall68ff0372010-09-08 01:44:27 +00001299 // int __cxa_guard_acquire(__guard *guard_object);
Chris Lattner2192fe52011-07-18 04:24:23 +00001300 llvm::FunctionType *FTy =
John McCall68ff0372010-09-08 01:44:27 +00001301 llvm::FunctionType::get(CGM.getTypes().ConvertType(CGM.getContext().IntTy),
Jay Foad5709f7c2011-07-29 13:56:53 +00001302 GuardPtrTy, /*isVarArg=*/false);
Nick Lewyckyadcec492012-02-13 23:45:02 +00001303 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_acquire",
Bill Wendling8594fcb2013-01-31 00:30:05 +00001304 llvm::AttributeSet::get(CGM.getLLVMContext(),
1305 llvm::AttributeSet::FunctionIndex,
Bill Wendling207f0532012-12-20 19:27:06 +00001306 llvm::Attribute::NoUnwind));
John McCall68ff0372010-09-08 01:44:27 +00001307}
1308
1309static llvm::Constant *getGuardReleaseFn(CodeGenModule &CGM,
Chris Lattnera5f58b02011-07-09 17:41:47 +00001310 llvm::PointerType *GuardPtrTy) {
John McCall68ff0372010-09-08 01:44:27 +00001311 // void __cxa_guard_release(__guard *guard_object);
Chris Lattner2192fe52011-07-18 04:24:23 +00001312 llvm::FunctionType *FTy =
Chris Lattnerece04092012-02-07 00:39:47 +00001313 llvm::FunctionType::get(CGM.VoidTy, GuardPtrTy, /*isVarArg=*/false);
Nick Lewyckyadcec492012-02-13 23:45:02 +00001314 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_release",
Bill Wendling8594fcb2013-01-31 00:30:05 +00001315 llvm::AttributeSet::get(CGM.getLLVMContext(),
1316 llvm::AttributeSet::FunctionIndex,
Bill Wendling207f0532012-12-20 19:27:06 +00001317 llvm::Attribute::NoUnwind));
John McCall68ff0372010-09-08 01:44:27 +00001318}
1319
1320static llvm::Constant *getGuardAbortFn(CodeGenModule &CGM,
Chris Lattnera5f58b02011-07-09 17:41:47 +00001321 llvm::PointerType *GuardPtrTy) {
John McCall68ff0372010-09-08 01:44:27 +00001322 // void __cxa_guard_abort(__guard *guard_object);
Chris Lattner2192fe52011-07-18 04:24:23 +00001323 llvm::FunctionType *FTy =
Chris Lattnerece04092012-02-07 00:39:47 +00001324 llvm::FunctionType::get(CGM.VoidTy, GuardPtrTy, /*isVarArg=*/false);
Nick Lewyckyadcec492012-02-13 23:45:02 +00001325 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_abort",
Bill Wendling8594fcb2013-01-31 00:30:05 +00001326 llvm::AttributeSet::get(CGM.getLLVMContext(),
1327 llvm::AttributeSet::FunctionIndex,
Bill Wendling207f0532012-12-20 19:27:06 +00001328 llvm::Attribute::NoUnwind));
John McCall68ff0372010-09-08 01:44:27 +00001329}
1330
1331namespace {
1332 struct CallGuardAbort : EHScopeStack::Cleanup {
1333 llvm::GlobalVariable *Guard;
Chandler Carruth84537952012-03-30 19:44:53 +00001334 CallGuardAbort(llvm::GlobalVariable *Guard) : Guard(Guard) {}
John McCall68ff0372010-09-08 01:44:27 +00001335
Craig Topper4f12f102014-03-12 06:41:41 +00001336 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall882987f2013-02-28 19:01:20 +00001337 CGF.EmitNounwindRuntimeCall(getGuardAbortFn(CGF.CGM, Guard->getType()),
1338 Guard);
John McCall68ff0372010-09-08 01:44:27 +00001339 }
1340 };
1341}
1342
1343/// The ARM code here follows the Itanium code closely enough that we
1344/// just special-case it at particular places.
John McCallcdf7ef52010-11-06 09:44:32 +00001345void ItaniumCXXABI::EmitGuardedInit(CodeGenFunction &CGF,
1346 const VarDecl &D,
John McCallb88a5662012-03-30 21:00:39 +00001347 llvm::GlobalVariable *var,
1348 bool shouldPerformInit) {
John McCall68ff0372010-09-08 01:44:27 +00001349 CGBuilderTy &Builder = CGF.Builder;
John McCallcdf7ef52010-11-06 09:44:32 +00001350
Richard Smithdbf74ba2013-04-14 23:01:42 +00001351 // We only need to use thread-safe statics for local non-TLS variables;
John McCallcdf7ef52010-11-06 09:44:32 +00001352 // global initialization is always single-threaded.
Richard Smithdbf74ba2013-04-14 23:01:42 +00001353 bool threadsafe = getContext().getLangOpts().ThreadsafeStatics &&
1354 D.isLocalVarDecl() && !D.getTLSKind();
Anders Carlssonc5d3ba12011-04-27 04:37:08 +00001355
Anders Carlssonc5d3ba12011-04-27 04:37:08 +00001356 // If we have a global variable with internal linkage and thread-safe statics
1357 // are disabled, we can just let the guard variable be of type i8.
John McCallb88a5662012-03-30 21:00:39 +00001358 bool useInt8GuardVariable = !threadsafe && var->hasInternalLinkage();
1359
1360 llvm::IntegerType *guardTy;
John McCall5aa52592011-06-17 07:33:57 +00001361 if (useInt8GuardVariable) {
John McCallb88a5662012-03-30 21:00:39 +00001362 guardTy = CGF.Int8Ty;
John McCall5aa52592011-06-17 07:33:57 +00001363 } else {
Tim Northover9bb857a2013-01-31 12:13:10 +00001364 // Guard variables are 64 bits in the generic ABI and size width on ARM
1365 // (i.e. 32-bit on AArch32, 64-bit on AArch64).
Mark Seabornedf0d382013-07-24 16:25:13 +00001366 guardTy = (UseARMGuardVarABI ? CGF.SizeTy : CGF.Int64Ty);
Anders Carlssonc5d3ba12011-04-27 04:37:08 +00001367 }
John McCallb88a5662012-03-30 21:00:39 +00001368 llvm::PointerType *guardPtrTy = guardTy->getPointerTo();
John McCall68ff0372010-09-08 01:44:27 +00001369
John McCallb88a5662012-03-30 21:00:39 +00001370 // Create the guard variable if we don't already have it (as we
1371 // might if we're double-emitting this function body).
1372 llvm::GlobalVariable *guard = CGM.getStaticLocalDeclGuardAddress(&D);
1373 if (!guard) {
1374 // Mangle the name for the guard.
1375 SmallString<256> guardName;
1376 {
1377 llvm::raw_svector_ostream out(guardName);
Reid Klecknerd8110b62013-09-10 20:14:30 +00001378 getMangleContext().mangleStaticGuardVariable(&D, out);
John McCallb88a5662012-03-30 21:00:39 +00001379 out.flush();
1380 }
John McCall8e7cb6d2010-11-02 21:04:24 +00001381
John McCallb88a5662012-03-30 21:00:39 +00001382 // Create the guard variable with a zero-initializer.
1383 // Just absorb linkage and visibility from the guarded variable.
1384 guard = new llvm::GlobalVariable(CGM.getModule(), guardTy,
1385 false, var->getLinkage(),
1386 llvm::ConstantInt::get(guardTy, 0),
1387 guardName.str());
1388 guard->setVisibility(var->getVisibility());
Richard Smithdbf74ba2013-04-14 23:01:42 +00001389 // If the variable is thread-local, so is its guard variable.
1390 guard->setThreadLocalMode(var->getThreadLocalMode());
John McCallb88a5662012-03-30 21:00:39 +00001391
1392 CGM.setStaticLocalDeclGuardAddress(&D, guard);
1393 }
John McCall87590e62012-03-30 07:09:50 +00001394
John McCall68ff0372010-09-08 01:44:27 +00001395 // Test whether the variable has completed initialization.
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001396 //
John McCall68ff0372010-09-08 01:44:27 +00001397 // Itanium C++ ABI 3.3.2:
1398 // The following is pseudo-code showing how these functions can be used:
1399 // if (obj_guard.first_byte == 0) {
1400 // if ( __cxa_guard_acquire (&obj_guard) ) {
1401 // try {
1402 // ... initialize the object ...;
1403 // } catch (...) {
1404 // __cxa_guard_abort (&obj_guard);
1405 // throw;
1406 // }
1407 // ... queue object destructor with __cxa_atexit() ...;
1408 // __cxa_guard_release (&obj_guard);
1409 // }
1410 // }
Tim Northovera2ee4332014-03-29 15:09:45 +00001411
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001412 // Load the first byte of the guard variable.
1413 llvm::LoadInst *LI =
John McCallb88a5662012-03-30 21:00:39 +00001414 Builder.CreateLoad(Builder.CreateBitCast(guard, CGM.Int8PtrTy));
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001415 LI->setAlignment(1);
John McCall68ff0372010-09-08 01:44:27 +00001416
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001417 // Itanium ABI:
1418 // An implementation supporting thread-safety on multiprocessor
1419 // systems must also guarantee that references to the initialized
1420 // object do not occur before the load of the initialization flag.
1421 //
1422 // In LLVM, we do this by marking the load Acquire.
1423 if (threadsafe)
1424 LI->setAtomic(llvm::Acquire);
Eli Friedman84d28122011-09-13 22:21:56 +00001425
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001426 // For ARM, we should only check the first bit, rather than the entire byte:
1427 //
1428 // ARM C++ ABI 3.2.3.1:
1429 // To support the potential use of initialization guard variables
1430 // as semaphores that are the target of ARM SWP and LDREX/STREX
1431 // synchronizing instructions we define a static initialization
1432 // guard variable to be a 4-byte aligned, 4-byte word with the
1433 // following inline access protocol.
1434 // #define INITIALIZED 1
1435 // if ((obj_guard & INITIALIZED) != INITIALIZED) {
1436 // if (__cxa_guard_acquire(&obj_guard))
1437 // ...
1438 // }
1439 //
1440 // and similarly for ARM64:
1441 //
1442 // ARM64 C++ ABI 3.2.2:
1443 // This ABI instead only specifies the value bit 0 of the static guard
1444 // variable; all other bits are platform defined. Bit 0 shall be 0 when the
1445 // variable is not initialized and 1 when it is.
1446 llvm::Value *V =
1447 (UseARMGuardVarABI && !useInt8GuardVariable)
1448 ? Builder.CreateAnd(LI, llvm::ConstantInt::get(CGM.Int8Ty, 1))
1449 : LI;
1450 llvm::Value *isInitialized = Builder.CreateIsNull(V, "guard.uninitialized");
John McCall68ff0372010-09-08 01:44:27 +00001451
1452 llvm::BasicBlock *InitCheckBlock = CGF.createBasicBlock("init.check");
1453 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
1454
1455 // Check if the first byte of the guard variable is zero.
John McCallb88a5662012-03-30 21:00:39 +00001456 Builder.CreateCondBr(isInitialized, InitCheckBlock, EndBlock);
John McCall68ff0372010-09-08 01:44:27 +00001457
1458 CGF.EmitBlock(InitCheckBlock);
1459
1460 // Variables used when coping with thread-safe statics and exceptions.
John McCall5aa52592011-06-17 07:33:57 +00001461 if (threadsafe) {
John McCall68ff0372010-09-08 01:44:27 +00001462 // Call __cxa_guard_acquire.
1463 llvm::Value *V
John McCall882987f2013-02-28 19:01:20 +00001464 = CGF.EmitNounwindRuntimeCall(getGuardAcquireFn(CGM, guardPtrTy), guard);
John McCall68ff0372010-09-08 01:44:27 +00001465
1466 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
1467
1468 Builder.CreateCondBr(Builder.CreateIsNotNull(V, "tobool"),
1469 InitBlock, EndBlock);
1470
1471 // Call __cxa_guard_abort along the exceptional edge.
John McCallb88a5662012-03-30 21:00:39 +00001472 CGF.EHStack.pushCleanup<CallGuardAbort>(EHCleanup, guard);
John McCall68ff0372010-09-08 01:44:27 +00001473
1474 CGF.EmitBlock(InitBlock);
1475 }
1476
1477 // Emit the initializer and add a global destructor if appropriate.
John McCallb88a5662012-03-30 21:00:39 +00001478 CGF.EmitCXXGlobalVarDeclInit(D, var, shouldPerformInit);
John McCall68ff0372010-09-08 01:44:27 +00001479
John McCall5aa52592011-06-17 07:33:57 +00001480 if (threadsafe) {
John McCall68ff0372010-09-08 01:44:27 +00001481 // Pop the guard-abort cleanup if we pushed one.
1482 CGF.PopCleanupBlock();
1483
1484 // Call __cxa_guard_release. This cannot throw.
John McCall882987f2013-02-28 19:01:20 +00001485 CGF.EmitNounwindRuntimeCall(getGuardReleaseFn(CGM, guardPtrTy), guard);
John McCall68ff0372010-09-08 01:44:27 +00001486 } else {
John McCallb88a5662012-03-30 21:00:39 +00001487 Builder.CreateStore(llvm::ConstantInt::get(guardTy, 1), guard);
John McCall68ff0372010-09-08 01:44:27 +00001488 }
1489
1490 CGF.EmitBlock(EndBlock);
1491}
John McCallc84ed6a2012-05-01 06:13:13 +00001492
1493/// Register a global destructor using __cxa_atexit.
1494static void emitGlobalDtorWithCXAAtExit(CodeGenFunction &CGF,
1495 llvm::Constant *dtor,
Richard Smithdbf74ba2013-04-14 23:01:42 +00001496 llvm::Constant *addr,
1497 bool TLS) {
Bill Wendling95cae882013-05-02 19:18:03 +00001498 const char *Name = "__cxa_atexit";
1499 if (TLS) {
1500 const llvm::Triple &T = CGF.getTarget().getTriple();
1501 Name = T.isMacOSX() ? "_tlv_atexit" : "__cxa_thread_atexit";
1502 }
Richard Smithdbf74ba2013-04-14 23:01:42 +00001503
John McCallc84ed6a2012-05-01 06:13:13 +00001504 // We're assuming that the destructor function is something we can
1505 // reasonably call with the default CC. Go ahead and cast it to the
1506 // right prototype.
1507 llvm::Type *dtorTy =
1508 llvm::FunctionType::get(CGF.VoidTy, CGF.Int8PtrTy, false)->getPointerTo();
1509
1510 // extern "C" int __cxa_atexit(void (*f)(void *), void *p, void *d);
1511 llvm::Type *paramTys[] = { dtorTy, CGF.Int8PtrTy, CGF.Int8PtrTy };
1512 llvm::FunctionType *atexitTy =
1513 llvm::FunctionType::get(CGF.IntTy, paramTys, false);
1514
1515 // Fetch the actual function.
Richard Smithdbf74ba2013-04-14 23:01:42 +00001516 llvm::Constant *atexit = CGF.CGM.CreateRuntimeFunction(atexitTy, Name);
John McCallc84ed6a2012-05-01 06:13:13 +00001517 if (llvm::Function *fn = dyn_cast<llvm::Function>(atexit))
1518 fn->setDoesNotThrow();
1519
1520 // Create a variable that binds the atexit to this shared object.
1521 llvm::Constant *handle =
1522 CGF.CGM.CreateRuntimeVariable(CGF.Int8Ty, "__dso_handle");
1523
1524 llvm::Value *args[] = {
1525 llvm::ConstantExpr::getBitCast(dtor, dtorTy),
1526 llvm::ConstantExpr::getBitCast(addr, CGF.Int8PtrTy),
1527 handle
1528 };
John McCall882987f2013-02-28 19:01:20 +00001529 CGF.EmitNounwindRuntimeCall(atexit, args);
John McCallc84ed6a2012-05-01 06:13:13 +00001530}
1531
1532/// Register a global destructor as best as we know how.
1533void ItaniumCXXABI::registerGlobalDtor(CodeGenFunction &CGF,
Richard Smithdbf74ba2013-04-14 23:01:42 +00001534 const VarDecl &D,
John McCallc84ed6a2012-05-01 06:13:13 +00001535 llvm::Constant *dtor,
1536 llvm::Constant *addr) {
1537 // Use __cxa_atexit if available.
Richard Smithdbf74ba2013-04-14 23:01:42 +00001538 if (CGM.getCodeGenOpts().CXAAtExit)
1539 return emitGlobalDtorWithCXAAtExit(CGF, dtor, addr, D.getTLSKind());
1540
1541 if (D.getTLSKind())
1542 CGM.ErrorUnsupported(&D, "non-trivial TLS destruction");
John McCallc84ed6a2012-05-01 06:13:13 +00001543
1544 // In Apple kexts, we want to add a global destructor entry.
1545 // FIXME: shouldn't this be guarded by some variable?
Richard Smith9c6890a2012-11-01 22:30:59 +00001546 if (CGM.getLangOpts().AppleKext) {
John McCallc84ed6a2012-05-01 06:13:13 +00001547 // Generate a global destructor entry.
1548 return CGM.AddCXXDtorEntry(dtor, addr);
1549 }
1550
David Blaikieebe87e12013-08-27 23:57:18 +00001551 CGF.registerGlobalDtorWithAtExit(D, dtor, addr);
John McCallc84ed6a2012-05-01 06:13:13 +00001552}
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001553
1554/// Get the appropriate linkage for the wrapper function. This is essentially
1555/// the weak form of the variable's linkage; every translation unit which wneeds
1556/// the wrapper emits a copy, and we want the linker to merge them.
1557static llvm::GlobalValue::LinkageTypes getThreadLocalWrapperLinkage(
1558 llvm::GlobalValue::LinkageTypes VarLinkage) {
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001559 // For internal linkage variables, we don't need an external or weak wrapper.
1560 if (llvm::GlobalValue::isLocalLinkage(VarLinkage))
1561 return VarLinkage;
1562 return llvm::GlobalValue::WeakODRLinkage;
1563}
1564
1565llvm::Function *
1566ItaniumCXXABI::getOrCreateThreadLocalWrapper(const VarDecl *VD,
1567 llvm::GlobalVariable *Var) {
1568 // Mangle the name for the thread_local wrapper function.
1569 SmallString<256> WrapperName;
1570 {
1571 llvm::raw_svector_ostream Out(WrapperName);
1572 getMangleContext().mangleItaniumThreadLocalWrapper(VD, Out);
1573 Out.flush();
1574 }
1575
1576 if (llvm::Value *V = Var->getParent()->getNamedValue(WrapperName))
1577 return cast<llvm::Function>(V);
1578
1579 llvm::Type *RetTy = Var->getType();
1580 if (VD->getType()->isReferenceType())
1581 RetTy = RetTy->getPointerElementType();
1582
1583 llvm::FunctionType *FnTy = llvm::FunctionType::get(RetTy, false);
1584 llvm::Function *Wrapper = llvm::Function::Create(
1585 FnTy, getThreadLocalWrapperLinkage(Var->getLinkage()), WrapperName.str(),
1586 &CGM.getModule());
1587 // Always resolve references to the wrapper at link time.
1588 Wrapper->setVisibility(llvm::GlobalValue::HiddenVisibility);
1589 return Wrapper;
1590}
1591
1592void ItaniumCXXABI::EmitThreadLocalInitFuncs(
1593 llvm::ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *> > Decls,
1594 llvm::Function *InitFunc) {
1595 for (unsigned I = 0, N = Decls.size(); I != N; ++I) {
1596 const VarDecl *VD = Decls[I].first;
1597 llvm::GlobalVariable *Var = Decls[I].second;
1598
1599 // Mangle the name for the thread_local initialization function.
1600 SmallString<256> InitFnName;
1601 {
1602 llvm::raw_svector_ostream Out(InitFnName);
1603 getMangleContext().mangleItaniumThreadLocalInit(VD, Out);
1604 Out.flush();
1605 }
1606
1607 // If we have a definition for the variable, emit the initialization
1608 // function as an alias to the global Init function (if any). Otherwise,
1609 // produce a declaration of the initialization function.
1610 llvm::GlobalValue *Init = 0;
1611 bool InitIsInitFunc = false;
1612 if (VD->hasDefinition()) {
1613 InitIsInitFunc = true;
1614 if (InitFunc)
1615 Init =
1616 new llvm::GlobalAlias(InitFunc->getType(), Var->getLinkage(),
1617 InitFnName.str(), InitFunc, &CGM.getModule());
1618 } else {
1619 // Emit a weak global function referring to the initialization function.
1620 // This function will not exist if the TU defining the thread_local
1621 // variable in question does not need any dynamic initialization for
1622 // its thread_local variables.
1623 llvm::FunctionType *FnTy = llvm::FunctionType::get(CGM.VoidTy, false);
1624 Init = llvm::Function::Create(
1625 FnTy, llvm::GlobalVariable::ExternalWeakLinkage, InitFnName.str(),
1626 &CGM.getModule());
1627 }
1628
1629 if (Init)
1630 Init->setVisibility(Var->getVisibility());
1631
1632 llvm::Function *Wrapper = getOrCreateThreadLocalWrapper(VD, Var);
1633 llvm::LLVMContext &Context = CGM.getModule().getContext();
1634 llvm::BasicBlock *Entry = llvm::BasicBlock::Create(Context, "", Wrapper);
1635 CGBuilderTy Builder(Entry);
1636 if (InitIsInitFunc) {
1637 if (Init)
1638 Builder.CreateCall(Init);
1639 } else {
1640 // Don't know whether we have an init function. Call it if it exists.
1641 llvm::Value *Have = Builder.CreateIsNotNull(Init);
1642 llvm::BasicBlock *InitBB = llvm::BasicBlock::Create(Context, "", Wrapper);
1643 llvm::BasicBlock *ExitBB = llvm::BasicBlock::Create(Context, "", Wrapper);
1644 Builder.CreateCondBr(Have, InitBB, ExitBB);
1645
1646 Builder.SetInsertPoint(InitBB);
1647 Builder.CreateCall(Init);
1648 Builder.CreateBr(ExitBB);
1649
1650 Builder.SetInsertPoint(ExitBB);
1651 }
1652
1653 // For a reference, the result of the wrapper function is a pointer to
1654 // the referenced object.
1655 llvm::Value *Val = Var;
1656 if (VD->getType()->isReferenceType()) {
1657 llvm::LoadInst *LI = Builder.CreateLoad(Val);
1658 LI->setAlignment(CGM.getContext().getDeclAlign(VD).getQuantity());
1659 Val = LI;
1660 }
1661
1662 Builder.CreateRet(Val);
1663 }
1664}
1665
Richard Smith0f383742014-03-26 22:48:22 +00001666LValue ItaniumCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
1667 const VarDecl *VD,
1668 QualType LValType) {
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001669 QualType T = VD->getType();
1670 llvm::Type *Ty = CGF.getTypes().ConvertTypeForMem(T);
1671 llvm::Value *Val = CGF.CGM.GetAddrOfGlobalVar(VD, Ty);
1672 llvm::Function *Wrapper =
1673 getOrCreateThreadLocalWrapper(VD, cast<llvm::GlobalVariable>(Val));
1674
1675 Val = CGF.Builder.CreateCall(Wrapper);
1676
1677 LValue LV;
1678 if (VD->getType()->isReferenceType())
Richard Smith0f383742014-03-26 22:48:22 +00001679 LV = CGF.MakeNaturalAlignAddrLValue(Val, LValType);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001680 else
Richard Smith0f383742014-03-26 22:48:22 +00001681 LV = CGF.MakeAddrLValue(Val, LValType, CGF.getContext().getDeclAlign(VD));
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001682 // FIXME: need setObjCGCLValueClass?
1683 return LV;
1684}
Peter Collingbourne66f82e62013-06-28 20:45:28 +00001685
1686/// Return whether the given global decl needs a VTT parameter, which it does
1687/// if it's a base constructor or destructor with virtual bases.
1688bool ItaniumCXXABI::NeedsVTTParameter(GlobalDecl GD) {
1689 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
1690
1691 // We don't have any virtual bases, just return early.
1692 if (!MD->getParent()->getNumVBases())
1693 return false;
1694
1695 // Check if we have a base constructor.
1696 if (isa<CXXConstructorDecl>(MD) && GD.getCtorType() == Ctor_Base)
1697 return true;
1698
1699 // Check if we have a base destructor.
1700 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1701 return true;
1702
1703 return false;
1704}