blob: f5d23726a9c7a4c14f925ded9de08e0d55ea81a8 [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
Reid Kleckner40ca9132014-05-13 22:05:45 +000055 bool classifyReturnType(CGFunctionInfo &FI) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000056
Craig Topper4f12f102014-03-12 06:41:41 +000057 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override {
Reid Klecknerd355ca72014-05-15 01:26:32 +000058 // Structures with either a non-trivial destructor or a non-trivial
59 // copy constructor are always indirect.
60 // FIXME: Use canCopyArgument() when it is fixed to handle lazily declared
61 // special members.
62 if (RD->hasNonTrivialDestructor() || RD->hasNonTrivialCopyConstructor())
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000063 return RAA_Indirect;
64 return RAA_Default;
65 }
66
Craig Topper4f12f102014-03-12 06:41:41 +000067 bool isZeroInitializable(const MemberPointerType *MPT) override;
John McCall84fa5102010-08-22 04:16:24 +000068
Craig Topper4f12f102014-03-12 06:41:41 +000069 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
John McCall7a9aac22010-08-23 01:21:21 +000070
Craig Topper4f12f102014-03-12 06:41:41 +000071 llvm::Value *
72 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF,
73 const Expr *E,
74 llvm::Value *&This,
75 llvm::Value *MemFnPtr,
76 const MemberPointerType *MPT) override;
John McCalla8bbb822010-08-22 03:04:22 +000077
Craig Topper4f12f102014-03-12 06:41:41 +000078 llvm::Value *
79 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
80 llvm::Value *Base,
81 llvm::Value *MemPtr,
82 const MemberPointerType *MPT) override;
John McCallc134eb52010-08-31 21:07:20 +000083
John McCall7a9aac22010-08-23 01:21:21 +000084 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
85 const CastExpr *E,
Craig Topper4f12f102014-03-12 06:41:41 +000086 llvm::Value *Src) override;
John McCallc62bb392012-02-15 01:22:51 +000087 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
Craig Topper4f12f102014-03-12 06:41:41 +000088 llvm::Constant *Src) override;
John McCall84fa5102010-08-22 04:16:24 +000089
Craig Topper4f12f102014-03-12 06:41:41 +000090 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
John McCall84fa5102010-08-22 04:16:24 +000091
Craig Topper4f12f102014-03-12 06:41:41 +000092 llvm::Constant *EmitMemberPointer(const CXXMethodDecl *MD) override;
John McCallf3a88602011-02-03 08:15:49 +000093 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
Craig Topper4f12f102014-03-12 06:41:41 +000094 CharUnits offset) override;
95 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Richard Smithdafff942012-01-14 04:30:29 +000096 llvm::Constant *BuildMemberPointer(const CXXMethodDecl *MD,
97 CharUnits ThisAdjustment);
John McCall1c456c82010-08-22 06:43:33 +000098
John McCall7a9aac22010-08-23 01:21:21 +000099 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000100 llvm::Value *L, llvm::Value *R,
John McCall7a9aac22010-08-23 01:21:21 +0000101 const MemberPointerType *MPT,
Craig Topper4f12f102014-03-12 06:41:41 +0000102 bool Inequality) override;
John McCall131d97d2010-08-22 08:30:07 +0000103
John McCall7a9aac22010-08-23 01:21:21 +0000104 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000105 llvm::Value *Addr,
106 const MemberPointerType *MPT) override;
John McCall5d865c322010-08-31 07:33:07 +0000107
Craig Topper4f12f102014-03-12 06:41:41 +0000108 llvm::Value *adjustToCompleteObject(CodeGenFunction &CGF, llvm::Value *ptr,
109 QualType type) override;
John McCall82fb8922012-09-25 10:10:39 +0000110
Craig Topper4f12f102014-03-12 06:41:41 +0000111 llvm::Value *
112 GetVirtualBaseClassOffset(CodeGenFunction &CGF, llvm::Value *This,
113 const CXXRecordDecl *ClassDecl,
114 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000115
John McCall5d865c322010-08-31 07:33:07 +0000116 void BuildConstructorSignature(const CXXConstructorDecl *Ctor,
Craig Topper4f12f102014-03-12 06:41:41 +0000117 CXXCtorType T, CanQualType &ResTy,
118 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000119
Craig Topper4f12f102014-03-12 06:41:41 +0000120 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000121
John McCall5d865c322010-08-31 07:33:07 +0000122 void BuildDestructorSignature(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000123 CXXDtorType T, CanQualType &ResTy,
124 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000125
Reid Klecknere7de47e2013-07-22 13:51:44 +0000126 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000127 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000128 // Itanium does not emit any destructor variant as an inline thunk.
129 // Delegating may occur as an optimization, but all variants are either
130 // emitted with external linkage or as linkonce if they are inline and used.
131 return false;
132 }
133
Craig Topper4f12f102014-03-12 06:41:41 +0000134 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000135
Reid Kleckner89077a12013-12-17 19:46:40 +0000136 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000137 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000138
Craig Topper4f12f102014-03-12 06:41:41 +0000139 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall8ed55a52010-09-02 09:58:18 +0000140
Reid Kleckner89077a12013-12-17 19:46:40 +0000141 unsigned addImplicitConstructorArgs(CodeGenFunction &CGF,
142 const CXXConstructorDecl *D,
143 CXXCtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000144 bool Delegating,
145 CallArgList &Args) override;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000146
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000147 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
148 CXXDtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000149 bool Delegating, llvm::Value *This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000150
Craig Topper4f12f102014-03-12 06:41:41 +0000151 void emitVTableDefinitions(CodeGenVTables &CGVT,
152 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000153
154 llvm::Value *getVTableAddressPointInStructor(
155 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
156 BaseSubobject Base, const CXXRecordDecl *NearestVBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000157 bool &NeedsVirtualOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000158
159 llvm::Constant *
160 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000161 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000162
163 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000164 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000165
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000166 llvm::Value *getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000167 llvm::Value *This,
168 llvm::Type *Ty) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000169
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000170 void EmitVirtualDestructorCall(CodeGenFunction &CGF,
171 const CXXDestructorDecl *Dtor,
172 CXXDtorType DtorType, SourceLocation CallLoc,
Craig Topper4f12f102014-03-12 06:41:41 +0000173 llvm::Value *This) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000174
Craig Topper4f12f102014-03-12 06:41:41 +0000175 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000176
Craig Topper4f12f102014-03-12 06:41:41 +0000177 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000178 // Allow inlining of thunks by emitting them with available_externally
179 // linkage together with vtables when needed.
180 if (ForVTable)
181 Thunk->setLinkage(llvm::GlobalValue::AvailableExternallyLinkage);
182 }
183
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000184 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, llvm::Value *This,
Craig Topper4f12f102014-03-12 06:41:41 +0000185 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000186
187 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000188 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000189
Craig Topper4f12f102014-03-12 06:41:41 +0000190 StringRef GetPureVirtualCallName() override { return "__cxa_pure_virtual"; }
191 StringRef GetDeletedVirtualCallName() override
192 { return "__cxa_deleted_virtual"; }
Joao Matos2ce88ef2012-07-17 17:10:11 +0000193
Craig Topper4f12f102014-03-12 06:41:41 +0000194 CharUnits getArrayCookieSizeImpl(QualType elementType) override;
John McCall8ed55a52010-09-02 09:58:18 +0000195 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
196 llvm::Value *NewPtr,
197 llvm::Value *NumElements,
John McCall284c48f2011-01-27 09:37:56 +0000198 const CXXNewExpr *expr,
Craig Topper4f12f102014-03-12 06:41:41 +0000199 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000200 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
201 llvm::Value *allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000202 CharUnits cookieSize) override;
John McCall68ff0372010-09-08 01:44:27 +0000203
John McCallcdf7ef52010-11-06 09:44:32 +0000204 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Craig Topper4f12f102014-03-12 06:41:41 +0000205 llvm::GlobalVariable *DeclPtr,
206 bool PerformInit) override;
Richard Smithdbf74ba2013-04-14 23:01:42 +0000207 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
Craig Topper4f12f102014-03-12 06:41:41 +0000208 llvm::Constant *dtor, llvm::Constant *addr) override;
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000209
210 llvm::Function *getOrCreateThreadLocalWrapper(const VarDecl *VD,
211 llvm::GlobalVariable *Var);
212 void EmitThreadLocalInitFuncs(
213 llvm::ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *> > Decls,
Craig Topper4f12f102014-03-12 06:41:41 +0000214 llvm::Function *InitFunc) override;
Richard Smith0f383742014-03-26 22:48:22 +0000215 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
216 QualType LValType) override;
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000217
Craig Topper4f12f102014-03-12 06:41:41 +0000218 bool NeedsVTTParameter(GlobalDecl GD) override;
Charles Davis4e786dd2010-05-25 19:52:27 +0000219};
John McCall86353412010-08-21 22:46:04 +0000220
221class ARMCXXABI : public ItaniumCXXABI {
222public:
Mark Seabornedf0d382013-07-24 16:25:13 +0000223 ARMCXXABI(CodeGen::CodeGenModule &CGM) :
224 ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true,
225 /* UseARMGuardVarABI = */ true) {}
John McCall5d865c322010-08-31 07:33:07 +0000226
Craig Topper4f12f102014-03-12 06:41:41 +0000227 bool HasThisReturn(GlobalDecl GD) const override {
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000228 return (isa<CXXConstructorDecl>(GD.getDecl()) || (
229 isa<CXXDestructorDecl>(GD.getDecl()) &&
230 GD.getDtorType() != Dtor_Deleting));
231 }
John McCall5d865c322010-08-31 07:33:07 +0000232
Craig Topper4f12f102014-03-12 06:41:41 +0000233 void EmitReturnFromThunk(CodeGenFunction &CGF, RValue RV,
234 QualType ResTy) override;
John McCall5d865c322010-08-31 07:33:07 +0000235
Craig Topper4f12f102014-03-12 06:41:41 +0000236 CharUnits getArrayCookieSizeImpl(QualType elementType) override;
John McCall8ed55a52010-09-02 09:58:18 +0000237 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
238 llvm::Value *NewPtr,
239 llvm::Value *NumElements,
John McCall284c48f2011-01-27 09:37:56 +0000240 const CXXNewExpr *expr,
Craig Topper4f12f102014-03-12 06:41:41 +0000241 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000242 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF, llvm::Value *allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000243 CharUnits cookieSize) override;
John McCall86353412010-08-21 22:46:04 +0000244};
Tim Northovera2ee4332014-03-29 15:09:45 +0000245
246class iOS64CXXABI : public ARMCXXABI {
247public:
248 iOS64CXXABI(CodeGen::CodeGenModule &CGM) : ARMCXXABI(CGM) {}
Tim Northover65f582f2014-03-30 17:32:48 +0000249
250 // ARM64 libraries are prepared for non-unique RTTI.
251 bool shouldRTTIBeUnique() override { return false; }
Tim Northovera2ee4332014-03-29 15:09:45 +0000252};
Charles Davis4e786dd2010-05-25 19:52:27 +0000253}
254
Charles Davis53c59df2010-08-16 03:33:14 +0000255CodeGen::CGCXXABI *CodeGen::CreateItaniumCXXABI(CodeGenModule &CGM) {
John McCallc8e01702013-04-16 22:48:15 +0000256 switch (CGM.getTarget().getCXXABI().getKind()) {
John McCall57625922013-01-25 23:36:14 +0000257 // For IR-generation purposes, there's no significant difference
258 // between the ARM and iOS ABIs.
259 case TargetCXXABI::GenericARM:
260 case TargetCXXABI::iOS:
261 return new ARMCXXABI(CGM);
Charles Davis4e786dd2010-05-25 19:52:27 +0000262
Tim Northovera2ee4332014-03-29 15:09:45 +0000263 case TargetCXXABI::iOS64:
264 return new iOS64CXXABI(CGM);
265
Tim Northover9bb857a2013-01-31 12:13:10 +0000266 // Note that AArch64 uses the generic ItaniumCXXABI class since it doesn't
267 // include the other 32-bit ARM oddities: constructor/destructor return values
268 // and array cookies.
269 case TargetCXXABI::GenericAArch64:
Mark Seabornedf0d382013-07-24 16:25:13 +0000270 return new ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true,
271 /* UseARMGuardVarABI = */ true);
Tim Northover9bb857a2013-01-31 12:13:10 +0000272
John McCall57625922013-01-25 23:36:14 +0000273 case TargetCXXABI::GenericItanium:
Mark Seabornedf0d382013-07-24 16:25:13 +0000274 if (CGM.getContext().getTargetInfo().getTriple().getArch()
275 == llvm::Triple::le32) {
276 // For PNaCl, use ARM-style method pointers so that PNaCl code
277 // does not assume anything about the alignment of function
278 // pointers.
279 return new ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true,
280 /* UseARMGuardVarABI = */ false);
281 }
John McCall57625922013-01-25 23:36:14 +0000282 return new ItaniumCXXABI(CGM);
283
284 case TargetCXXABI::Microsoft:
285 llvm_unreachable("Microsoft ABI is not Itanium-based");
286 }
287 llvm_unreachable("bad ABI kind");
John McCall86353412010-08-21 22:46:04 +0000288}
289
Chris Lattnera5f58b02011-07-09 17:41:47 +0000290llvm::Type *
John McCall7a9aac22010-08-23 01:21:21 +0000291ItaniumCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
292 if (MPT->isMemberDataPointer())
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000293 return CGM.PtrDiffTy;
294 return llvm::StructType::get(CGM.PtrDiffTy, CGM.PtrDiffTy, NULL);
John McCall1c456c82010-08-22 06:43:33 +0000295}
296
John McCalld9c6c0b2010-08-22 00:59:17 +0000297/// In the Itanium and ARM ABIs, method pointers have the form:
298/// struct { ptrdiff_t ptr; ptrdiff_t adj; } memptr;
299///
300/// In the Itanium ABI:
301/// - method pointers are virtual if (memptr.ptr & 1) is nonzero
302/// - the this-adjustment is (memptr.adj)
303/// - the virtual offset is (memptr.ptr - 1)
304///
305/// In the ARM ABI:
306/// - method pointers are virtual if (memptr.adj & 1) is nonzero
307/// - the this-adjustment is (memptr.adj >> 1)
308/// - the virtual offset is (memptr.ptr)
309/// ARM uses 'adj' for the virtual flag because Thumb functions
310/// may be only single-byte aligned.
311///
312/// If the member is virtual, the adjusted 'this' pointer points
313/// to a vtable pointer from which the virtual offset is applied.
314///
315/// If the member is non-virtual, memptr.ptr is the address of
316/// the function to call.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000317llvm::Value *ItaniumCXXABI::EmitLoadOfMemberFunctionPointer(
318 CodeGenFunction &CGF, const Expr *E, llvm::Value *&This,
319 llvm::Value *MemFnPtr, const MemberPointerType *MPT) {
John McCall475999d2010-08-22 00:05:51 +0000320 CGBuilderTy &Builder = CGF.Builder;
321
322 const FunctionProtoType *FPT =
323 MPT->getPointeeType()->getAs<FunctionProtoType>();
324 const CXXRecordDecl *RD =
325 cast<CXXRecordDecl>(MPT->getClass()->getAs<RecordType>()->getDecl());
326
Chris Lattner2192fe52011-07-18 04:24:23 +0000327 llvm::FunctionType *FTy =
John McCalla729c622012-02-17 03:33:10 +0000328 CGM.getTypes().GetFunctionType(
329 CGM.getTypes().arrangeCXXMethodType(RD, FPT));
John McCall475999d2010-08-22 00:05:51 +0000330
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000331 llvm::Constant *ptrdiff_1 = llvm::ConstantInt::get(CGM.PtrDiffTy, 1);
John McCall475999d2010-08-22 00:05:51 +0000332
John McCalld9c6c0b2010-08-22 00:59:17 +0000333 llvm::BasicBlock *FnVirtual = CGF.createBasicBlock("memptr.virtual");
334 llvm::BasicBlock *FnNonVirtual = CGF.createBasicBlock("memptr.nonvirtual");
335 llvm::BasicBlock *FnEnd = CGF.createBasicBlock("memptr.end");
336
John McCalla1dee5302010-08-22 10:59:02 +0000337 // Extract memptr.adj, which is in the second field.
338 llvm::Value *RawAdj = Builder.CreateExtractValue(MemFnPtr, 1, "memptr.adj");
John McCalld9c6c0b2010-08-22 00:59:17 +0000339
340 // Compute the true adjustment.
341 llvm::Value *Adj = RawAdj;
Mark Seabornedf0d382013-07-24 16:25:13 +0000342 if (UseARMMethodPtrABI)
John McCalld9c6c0b2010-08-22 00:59:17 +0000343 Adj = Builder.CreateAShr(Adj, ptrdiff_1, "memptr.adj.shifted");
John McCall475999d2010-08-22 00:05:51 +0000344
345 // Apply the adjustment and cast back to the original struct type
346 // for consistency.
John McCalld9c6c0b2010-08-22 00:59:17 +0000347 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy());
348 Ptr = Builder.CreateInBoundsGEP(Ptr, Adj);
349 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted");
John McCall475999d2010-08-22 00:05:51 +0000350
351 // Load the function pointer.
John McCalla1dee5302010-08-22 10:59:02 +0000352 llvm::Value *FnAsInt = Builder.CreateExtractValue(MemFnPtr, 0, "memptr.ptr");
John McCall475999d2010-08-22 00:05:51 +0000353
354 // If the LSB in the function pointer is 1, the function pointer points to
355 // a virtual function.
John McCalld9c6c0b2010-08-22 00:59:17 +0000356 llvm::Value *IsVirtual;
Mark Seabornedf0d382013-07-24 16:25:13 +0000357 if (UseARMMethodPtrABI)
John McCalld9c6c0b2010-08-22 00:59:17 +0000358 IsVirtual = Builder.CreateAnd(RawAdj, ptrdiff_1);
359 else
360 IsVirtual = Builder.CreateAnd(FnAsInt, ptrdiff_1);
361 IsVirtual = Builder.CreateIsNotNull(IsVirtual, "memptr.isvirtual");
John McCall475999d2010-08-22 00:05:51 +0000362 Builder.CreateCondBr(IsVirtual, FnVirtual, FnNonVirtual);
363
364 // In the virtual path, the adjustment left 'This' pointing to the
365 // vtable of the correct base subobject. The "function pointer" is an
John McCalld9c6c0b2010-08-22 00:59:17 +0000366 // offset within the vtable (+1 for the virtual flag on non-ARM).
John McCall475999d2010-08-22 00:05:51 +0000367 CGF.EmitBlock(FnVirtual);
368
369 // Cast the adjusted this to a pointer to vtable pointer and load.
Chris Lattner2192fe52011-07-18 04:24:23 +0000370 llvm::Type *VTableTy = Builder.getInt8PtrTy();
Richard Smith0fc7bdc2014-03-12 18:26:14 +0000371 llvm::Value *VTable = CGF.GetVTablePtr(This, VTableTy);
John McCall475999d2010-08-22 00:05:51 +0000372
373 // Apply the offset.
John McCalld9c6c0b2010-08-22 00:59:17 +0000374 llvm::Value *VTableOffset = FnAsInt;
Mark Seabornedf0d382013-07-24 16:25:13 +0000375 if (!UseARMMethodPtrABI)
376 VTableOffset = Builder.CreateSub(VTableOffset, ptrdiff_1);
John McCalld9c6c0b2010-08-22 00:59:17 +0000377 VTable = Builder.CreateGEP(VTable, VTableOffset);
John McCall475999d2010-08-22 00:05:51 +0000378
379 // Load the virtual function to call.
380 VTable = Builder.CreateBitCast(VTable, FTy->getPointerTo()->getPointerTo());
John McCalld9c6c0b2010-08-22 00:59:17 +0000381 llvm::Value *VirtualFn = Builder.CreateLoad(VTable, "memptr.virtualfn");
John McCall475999d2010-08-22 00:05:51 +0000382 CGF.EmitBranch(FnEnd);
383
384 // In the non-virtual path, the function pointer is actually a
385 // function pointer.
386 CGF.EmitBlock(FnNonVirtual);
387 llvm::Value *NonVirtualFn =
John McCalld9c6c0b2010-08-22 00:59:17 +0000388 Builder.CreateIntToPtr(FnAsInt, FTy->getPointerTo(), "memptr.nonvirtualfn");
John McCall475999d2010-08-22 00:05:51 +0000389
390 // We're done.
391 CGF.EmitBlock(FnEnd);
Jay Foad20c0f022011-03-30 11:28:58 +0000392 llvm::PHINode *Callee = Builder.CreatePHI(FTy->getPointerTo(), 2);
John McCall475999d2010-08-22 00:05:51 +0000393 Callee->addIncoming(VirtualFn, FnVirtual);
394 Callee->addIncoming(NonVirtualFn, FnNonVirtual);
395 return Callee;
396}
John McCalla8bbb822010-08-22 03:04:22 +0000397
John McCallc134eb52010-08-31 21:07:20 +0000398/// Compute an l-value by applying the given pointer-to-member to a
399/// base object.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000400llvm::Value *ItaniumCXXABI::EmitMemberDataPointerAddress(
401 CodeGenFunction &CGF, const Expr *E, llvm::Value *Base, llvm::Value *MemPtr,
402 const MemberPointerType *MPT) {
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000403 assert(MemPtr->getType() == CGM.PtrDiffTy);
John McCallc134eb52010-08-31 21:07:20 +0000404
405 CGBuilderTy &Builder = CGF.Builder;
406
Micah Villmowea2fea22012-10-25 15:39:14 +0000407 unsigned AS = Base->getType()->getPointerAddressSpace();
John McCallc134eb52010-08-31 21:07:20 +0000408
409 // Cast to char*.
410 Base = Builder.CreateBitCast(Base, Builder.getInt8Ty()->getPointerTo(AS));
411
412 // Apply the offset, which we assume is non-null.
413 llvm::Value *Addr = Builder.CreateInBoundsGEP(Base, MemPtr, "memptr.offset");
414
415 // Cast the address to the appropriate pointer type, adopting the
416 // address space of the base pointer.
Chris Lattner2192fe52011-07-18 04:24:23 +0000417 llvm::Type *PType
Douglas Gregor04f36212010-09-02 17:38:50 +0000418 = CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
John McCallc134eb52010-08-31 21:07:20 +0000419 return Builder.CreateBitCast(Addr, PType);
420}
421
John McCallc62bb392012-02-15 01:22:51 +0000422/// Perform a bitcast, derived-to-base, or base-to-derived member pointer
423/// conversion.
424///
425/// Bitcast conversions are always a no-op under Itanium.
John McCall7a9aac22010-08-23 01:21:21 +0000426///
427/// Obligatory offset/adjustment diagram:
428/// <-- offset --> <-- adjustment -->
429/// |--------------------------|----------------------|--------------------|
430/// ^Derived address point ^Base address point ^Member address point
431///
432/// So when converting a base member pointer to a derived member pointer,
433/// we add the offset to the adjustment because the address point has
434/// decreased; and conversely, when converting a derived MP to a base MP
435/// we subtract the offset from the adjustment because the address point
436/// has increased.
437///
438/// The standard forbids (at compile time) conversion to and from
439/// virtual bases, which is why we don't have to consider them here.
440///
441/// The standard forbids (at run time) casting a derived MP to a base
442/// MP when the derived MP does not point to a member of the base.
443/// This is why -1 is a reasonable choice for null data member
444/// pointers.
John McCalla1dee5302010-08-22 10:59:02 +0000445llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000446ItaniumCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
447 const CastExpr *E,
John McCallc62bb392012-02-15 01:22:51 +0000448 llvm::Value *src) {
John McCalle3027922010-08-25 11:45:40 +0000449 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
John McCallc62bb392012-02-15 01:22:51 +0000450 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
451 E->getCastKind() == CK_ReinterpretMemberPointer);
452
453 // Under Itanium, reinterprets don't require any additional processing.
454 if (E->getCastKind() == CK_ReinterpretMemberPointer) return src;
455
456 // Use constant emission if we can.
457 if (isa<llvm::Constant>(src))
458 return EmitMemberPointerConversion(E, cast<llvm::Constant>(src));
459
460 llvm::Constant *adj = getMemberPointerAdjustment(E);
461 if (!adj) return src;
John McCalla8bbb822010-08-22 03:04:22 +0000462
463 CGBuilderTy &Builder = CGF.Builder;
John McCallc62bb392012-02-15 01:22:51 +0000464 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
John McCalla8bbb822010-08-22 03:04:22 +0000465
John McCallc62bb392012-02-15 01:22:51 +0000466 const MemberPointerType *destTy =
467 E->getType()->castAs<MemberPointerType>();
John McCall1c456c82010-08-22 06:43:33 +0000468
John McCall7a9aac22010-08-23 01:21:21 +0000469 // For member data pointers, this is just a matter of adding the
470 // offset if the source is non-null.
John McCallc62bb392012-02-15 01:22:51 +0000471 if (destTy->isMemberDataPointer()) {
472 llvm::Value *dst;
473 if (isDerivedToBase)
474 dst = Builder.CreateNSWSub(src, adj, "adj");
John McCall7a9aac22010-08-23 01:21:21 +0000475 else
John McCallc62bb392012-02-15 01:22:51 +0000476 dst = Builder.CreateNSWAdd(src, adj, "adj");
John McCall7a9aac22010-08-23 01:21:21 +0000477
478 // Null check.
John McCallc62bb392012-02-15 01:22:51 +0000479 llvm::Value *null = llvm::Constant::getAllOnesValue(src->getType());
480 llvm::Value *isNull = Builder.CreateICmpEQ(src, null, "memptr.isnull");
481 return Builder.CreateSelect(isNull, src, dst);
John McCall7a9aac22010-08-23 01:21:21 +0000482 }
483
John McCalla1dee5302010-08-22 10:59:02 +0000484 // The this-adjustment is left-shifted by 1 on ARM.
Mark Seabornedf0d382013-07-24 16:25:13 +0000485 if (UseARMMethodPtrABI) {
John McCallc62bb392012-02-15 01:22:51 +0000486 uint64_t offset = cast<llvm::ConstantInt>(adj)->getZExtValue();
487 offset <<= 1;
488 adj = llvm::ConstantInt::get(adj->getType(), offset);
John McCalla1dee5302010-08-22 10:59:02 +0000489 }
490
John McCallc62bb392012-02-15 01:22:51 +0000491 llvm::Value *srcAdj = Builder.CreateExtractValue(src, 1, "src.adj");
492 llvm::Value *dstAdj;
493 if (isDerivedToBase)
494 dstAdj = Builder.CreateNSWSub(srcAdj, adj, "adj");
John McCalla1dee5302010-08-22 10:59:02 +0000495 else
John McCallc62bb392012-02-15 01:22:51 +0000496 dstAdj = Builder.CreateNSWAdd(srcAdj, adj, "adj");
John McCalla1dee5302010-08-22 10:59:02 +0000497
John McCallc62bb392012-02-15 01:22:51 +0000498 return Builder.CreateInsertValue(src, dstAdj, 1);
499}
500
501llvm::Constant *
502ItaniumCXXABI::EmitMemberPointerConversion(const CastExpr *E,
503 llvm::Constant *src) {
504 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
505 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
506 E->getCastKind() == CK_ReinterpretMemberPointer);
507
508 // Under Itanium, reinterprets don't require any additional processing.
509 if (E->getCastKind() == CK_ReinterpretMemberPointer) return src;
510
511 // If the adjustment is trivial, we don't need to do anything.
512 llvm::Constant *adj = getMemberPointerAdjustment(E);
513 if (!adj) return src;
514
515 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
516
517 const MemberPointerType *destTy =
518 E->getType()->castAs<MemberPointerType>();
519
520 // For member data pointers, this is just a matter of adding the
521 // offset if the source is non-null.
522 if (destTy->isMemberDataPointer()) {
523 // null maps to null.
524 if (src->isAllOnesValue()) return src;
525
526 if (isDerivedToBase)
527 return llvm::ConstantExpr::getNSWSub(src, adj);
528 else
529 return llvm::ConstantExpr::getNSWAdd(src, adj);
530 }
531
532 // The this-adjustment is left-shifted by 1 on ARM.
Mark Seabornedf0d382013-07-24 16:25:13 +0000533 if (UseARMMethodPtrABI) {
John McCallc62bb392012-02-15 01:22:51 +0000534 uint64_t offset = cast<llvm::ConstantInt>(adj)->getZExtValue();
535 offset <<= 1;
536 adj = llvm::ConstantInt::get(adj->getType(), offset);
537 }
538
539 llvm::Constant *srcAdj = llvm::ConstantExpr::getExtractValue(src, 1);
540 llvm::Constant *dstAdj;
541 if (isDerivedToBase)
542 dstAdj = llvm::ConstantExpr::getNSWSub(srcAdj, adj);
543 else
544 dstAdj = llvm::ConstantExpr::getNSWAdd(srcAdj, adj);
545
546 return llvm::ConstantExpr::getInsertValue(src, dstAdj, 1);
John McCalla8bbb822010-08-22 03:04:22 +0000547}
John McCall84fa5102010-08-22 04:16:24 +0000548
549llvm::Constant *
John McCall7a9aac22010-08-23 01:21:21 +0000550ItaniumCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
John McCall7a9aac22010-08-23 01:21:21 +0000551 // Itanium C++ ABI 2.3:
552 // A NULL pointer is represented as -1.
553 if (MPT->isMemberDataPointer())
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000554 return llvm::ConstantInt::get(CGM.PtrDiffTy, -1ULL, /*isSigned=*/true);
John McCalla1dee5302010-08-22 10:59:02 +0000555
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000556 llvm::Constant *Zero = llvm::ConstantInt::get(CGM.PtrDiffTy, 0);
John McCalla1dee5302010-08-22 10:59:02 +0000557 llvm::Constant *Values[2] = { Zero, Zero };
Chris Lattnere64d7ba2011-06-20 04:01:35 +0000558 return llvm::ConstantStruct::getAnon(Values);
John McCall84fa5102010-08-22 04:16:24 +0000559}
560
John McCallf3a88602011-02-03 08:15:49 +0000561llvm::Constant *
562ItaniumCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
563 CharUnits offset) {
John McCall7a9aac22010-08-23 01:21:21 +0000564 // Itanium C++ ABI 2.3:
565 // A pointer to data member is an offset from the base address of
566 // the class object containing it, represented as a ptrdiff_t
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000567 return llvm::ConstantInt::get(CGM.PtrDiffTy, offset.getQuantity());
John McCall7a9aac22010-08-23 01:21:21 +0000568}
569
John McCall2979fe02011-04-12 00:42:48 +0000570llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const CXXMethodDecl *MD) {
Richard Smithdafff942012-01-14 04:30:29 +0000571 return BuildMemberPointer(MD, CharUnits::Zero());
572}
573
574llvm::Constant *ItaniumCXXABI::BuildMemberPointer(const CXXMethodDecl *MD,
575 CharUnits ThisAdjustment) {
John McCalla1dee5302010-08-22 10:59:02 +0000576 assert(MD->isInstance() && "Member function must not be static!");
577 MD = MD->getCanonicalDecl();
578
579 CodeGenTypes &Types = CGM.getTypes();
John McCalla1dee5302010-08-22 10:59:02 +0000580
581 // Get the function pointer (or index if this is a virtual function).
582 llvm::Constant *MemPtr[2];
583 if (MD->isVirtual()) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000584 uint64_t Index = CGM.getItaniumVTableContext().getMethodVTableIndex(MD);
John McCalla1dee5302010-08-22 10:59:02 +0000585
Ken Dyckdf016282011-04-09 01:30:02 +0000586 const ASTContext &Context = getContext();
587 CharUnits PointerWidth =
Douglas Gregore8bbc122011-09-02 00:18:52 +0000588 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
Ken Dyckdf016282011-04-09 01:30:02 +0000589 uint64_t VTableOffset = (Index * PointerWidth.getQuantity());
John McCalla1dee5302010-08-22 10:59:02 +0000590
Mark Seabornedf0d382013-07-24 16:25:13 +0000591 if (UseARMMethodPtrABI) {
John McCalla1dee5302010-08-22 10:59:02 +0000592 // ARM C++ ABI 3.2.1:
593 // This ABI specifies that adj contains twice the this
594 // adjustment, plus 1 if the member function is virtual. The
595 // least significant bit of adj then makes exactly the same
596 // discrimination as the least significant bit of ptr does for
597 // Itanium.
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000598 MemPtr[0] = llvm::ConstantInt::get(CGM.PtrDiffTy, VTableOffset);
599 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy,
Richard Smithdafff942012-01-14 04:30:29 +0000600 2 * ThisAdjustment.getQuantity() + 1);
John McCalla1dee5302010-08-22 10:59:02 +0000601 } else {
602 // Itanium C++ ABI 2.3:
603 // For a virtual function, [the pointer field] is 1 plus the
604 // virtual table offset (in bytes) of the function,
605 // represented as a ptrdiff_t.
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000606 MemPtr[0] = llvm::ConstantInt::get(CGM.PtrDiffTy, VTableOffset + 1);
607 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy,
Richard Smithdafff942012-01-14 04:30:29 +0000608 ThisAdjustment.getQuantity());
John McCalla1dee5302010-08-22 10:59:02 +0000609 }
610 } else {
John McCall2979fe02011-04-12 00:42:48 +0000611 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Chris Lattner2192fe52011-07-18 04:24:23 +0000612 llvm::Type *Ty;
John McCall2979fe02011-04-12 00:42:48 +0000613 // Check whether the function has a computable LLVM signature.
Chris Lattner8806e322011-07-10 00:18:59 +0000614 if (Types.isFuncTypeConvertible(FPT)) {
John McCall2979fe02011-04-12 00:42:48 +0000615 // The function has a computable LLVM signature; use the correct type.
John McCalla729c622012-02-17 03:33:10 +0000616 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
John McCalla1dee5302010-08-22 10:59:02 +0000617 } else {
John McCall2979fe02011-04-12 00:42:48 +0000618 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
619 // function type is incomplete.
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000620 Ty = CGM.PtrDiffTy;
John McCalla1dee5302010-08-22 10:59:02 +0000621 }
John McCall2979fe02011-04-12 00:42:48 +0000622 llvm::Constant *addr = CGM.GetAddrOfFunction(MD, Ty);
John McCalla1dee5302010-08-22 10:59:02 +0000623
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000624 MemPtr[0] = llvm::ConstantExpr::getPtrToInt(addr, CGM.PtrDiffTy);
Mark Seabornedf0d382013-07-24 16:25:13 +0000625 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy,
626 (UseARMMethodPtrABI ? 2 : 1) *
Richard Smithdafff942012-01-14 04:30:29 +0000627 ThisAdjustment.getQuantity());
John McCalla1dee5302010-08-22 10:59:02 +0000628 }
John McCall1c456c82010-08-22 06:43:33 +0000629
Chris Lattnere64d7ba2011-06-20 04:01:35 +0000630 return llvm::ConstantStruct::getAnon(MemPtr);
John McCall1c456c82010-08-22 06:43:33 +0000631}
632
Richard Smithdafff942012-01-14 04:30:29 +0000633llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const APValue &MP,
634 QualType MPType) {
635 const MemberPointerType *MPT = MPType->castAs<MemberPointerType>();
636 const ValueDecl *MPD = MP.getMemberPointerDecl();
637 if (!MPD)
638 return EmitNullMemberPointer(MPT);
639
Reid Kleckner452abac2013-05-09 21:01:17 +0000640 CharUnits ThisAdjustment = getMemberPointerPathAdjustment(MP);
Richard Smithdafff942012-01-14 04:30:29 +0000641
642 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD))
643 return BuildMemberPointer(MD, ThisAdjustment);
644
645 CharUnits FieldOffset =
646 getContext().toCharUnitsFromBits(getContext().getFieldOffset(MPD));
647 return EmitMemberDataPointer(MPT, ThisAdjustment + FieldOffset);
648}
649
John McCall131d97d2010-08-22 08:30:07 +0000650/// The comparison algorithm is pretty easy: the member pointers are
651/// the same if they're either bitwise identical *or* both null.
652///
653/// ARM is different here only because null-ness is more complicated.
654llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000655ItaniumCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
656 llvm::Value *L,
657 llvm::Value *R,
658 const MemberPointerType *MPT,
659 bool Inequality) {
John McCall131d97d2010-08-22 08:30:07 +0000660 CGBuilderTy &Builder = CGF.Builder;
661
John McCall131d97d2010-08-22 08:30:07 +0000662 llvm::ICmpInst::Predicate Eq;
663 llvm::Instruction::BinaryOps And, Or;
664 if (Inequality) {
665 Eq = llvm::ICmpInst::ICMP_NE;
666 And = llvm::Instruction::Or;
667 Or = llvm::Instruction::And;
668 } else {
669 Eq = llvm::ICmpInst::ICMP_EQ;
670 And = llvm::Instruction::And;
671 Or = llvm::Instruction::Or;
672 }
673
John McCall7a9aac22010-08-23 01:21:21 +0000674 // Member data pointers are easy because there's a unique null
675 // value, so it just comes down to bitwise equality.
676 if (MPT->isMemberDataPointer())
677 return Builder.CreateICmp(Eq, L, R);
678
679 // For member function pointers, the tautologies are more complex.
680 // The Itanium tautology is:
John McCall61a14882010-08-23 06:56:36 +0000681 // (L == R) <==> (L.ptr == R.ptr && (L.ptr == 0 || L.adj == R.adj))
John McCall7a9aac22010-08-23 01:21:21 +0000682 // The ARM tautology is:
John McCall61a14882010-08-23 06:56:36 +0000683 // (L == R) <==> (L.ptr == R.ptr &&
684 // (L.adj == R.adj ||
685 // (L.ptr == 0 && ((L.adj|R.adj) & 1) == 0)))
John McCall7a9aac22010-08-23 01:21:21 +0000686 // The inequality tautologies have exactly the same structure, except
687 // applying De Morgan's laws.
688
689 llvm::Value *LPtr = Builder.CreateExtractValue(L, 0, "lhs.memptr.ptr");
690 llvm::Value *RPtr = Builder.CreateExtractValue(R, 0, "rhs.memptr.ptr");
691
John McCall131d97d2010-08-22 08:30:07 +0000692 // This condition tests whether L.ptr == R.ptr. This must always be
693 // true for equality to hold.
694 llvm::Value *PtrEq = Builder.CreateICmp(Eq, LPtr, RPtr, "cmp.ptr");
695
696 // This condition, together with the assumption that L.ptr == R.ptr,
697 // tests whether the pointers are both null. ARM imposes an extra
698 // condition.
699 llvm::Value *Zero = llvm::Constant::getNullValue(LPtr->getType());
700 llvm::Value *EqZero = Builder.CreateICmp(Eq, LPtr, Zero, "cmp.ptr.null");
701
702 // This condition tests whether L.adj == R.adj. If this isn't
703 // true, the pointers are unequal unless they're both null.
John McCalla1dee5302010-08-22 10:59:02 +0000704 llvm::Value *LAdj = Builder.CreateExtractValue(L, 1, "lhs.memptr.adj");
705 llvm::Value *RAdj = Builder.CreateExtractValue(R, 1, "rhs.memptr.adj");
John McCall131d97d2010-08-22 08:30:07 +0000706 llvm::Value *AdjEq = Builder.CreateICmp(Eq, LAdj, RAdj, "cmp.adj");
707
708 // Null member function pointers on ARM clear the low bit of Adj,
709 // so the zero condition has to check that neither low bit is set.
Mark Seabornedf0d382013-07-24 16:25:13 +0000710 if (UseARMMethodPtrABI) {
John McCall131d97d2010-08-22 08:30:07 +0000711 llvm::Value *One = llvm::ConstantInt::get(LPtr->getType(), 1);
712
713 // Compute (l.adj | r.adj) & 1 and test it against zero.
714 llvm::Value *OrAdj = Builder.CreateOr(LAdj, RAdj, "or.adj");
715 llvm::Value *OrAdjAnd1 = Builder.CreateAnd(OrAdj, One);
716 llvm::Value *OrAdjAnd1EqZero = Builder.CreateICmp(Eq, OrAdjAnd1, Zero,
717 "cmp.or.adj");
718 EqZero = Builder.CreateBinOp(And, EqZero, OrAdjAnd1EqZero);
719 }
720
721 // Tie together all our conditions.
722 llvm::Value *Result = Builder.CreateBinOp(Or, EqZero, AdjEq);
723 Result = Builder.CreateBinOp(And, PtrEq, Result,
724 Inequality ? "memptr.ne" : "memptr.eq");
725 return Result;
726}
727
728llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000729ItaniumCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
730 llvm::Value *MemPtr,
731 const MemberPointerType *MPT) {
John McCall131d97d2010-08-22 08:30:07 +0000732 CGBuilderTy &Builder = CGF.Builder;
John McCall7a9aac22010-08-23 01:21:21 +0000733
734 /// For member data pointers, this is just a check against -1.
735 if (MPT->isMemberDataPointer()) {
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000736 assert(MemPtr->getType() == CGM.PtrDiffTy);
John McCall7a9aac22010-08-23 01:21:21 +0000737 llvm::Value *NegativeOne =
738 llvm::Constant::getAllOnesValue(MemPtr->getType());
739 return Builder.CreateICmpNE(MemPtr, NegativeOne, "memptr.tobool");
740 }
John McCall131d97d2010-08-22 08:30:07 +0000741
Daniel Dunbar914bc412011-04-19 23:10:47 +0000742 // In Itanium, a member function pointer is not null if 'ptr' is not null.
John McCalla1dee5302010-08-22 10:59:02 +0000743 llvm::Value *Ptr = Builder.CreateExtractValue(MemPtr, 0, "memptr.ptr");
John McCall131d97d2010-08-22 08:30:07 +0000744
745 llvm::Constant *Zero = llvm::ConstantInt::get(Ptr->getType(), 0);
746 llvm::Value *Result = Builder.CreateICmpNE(Ptr, Zero, "memptr.tobool");
747
Daniel Dunbar914bc412011-04-19 23:10:47 +0000748 // On ARM, a member function pointer is also non-null if the low bit of 'adj'
749 // (the virtual bit) is set.
Mark Seabornedf0d382013-07-24 16:25:13 +0000750 if (UseARMMethodPtrABI) {
John McCall131d97d2010-08-22 08:30:07 +0000751 llvm::Constant *One = llvm::ConstantInt::get(Ptr->getType(), 1);
John McCalla1dee5302010-08-22 10:59:02 +0000752 llvm::Value *Adj = Builder.CreateExtractValue(MemPtr, 1, "memptr.adj");
John McCall131d97d2010-08-22 08:30:07 +0000753 llvm::Value *VirtualBit = Builder.CreateAnd(Adj, One, "memptr.virtualbit");
Daniel Dunbar914bc412011-04-19 23:10:47 +0000754 llvm::Value *IsVirtual = Builder.CreateICmpNE(VirtualBit, Zero,
755 "memptr.isvirtual");
756 Result = Builder.CreateOr(Result, IsVirtual);
John McCall131d97d2010-08-22 08:30:07 +0000757 }
758
759 return Result;
760}
John McCall1c456c82010-08-22 06:43:33 +0000761
Reid Kleckner40ca9132014-05-13 22:05:45 +0000762bool ItaniumCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
763 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
764 if (!RD)
765 return false;
766
Reid Klecknerd355ca72014-05-15 01:26:32 +0000767 // Return indirectly if we have a non-trivial copy ctor or non-trivial dtor.
768 // FIXME: Use canCopyArgument() when it is fixed to handle lazily declared
769 // special members.
770 if (RD->hasNonTrivialDestructor() || RD->hasNonTrivialCopyConstructor()) {
Reid Kleckner40ca9132014-05-13 22:05:45 +0000771 FI.getReturnInfo() = ABIArgInfo::getIndirect(0, /*ByVal=*/false);
772 return true;
773 }
Reid Kleckner40ca9132014-05-13 22:05:45 +0000774 return false;
775}
776
John McCall614dbdc2010-08-22 21:01:12 +0000777/// The Itanium ABI requires non-zero initialization only for data
778/// member pointers, for which '0' is a valid offset.
779bool ItaniumCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
780 return MPT->getPointeeType()->isFunctionType();
John McCall84fa5102010-08-22 04:16:24 +0000781}
John McCall5d865c322010-08-31 07:33:07 +0000782
John McCall82fb8922012-09-25 10:10:39 +0000783/// The Itanium ABI always places an offset to the complete object
784/// at entry -2 in the vtable.
785llvm::Value *ItaniumCXXABI::adjustToCompleteObject(CodeGenFunction &CGF,
786 llvm::Value *ptr,
787 QualType type) {
788 // Grab the vtable pointer as an intptr_t*.
789 llvm::Value *vtable = CGF.GetVTablePtr(ptr, CGF.IntPtrTy->getPointerTo());
790
791 // Track back to entry -2 and pull out the offset there.
792 llvm::Value *offsetPtr =
793 CGF.Builder.CreateConstInBoundsGEP1_64(vtable, -2, "complete-offset.ptr");
794 llvm::LoadInst *offset = CGF.Builder.CreateLoad(offsetPtr);
795 offset->setAlignment(CGF.PointerAlignInBytes);
796
797 // Apply the offset.
798 ptr = CGF.Builder.CreateBitCast(ptr, CGF.Int8PtrTy);
799 return CGF.Builder.CreateInBoundsGEP(ptr, offset);
800}
801
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000802llvm::Value *
803ItaniumCXXABI::GetVirtualBaseClassOffset(CodeGenFunction &CGF,
804 llvm::Value *This,
805 const CXXRecordDecl *ClassDecl,
806 const CXXRecordDecl *BaseClassDecl) {
807 llvm::Value *VTablePtr = CGF.GetVTablePtr(This, CGM.Int8PtrTy);
808 CharUnits VBaseOffsetOffset =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000809 CGM.getItaniumVTableContext().getVirtualBaseOffsetOffset(ClassDecl,
810 BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000811
812 llvm::Value *VBaseOffsetPtr =
813 CGF.Builder.CreateConstGEP1_64(VTablePtr, VBaseOffsetOffset.getQuantity(),
814 "vbase.offset.ptr");
815 VBaseOffsetPtr = CGF.Builder.CreateBitCast(VBaseOffsetPtr,
816 CGM.PtrDiffTy->getPointerTo());
817
818 llvm::Value *VBaseOffset =
819 CGF.Builder.CreateLoad(VBaseOffsetPtr, "vbase.offset");
820
821 return VBaseOffset;
822}
823
John McCall5d865c322010-08-31 07:33:07 +0000824/// The generic ABI passes 'this', plus a VTT if it's initializing a
825/// base subobject.
Reid Kleckner89077a12013-12-17 19:46:40 +0000826void
827ItaniumCXXABI::BuildConstructorSignature(const CXXConstructorDecl *Ctor,
828 CXXCtorType Type, CanQualType &ResTy,
829 SmallVectorImpl<CanQualType> &ArgTys) {
John McCall9bca9232010-09-02 10:25:57 +0000830 ASTContext &Context = getContext();
John McCall5d865c322010-08-31 07:33:07 +0000831
Reid Kleckner89077a12013-12-17 19:46:40 +0000832 // All parameters are already in place except VTT, which goes after 'this'.
833 // These are Clang types, so we don't need to worry about sret yet.
John McCall5d865c322010-08-31 07:33:07 +0000834
835 // Check if we need to add a VTT parameter (which has type void **).
836 if (Type == Ctor_Base && Ctor->getParent()->getNumVBases() != 0)
Reid Kleckner89077a12013-12-17 19:46:40 +0000837 ArgTys.insert(ArgTys.begin() + 1,
838 Context.getPointerType(Context.VoidPtrTy));
John McCall5d865c322010-08-31 07:33:07 +0000839}
840
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000841void ItaniumCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
842 // Just make sure we're in sync with TargetCXXABI.
843 assert(CGM.getTarget().getCXXABI().hasConstructorVariants());
844
Rafael Espindolac3cde362013-12-09 14:51:17 +0000845 // The constructor used for constructing this as a base class;
846 // ignores virtual bases.
847 CGM.EmitGlobal(GlobalDecl(D, Ctor_Base));
848
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000849 // The constructor used for constructing this as a complete class;
850 // constucts the virtual bases, then calls the base constructor.
851 if (!D->getParent()->isAbstract()) {
852 // We don't need to emit the complete ctor if the class is abstract.
853 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
854 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000855}
856
John McCall5d865c322010-08-31 07:33:07 +0000857/// The generic ABI passes 'this', plus a VTT if it's destroying a
858/// base subobject.
859void ItaniumCXXABI::BuildDestructorSignature(const CXXDestructorDecl *Dtor,
860 CXXDtorType Type,
861 CanQualType &ResTy,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000862 SmallVectorImpl<CanQualType> &ArgTys) {
John McCall9bca9232010-09-02 10:25:57 +0000863 ASTContext &Context = getContext();
John McCall5d865c322010-08-31 07:33:07 +0000864
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000865 // 'this' parameter is already there, as well as 'this' return if
866 // HasThisReturn(GlobalDecl(Dtor, Type)) is true
John McCall5d865c322010-08-31 07:33:07 +0000867
868 // Check if we need to add a VTT parameter (which has type void **).
869 if (Type == Dtor_Base && Dtor->getParent()->getNumVBases() != 0)
870 ArgTys.push_back(Context.getPointerType(Context.VoidPtrTy));
871}
872
Reid Klecknere7de47e2013-07-22 13:51:44 +0000873void ItaniumCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
Rafael Espindolac3cde362013-12-09 14:51:17 +0000874 // The destructor used for destructing this as a base class; ignores
875 // virtual bases.
876 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
Reid Klecknere7de47e2013-07-22 13:51:44 +0000877
878 // The destructor used for destructing this as a most-derived class;
879 // call the base destructor and then destructs any virtual bases.
880 CGM.EmitGlobal(GlobalDecl(D, Dtor_Complete));
881
Rafael Espindolac3cde362013-12-09 14:51:17 +0000882 // The destructor in a virtual table is always a 'deleting'
883 // destructor, which calls the complete destructor and then uses the
884 // appropriate operator delete.
885 if (D->isVirtual())
886 CGM.EmitGlobal(GlobalDecl(D, Dtor_Deleting));
Reid Klecknere7de47e2013-07-22 13:51:44 +0000887}
888
Reid Kleckner89077a12013-12-17 19:46:40 +0000889void ItaniumCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
890 QualType &ResTy,
891 FunctionArgList &Params) {
John McCall5d865c322010-08-31 07:33:07 +0000892 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +0000893 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
John McCall5d865c322010-08-31 07:33:07 +0000894
895 // Check if we need a VTT parameter as well.
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000896 if (NeedsVTTParameter(CGF.CurGD)) {
John McCall9bca9232010-09-02 10:25:57 +0000897 ASTContext &Context = getContext();
John McCall5d865c322010-08-31 07:33:07 +0000898
899 // FIXME: avoid the fake decl
900 QualType T = Context.getPointerType(Context.VoidPtrTy);
901 ImplicitParamDecl *VTTDecl
Craig Topper8a13c412014-05-21 05:09:00 +0000902 = ImplicitParamDecl::Create(Context, nullptr, MD->getLocation(),
John McCall5d865c322010-08-31 07:33:07 +0000903 &Context.Idents.get("vtt"), T);
Reid Kleckner89077a12013-12-17 19:46:40 +0000904 Params.insert(Params.begin() + 1, VTTDecl);
Reid Kleckner2af6d732013-12-13 00:09:59 +0000905 getStructorImplicitParamDecl(CGF) = VTTDecl;
John McCall5d865c322010-08-31 07:33:07 +0000906 }
907}
908
John McCall5d865c322010-08-31 07:33:07 +0000909void ItaniumCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
910 /// Initialize the 'this' slot.
911 EmitThisParam(CGF);
912
913 /// Initialize the 'vtt' slot if needed.
Reid Kleckner2af6d732013-12-13 00:09:59 +0000914 if (getStructorImplicitParamDecl(CGF)) {
915 getStructorImplicitParamValue(CGF) = CGF.Builder.CreateLoad(
916 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)), "vtt");
John McCall5d865c322010-08-31 07:33:07 +0000917 }
John McCall5d865c322010-08-31 07:33:07 +0000918
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000919 /// If this is a function that the ABI specifies returns 'this', initialize
920 /// the return slot to 'this' at the start of the function.
921 ///
922 /// Unlike the setting of return types, this is done within the ABI
923 /// implementation instead of by clients of CGCXXABI because:
924 /// 1) getThisValue is currently protected
925 /// 2) in theory, an ABI could implement 'this' returns some other way;
926 /// HasThisReturn only specifies a contract, not the implementation
John McCall5d865c322010-08-31 07:33:07 +0000927 if (HasThisReturn(CGF.CurGD))
Eli Friedman9fbeba02012-02-11 02:57:39 +0000928 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
John McCall5d865c322010-08-31 07:33:07 +0000929}
930
Reid Kleckner89077a12013-12-17 19:46:40 +0000931unsigned ItaniumCXXABI::addImplicitConstructorArgs(
932 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
933 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
934 if (!NeedsVTTParameter(GlobalDecl(D, Type)))
935 return 0;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000936
Reid Kleckner89077a12013-12-17 19:46:40 +0000937 // Insert the implicit 'vtt' argument as the second argument.
938 llvm::Value *VTT =
939 CGF.GetVTTParameter(GlobalDecl(D, Type), ForVirtualBase, Delegating);
940 QualType VTTTy = getContext().getPointerType(getContext().VoidPtrTy);
941 Args.insert(Args.begin() + 1,
942 CallArg(RValue::get(VTT), VTTTy, /*needscopy=*/false));
943 return 1; // Added one arg.
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000944}
945
946void ItaniumCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
947 const CXXDestructorDecl *DD,
948 CXXDtorType Type, bool ForVirtualBase,
949 bool Delegating, llvm::Value *This) {
950 GlobalDecl GD(DD, Type);
951 llvm::Value *VTT = CGF.GetVTTParameter(GD, ForVirtualBase, Delegating);
952 QualType VTTTy = getContext().getPointerType(getContext().VoidPtrTy);
953
Craig Topper8a13c412014-05-21 05:09:00 +0000954 llvm::Value *Callee = nullptr;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000955 if (getContext().getLangOpts().AppleKext)
956 Callee = CGF.BuildAppleKextVirtualDestructorCall(DD, Type, DD->getParent());
957
958 if (!Callee)
959 Callee = CGM.GetAddrOfCXXDestructor(DD, Type);
960
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000961 // FIXME: Provide a source location here.
962 CGF.EmitCXXMemberCall(DD, SourceLocation(), Callee, ReturnValueSlot(), This,
Craig Topper8a13c412014-05-21 05:09:00 +0000963 VTT, VTTTy, nullptr, nullptr);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000964}
965
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000966void ItaniumCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
967 const CXXRecordDecl *RD) {
968 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, CharUnits());
969 if (VTable->hasInitializer())
970 return;
971
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000972 ItaniumVTableContext &VTContext = CGM.getItaniumVTableContext();
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000973 const VTableLayout &VTLayout = VTContext.getVTableLayout(RD);
974 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
975
976 // Create and set the initializer.
977 llvm::Constant *Init = CGVT.CreateVTableInitializer(
978 RD, VTLayout.vtable_component_begin(), VTLayout.getNumVTableComponents(),
979 VTLayout.vtable_thunk_begin(), VTLayout.getNumVTableThunks());
980 VTable->setInitializer(Init);
981
982 // Set the correct linkage.
983 VTable->setLinkage(Linkage);
984
985 // Set the right visibility.
John McCall8f80a612014-02-08 00:41:16 +0000986 CGM.setGlobalVisibility(VTable, RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000987
988 // If this is the magic class __cxxabiv1::__fundamental_type_info,
989 // we will emit the typeinfo for the fundamental types. This is the
990 // same behaviour as GCC.
991 const DeclContext *DC = RD->getDeclContext();
992 if (RD->getIdentifier() &&
993 RD->getIdentifier()->isStr("__fundamental_type_info") &&
994 isa<NamespaceDecl>(DC) && cast<NamespaceDecl>(DC)->getIdentifier() &&
995 cast<NamespaceDecl>(DC)->getIdentifier()->isStr("__cxxabiv1") &&
996 DC->getParent()->isTranslationUnit())
997 CGM.EmitFundamentalRTTIDescriptors();
998}
999
1000llvm::Value *ItaniumCXXABI::getVTableAddressPointInStructor(
1001 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
1002 const CXXRecordDecl *NearestVBase, bool &NeedsVirtualOffset) {
1003 bool NeedsVTTParam = CGM.getCXXABI().NeedsVTTParameter(CGF.CurGD);
1004 NeedsVirtualOffset = (NeedsVTTParam && NearestVBase);
1005
1006 llvm::Value *VTableAddressPoint;
1007 if (NeedsVTTParam && (Base.getBase()->getNumVBases() || NearestVBase)) {
1008 // Get the secondary vpointer index.
1009 uint64_t VirtualPointerIndex =
1010 CGM.getVTables().getSecondaryVirtualPointerIndex(VTableClass, Base);
1011
1012 /// Load the VTT.
1013 llvm::Value *VTT = CGF.LoadCXXVTT();
1014 if (VirtualPointerIndex)
1015 VTT = CGF.Builder.CreateConstInBoundsGEP1_64(VTT, VirtualPointerIndex);
1016
1017 // And load the address point from the VTT.
1018 VTableAddressPoint = CGF.Builder.CreateLoad(VTT);
1019 } else {
1020 llvm::Constant *VTable =
1021 CGM.getCXXABI().getAddrOfVTable(VTableClass, CharUnits());
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001022 uint64_t AddressPoint = CGM.getItaniumVTableContext()
1023 .getVTableLayout(VTableClass)
1024 .getAddressPoint(Base);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001025 VTableAddressPoint =
1026 CGF.Builder.CreateConstInBoundsGEP2_64(VTable, 0, AddressPoint);
1027 }
1028
1029 return VTableAddressPoint;
1030}
1031
1032llvm::Constant *ItaniumCXXABI::getVTableAddressPointForConstExpr(
1033 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1034 llvm::Constant *VTable = getAddrOfVTable(VTableClass, CharUnits());
1035
1036 // Find the appropriate vtable within the vtable group.
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001037 uint64_t AddressPoint = CGM.getItaniumVTableContext()
1038 .getVTableLayout(VTableClass)
1039 .getAddressPoint(Base);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001040 llvm::Value *Indices[] = {
1041 llvm::ConstantInt::get(CGM.Int64Ty, 0),
1042 llvm::ConstantInt::get(CGM.Int64Ty, AddressPoint)
1043 };
1044
1045 return llvm::ConstantExpr::getInBoundsGetElementPtr(VTable, Indices);
1046}
1047
1048llvm::GlobalVariable *ItaniumCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1049 CharUnits VPtrOffset) {
1050 assert(VPtrOffset.isZero() && "Itanium ABI only supports zero vptr offsets");
1051
1052 llvm::GlobalVariable *&VTable = VTables[RD];
1053 if (VTable)
1054 return VTable;
1055
1056 // Queue up this v-table for possible deferred emission.
1057 CGM.addDeferredVTable(RD);
1058
1059 SmallString<256> OutName;
1060 llvm::raw_svector_ostream Out(OutName);
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001061 getMangleContext().mangleCXXVTable(RD, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001062 Out.flush();
1063 StringRef Name = OutName.str();
1064
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001065 ItaniumVTableContext &VTContext = CGM.getItaniumVTableContext();
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001066 llvm::ArrayType *ArrayType = llvm::ArrayType::get(
1067 CGM.Int8PtrTy, VTContext.getVTableLayout(RD).getNumVTableComponents());
1068
1069 VTable = CGM.CreateOrReplaceCXXRuntimeVariable(
1070 Name, ArrayType, llvm::GlobalValue::ExternalLinkage);
1071 VTable->setUnnamedAddr(true);
1072 return VTable;
1073}
1074
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001075llvm::Value *ItaniumCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1076 GlobalDecl GD,
1077 llvm::Value *This,
1078 llvm::Type *Ty) {
1079 GD = GD.getCanonicalDecl();
1080 Ty = Ty->getPointerTo()->getPointerTo();
1081 llvm::Value *VTable = CGF.GetVTablePtr(This, Ty);
1082
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001083 uint64_t VTableIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001084 llvm::Value *VFuncPtr =
1085 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, VTableIndex, "vfn");
1086 return CGF.Builder.CreateLoad(VFuncPtr);
1087}
1088
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001089void ItaniumCXXABI::EmitVirtualDestructorCall(CodeGenFunction &CGF,
1090 const CXXDestructorDecl *Dtor,
1091 CXXDtorType DtorType,
1092 SourceLocation CallLoc,
1093 llvm::Value *This) {
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001094 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1095
1096 const CGFunctionInfo *FInfo
1097 = &CGM.getTypes().arrangeCXXDestructor(Dtor, DtorType);
1098 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001099 llvm::Value *Callee =
1100 getVirtualFunctionPointer(CGF, GlobalDecl(Dtor, DtorType), This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001101
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001102 CGF.EmitCXXMemberCall(Dtor, CallLoc, Callee, ReturnValueSlot(), This,
Craig Topper8a13c412014-05-21 05:09:00 +00001103 /*ImplicitParam=*/nullptr, QualType(), nullptr,
1104 nullptr);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001105}
1106
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001107void ItaniumCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001108 CodeGenVTables &VTables = CGM.getVTables();
1109 llvm::GlobalVariable *VTT = VTables.GetAddrOfVTT(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001110 VTables.EmitVTTDefinition(VTT, CGM.getVTableLinkage(RD), RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001111}
1112
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001113static llvm::Value *performTypeAdjustment(CodeGenFunction &CGF,
1114 llvm::Value *Ptr,
1115 int64_t NonVirtualAdjustment,
1116 int64_t VirtualAdjustment,
1117 bool IsReturnAdjustment) {
1118 if (!NonVirtualAdjustment && !VirtualAdjustment)
1119 return Ptr;
1120
1121 llvm::Type *Int8PtrTy = CGF.Int8PtrTy;
1122 llvm::Value *V = CGF.Builder.CreateBitCast(Ptr, Int8PtrTy);
1123
1124 if (NonVirtualAdjustment && !IsReturnAdjustment) {
1125 // Perform the non-virtual adjustment for a base-to-derived cast.
1126 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
1127 }
1128
1129 if (VirtualAdjustment) {
1130 llvm::Type *PtrDiffTy =
1131 CGF.ConvertType(CGF.getContext().getPointerDiffType());
1132
1133 // Perform the virtual adjustment.
1134 llvm::Value *VTablePtrPtr =
1135 CGF.Builder.CreateBitCast(V, Int8PtrTy->getPointerTo());
1136
1137 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr);
1138
1139 llvm::Value *OffsetPtr =
1140 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment);
1141
1142 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo());
1143
1144 // Load the adjustment offset from the vtable.
1145 llvm::Value *Offset = CGF.Builder.CreateLoad(OffsetPtr);
1146
1147 // Adjust our pointer.
1148 V = CGF.Builder.CreateInBoundsGEP(V, Offset);
1149 }
1150
1151 if (NonVirtualAdjustment && IsReturnAdjustment) {
1152 // Perform the non-virtual adjustment for a derived-to-base cast.
1153 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
1154 }
1155
1156 // Cast back to the original type.
1157 return CGF.Builder.CreateBitCast(V, Ptr->getType());
1158}
1159
1160llvm::Value *ItaniumCXXABI::performThisAdjustment(CodeGenFunction &CGF,
1161 llvm::Value *This,
1162 const ThisAdjustment &TA) {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00001163 return performTypeAdjustment(CGF, This, TA.NonVirtual,
1164 TA.Virtual.Itanium.VCallOffsetOffset,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001165 /*IsReturnAdjustment=*/false);
1166}
1167
1168llvm::Value *
1169ItaniumCXXABI::performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
1170 const ReturnAdjustment &RA) {
1171 return performTypeAdjustment(CGF, Ret, RA.NonVirtual,
1172 RA.Virtual.Itanium.VBaseOffsetOffset,
1173 /*IsReturnAdjustment=*/true);
1174}
1175
John McCall5d865c322010-08-31 07:33:07 +00001176void ARMCXXABI::EmitReturnFromThunk(CodeGenFunction &CGF,
1177 RValue RV, QualType ResultType) {
1178 if (!isa<CXXDestructorDecl>(CGF.CurGD.getDecl()))
1179 return ItaniumCXXABI::EmitReturnFromThunk(CGF, RV, ResultType);
1180
1181 // Destructor thunks in the ARM ABI have indeterminate results.
Chris Lattner2192fe52011-07-18 04:24:23 +00001182 llvm::Type *T =
John McCall5d865c322010-08-31 07:33:07 +00001183 cast<llvm::PointerType>(CGF.ReturnValue->getType())->getElementType();
1184 RValue Undef = RValue::get(llvm::UndefValue::get(T));
1185 return ItaniumCXXABI::EmitReturnFromThunk(CGF, Undef, ResultType);
1186}
John McCall8ed55a52010-09-02 09:58:18 +00001187
1188/************************** Array allocation cookies **************************/
1189
John McCallb91cd662012-05-01 05:23:51 +00001190CharUnits ItaniumCXXABI::getArrayCookieSizeImpl(QualType elementType) {
1191 // The array cookie is a size_t; pad that up to the element alignment.
1192 // The cookie is actually right-justified in that space.
1193 return std::max(CharUnits::fromQuantity(CGM.SizeSizeInBytes),
1194 CGM.getContext().getTypeAlignInChars(elementType));
John McCall8ed55a52010-09-02 09:58:18 +00001195}
1196
1197llvm::Value *ItaniumCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
1198 llvm::Value *NewPtr,
1199 llvm::Value *NumElements,
John McCall284c48f2011-01-27 09:37:56 +00001200 const CXXNewExpr *expr,
John McCall8ed55a52010-09-02 09:58:18 +00001201 QualType ElementType) {
John McCallb91cd662012-05-01 05:23:51 +00001202 assert(requiresArrayCookie(expr));
John McCall8ed55a52010-09-02 09:58:18 +00001203
Micah Villmowea2fea22012-10-25 15:39:14 +00001204 unsigned AS = NewPtr->getType()->getPointerAddressSpace();
John McCall8ed55a52010-09-02 09:58:18 +00001205
John McCall9bca9232010-09-02 10:25:57 +00001206 ASTContext &Ctx = getContext();
John McCall8ed55a52010-09-02 09:58:18 +00001207 QualType SizeTy = Ctx.getSizeType();
1208 CharUnits SizeSize = Ctx.getTypeSizeInChars(SizeTy);
1209
1210 // The size of the cookie.
1211 CharUnits CookieSize =
1212 std::max(SizeSize, Ctx.getTypeAlignInChars(ElementType));
John McCallb91cd662012-05-01 05:23:51 +00001213 assert(CookieSize == getArrayCookieSizeImpl(ElementType));
John McCall8ed55a52010-09-02 09:58:18 +00001214
1215 // Compute an offset to the cookie.
1216 llvm::Value *CookiePtr = NewPtr;
1217 CharUnits CookieOffset = CookieSize - SizeSize;
1218 if (!CookieOffset.isZero())
1219 CookiePtr = CGF.Builder.CreateConstInBoundsGEP1_64(CookiePtr,
1220 CookieOffset.getQuantity());
1221
1222 // Write the number of elements into the appropriate slot.
1223 llvm::Value *NumElementsPtr
1224 = CGF.Builder.CreateBitCast(CookiePtr,
1225 CGF.ConvertType(SizeTy)->getPointerTo(AS));
1226 CGF.Builder.CreateStore(NumElements, NumElementsPtr);
1227
1228 // Finally, compute a pointer to the actual data buffer by skipping
1229 // over the cookie completely.
1230 return CGF.Builder.CreateConstInBoundsGEP1_64(NewPtr,
1231 CookieSize.getQuantity());
1232}
1233
John McCallb91cd662012-05-01 05:23:51 +00001234llvm::Value *ItaniumCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
1235 llvm::Value *allocPtr,
1236 CharUnits cookieSize) {
1237 // The element size is right-justified in the cookie.
1238 llvm::Value *numElementsPtr = allocPtr;
1239 CharUnits numElementsOffset =
1240 cookieSize - CharUnits::fromQuantity(CGF.SizeSizeInBytes);
1241 if (!numElementsOffset.isZero())
1242 numElementsPtr =
1243 CGF.Builder.CreateConstInBoundsGEP1_64(numElementsPtr,
1244 numElementsOffset.getQuantity());
John McCall8ed55a52010-09-02 09:58:18 +00001245
Micah Villmowea2fea22012-10-25 15:39:14 +00001246 unsigned AS = allocPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001247 numElementsPtr =
1248 CGF.Builder.CreateBitCast(numElementsPtr, CGF.SizeTy->getPointerTo(AS));
1249 return CGF.Builder.CreateLoad(numElementsPtr);
John McCall8ed55a52010-09-02 09:58:18 +00001250}
1251
John McCallb91cd662012-05-01 05:23:51 +00001252CharUnits ARMCXXABI::getArrayCookieSizeImpl(QualType elementType) {
John McCallc19c7062013-01-25 23:36:19 +00001253 // ARM says that the cookie is always:
John McCall8ed55a52010-09-02 09:58:18 +00001254 // struct array_cookie {
1255 // std::size_t element_size; // element_size != 0
1256 // std::size_t element_count;
1257 // };
John McCallc19c7062013-01-25 23:36:19 +00001258 // But the base ABI doesn't give anything an alignment greater than
1259 // 8, so we can dismiss this as typical ABI-author blindness to
1260 // actual language complexity and round up to the element alignment.
1261 return std::max(CharUnits::fromQuantity(2 * CGM.SizeSizeInBytes),
1262 CGM.getContext().getTypeAlignInChars(elementType));
John McCall8ed55a52010-09-02 09:58:18 +00001263}
1264
1265llvm::Value *ARMCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
John McCallc19c7062013-01-25 23:36:19 +00001266 llvm::Value *newPtr,
1267 llvm::Value *numElements,
John McCall284c48f2011-01-27 09:37:56 +00001268 const CXXNewExpr *expr,
John McCallc19c7062013-01-25 23:36:19 +00001269 QualType elementType) {
John McCallb91cd662012-05-01 05:23:51 +00001270 assert(requiresArrayCookie(expr));
John McCall8ed55a52010-09-02 09:58:18 +00001271
John McCallc19c7062013-01-25 23:36:19 +00001272 // NewPtr is a char*, but we generalize to arbitrary addrspaces.
1273 unsigned AS = newPtr->getType()->getPointerAddressSpace();
John McCall8ed55a52010-09-02 09:58:18 +00001274
1275 // The cookie is always at the start of the buffer.
John McCallc19c7062013-01-25 23:36:19 +00001276 llvm::Value *cookie = newPtr;
John McCall8ed55a52010-09-02 09:58:18 +00001277
1278 // The first element is the element size.
John McCallc19c7062013-01-25 23:36:19 +00001279 cookie = CGF.Builder.CreateBitCast(cookie, CGF.SizeTy->getPointerTo(AS));
1280 llvm::Value *elementSize = llvm::ConstantInt::get(CGF.SizeTy,
1281 getContext().getTypeSizeInChars(elementType).getQuantity());
1282 CGF.Builder.CreateStore(elementSize, cookie);
John McCall8ed55a52010-09-02 09:58:18 +00001283
1284 // The second element is the element count.
John McCallc19c7062013-01-25 23:36:19 +00001285 cookie = CGF.Builder.CreateConstInBoundsGEP1_32(cookie, 1);
1286 CGF.Builder.CreateStore(numElements, cookie);
John McCall8ed55a52010-09-02 09:58:18 +00001287
1288 // Finally, compute a pointer to the actual data buffer by skipping
1289 // over the cookie completely.
John McCallc19c7062013-01-25 23:36:19 +00001290 CharUnits cookieSize = ARMCXXABI::getArrayCookieSizeImpl(elementType);
1291 return CGF.Builder.CreateConstInBoundsGEP1_64(newPtr,
1292 cookieSize.getQuantity());
John McCall8ed55a52010-09-02 09:58:18 +00001293}
1294
John McCallb91cd662012-05-01 05:23:51 +00001295llvm::Value *ARMCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
1296 llvm::Value *allocPtr,
1297 CharUnits cookieSize) {
1298 // The number of elements is at offset sizeof(size_t) relative to
1299 // the allocated pointer.
1300 llvm::Value *numElementsPtr
1301 = CGF.Builder.CreateConstInBoundsGEP1_64(allocPtr, CGF.SizeSizeInBytes);
John McCall8ed55a52010-09-02 09:58:18 +00001302
Micah Villmowea2fea22012-10-25 15:39:14 +00001303 unsigned AS = allocPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001304 numElementsPtr =
1305 CGF.Builder.CreateBitCast(numElementsPtr, CGF.SizeTy->getPointerTo(AS));
1306 return CGF.Builder.CreateLoad(numElementsPtr);
John McCall8ed55a52010-09-02 09:58:18 +00001307}
1308
John McCall68ff0372010-09-08 01:44:27 +00001309/*********************** Static local initialization **************************/
1310
1311static llvm::Constant *getGuardAcquireFn(CodeGenModule &CGM,
Chris Lattnera5f58b02011-07-09 17:41:47 +00001312 llvm::PointerType *GuardPtrTy) {
John McCall68ff0372010-09-08 01:44:27 +00001313 // int __cxa_guard_acquire(__guard *guard_object);
Chris Lattner2192fe52011-07-18 04:24:23 +00001314 llvm::FunctionType *FTy =
John McCall68ff0372010-09-08 01:44:27 +00001315 llvm::FunctionType::get(CGM.getTypes().ConvertType(CGM.getContext().IntTy),
Jay Foad5709f7c2011-07-29 13:56:53 +00001316 GuardPtrTy, /*isVarArg=*/false);
Nick Lewyckyadcec492012-02-13 23:45:02 +00001317 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_acquire",
Bill Wendling8594fcb2013-01-31 00:30:05 +00001318 llvm::AttributeSet::get(CGM.getLLVMContext(),
1319 llvm::AttributeSet::FunctionIndex,
Bill Wendling207f0532012-12-20 19:27:06 +00001320 llvm::Attribute::NoUnwind));
John McCall68ff0372010-09-08 01:44:27 +00001321}
1322
1323static llvm::Constant *getGuardReleaseFn(CodeGenModule &CGM,
Chris Lattnera5f58b02011-07-09 17:41:47 +00001324 llvm::PointerType *GuardPtrTy) {
John McCall68ff0372010-09-08 01:44:27 +00001325 // void __cxa_guard_release(__guard *guard_object);
Chris Lattner2192fe52011-07-18 04:24:23 +00001326 llvm::FunctionType *FTy =
Chris Lattnerece04092012-02-07 00:39:47 +00001327 llvm::FunctionType::get(CGM.VoidTy, GuardPtrTy, /*isVarArg=*/false);
Nick Lewyckyadcec492012-02-13 23:45:02 +00001328 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_release",
Bill Wendling8594fcb2013-01-31 00:30:05 +00001329 llvm::AttributeSet::get(CGM.getLLVMContext(),
1330 llvm::AttributeSet::FunctionIndex,
Bill Wendling207f0532012-12-20 19:27:06 +00001331 llvm::Attribute::NoUnwind));
John McCall68ff0372010-09-08 01:44:27 +00001332}
1333
1334static llvm::Constant *getGuardAbortFn(CodeGenModule &CGM,
Chris Lattnera5f58b02011-07-09 17:41:47 +00001335 llvm::PointerType *GuardPtrTy) {
John McCall68ff0372010-09-08 01:44:27 +00001336 // void __cxa_guard_abort(__guard *guard_object);
Chris Lattner2192fe52011-07-18 04:24:23 +00001337 llvm::FunctionType *FTy =
Chris Lattnerece04092012-02-07 00:39:47 +00001338 llvm::FunctionType::get(CGM.VoidTy, GuardPtrTy, /*isVarArg=*/false);
Nick Lewyckyadcec492012-02-13 23:45:02 +00001339 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_abort",
Bill Wendling8594fcb2013-01-31 00:30:05 +00001340 llvm::AttributeSet::get(CGM.getLLVMContext(),
1341 llvm::AttributeSet::FunctionIndex,
Bill Wendling207f0532012-12-20 19:27:06 +00001342 llvm::Attribute::NoUnwind));
John McCall68ff0372010-09-08 01:44:27 +00001343}
1344
1345namespace {
1346 struct CallGuardAbort : EHScopeStack::Cleanup {
1347 llvm::GlobalVariable *Guard;
Chandler Carruth84537952012-03-30 19:44:53 +00001348 CallGuardAbort(llvm::GlobalVariable *Guard) : Guard(Guard) {}
John McCall68ff0372010-09-08 01:44:27 +00001349
Craig Topper4f12f102014-03-12 06:41:41 +00001350 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall882987f2013-02-28 19:01:20 +00001351 CGF.EmitNounwindRuntimeCall(getGuardAbortFn(CGF.CGM, Guard->getType()),
1352 Guard);
John McCall68ff0372010-09-08 01:44:27 +00001353 }
1354 };
1355}
1356
1357/// The ARM code here follows the Itanium code closely enough that we
1358/// just special-case it at particular places.
John McCallcdf7ef52010-11-06 09:44:32 +00001359void ItaniumCXXABI::EmitGuardedInit(CodeGenFunction &CGF,
1360 const VarDecl &D,
John McCallb88a5662012-03-30 21:00:39 +00001361 llvm::GlobalVariable *var,
1362 bool shouldPerformInit) {
John McCall68ff0372010-09-08 01:44:27 +00001363 CGBuilderTy &Builder = CGF.Builder;
John McCallcdf7ef52010-11-06 09:44:32 +00001364
Richard Smithdbf74ba2013-04-14 23:01:42 +00001365 // We only need to use thread-safe statics for local non-TLS variables;
John McCallcdf7ef52010-11-06 09:44:32 +00001366 // global initialization is always single-threaded.
Richard Smithdbf74ba2013-04-14 23:01:42 +00001367 bool threadsafe = getContext().getLangOpts().ThreadsafeStatics &&
1368 D.isLocalVarDecl() && !D.getTLSKind();
Anders Carlssonc5d3ba12011-04-27 04:37:08 +00001369
Anders Carlssonc5d3ba12011-04-27 04:37:08 +00001370 // If we have a global variable with internal linkage and thread-safe statics
1371 // are disabled, we can just let the guard variable be of type i8.
John McCallb88a5662012-03-30 21:00:39 +00001372 bool useInt8GuardVariable = !threadsafe && var->hasInternalLinkage();
1373
1374 llvm::IntegerType *guardTy;
John McCall5aa52592011-06-17 07:33:57 +00001375 if (useInt8GuardVariable) {
John McCallb88a5662012-03-30 21:00:39 +00001376 guardTy = CGF.Int8Ty;
John McCall5aa52592011-06-17 07:33:57 +00001377 } else {
Tim Northover9bb857a2013-01-31 12:13:10 +00001378 // Guard variables are 64 bits in the generic ABI and size width on ARM
1379 // (i.e. 32-bit on AArch32, 64-bit on AArch64).
Mark Seabornedf0d382013-07-24 16:25:13 +00001380 guardTy = (UseARMGuardVarABI ? CGF.SizeTy : CGF.Int64Ty);
Anders Carlssonc5d3ba12011-04-27 04:37:08 +00001381 }
John McCallb88a5662012-03-30 21:00:39 +00001382 llvm::PointerType *guardPtrTy = guardTy->getPointerTo();
John McCall68ff0372010-09-08 01:44:27 +00001383
John McCallb88a5662012-03-30 21:00:39 +00001384 // Create the guard variable if we don't already have it (as we
1385 // might if we're double-emitting this function body).
1386 llvm::GlobalVariable *guard = CGM.getStaticLocalDeclGuardAddress(&D);
1387 if (!guard) {
1388 // Mangle the name for the guard.
1389 SmallString<256> guardName;
1390 {
1391 llvm::raw_svector_ostream out(guardName);
Reid Klecknerd8110b62013-09-10 20:14:30 +00001392 getMangleContext().mangleStaticGuardVariable(&D, out);
John McCallb88a5662012-03-30 21:00:39 +00001393 out.flush();
1394 }
John McCall8e7cb6d2010-11-02 21:04:24 +00001395
John McCallb88a5662012-03-30 21:00:39 +00001396 // Create the guard variable with a zero-initializer.
1397 // Just absorb linkage and visibility from the guarded variable.
1398 guard = new llvm::GlobalVariable(CGM.getModule(), guardTy,
1399 false, var->getLinkage(),
1400 llvm::ConstantInt::get(guardTy, 0),
1401 guardName.str());
1402 guard->setVisibility(var->getVisibility());
Richard Smithdbf74ba2013-04-14 23:01:42 +00001403 // If the variable is thread-local, so is its guard variable.
1404 guard->setThreadLocalMode(var->getThreadLocalMode());
John McCallb88a5662012-03-30 21:00:39 +00001405
1406 CGM.setStaticLocalDeclGuardAddress(&D, guard);
1407 }
John McCall87590e62012-03-30 07:09:50 +00001408
John McCall68ff0372010-09-08 01:44:27 +00001409 // Test whether the variable has completed initialization.
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001410 //
John McCall68ff0372010-09-08 01:44:27 +00001411 // Itanium C++ ABI 3.3.2:
1412 // The following is pseudo-code showing how these functions can be used:
1413 // if (obj_guard.first_byte == 0) {
1414 // if ( __cxa_guard_acquire (&obj_guard) ) {
1415 // try {
1416 // ... initialize the object ...;
1417 // } catch (...) {
1418 // __cxa_guard_abort (&obj_guard);
1419 // throw;
1420 // }
1421 // ... queue object destructor with __cxa_atexit() ...;
1422 // __cxa_guard_release (&obj_guard);
1423 // }
1424 // }
Tim Northovera2ee4332014-03-29 15:09:45 +00001425
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001426 // Load the first byte of the guard variable.
1427 llvm::LoadInst *LI =
John McCallb88a5662012-03-30 21:00:39 +00001428 Builder.CreateLoad(Builder.CreateBitCast(guard, CGM.Int8PtrTy));
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001429 LI->setAlignment(1);
John McCall68ff0372010-09-08 01:44:27 +00001430
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001431 // Itanium ABI:
1432 // An implementation supporting thread-safety on multiprocessor
1433 // systems must also guarantee that references to the initialized
1434 // object do not occur before the load of the initialization flag.
1435 //
1436 // In LLVM, we do this by marking the load Acquire.
1437 if (threadsafe)
1438 LI->setAtomic(llvm::Acquire);
Eli Friedman84d28122011-09-13 22:21:56 +00001439
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001440 // For ARM, we should only check the first bit, rather than the entire byte:
1441 //
1442 // ARM C++ ABI 3.2.3.1:
1443 // To support the potential use of initialization guard variables
1444 // as semaphores that are the target of ARM SWP and LDREX/STREX
1445 // synchronizing instructions we define a static initialization
1446 // guard variable to be a 4-byte aligned, 4-byte word with the
1447 // following inline access protocol.
1448 // #define INITIALIZED 1
1449 // if ((obj_guard & INITIALIZED) != INITIALIZED) {
1450 // if (__cxa_guard_acquire(&obj_guard))
1451 // ...
1452 // }
1453 //
1454 // and similarly for ARM64:
1455 //
1456 // ARM64 C++ ABI 3.2.2:
1457 // This ABI instead only specifies the value bit 0 of the static guard
1458 // variable; all other bits are platform defined. Bit 0 shall be 0 when the
1459 // variable is not initialized and 1 when it is.
1460 llvm::Value *V =
1461 (UseARMGuardVarABI && !useInt8GuardVariable)
1462 ? Builder.CreateAnd(LI, llvm::ConstantInt::get(CGM.Int8Ty, 1))
1463 : LI;
1464 llvm::Value *isInitialized = Builder.CreateIsNull(V, "guard.uninitialized");
John McCall68ff0372010-09-08 01:44:27 +00001465
1466 llvm::BasicBlock *InitCheckBlock = CGF.createBasicBlock("init.check");
1467 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
1468
1469 // Check if the first byte of the guard variable is zero.
John McCallb88a5662012-03-30 21:00:39 +00001470 Builder.CreateCondBr(isInitialized, InitCheckBlock, EndBlock);
John McCall68ff0372010-09-08 01:44:27 +00001471
1472 CGF.EmitBlock(InitCheckBlock);
1473
1474 // Variables used when coping with thread-safe statics and exceptions.
John McCall5aa52592011-06-17 07:33:57 +00001475 if (threadsafe) {
John McCall68ff0372010-09-08 01:44:27 +00001476 // Call __cxa_guard_acquire.
1477 llvm::Value *V
John McCall882987f2013-02-28 19:01:20 +00001478 = CGF.EmitNounwindRuntimeCall(getGuardAcquireFn(CGM, guardPtrTy), guard);
John McCall68ff0372010-09-08 01:44:27 +00001479
1480 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
1481
1482 Builder.CreateCondBr(Builder.CreateIsNotNull(V, "tobool"),
1483 InitBlock, EndBlock);
1484
1485 // Call __cxa_guard_abort along the exceptional edge.
John McCallb88a5662012-03-30 21:00:39 +00001486 CGF.EHStack.pushCleanup<CallGuardAbort>(EHCleanup, guard);
John McCall68ff0372010-09-08 01:44:27 +00001487
1488 CGF.EmitBlock(InitBlock);
1489 }
1490
1491 // Emit the initializer and add a global destructor if appropriate.
John McCallb88a5662012-03-30 21:00:39 +00001492 CGF.EmitCXXGlobalVarDeclInit(D, var, shouldPerformInit);
John McCall68ff0372010-09-08 01:44:27 +00001493
John McCall5aa52592011-06-17 07:33:57 +00001494 if (threadsafe) {
John McCall68ff0372010-09-08 01:44:27 +00001495 // Pop the guard-abort cleanup if we pushed one.
1496 CGF.PopCleanupBlock();
1497
1498 // Call __cxa_guard_release. This cannot throw.
John McCall882987f2013-02-28 19:01:20 +00001499 CGF.EmitNounwindRuntimeCall(getGuardReleaseFn(CGM, guardPtrTy), guard);
John McCall68ff0372010-09-08 01:44:27 +00001500 } else {
John McCallb88a5662012-03-30 21:00:39 +00001501 Builder.CreateStore(llvm::ConstantInt::get(guardTy, 1), guard);
John McCall68ff0372010-09-08 01:44:27 +00001502 }
1503
1504 CGF.EmitBlock(EndBlock);
1505}
John McCallc84ed6a2012-05-01 06:13:13 +00001506
1507/// Register a global destructor using __cxa_atexit.
1508static void emitGlobalDtorWithCXAAtExit(CodeGenFunction &CGF,
1509 llvm::Constant *dtor,
Richard Smithdbf74ba2013-04-14 23:01:42 +00001510 llvm::Constant *addr,
1511 bool TLS) {
Bill Wendling95cae882013-05-02 19:18:03 +00001512 const char *Name = "__cxa_atexit";
1513 if (TLS) {
1514 const llvm::Triple &T = CGF.getTarget().getTriple();
1515 Name = T.isMacOSX() ? "_tlv_atexit" : "__cxa_thread_atexit";
1516 }
Richard Smithdbf74ba2013-04-14 23:01:42 +00001517
John McCallc84ed6a2012-05-01 06:13:13 +00001518 // We're assuming that the destructor function is something we can
1519 // reasonably call with the default CC. Go ahead and cast it to the
1520 // right prototype.
1521 llvm::Type *dtorTy =
1522 llvm::FunctionType::get(CGF.VoidTy, CGF.Int8PtrTy, false)->getPointerTo();
1523
1524 // extern "C" int __cxa_atexit(void (*f)(void *), void *p, void *d);
1525 llvm::Type *paramTys[] = { dtorTy, CGF.Int8PtrTy, CGF.Int8PtrTy };
1526 llvm::FunctionType *atexitTy =
1527 llvm::FunctionType::get(CGF.IntTy, paramTys, false);
1528
1529 // Fetch the actual function.
Richard Smithdbf74ba2013-04-14 23:01:42 +00001530 llvm::Constant *atexit = CGF.CGM.CreateRuntimeFunction(atexitTy, Name);
John McCallc84ed6a2012-05-01 06:13:13 +00001531 if (llvm::Function *fn = dyn_cast<llvm::Function>(atexit))
1532 fn->setDoesNotThrow();
1533
1534 // Create a variable that binds the atexit to this shared object.
1535 llvm::Constant *handle =
1536 CGF.CGM.CreateRuntimeVariable(CGF.Int8Ty, "__dso_handle");
1537
1538 llvm::Value *args[] = {
1539 llvm::ConstantExpr::getBitCast(dtor, dtorTy),
1540 llvm::ConstantExpr::getBitCast(addr, CGF.Int8PtrTy),
1541 handle
1542 };
John McCall882987f2013-02-28 19:01:20 +00001543 CGF.EmitNounwindRuntimeCall(atexit, args);
John McCallc84ed6a2012-05-01 06:13:13 +00001544}
1545
1546/// Register a global destructor as best as we know how.
1547void ItaniumCXXABI::registerGlobalDtor(CodeGenFunction &CGF,
Richard Smithdbf74ba2013-04-14 23:01:42 +00001548 const VarDecl &D,
John McCallc84ed6a2012-05-01 06:13:13 +00001549 llvm::Constant *dtor,
1550 llvm::Constant *addr) {
1551 // Use __cxa_atexit if available.
Richard Smithdbf74ba2013-04-14 23:01:42 +00001552 if (CGM.getCodeGenOpts().CXAAtExit)
1553 return emitGlobalDtorWithCXAAtExit(CGF, dtor, addr, D.getTLSKind());
1554
1555 if (D.getTLSKind())
1556 CGM.ErrorUnsupported(&D, "non-trivial TLS destruction");
John McCallc84ed6a2012-05-01 06:13:13 +00001557
1558 // In Apple kexts, we want to add a global destructor entry.
1559 // FIXME: shouldn't this be guarded by some variable?
Richard Smith9c6890a2012-11-01 22:30:59 +00001560 if (CGM.getLangOpts().AppleKext) {
John McCallc84ed6a2012-05-01 06:13:13 +00001561 // Generate a global destructor entry.
1562 return CGM.AddCXXDtorEntry(dtor, addr);
1563 }
1564
David Blaikieebe87e12013-08-27 23:57:18 +00001565 CGF.registerGlobalDtorWithAtExit(D, dtor, addr);
John McCallc84ed6a2012-05-01 06:13:13 +00001566}
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001567
1568/// Get the appropriate linkage for the wrapper function. This is essentially
1569/// the weak form of the variable's linkage; every translation unit which wneeds
1570/// the wrapper emits a copy, and we want the linker to merge them.
1571static llvm::GlobalValue::LinkageTypes getThreadLocalWrapperLinkage(
1572 llvm::GlobalValue::LinkageTypes VarLinkage) {
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001573 // For internal linkage variables, we don't need an external or weak wrapper.
1574 if (llvm::GlobalValue::isLocalLinkage(VarLinkage))
1575 return VarLinkage;
1576 return llvm::GlobalValue::WeakODRLinkage;
1577}
1578
1579llvm::Function *
1580ItaniumCXXABI::getOrCreateThreadLocalWrapper(const VarDecl *VD,
1581 llvm::GlobalVariable *Var) {
1582 // Mangle the name for the thread_local wrapper function.
1583 SmallString<256> WrapperName;
1584 {
1585 llvm::raw_svector_ostream Out(WrapperName);
1586 getMangleContext().mangleItaniumThreadLocalWrapper(VD, Out);
1587 Out.flush();
1588 }
1589
1590 if (llvm::Value *V = Var->getParent()->getNamedValue(WrapperName))
1591 return cast<llvm::Function>(V);
1592
1593 llvm::Type *RetTy = Var->getType();
1594 if (VD->getType()->isReferenceType())
1595 RetTy = RetTy->getPointerElementType();
1596
1597 llvm::FunctionType *FnTy = llvm::FunctionType::get(RetTy, false);
1598 llvm::Function *Wrapper = llvm::Function::Create(
David Majnemerceaaa8d2014-05-05 18:54:23 +00001599 FnTy, getThreadLocalWrapperLinkage(
1600 CGM.getLLVMLinkageVarDefinition(VD, /*isConstant=*/false)),
1601 WrapperName.str(), &CGM.getModule());
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001602 // Always resolve references to the wrapper at link time.
Duncan P. N. Exon Smith4434d362014-05-07 22:36:11 +00001603 if (!Wrapper->hasLocalLinkage())
1604 Wrapper->setVisibility(llvm::GlobalValue::HiddenVisibility);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001605 return Wrapper;
1606}
1607
1608void ItaniumCXXABI::EmitThreadLocalInitFuncs(
1609 llvm::ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *> > Decls,
1610 llvm::Function *InitFunc) {
1611 for (unsigned I = 0, N = Decls.size(); I != N; ++I) {
1612 const VarDecl *VD = Decls[I].first;
1613 llvm::GlobalVariable *Var = Decls[I].second;
1614
1615 // Mangle the name for the thread_local initialization function.
1616 SmallString<256> InitFnName;
1617 {
1618 llvm::raw_svector_ostream Out(InitFnName);
1619 getMangleContext().mangleItaniumThreadLocalInit(VD, Out);
1620 Out.flush();
1621 }
1622
1623 // If we have a definition for the variable, emit the initialization
1624 // function as an alias to the global Init function (if any). Otherwise,
1625 // produce a declaration of the initialization function.
Craig Topper8a13c412014-05-21 05:09:00 +00001626 llvm::GlobalValue *Init = nullptr;
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001627 bool InitIsInitFunc = false;
1628 if (VD->hasDefinition()) {
1629 InitIsInitFunc = true;
1630 if (InitFunc)
Rafael Espindola234405b2014-05-17 21:30:14 +00001631 Init = llvm::GlobalAlias::create(Var->getLinkage(), InitFnName.str(),
1632 InitFunc);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001633 } else {
1634 // Emit a weak global function referring to the initialization function.
1635 // This function will not exist if the TU defining the thread_local
1636 // variable in question does not need any dynamic initialization for
1637 // its thread_local variables.
1638 llvm::FunctionType *FnTy = llvm::FunctionType::get(CGM.VoidTy, false);
1639 Init = llvm::Function::Create(
1640 FnTy, llvm::GlobalVariable::ExternalWeakLinkage, InitFnName.str(),
1641 &CGM.getModule());
1642 }
1643
1644 if (Init)
1645 Init->setVisibility(Var->getVisibility());
1646
1647 llvm::Function *Wrapper = getOrCreateThreadLocalWrapper(VD, Var);
1648 llvm::LLVMContext &Context = CGM.getModule().getContext();
1649 llvm::BasicBlock *Entry = llvm::BasicBlock::Create(Context, "", Wrapper);
1650 CGBuilderTy Builder(Entry);
1651 if (InitIsInitFunc) {
1652 if (Init)
1653 Builder.CreateCall(Init);
1654 } else {
1655 // Don't know whether we have an init function. Call it if it exists.
1656 llvm::Value *Have = Builder.CreateIsNotNull(Init);
1657 llvm::BasicBlock *InitBB = llvm::BasicBlock::Create(Context, "", Wrapper);
1658 llvm::BasicBlock *ExitBB = llvm::BasicBlock::Create(Context, "", Wrapper);
1659 Builder.CreateCondBr(Have, InitBB, ExitBB);
1660
1661 Builder.SetInsertPoint(InitBB);
1662 Builder.CreateCall(Init);
1663 Builder.CreateBr(ExitBB);
1664
1665 Builder.SetInsertPoint(ExitBB);
1666 }
1667
1668 // For a reference, the result of the wrapper function is a pointer to
1669 // the referenced object.
1670 llvm::Value *Val = Var;
1671 if (VD->getType()->isReferenceType()) {
1672 llvm::LoadInst *LI = Builder.CreateLoad(Val);
1673 LI->setAlignment(CGM.getContext().getDeclAlign(VD).getQuantity());
1674 Val = LI;
1675 }
1676
1677 Builder.CreateRet(Val);
1678 }
1679}
1680
Richard Smith0f383742014-03-26 22:48:22 +00001681LValue ItaniumCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
1682 const VarDecl *VD,
1683 QualType LValType) {
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001684 QualType T = VD->getType();
1685 llvm::Type *Ty = CGF.getTypes().ConvertTypeForMem(T);
1686 llvm::Value *Val = CGF.CGM.GetAddrOfGlobalVar(VD, Ty);
1687 llvm::Function *Wrapper =
1688 getOrCreateThreadLocalWrapper(VD, cast<llvm::GlobalVariable>(Val));
1689
1690 Val = CGF.Builder.CreateCall(Wrapper);
1691
1692 LValue LV;
1693 if (VD->getType()->isReferenceType())
Richard Smith0f383742014-03-26 22:48:22 +00001694 LV = CGF.MakeNaturalAlignAddrLValue(Val, LValType);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001695 else
Richard Smith0f383742014-03-26 22:48:22 +00001696 LV = CGF.MakeAddrLValue(Val, LValType, CGF.getContext().getDeclAlign(VD));
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001697 // FIXME: need setObjCGCLValueClass?
1698 return LV;
1699}
Peter Collingbourne66f82e62013-06-28 20:45:28 +00001700
1701/// Return whether the given global decl needs a VTT parameter, which it does
1702/// if it's a base constructor or destructor with virtual bases.
1703bool ItaniumCXXABI::NeedsVTTParameter(GlobalDecl GD) {
1704 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
1705
1706 // We don't have any virtual bases, just return early.
1707 if (!MD->getParent()->getNumVBases())
1708 return false;
1709
1710 // Check if we have a base constructor.
1711 if (isa<CXXConstructorDecl>(MD) && GD.getCtorType() == Ctor_Base)
1712 return true;
1713
1714 // Check if we have a base destructor.
1715 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
1716 return true;
1717
1718 return false;
1719}