blob: 66f51305430a15434ff13d2497eaf9cfe06ef3db [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"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000022#include "CGCleanup.h"
John McCall7a9aac22010-08-23 01:21:21 +000023#include "CGRecordLayout.h"
Charles Davisa325a6e2012-06-23 23:44:00 +000024#include "CGVTables.h"
John McCall475999d2010-08-22 00:05:51 +000025#include "CodeGenFunction.h"
Charles Davis4e786dd2010-05-25 19:52:27 +000026#include "CodeGenModule.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000027#include "TargetInfo.h"
John McCall5ad74072017-03-02 20:04:19 +000028#include "clang/CodeGen/ConstantInitBuilder.h"
Craig Topperc9ee1d02012-09-15 18:47:51 +000029#include "clang/AST/Mangle.h"
30#include "clang/AST/Type.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000031#include "clang/AST/StmtCXX.h"
David Majnemer1162d252014-06-22 19:05:33 +000032#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000033#include "llvm/IR/DataLayout.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000034#include "llvm/IR/Instructions.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000035#include "llvm/IR/Intrinsics.h"
36#include "llvm/IR/Value.h"
Charles Davis4e786dd2010-05-25 19:52:27 +000037
38using namespace clang;
John McCall475999d2010-08-22 00:05:51 +000039using namespace CodeGen;
Charles Davis4e786dd2010-05-25 19:52:27 +000040
41namespace {
Charles Davis53c59df2010-08-16 03:33:14 +000042class ItaniumCXXABI : public CodeGen::CGCXXABI {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +000043 /// VTables - All the vtables which have been defined.
44 llvm::DenseMap<const CXXRecordDecl *, llvm::GlobalVariable *> VTables;
45
John McCall475999d2010-08-22 00:05:51 +000046protected:
Mark Seabornedf0d382013-07-24 16:25:13 +000047 bool UseARMMethodPtrABI;
48 bool UseARMGuardVarABI;
John McCalld23b27e2016-09-16 02:40:45 +000049 bool Use32BitVTableOffsetABI;
John McCall7a9aac22010-08-23 01:21:21 +000050
Timur Iskhodzhanov67455222013-10-03 06:26:13 +000051 ItaniumMangleContext &getMangleContext() {
52 return cast<ItaniumMangleContext>(CodeGen::CGCXXABI::getMangleContext());
53 }
54
Charles Davis4e786dd2010-05-25 19:52:27 +000055public:
Mark Seabornedf0d382013-07-24 16:25:13 +000056 ItaniumCXXABI(CodeGen::CodeGenModule &CGM,
57 bool UseARMMethodPtrABI = false,
58 bool UseARMGuardVarABI = false) :
59 CGCXXABI(CGM), UseARMMethodPtrABI(UseARMMethodPtrABI),
John McCalld23b27e2016-09-16 02:40:45 +000060 UseARMGuardVarABI(UseARMGuardVarABI),
Richard Smithb17d6fa2016-12-01 03:04:07 +000061 Use32BitVTableOffsetABI(false) { }
John McCall475999d2010-08-22 00:05:51 +000062
Reid Kleckner40ca9132014-05-13 22:05:45 +000063 bool classifyReturnType(CGFunctionInfo &FI) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000064
Craig Topper4f12f102014-03-12 06:41:41 +000065 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override {
Reid Klecknerd355ca72014-05-15 01:26:32 +000066 // Structures with either a non-trivial destructor or a non-trivial
67 // copy constructor are always indirect.
68 // FIXME: Use canCopyArgument() when it is fixed to handle lazily declared
69 // special members.
70 if (RD->hasNonTrivialDestructor() || RD->hasNonTrivialCopyConstructor())
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000071 return RAA_Indirect;
72 return RAA_Default;
73 }
74
John McCall7f416cc2015-09-08 08:05:57 +000075 bool isThisCompleteObject(GlobalDecl GD) const override {
76 // The Itanium ABI has separate complete-object vs. base-object
77 // variants of both constructors and destructors.
78 if (isa<CXXDestructorDecl>(GD.getDecl())) {
79 switch (GD.getDtorType()) {
80 case Dtor_Complete:
81 case Dtor_Deleting:
82 return true;
83
84 case Dtor_Base:
85 return false;
86
87 case Dtor_Comdat:
88 llvm_unreachable("emitting dtor comdat as function?");
89 }
90 llvm_unreachable("bad dtor kind");
91 }
92 if (isa<CXXConstructorDecl>(GD.getDecl())) {
93 switch (GD.getCtorType()) {
94 case Ctor_Complete:
95 return true;
96
97 case Ctor_Base:
98 return false;
99
100 case Ctor_CopyingClosure:
101 case Ctor_DefaultClosure:
102 llvm_unreachable("closure ctors in Itanium ABI?");
103
104 case Ctor_Comdat:
105 llvm_unreachable("emitting ctor comdat as function?");
106 }
107 llvm_unreachable("bad dtor kind");
108 }
109
110 // No other kinds.
111 return false;
112 }
113
Craig Topper4f12f102014-03-12 06:41:41 +0000114 bool isZeroInitializable(const MemberPointerType *MPT) override;
John McCall84fa5102010-08-22 04:16:24 +0000115
Craig Topper4f12f102014-03-12 06:41:41 +0000116 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
John McCall7a9aac22010-08-23 01:21:21 +0000117
John McCallb92ab1a2016-10-26 23:46:34 +0000118 CGCallee
Craig Topper4f12f102014-03-12 06:41:41 +0000119 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF,
120 const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000121 Address This,
122 llvm::Value *&ThisPtrForCall,
Craig Topper4f12f102014-03-12 06:41:41 +0000123 llvm::Value *MemFnPtr,
124 const MemberPointerType *MPT) override;
John McCalla8bbb822010-08-22 03:04:22 +0000125
Craig Topper4f12f102014-03-12 06:41:41 +0000126 llvm::Value *
127 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000128 Address Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000129 llvm::Value *MemPtr,
130 const MemberPointerType *MPT) override;
John McCallc134eb52010-08-31 21:07:20 +0000131
John McCall7a9aac22010-08-23 01:21:21 +0000132 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
133 const CastExpr *E,
Craig Topper4f12f102014-03-12 06:41:41 +0000134 llvm::Value *Src) override;
John McCallc62bb392012-02-15 01:22:51 +0000135 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
Craig Topper4f12f102014-03-12 06:41:41 +0000136 llvm::Constant *Src) override;
John McCall84fa5102010-08-22 04:16:24 +0000137
Craig Topper4f12f102014-03-12 06:41:41 +0000138 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
John McCall84fa5102010-08-22 04:16:24 +0000139
David Majnemere2be95b2015-06-23 07:31:01 +0000140 llvm::Constant *EmitMemberFunctionPointer(const CXXMethodDecl *MD) override;
John McCallf3a88602011-02-03 08:15:49 +0000141 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
Craig Topper4f12f102014-03-12 06:41:41 +0000142 CharUnits offset) override;
143 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Richard Smithdafff942012-01-14 04:30:29 +0000144 llvm::Constant *BuildMemberPointer(const CXXMethodDecl *MD,
145 CharUnits ThisAdjustment);
John McCall1c456c82010-08-22 06:43:33 +0000146
John McCall7a9aac22010-08-23 01:21:21 +0000147 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000148 llvm::Value *L, llvm::Value *R,
John McCall7a9aac22010-08-23 01:21:21 +0000149 const MemberPointerType *MPT,
Craig Topper4f12f102014-03-12 06:41:41 +0000150 bool Inequality) override;
John McCall131d97d2010-08-22 08:30:07 +0000151
John McCall7a9aac22010-08-23 01:21:21 +0000152 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000153 llvm::Value *Addr,
154 const MemberPointerType *MPT) override;
John McCall5d865c322010-08-31 07:33:07 +0000155
David Majnemer08681372014-11-01 07:37:17 +0000156 void emitVirtualObjectDelete(CodeGenFunction &CGF, const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000157 Address Ptr, QualType ElementType,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000158 const CXXDestructorDecl *Dtor) override;
John McCall82fb8922012-09-25 10:10:39 +0000159
John McCall7f416cc2015-09-08 08:05:57 +0000160 CharUnits getAlignmentOfExnObject() {
Akira Hatanaka68ab7fe2016-03-31 06:36:07 +0000161 unsigned Align = CGM.getContext().getTargetInfo().getExnObjectAlignment();
162 return CGM.getContext().toCharUnitsFromBits(Align);
John McCall7f416cc2015-09-08 08:05:57 +0000163 }
164
David Majnemer442d0a22014-11-25 07:20:20 +0000165 void emitRethrow(CodeGenFunction &CGF, bool isNoReturn) override;
David Majnemer7c237072015-03-05 00:46:22 +0000166 void emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) override;
David Majnemer442d0a22014-11-25 07:20:20 +0000167
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000168 void emitBeginCatch(CodeGenFunction &CGF, const CXXCatchStmt *C) override;
169
170 llvm::CallInst *
171 emitTerminateForUnexpectedException(CodeGenFunction &CGF,
172 llvm::Value *Exn) override;
173
Saleem Abdulrasool8dbaf5c2016-09-30 23:11:05 +0000174 void EmitFundamentalRTTIDescriptor(QualType Type, bool DLLExport);
175 void EmitFundamentalRTTIDescriptors(bool DLLExport);
David Majnemer443250f2015-03-17 20:35:00 +0000176 llvm::Constant *getAddrOfRTTIDescriptor(QualType Ty) override;
Reid Kleckner10aa7702015-09-16 20:15:55 +0000177 CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +0000178 getAddrOfCXXCatchHandlerType(QualType Ty,
179 QualType CatchHandlerType) override {
Reid Kleckner10aa7702015-09-16 20:15:55 +0000180 return CatchTypeInfo{getAddrOfRTTIDescriptor(Ty), 0};
David Majnemer443250f2015-03-17 20:35:00 +0000181 }
David Majnemere2cb8d12014-07-07 06:20:47 +0000182
David Majnemer1162d252014-06-22 19:05:33 +0000183 bool shouldTypeidBeNullChecked(bool IsDeref, QualType SrcRecordTy) override;
184 void EmitBadTypeidCall(CodeGenFunction &CGF) override;
185 llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000186 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000187 llvm::Type *StdTypeInfoPtrTy) override;
188
189 bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
190 QualType SrcRecordTy) override;
191
John McCall7f416cc2015-09-08 08:05:57 +0000192 llvm::Value *EmitDynamicCastCall(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000193 QualType SrcRecordTy, QualType DestTy,
194 QualType DestRecordTy,
195 llvm::BasicBlock *CastEnd) override;
196
John McCall7f416cc2015-09-08 08:05:57 +0000197 llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000198 QualType SrcRecordTy,
199 QualType DestTy) override;
200
201 bool EmitBadCastCall(CodeGenFunction &CGF) override;
202
Craig Topper4f12f102014-03-12 06:41:41 +0000203 llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +0000204 GetVirtualBaseClassOffset(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000205 const CXXRecordDecl *ClassDecl,
206 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000207
Craig Topper4f12f102014-03-12 06:41:41 +0000208 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000209
George Burgess IVf203dbf2017-02-22 20:28:02 +0000210 AddedStructorArgs
211 buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
212 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000213
Reid Klecknere7de47e2013-07-22 13:51:44 +0000214 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000215 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000216 // Itanium does not emit any destructor variant as an inline thunk.
217 // Delegating may occur as an optimization, but all variants are either
218 // emitted with external linkage or as linkonce if they are inline and used.
219 return false;
220 }
221
Craig Topper4f12f102014-03-12 06:41:41 +0000222 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000223
Reid Kleckner89077a12013-12-17 19:46:40 +0000224 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000225 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000226
Craig Topper4f12f102014-03-12 06:41:41 +0000227 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall8ed55a52010-09-02 09:58:18 +0000228
George Burgess IVf203dbf2017-02-22 20:28:02 +0000229 AddedStructorArgs
230 addImplicitConstructorArgs(CodeGenFunction &CGF, const CXXConstructorDecl *D,
231 CXXCtorType Type, bool ForVirtualBase,
232 bool Delegating, CallArgList &Args) override;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000233
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000234 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
235 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +0000236 bool Delegating, Address This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000237
Craig Topper4f12f102014-03-12 06:41:41 +0000238 void emitVTableDefinitions(CodeGenVTables &CGVT,
239 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000240
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000241 bool isVirtualOffsetNeededForVTableField(CodeGenFunction &CGF,
242 CodeGenFunction::VPtr Vptr) override;
243
244 bool doStructorsInitializeVPtrs(const CXXRecordDecl *VTableClass) override {
245 return true;
246 }
247
248 llvm::Constant *
249 getVTableAddressPoint(BaseSubobject Base,
250 const CXXRecordDecl *VTableClass) override;
251
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000252 llvm::Value *getVTableAddressPointInStructor(
253 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000254 BaseSubobject Base, const CXXRecordDecl *NearestVBase) override;
255
256 llvm::Value *getVTableAddressPointInStructorWithVTT(
257 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
258 BaseSubobject Base, const CXXRecordDecl *NearestVBase);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000259
260 llvm::Constant *
261 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000262 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000263
264 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000265 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000266
John McCallb92ab1a2016-10-26 23:46:34 +0000267 CGCallee getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
268 Address This, llvm::Type *Ty,
269 SourceLocation Loc) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000270
David Majnemer0c0b6d92014-10-31 20:09:12 +0000271 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF,
272 const CXXDestructorDecl *Dtor,
273 CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +0000274 Address This,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000275 const CXXMemberCallExpr *CE) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000276
Craig Topper4f12f102014-03-12 06:41:41 +0000277 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000278
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000279 bool canSpeculativelyEmitVTable(const CXXRecordDecl *RD) const override;
Piotr Padlewskia68a7872015-07-24 04:04:49 +0000280
Hans Wennborgc94391d2014-06-06 20:04:01 +0000281 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable, GlobalDecl GD,
282 bool ReturnAdjustment) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000283 // Allow inlining of thunks by emitting them with available_externally
284 // linkage together with vtables when needed.
Peter Collingbourne8fabc1b2015-07-01 02:10:26 +0000285 if (ForVTable && !Thunk->hasLocalLinkage())
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000286 Thunk->setLinkage(llvm::GlobalValue::AvailableExternallyLinkage);
287 }
288
John McCall7f416cc2015-09-08 08:05:57 +0000289 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, Address This,
Craig Topper4f12f102014-03-12 06:41:41 +0000290 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000291
John McCall7f416cc2015-09-08 08:05:57 +0000292 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000293 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000294
David Majnemer196ac332014-09-11 23:05:02 +0000295 size_t getSrcArgforCopyCtor(const CXXConstructorDecl *,
296 FunctionArgList &Args) const override {
297 assert(!Args.empty() && "expected the arglist to not be empty!");
298 return Args.size() - 1;
299 }
300
Craig Topper4f12f102014-03-12 06:41:41 +0000301 StringRef GetPureVirtualCallName() override { return "__cxa_pure_virtual"; }
302 StringRef GetDeletedVirtualCallName() override
303 { return "__cxa_deleted_virtual"; }
Joao Matos2ce88ef2012-07-17 17:10:11 +0000304
Craig Topper4f12f102014-03-12 06:41:41 +0000305 CharUnits getArrayCookieSizeImpl(QualType elementType) override;
John McCall7f416cc2015-09-08 08:05:57 +0000306 Address InitializeArrayCookie(CodeGenFunction &CGF,
307 Address NewPtr,
308 llvm::Value *NumElements,
309 const CXXNewExpr *expr,
310 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000311 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000312 Address allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000313 CharUnits cookieSize) override;
John McCall68ff0372010-09-08 01:44:27 +0000314
John McCallcdf7ef52010-11-06 09:44:32 +0000315 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Craig Topper4f12f102014-03-12 06:41:41 +0000316 llvm::GlobalVariable *DeclPtr,
317 bool PerformInit) override;
Richard Smithdbf74ba2013-04-14 23:01:42 +0000318 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
Craig Topper4f12f102014-03-12 06:41:41 +0000319 llvm::Constant *dtor, llvm::Constant *addr) override;
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000320
321 llvm::Function *getOrCreateThreadLocalWrapper(const VarDecl *VD,
Alexander Musmanf94c3182014-09-26 06:28:25 +0000322 llvm::Value *Val);
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000323 void EmitThreadLocalInitFuncs(
David Majnemerb3341ea2014-10-05 05:05:40 +0000324 CodeGenModule &CGM,
Richard Smith5a99c492015-12-01 01:10:48 +0000325 ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +0000326 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +0000327 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) override;
David Majnemerb3341ea2014-10-05 05:05:40 +0000328
329 bool usesThreadWrapperFunction() const override { return true; }
Richard Smith0f383742014-03-26 22:48:22 +0000330 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
331 QualType LValType) override;
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000332
Craig Topper4f12f102014-03-12 06:41:41 +0000333 bool NeedsVTTParameter(GlobalDecl GD) override;
David Majnemere2cb8d12014-07-07 06:20:47 +0000334
335 /**************************** RTTI Uniqueness ******************************/
336
337protected:
338 /// Returns true if the ABI requires RTTI type_info objects to be unique
339 /// across a program.
340 virtual bool shouldRTTIBeUnique() const { return true; }
341
342public:
343 /// What sort of unique-RTTI behavior should we use?
344 enum RTTIUniquenessKind {
345 /// We are guaranteeing, or need to guarantee, that the RTTI string
346 /// is unique.
347 RUK_Unique,
348
349 /// We are not guaranteeing uniqueness for the RTTI string, so we
350 /// can demote to hidden visibility but must use string comparisons.
351 RUK_NonUniqueHidden,
352
353 /// We are not guaranteeing uniqueness for the RTTI string, so we
354 /// have to use string comparisons, but we also have to emit it with
355 /// non-hidden visibility.
356 RUK_NonUniqueVisible
357 };
358
359 /// Return the required visibility status for the given type and linkage in
360 /// the current ABI.
361 RTTIUniquenessKind
362 classifyRTTIUniqueness(QualType CanTy,
363 llvm::GlobalValue::LinkageTypes Linkage) const;
364 friend class ItaniumRTTIBuilder;
Rafael Espindola91f68b42014-09-15 19:20:10 +0000365
366 void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) override;
Piotr Padlewskia68a7872015-07-24 04:04:49 +0000367
368 private:
Piotr Padlewskia587ca52016-12-28 18:26:08 +0000369 bool hasAnyVirtualInlineFunction(const CXXRecordDecl *RD) const {
Piotr Padlewskia68a7872015-07-24 04:04:49 +0000370 const auto &VtableLayout =
371 CGM.getItaniumVTableContext().getVTableLayout(RD);
372
373 for (const auto &VtableComponent : VtableLayout.vtable_components()) {
Piotr Padlewskia587ca52016-12-28 18:26:08 +0000374 // Skip empty slot.
Piotr Padlewski1d02f682015-08-19 20:09:09 +0000375 if (!VtableComponent.isUsedFunctionPointerKind())
Piotr Padlewskia68a7872015-07-24 04:04:49 +0000376 continue;
377
Piotr Padlewski1d02f682015-08-19 20:09:09 +0000378 const CXXMethodDecl *Method = VtableComponent.getFunctionDecl();
Piotr Padlewskia68a7872015-07-24 04:04:49 +0000379 if (Method->getCanonicalDecl()->isInlined())
380 return true;
381 }
382 return false;
383 }
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000384
385 bool isVTableHidden(const CXXRecordDecl *RD) const {
386 const auto &VtableLayout =
387 CGM.getItaniumVTableContext().getVTableLayout(RD);
388
389 for (const auto &VtableComponent : VtableLayout.vtable_components()) {
390 if (VtableComponent.isRTTIKind()) {
391 const CXXRecordDecl *RTTIDecl = VtableComponent.getRTTIDecl();
392 if (RTTIDecl->getVisibility() == Visibility::HiddenVisibility)
393 return true;
394 } else if (VtableComponent.isUsedFunctionPointerKind()) {
395 const CXXMethodDecl *Method = VtableComponent.getFunctionDecl();
396 if (Method->getVisibility() == Visibility::HiddenVisibility &&
397 !Method->isDefined())
398 return true;
399 }
400 }
401 return false;
402 }
Charles Davis4e786dd2010-05-25 19:52:27 +0000403};
John McCall86353412010-08-21 22:46:04 +0000404
405class ARMCXXABI : public ItaniumCXXABI {
406public:
Mark Seabornedf0d382013-07-24 16:25:13 +0000407 ARMCXXABI(CodeGen::CodeGenModule &CGM) :
408 ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true,
409 /* UseARMGuardVarABI = */ true) {}
John McCall5d865c322010-08-31 07:33:07 +0000410
Craig Topper4f12f102014-03-12 06:41:41 +0000411 bool HasThisReturn(GlobalDecl GD) const override {
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000412 return (isa<CXXConstructorDecl>(GD.getDecl()) || (
413 isa<CXXDestructorDecl>(GD.getDecl()) &&
414 GD.getDtorType() != Dtor_Deleting));
415 }
John McCall5d865c322010-08-31 07:33:07 +0000416
Craig Topper4f12f102014-03-12 06:41:41 +0000417 void EmitReturnFromThunk(CodeGenFunction &CGF, RValue RV,
418 QualType ResTy) override;
John McCall5d865c322010-08-31 07:33:07 +0000419
Craig Topper4f12f102014-03-12 06:41:41 +0000420 CharUnits getArrayCookieSizeImpl(QualType elementType) override;
John McCall7f416cc2015-09-08 08:05:57 +0000421 Address InitializeArrayCookie(CodeGenFunction &CGF,
422 Address NewPtr,
423 llvm::Value *NumElements,
424 const CXXNewExpr *expr,
425 QualType ElementType) override;
426 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF, Address allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000427 CharUnits cookieSize) override;
John McCall86353412010-08-21 22:46:04 +0000428};
Tim Northovera2ee4332014-03-29 15:09:45 +0000429
430class iOS64CXXABI : public ARMCXXABI {
431public:
John McCalld23b27e2016-09-16 02:40:45 +0000432 iOS64CXXABI(CodeGen::CodeGenModule &CGM) : ARMCXXABI(CGM) {
433 Use32BitVTableOffsetABI = true;
434 }
Tim Northover65f582f2014-03-30 17:32:48 +0000435
436 // ARM64 libraries are prepared for non-unique RTTI.
David Majnemere2cb8d12014-07-07 06:20:47 +0000437 bool shouldRTTIBeUnique() const override { return false; }
Tim Northovera2ee4332014-03-29 15:09:45 +0000438};
Dan Gohmanc2853072015-09-03 22:51:53 +0000439
440class WebAssemblyCXXABI final : public ItaniumCXXABI {
441public:
442 explicit WebAssemblyCXXABI(CodeGen::CodeGenModule &CGM)
443 : ItaniumCXXABI(CGM, /*UseARMMethodPtrABI=*/true,
444 /*UseARMGuardVarABI=*/true) {}
445
446private:
447 bool HasThisReturn(GlobalDecl GD) const override {
448 return isa<CXXConstructorDecl>(GD.getDecl()) ||
449 (isa<CXXDestructorDecl>(GD.getDecl()) &&
450 GD.getDtorType() != Dtor_Deleting);
451 }
Derek Schuff8179be42016-05-10 17:44:55 +0000452 bool canCallMismatchedFunctionType() const override { return false; }
Dan Gohmanc2853072015-09-03 22:51:53 +0000453};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000454}
Charles Davis4e786dd2010-05-25 19:52:27 +0000455
Charles Davis53c59df2010-08-16 03:33:14 +0000456CodeGen::CGCXXABI *CodeGen::CreateItaniumCXXABI(CodeGenModule &CGM) {
John McCallc8e01702013-04-16 22:48:15 +0000457 switch (CGM.getTarget().getCXXABI().getKind()) {
John McCall57625922013-01-25 23:36:14 +0000458 // For IR-generation purposes, there's no significant difference
459 // between the ARM and iOS ABIs.
460 case TargetCXXABI::GenericARM:
461 case TargetCXXABI::iOS:
Tim Northover756447a2015-10-30 16:30:36 +0000462 case TargetCXXABI::WatchOS:
John McCall57625922013-01-25 23:36:14 +0000463 return new ARMCXXABI(CGM);
Charles Davis4e786dd2010-05-25 19:52:27 +0000464
Tim Northovera2ee4332014-03-29 15:09:45 +0000465 case TargetCXXABI::iOS64:
466 return new iOS64CXXABI(CGM);
467
Tim Northover9bb857a2013-01-31 12:13:10 +0000468 // Note that AArch64 uses the generic ItaniumCXXABI class since it doesn't
469 // include the other 32-bit ARM oddities: constructor/destructor return values
470 // and array cookies.
471 case TargetCXXABI::GenericAArch64:
Mark Seabornedf0d382013-07-24 16:25:13 +0000472 return new ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true,
473 /* UseARMGuardVarABI = */ true);
Tim Northover9bb857a2013-01-31 12:13:10 +0000474
Zoran Jovanovic26a12162015-02-18 15:21:35 +0000475 case TargetCXXABI::GenericMIPS:
476 return new ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true);
477
Dan Gohmanc2853072015-09-03 22:51:53 +0000478 case TargetCXXABI::WebAssembly:
479 return new WebAssemblyCXXABI(CGM);
480
John McCall57625922013-01-25 23:36:14 +0000481 case TargetCXXABI::GenericItanium:
Mark Seabornedf0d382013-07-24 16:25:13 +0000482 if (CGM.getContext().getTargetInfo().getTriple().getArch()
483 == llvm::Triple::le32) {
484 // For PNaCl, use ARM-style method pointers so that PNaCl code
485 // does not assume anything about the alignment of function
486 // pointers.
487 return new ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true,
488 /* UseARMGuardVarABI = */ false);
489 }
John McCall57625922013-01-25 23:36:14 +0000490 return new ItaniumCXXABI(CGM);
491
492 case TargetCXXABI::Microsoft:
493 llvm_unreachable("Microsoft ABI is not Itanium-based");
494 }
495 llvm_unreachable("bad ABI kind");
John McCall86353412010-08-21 22:46:04 +0000496}
497
Chris Lattnera5f58b02011-07-09 17:41:47 +0000498llvm::Type *
John McCall7a9aac22010-08-23 01:21:21 +0000499ItaniumCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
500 if (MPT->isMemberDataPointer())
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000501 return CGM.PtrDiffTy;
Serge Guelton1d993272017-05-09 19:31:30 +0000502 return llvm::StructType::get(CGM.PtrDiffTy, CGM.PtrDiffTy);
John McCall1c456c82010-08-22 06:43:33 +0000503}
504
John McCalld9c6c0b2010-08-22 00:59:17 +0000505/// In the Itanium and ARM ABIs, method pointers have the form:
506/// struct { ptrdiff_t ptr; ptrdiff_t adj; } memptr;
507///
508/// In the Itanium ABI:
509/// - method pointers are virtual if (memptr.ptr & 1) is nonzero
510/// - the this-adjustment is (memptr.adj)
511/// - the virtual offset is (memptr.ptr - 1)
512///
513/// In the ARM ABI:
514/// - method pointers are virtual if (memptr.adj & 1) is nonzero
515/// - the this-adjustment is (memptr.adj >> 1)
516/// - the virtual offset is (memptr.ptr)
517/// ARM uses 'adj' for the virtual flag because Thumb functions
518/// may be only single-byte aligned.
519///
520/// If the member is virtual, the adjusted 'this' pointer points
521/// to a vtable pointer from which the virtual offset is applied.
522///
523/// If the member is non-virtual, memptr.ptr is the address of
524/// the function to call.
John McCallb92ab1a2016-10-26 23:46:34 +0000525CGCallee ItaniumCXXABI::EmitLoadOfMemberFunctionPointer(
John McCall7f416cc2015-09-08 08:05:57 +0000526 CodeGenFunction &CGF, const Expr *E, Address ThisAddr,
527 llvm::Value *&ThisPtrForCall,
David Majnemer2b0d66d2014-02-20 23:22:07 +0000528 llvm::Value *MemFnPtr, const MemberPointerType *MPT) {
John McCall475999d2010-08-22 00:05:51 +0000529 CGBuilderTy &Builder = CGF.Builder;
530
531 const FunctionProtoType *FPT =
532 MPT->getPointeeType()->getAs<FunctionProtoType>();
533 const CXXRecordDecl *RD =
534 cast<CXXRecordDecl>(MPT->getClass()->getAs<RecordType>()->getDecl());
535
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000536 llvm::FunctionType *FTy = CGM.getTypes().GetFunctionType(
537 CGM.getTypes().arrangeCXXMethodType(RD, FPT, /*FD=*/nullptr));
John McCall475999d2010-08-22 00:05:51 +0000538
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000539 llvm::Constant *ptrdiff_1 = llvm::ConstantInt::get(CGM.PtrDiffTy, 1);
John McCall475999d2010-08-22 00:05:51 +0000540
John McCalld9c6c0b2010-08-22 00:59:17 +0000541 llvm::BasicBlock *FnVirtual = CGF.createBasicBlock("memptr.virtual");
542 llvm::BasicBlock *FnNonVirtual = CGF.createBasicBlock("memptr.nonvirtual");
543 llvm::BasicBlock *FnEnd = CGF.createBasicBlock("memptr.end");
544
John McCalla1dee5302010-08-22 10:59:02 +0000545 // Extract memptr.adj, which is in the second field.
546 llvm::Value *RawAdj = Builder.CreateExtractValue(MemFnPtr, 1, "memptr.adj");
John McCalld9c6c0b2010-08-22 00:59:17 +0000547
548 // Compute the true adjustment.
549 llvm::Value *Adj = RawAdj;
Mark Seabornedf0d382013-07-24 16:25:13 +0000550 if (UseARMMethodPtrABI)
John McCalld9c6c0b2010-08-22 00:59:17 +0000551 Adj = Builder.CreateAShr(Adj, ptrdiff_1, "memptr.adj.shifted");
John McCall475999d2010-08-22 00:05:51 +0000552
553 // Apply the adjustment and cast back to the original struct type
554 // for consistency.
John McCall7f416cc2015-09-08 08:05:57 +0000555 llvm::Value *This = ThisAddr.getPointer();
John McCalld9c6c0b2010-08-22 00:59:17 +0000556 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy());
557 Ptr = Builder.CreateInBoundsGEP(Ptr, Adj);
558 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted");
John McCall7f416cc2015-09-08 08:05:57 +0000559 ThisPtrForCall = This;
John McCall475999d2010-08-22 00:05:51 +0000560
561 // Load the function pointer.
John McCalla1dee5302010-08-22 10:59:02 +0000562 llvm::Value *FnAsInt = Builder.CreateExtractValue(MemFnPtr, 0, "memptr.ptr");
John McCall475999d2010-08-22 00:05:51 +0000563
564 // If the LSB in the function pointer is 1, the function pointer points to
565 // a virtual function.
John McCalld9c6c0b2010-08-22 00:59:17 +0000566 llvm::Value *IsVirtual;
Mark Seabornedf0d382013-07-24 16:25:13 +0000567 if (UseARMMethodPtrABI)
John McCalld9c6c0b2010-08-22 00:59:17 +0000568 IsVirtual = Builder.CreateAnd(RawAdj, ptrdiff_1);
569 else
570 IsVirtual = Builder.CreateAnd(FnAsInt, ptrdiff_1);
571 IsVirtual = Builder.CreateIsNotNull(IsVirtual, "memptr.isvirtual");
John McCall475999d2010-08-22 00:05:51 +0000572 Builder.CreateCondBr(IsVirtual, FnVirtual, FnNonVirtual);
573
574 // In the virtual path, the adjustment left 'This' pointing to the
575 // vtable of the correct base subobject. The "function pointer" is an
John McCalld9c6c0b2010-08-22 00:59:17 +0000576 // offset within the vtable (+1 for the virtual flag on non-ARM).
John McCall475999d2010-08-22 00:05:51 +0000577 CGF.EmitBlock(FnVirtual);
578
579 // Cast the adjusted this to a pointer to vtable pointer and load.
Chris Lattner2192fe52011-07-18 04:24:23 +0000580 llvm::Type *VTableTy = Builder.getInt8PtrTy();
John McCall7f416cc2015-09-08 08:05:57 +0000581 CharUnits VTablePtrAlign =
582 CGF.CGM.getDynamicOffsetAlignment(ThisAddr.getAlignment(), RD,
583 CGF.getPointerAlign());
584 llvm::Value *VTable =
Piotr Padlewski4b1ac722015-09-15 21:46:55 +0000585 CGF.GetVTablePtr(Address(This, VTablePtrAlign), VTableTy, RD);
John McCall475999d2010-08-22 00:05:51 +0000586
587 // Apply the offset.
John McCalld23b27e2016-09-16 02:40:45 +0000588 // On ARM64, to reserve extra space in virtual member function pointers,
589 // we only pay attention to the low 32 bits of the offset.
John McCalld9c6c0b2010-08-22 00:59:17 +0000590 llvm::Value *VTableOffset = FnAsInt;
Mark Seabornedf0d382013-07-24 16:25:13 +0000591 if (!UseARMMethodPtrABI)
592 VTableOffset = Builder.CreateSub(VTableOffset, ptrdiff_1);
John McCalld23b27e2016-09-16 02:40:45 +0000593 if (Use32BitVTableOffsetABI) {
594 VTableOffset = Builder.CreateTrunc(VTableOffset, CGF.Int32Ty);
595 VTableOffset = Builder.CreateZExt(VTableOffset, CGM.PtrDiffTy);
596 }
John McCalld9c6c0b2010-08-22 00:59:17 +0000597 VTable = Builder.CreateGEP(VTable, VTableOffset);
John McCall475999d2010-08-22 00:05:51 +0000598
599 // Load the virtual function to call.
600 VTable = Builder.CreateBitCast(VTable, FTy->getPointerTo()->getPointerTo());
John McCall7f416cc2015-09-08 08:05:57 +0000601 llvm::Value *VirtualFn =
602 Builder.CreateAlignedLoad(VTable, CGF.getPointerAlign(),
603 "memptr.virtualfn");
John McCall475999d2010-08-22 00:05:51 +0000604 CGF.EmitBranch(FnEnd);
605
606 // In the non-virtual path, the function pointer is actually a
607 // function pointer.
608 CGF.EmitBlock(FnNonVirtual);
609 llvm::Value *NonVirtualFn =
John McCalld9c6c0b2010-08-22 00:59:17 +0000610 Builder.CreateIntToPtr(FnAsInt, FTy->getPointerTo(), "memptr.nonvirtualfn");
John McCall475999d2010-08-22 00:05:51 +0000611
612 // We're done.
613 CGF.EmitBlock(FnEnd);
John McCallb92ab1a2016-10-26 23:46:34 +0000614 llvm::PHINode *CalleePtr = Builder.CreatePHI(FTy->getPointerTo(), 2);
615 CalleePtr->addIncoming(VirtualFn, FnVirtual);
616 CalleePtr->addIncoming(NonVirtualFn, FnNonVirtual);
617
618 CGCallee Callee(FPT, CalleePtr);
John McCall475999d2010-08-22 00:05:51 +0000619 return Callee;
620}
John McCalla8bbb822010-08-22 03:04:22 +0000621
John McCallc134eb52010-08-31 21:07:20 +0000622/// Compute an l-value by applying the given pointer-to-member to a
623/// base object.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000624llvm::Value *ItaniumCXXABI::EmitMemberDataPointerAddress(
John McCall7f416cc2015-09-08 08:05:57 +0000625 CodeGenFunction &CGF, const Expr *E, Address Base, llvm::Value *MemPtr,
David Majnemer2b0d66d2014-02-20 23:22:07 +0000626 const MemberPointerType *MPT) {
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000627 assert(MemPtr->getType() == CGM.PtrDiffTy);
John McCallc134eb52010-08-31 21:07:20 +0000628
629 CGBuilderTy &Builder = CGF.Builder;
630
John McCallc134eb52010-08-31 21:07:20 +0000631 // Cast to char*.
John McCall7f416cc2015-09-08 08:05:57 +0000632 Base = Builder.CreateElementBitCast(Base, CGF.Int8Ty);
John McCallc134eb52010-08-31 21:07:20 +0000633
634 // Apply the offset, which we assume is non-null.
John McCall7f416cc2015-09-08 08:05:57 +0000635 llvm::Value *Addr =
636 Builder.CreateInBoundsGEP(Base.getPointer(), MemPtr, "memptr.offset");
John McCallc134eb52010-08-31 21:07:20 +0000637
638 // Cast the address to the appropriate pointer type, adopting the
639 // address space of the base pointer.
John McCall7f416cc2015-09-08 08:05:57 +0000640 llvm::Type *PType = CGF.ConvertTypeForMem(MPT->getPointeeType())
641 ->getPointerTo(Base.getAddressSpace());
John McCallc134eb52010-08-31 21:07:20 +0000642 return Builder.CreateBitCast(Addr, PType);
643}
644
John McCallc62bb392012-02-15 01:22:51 +0000645/// Perform a bitcast, derived-to-base, or base-to-derived member pointer
646/// conversion.
647///
648/// Bitcast conversions are always a no-op under Itanium.
John McCall7a9aac22010-08-23 01:21:21 +0000649///
650/// Obligatory offset/adjustment diagram:
651/// <-- offset --> <-- adjustment -->
652/// |--------------------------|----------------------|--------------------|
653/// ^Derived address point ^Base address point ^Member address point
654///
655/// So when converting a base member pointer to a derived member pointer,
656/// we add the offset to the adjustment because the address point has
657/// decreased; and conversely, when converting a derived MP to a base MP
658/// we subtract the offset from the adjustment because the address point
659/// has increased.
660///
661/// The standard forbids (at compile time) conversion to and from
662/// virtual bases, which is why we don't have to consider them here.
663///
664/// The standard forbids (at run time) casting a derived MP to a base
665/// MP when the derived MP does not point to a member of the base.
666/// This is why -1 is a reasonable choice for null data member
667/// pointers.
John McCalla1dee5302010-08-22 10:59:02 +0000668llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000669ItaniumCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
670 const CastExpr *E,
John McCallc62bb392012-02-15 01:22:51 +0000671 llvm::Value *src) {
John McCalle3027922010-08-25 11:45:40 +0000672 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
John McCallc62bb392012-02-15 01:22:51 +0000673 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
674 E->getCastKind() == CK_ReinterpretMemberPointer);
675
676 // Under Itanium, reinterprets don't require any additional processing.
677 if (E->getCastKind() == CK_ReinterpretMemberPointer) return src;
678
679 // Use constant emission if we can.
680 if (isa<llvm::Constant>(src))
681 return EmitMemberPointerConversion(E, cast<llvm::Constant>(src));
682
683 llvm::Constant *adj = getMemberPointerAdjustment(E);
684 if (!adj) return src;
John McCalla8bbb822010-08-22 03:04:22 +0000685
686 CGBuilderTy &Builder = CGF.Builder;
John McCallc62bb392012-02-15 01:22:51 +0000687 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
John McCalla8bbb822010-08-22 03:04:22 +0000688
John McCallc62bb392012-02-15 01:22:51 +0000689 const MemberPointerType *destTy =
690 E->getType()->castAs<MemberPointerType>();
John McCall1c456c82010-08-22 06:43:33 +0000691
John McCall7a9aac22010-08-23 01:21:21 +0000692 // For member data pointers, this is just a matter of adding the
693 // offset if the source is non-null.
John McCallc62bb392012-02-15 01:22:51 +0000694 if (destTy->isMemberDataPointer()) {
695 llvm::Value *dst;
696 if (isDerivedToBase)
697 dst = Builder.CreateNSWSub(src, adj, "adj");
John McCall7a9aac22010-08-23 01:21:21 +0000698 else
John McCallc62bb392012-02-15 01:22:51 +0000699 dst = Builder.CreateNSWAdd(src, adj, "adj");
John McCall7a9aac22010-08-23 01:21:21 +0000700
701 // Null check.
John McCallc62bb392012-02-15 01:22:51 +0000702 llvm::Value *null = llvm::Constant::getAllOnesValue(src->getType());
703 llvm::Value *isNull = Builder.CreateICmpEQ(src, null, "memptr.isnull");
704 return Builder.CreateSelect(isNull, src, dst);
John McCall7a9aac22010-08-23 01:21:21 +0000705 }
706
John McCalla1dee5302010-08-22 10:59:02 +0000707 // The this-adjustment is left-shifted by 1 on ARM.
Mark Seabornedf0d382013-07-24 16:25:13 +0000708 if (UseARMMethodPtrABI) {
John McCallc62bb392012-02-15 01:22:51 +0000709 uint64_t offset = cast<llvm::ConstantInt>(adj)->getZExtValue();
710 offset <<= 1;
711 adj = llvm::ConstantInt::get(adj->getType(), offset);
John McCalla1dee5302010-08-22 10:59:02 +0000712 }
713
John McCallc62bb392012-02-15 01:22:51 +0000714 llvm::Value *srcAdj = Builder.CreateExtractValue(src, 1, "src.adj");
715 llvm::Value *dstAdj;
716 if (isDerivedToBase)
717 dstAdj = Builder.CreateNSWSub(srcAdj, adj, "adj");
John McCalla1dee5302010-08-22 10:59:02 +0000718 else
John McCallc62bb392012-02-15 01:22:51 +0000719 dstAdj = Builder.CreateNSWAdd(srcAdj, adj, "adj");
John McCalla1dee5302010-08-22 10:59:02 +0000720
John McCallc62bb392012-02-15 01:22:51 +0000721 return Builder.CreateInsertValue(src, dstAdj, 1);
722}
723
724llvm::Constant *
725ItaniumCXXABI::EmitMemberPointerConversion(const CastExpr *E,
726 llvm::Constant *src) {
727 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
728 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
729 E->getCastKind() == CK_ReinterpretMemberPointer);
730
731 // Under Itanium, reinterprets don't require any additional processing.
732 if (E->getCastKind() == CK_ReinterpretMemberPointer) return src;
733
734 // If the adjustment is trivial, we don't need to do anything.
735 llvm::Constant *adj = getMemberPointerAdjustment(E);
736 if (!adj) return src;
737
738 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
739
740 const MemberPointerType *destTy =
741 E->getType()->castAs<MemberPointerType>();
742
743 // For member data pointers, this is just a matter of adding the
744 // offset if the source is non-null.
745 if (destTy->isMemberDataPointer()) {
746 // null maps to null.
747 if (src->isAllOnesValue()) return src;
748
749 if (isDerivedToBase)
750 return llvm::ConstantExpr::getNSWSub(src, adj);
751 else
752 return llvm::ConstantExpr::getNSWAdd(src, adj);
753 }
754
755 // The this-adjustment is left-shifted by 1 on ARM.
Mark Seabornedf0d382013-07-24 16:25:13 +0000756 if (UseARMMethodPtrABI) {
John McCallc62bb392012-02-15 01:22:51 +0000757 uint64_t offset = cast<llvm::ConstantInt>(adj)->getZExtValue();
758 offset <<= 1;
759 adj = llvm::ConstantInt::get(adj->getType(), offset);
760 }
761
762 llvm::Constant *srcAdj = llvm::ConstantExpr::getExtractValue(src, 1);
763 llvm::Constant *dstAdj;
764 if (isDerivedToBase)
765 dstAdj = llvm::ConstantExpr::getNSWSub(srcAdj, adj);
766 else
767 dstAdj = llvm::ConstantExpr::getNSWAdd(srcAdj, adj);
768
769 return llvm::ConstantExpr::getInsertValue(src, dstAdj, 1);
John McCalla8bbb822010-08-22 03:04:22 +0000770}
John McCall84fa5102010-08-22 04:16:24 +0000771
772llvm::Constant *
John McCall7a9aac22010-08-23 01:21:21 +0000773ItaniumCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
John McCall7a9aac22010-08-23 01:21:21 +0000774 // Itanium C++ ABI 2.3:
775 // A NULL pointer is represented as -1.
776 if (MPT->isMemberDataPointer())
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000777 return llvm::ConstantInt::get(CGM.PtrDiffTy, -1ULL, /*isSigned=*/true);
John McCalla1dee5302010-08-22 10:59:02 +0000778
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000779 llvm::Constant *Zero = llvm::ConstantInt::get(CGM.PtrDiffTy, 0);
John McCalla1dee5302010-08-22 10:59:02 +0000780 llvm::Constant *Values[2] = { Zero, Zero };
Chris Lattnere64d7ba2011-06-20 04:01:35 +0000781 return llvm::ConstantStruct::getAnon(Values);
John McCall84fa5102010-08-22 04:16:24 +0000782}
783
John McCallf3a88602011-02-03 08:15:49 +0000784llvm::Constant *
785ItaniumCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
786 CharUnits offset) {
John McCall7a9aac22010-08-23 01:21:21 +0000787 // Itanium C++ ABI 2.3:
788 // A pointer to data member is an offset from the base address of
789 // the class object containing it, represented as a ptrdiff_t
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000790 return llvm::ConstantInt::get(CGM.PtrDiffTy, offset.getQuantity());
John McCall7a9aac22010-08-23 01:21:21 +0000791}
792
David Majnemere2be95b2015-06-23 07:31:01 +0000793llvm::Constant *
794ItaniumCXXABI::EmitMemberFunctionPointer(const CXXMethodDecl *MD) {
Richard Smithdafff942012-01-14 04:30:29 +0000795 return BuildMemberPointer(MD, CharUnits::Zero());
796}
797
798llvm::Constant *ItaniumCXXABI::BuildMemberPointer(const CXXMethodDecl *MD,
799 CharUnits ThisAdjustment) {
John McCalla1dee5302010-08-22 10:59:02 +0000800 assert(MD->isInstance() && "Member function must not be static!");
801 MD = MD->getCanonicalDecl();
802
803 CodeGenTypes &Types = CGM.getTypes();
John McCalla1dee5302010-08-22 10:59:02 +0000804
805 // Get the function pointer (or index if this is a virtual function).
806 llvm::Constant *MemPtr[2];
807 if (MD->isVirtual()) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000808 uint64_t Index = CGM.getItaniumVTableContext().getMethodVTableIndex(MD);
John McCalla1dee5302010-08-22 10:59:02 +0000809
Ken Dyckdf016282011-04-09 01:30:02 +0000810 const ASTContext &Context = getContext();
811 CharUnits PointerWidth =
Douglas Gregore8bbc122011-09-02 00:18:52 +0000812 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
Ken Dyckdf016282011-04-09 01:30:02 +0000813 uint64_t VTableOffset = (Index * PointerWidth.getQuantity());
John McCalla1dee5302010-08-22 10:59:02 +0000814
Mark Seabornedf0d382013-07-24 16:25:13 +0000815 if (UseARMMethodPtrABI) {
John McCalla1dee5302010-08-22 10:59:02 +0000816 // ARM C++ ABI 3.2.1:
817 // This ABI specifies that adj contains twice the this
818 // adjustment, plus 1 if the member function is virtual. The
819 // least significant bit of adj then makes exactly the same
820 // discrimination as the least significant bit of ptr does for
821 // Itanium.
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000822 MemPtr[0] = llvm::ConstantInt::get(CGM.PtrDiffTy, VTableOffset);
823 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy,
Richard Smithdafff942012-01-14 04:30:29 +0000824 2 * ThisAdjustment.getQuantity() + 1);
John McCalla1dee5302010-08-22 10:59:02 +0000825 } else {
826 // Itanium C++ ABI 2.3:
827 // For a virtual function, [the pointer field] is 1 plus the
828 // virtual table offset (in bytes) of the function,
829 // represented as a ptrdiff_t.
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000830 MemPtr[0] = llvm::ConstantInt::get(CGM.PtrDiffTy, VTableOffset + 1);
831 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy,
Richard Smithdafff942012-01-14 04:30:29 +0000832 ThisAdjustment.getQuantity());
John McCalla1dee5302010-08-22 10:59:02 +0000833 }
834 } else {
John McCall2979fe02011-04-12 00:42:48 +0000835 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Chris Lattner2192fe52011-07-18 04:24:23 +0000836 llvm::Type *Ty;
John McCall2979fe02011-04-12 00:42:48 +0000837 // Check whether the function has a computable LLVM signature.
Chris Lattner8806e322011-07-10 00:18:59 +0000838 if (Types.isFuncTypeConvertible(FPT)) {
John McCall2979fe02011-04-12 00:42:48 +0000839 // The function has a computable LLVM signature; use the correct type.
John McCalla729c622012-02-17 03:33:10 +0000840 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
John McCalla1dee5302010-08-22 10:59:02 +0000841 } else {
John McCall2979fe02011-04-12 00:42:48 +0000842 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
843 // function type is incomplete.
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000844 Ty = CGM.PtrDiffTy;
John McCalla1dee5302010-08-22 10:59:02 +0000845 }
John McCall2979fe02011-04-12 00:42:48 +0000846 llvm::Constant *addr = CGM.GetAddrOfFunction(MD, Ty);
John McCalla1dee5302010-08-22 10:59:02 +0000847
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000848 MemPtr[0] = llvm::ConstantExpr::getPtrToInt(addr, CGM.PtrDiffTy);
Mark Seabornedf0d382013-07-24 16:25:13 +0000849 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy,
850 (UseARMMethodPtrABI ? 2 : 1) *
Richard Smithdafff942012-01-14 04:30:29 +0000851 ThisAdjustment.getQuantity());
John McCalla1dee5302010-08-22 10:59:02 +0000852 }
John McCall1c456c82010-08-22 06:43:33 +0000853
Chris Lattnere64d7ba2011-06-20 04:01:35 +0000854 return llvm::ConstantStruct::getAnon(MemPtr);
John McCall1c456c82010-08-22 06:43:33 +0000855}
856
Richard Smithdafff942012-01-14 04:30:29 +0000857llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const APValue &MP,
858 QualType MPType) {
859 const MemberPointerType *MPT = MPType->castAs<MemberPointerType>();
860 const ValueDecl *MPD = MP.getMemberPointerDecl();
861 if (!MPD)
862 return EmitNullMemberPointer(MPT);
863
Reid Kleckner452abac2013-05-09 21:01:17 +0000864 CharUnits ThisAdjustment = getMemberPointerPathAdjustment(MP);
Richard Smithdafff942012-01-14 04:30:29 +0000865
866 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD))
867 return BuildMemberPointer(MD, ThisAdjustment);
868
869 CharUnits FieldOffset =
870 getContext().toCharUnitsFromBits(getContext().getFieldOffset(MPD));
871 return EmitMemberDataPointer(MPT, ThisAdjustment + FieldOffset);
872}
873
John McCall131d97d2010-08-22 08:30:07 +0000874/// The comparison algorithm is pretty easy: the member pointers are
875/// the same if they're either bitwise identical *or* both null.
876///
877/// ARM is different here only because null-ness is more complicated.
878llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000879ItaniumCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
880 llvm::Value *L,
881 llvm::Value *R,
882 const MemberPointerType *MPT,
883 bool Inequality) {
John McCall131d97d2010-08-22 08:30:07 +0000884 CGBuilderTy &Builder = CGF.Builder;
885
John McCall131d97d2010-08-22 08:30:07 +0000886 llvm::ICmpInst::Predicate Eq;
887 llvm::Instruction::BinaryOps And, Or;
888 if (Inequality) {
889 Eq = llvm::ICmpInst::ICMP_NE;
890 And = llvm::Instruction::Or;
891 Or = llvm::Instruction::And;
892 } else {
893 Eq = llvm::ICmpInst::ICMP_EQ;
894 And = llvm::Instruction::And;
895 Or = llvm::Instruction::Or;
896 }
897
John McCall7a9aac22010-08-23 01:21:21 +0000898 // Member data pointers are easy because there's a unique null
899 // value, so it just comes down to bitwise equality.
900 if (MPT->isMemberDataPointer())
901 return Builder.CreateICmp(Eq, L, R);
902
903 // For member function pointers, the tautologies are more complex.
904 // The Itanium tautology is:
John McCall61a14882010-08-23 06:56:36 +0000905 // (L == R) <==> (L.ptr == R.ptr && (L.ptr == 0 || L.adj == R.adj))
John McCall7a9aac22010-08-23 01:21:21 +0000906 // The ARM tautology is:
John McCall61a14882010-08-23 06:56:36 +0000907 // (L == R) <==> (L.ptr == R.ptr &&
908 // (L.adj == R.adj ||
909 // (L.ptr == 0 && ((L.adj|R.adj) & 1) == 0)))
John McCall7a9aac22010-08-23 01:21:21 +0000910 // The inequality tautologies have exactly the same structure, except
911 // applying De Morgan's laws.
912
913 llvm::Value *LPtr = Builder.CreateExtractValue(L, 0, "lhs.memptr.ptr");
914 llvm::Value *RPtr = Builder.CreateExtractValue(R, 0, "rhs.memptr.ptr");
915
John McCall131d97d2010-08-22 08:30:07 +0000916 // This condition tests whether L.ptr == R.ptr. This must always be
917 // true for equality to hold.
918 llvm::Value *PtrEq = Builder.CreateICmp(Eq, LPtr, RPtr, "cmp.ptr");
919
920 // This condition, together with the assumption that L.ptr == R.ptr,
921 // tests whether the pointers are both null. ARM imposes an extra
922 // condition.
923 llvm::Value *Zero = llvm::Constant::getNullValue(LPtr->getType());
924 llvm::Value *EqZero = Builder.CreateICmp(Eq, LPtr, Zero, "cmp.ptr.null");
925
926 // This condition tests whether L.adj == R.adj. If this isn't
927 // true, the pointers are unequal unless they're both null.
John McCalla1dee5302010-08-22 10:59:02 +0000928 llvm::Value *LAdj = Builder.CreateExtractValue(L, 1, "lhs.memptr.adj");
929 llvm::Value *RAdj = Builder.CreateExtractValue(R, 1, "rhs.memptr.adj");
John McCall131d97d2010-08-22 08:30:07 +0000930 llvm::Value *AdjEq = Builder.CreateICmp(Eq, LAdj, RAdj, "cmp.adj");
931
932 // Null member function pointers on ARM clear the low bit of Adj,
933 // so the zero condition has to check that neither low bit is set.
Mark Seabornedf0d382013-07-24 16:25:13 +0000934 if (UseARMMethodPtrABI) {
John McCall131d97d2010-08-22 08:30:07 +0000935 llvm::Value *One = llvm::ConstantInt::get(LPtr->getType(), 1);
936
937 // Compute (l.adj | r.adj) & 1 and test it against zero.
938 llvm::Value *OrAdj = Builder.CreateOr(LAdj, RAdj, "or.adj");
939 llvm::Value *OrAdjAnd1 = Builder.CreateAnd(OrAdj, One);
940 llvm::Value *OrAdjAnd1EqZero = Builder.CreateICmp(Eq, OrAdjAnd1, Zero,
941 "cmp.or.adj");
942 EqZero = Builder.CreateBinOp(And, EqZero, OrAdjAnd1EqZero);
943 }
944
945 // Tie together all our conditions.
946 llvm::Value *Result = Builder.CreateBinOp(Or, EqZero, AdjEq);
947 Result = Builder.CreateBinOp(And, PtrEq, Result,
948 Inequality ? "memptr.ne" : "memptr.eq");
949 return Result;
950}
951
952llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000953ItaniumCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
954 llvm::Value *MemPtr,
955 const MemberPointerType *MPT) {
John McCall131d97d2010-08-22 08:30:07 +0000956 CGBuilderTy &Builder = CGF.Builder;
John McCall7a9aac22010-08-23 01:21:21 +0000957
958 /// For member data pointers, this is just a check against -1.
959 if (MPT->isMemberDataPointer()) {
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000960 assert(MemPtr->getType() == CGM.PtrDiffTy);
John McCall7a9aac22010-08-23 01:21:21 +0000961 llvm::Value *NegativeOne =
962 llvm::Constant::getAllOnesValue(MemPtr->getType());
963 return Builder.CreateICmpNE(MemPtr, NegativeOne, "memptr.tobool");
964 }
John McCall131d97d2010-08-22 08:30:07 +0000965
Daniel Dunbar914bc412011-04-19 23:10:47 +0000966 // In Itanium, a member function pointer is not null if 'ptr' is not null.
John McCalla1dee5302010-08-22 10:59:02 +0000967 llvm::Value *Ptr = Builder.CreateExtractValue(MemPtr, 0, "memptr.ptr");
John McCall131d97d2010-08-22 08:30:07 +0000968
969 llvm::Constant *Zero = llvm::ConstantInt::get(Ptr->getType(), 0);
970 llvm::Value *Result = Builder.CreateICmpNE(Ptr, Zero, "memptr.tobool");
971
Daniel Dunbar914bc412011-04-19 23:10:47 +0000972 // On ARM, a member function pointer is also non-null if the low bit of 'adj'
973 // (the virtual bit) is set.
Mark Seabornedf0d382013-07-24 16:25:13 +0000974 if (UseARMMethodPtrABI) {
John McCall131d97d2010-08-22 08:30:07 +0000975 llvm::Constant *One = llvm::ConstantInt::get(Ptr->getType(), 1);
John McCalla1dee5302010-08-22 10:59:02 +0000976 llvm::Value *Adj = Builder.CreateExtractValue(MemPtr, 1, "memptr.adj");
John McCall131d97d2010-08-22 08:30:07 +0000977 llvm::Value *VirtualBit = Builder.CreateAnd(Adj, One, "memptr.virtualbit");
Daniel Dunbar914bc412011-04-19 23:10:47 +0000978 llvm::Value *IsVirtual = Builder.CreateICmpNE(VirtualBit, Zero,
979 "memptr.isvirtual");
980 Result = Builder.CreateOr(Result, IsVirtual);
John McCall131d97d2010-08-22 08:30:07 +0000981 }
982
983 return Result;
984}
John McCall1c456c82010-08-22 06:43:33 +0000985
Reid Kleckner40ca9132014-05-13 22:05:45 +0000986bool ItaniumCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
987 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
988 if (!RD)
989 return false;
990
Reid Klecknerd355ca72014-05-15 01:26:32 +0000991 // Return indirectly if we have a non-trivial copy ctor or non-trivial dtor.
992 // FIXME: Use canCopyArgument() when it is fixed to handle lazily declared
993 // special members.
994 if (RD->hasNonTrivialDestructor() || RD->hasNonTrivialCopyConstructor()) {
John McCall7f416cc2015-09-08 08:05:57 +0000995 auto Align = CGM.getContext().getTypeAlignInChars(FI.getReturnType());
996 FI.getReturnInfo() = ABIArgInfo::getIndirect(Align, /*ByVal=*/false);
Reid Kleckner40ca9132014-05-13 22:05:45 +0000997 return true;
998 }
Reid Kleckner40ca9132014-05-13 22:05:45 +0000999 return false;
1000}
1001
John McCall614dbdc2010-08-22 21:01:12 +00001002/// The Itanium ABI requires non-zero initialization only for data
1003/// member pointers, for which '0' is a valid offset.
1004bool ItaniumCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
David Majnemer5fd33e02015-04-24 01:25:08 +00001005 return MPT->isMemberFunctionPointer();
John McCall84fa5102010-08-22 04:16:24 +00001006}
John McCall5d865c322010-08-31 07:33:07 +00001007
John McCall82fb8922012-09-25 10:10:39 +00001008/// The Itanium ABI always places an offset to the complete object
1009/// at entry -2 in the vtable.
David Majnemer08681372014-11-01 07:37:17 +00001010void ItaniumCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
1011 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +00001012 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +00001013 QualType ElementType,
1014 const CXXDestructorDecl *Dtor) {
1015 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +00001016 if (UseGlobalDelete) {
1017 // Derive the complete-object pointer, which is what we need
1018 // to pass to the deallocation function.
John McCall82fb8922012-09-25 10:10:39 +00001019
David Majnemer0c0b6d92014-10-31 20:09:12 +00001020 // Grab the vtable pointer as an intptr_t*.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001021 auto *ClassDecl =
1022 cast<CXXRecordDecl>(ElementType->getAs<RecordType>()->getDecl());
1023 llvm::Value *VTable =
1024 CGF.GetVTablePtr(Ptr, CGF.IntPtrTy->getPointerTo(), ClassDecl);
John McCall82fb8922012-09-25 10:10:39 +00001025
David Majnemer0c0b6d92014-10-31 20:09:12 +00001026 // Track back to entry -2 and pull out the offset there.
1027 llvm::Value *OffsetPtr = CGF.Builder.CreateConstInBoundsGEP1_64(
1028 VTable, -2, "complete-offset.ptr");
John McCall7f416cc2015-09-08 08:05:57 +00001029 llvm::Value *Offset =
1030 CGF.Builder.CreateAlignedLoad(OffsetPtr, CGF.getPointerAlign());
David Majnemer0c0b6d92014-10-31 20:09:12 +00001031
1032 // Apply the offset.
John McCall7f416cc2015-09-08 08:05:57 +00001033 llvm::Value *CompletePtr =
1034 CGF.Builder.CreateBitCast(Ptr.getPointer(), CGF.Int8PtrTy);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001035 CompletePtr = CGF.Builder.CreateInBoundsGEP(CompletePtr, Offset);
1036
1037 // If we're supposed to call the global delete, make sure we do so
1038 // even if the destructor throws.
David Majnemer08681372014-11-01 07:37:17 +00001039 CGF.pushCallObjectDeleteCleanup(DE->getOperatorDelete(), CompletePtr,
1040 ElementType);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001041 }
1042
1043 // FIXME: Provide a source location here even though there's no
1044 // CXXMemberCallExpr for dtor call.
1045 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
1046 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr);
1047
1048 if (UseGlobalDelete)
1049 CGF.PopCleanupBlock();
John McCall82fb8922012-09-25 10:10:39 +00001050}
1051
David Majnemer442d0a22014-11-25 07:20:20 +00001052void ItaniumCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
1053 // void __cxa_rethrow();
1054
1055 llvm::FunctionType *FTy =
1056 llvm::FunctionType::get(CGM.VoidTy, /*IsVarArgs=*/false);
1057
1058 llvm::Constant *Fn = CGM.CreateRuntimeFunction(FTy, "__cxa_rethrow");
1059
1060 if (isNoReturn)
1061 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, None);
1062 else
1063 CGF.EmitRuntimeCallOrInvoke(Fn);
1064}
1065
David Majnemer7c237072015-03-05 00:46:22 +00001066static llvm::Constant *getAllocateExceptionFn(CodeGenModule &CGM) {
1067 // void *__cxa_allocate_exception(size_t thrown_size);
1068
1069 llvm::FunctionType *FTy =
1070 llvm::FunctionType::get(CGM.Int8PtrTy, CGM.SizeTy, /*IsVarArgs=*/false);
1071
1072 return CGM.CreateRuntimeFunction(FTy, "__cxa_allocate_exception");
1073}
1074
1075static llvm::Constant *getThrowFn(CodeGenModule &CGM) {
1076 // void __cxa_throw(void *thrown_exception, std::type_info *tinfo,
1077 // void (*dest) (void *));
1078
1079 llvm::Type *Args[3] = { CGM.Int8PtrTy, CGM.Int8PtrTy, CGM.Int8PtrTy };
1080 llvm::FunctionType *FTy =
1081 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
1082
1083 return CGM.CreateRuntimeFunction(FTy, "__cxa_throw");
1084}
1085
1086void ItaniumCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
1087 QualType ThrowType = E->getSubExpr()->getType();
1088 // Now allocate the exception object.
1089 llvm::Type *SizeTy = CGF.ConvertType(getContext().getSizeType());
1090 uint64_t TypeSize = getContext().getTypeSizeInChars(ThrowType).getQuantity();
1091
1092 llvm::Constant *AllocExceptionFn = getAllocateExceptionFn(CGM);
1093 llvm::CallInst *ExceptionPtr = CGF.EmitNounwindRuntimeCall(
1094 AllocExceptionFn, llvm::ConstantInt::get(SizeTy, TypeSize), "exception");
1095
John McCall7f416cc2015-09-08 08:05:57 +00001096 CharUnits ExnAlign = getAlignmentOfExnObject();
1097 CGF.EmitAnyExprToExn(E->getSubExpr(), Address(ExceptionPtr, ExnAlign));
David Majnemer7c237072015-03-05 00:46:22 +00001098
1099 // Now throw the exception.
1100 llvm::Constant *TypeInfo = CGM.GetAddrOfRTTIDescriptor(ThrowType,
1101 /*ForEH=*/true);
1102
1103 // The address of the destructor. If the exception type has a
1104 // trivial destructor (or isn't a record), we just pass null.
1105 llvm::Constant *Dtor = nullptr;
1106 if (const RecordType *RecordTy = ThrowType->getAs<RecordType>()) {
1107 CXXRecordDecl *Record = cast<CXXRecordDecl>(RecordTy->getDecl());
1108 if (!Record->hasTrivialDestructor()) {
1109 CXXDestructorDecl *DtorD = Record->getDestructor();
1110 Dtor = CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete);
1111 Dtor = llvm::ConstantExpr::getBitCast(Dtor, CGM.Int8PtrTy);
1112 }
1113 }
1114 if (!Dtor) Dtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
1115
1116 llvm::Value *args[] = { ExceptionPtr, TypeInfo, Dtor };
1117 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(CGM), args);
1118}
1119
David Majnemer1162d252014-06-22 19:05:33 +00001120static llvm::Constant *getItaniumDynamicCastFn(CodeGenFunction &CGF) {
1121 // void *__dynamic_cast(const void *sub,
1122 // const abi::__class_type_info *src,
1123 // const abi::__class_type_info *dst,
1124 // std::ptrdiff_t src2dst_offset);
1125
1126 llvm::Type *Int8PtrTy = CGF.Int8PtrTy;
1127 llvm::Type *PtrDiffTy =
1128 CGF.ConvertType(CGF.getContext().getPointerDiffType());
1129
1130 llvm::Type *Args[4] = { Int8PtrTy, Int8PtrTy, Int8PtrTy, PtrDiffTy };
1131
1132 llvm::FunctionType *FTy = llvm::FunctionType::get(Int8PtrTy, Args, false);
1133
1134 // Mark the function as nounwind readonly.
1135 llvm::Attribute::AttrKind FuncAttrs[] = { llvm::Attribute::NoUnwind,
1136 llvm::Attribute::ReadOnly };
Reid Klecknerde864822017-03-21 16:57:30 +00001137 llvm::AttributeList Attrs = llvm::AttributeList::get(
1138 CGF.getLLVMContext(), llvm::AttributeList::FunctionIndex, FuncAttrs);
David Majnemer1162d252014-06-22 19:05:33 +00001139
1140 return CGF.CGM.CreateRuntimeFunction(FTy, "__dynamic_cast", Attrs);
1141}
1142
1143static llvm::Constant *getBadCastFn(CodeGenFunction &CGF) {
1144 // void __cxa_bad_cast();
1145 llvm::FunctionType *FTy = llvm::FunctionType::get(CGF.VoidTy, false);
1146 return CGF.CGM.CreateRuntimeFunction(FTy, "__cxa_bad_cast");
1147}
1148
1149/// \brief Compute the src2dst_offset hint as described in the
1150/// Itanium C++ ABI [2.9.7]
1151static CharUnits computeOffsetHint(ASTContext &Context,
1152 const CXXRecordDecl *Src,
1153 const CXXRecordDecl *Dst) {
1154 CXXBasePaths Paths(/*FindAmbiguities=*/true, /*RecordPaths=*/true,
1155 /*DetectVirtual=*/false);
1156
1157 // If Dst is not derived from Src we can skip the whole computation below and
1158 // return that Src is not a public base of Dst. Record all inheritance paths.
1159 if (!Dst->isDerivedFrom(Src, Paths))
1160 return CharUnits::fromQuantity(-2ULL);
1161
1162 unsigned NumPublicPaths = 0;
1163 CharUnits Offset;
1164
1165 // Now walk all possible inheritance paths.
Piotr Padlewski44b4ce82015-07-28 16:10:58 +00001166 for (const CXXBasePath &Path : Paths) {
1167 if (Path.Access != AS_public) // Ignore non-public inheritance.
David Majnemer1162d252014-06-22 19:05:33 +00001168 continue;
1169
1170 ++NumPublicPaths;
1171
Piotr Padlewski44b4ce82015-07-28 16:10:58 +00001172 for (const CXXBasePathElement &PathElement : Path) {
David Majnemer1162d252014-06-22 19:05:33 +00001173 // If the path contains a virtual base class we can't give any hint.
1174 // -1: no hint.
Piotr Padlewski44b4ce82015-07-28 16:10:58 +00001175 if (PathElement.Base->isVirtual())
David Majnemer1162d252014-06-22 19:05:33 +00001176 return CharUnits::fromQuantity(-1ULL);
1177
1178 if (NumPublicPaths > 1) // Won't use offsets, skip computation.
1179 continue;
1180
1181 // Accumulate the base class offsets.
Piotr Padlewski44b4ce82015-07-28 16:10:58 +00001182 const ASTRecordLayout &L = Context.getASTRecordLayout(PathElement.Class);
1183 Offset += L.getBaseClassOffset(
1184 PathElement.Base->getType()->getAsCXXRecordDecl());
David Majnemer1162d252014-06-22 19:05:33 +00001185 }
1186 }
1187
1188 // -2: Src is not a public base of Dst.
1189 if (NumPublicPaths == 0)
1190 return CharUnits::fromQuantity(-2ULL);
1191
1192 // -3: Src is a multiple public base type but never a virtual base type.
1193 if (NumPublicPaths > 1)
1194 return CharUnits::fromQuantity(-3ULL);
1195
1196 // Otherwise, the Src type is a unique public nonvirtual base type of Dst.
1197 // Return the offset of Src from the origin of Dst.
1198 return Offset;
1199}
1200
1201static llvm::Constant *getBadTypeidFn(CodeGenFunction &CGF) {
1202 // void __cxa_bad_typeid();
1203 llvm::FunctionType *FTy = llvm::FunctionType::get(CGF.VoidTy, false);
1204
1205 return CGF.CGM.CreateRuntimeFunction(FTy, "__cxa_bad_typeid");
1206}
1207
1208bool ItaniumCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
1209 QualType SrcRecordTy) {
1210 return IsDeref;
1211}
1212
1213void ItaniumCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
1214 llvm::Value *Fn = getBadTypeidFn(CGF);
1215 CGF.EmitRuntimeCallOrInvoke(Fn).setDoesNotReturn();
1216 CGF.Builder.CreateUnreachable();
1217}
1218
1219llvm::Value *ItaniumCXXABI::EmitTypeid(CodeGenFunction &CGF,
1220 QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +00001221 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +00001222 llvm::Type *StdTypeInfoPtrTy) {
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001223 auto *ClassDecl =
1224 cast<CXXRecordDecl>(SrcRecordTy->getAs<RecordType>()->getDecl());
David Majnemer1162d252014-06-22 19:05:33 +00001225 llvm::Value *Value =
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001226 CGF.GetVTablePtr(ThisPtr, StdTypeInfoPtrTy->getPointerTo(), ClassDecl);
David Majnemer1162d252014-06-22 19:05:33 +00001227
1228 // Load the type info.
1229 Value = CGF.Builder.CreateConstInBoundsGEP1_64(Value, -1ULL);
John McCall7f416cc2015-09-08 08:05:57 +00001230 return CGF.Builder.CreateAlignedLoad(Value, CGF.getPointerAlign());
David Majnemer1162d252014-06-22 19:05:33 +00001231}
1232
1233bool ItaniumCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
1234 QualType SrcRecordTy) {
1235 return SrcIsPtr;
1236}
1237
1238llvm::Value *ItaniumCXXABI::EmitDynamicCastCall(
John McCall7f416cc2015-09-08 08:05:57 +00001239 CodeGenFunction &CGF, Address ThisAddr, QualType SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00001240 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
1241 llvm::Type *PtrDiffLTy =
1242 CGF.ConvertType(CGF.getContext().getPointerDiffType());
1243 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
1244
1245 llvm::Value *SrcRTTI =
1246 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
1247 llvm::Value *DestRTTI =
1248 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
1249
1250 // Compute the offset hint.
1251 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
1252 const CXXRecordDecl *DestDecl = DestRecordTy->getAsCXXRecordDecl();
1253 llvm::Value *OffsetHint = llvm::ConstantInt::get(
1254 PtrDiffLTy,
1255 computeOffsetHint(CGF.getContext(), SrcDecl, DestDecl).getQuantity());
1256
1257 // Emit the call to __dynamic_cast.
John McCall7f416cc2015-09-08 08:05:57 +00001258 llvm::Value *Value = ThisAddr.getPointer();
David Majnemer1162d252014-06-22 19:05:33 +00001259 Value = CGF.EmitCastToVoidPtr(Value);
1260
1261 llvm::Value *args[] = {Value, SrcRTTI, DestRTTI, OffsetHint};
1262 Value = CGF.EmitNounwindRuntimeCall(getItaniumDynamicCastFn(CGF), args);
1263 Value = CGF.Builder.CreateBitCast(Value, DestLTy);
1264
1265 /// C++ [expr.dynamic.cast]p9:
1266 /// A failed cast to reference type throws std::bad_cast
1267 if (DestTy->isReferenceType()) {
1268 llvm::BasicBlock *BadCastBlock =
1269 CGF.createBasicBlock("dynamic_cast.bad_cast");
1270
1271 llvm::Value *IsNull = CGF.Builder.CreateIsNull(Value);
1272 CGF.Builder.CreateCondBr(IsNull, BadCastBlock, CastEnd);
1273
1274 CGF.EmitBlock(BadCastBlock);
1275 EmitBadCastCall(CGF);
1276 }
1277
1278 return Value;
1279}
1280
1281llvm::Value *ItaniumCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001282 Address ThisAddr,
David Majnemer1162d252014-06-22 19:05:33 +00001283 QualType SrcRecordTy,
1284 QualType DestTy) {
1285 llvm::Type *PtrDiffLTy =
1286 CGF.ConvertType(CGF.getContext().getPointerDiffType());
1287 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
1288
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001289 auto *ClassDecl =
1290 cast<CXXRecordDecl>(SrcRecordTy->getAs<RecordType>()->getDecl());
David Majnemer1162d252014-06-22 19:05:33 +00001291 // Get the vtable pointer.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001292 llvm::Value *VTable = CGF.GetVTablePtr(ThisAddr, PtrDiffLTy->getPointerTo(),
1293 ClassDecl);
David Majnemer1162d252014-06-22 19:05:33 +00001294
1295 // Get the offset-to-top from the vtable.
1296 llvm::Value *OffsetToTop =
1297 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, -2ULL);
John McCall7f416cc2015-09-08 08:05:57 +00001298 OffsetToTop =
1299 CGF.Builder.CreateAlignedLoad(OffsetToTop, CGF.getPointerAlign(),
1300 "offset.to.top");
David Majnemer1162d252014-06-22 19:05:33 +00001301
1302 // Finally, add the offset to the pointer.
John McCall7f416cc2015-09-08 08:05:57 +00001303 llvm::Value *Value = ThisAddr.getPointer();
David Majnemer1162d252014-06-22 19:05:33 +00001304 Value = CGF.EmitCastToVoidPtr(Value);
1305 Value = CGF.Builder.CreateInBoundsGEP(Value, OffsetToTop);
1306
1307 return CGF.Builder.CreateBitCast(Value, DestLTy);
1308}
1309
1310bool ItaniumCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
1311 llvm::Value *Fn = getBadCastFn(CGF);
1312 CGF.EmitRuntimeCallOrInvoke(Fn).setDoesNotReturn();
1313 CGF.Builder.CreateUnreachable();
1314 return true;
1315}
1316
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001317llvm::Value *
1318ItaniumCXXABI::GetVirtualBaseClassOffset(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001319 Address This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001320 const CXXRecordDecl *ClassDecl,
1321 const CXXRecordDecl *BaseClassDecl) {
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001322 llvm::Value *VTablePtr = CGF.GetVTablePtr(This, CGM.Int8PtrTy, ClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001323 CharUnits VBaseOffsetOffset =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001324 CGM.getItaniumVTableContext().getVirtualBaseOffsetOffset(ClassDecl,
1325 BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001326
1327 llvm::Value *VBaseOffsetPtr =
1328 CGF.Builder.CreateConstGEP1_64(VTablePtr, VBaseOffsetOffset.getQuantity(),
1329 "vbase.offset.ptr");
1330 VBaseOffsetPtr = CGF.Builder.CreateBitCast(VBaseOffsetPtr,
1331 CGM.PtrDiffTy->getPointerTo());
1332
1333 llvm::Value *VBaseOffset =
John McCall7f416cc2015-09-08 08:05:57 +00001334 CGF.Builder.CreateAlignedLoad(VBaseOffsetPtr, CGF.getPointerAlign(),
1335 "vbase.offset");
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001336
1337 return VBaseOffset;
1338}
1339
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001340void ItaniumCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1341 // Just make sure we're in sync with TargetCXXABI.
1342 assert(CGM.getTarget().getCXXABI().hasConstructorVariants());
1343
Rafael Espindolac3cde362013-12-09 14:51:17 +00001344 // The constructor used for constructing this as a base class;
1345 // ignores virtual bases.
1346 CGM.EmitGlobal(GlobalDecl(D, Ctor_Base));
1347
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001348 // The constructor used for constructing this as a complete class;
Nico Weber4c2ffb22015-01-07 05:25:05 +00001349 // constructs the virtual bases, then calls the base constructor.
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001350 if (!D->getParent()->isAbstract()) {
1351 // We don't need to emit the complete ctor if the class is abstract.
1352 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
1353 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001354}
1355
George Burgess IVf203dbf2017-02-22 20:28:02 +00001356CGCXXABI::AddedStructorArgs
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001357ItaniumCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
1358 SmallVectorImpl<CanQualType> &ArgTys) {
John McCall9bca9232010-09-02 10:25:57 +00001359 ASTContext &Context = getContext();
John McCall5d865c322010-08-31 07:33:07 +00001360
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001361 // All parameters are already in place except VTT, which goes after 'this'.
1362 // These are Clang types, so we don't need to worry about sret yet.
John McCall5d865c322010-08-31 07:33:07 +00001363
1364 // Check if we need to add a VTT parameter (which has type void **).
George Burgess IVf203dbf2017-02-22 20:28:02 +00001365 if (T == StructorType::Base && MD->getParent()->getNumVBases() != 0) {
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001366 ArgTys.insert(ArgTys.begin() + 1,
1367 Context.getPointerType(Context.VoidPtrTy));
George Burgess IVf203dbf2017-02-22 20:28:02 +00001368 return AddedStructorArgs::prefix(1);
1369 }
1370 return AddedStructorArgs{};
John McCall5d865c322010-08-31 07:33:07 +00001371}
1372
Reid Klecknere7de47e2013-07-22 13:51:44 +00001373void ItaniumCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
Rafael Espindolac3cde362013-12-09 14:51:17 +00001374 // The destructor used for destructing this as a base class; ignores
1375 // virtual bases.
1376 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
Reid Klecknere7de47e2013-07-22 13:51:44 +00001377
1378 // The destructor used for destructing this as a most-derived class;
1379 // call the base destructor and then destructs any virtual bases.
1380 CGM.EmitGlobal(GlobalDecl(D, Dtor_Complete));
1381
Rafael Espindolac3cde362013-12-09 14:51:17 +00001382 // The destructor in a virtual table is always a 'deleting'
1383 // destructor, which calls the complete destructor and then uses the
1384 // appropriate operator delete.
1385 if (D->isVirtual())
1386 CGM.EmitGlobal(GlobalDecl(D, Dtor_Deleting));
Reid Klecknere7de47e2013-07-22 13:51:44 +00001387}
1388
Reid Kleckner89077a12013-12-17 19:46:40 +00001389void ItaniumCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1390 QualType &ResTy,
1391 FunctionArgList &Params) {
John McCall5d865c322010-08-31 07:33:07 +00001392 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001393 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
John McCall5d865c322010-08-31 07:33:07 +00001394
1395 // Check if we need a VTT parameter as well.
Peter Collingbourne66f82e62013-06-28 20:45:28 +00001396 if (NeedsVTTParameter(CGF.CurGD)) {
John McCall9bca9232010-09-02 10:25:57 +00001397 ASTContext &Context = getContext();
John McCall5d865c322010-08-31 07:33:07 +00001398
1399 // FIXME: avoid the fake decl
1400 QualType T = Context.getPointerType(Context.VoidPtrTy);
1401 ImplicitParamDecl *VTTDecl
Craig Topper8a13c412014-05-21 05:09:00 +00001402 = ImplicitParamDecl::Create(Context, nullptr, MD->getLocation(),
John McCall5d865c322010-08-31 07:33:07 +00001403 &Context.Idents.get("vtt"), T);
Reid Kleckner89077a12013-12-17 19:46:40 +00001404 Params.insert(Params.begin() + 1, VTTDecl);
Reid Kleckner2af6d732013-12-13 00:09:59 +00001405 getStructorImplicitParamDecl(CGF) = VTTDecl;
John McCall5d865c322010-08-31 07:33:07 +00001406 }
1407}
1408
John McCall5d865c322010-08-31 07:33:07 +00001409void ItaniumCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
Justin Lebared4f1722016-07-27 22:04:24 +00001410 // Naked functions have no prolog.
1411 if (CGF.CurFuncDecl && CGF.CurFuncDecl->hasAttr<NakedAttr>())
1412 return;
1413
John McCall5d865c322010-08-31 07:33:07 +00001414 /// Initialize the 'this' slot.
1415 EmitThisParam(CGF);
1416
1417 /// Initialize the 'vtt' slot if needed.
Reid Kleckner2af6d732013-12-13 00:09:59 +00001418 if (getStructorImplicitParamDecl(CGF)) {
1419 getStructorImplicitParamValue(CGF) = CGF.Builder.CreateLoad(
1420 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)), "vtt");
John McCall5d865c322010-08-31 07:33:07 +00001421 }
John McCall5d865c322010-08-31 07:33:07 +00001422
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001423 /// If this is a function that the ABI specifies returns 'this', initialize
1424 /// the return slot to 'this' at the start of the function.
1425 ///
1426 /// Unlike the setting of return types, this is done within the ABI
1427 /// implementation instead of by clients of CGCXXABI because:
1428 /// 1) getThisValue is currently protected
1429 /// 2) in theory, an ABI could implement 'this' returns some other way;
1430 /// HasThisReturn only specifies a contract, not the implementation
John McCall5d865c322010-08-31 07:33:07 +00001431 if (HasThisReturn(CGF.CurGD))
Eli Friedman9fbeba02012-02-11 02:57:39 +00001432 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
John McCall5d865c322010-08-31 07:33:07 +00001433}
1434
George Burgess IVf203dbf2017-02-22 20:28:02 +00001435CGCXXABI::AddedStructorArgs ItaniumCXXABI::addImplicitConstructorArgs(
Reid Kleckner89077a12013-12-17 19:46:40 +00001436 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1437 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
1438 if (!NeedsVTTParameter(GlobalDecl(D, Type)))
George Burgess IVf203dbf2017-02-22 20:28:02 +00001439 return AddedStructorArgs{};
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001440
Reid Kleckner89077a12013-12-17 19:46:40 +00001441 // Insert the implicit 'vtt' argument as the second argument.
1442 llvm::Value *VTT =
1443 CGF.GetVTTParameter(GlobalDecl(D, Type), ForVirtualBase, Delegating);
1444 QualType VTTTy = getContext().getPointerType(getContext().VoidPtrTy);
1445 Args.insert(Args.begin() + 1,
1446 CallArg(RValue::get(VTT), VTTTy, /*needscopy=*/false));
George Burgess IVf203dbf2017-02-22 20:28:02 +00001447 return AddedStructorArgs::prefix(1); // Added one arg.
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001448}
1449
1450void ItaniumCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1451 const CXXDestructorDecl *DD,
1452 CXXDtorType Type, bool ForVirtualBase,
John McCall7f416cc2015-09-08 08:05:57 +00001453 bool Delegating, Address This) {
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001454 GlobalDecl GD(DD, Type);
1455 llvm::Value *VTT = CGF.GetVTTParameter(GD, ForVirtualBase, Delegating);
1456 QualType VTTTy = getContext().getPointerType(getContext().VoidPtrTy);
1457
John McCallb92ab1a2016-10-26 23:46:34 +00001458 CGCallee Callee;
1459 if (getContext().getLangOpts().AppleKext &&
1460 Type != Dtor_Base && DD->isVirtual())
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001461 Callee = CGF.BuildAppleKextVirtualDestructorCall(DD, Type, DD->getParent());
John McCallb92ab1a2016-10-26 23:46:34 +00001462 else
1463 Callee =
1464 CGCallee::forDirect(CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type)),
1465 DD);
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001466
John McCall7f416cc2015-09-08 08:05:57 +00001467 CGF.EmitCXXMemberOrOperatorCall(DD, Callee, ReturnValueSlot(),
Richard Smith762672a2016-09-28 19:09:10 +00001468 This.getPointer(), VTT, VTTTy,
1469 nullptr, nullptr);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001470}
1471
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001472void ItaniumCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1473 const CXXRecordDecl *RD) {
1474 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, CharUnits());
1475 if (VTable->hasInitializer())
1476 return;
1477
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001478 ItaniumVTableContext &VTContext = CGM.getItaniumVTableContext();
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001479 const VTableLayout &VTLayout = VTContext.getVTableLayout(RD);
1480 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
David Majnemerd905da42014-07-01 20:30:31 +00001481 llvm::Constant *RTTI =
1482 CGM.GetAddrOfRTTIDescriptor(CGM.getContext().getTagDeclType(RD));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001483
1484 // Create and set the initializer.
John McCall9c6cb762016-11-28 22:18:33 +00001485 ConstantInitBuilder Builder(CGM);
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001486 auto Components = Builder.beginStruct();
John McCall9c6cb762016-11-28 22:18:33 +00001487 CGVT.createVTableInitializer(Components, VTLayout, RTTI);
1488 Components.finishAndSetAsInitializer(VTable);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001489
1490 // Set the correct linkage.
1491 VTable->setLinkage(Linkage);
1492
NAKAMURA Takumic7da6da2015-05-09 21:10:07 +00001493 if (CGM.supportsCOMDAT() && VTable->isWeakForLinker())
1494 VTable->setComdat(CGM.getModule().getOrInsertComdat(VTable->getName()));
Rafael Espindolacb92c192015-01-15 23:18:01 +00001495
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001496 // Set the right visibility.
John McCall8f80a612014-02-08 00:41:16 +00001497 CGM.setGlobalVisibility(VTable, RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001498
Benjamin Kramer5d34a2b2014-09-10 12:50:59 +00001499 // Use pointer alignment for the vtable. Otherwise we would align them based
1500 // on the size of the initializer which doesn't make sense as only single
1501 // values are read.
1502 unsigned PAlign = CGM.getTarget().getPointerAlign(0);
1503 VTable->setAlignment(getContext().toCharUnitsFromBits(PAlign).getQuantity());
1504
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001505 // If this is the magic class __cxxabiv1::__fundamental_type_info,
1506 // we will emit the typeinfo for the fundamental types. This is the
1507 // same behaviour as GCC.
1508 const DeclContext *DC = RD->getDeclContext();
1509 if (RD->getIdentifier() &&
1510 RD->getIdentifier()->isStr("__fundamental_type_info") &&
1511 isa<NamespaceDecl>(DC) && cast<NamespaceDecl>(DC)->getIdentifier() &&
1512 cast<NamespaceDecl>(DC)->getIdentifier()->isStr("__cxxabiv1") &&
1513 DC->getParent()->isTranslationUnit())
Saleem Abdulrasool8dbaf5c2016-09-30 23:11:05 +00001514 EmitFundamentalRTTIDescriptors(RD->hasAttr<DLLExportAttr>());
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001515
Evgeniy Stepanov93987df2016-01-23 01:20:18 +00001516 if (!VTable->isDeclarationForLinker())
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001517 CGM.EmitVTableTypeMetadata(VTable, VTLayout);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001518}
1519
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001520bool ItaniumCXXABI::isVirtualOffsetNeededForVTableField(
1521 CodeGenFunction &CGF, CodeGenFunction::VPtr Vptr) {
1522 if (Vptr.NearestVBase == nullptr)
1523 return false;
1524 return NeedsVTTParameter(CGF.CurGD);
Piotr Padlewski255652e2015-09-09 22:20:28 +00001525}
1526
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001527llvm::Value *ItaniumCXXABI::getVTableAddressPointInStructor(
1528 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
1529 const CXXRecordDecl *NearestVBase) {
1530
1531 if ((Base.getBase()->getNumVBases() || NearestVBase != nullptr) &&
1532 NeedsVTTParameter(CGF.CurGD)) {
1533 return getVTableAddressPointInStructorWithVTT(CGF, VTableClass, Base,
1534 NearestVBase);
1535 }
1536 return getVTableAddressPoint(Base, VTableClass);
1537}
1538
1539llvm::Constant *
1540ItaniumCXXABI::getVTableAddressPoint(BaseSubobject Base,
1541 const CXXRecordDecl *VTableClass) {
1542 llvm::GlobalValue *VTable = getAddrOfVTable(VTableClass, CharUnits());
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001543
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001544 // Find the appropriate vtable within the vtable group, and the address point
1545 // within that vtable.
1546 VTableLayout::AddressPointLocation AddressPoint =
1547 CGM.getItaniumVTableContext()
1548 .getVTableLayout(VTableClass)
1549 .getAddressPoint(Base);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001550 llvm::Value *Indices[] = {
Peter Collingbourne4e6a5402016-03-14 19:07:10 +00001551 llvm::ConstantInt::get(CGM.Int32Ty, 0),
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001552 llvm::ConstantInt::get(CGM.Int32Ty, AddressPoint.VTableIndex),
1553 llvm::ConstantInt::get(CGM.Int32Ty, AddressPoint.AddressPointIndex),
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001554 };
1555
Peter Collingbourne25a2b702016-12-13 20:50:44 +00001556 return llvm::ConstantExpr::getGetElementPtr(VTable->getValueType(), VTable,
1557 Indices, /*InBounds=*/true,
1558 /*InRangeIndex=*/1);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001559}
1560
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001561llvm::Value *ItaniumCXXABI::getVTableAddressPointInStructorWithVTT(
1562 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
1563 const CXXRecordDecl *NearestVBase) {
1564 assert((Base.getBase()->getNumVBases() || NearestVBase != nullptr) &&
1565 NeedsVTTParameter(CGF.CurGD) && "This class doesn't have VTT");
1566
1567 // Get the secondary vpointer index.
1568 uint64_t VirtualPointerIndex =
1569 CGM.getVTables().getSecondaryVirtualPointerIndex(VTableClass, Base);
1570
1571 /// Load the VTT.
1572 llvm::Value *VTT = CGF.LoadCXXVTT();
1573 if (VirtualPointerIndex)
1574 VTT = CGF.Builder.CreateConstInBoundsGEP1_64(VTT, VirtualPointerIndex);
1575
1576 // And load the address point from the VTT.
1577 return CGF.Builder.CreateAlignedLoad(VTT, CGF.getPointerAlign());
1578}
1579
1580llvm::Constant *ItaniumCXXABI::getVTableAddressPointForConstExpr(
1581 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1582 return getVTableAddressPoint(Base, VTableClass);
1583}
1584
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001585llvm::GlobalVariable *ItaniumCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1586 CharUnits VPtrOffset) {
1587 assert(VPtrOffset.isZero() && "Itanium ABI only supports zero vptr offsets");
1588
1589 llvm::GlobalVariable *&VTable = VTables[RD];
1590 if (VTable)
1591 return VTable;
1592
Eric Christopherd160c502016-01-29 01:35:53 +00001593 // Queue up this vtable for possible deferred emission.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001594 CGM.addDeferredVTable(RD);
1595
Yaron Kerene46f7ed2015-07-29 14:21:47 +00001596 SmallString<256> Name;
1597 llvm::raw_svector_ostream Out(Name);
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001598 getMangleContext().mangleCXXVTable(RD, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001599
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001600 const VTableLayout &VTLayout =
1601 CGM.getItaniumVTableContext().getVTableLayout(RD);
1602 llvm::Type *VTableType = CGM.getVTables().getVTableType(VTLayout);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001603
1604 VTable = CGM.CreateOrReplaceCXXRuntimeVariable(
Peter Collingbourne2849c4e2016-12-13 20:40:39 +00001605 Name, VTableType, llvm::GlobalValue::ExternalLinkage);
Peter Collingbournebcf909d2016-06-14 21:02:05 +00001606 VTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Hans Wennborgda24e9c2014-06-02 23:13:03 +00001607
1608 if (RD->hasAttr<DLLImportAttr>())
1609 VTable->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1610 else if (RD->hasAttr<DLLExportAttr>())
1611 VTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1612
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001613 return VTable;
1614}
1615
John McCallb92ab1a2016-10-26 23:46:34 +00001616CGCallee ItaniumCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1617 GlobalDecl GD,
1618 Address This,
1619 llvm::Type *Ty,
1620 SourceLocation Loc) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001621 GD = GD.getCanonicalDecl();
1622 Ty = Ty->getPointerTo()->getPointerTo();
Piotr Padlewski4b1ac722015-09-15 21:46:55 +00001623 auto *MethodDecl = cast<CXXMethodDecl>(GD.getDecl());
1624 llvm::Value *VTable = CGF.GetVTablePtr(This, Ty, MethodDecl->getParent());
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001625
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001626 uint64_t VTableIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(GD);
John McCallb92ab1a2016-10-26 23:46:34 +00001627 llvm::Value *VFunc;
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001628 if (CGF.ShouldEmitVTableTypeCheckedLoad(MethodDecl->getParent())) {
John McCallb92ab1a2016-10-26 23:46:34 +00001629 VFunc = CGF.EmitVTableTypeCheckedLoad(
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001630 MethodDecl->getParent(), VTable,
1631 VTableIndex * CGM.getContext().getTargetInfo().getPointerWidth(0) / 8);
1632 } else {
1633 CGF.EmitTypeMetadataCodeForVCall(MethodDecl->getParent(), VTable, Loc);
1634
1635 llvm::Value *VFuncPtr =
1636 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, VTableIndex, "vfn");
Piotr Padlewski77cc9622016-10-29 15:28:30 +00001637 auto *VFuncLoad =
1638 CGF.Builder.CreateAlignedLoad(VFuncPtr, CGF.getPointerAlign());
1639
1640 // Add !invariant.load md to virtual function load to indicate that
1641 // function didn't change inside vtable.
1642 // It's safe to add it without -fstrict-vtable-pointers, but it would not
1643 // help in devirtualization because it will only matter if we will have 2
1644 // the same virtual function loads from the same vtable load, which won't
1645 // happen without enabled devirtualization with -fstrict-vtable-pointers.
1646 if (CGM.getCodeGenOpts().OptimizationLevel > 0 &&
1647 CGM.getCodeGenOpts().StrictVTablePointers)
1648 VFuncLoad->setMetadata(
1649 llvm::LLVMContext::MD_invariant_load,
1650 llvm::MDNode::get(CGM.getLLVMContext(),
1651 llvm::ArrayRef<llvm::Metadata *>()));
1652 VFunc = VFuncLoad;
Peter Collingbourne0ca03632016-06-25 00:24:06 +00001653 }
John McCallb92ab1a2016-10-26 23:46:34 +00001654
1655 CGCallee Callee(MethodDecl, VFunc);
1656 return Callee;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001657}
1658
David Majnemer0c0b6d92014-10-31 20:09:12 +00001659llvm::Value *ItaniumCXXABI::EmitVirtualDestructorCall(
1660 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
John McCall7f416cc2015-09-08 08:05:57 +00001661 Address This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001662 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001663 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1664
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001665 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1666 Dtor, getFromDtorType(DtorType));
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001667 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
John McCallb92ab1a2016-10-26 23:46:34 +00001668 CGCallee Callee =
Peter Collingbourne6708c4a2015-06-19 01:51:54 +00001669 getVirtualFunctionPointer(CGF, GlobalDecl(Dtor, DtorType), This, Ty,
1670 CE ? CE->getLocStart() : SourceLocation());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001671
John McCall7f416cc2015-09-08 08:05:57 +00001672 CGF.EmitCXXMemberOrOperatorCall(Dtor, Callee, ReturnValueSlot(),
1673 This.getPointer(), /*ImplicitParam=*/nullptr,
Richard Smith762672a2016-09-28 19:09:10 +00001674 QualType(), CE, nullptr);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001675 return nullptr;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001676}
1677
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001678void ItaniumCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001679 CodeGenVTables &VTables = CGM.getVTables();
1680 llvm::GlobalVariable *VTT = VTables.GetAddrOfVTT(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001681 VTables.EmitVTTDefinition(VTT, CGM.getVTableLinkage(RD), RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001682}
1683
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001684bool ItaniumCXXABI::canSpeculativelyEmitVTable(const CXXRecordDecl *RD) const {
Piotr Padlewskia68a7872015-07-24 04:04:49 +00001685 // We don't emit available_externally vtables if we are in -fapple-kext mode
1686 // because kext mode does not permit devirtualization.
1687 if (CGM.getLangOpts().AppleKext)
1688 return false;
1689
Piotr Padlewskid679d7e2015-09-15 00:37:06 +00001690 // If we don't have any inline virtual functions, and if vtable is not hidden,
Piotr Padlewskia68a7872015-07-24 04:04:49 +00001691 // then we are safe to emit available_externally copy of vtable.
1692 // FIXME we can still emit a copy of the vtable if we
1693 // can emit definition of the inline functions.
Piotr Padlewskia587ca52016-12-28 18:26:08 +00001694 return !hasAnyVirtualInlineFunction(RD) && !isVTableHidden(RD);
Piotr Padlewskia68a7872015-07-24 04:04:49 +00001695}
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001696static llvm::Value *performTypeAdjustment(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001697 Address InitialPtr,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001698 int64_t NonVirtualAdjustment,
1699 int64_t VirtualAdjustment,
1700 bool IsReturnAdjustment) {
1701 if (!NonVirtualAdjustment && !VirtualAdjustment)
John McCall7f416cc2015-09-08 08:05:57 +00001702 return InitialPtr.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001703
John McCall7f416cc2015-09-08 08:05:57 +00001704 Address V = CGF.Builder.CreateElementBitCast(InitialPtr, CGF.Int8Ty);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001705
John McCall7f416cc2015-09-08 08:05:57 +00001706 // In a base-to-derived cast, the non-virtual adjustment is applied first.
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001707 if (NonVirtualAdjustment && !IsReturnAdjustment) {
John McCall7f416cc2015-09-08 08:05:57 +00001708 V = CGF.Builder.CreateConstInBoundsByteGEP(V,
1709 CharUnits::fromQuantity(NonVirtualAdjustment));
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001710 }
1711
John McCall7f416cc2015-09-08 08:05:57 +00001712 // Perform the virtual adjustment if we have one.
1713 llvm::Value *ResultPtr;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001714 if (VirtualAdjustment) {
1715 llvm::Type *PtrDiffTy =
1716 CGF.ConvertType(CGF.getContext().getPointerDiffType());
1717
John McCall7f416cc2015-09-08 08:05:57 +00001718 Address VTablePtrPtr = CGF.Builder.CreateElementBitCast(V, CGF.Int8PtrTy);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001719 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr);
1720
1721 llvm::Value *OffsetPtr =
1722 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment);
1723
1724 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo());
1725
1726 // Load the adjustment offset from the vtable.
John McCall7f416cc2015-09-08 08:05:57 +00001727 llvm::Value *Offset =
1728 CGF.Builder.CreateAlignedLoad(OffsetPtr, CGF.getPointerAlign());
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001729
1730 // Adjust our pointer.
John McCall7f416cc2015-09-08 08:05:57 +00001731 ResultPtr = CGF.Builder.CreateInBoundsGEP(V.getPointer(), Offset);
1732 } else {
1733 ResultPtr = V.getPointer();
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001734 }
1735
John McCall7f416cc2015-09-08 08:05:57 +00001736 // In a derived-to-base conversion, the non-virtual adjustment is
1737 // applied second.
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001738 if (NonVirtualAdjustment && IsReturnAdjustment) {
John McCall7f416cc2015-09-08 08:05:57 +00001739 ResultPtr = CGF.Builder.CreateConstInBoundsGEP1_64(ResultPtr,
1740 NonVirtualAdjustment);
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001741 }
1742
1743 // Cast back to the original type.
John McCall7f416cc2015-09-08 08:05:57 +00001744 return CGF.Builder.CreateBitCast(ResultPtr, InitialPtr.getType());
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001745}
1746
1747llvm::Value *ItaniumCXXABI::performThisAdjustment(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001748 Address This,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001749 const ThisAdjustment &TA) {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00001750 return performTypeAdjustment(CGF, This, TA.NonVirtual,
1751 TA.Virtual.Itanium.VCallOffsetOffset,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001752 /*IsReturnAdjustment=*/false);
1753}
1754
1755llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +00001756ItaniumCXXABI::performReturnAdjustment(CodeGenFunction &CGF, Address Ret,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001757 const ReturnAdjustment &RA) {
1758 return performTypeAdjustment(CGF, Ret, RA.NonVirtual,
1759 RA.Virtual.Itanium.VBaseOffsetOffset,
1760 /*IsReturnAdjustment=*/true);
1761}
1762
John McCall5d865c322010-08-31 07:33:07 +00001763void ARMCXXABI::EmitReturnFromThunk(CodeGenFunction &CGF,
1764 RValue RV, QualType ResultType) {
1765 if (!isa<CXXDestructorDecl>(CGF.CurGD.getDecl()))
1766 return ItaniumCXXABI::EmitReturnFromThunk(CGF, RV, ResultType);
1767
1768 // Destructor thunks in the ARM ABI have indeterminate results.
John McCall7f416cc2015-09-08 08:05:57 +00001769 llvm::Type *T = CGF.ReturnValue.getElementType();
John McCall5d865c322010-08-31 07:33:07 +00001770 RValue Undef = RValue::get(llvm::UndefValue::get(T));
1771 return ItaniumCXXABI::EmitReturnFromThunk(CGF, Undef, ResultType);
1772}
John McCall8ed55a52010-09-02 09:58:18 +00001773
1774/************************** Array allocation cookies **************************/
1775
John McCallb91cd662012-05-01 05:23:51 +00001776CharUnits ItaniumCXXABI::getArrayCookieSizeImpl(QualType elementType) {
1777 // The array cookie is a size_t; pad that up to the element alignment.
1778 // The cookie is actually right-justified in that space.
1779 return std::max(CharUnits::fromQuantity(CGM.SizeSizeInBytes),
1780 CGM.getContext().getTypeAlignInChars(elementType));
John McCall8ed55a52010-09-02 09:58:18 +00001781}
1782
John McCall7f416cc2015-09-08 08:05:57 +00001783Address ItaniumCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
1784 Address NewPtr,
1785 llvm::Value *NumElements,
1786 const CXXNewExpr *expr,
1787 QualType ElementType) {
John McCallb91cd662012-05-01 05:23:51 +00001788 assert(requiresArrayCookie(expr));
John McCall8ed55a52010-09-02 09:58:18 +00001789
John McCall7f416cc2015-09-08 08:05:57 +00001790 unsigned AS = NewPtr.getAddressSpace();
John McCall8ed55a52010-09-02 09:58:18 +00001791
John McCall9bca9232010-09-02 10:25:57 +00001792 ASTContext &Ctx = getContext();
John McCall7f416cc2015-09-08 08:05:57 +00001793 CharUnits SizeSize = CGF.getSizeSize();
John McCall8ed55a52010-09-02 09:58:18 +00001794
1795 // The size of the cookie.
1796 CharUnits CookieSize =
1797 std::max(SizeSize, Ctx.getTypeAlignInChars(ElementType));
John McCallb91cd662012-05-01 05:23:51 +00001798 assert(CookieSize == getArrayCookieSizeImpl(ElementType));
John McCall8ed55a52010-09-02 09:58:18 +00001799
1800 // Compute an offset to the cookie.
John McCall7f416cc2015-09-08 08:05:57 +00001801 Address CookiePtr = NewPtr;
John McCall8ed55a52010-09-02 09:58:18 +00001802 CharUnits CookieOffset = CookieSize - SizeSize;
1803 if (!CookieOffset.isZero())
John McCall7f416cc2015-09-08 08:05:57 +00001804 CookiePtr = CGF.Builder.CreateConstInBoundsByteGEP(CookiePtr, CookieOffset);
John McCall8ed55a52010-09-02 09:58:18 +00001805
1806 // Write the number of elements into the appropriate slot.
John McCall7f416cc2015-09-08 08:05:57 +00001807 Address NumElementsPtr =
1808 CGF.Builder.CreateElementBitCast(CookiePtr, CGF.SizeTy);
Kostya Serebryany4ee69042014-08-26 02:29:59 +00001809 llvm::Instruction *SI = CGF.Builder.CreateStore(NumElements, NumElementsPtr);
John McCall7f416cc2015-09-08 08:05:57 +00001810
1811 // Handle the array cookie specially in ASan.
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001812 if (CGM.getLangOpts().Sanitize.has(SanitizerKind::Address) && AS == 0 &&
Kostya Serebryany4ee69042014-08-26 02:29:59 +00001813 expr->getOperatorNew()->isReplaceableGlobalAllocationFunction()) {
Kostya Serebryany4a9187a2014-08-29 01:01:32 +00001814 // The store to the CookiePtr does not need to be instrumented.
Kostya Serebryany4ee69042014-08-26 02:29:59 +00001815 CGM.getSanitizerMetadata()->disableSanitizerForInstruction(SI);
1816 llvm::FunctionType *FTy =
John McCall7f416cc2015-09-08 08:05:57 +00001817 llvm::FunctionType::get(CGM.VoidTy, NumElementsPtr.getType(), false);
Kostya Serebryany4ee69042014-08-26 02:29:59 +00001818 llvm::Constant *F =
1819 CGM.CreateRuntimeFunction(FTy, "__asan_poison_cxx_array_cookie");
John McCall7f416cc2015-09-08 08:05:57 +00001820 CGF.Builder.CreateCall(F, NumElementsPtr.getPointer());
Kostya Serebryany4ee69042014-08-26 02:29:59 +00001821 }
John McCall8ed55a52010-09-02 09:58:18 +00001822
1823 // Finally, compute a pointer to the actual data buffer by skipping
1824 // over the cookie completely.
John McCall7f416cc2015-09-08 08:05:57 +00001825 return CGF.Builder.CreateConstInBoundsByteGEP(NewPtr, CookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001826}
1827
John McCallb91cd662012-05-01 05:23:51 +00001828llvm::Value *ItaniumCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001829 Address allocPtr,
John McCallb91cd662012-05-01 05:23:51 +00001830 CharUnits cookieSize) {
1831 // The element size is right-justified in the cookie.
John McCall7f416cc2015-09-08 08:05:57 +00001832 Address numElementsPtr = allocPtr;
1833 CharUnits numElementsOffset = cookieSize - CGF.getSizeSize();
John McCallb91cd662012-05-01 05:23:51 +00001834 if (!numElementsOffset.isZero())
1835 numElementsPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001836 CGF.Builder.CreateConstInBoundsByteGEP(numElementsPtr, numElementsOffset);
John McCall8ed55a52010-09-02 09:58:18 +00001837
John McCall7f416cc2015-09-08 08:05:57 +00001838 unsigned AS = allocPtr.getAddressSpace();
1839 numElementsPtr = CGF.Builder.CreateElementBitCast(numElementsPtr, CGF.SizeTy);
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001840 if (!CGM.getLangOpts().Sanitize.has(SanitizerKind::Address) || AS != 0)
Kostya Serebryany4a9187a2014-08-29 01:01:32 +00001841 return CGF.Builder.CreateLoad(numElementsPtr);
1842 // In asan mode emit a function call instead of a regular load and let the
1843 // run-time deal with it: if the shadow is properly poisoned return the
1844 // cookie, otherwise return 0 to avoid an infinite loop calling DTORs.
1845 // We can't simply ignore this load using nosanitize metadata because
1846 // the metadata may be lost.
1847 llvm::FunctionType *FTy =
1848 llvm::FunctionType::get(CGF.SizeTy, CGF.SizeTy->getPointerTo(0), false);
1849 llvm::Constant *F =
1850 CGM.CreateRuntimeFunction(FTy, "__asan_load_cxx_array_cookie");
John McCall7f416cc2015-09-08 08:05:57 +00001851 return CGF.Builder.CreateCall(F, numElementsPtr.getPointer());
John McCall8ed55a52010-09-02 09:58:18 +00001852}
1853
John McCallb91cd662012-05-01 05:23:51 +00001854CharUnits ARMCXXABI::getArrayCookieSizeImpl(QualType elementType) {
John McCallc19c7062013-01-25 23:36:19 +00001855 // ARM says that the cookie is always:
John McCall8ed55a52010-09-02 09:58:18 +00001856 // struct array_cookie {
1857 // std::size_t element_size; // element_size != 0
1858 // std::size_t element_count;
1859 // };
John McCallc19c7062013-01-25 23:36:19 +00001860 // But the base ABI doesn't give anything an alignment greater than
1861 // 8, so we can dismiss this as typical ABI-author blindness to
1862 // actual language complexity and round up to the element alignment.
1863 return std::max(CharUnits::fromQuantity(2 * CGM.SizeSizeInBytes),
1864 CGM.getContext().getTypeAlignInChars(elementType));
John McCall8ed55a52010-09-02 09:58:18 +00001865}
1866
John McCall7f416cc2015-09-08 08:05:57 +00001867Address ARMCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
1868 Address newPtr,
1869 llvm::Value *numElements,
1870 const CXXNewExpr *expr,
1871 QualType elementType) {
John McCallb91cd662012-05-01 05:23:51 +00001872 assert(requiresArrayCookie(expr));
John McCall8ed55a52010-09-02 09:58:18 +00001873
John McCall8ed55a52010-09-02 09:58:18 +00001874 // The cookie is always at the start of the buffer.
John McCall7f416cc2015-09-08 08:05:57 +00001875 Address cookie = newPtr;
John McCall8ed55a52010-09-02 09:58:18 +00001876
1877 // The first element is the element size.
John McCall7f416cc2015-09-08 08:05:57 +00001878 cookie = CGF.Builder.CreateElementBitCast(cookie, CGF.SizeTy);
John McCallc19c7062013-01-25 23:36:19 +00001879 llvm::Value *elementSize = llvm::ConstantInt::get(CGF.SizeTy,
1880 getContext().getTypeSizeInChars(elementType).getQuantity());
1881 CGF.Builder.CreateStore(elementSize, cookie);
John McCall8ed55a52010-09-02 09:58:18 +00001882
1883 // The second element is the element count.
John McCall7f416cc2015-09-08 08:05:57 +00001884 cookie = CGF.Builder.CreateConstInBoundsGEP(cookie, 1, CGF.getSizeSize());
John McCallc19c7062013-01-25 23:36:19 +00001885 CGF.Builder.CreateStore(numElements, cookie);
John McCall8ed55a52010-09-02 09:58:18 +00001886
1887 // Finally, compute a pointer to the actual data buffer by skipping
1888 // over the cookie completely.
John McCallc19c7062013-01-25 23:36:19 +00001889 CharUnits cookieSize = ARMCXXABI::getArrayCookieSizeImpl(elementType);
John McCall7f416cc2015-09-08 08:05:57 +00001890 return CGF.Builder.CreateConstInBoundsByteGEP(newPtr, cookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001891}
1892
John McCallb91cd662012-05-01 05:23:51 +00001893llvm::Value *ARMCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001894 Address allocPtr,
John McCallb91cd662012-05-01 05:23:51 +00001895 CharUnits cookieSize) {
1896 // The number of elements is at offset sizeof(size_t) relative to
1897 // the allocated pointer.
John McCall7f416cc2015-09-08 08:05:57 +00001898 Address numElementsPtr
1899 = CGF.Builder.CreateConstInBoundsByteGEP(allocPtr, CGF.getSizeSize());
John McCall8ed55a52010-09-02 09:58:18 +00001900
John McCall7f416cc2015-09-08 08:05:57 +00001901 numElementsPtr = CGF.Builder.CreateElementBitCast(numElementsPtr, CGF.SizeTy);
John McCallb91cd662012-05-01 05:23:51 +00001902 return CGF.Builder.CreateLoad(numElementsPtr);
John McCall8ed55a52010-09-02 09:58:18 +00001903}
1904
John McCall68ff0372010-09-08 01:44:27 +00001905/*********************** Static local initialization **************************/
1906
1907static llvm::Constant *getGuardAcquireFn(CodeGenModule &CGM,
Chris Lattnera5f58b02011-07-09 17:41:47 +00001908 llvm::PointerType *GuardPtrTy) {
John McCall68ff0372010-09-08 01:44:27 +00001909 // int __cxa_guard_acquire(__guard *guard_object);
Chris Lattner2192fe52011-07-18 04:24:23 +00001910 llvm::FunctionType *FTy =
John McCall68ff0372010-09-08 01:44:27 +00001911 llvm::FunctionType::get(CGM.getTypes().ConvertType(CGM.getContext().IntTy),
Jay Foad5709f7c2011-07-29 13:56:53 +00001912 GuardPtrTy, /*isVarArg=*/false);
Reid Klecknerde864822017-03-21 16:57:30 +00001913 return CGM.CreateRuntimeFunction(
1914 FTy, "__cxa_guard_acquire",
1915 llvm::AttributeList::get(CGM.getLLVMContext(),
1916 llvm::AttributeList::FunctionIndex,
1917 llvm::Attribute::NoUnwind));
John McCall68ff0372010-09-08 01:44:27 +00001918}
1919
1920static llvm::Constant *getGuardReleaseFn(CodeGenModule &CGM,
Chris Lattnera5f58b02011-07-09 17:41:47 +00001921 llvm::PointerType *GuardPtrTy) {
John McCall68ff0372010-09-08 01:44:27 +00001922 // void __cxa_guard_release(__guard *guard_object);
Chris Lattner2192fe52011-07-18 04:24:23 +00001923 llvm::FunctionType *FTy =
Chris Lattnerece04092012-02-07 00:39:47 +00001924 llvm::FunctionType::get(CGM.VoidTy, GuardPtrTy, /*isVarArg=*/false);
Reid Klecknerde864822017-03-21 16:57:30 +00001925 return CGM.CreateRuntimeFunction(
1926 FTy, "__cxa_guard_release",
1927 llvm::AttributeList::get(CGM.getLLVMContext(),
1928 llvm::AttributeList::FunctionIndex,
1929 llvm::Attribute::NoUnwind));
John McCall68ff0372010-09-08 01:44:27 +00001930}
1931
1932static llvm::Constant *getGuardAbortFn(CodeGenModule &CGM,
Chris Lattnera5f58b02011-07-09 17:41:47 +00001933 llvm::PointerType *GuardPtrTy) {
John McCall68ff0372010-09-08 01:44:27 +00001934 // void __cxa_guard_abort(__guard *guard_object);
Chris Lattner2192fe52011-07-18 04:24:23 +00001935 llvm::FunctionType *FTy =
Chris Lattnerece04092012-02-07 00:39:47 +00001936 llvm::FunctionType::get(CGM.VoidTy, GuardPtrTy, /*isVarArg=*/false);
Reid Klecknerde864822017-03-21 16:57:30 +00001937 return CGM.CreateRuntimeFunction(
1938 FTy, "__cxa_guard_abort",
1939 llvm::AttributeList::get(CGM.getLLVMContext(),
1940 llvm::AttributeList::FunctionIndex,
1941 llvm::Attribute::NoUnwind));
John McCall68ff0372010-09-08 01:44:27 +00001942}
1943
1944namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00001945 struct CallGuardAbort final : EHScopeStack::Cleanup {
John McCall68ff0372010-09-08 01:44:27 +00001946 llvm::GlobalVariable *Guard;
Chandler Carruth84537952012-03-30 19:44:53 +00001947 CallGuardAbort(llvm::GlobalVariable *Guard) : Guard(Guard) {}
John McCall68ff0372010-09-08 01:44:27 +00001948
Craig Topper4f12f102014-03-12 06:41:41 +00001949 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall882987f2013-02-28 19:01:20 +00001950 CGF.EmitNounwindRuntimeCall(getGuardAbortFn(CGF.CGM, Guard->getType()),
1951 Guard);
John McCall68ff0372010-09-08 01:44:27 +00001952 }
1953 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001954}
John McCall68ff0372010-09-08 01:44:27 +00001955
1956/// The ARM code here follows the Itanium code closely enough that we
1957/// just special-case it at particular places.
John McCallcdf7ef52010-11-06 09:44:32 +00001958void ItaniumCXXABI::EmitGuardedInit(CodeGenFunction &CGF,
1959 const VarDecl &D,
John McCallb88a5662012-03-30 21:00:39 +00001960 llvm::GlobalVariable *var,
1961 bool shouldPerformInit) {
John McCall68ff0372010-09-08 01:44:27 +00001962 CGBuilderTy &Builder = CGF.Builder;
John McCallcdf7ef52010-11-06 09:44:32 +00001963
Richard Smith62f19e72016-06-25 00:15:56 +00001964 // Inline variables that weren't instantiated from variable templates have
1965 // partially-ordered initialization within their translation unit.
1966 bool NonTemplateInline =
1967 D.isInline() &&
1968 !isTemplateInstantiation(D.getTemplateSpecializationKind());
1969
1970 // We only need to use thread-safe statics for local non-TLS variables and
1971 // inline variables; other global initialization is always single-threaded
1972 // or (through lazy dynamic loading in multiple threads) unsequenced.
Richard Smithdbf74ba2013-04-14 23:01:42 +00001973 bool threadsafe = getContext().getLangOpts().ThreadsafeStatics &&
Richard Smith62f19e72016-06-25 00:15:56 +00001974 (D.isLocalVarDecl() || NonTemplateInline) &&
1975 !D.getTLSKind();
Anders Carlssonc5d3ba12011-04-27 04:37:08 +00001976
Anders Carlssonc5d3ba12011-04-27 04:37:08 +00001977 // If we have a global variable with internal linkage and thread-safe statics
1978 // are disabled, we can just let the guard variable be of type i8.
John McCallb88a5662012-03-30 21:00:39 +00001979 bool useInt8GuardVariable = !threadsafe && var->hasInternalLinkage();
1980
1981 llvm::IntegerType *guardTy;
John McCall7f416cc2015-09-08 08:05:57 +00001982 CharUnits guardAlignment;
John McCall5aa52592011-06-17 07:33:57 +00001983 if (useInt8GuardVariable) {
John McCallb88a5662012-03-30 21:00:39 +00001984 guardTy = CGF.Int8Ty;
John McCall7f416cc2015-09-08 08:05:57 +00001985 guardAlignment = CharUnits::One();
John McCall5aa52592011-06-17 07:33:57 +00001986 } else {
Tim Northover9bb857a2013-01-31 12:13:10 +00001987 // Guard variables are 64 bits in the generic ABI and size width on ARM
1988 // (i.e. 32-bit on AArch32, 64-bit on AArch64).
John McCall7f416cc2015-09-08 08:05:57 +00001989 if (UseARMGuardVarABI) {
1990 guardTy = CGF.SizeTy;
1991 guardAlignment = CGF.getSizeAlign();
1992 } else {
1993 guardTy = CGF.Int64Ty;
1994 guardAlignment = CharUnits::fromQuantity(
1995 CGM.getDataLayout().getABITypeAlignment(guardTy));
1996 }
Anders Carlssonc5d3ba12011-04-27 04:37:08 +00001997 }
John McCallb88a5662012-03-30 21:00:39 +00001998 llvm::PointerType *guardPtrTy = guardTy->getPointerTo();
John McCall68ff0372010-09-08 01:44:27 +00001999
John McCallb88a5662012-03-30 21:00:39 +00002000 // Create the guard variable if we don't already have it (as we
2001 // might if we're double-emitting this function body).
2002 llvm::GlobalVariable *guard = CGM.getStaticLocalDeclGuardAddress(&D);
2003 if (!guard) {
2004 // Mangle the name for the guard.
2005 SmallString<256> guardName;
2006 {
2007 llvm::raw_svector_ostream out(guardName);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002008 getMangleContext().mangleStaticGuardVariable(&D, out);
John McCallb88a5662012-03-30 21:00:39 +00002009 }
John McCall8e7cb6d2010-11-02 21:04:24 +00002010
John McCallb88a5662012-03-30 21:00:39 +00002011 // Create the guard variable with a zero-initializer.
2012 // Just absorb linkage and visibility from the guarded variable.
2013 guard = new llvm::GlobalVariable(CGM.getModule(), guardTy,
2014 false, var->getLinkage(),
2015 llvm::ConstantInt::get(guardTy, 0),
2016 guardName.str());
2017 guard->setVisibility(var->getVisibility());
Richard Smithdbf74ba2013-04-14 23:01:42 +00002018 // If the variable is thread-local, so is its guard variable.
2019 guard->setThreadLocalMode(var->getThreadLocalMode());
John McCall7f416cc2015-09-08 08:05:57 +00002020 guard->setAlignment(guardAlignment.getQuantity());
John McCallb88a5662012-03-30 21:00:39 +00002021
Yaron Keren5bfa1082015-09-03 20:33:29 +00002022 // The ABI says: "It is suggested that it be emitted in the same COMDAT
2023 // group as the associated data object." In practice, this doesn't work for
Dan Gohman839f2152017-01-17 21:46:38 +00002024 // non-ELF and non-Wasm object formats, so only do it for ELF and Wasm.
Rafael Espindola0d4fb982015-01-12 22:13:53 +00002025 llvm::Comdat *C = var->getComdat();
Yaron Keren5bfa1082015-09-03 20:33:29 +00002026 if (!D.isLocalVarDecl() && C &&
Dan Gohman839f2152017-01-17 21:46:38 +00002027 (CGM.getTarget().getTriple().isOSBinFormatELF() ||
2028 CGM.getTarget().getTriple().isOSBinFormatWasm())) {
Rafael Espindola2ae4b632014-09-19 19:43:18 +00002029 guard->setComdat(C);
Richard Smith62f19e72016-06-25 00:15:56 +00002030 // An inline variable's guard function is run from the per-TU
2031 // initialization function, not via a dedicated global ctor function, so
2032 // we can't put it in a comdat.
2033 if (!NonTemplateInline)
2034 CGF.CurFn->setComdat(C);
NAKAMURA Takumic7da6da2015-05-09 21:10:07 +00002035 } else if (CGM.supportsCOMDAT() && guard->isWeakForLinker()) {
2036 guard->setComdat(CGM.getModule().getOrInsertComdat(guard->getName()));
Rafael Espindola2ae4b632014-09-19 19:43:18 +00002037 }
2038
John McCallb88a5662012-03-30 21:00:39 +00002039 CGM.setStaticLocalDeclGuardAddress(&D, guard);
2040 }
John McCall87590e62012-03-30 07:09:50 +00002041
John McCall7f416cc2015-09-08 08:05:57 +00002042 Address guardAddr = Address(guard, guardAlignment);
2043
John McCall68ff0372010-09-08 01:44:27 +00002044 // Test whether the variable has completed initialization.
Justin Bogner0cbb6d82014-04-23 01:50:10 +00002045 //
John McCall68ff0372010-09-08 01:44:27 +00002046 // Itanium C++ ABI 3.3.2:
2047 // The following is pseudo-code showing how these functions can be used:
2048 // if (obj_guard.first_byte == 0) {
2049 // if ( __cxa_guard_acquire (&obj_guard) ) {
2050 // try {
2051 // ... initialize the object ...;
2052 // } catch (...) {
2053 // __cxa_guard_abort (&obj_guard);
2054 // throw;
2055 // }
2056 // ... queue object destructor with __cxa_atexit() ...;
2057 // __cxa_guard_release (&obj_guard);
2058 // }
2059 // }
Tim Northovera2ee4332014-03-29 15:09:45 +00002060
Justin Bogner0cbb6d82014-04-23 01:50:10 +00002061 // Load the first byte of the guard variable.
2062 llvm::LoadInst *LI =
John McCall7f416cc2015-09-08 08:05:57 +00002063 Builder.CreateLoad(Builder.CreateElementBitCast(guardAddr, CGM.Int8Ty));
John McCall68ff0372010-09-08 01:44:27 +00002064
Justin Bogner0cbb6d82014-04-23 01:50:10 +00002065 // Itanium ABI:
2066 // An implementation supporting thread-safety on multiprocessor
2067 // systems must also guarantee that references to the initialized
2068 // object do not occur before the load of the initialization flag.
2069 //
2070 // In LLVM, we do this by marking the load Acquire.
2071 if (threadsafe)
JF Bastien92f4ef12016-04-06 17:26:42 +00002072 LI->setAtomic(llvm::AtomicOrdering::Acquire);
Eli Friedman84d28122011-09-13 22:21:56 +00002073
Justin Bogner0cbb6d82014-04-23 01:50:10 +00002074 // For ARM, we should only check the first bit, rather than the entire byte:
2075 //
2076 // ARM C++ ABI 3.2.3.1:
2077 // To support the potential use of initialization guard variables
2078 // as semaphores that are the target of ARM SWP and LDREX/STREX
2079 // synchronizing instructions we define a static initialization
2080 // guard variable to be a 4-byte aligned, 4-byte word with the
2081 // following inline access protocol.
2082 // #define INITIALIZED 1
2083 // if ((obj_guard & INITIALIZED) != INITIALIZED) {
2084 // if (__cxa_guard_acquire(&obj_guard))
2085 // ...
2086 // }
2087 //
2088 // and similarly for ARM64:
2089 //
2090 // ARM64 C++ ABI 3.2.2:
2091 // This ABI instead only specifies the value bit 0 of the static guard
2092 // variable; all other bits are platform defined. Bit 0 shall be 0 when the
2093 // variable is not initialized and 1 when it is.
2094 llvm::Value *V =
2095 (UseARMGuardVarABI && !useInt8GuardVariable)
2096 ? Builder.CreateAnd(LI, llvm::ConstantInt::get(CGM.Int8Ty, 1))
2097 : LI;
2098 llvm::Value *isInitialized = Builder.CreateIsNull(V, "guard.uninitialized");
John McCall68ff0372010-09-08 01:44:27 +00002099
2100 llvm::BasicBlock *InitCheckBlock = CGF.createBasicBlock("init.check");
2101 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
2102
2103 // Check if the first byte of the guard variable is zero.
John McCallb88a5662012-03-30 21:00:39 +00002104 Builder.CreateCondBr(isInitialized, InitCheckBlock, EndBlock);
John McCall68ff0372010-09-08 01:44:27 +00002105
2106 CGF.EmitBlock(InitCheckBlock);
2107
2108 // Variables used when coping with thread-safe statics and exceptions.
John McCall5aa52592011-06-17 07:33:57 +00002109 if (threadsafe) {
John McCall68ff0372010-09-08 01:44:27 +00002110 // Call __cxa_guard_acquire.
2111 llvm::Value *V
John McCall882987f2013-02-28 19:01:20 +00002112 = CGF.EmitNounwindRuntimeCall(getGuardAcquireFn(CGM, guardPtrTy), guard);
John McCall68ff0372010-09-08 01:44:27 +00002113
2114 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
2115
2116 Builder.CreateCondBr(Builder.CreateIsNotNull(V, "tobool"),
2117 InitBlock, EndBlock);
2118
2119 // Call __cxa_guard_abort along the exceptional edge.
John McCallb88a5662012-03-30 21:00:39 +00002120 CGF.EHStack.pushCleanup<CallGuardAbort>(EHCleanup, guard);
John McCall68ff0372010-09-08 01:44:27 +00002121
2122 CGF.EmitBlock(InitBlock);
2123 }
2124
2125 // Emit the initializer and add a global destructor if appropriate.
John McCallb88a5662012-03-30 21:00:39 +00002126 CGF.EmitCXXGlobalVarDeclInit(D, var, shouldPerformInit);
John McCall68ff0372010-09-08 01:44:27 +00002127
John McCall5aa52592011-06-17 07:33:57 +00002128 if (threadsafe) {
John McCall68ff0372010-09-08 01:44:27 +00002129 // Pop the guard-abort cleanup if we pushed one.
2130 CGF.PopCleanupBlock();
2131
2132 // Call __cxa_guard_release. This cannot throw.
John McCall7f416cc2015-09-08 08:05:57 +00002133 CGF.EmitNounwindRuntimeCall(getGuardReleaseFn(CGM, guardPtrTy),
2134 guardAddr.getPointer());
John McCall68ff0372010-09-08 01:44:27 +00002135 } else {
John McCall7f416cc2015-09-08 08:05:57 +00002136 Builder.CreateStore(llvm::ConstantInt::get(guardTy, 1), guardAddr);
John McCall68ff0372010-09-08 01:44:27 +00002137 }
2138
2139 CGF.EmitBlock(EndBlock);
2140}
John McCallc84ed6a2012-05-01 06:13:13 +00002141
2142/// Register a global destructor using __cxa_atexit.
2143static void emitGlobalDtorWithCXAAtExit(CodeGenFunction &CGF,
2144 llvm::Constant *dtor,
Richard Smithdbf74ba2013-04-14 23:01:42 +00002145 llvm::Constant *addr,
2146 bool TLS) {
Bill Wendling95cae882013-05-02 19:18:03 +00002147 const char *Name = "__cxa_atexit";
2148 if (TLS) {
2149 const llvm::Triple &T = CGF.getTarget().getTriple();
Manman Renf93fff22015-11-11 23:08:18 +00002150 Name = T.isOSDarwin() ? "_tlv_atexit" : "__cxa_thread_atexit";
Bill Wendling95cae882013-05-02 19:18:03 +00002151 }
Richard Smithdbf74ba2013-04-14 23:01:42 +00002152
John McCallc84ed6a2012-05-01 06:13:13 +00002153 // We're assuming that the destructor function is something we can
2154 // reasonably call with the default CC. Go ahead and cast it to the
2155 // right prototype.
2156 llvm::Type *dtorTy =
2157 llvm::FunctionType::get(CGF.VoidTy, CGF.Int8PtrTy, false)->getPointerTo();
2158
2159 // extern "C" int __cxa_atexit(void (*f)(void *), void *p, void *d);
2160 llvm::Type *paramTys[] = { dtorTy, CGF.Int8PtrTy, CGF.Int8PtrTy };
2161 llvm::FunctionType *atexitTy =
2162 llvm::FunctionType::get(CGF.IntTy, paramTys, false);
2163
2164 // Fetch the actual function.
Richard Smithdbf74ba2013-04-14 23:01:42 +00002165 llvm::Constant *atexit = CGF.CGM.CreateRuntimeFunction(atexitTy, Name);
John McCallc84ed6a2012-05-01 06:13:13 +00002166 if (llvm::Function *fn = dyn_cast<llvm::Function>(atexit))
2167 fn->setDoesNotThrow();
2168
2169 // Create a variable that binds the atexit to this shared object.
2170 llvm::Constant *handle =
Reid Kleckner9de92142017-02-13 18:49:21 +00002171 CGF.CGM.CreateRuntimeVariable(CGF.Int8Ty, "__dso_handle");
2172 auto *GV = cast<llvm::GlobalValue>(handle->stripPointerCasts());
2173 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCallc84ed6a2012-05-01 06:13:13 +00002174
2175 llvm::Value *args[] = {
2176 llvm::ConstantExpr::getBitCast(dtor, dtorTy),
2177 llvm::ConstantExpr::getBitCast(addr, CGF.Int8PtrTy),
2178 handle
2179 };
John McCall882987f2013-02-28 19:01:20 +00002180 CGF.EmitNounwindRuntimeCall(atexit, args);
John McCallc84ed6a2012-05-01 06:13:13 +00002181}
2182
2183/// Register a global destructor as best as we know how.
2184void ItaniumCXXABI::registerGlobalDtor(CodeGenFunction &CGF,
Richard Smithdbf74ba2013-04-14 23:01:42 +00002185 const VarDecl &D,
John McCallc84ed6a2012-05-01 06:13:13 +00002186 llvm::Constant *dtor,
2187 llvm::Constant *addr) {
2188 // Use __cxa_atexit if available.
Richard Smithdbf74ba2013-04-14 23:01:42 +00002189 if (CGM.getCodeGenOpts().CXAAtExit)
2190 return emitGlobalDtorWithCXAAtExit(CGF, dtor, addr, D.getTLSKind());
2191
2192 if (D.getTLSKind())
2193 CGM.ErrorUnsupported(&D, "non-trivial TLS destruction");
John McCallc84ed6a2012-05-01 06:13:13 +00002194
2195 // In Apple kexts, we want to add a global destructor entry.
2196 // FIXME: shouldn't this be guarded by some variable?
Richard Smith9c6890a2012-11-01 22:30:59 +00002197 if (CGM.getLangOpts().AppleKext) {
John McCallc84ed6a2012-05-01 06:13:13 +00002198 // Generate a global destructor entry.
2199 return CGM.AddCXXDtorEntry(dtor, addr);
2200 }
2201
David Blaikieebe87e12013-08-27 23:57:18 +00002202 CGF.registerGlobalDtorWithAtExit(D, dtor, addr);
John McCallc84ed6a2012-05-01 06:13:13 +00002203}
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002204
David Majnemer9b21c332014-07-11 20:28:10 +00002205static bool isThreadWrapperReplaceable(const VarDecl *VD,
2206 CodeGen::CodeGenModule &CGM) {
2207 assert(!VD->isStaticLocal() && "static local VarDecls don't need wrappers!");
Manman Renf93fff22015-11-11 23:08:18 +00002208 // Darwin prefers to have references to thread local variables to go through
David Majnemer9b21c332014-07-11 20:28:10 +00002209 // the thread wrapper instead of directly referencing the backing variable.
2210 return VD->getTLSKind() == VarDecl::TLS_Dynamic &&
Manman Renf93fff22015-11-11 23:08:18 +00002211 CGM.getTarget().getTriple().isOSDarwin();
David Majnemer9b21c332014-07-11 20:28:10 +00002212}
2213
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002214/// Get the appropriate linkage for the wrapper function. This is essentially
David Majnemer4632e1e2014-06-27 16:56:27 +00002215/// the weak form of the variable's linkage; every translation unit which needs
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002216/// the wrapper emits a copy, and we want the linker to merge them.
David Majnemer35ab3282014-06-11 04:08:55 +00002217static llvm::GlobalValue::LinkageTypes
2218getThreadLocalWrapperLinkage(const VarDecl *VD, CodeGen::CodeGenModule &CGM) {
2219 llvm::GlobalValue::LinkageTypes VarLinkage =
2220 CGM.getLLVMLinkageVarDefinition(VD, /*isConstant=*/false);
2221
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002222 // For internal linkage variables, we don't need an external or weak wrapper.
2223 if (llvm::GlobalValue::isLocalLinkage(VarLinkage))
2224 return VarLinkage;
David Majnemer35ab3282014-06-11 04:08:55 +00002225
David Majnemer9b21c332014-07-11 20:28:10 +00002226 // If the thread wrapper is replaceable, give it appropriate linkage.
Manman Ren68150262015-11-11 22:42:31 +00002227 if (isThreadWrapperReplaceable(VD, CGM))
2228 if (!llvm::GlobalVariable::isLinkOnceLinkage(VarLinkage) &&
2229 !llvm::GlobalVariable::isWeakODRLinkage(VarLinkage))
2230 return VarLinkage;
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002231 return llvm::GlobalValue::WeakODRLinkage;
2232}
2233
2234llvm::Function *
2235ItaniumCXXABI::getOrCreateThreadLocalWrapper(const VarDecl *VD,
Alexander Musmanf94c3182014-09-26 06:28:25 +00002236 llvm::Value *Val) {
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002237 // Mangle the name for the thread_local wrapper function.
2238 SmallString<256> WrapperName;
2239 {
2240 llvm::raw_svector_ostream Out(WrapperName);
2241 getMangleContext().mangleItaniumThreadLocalWrapper(VD, Out);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002242 }
2243
Akira Hatanaka26907f92016-01-15 03:34:06 +00002244 // FIXME: If VD is a definition, we should regenerate the function attributes
2245 // before returning.
Alexander Musmanf94c3182014-09-26 06:28:25 +00002246 if (llvm::Value *V = CGM.getModule().getNamedValue(WrapperName))
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002247 return cast<llvm::Function>(V);
2248
Akira Hatanaka26907f92016-01-15 03:34:06 +00002249 QualType RetQT = VD->getType();
2250 if (RetQT->isReferenceType())
2251 RetQT = RetQT.getNonReferenceType();
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002252
John McCallc56a8b32016-03-11 04:30:31 +00002253 const CGFunctionInfo &FI = CGM.getTypes().arrangeBuiltinFunctionDeclaration(
2254 getContext().getPointerType(RetQT), FunctionArgList());
Akira Hatanaka26907f92016-01-15 03:34:06 +00002255
2256 llvm::FunctionType *FnTy = CGM.getTypes().GetFunctionType(FI);
David Majnemer35ab3282014-06-11 04:08:55 +00002257 llvm::Function *Wrapper =
2258 llvm::Function::Create(FnTy, getThreadLocalWrapperLinkage(VD, CGM),
2259 WrapperName.str(), &CGM.getModule());
Akira Hatanaka26907f92016-01-15 03:34:06 +00002260
2261 CGM.SetLLVMFunctionAttributes(nullptr, FI, Wrapper);
2262
2263 if (VD->hasDefinition())
2264 CGM.SetLLVMFunctionAttributesForDefinition(nullptr, Wrapper);
2265
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002266 // Always resolve references to the wrapper at link time.
Manman Ren68150262015-11-11 22:42:31 +00002267 if (!Wrapper->hasLocalLinkage() && !(isThreadWrapperReplaceable(VD, CGM) &&
2268 !llvm::GlobalVariable::isLinkOnceLinkage(Wrapper->getLinkage()) &&
2269 !llvm::GlobalVariable::isWeakODRLinkage(Wrapper->getLinkage())))
Duncan P. N. Exon Smith4434d362014-05-07 22:36:11 +00002270 Wrapper->setVisibility(llvm::GlobalValue::HiddenVisibility);
Manman Renb0b3af72015-12-17 00:42:36 +00002271
2272 if (isThreadWrapperReplaceable(VD, CGM)) {
2273 Wrapper->setCallingConv(llvm::CallingConv::CXX_FAST_TLS);
2274 Wrapper->addFnAttr(llvm::Attribute::NoUnwind);
2275 }
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002276 return Wrapper;
2277}
2278
2279void ItaniumCXXABI::EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +00002280 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
2281 ArrayRef<llvm::Function *> CXXThreadLocalInits,
2282 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) {
David Majnemerb3341ea2014-10-05 05:05:40 +00002283 llvm::Function *InitFunc = nullptr;
Richard Smithfbe23692017-01-13 00:43:31 +00002284
2285 // Separate initializers into those with ordered (or partially-ordered)
2286 // initialization and those with unordered initialization.
2287 llvm::SmallVector<llvm::Function *, 8> OrderedInits;
2288 llvm::SmallDenseMap<const VarDecl *, llvm::Function *> UnorderedInits;
2289 for (unsigned I = 0; I != CXXThreadLocalInits.size(); ++I) {
2290 if (isTemplateInstantiation(
2291 CXXThreadLocalInitVars[I]->getTemplateSpecializationKind()))
2292 UnorderedInits[CXXThreadLocalInitVars[I]->getCanonicalDecl()] =
2293 CXXThreadLocalInits[I];
2294 else
2295 OrderedInits.push_back(CXXThreadLocalInits[I]);
2296 }
2297
2298 if (!OrderedInits.empty()) {
David Majnemerb3341ea2014-10-05 05:05:40 +00002299 // Generate a guarded initialization function.
2300 llvm::FunctionType *FTy =
2301 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
Akira Hatanaka7791f1a42015-10-31 01:28:07 +00002302 const CGFunctionInfo &FI = CGM.getTypes().arrangeNullaryFunction();
2303 InitFunc = CGM.CreateGlobalInitOrDestructFunction(FTy, "__tls_init", FI,
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002304 SourceLocation(),
David Majnemerb3341ea2014-10-05 05:05:40 +00002305 /*TLS=*/true);
2306 llvm::GlobalVariable *Guard = new llvm::GlobalVariable(
2307 CGM.getModule(), CGM.Int8Ty, /*isConstant=*/false,
2308 llvm::GlobalVariable::InternalLinkage,
2309 llvm::ConstantInt::get(CGM.Int8Ty, 0), "__tls_guard");
2310 Guard->setThreadLocal(true);
John McCall7f416cc2015-09-08 08:05:57 +00002311
2312 CharUnits GuardAlign = CharUnits::One();
2313 Guard->setAlignment(GuardAlign.getQuantity());
2314
Richard Smithfbe23692017-01-13 00:43:31 +00002315 CodeGenFunction(CGM).GenerateCXXGlobalInitFunc(InitFunc, OrderedInits,
2316 Address(Guard, GuardAlign));
Manman Ren5e5d0462016-03-18 23:35:21 +00002317 // On Darwin platforms, use CXX_FAST_TLS calling convention.
2318 if (CGM.getTarget().getTriple().isOSDarwin()) {
2319 InitFunc->setCallingConv(llvm::CallingConv::CXX_FAST_TLS);
2320 InitFunc->addFnAttr(llvm::Attribute::NoUnwind);
2321 }
David Majnemerb3341ea2014-10-05 05:05:40 +00002322 }
Richard Smithfbe23692017-01-13 00:43:31 +00002323
2324 // Emit thread wrappers.
Richard Smith5a99c492015-12-01 01:10:48 +00002325 for (const VarDecl *VD : CXXThreadLocals) {
2326 llvm::GlobalVariable *Var =
2327 cast<llvm::GlobalVariable>(CGM.GetGlobalValue(CGM.getMangledName(VD)));
Richard Smithfbe23692017-01-13 00:43:31 +00002328 llvm::Function *Wrapper = getOrCreateThreadLocalWrapper(VD, Var);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002329
David Majnemer9b21c332014-07-11 20:28:10 +00002330 // Some targets require that all access to thread local variables go through
2331 // the thread wrapper. This means that we cannot attempt to create a thread
2332 // wrapper or a thread helper.
Richard Smithfbe23692017-01-13 00:43:31 +00002333 if (isThreadWrapperReplaceable(VD, CGM) && !VD->hasDefinition()) {
2334 Wrapper->setLinkage(llvm::Function::ExternalLinkage);
David Majnemer9b21c332014-07-11 20:28:10 +00002335 continue;
Richard Smithfbe23692017-01-13 00:43:31 +00002336 }
David Majnemer9b21c332014-07-11 20:28:10 +00002337
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002338 // Mangle the name for the thread_local initialization function.
2339 SmallString<256> InitFnName;
2340 {
2341 llvm::raw_svector_ostream Out(InitFnName);
2342 getMangleContext().mangleItaniumThreadLocalInit(VD, Out);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002343 }
2344
2345 // If we have a definition for the variable, emit the initialization
2346 // function as an alias to the global Init function (if any). Otherwise,
2347 // produce a declaration of the initialization function.
Craig Topper8a13c412014-05-21 05:09:00 +00002348 llvm::GlobalValue *Init = nullptr;
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002349 bool InitIsInitFunc = false;
2350 if (VD->hasDefinition()) {
2351 InitIsInitFunc = true;
Richard Smithfbe23692017-01-13 00:43:31 +00002352 llvm::Function *InitFuncToUse = InitFunc;
2353 if (isTemplateInstantiation(VD->getTemplateSpecializationKind()))
2354 InitFuncToUse = UnorderedInits.lookup(VD->getCanonicalDecl());
2355 if (InitFuncToUse)
Rafael Espindola234405b2014-05-17 21:30:14 +00002356 Init = llvm::GlobalAlias::create(Var->getLinkage(), InitFnName.str(),
Richard Smithfbe23692017-01-13 00:43:31 +00002357 InitFuncToUse);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002358 } else {
2359 // Emit a weak global function referring to the initialization function.
2360 // This function will not exist if the TU defining the thread_local
2361 // variable in question does not need any dynamic initialization for
2362 // its thread_local variables.
2363 llvm::FunctionType *FnTy = llvm::FunctionType::get(CGM.VoidTy, false);
Richard Smithfbe23692017-01-13 00:43:31 +00002364 Init = llvm::Function::Create(FnTy,
2365 llvm::GlobalVariable::ExternalWeakLinkage,
2366 InitFnName.str(), &CGM.getModule());
John McCallc56a8b32016-03-11 04:30:31 +00002367 const CGFunctionInfo &FI = CGM.getTypes().arrangeNullaryFunction();
Akira Hatanaka26907f92016-01-15 03:34:06 +00002368 CGM.SetLLVMFunctionAttributes(nullptr, FI, cast<llvm::Function>(Init));
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002369 }
2370
2371 if (Init)
2372 Init->setVisibility(Var->getVisibility());
2373
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002374 llvm::LLVMContext &Context = CGM.getModule().getContext();
2375 llvm::BasicBlock *Entry = llvm::BasicBlock::Create(Context, "", Wrapper);
John McCall7f416cc2015-09-08 08:05:57 +00002376 CGBuilderTy Builder(CGM, Entry);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002377 if (InitIsInitFunc) {
Manman Ren5e5d0462016-03-18 23:35:21 +00002378 if (Init) {
2379 llvm::CallInst *CallVal = Builder.CreateCall(Init);
2380 if (isThreadWrapperReplaceable(VD, CGM))
2381 CallVal->setCallingConv(llvm::CallingConv::CXX_FAST_TLS);
2382 }
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002383 } else {
2384 // Don't know whether we have an init function. Call it if it exists.
2385 llvm::Value *Have = Builder.CreateIsNotNull(Init);
2386 llvm::BasicBlock *InitBB = llvm::BasicBlock::Create(Context, "", Wrapper);
2387 llvm::BasicBlock *ExitBB = llvm::BasicBlock::Create(Context, "", Wrapper);
2388 Builder.CreateCondBr(Have, InitBB, ExitBB);
2389
2390 Builder.SetInsertPoint(InitBB);
David Blaikie4ba525b2015-07-14 17:27:39 +00002391 Builder.CreateCall(Init);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002392 Builder.CreateBr(ExitBB);
2393
2394 Builder.SetInsertPoint(ExitBB);
2395 }
2396
2397 // For a reference, the result of the wrapper function is a pointer to
2398 // the referenced object.
2399 llvm::Value *Val = Var;
2400 if (VD->getType()->isReferenceType()) {
John McCall7f416cc2015-09-08 08:05:57 +00002401 CharUnits Align = CGM.getContext().getDeclAlign(VD);
2402 Val = Builder.CreateAlignedLoad(Val, Align);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002403 }
Alexander Musmanf94c3182014-09-26 06:28:25 +00002404 if (Val->getType() != Wrapper->getReturnType())
2405 Val = Builder.CreatePointerBitCastOrAddrSpaceCast(
2406 Val, Wrapper->getReturnType(), "");
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002407 Builder.CreateRet(Val);
2408 }
2409}
2410
Richard Smith0f383742014-03-26 22:48:22 +00002411LValue ItaniumCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2412 const VarDecl *VD,
2413 QualType LValType) {
Richard Smith5a99c492015-12-01 01:10:48 +00002414 llvm::Value *Val = CGF.CGM.GetAddrOfGlobalVar(VD);
Alexander Musmanf94c3182014-09-26 06:28:25 +00002415 llvm::Function *Wrapper = getOrCreateThreadLocalWrapper(VD, Val);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002416
Manman Renb0b3af72015-12-17 00:42:36 +00002417 llvm::CallInst *CallVal = CGF.Builder.CreateCall(Wrapper);
Saleem Abdulrasool4a7130a2016-08-01 21:31:24 +00002418 CallVal->setCallingConv(Wrapper->getCallingConv());
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002419
2420 LValue LV;
2421 if (VD->getType()->isReferenceType())
Manman Renb0b3af72015-12-17 00:42:36 +00002422 LV = CGF.MakeNaturalAlignAddrLValue(CallVal, LValType);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002423 else
Manman Renb0b3af72015-12-17 00:42:36 +00002424 LV = CGF.MakeAddrLValue(CallVal, LValType,
2425 CGF.getContext().getDeclAlign(VD));
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002426 // FIXME: need setObjCGCLValueClass?
2427 return LV;
2428}
Peter Collingbourne66f82e62013-06-28 20:45:28 +00002429
2430/// Return whether the given global decl needs a VTT parameter, which it does
2431/// if it's a base constructor or destructor with virtual bases.
2432bool ItaniumCXXABI::NeedsVTTParameter(GlobalDecl GD) {
2433 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2434
2435 // We don't have any virtual bases, just return early.
2436 if (!MD->getParent()->getNumVBases())
2437 return false;
2438
2439 // Check if we have a base constructor.
2440 if (isa<CXXConstructorDecl>(MD) && GD.getCtorType() == Ctor_Base)
2441 return true;
2442
2443 // Check if we have a base destructor.
2444 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
2445 return true;
2446
2447 return false;
2448}
David Majnemere2cb8d12014-07-07 06:20:47 +00002449
2450namespace {
2451class ItaniumRTTIBuilder {
2452 CodeGenModule &CGM; // Per-module state.
2453 llvm::LLVMContext &VMContext;
2454 const ItaniumCXXABI &CXXABI; // Per-module state.
2455
2456 /// Fields - The fields of the RTTI descriptor currently being built.
2457 SmallVector<llvm::Constant *, 16> Fields;
2458
2459 /// GetAddrOfTypeName - Returns the mangled type name of the given type.
2460 llvm::GlobalVariable *
2461 GetAddrOfTypeName(QualType Ty, llvm::GlobalVariable::LinkageTypes Linkage);
2462
2463 /// GetAddrOfExternalRTTIDescriptor - Returns the constant for the RTTI
2464 /// descriptor of the given type.
2465 llvm::Constant *GetAddrOfExternalRTTIDescriptor(QualType Ty);
2466
2467 /// BuildVTablePointer - Build the vtable pointer for the given type.
2468 void BuildVTablePointer(const Type *Ty);
2469
2470 /// BuildSIClassTypeInfo - Build an abi::__si_class_type_info, used for single
2471 /// inheritance, according to the Itanium C++ ABI, 2.9.5p6b.
2472 void BuildSIClassTypeInfo(const CXXRecordDecl *RD);
2473
2474 /// BuildVMIClassTypeInfo - Build an abi::__vmi_class_type_info, used for
2475 /// classes with bases that do not satisfy the abi::__si_class_type_info
2476 /// constraints, according ti the Itanium C++ ABI, 2.9.5p5c.
2477 void BuildVMIClassTypeInfo(const CXXRecordDecl *RD);
2478
2479 /// BuildPointerTypeInfo - Build an abi::__pointer_type_info struct, used
2480 /// for pointer types.
2481 void BuildPointerTypeInfo(QualType PointeeTy);
2482
2483 /// BuildObjCObjectTypeInfo - Build the appropriate kind of
2484 /// type_info for an object type.
2485 void BuildObjCObjectTypeInfo(const ObjCObjectType *Ty);
2486
2487 /// BuildPointerToMemberTypeInfo - Build an abi::__pointer_to_member_type_info
2488 /// struct, used for member pointer types.
2489 void BuildPointerToMemberTypeInfo(const MemberPointerType *Ty);
2490
2491public:
2492 ItaniumRTTIBuilder(const ItaniumCXXABI &ABI)
2493 : CGM(ABI.CGM), VMContext(CGM.getModule().getContext()), CXXABI(ABI) {}
2494
2495 // Pointer type info flags.
2496 enum {
2497 /// PTI_Const - Type has const qualifier.
2498 PTI_Const = 0x1,
2499
2500 /// PTI_Volatile - Type has volatile qualifier.
2501 PTI_Volatile = 0x2,
2502
2503 /// PTI_Restrict - Type has restrict qualifier.
2504 PTI_Restrict = 0x4,
2505
2506 /// PTI_Incomplete - Type is incomplete.
2507 PTI_Incomplete = 0x8,
2508
2509 /// PTI_ContainingClassIncomplete - Containing class is incomplete.
2510 /// (in pointer to member).
Richard Smitha7d93782016-12-01 03:32:42 +00002511 PTI_ContainingClassIncomplete = 0x10,
2512
2513 /// PTI_TransactionSafe - Pointee is transaction_safe function (C++ TM TS).
2514 //PTI_TransactionSafe = 0x20,
2515
2516 /// PTI_Noexcept - Pointee is noexcept function (C++1z).
2517 PTI_Noexcept = 0x40,
David Majnemere2cb8d12014-07-07 06:20:47 +00002518 };
2519
2520 // VMI type info flags.
2521 enum {
2522 /// VMI_NonDiamondRepeat - Class has non-diamond repeated inheritance.
2523 VMI_NonDiamondRepeat = 0x1,
2524
2525 /// VMI_DiamondShaped - Class is diamond shaped.
2526 VMI_DiamondShaped = 0x2
2527 };
2528
2529 // Base class type info flags.
2530 enum {
2531 /// BCTI_Virtual - Base class is virtual.
2532 BCTI_Virtual = 0x1,
2533
2534 /// BCTI_Public - Base class is public.
2535 BCTI_Public = 0x2
2536 };
2537
2538 /// BuildTypeInfo - Build the RTTI type info struct for the given type.
2539 ///
2540 /// \param Force - true to force the creation of this RTTI value
Saleem Abdulrasool8dbaf5c2016-09-30 23:11:05 +00002541 /// \param DLLExport - true to mark the RTTI value as DLLExport
2542 llvm::Constant *BuildTypeInfo(QualType Ty, bool Force = false,
2543 bool DLLExport = false);
David Majnemere2cb8d12014-07-07 06:20:47 +00002544};
Alexander Kornienkoab9db512015-06-22 23:07:51 +00002545}
David Majnemere2cb8d12014-07-07 06:20:47 +00002546
2547llvm::GlobalVariable *ItaniumRTTIBuilder::GetAddrOfTypeName(
2548 QualType Ty, llvm::GlobalVariable::LinkageTypes Linkage) {
Yaron Kerene46f7ed2015-07-29 14:21:47 +00002549 SmallString<256> Name;
2550 llvm::raw_svector_ostream Out(Name);
David Majnemere2cb8d12014-07-07 06:20:47 +00002551 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(Ty, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00002552
2553 // We know that the mangled name of the type starts at index 4 of the
2554 // mangled name of the typename, so we can just index into it in order to
2555 // get the mangled name of the type.
2556 llvm::Constant *Init = llvm::ConstantDataArray::getString(VMContext,
2557 Name.substr(4));
2558
2559 llvm::GlobalVariable *GV =
2560 CGM.CreateOrReplaceCXXRuntimeVariable(Name, Init->getType(), Linkage);
2561
2562 GV->setInitializer(Init);
2563
2564 return GV;
2565}
2566
2567llvm::Constant *
2568ItaniumRTTIBuilder::GetAddrOfExternalRTTIDescriptor(QualType Ty) {
2569 // Mangle the RTTI name.
Yaron Kerene46f7ed2015-07-29 14:21:47 +00002570 SmallString<256> Name;
2571 llvm::raw_svector_ostream Out(Name);
David Majnemere2cb8d12014-07-07 06:20:47 +00002572 CGM.getCXXABI().getMangleContext().mangleCXXRTTI(Ty, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00002573
2574 // Look for an existing global.
2575 llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name);
2576
2577 if (!GV) {
2578 // Create a new global variable.
2579 GV = new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
2580 /*Constant=*/true,
2581 llvm::GlobalValue::ExternalLinkage, nullptr,
2582 Name);
David Majnemer1fb1a042014-11-07 07:26:38 +00002583 if (const RecordType *RecordTy = dyn_cast<RecordType>(Ty)) {
2584 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RecordTy->getDecl());
2585 if (RD->hasAttr<DLLImportAttr>())
2586 GV->setDLLStorageClass(llvm::GlobalVariable::DLLImportStorageClass);
2587 }
David Majnemere2cb8d12014-07-07 06:20:47 +00002588 }
2589
2590 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
2591}
2592
2593/// TypeInfoIsInStandardLibrary - Given a builtin type, returns whether the type
2594/// info for that type is defined in the standard library.
2595static bool TypeInfoIsInStandardLibrary(const BuiltinType *Ty) {
2596 // Itanium C++ ABI 2.9.2:
2597 // Basic type information (e.g. for "int", "bool", etc.) will be kept in
2598 // the run-time support library. Specifically, the run-time support
2599 // library should contain type_info objects for the types X, X* and
2600 // X const*, for every X in: void, std::nullptr_t, bool, wchar_t, char,
2601 // unsigned char, signed char, short, unsigned short, int, unsigned int,
2602 // long, unsigned long, long long, unsigned long long, float, double,
2603 // long double, char16_t, char32_t, and the IEEE 754r decimal and
2604 // half-precision floating point types.
Richard Smith4a382012016-02-03 01:32:42 +00002605 //
2606 // GCC also emits RTTI for __int128.
2607 // FIXME: We do not emit RTTI information for decimal types here.
2608
2609 // Types added here must also be added to EmitFundamentalRTTIDescriptors.
David Majnemere2cb8d12014-07-07 06:20:47 +00002610 switch (Ty->getKind()) {
2611 case BuiltinType::Void:
2612 case BuiltinType::NullPtr:
2613 case BuiltinType::Bool:
2614 case BuiltinType::WChar_S:
2615 case BuiltinType::WChar_U:
2616 case BuiltinType::Char_U:
2617 case BuiltinType::Char_S:
2618 case BuiltinType::UChar:
2619 case BuiltinType::SChar:
2620 case BuiltinType::Short:
2621 case BuiltinType::UShort:
2622 case BuiltinType::Int:
2623 case BuiltinType::UInt:
2624 case BuiltinType::Long:
2625 case BuiltinType::ULong:
2626 case BuiltinType::LongLong:
2627 case BuiltinType::ULongLong:
2628 case BuiltinType::Half:
2629 case BuiltinType::Float:
2630 case BuiltinType::Double:
2631 case BuiltinType::LongDouble:
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +00002632 case BuiltinType::Float128:
David Majnemere2cb8d12014-07-07 06:20:47 +00002633 case BuiltinType::Char16:
2634 case BuiltinType::Char32:
2635 case BuiltinType::Int128:
2636 case BuiltinType::UInt128:
Richard Smith4a382012016-02-03 01:32:42 +00002637 return true;
2638
Alexey Bader954ba212016-04-08 13:40:33 +00002639#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
2640 case BuiltinType::Id:
Alexey Baderb62f1442016-04-13 08:33:41 +00002641#include "clang/Basic/OpenCLImageTypes.def"
David Majnemere2cb8d12014-07-07 06:20:47 +00002642 case BuiltinType::OCLSampler:
2643 case BuiltinType::OCLEvent:
Alexey Bader9c8453f2015-09-15 11:18:52 +00002644 case BuiltinType::OCLClkEvent:
2645 case BuiltinType::OCLQueue:
Alexey Bader9c8453f2015-09-15 11:18:52 +00002646 case BuiltinType::OCLReserveID:
Richard Smith4a382012016-02-03 01:32:42 +00002647 return false;
David Majnemere2cb8d12014-07-07 06:20:47 +00002648
2649 case BuiltinType::Dependent:
2650#define BUILTIN_TYPE(Id, SingletonId)
2651#define PLACEHOLDER_TYPE(Id, SingletonId) \
2652 case BuiltinType::Id:
2653#include "clang/AST/BuiltinTypes.def"
2654 llvm_unreachable("asking for RRTI for a placeholder type!");
2655
2656 case BuiltinType::ObjCId:
2657 case BuiltinType::ObjCClass:
2658 case BuiltinType::ObjCSel:
2659 llvm_unreachable("FIXME: Objective-C types are unsupported!");
2660 }
2661
2662 llvm_unreachable("Invalid BuiltinType Kind!");
2663}
2664
2665static bool TypeInfoIsInStandardLibrary(const PointerType *PointerTy) {
2666 QualType PointeeTy = PointerTy->getPointeeType();
2667 const BuiltinType *BuiltinTy = dyn_cast<BuiltinType>(PointeeTy);
2668 if (!BuiltinTy)
2669 return false;
2670
2671 // Check the qualifiers.
2672 Qualifiers Quals = PointeeTy.getQualifiers();
2673 Quals.removeConst();
2674
2675 if (!Quals.empty())
2676 return false;
2677
2678 return TypeInfoIsInStandardLibrary(BuiltinTy);
2679}
2680
2681/// IsStandardLibraryRTTIDescriptor - Returns whether the type
2682/// information for the given type exists in the standard library.
2683static bool IsStandardLibraryRTTIDescriptor(QualType Ty) {
2684 // Type info for builtin types is defined in the standard library.
2685 if (const BuiltinType *BuiltinTy = dyn_cast<BuiltinType>(Ty))
2686 return TypeInfoIsInStandardLibrary(BuiltinTy);
2687
2688 // Type info for some pointer types to builtin types is defined in the
2689 // standard library.
2690 if (const PointerType *PointerTy = dyn_cast<PointerType>(Ty))
2691 return TypeInfoIsInStandardLibrary(PointerTy);
2692
2693 return false;
2694}
2695
2696/// ShouldUseExternalRTTIDescriptor - Returns whether the type information for
2697/// the given type exists somewhere else, and that we should not emit the type
2698/// information in this translation unit. Assumes that it is not a
2699/// standard-library type.
2700static bool ShouldUseExternalRTTIDescriptor(CodeGenModule &CGM,
2701 QualType Ty) {
2702 ASTContext &Context = CGM.getContext();
2703
2704 // If RTTI is disabled, assume it might be disabled in the
2705 // translation unit that defines any potential key function, too.
2706 if (!Context.getLangOpts().RTTI) return false;
2707
2708 if (const RecordType *RecordTy = dyn_cast<RecordType>(Ty)) {
2709 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RecordTy->getDecl());
2710 if (!RD->hasDefinition())
2711 return false;
2712
2713 if (!RD->isDynamicClass())
2714 return false;
2715
2716 // FIXME: this may need to be reconsidered if the key function
2717 // changes.
David Majnemerbe9022c2015-08-06 20:56:55 +00002718 // N.B. We must always emit the RTTI data ourselves if there exists a key
2719 // function.
2720 bool IsDLLImport = RD->hasAttr<DLLImportAttr>();
David Majnemer1fb1a042014-11-07 07:26:38 +00002721 if (CGM.getVTables().isVTableExternal(RD))
David Majnemerbe9022c2015-08-06 20:56:55 +00002722 return IsDLLImport ? false : true;
David Majnemer1fb1a042014-11-07 07:26:38 +00002723
David Majnemerbe9022c2015-08-06 20:56:55 +00002724 if (IsDLLImport)
David Majnemer1fb1a042014-11-07 07:26:38 +00002725 return true;
David Majnemere2cb8d12014-07-07 06:20:47 +00002726 }
2727
2728 return false;
2729}
2730
2731/// IsIncompleteClassType - Returns whether the given record type is incomplete.
2732static bool IsIncompleteClassType(const RecordType *RecordTy) {
2733 return !RecordTy->getDecl()->isCompleteDefinition();
2734}
2735
2736/// ContainsIncompleteClassType - Returns whether the given type contains an
2737/// incomplete class type. This is true if
2738///
2739/// * The given type is an incomplete class type.
2740/// * The given type is a pointer type whose pointee type contains an
2741/// incomplete class type.
2742/// * The given type is a member pointer type whose class is an incomplete
2743/// class type.
2744/// * The given type is a member pointer type whoise pointee type contains an
2745/// incomplete class type.
2746/// is an indirect or direct pointer to an incomplete class type.
2747static bool ContainsIncompleteClassType(QualType Ty) {
2748 if (const RecordType *RecordTy = dyn_cast<RecordType>(Ty)) {
2749 if (IsIncompleteClassType(RecordTy))
2750 return true;
2751 }
2752
2753 if (const PointerType *PointerTy = dyn_cast<PointerType>(Ty))
2754 return ContainsIncompleteClassType(PointerTy->getPointeeType());
2755
2756 if (const MemberPointerType *MemberPointerTy =
2757 dyn_cast<MemberPointerType>(Ty)) {
2758 // Check if the class type is incomplete.
2759 const RecordType *ClassType = cast<RecordType>(MemberPointerTy->getClass());
2760 if (IsIncompleteClassType(ClassType))
2761 return true;
2762
2763 return ContainsIncompleteClassType(MemberPointerTy->getPointeeType());
2764 }
2765
2766 return false;
2767}
2768
2769// CanUseSingleInheritance - Return whether the given record decl has a "single,
2770// public, non-virtual base at offset zero (i.e. the derived class is dynamic
2771// iff the base is)", according to Itanium C++ ABI, 2.95p6b.
2772static bool CanUseSingleInheritance(const CXXRecordDecl *RD) {
2773 // Check the number of bases.
2774 if (RD->getNumBases() != 1)
2775 return false;
2776
2777 // Get the base.
2778 CXXRecordDecl::base_class_const_iterator Base = RD->bases_begin();
2779
2780 // Check that the base is not virtual.
2781 if (Base->isVirtual())
2782 return false;
2783
2784 // Check that the base is public.
2785 if (Base->getAccessSpecifier() != AS_public)
2786 return false;
2787
2788 // Check that the class is dynamic iff the base is.
2789 const CXXRecordDecl *BaseDecl =
2790 cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl());
2791 if (!BaseDecl->isEmpty() &&
2792 BaseDecl->isDynamicClass() != RD->isDynamicClass())
2793 return false;
2794
2795 return true;
2796}
2797
2798void ItaniumRTTIBuilder::BuildVTablePointer(const Type *Ty) {
2799 // abi::__class_type_info.
2800 static const char * const ClassTypeInfo =
2801 "_ZTVN10__cxxabiv117__class_type_infoE";
2802 // abi::__si_class_type_info.
2803 static const char * const SIClassTypeInfo =
2804 "_ZTVN10__cxxabiv120__si_class_type_infoE";
2805 // abi::__vmi_class_type_info.
2806 static const char * const VMIClassTypeInfo =
2807 "_ZTVN10__cxxabiv121__vmi_class_type_infoE";
2808
2809 const char *VTableName = nullptr;
2810
2811 switch (Ty->getTypeClass()) {
2812#define TYPE(Class, Base)
2813#define ABSTRACT_TYPE(Class, Base)
2814#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base) case Type::Class:
2815#define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
2816#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2817#include "clang/AST/TypeNodes.def"
2818 llvm_unreachable("Non-canonical and dependent types shouldn't get here");
2819
2820 case Type::LValueReference:
2821 case Type::RValueReference:
2822 llvm_unreachable("References shouldn't get here");
2823
2824 case Type::Auto:
Richard Smith600b5262017-01-26 20:40:47 +00002825 case Type::DeducedTemplateSpecialization:
2826 llvm_unreachable("Undeduced type shouldn't get here");
David Majnemere2cb8d12014-07-07 06:20:47 +00002827
Xiuli Pan9c14e282016-01-09 12:53:17 +00002828 case Type::Pipe:
2829 llvm_unreachable("Pipe types shouldn't get here");
2830
David Majnemere2cb8d12014-07-07 06:20:47 +00002831 case Type::Builtin:
2832 // GCC treats vector and complex types as fundamental types.
2833 case Type::Vector:
2834 case Type::ExtVector:
2835 case Type::Complex:
2836 case Type::Atomic:
2837 // FIXME: GCC treats block pointers as fundamental types?!
2838 case Type::BlockPointer:
2839 // abi::__fundamental_type_info.
2840 VTableName = "_ZTVN10__cxxabiv123__fundamental_type_infoE";
2841 break;
2842
2843 case Type::ConstantArray:
2844 case Type::IncompleteArray:
2845 case Type::VariableArray:
2846 // abi::__array_type_info.
2847 VTableName = "_ZTVN10__cxxabiv117__array_type_infoE";
2848 break;
2849
2850 case Type::FunctionNoProto:
2851 case Type::FunctionProto:
Richard Smithb17d6fa2016-12-01 03:04:07 +00002852 // abi::__function_type_info.
2853 VTableName = "_ZTVN10__cxxabiv120__function_type_infoE";
David Majnemere2cb8d12014-07-07 06:20:47 +00002854 break;
2855
2856 case Type::Enum:
2857 // abi::__enum_type_info.
2858 VTableName = "_ZTVN10__cxxabiv116__enum_type_infoE";
2859 break;
2860
2861 case Type::Record: {
2862 const CXXRecordDecl *RD =
2863 cast<CXXRecordDecl>(cast<RecordType>(Ty)->getDecl());
2864
2865 if (!RD->hasDefinition() || !RD->getNumBases()) {
2866 VTableName = ClassTypeInfo;
2867 } else if (CanUseSingleInheritance(RD)) {
2868 VTableName = SIClassTypeInfo;
2869 } else {
2870 VTableName = VMIClassTypeInfo;
2871 }
2872
2873 break;
2874 }
2875
2876 case Type::ObjCObject:
2877 // Ignore protocol qualifiers.
2878 Ty = cast<ObjCObjectType>(Ty)->getBaseType().getTypePtr();
2879
2880 // Handle id and Class.
2881 if (isa<BuiltinType>(Ty)) {
2882 VTableName = ClassTypeInfo;
2883 break;
2884 }
2885
2886 assert(isa<ObjCInterfaceType>(Ty));
2887 // Fall through.
2888
2889 case Type::ObjCInterface:
2890 if (cast<ObjCInterfaceType>(Ty)->getDecl()->getSuperClass()) {
2891 VTableName = SIClassTypeInfo;
2892 } else {
2893 VTableName = ClassTypeInfo;
2894 }
2895 break;
2896
2897 case Type::ObjCObjectPointer:
2898 case Type::Pointer:
2899 // abi::__pointer_type_info.
2900 VTableName = "_ZTVN10__cxxabiv119__pointer_type_infoE";
2901 break;
2902
2903 case Type::MemberPointer:
2904 // abi::__pointer_to_member_type_info.
2905 VTableName = "_ZTVN10__cxxabiv129__pointer_to_member_type_infoE";
2906 break;
2907 }
2908
2909 llvm::Constant *VTable =
2910 CGM.getModule().getOrInsertGlobal(VTableName, CGM.Int8PtrTy);
2911
2912 llvm::Type *PtrDiffTy =
2913 CGM.getTypes().ConvertType(CGM.getContext().getPointerDiffType());
2914
2915 // The vtable address point is 2.
2916 llvm::Constant *Two = llvm::ConstantInt::get(PtrDiffTy, 2);
David Blaikiee3b172a2015-04-02 18:55:21 +00002917 VTable =
2918 llvm::ConstantExpr::getInBoundsGetElementPtr(CGM.Int8PtrTy, VTable, Two);
David Majnemere2cb8d12014-07-07 06:20:47 +00002919 VTable = llvm::ConstantExpr::getBitCast(VTable, CGM.Int8PtrTy);
2920
2921 Fields.push_back(VTable);
2922}
2923
2924/// \brief Return the linkage that the type info and type info name constants
2925/// should have for the given type.
2926static llvm::GlobalVariable::LinkageTypes getTypeInfoLinkage(CodeGenModule &CGM,
2927 QualType Ty) {
2928 // Itanium C++ ABI 2.9.5p7:
2929 // In addition, it and all of the intermediate abi::__pointer_type_info
2930 // structs in the chain down to the abi::__class_type_info for the
2931 // incomplete class type must be prevented from resolving to the
2932 // corresponding type_info structs for the complete class type, possibly
2933 // by making them local static objects. Finally, a dummy class RTTI is
2934 // generated for the incomplete type that will not resolve to the final
2935 // complete class RTTI (because the latter need not exist), possibly by
2936 // making it a local static object.
2937 if (ContainsIncompleteClassType(Ty))
2938 return llvm::GlobalValue::InternalLinkage;
2939
2940 switch (Ty->getLinkage()) {
2941 case NoLinkage:
2942 case InternalLinkage:
2943 case UniqueExternalLinkage:
2944 return llvm::GlobalValue::InternalLinkage;
2945
2946 case VisibleNoLinkage:
2947 case ExternalLinkage:
Saleem Abdulrasool18820022016-12-02 22:46:18 +00002948 // RTTI is not enabled, which means that this type info struct is going
2949 // to be used for exception handling. Give it linkonce_odr linkage.
2950 if (!CGM.getLangOpts().RTTI)
David Majnemere2cb8d12014-07-07 06:20:47 +00002951 return llvm::GlobalValue::LinkOnceODRLinkage;
David Majnemere2cb8d12014-07-07 06:20:47 +00002952
2953 if (const RecordType *Record = dyn_cast<RecordType>(Ty)) {
2954 const CXXRecordDecl *RD = cast<CXXRecordDecl>(Record->getDecl());
2955 if (RD->hasAttr<WeakAttr>())
2956 return llvm::GlobalValue::WeakODRLinkage;
Saleem Abdulrasool18820022016-12-02 22:46:18 +00002957 if (CGM.getTriple().isWindowsItaniumEnvironment())
2958 if (RD->hasAttr<DLLImportAttr>())
2959 return llvm::GlobalValue::ExternalLinkage;
David Majnemerbe9022c2015-08-06 20:56:55 +00002960 if (RD->isDynamicClass()) {
2961 llvm::GlobalValue::LinkageTypes LT = CGM.getVTableLinkage(RD);
2962 // MinGW won't export the RTTI information when there is a key function.
2963 // Make sure we emit our own copy instead of attempting to dllimport it.
2964 if (RD->hasAttr<DLLImportAttr>() &&
2965 llvm::GlobalValue::isAvailableExternallyLinkage(LT))
2966 LT = llvm::GlobalValue::LinkOnceODRLinkage;
2967 return LT;
2968 }
David Majnemere2cb8d12014-07-07 06:20:47 +00002969 }
2970
2971 return llvm::GlobalValue::LinkOnceODRLinkage;
2972 }
2973
2974 llvm_unreachable("Invalid linkage!");
2975}
2976
Saleem Abdulrasool8dbaf5c2016-09-30 23:11:05 +00002977llvm::Constant *ItaniumRTTIBuilder::BuildTypeInfo(QualType Ty, bool Force,
2978 bool DLLExport) {
David Majnemere2cb8d12014-07-07 06:20:47 +00002979 // We want to operate on the canonical type.
Yaron Kerenebd14262016-03-16 12:14:43 +00002980 Ty = Ty.getCanonicalType();
David Majnemere2cb8d12014-07-07 06:20:47 +00002981
2982 // Check if we've already emitted an RTTI descriptor for this type.
Yaron Kerene46f7ed2015-07-29 14:21:47 +00002983 SmallString<256> Name;
2984 llvm::raw_svector_ostream Out(Name);
David Majnemere2cb8d12014-07-07 06:20:47 +00002985 CGM.getCXXABI().getMangleContext().mangleCXXRTTI(Ty, Out);
David Majnemere2cb8d12014-07-07 06:20:47 +00002986
2987 llvm::GlobalVariable *OldGV = CGM.getModule().getNamedGlobal(Name);
2988 if (OldGV && !OldGV->isDeclaration()) {
2989 assert(!OldGV->hasAvailableExternallyLinkage() &&
2990 "available_externally typeinfos not yet implemented");
2991
2992 return llvm::ConstantExpr::getBitCast(OldGV, CGM.Int8PtrTy);
2993 }
2994
2995 // Check if there is already an external RTTI descriptor for this type.
2996 bool IsStdLib = IsStandardLibraryRTTIDescriptor(Ty);
2997 if (!Force && (IsStdLib || ShouldUseExternalRTTIDescriptor(CGM, Ty)))
2998 return GetAddrOfExternalRTTIDescriptor(Ty);
2999
3000 // Emit the standard library with external linkage.
3001 llvm::GlobalVariable::LinkageTypes Linkage;
3002 if (IsStdLib)
3003 Linkage = llvm::GlobalValue::ExternalLinkage;
3004 else
3005 Linkage = getTypeInfoLinkage(CGM, Ty);
3006
3007 // Add the vtable pointer.
3008 BuildVTablePointer(cast<Type>(Ty));
3009
3010 // And the name.
3011 llvm::GlobalVariable *TypeName = GetAddrOfTypeName(Ty, Linkage);
3012 llvm::Constant *TypeNameField;
3013
3014 // If we're supposed to demote the visibility, be sure to set a flag
3015 // to use a string comparison for type_info comparisons.
3016 ItaniumCXXABI::RTTIUniquenessKind RTTIUniqueness =
3017 CXXABI.classifyRTTIUniqueness(Ty, Linkage);
3018 if (RTTIUniqueness != ItaniumCXXABI::RUK_Unique) {
3019 // The flag is the sign bit, which on ARM64 is defined to be clear
3020 // for global pointers. This is very ARM64-specific.
3021 TypeNameField = llvm::ConstantExpr::getPtrToInt(TypeName, CGM.Int64Ty);
3022 llvm::Constant *flag =
3023 llvm::ConstantInt::get(CGM.Int64Ty, ((uint64_t)1) << 63);
3024 TypeNameField = llvm::ConstantExpr::getAdd(TypeNameField, flag);
3025 TypeNameField =
3026 llvm::ConstantExpr::getIntToPtr(TypeNameField, CGM.Int8PtrTy);
3027 } else {
3028 TypeNameField = llvm::ConstantExpr::getBitCast(TypeName, CGM.Int8PtrTy);
3029 }
3030 Fields.push_back(TypeNameField);
3031
3032 switch (Ty->getTypeClass()) {
3033#define TYPE(Class, Base)
3034#define ABSTRACT_TYPE(Class, Base)
3035#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base) case Type::Class:
3036#define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
3037#define DEPENDENT_TYPE(Class, Base) case Type::Class:
3038#include "clang/AST/TypeNodes.def"
3039 llvm_unreachable("Non-canonical and dependent types shouldn't get here");
3040
3041 // GCC treats vector types as fundamental types.
3042 case Type::Builtin:
3043 case Type::Vector:
3044 case Type::ExtVector:
3045 case Type::Complex:
3046 case Type::BlockPointer:
3047 // Itanium C++ ABI 2.9.5p4:
3048 // abi::__fundamental_type_info adds no data members to std::type_info.
3049 break;
3050
3051 case Type::LValueReference:
3052 case Type::RValueReference:
3053 llvm_unreachable("References shouldn't get here");
3054
3055 case Type::Auto:
Richard Smith600b5262017-01-26 20:40:47 +00003056 case Type::DeducedTemplateSpecialization:
3057 llvm_unreachable("Undeduced type shouldn't get here");
David Majnemere2cb8d12014-07-07 06:20:47 +00003058
Xiuli Pan9c14e282016-01-09 12:53:17 +00003059 case Type::Pipe:
3060 llvm_unreachable("Pipe type shouldn't get here");
3061
David Majnemere2cb8d12014-07-07 06:20:47 +00003062 case Type::ConstantArray:
3063 case Type::IncompleteArray:
3064 case Type::VariableArray:
3065 // Itanium C++ ABI 2.9.5p5:
3066 // abi::__array_type_info adds no data members to std::type_info.
3067 break;
3068
3069 case Type::FunctionNoProto:
Richard Smithb17d6fa2016-12-01 03:04:07 +00003070 case Type::FunctionProto:
David Majnemere2cb8d12014-07-07 06:20:47 +00003071 // Itanium C++ ABI 2.9.5p5:
3072 // abi::__function_type_info adds no data members to std::type_info.
3073 break;
3074
3075 case Type::Enum:
3076 // Itanium C++ ABI 2.9.5p5:
3077 // abi::__enum_type_info adds no data members to std::type_info.
3078 break;
3079
3080 case Type::Record: {
3081 const CXXRecordDecl *RD =
3082 cast<CXXRecordDecl>(cast<RecordType>(Ty)->getDecl());
3083 if (!RD->hasDefinition() || !RD->getNumBases()) {
3084 // We don't need to emit any fields.
3085 break;
3086 }
3087
3088 if (CanUseSingleInheritance(RD))
3089 BuildSIClassTypeInfo(RD);
3090 else
3091 BuildVMIClassTypeInfo(RD);
3092
3093 break;
3094 }
3095
3096 case Type::ObjCObject:
3097 case Type::ObjCInterface:
3098 BuildObjCObjectTypeInfo(cast<ObjCObjectType>(Ty));
3099 break;
3100
3101 case Type::ObjCObjectPointer:
3102 BuildPointerTypeInfo(cast<ObjCObjectPointerType>(Ty)->getPointeeType());
3103 break;
3104
3105 case Type::Pointer:
3106 BuildPointerTypeInfo(cast<PointerType>(Ty)->getPointeeType());
3107 break;
3108
3109 case Type::MemberPointer:
3110 BuildPointerToMemberTypeInfo(cast<MemberPointerType>(Ty));
3111 break;
3112
3113 case Type::Atomic:
3114 // No fields, at least for the moment.
3115 break;
3116 }
3117
3118 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Fields);
3119
Rafael Espindolacb92c192015-01-15 23:18:01 +00003120 llvm::Module &M = CGM.getModule();
David Majnemere2cb8d12014-07-07 06:20:47 +00003121 llvm::GlobalVariable *GV =
Rafael Espindolacb92c192015-01-15 23:18:01 +00003122 new llvm::GlobalVariable(M, Init->getType(),
3123 /*Constant=*/true, Linkage, Init, Name);
3124
David Majnemere2cb8d12014-07-07 06:20:47 +00003125 // If there's already an old global variable, replace it with the new one.
3126 if (OldGV) {
3127 GV->takeName(OldGV);
3128 llvm::Constant *NewPtr =
3129 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
3130 OldGV->replaceAllUsesWith(NewPtr);
3131 OldGV->eraseFromParent();
3132 }
3133
Yaron Keren04da2382015-07-29 15:42:28 +00003134 if (CGM.supportsCOMDAT() && GV->isWeakForLinker())
3135 GV->setComdat(M.getOrInsertComdat(GV->getName()));
3136
David Majnemere2cb8d12014-07-07 06:20:47 +00003137 // The Itanium ABI specifies that type_info objects must be globally
3138 // unique, with one exception: if the type is an incomplete class
3139 // type or a (possibly indirect) pointer to one. That exception
3140 // affects the general case of comparing type_info objects produced
3141 // by the typeid operator, which is why the comparison operators on
3142 // std::type_info generally use the type_info name pointers instead
3143 // of the object addresses. However, the language's built-in uses
3144 // of RTTI generally require class types to be complete, even when
3145 // manipulating pointers to those class types. This allows the
3146 // implementation of dynamic_cast to rely on address equality tests,
3147 // which is much faster.
3148
3149 // All of this is to say that it's important that both the type_info
3150 // object and the type_info name be uniqued when weakly emitted.
3151
3152 // Give the type_info object and name the formal visibility of the
3153 // type itself.
3154 llvm::GlobalValue::VisibilityTypes llvmVisibility;
3155 if (llvm::GlobalValue::isLocalLinkage(Linkage))
3156 // If the linkage is local, only default visibility makes sense.
3157 llvmVisibility = llvm::GlobalValue::DefaultVisibility;
3158 else if (RTTIUniqueness == ItaniumCXXABI::RUK_NonUniqueHidden)
3159 llvmVisibility = llvm::GlobalValue::HiddenVisibility;
3160 else
3161 llvmVisibility = CodeGenModule::GetLLVMVisibility(Ty->getVisibility());
Saleem Abdulrasool18820022016-12-02 22:46:18 +00003162
David Majnemere2cb8d12014-07-07 06:20:47 +00003163 TypeName->setVisibility(llvmVisibility);
3164 GV->setVisibility(llvmVisibility);
Saleem Abdulrasool18820022016-12-02 22:46:18 +00003165
3166 if (CGM.getTriple().isWindowsItaniumEnvironment()) {
3167 auto RD = Ty->getAsCXXRecordDecl();
3168 if (DLLExport || (RD && RD->hasAttr<DLLExportAttr>())) {
3169 TypeName->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
3170 GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
Saleem Abdulrasool317dcc32016-12-05 22:40:20 +00003171 } else if (CGM.getLangOpts().RTTI && RD && RD->hasAttr<DLLImportAttr>()) {
Saleem Abdulrasool18820022016-12-02 22:46:18 +00003172 TypeName->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
3173 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
3174
3175 // Because the typename and the typeinfo are DLL import, convert them to
3176 // declarations rather than definitions. The initializers still need to
3177 // be constructed to calculate the type for the declarations.
3178 TypeName->setInitializer(nullptr);
3179 GV->setInitializer(nullptr);
3180 }
3181 }
David Majnemere2cb8d12014-07-07 06:20:47 +00003182
3183 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
3184}
3185
David Majnemere2cb8d12014-07-07 06:20:47 +00003186/// BuildObjCObjectTypeInfo - Build the appropriate kind of type_info
3187/// for the given Objective-C object type.
3188void ItaniumRTTIBuilder::BuildObjCObjectTypeInfo(const ObjCObjectType *OT) {
3189 // Drop qualifiers.
3190 const Type *T = OT->getBaseType().getTypePtr();
3191 assert(isa<BuiltinType>(T) || isa<ObjCInterfaceType>(T));
3192
3193 // The builtin types are abi::__class_type_infos and don't require
3194 // extra fields.
3195 if (isa<BuiltinType>(T)) return;
3196
3197 ObjCInterfaceDecl *Class = cast<ObjCInterfaceType>(T)->getDecl();
3198 ObjCInterfaceDecl *Super = Class->getSuperClass();
3199
3200 // Root classes are also __class_type_info.
3201 if (!Super) return;
3202
3203 QualType SuperTy = CGM.getContext().getObjCInterfaceType(Super);
3204
3205 // Everything else is single inheritance.
3206 llvm::Constant *BaseTypeInfo =
3207 ItaniumRTTIBuilder(CXXABI).BuildTypeInfo(SuperTy);
3208 Fields.push_back(BaseTypeInfo);
3209}
3210
3211/// BuildSIClassTypeInfo - Build an abi::__si_class_type_info, used for single
3212/// inheritance, according to the Itanium C++ ABI, 2.95p6b.
3213void ItaniumRTTIBuilder::BuildSIClassTypeInfo(const CXXRecordDecl *RD) {
3214 // Itanium C++ ABI 2.9.5p6b:
3215 // It adds to abi::__class_type_info a single member pointing to the
3216 // type_info structure for the base type,
3217 llvm::Constant *BaseTypeInfo =
3218 ItaniumRTTIBuilder(CXXABI).BuildTypeInfo(RD->bases_begin()->getType());
3219 Fields.push_back(BaseTypeInfo);
3220}
3221
3222namespace {
3223 /// SeenBases - Contains virtual and non-virtual bases seen when traversing
3224 /// a class hierarchy.
3225 struct SeenBases {
3226 llvm::SmallPtrSet<const CXXRecordDecl *, 16> NonVirtualBases;
3227 llvm::SmallPtrSet<const CXXRecordDecl *, 16> VirtualBases;
3228 };
3229}
3230
3231/// ComputeVMIClassTypeInfoFlags - Compute the value of the flags member in
3232/// abi::__vmi_class_type_info.
3233///
3234static unsigned ComputeVMIClassTypeInfoFlags(const CXXBaseSpecifier *Base,
3235 SeenBases &Bases) {
3236
3237 unsigned Flags = 0;
3238
3239 const CXXRecordDecl *BaseDecl =
3240 cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl());
3241
3242 if (Base->isVirtual()) {
3243 // Mark the virtual base as seen.
David Blaikie82e95a32014-11-19 07:49:47 +00003244 if (!Bases.VirtualBases.insert(BaseDecl).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003245 // If this virtual base has been seen before, then the class is diamond
3246 // shaped.
3247 Flags |= ItaniumRTTIBuilder::VMI_DiamondShaped;
3248 } else {
3249 if (Bases.NonVirtualBases.count(BaseDecl))
3250 Flags |= ItaniumRTTIBuilder::VMI_NonDiamondRepeat;
3251 }
3252 } else {
3253 // Mark the non-virtual base as seen.
David Blaikie82e95a32014-11-19 07:49:47 +00003254 if (!Bases.NonVirtualBases.insert(BaseDecl).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003255 // If this non-virtual base has been seen before, then the class has non-
3256 // diamond shaped repeated inheritance.
3257 Flags |= ItaniumRTTIBuilder::VMI_NonDiamondRepeat;
3258 } else {
3259 if (Bases.VirtualBases.count(BaseDecl))
3260 Flags |= ItaniumRTTIBuilder::VMI_NonDiamondRepeat;
3261 }
3262 }
3263
3264 // Walk all bases.
3265 for (const auto &I : BaseDecl->bases())
3266 Flags |= ComputeVMIClassTypeInfoFlags(&I, Bases);
3267
3268 return Flags;
3269}
3270
3271static unsigned ComputeVMIClassTypeInfoFlags(const CXXRecordDecl *RD) {
3272 unsigned Flags = 0;
3273 SeenBases Bases;
3274
3275 // Walk all bases.
3276 for (const auto &I : RD->bases())
3277 Flags |= ComputeVMIClassTypeInfoFlags(&I, Bases);
3278
3279 return Flags;
3280}
3281
3282/// BuildVMIClassTypeInfo - Build an abi::__vmi_class_type_info, used for
3283/// classes with bases that do not satisfy the abi::__si_class_type_info
3284/// constraints, according ti the Itanium C++ ABI, 2.9.5p5c.
3285void ItaniumRTTIBuilder::BuildVMIClassTypeInfo(const CXXRecordDecl *RD) {
3286 llvm::Type *UnsignedIntLTy =
3287 CGM.getTypes().ConvertType(CGM.getContext().UnsignedIntTy);
3288
3289 // Itanium C++ ABI 2.9.5p6c:
3290 // __flags is a word with flags describing details about the class
3291 // structure, which may be referenced by using the __flags_masks
3292 // enumeration. These flags refer to both direct and indirect bases.
3293 unsigned Flags = ComputeVMIClassTypeInfoFlags(RD);
3294 Fields.push_back(llvm::ConstantInt::get(UnsignedIntLTy, Flags));
3295
3296 // Itanium C++ ABI 2.9.5p6c:
3297 // __base_count is a word with the number of direct proper base class
3298 // descriptions that follow.
3299 Fields.push_back(llvm::ConstantInt::get(UnsignedIntLTy, RD->getNumBases()));
3300
3301 if (!RD->getNumBases())
3302 return;
3303
David Majnemere2cb8d12014-07-07 06:20:47 +00003304 // Now add the base class descriptions.
3305
3306 // Itanium C++ ABI 2.9.5p6c:
3307 // __base_info[] is an array of base class descriptions -- one for every
3308 // direct proper base. Each description is of the type:
3309 //
3310 // struct abi::__base_class_type_info {
3311 // public:
3312 // const __class_type_info *__base_type;
3313 // long __offset_flags;
3314 //
3315 // enum __offset_flags_masks {
3316 // __virtual_mask = 0x1,
3317 // __public_mask = 0x2,
3318 // __offset_shift = 8
3319 // };
3320 // };
Reid Klecknerd8b04662016-08-25 22:16:30 +00003321
3322 // If we're in mingw and 'long' isn't wide enough for a pointer, use 'long
3323 // long' instead of 'long' for __offset_flags. libstdc++abi uses long long on
3324 // LLP64 platforms.
3325 // FIXME: Consider updating libc++abi to match, and extend this logic to all
3326 // LLP64 platforms.
3327 QualType OffsetFlagsTy = CGM.getContext().LongTy;
3328 const TargetInfo &TI = CGM.getContext().getTargetInfo();
3329 if (TI.getTriple().isOSCygMing() && TI.getPointerWidth(0) > TI.getLongWidth())
3330 OffsetFlagsTy = CGM.getContext().LongLongTy;
3331 llvm::Type *OffsetFlagsLTy =
3332 CGM.getTypes().ConvertType(OffsetFlagsTy);
3333
David Majnemere2cb8d12014-07-07 06:20:47 +00003334 for (const auto &Base : RD->bases()) {
3335 // The __base_type member points to the RTTI for the base type.
3336 Fields.push_back(ItaniumRTTIBuilder(CXXABI).BuildTypeInfo(Base.getType()));
3337
3338 const CXXRecordDecl *BaseDecl =
3339 cast<CXXRecordDecl>(Base.getType()->getAs<RecordType>()->getDecl());
3340
3341 int64_t OffsetFlags = 0;
3342
3343 // All but the lower 8 bits of __offset_flags are a signed offset.
3344 // For a non-virtual base, this is the offset in the object of the base
3345 // subobject. For a virtual base, this is the offset in the virtual table of
3346 // the virtual base offset for the virtual base referenced (negative).
3347 CharUnits Offset;
3348 if (Base.isVirtual())
3349 Offset =
3350 CGM.getItaniumVTableContext().getVirtualBaseOffsetOffset(RD, BaseDecl);
3351 else {
3352 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3353 Offset = Layout.getBaseClassOffset(BaseDecl);
3354 };
3355
3356 OffsetFlags = uint64_t(Offset.getQuantity()) << 8;
3357
3358 // The low-order byte of __offset_flags contains flags, as given by the
3359 // masks from the enumeration __offset_flags_masks.
3360 if (Base.isVirtual())
3361 OffsetFlags |= BCTI_Virtual;
3362 if (Base.getAccessSpecifier() == AS_public)
3363 OffsetFlags |= BCTI_Public;
3364
Reid Klecknerd8b04662016-08-25 22:16:30 +00003365 Fields.push_back(llvm::ConstantInt::get(OffsetFlagsLTy, OffsetFlags));
David Majnemere2cb8d12014-07-07 06:20:47 +00003366 }
3367}
3368
Richard Smitha7d93782016-12-01 03:32:42 +00003369/// Compute the flags for a __pbase_type_info, and remove the corresponding
3370/// pieces from \p Type.
3371static unsigned extractPBaseFlags(ASTContext &Ctx, QualType &Type) {
3372 unsigned Flags = 0;
David Majnemere2cb8d12014-07-07 06:20:47 +00003373
Richard Smitha7d93782016-12-01 03:32:42 +00003374 if (Type.isConstQualified())
3375 Flags |= ItaniumRTTIBuilder::PTI_Const;
3376 if (Type.isVolatileQualified())
3377 Flags |= ItaniumRTTIBuilder::PTI_Volatile;
3378 if (Type.isRestrictQualified())
3379 Flags |= ItaniumRTTIBuilder::PTI_Restrict;
3380 Type = Type.getUnqualifiedType();
David Majnemere2cb8d12014-07-07 06:20:47 +00003381
3382 // Itanium C++ ABI 2.9.5p7:
3383 // When the abi::__pbase_type_info is for a direct or indirect pointer to an
3384 // incomplete class type, the incomplete target type flag is set.
Richard Smitha7d93782016-12-01 03:32:42 +00003385 if (ContainsIncompleteClassType(Type))
3386 Flags |= ItaniumRTTIBuilder::PTI_Incomplete;
3387
3388 if (auto *Proto = Type->getAs<FunctionProtoType>()) {
3389 if (Proto->isNothrow(Ctx)) {
3390 Flags |= ItaniumRTTIBuilder::PTI_Noexcept;
3391 Type = Ctx.getFunctionType(
3392 Proto->getReturnType(), Proto->getParamTypes(),
3393 Proto->getExtProtoInfo().withExceptionSpec(EST_None));
3394 }
3395 }
3396
3397 return Flags;
3398}
3399
3400/// BuildPointerTypeInfo - Build an abi::__pointer_type_info struct,
3401/// used for pointer types.
3402void ItaniumRTTIBuilder::BuildPointerTypeInfo(QualType PointeeTy) {
3403 // Itanium C++ ABI 2.9.5p7:
3404 // __flags is a flag word describing the cv-qualification and other
3405 // attributes of the type pointed to
3406 unsigned Flags = extractPBaseFlags(CGM.getContext(), PointeeTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003407
3408 llvm::Type *UnsignedIntLTy =
3409 CGM.getTypes().ConvertType(CGM.getContext().UnsignedIntTy);
3410 Fields.push_back(llvm::ConstantInt::get(UnsignedIntLTy, Flags));
3411
3412 // Itanium C++ ABI 2.9.5p7:
3413 // __pointee is a pointer to the std::type_info derivation for the
3414 // unqualified type being pointed to.
3415 llvm::Constant *PointeeTypeInfo =
Richard Smitha7d93782016-12-01 03:32:42 +00003416 ItaniumRTTIBuilder(CXXABI).BuildTypeInfo(PointeeTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003417 Fields.push_back(PointeeTypeInfo);
3418}
3419
3420/// BuildPointerToMemberTypeInfo - Build an abi::__pointer_to_member_type_info
3421/// struct, used for member pointer types.
3422void
3423ItaniumRTTIBuilder::BuildPointerToMemberTypeInfo(const MemberPointerType *Ty) {
3424 QualType PointeeTy = Ty->getPointeeType();
3425
David Majnemere2cb8d12014-07-07 06:20:47 +00003426 // Itanium C++ ABI 2.9.5p7:
3427 // __flags is a flag word describing the cv-qualification and other
3428 // attributes of the type pointed to.
Richard Smitha7d93782016-12-01 03:32:42 +00003429 unsigned Flags = extractPBaseFlags(CGM.getContext(), PointeeTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003430
3431 const RecordType *ClassType = cast<RecordType>(Ty->getClass());
David Majnemere2cb8d12014-07-07 06:20:47 +00003432 if (IsIncompleteClassType(ClassType))
3433 Flags |= PTI_ContainingClassIncomplete;
3434
3435 llvm::Type *UnsignedIntLTy =
3436 CGM.getTypes().ConvertType(CGM.getContext().UnsignedIntTy);
3437 Fields.push_back(llvm::ConstantInt::get(UnsignedIntLTy, Flags));
3438
3439 // Itanium C++ ABI 2.9.5p7:
3440 // __pointee is a pointer to the std::type_info derivation for the
3441 // unqualified type being pointed to.
3442 llvm::Constant *PointeeTypeInfo =
Richard Smitha7d93782016-12-01 03:32:42 +00003443 ItaniumRTTIBuilder(CXXABI).BuildTypeInfo(PointeeTy);
David Majnemere2cb8d12014-07-07 06:20:47 +00003444 Fields.push_back(PointeeTypeInfo);
3445
3446 // Itanium C++ ABI 2.9.5p9:
3447 // __context is a pointer to an abi::__class_type_info corresponding to the
3448 // class type containing the member pointed to
3449 // (e.g., the "A" in "int A::*").
3450 Fields.push_back(
3451 ItaniumRTTIBuilder(CXXABI).BuildTypeInfo(QualType(ClassType, 0)));
3452}
3453
David Majnemer443250f2015-03-17 20:35:00 +00003454llvm::Constant *ItaniumCXXABI::getAddrOfRTTIDescriptor(QualType Ty) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003455 return ItaniumRTTIBuilder(*this).BuildTypeInfo(Ty);
3456}
3457
Saleem Abdulrasool8dbaf5c2016-09-30 23:11:05 +00003458void ItaniumCXXABI::EmitFundamentalRTTIDescriptor(QualType Type,
3459 bool DLLExport) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003460 QualType PointerType = getContext().getPointerType(Type);
3461 QualType PointerTypeConst = getContext().getPointerType(Type.withConst());
Saleem Abdulrasool8dbaf5c2016-09-30 23:11:05 +00003462 ItaniumRTTIBuilder(*this).BuildTypeInfo(Type, /*Force=*/true, DLLExport);
3463 ItaniumRTTIBuilder(*this).BuildTypeInfo(PointerType, /*Force=*/true,
3464 DLLExport);
3465 ItaniumRTTIBuilder(*this).BuildTypeInfo(PointerTypeConst, /*Force=*/true,
3466 DLLExport);
David Majnemere2cb8d12014-07-07 06:20:47 +00003467}
3468
Saleem Abdulrasool8dbaf5c2016-09-30 23:11:05 +00003469void ItaniumCXXABI::EmitFundamentalRTTIDescriptors(bool DLLExport) {
Richard Smith4a382012016-02-03 01:32:42 +00003470 // Types added here must also be added to TypeInfoIsInStandardLibrary.
David Majnemere2cb8d12014-07-07 06:20:47 +00003471 QualType FundamentalTypes[] = {
3472 getContext().VoidTy, getContext().NullPtrTy,
3473 getContext().BoolTy, getContext().WCharTy,
3474 getContext().CharTy, getContext().UnsignedCharTy,
3475 getContext().SignedCharTy, getContext().ShortTy,
3476 getContext().UnsignedShortTy, getContext().IntTy,
3477 getContext().UnsignedIntTy, getContext().LongTy,
3478 getContext().UnsignedLongTy, getContext().LongLongTy,
Richard Smith4a382012016-02-03 01:32:42 +00003479 getContext().UnsignedLongLongTy, getContext().Int128Ty,
3480 getContext().UnsignedInt128Ty, getContext().HalfTy,
David Majnemere2cb8d12014-07-07 06:20:47 +00003481 getContext().FloatTy, getContext().DoubleTy,
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +00003482 getContext().LongDoubleTy, getContext().Float128Ty,
3483 getContext().Char16Ty, getContext().Char32Ty
David Majnemere2cb8d12014-07-07 06:20:47 +00003484 };
3485 for (const QualType &FundamentalType : FundamentalTypes)
Saleem Abdulrasool8dbaf5c2016-09-30 23:11:05 +00003486 EmitFundamentalRTTIDescriptor(FundamentalType, DLLExport);
David Majnemere2cb8d12014-07-07 06:20:47 +00003487}
3488
3489/// What sort of uniqueness rules should we use for the RTTI for the
3490/// given type?
3491ItaniumCXXABI::RTTIUniquenessKind ItaniumCXXABI::classifyRTTIUniqueness(
3492 QualType CanTy, llvm::GlobalValue::LinkageTypes Linkage) const {
3493 if (shouldRTTIBeUnique())
3494 return RUK_Unique;
3495
3496 // It's only necessary for linkonce_odr or weak_odr linkage.
3497 if (Linkage != llvm::GlobalValue::LinkOnceODRLinkage &&
3498 Linkage != llvm::GlobalValue::WeakODRLinkage)
3499 return RUK_Unique;
3500
3501 // It's only necessary with default visibility.
3502 if (CanTy->getVisibility() != DefaultVisibility)
3503 return RUK_Unique;
3504
3505 // If we're not required to publish this symbol, hide it.
3506 if (Linkage == llvm::GlobalValue::LinkOnceODRLinkage)
3507 return RUK_NonUniqueHidden;
3508
3509 // If we're required to publish this symbol, as we might be under an
3510 // explicit instantiation, leave it with default visibility but
3511 // enable string-comparisons.
3512 assert(Linkage == llvm::GlobalValue::WeakODRLinkage);
3513 return RUK_NonUniqueVisible;
3514}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003515
Rafael Espindola1e4df922014-09-16 15:18:21 +00003516// Find out how to codegen the complete destructor and constructor
3517namespace {
3518enum class StructorCodegen { Emit, RAUW, Alias, COMDAT };
3519}
3520static StructorCodegen getCodegenToUse(CodeGenModule &CGM,
3521 const CXXMethodDecl *MD) {
3522 if (!CGM.getCodeGenOpts().CXXCtorDtorAliases)
3523 return StructorCodegen::Emit;
Rafael Espindola91f68b42014-09-15 19:20:10 +00003524
Rafael Espindola1e4df922014-09-16 15:18:21 +00003525 // The complete and base structors are not equivalent if there are any virtual
3526 // bases, so emit separate functions.
3527 if (MD->getParent()->getNumVBases())
3528 return StructorCodegen::Emit;
3529
3530 GlobalDecl AliasDecl;
3531 if (const auto *DD = dyn_cast<CXXDestructorDecl>(MD)) {
3532 AliasDecl = GlobalDecl(DD, Dtor_Complete);
3533 } else {
3534 const auto *CD = cast<CXXConstructorDecl>(MD);
3535 AliasDecl = GlobalDecl(CD, Ctor_Complete);
3536 }
3537 llvm::GlobalValue::LinkageTypes Linkage = CGM.getFunctionLinkage(AliasDecl);
3538
3539 if (llvm::GlobalValue::isDiscardableIfUnused(Linkage))
3540 return StructorCodegen::RAUW;
3541
3542 // FIXME: Should we allow available_externally aliases?
3543 if (!llvm::GlobalAlias::isValidLinkage(Linkage))
3544 return StructorCodegen::RAUW;
3545
Rafael Espindola0806f982014-09-16 20:19:43 +00003546 if (llvm::GlobalValue::isWeakForLinker(Linkage)) {
Dan Gohman839f2152017-01-17 21:46:38 +00003547 // Only ELF and wasm support COMDATs with arbitrary names (C5/D5).
3548 if (CGM.getTarget().getTriple().isOSBinFormatELF() ||
3549 CGM.getTarget().getTriple().isOSBinFormatWasm())
Rafael Espindola0806f982014-09-16 20:19:43 +00003550 return StructorCodegen::COMDAT;
3551 return StructorCodegen::Emit;
3552 }
Rafael Espindola1e4df922014-09-16 15:18:21 +00003553
3554 return StructorCodegen::Alias;
Rafael Espindola91f68b42014-09-15 19:20:10 +00003555}
3556
Rafael Espindola1e4df922014-09-16 15:18:21 +00003557static void emitConstructorDestructorAlias(CodeGenModule &CGM,
3558 GlobalDecl AliasDecl,
3559 GlobalDecl TargetDecl) {
3560 llvm::GlobalValue::LinkageTypes Linkage = CGM.getFunctionLinkage(AliasDecl);
3561
3562 StringRef MangledName = CGM.getMangledName(AliasDecl);
3563 llvm::GlobalValue *Entry = CGM.GetGlobalValue(MangledName);
3564 if (Entry && !Entry->isDeclaration())
3565 return;
3566
3567 auto *Aliasee = cast<llvm::GlobalValue>(CGM.GetAddrOfGlobal(TargetDecl));
Rafael Espindola1e4df922014-09-16 15:18:21 +00003568
3569 // Create the alias with no name.
David Blaikie2a791d72015-09-14 18:38:22 +00003570 auto *Alias = llvm::GlobalAlias::create(Linkage, "", Aliasee);
Rafael Espindola1e4df922014-09-16 15:18:21 +00003571
3572 // Switch any previous uses to the alias.
3573 if (Entry) {
NAKAMURA Takumie9621042015-09-15 01:39:27 +00003574 assert(Entry->getType() == Aliasee->getType() &&
Rafael Espindola1e4df922014-09-16 15:18:21 +00003575 "declaration exists with different type");
3576 Alias->takeName(Entry);
3577 Entry->replaceAllUsesWith(Alias);
3578 Entry->eraseFromParent();
3579 } else {
3580 Alias->setName(MangledName);
3581 }
3582
3583 // Finally, set up the alias with its proper name and attributes.
Dario Domiziolic4fb8ca72014-09-19 22:06:24 +00003584 CGM.setAliasAttributes(cast<NamedDecl>(AliasDecl.getDecl()), Alias);
Rafael Espindola1e4df922014-09-16 15:18:21 +00003585}
3586
3587void ItaniumCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3588 StructorType Type) {
3589 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
3590 const CXXDestructorDecl *DD = CD ? nullptr : cast<CXXDestructorDecl>(MD);
3591
3592 StructorCodegen CGType = getCodegenToUse(CGM, MD);
3593
3594 if (Type == StructorType::Complete) {
3595 GlobalDecl CompleteDecl;
3596 GlobalDecl BaseDecl;
3597 if (CD) {
3598 CompleteDecl = GlobalDecl(CD, Ctor_Complete);
3599 BaseDecl = GlobalDecl(CD, Ctor_Base);
3600 } else {
3601 CompleteDecl = GlobalDecl(DD, Dtor_Complete);
3602 BaseDecl = GlobalDecl(DD, Dtor_Base);
3603 }
3604
3605 if (CGType == StructorCodegen::Alias || CGType == StructorCodegen::COMDAT) {
3606 emitConstructorDestructorAlias(CGM, CompleteDecl, BaseDecl);
3607 return;
3608 }
3609
3610 if (CGType == StructorCodegen::RAUW) {
3611 StringRef MangledName = CGM.getMangledName(CompleteDecl);
Andrey Bokhankocab58582015-08-31 13:20:44 +00003612 auto *Aliasee = CGM.GetAddrOfGlobal(BaseDecl);
Rafael Espindola1e4df922014-09-16 15:18:21 +00003613 CGM.addReplacement(MangledName, Aliasee);
3614 return;
Rafael Espindola91f68b42014-09-15 19:20:10 +00003615 }
3616 }
3617
3618 // The base destructor is equivalent to the base destructor of its
3619 // base class if there is exactly one non-virtual base class with a
3620 // non-trivial destructor, there are no fields with a non-trivial
3621 // destructor, and the body of the destructor is trivial.
Rafael Espindola1e4df922014-09-16 15:18:21 +00003622 if (DD && Type == StructorType::Base && CGType != StructorCodegen::COMDAT &&
3623 !CGM.TryEmitBaseDestructorAsAlias(DD))
Rafael Espindola91f68b42014-09-15 19:20:10 +00003624 return;
3625
Rafael Espindola1e4df922014-09-16 15:18:21 +00003626 llvm::Function *Fn = CGM.codegenCXXStructor(MD, Type);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003627
Rafael Espindola1e4df922014-09-16 15:18:21 +00003628 if (CGType == StructorCodegen::COMDAT) {
3629 SmallString<256> Buffer;
3630 llvm::raw_svector_ostream Out(Buffer);
3631 if (DD)
3632 getMangleContext().mangleCXXDtorComdat(DD, Out);
3633 else
3634 getMangleContext().mangleCXXCtorComdat(CD, Out);
3635 llvm::Comdat *C = CGM.getModule().getOrInsertComdat(Out.str());
3636 Fn->setComdat(C);
Rafael Espindoladbee8a72015-01-15 21:36:08 +00003637 } else {
3638 CGM.maybeSetTrivialComdat(*MD, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003639 }
Rafael Espindola91f68b42014-09-15 19:20:10 +00003640}
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003641
3642static llvm::Constant *getBeginCatchFn(CodeGenModule &CGM) {
3643 // void *__cxa_begin_catch(void*);
3644 llvm::FunctionType *FTy = llvm::FunctionType::get(
3645 CGM.Int8PtrTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
3646
3647 return CGM.CreateRuntimeFunction(FTy, "__cxa_begin_catch");
3648}
3649
3650static llvm::Constant *getEndCatchFn(CodeGenModule &CGM) {
3651 // void __cxa_end_catch();
3652 llvm::FunctionType *FTy =
3653 llvm::FunctionType::get(CGM.VoidTy, /*IsVarArgs=*/false);
3654
3655 return CGM.CreateRuntimeFunction(FTy, "__cxa_end_catch");
3656}
3657
3658static llvm::Constant *getGetExceptionPtrFn(CodeGenModule &CGM) {
3659 // void *__cxa_get_exception_ptr(void*);
3660 llvm::FunctionType *FTy = llvm::FunctionType::get(
3661 CGM.Int8PtrTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
3662
3663 return CGM.CreateRuntimeFunction(FTy, "__cxa_get_exception_ptr");
3664}
3665
3666namespace {
3667 /// A cleanup to call __cxa_end_catch. In many cases, the caught
3668 /// exception type lets us state definitively that the thrown exception
3669 /// type does not have a destructor. In particular:
3670 /// - Catch-alls tell us nothing, so we have to conservatively
3671 /// assume that the thrown exception might have a destructor.
3672 /// - Catches by reference behave according to their base types.
3673 /// - Catches of non-record types will only trigger for exceptions
3674 /// of non-record types, which never have destructors.
3675 /// - Catches of record types can trigger for arbitrary subclasses
3676 /// of the caught type, so we have to assume the actual thrown
3677 /// exception type might have a throwing destructor, even if the
3678 /// caught type's destructor is trivial or nothrow.
David Blaikie7e70d682015-08-18 22:40:54 +00003679 struct CallEndCatch final : EHScopeStack::Cleanup {
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003680 CallEndCatch(bool MightThrow) : MightThrow(MightThrow) {}
3681 bool MightThrow;
3682
3683 void Emit(CodeGenFunction &CGF, Flags flags) override {
3684 if (!MightThrow) {
3685 CGF.EmitNounwindRuntimeCall(getEndCatchFn(CGF.CGM));
3686 return;
3687 }
3688
3689 CGF.EmitRuntimeCallOrInvoke(getEndCatchFn(CGF.CGM));
3690 }
3691 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00003692}
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003693
3694/// Emits a call to __cxa_begin_catch and enters a cleanup to call
3695/// __cxa_end_catch.
3696///
3697/// \param EndMightThrow - true if __cxa_end_catch might throw
3698static llvm::Value *CallBeginCatch(CodeGenFunction &CGF,
3699 llvm::Value *Exn,
3700 bool EndMightThrow) {
3701 llvm::CallInst *call =
3702 CGF.EmitNounwindRuntimeCall(getBeginCatchFn(CGF.CGM), Exn);
3703
3704 CGF.EHStack.pushCleanup<CallEndCatch>(NormalAndEHCleanup, EndMightThrow);
3705
3706 return call;
3707}
3708
3709/// A "special initializer" callback for initializing a catch
3710/// parameter during catch initialization.
3711static void InitCatchParam(CodeGenFunction &CGF,
3712 const VarDecl &CatchParam,
John McCall7f416cc2015-09-08 08:05:57 +00003713 Address ParamAddr,
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003714 SourceLocation Loc) {
3715 // Load the exception from where the landing pad saved it.
3716 llvm::Value *Exn = CGF.getExceptionFromSlot();
3717
3718 CanQualType CatchType =
3719 CGF.CGM.getContext().getCanonicalType(CatchParam.getType());
3720 llvm::Type *LLVMCatchTy = CGF.ConvertTypeForMem(CatchType);
3721
3722 // If we're catching by reference, we can just cast the object
3723 // pointer to the appropriate pointer.
3724 if (isa<ReferenceType>(CatchType)) {
3725 QualType CaughtType = cast<ReferenceType>(CatchType)->getPointeeType();
3726 bool EndCatchMightThrow = CaughtType->isRecordType();
3727
3728 // __cxa_begin_catch returns the adjusted object pointer.
3729 llvm::Value *AdjustedExn = CallBeginCatch(CGF, Exn, EndCatchMightThrow);
3730
3731 // We have no way to tell the personality function that we're
3732 // catching by reference, so if we're catching a pointer,
3733 // __cxa_begin_catch will actually return that pointer by value.
3734 if (const PointerType *PT = dyn_cast<PointerType>(CaughtType)) {
3735 QualType PointeeType = PT->getPointeeType();
3736
3737 // When catching by reference, generally we should just ignore
3738 // this by-value pointer and use the exception object instead.
3739 if (!PointeeType->isRecordType()) {
3740
3741 // Exn points to the struct _Unwind_Exception header, which
3742 // we have to skip past in order to reach the exception data.
3743 unsigned HeaderSize =
3744 CGF.CGM.getTargetCodeGenInfo().getSizeOfUnwindException();
3745 AdjustedExn = CGF.Builder.CreateConstGEP1_32(Exn, HeaderSize);
3746
3747 // However, if we're catching a pointer-to-record type that won't
3748 // work, because the personality function might have adjusted
3749 // the pointer. There's actually no way for us to fully satisfy
3750 // the language/ABI contract here: we can't use Exn because it
3751 // might have the wrong adjustment, but we can't use the by-value
3752 // pointer because it's off by a level of abstraction.
3753 //
3754 // The current solution is to dump the adjusted pointer into an
3755 // alloca, which breaks language semantics (because changing the
3756 // pointer doesn't change the exception) but at least works.
3757 // The better solution would be to filter out non-exact matches
3758 // and rethrow them, but this is tricky because the rethrow
3759 // really needs to be catchable by other sites at this landing
3760 // pad. The best solution is to fix the personality function.
3761 } else {
3762 // Pull the pointer for the reference type off.
3763 llvm::Type *PtrTy =
3764 cast<llvm::PointerType>(LLVMCatchTy)->getElementType();
3765
3766 // Create the temporary and write the adjusted pointer into it.
John McCall7f416cc2015-09-08 08:05:57 +00003767 Address ExnPtrTmp =
3768 CGF.CreateTempAlloca(PtrTy, CGF.getPointerAlign(), "exn.byref.tmp");
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003769 llvm::Value *Casted = CGF.Builder.CreateBitCast(AdjustedExn, PtrTy);
3770 CGF.Builder.CreateStore(Casted, ExnPtrTmp);
3771
3772 // Bind the reference to the temporary.
John McCall7f416cc2015-09-08 08:05:57 +00003773 AdjustedExn = ExnPtrTmp.getPointer();
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003774 }
3775 }
3776
3777 llvm::Value *ExnCast =
3778 CGF.Builder.CreateBitCast(AdjustedExn, LLVMCatchTy, "exn.byref");
3779 CGF.Builder.CreateStore(ExnCast, ParamAddr);
3780 return;
3781 }
3782
3783 // Scalars and complexes.
3784 TypeEvaluationKind TEK = CGF.getEvaluationKind(CatchType);
3785 if (TEK != TEK_Aggregate) {
3786 llvm::Value *AdjustedExn = CallBeginCatch(CGF, Exn, false);
3787
3788 // If the catch type is a pointer type, __cxa_begin_catch returns
3789 // the pointer by value.
3790 if (CatchType->hasPointerRepresentation()) {
3791 llvm::Value *CastExn =
3792 CGF.Builder.CreateBitCast(AdjustedExn, LLVMCatchTy, "exn.casted");
3793
3794 switch (CatchType.getQualifiers().getObjCLifetime()) {
3795 case Qualifiers::OCL_Strong:
3796 CastExn = CGF.EmitARCRetainNonBlock(CastExn);
3797 // fallthrough
3798
3799 case Qualifiers::OCL_None:
3800 case Qualifiers::OCL_ExplicitNone:
3801 case Qualifiers::OCL_Autoreleasing:
3802 CGF.Builder.CreateStore(CastExn, ParamAddr);
3803 return;
3804
3805 case Qualifiers::OCL_Weak:
3806 CGF.EmitARCInitWeak(ParamAddr, CastExn);
3807 return;
3808 }
3809 llvm_unreachable("bad ownership qualifier!");
3810 }
3811
3812 // Otherwise, it returns a pointer into the exception object.
3813
3814 llvm::Type *PtrTy = LLVMCatchTy->getPointerTo(0); // addrspace 0 ok
3815 llvm::Value *Cast = CGF.Builder.CreateBitCast(AdjustedExn, PtrTy);
3816
3817 LValue srcLV = CGF.MakeNaturalAlignAddrLValue(Cast, CatchType);
John McCall7f416cc2015-09-08 08:05:57 +00003818 LValue destLV = CGF.MakeAddrLValue(ParamAddr, CatchType);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003819 switch (TEK) {
3820 case TEK_Complex:
3821 CGF.EmitStoreOfComplex(CGF.EmitLoadOfComplex(srcLV, Loc), destLV,
3822 /*init*/ true);
3823 return;
3824 case TEK_Scalar: {
3825 llvm::Value *ExnLoad = CGF.EmitLoadOfScalar(srcLV, Loc);
3826 CGF.EmitStoreOfScalar(ExnLoad, destLV, /*init*/ true);
3827 return;
3828 }
3829 case TEK_Aggregate:
3830 llvm_unreachable("evaluation kind filtered out!");
3831 }
3832 llvm_unreachable("bad evaluation kind");
3833 }
3834
3835 assert(isa<RecordType>(CatchType) && "unexpected catch type!");
John McCall7f416cc2015-09-08 08:05:57 +00003836 auto catchRD = CatchType->getAsCXXRecordDecl();
3837 CharUnits caughtExnAlignment = CGF.CGM.getClassPointerAlignment(catchRD);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003838
3839 llvm::Type *PtrTy = LLVMCatchTy->getPointerTo(0); // addrspace 0 ok
3840
3841 // Check for a copy expression. If we don't have a copy expression,
3842 // that means a trivial copy is okay.
3843 const Expr *copyExpr = CatchParam.getInit();
3844 if (!copyExpr) {
3845 llvm::Value *rawAdjustedExn = CallBeginCatch(CGF, Exn, true);
John McCall7f416cc2015-09-08 08:05:57 +00003846 Address adjustedExn(CGF.Builder.CreateBitCast(rawAdjustedExn, PtrTy),
3847 caughtExnAlignment);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003848 CGF.EmitAggregateCopy(ParamAddr, adjustedExn, CatchType);
3849 return;
3850 }
3851
3852 // We have to call __cxa_get_exception_ptr to get the adjusted
3853 // pointer before copying.
3854 llvm::CallInst *rawAdjustedExn =
3855 CGF.EmitNounwindRuntimeCall(getGetExceptionPtrFn(CGF.CGM), Exn);
3856
3857 // Cast that to the appropriate type.
John McCall7f416cc2015-09-08 08:05:57 +00003858 Address adjustedExn(CGF.Builder.CreateBitCast(rawAdjustedExn, PtrTy),
3859 caughtExnAlignment);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003860
3861 // The copy expression is defined in terms of an OpaqueValueExpr.
3862 // Find it and map it to the adjusted expression.
3863 CodeGenFunction::OpaqueValueMapping
3864 opaque(CGF, OpaqueValueExpr::findInCopyConstruct(copyExpr),
3865 CGF.MakeAddrLValue(adjustedExn, CatchParam.getType()));
3866
3867 // Call the copy ctor in a terminate scope.
3868 CGF.EHStack.pushTerminate();
3869
3870 // Perform the copy construction.
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003871 CGF.EmitAggExpr(copyExpr,
John McCall7f416cc2015-09-08 08:05:57 +00003872 AggValueSlot::forAddr(ParamAddr, Qualifiers(),
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003873 AggValueSlot::IsNotDestructed,
3874 AggValueSlot::DoesNotNeedGCBarriers,
3875 AggValueSlot::IsNotAliased));
3876
3877 // Leave the terminate scope.
3878 CGF.EHStack.popTerminate();
3879
3880 // Undo the opaque value mapping.
3881 opaque.pop();
3882
3883 // Finally we can call __cxa_begin_catch.
3884 CallBeginCatch(CGF, Exn, true);
3885}
3886
3887/// Begins a catch statement by initializing the catch variable and
3888/// calling __cxa_begin_catch.
3889void ItaniumCXXABI::emitBeginCatch(CodeGenFunction &CGF,
3890 const CXXCatchStmt *S) {
3891 // We have to be very careful with the ordering of cleanups here:
3892 // C++ [except.throw]p4:
3893 // The destruction [of the exception temporary] occurs
3894 // immediately after the destruction of the object declared in
3895 // the exception-declaration in the handler.
3896 //
3897 // So the precise ordering is:
3898 // 1. Construct catch variable.
3899 // 2. __cxa_begin_catch
3900 // 3. Enter __cxa_end_catch cleanup
3901 // 4. Enter dtor cleanup
3902 //
3903 // We do this by using a slightly abnormal initialization process.
3904 // Delegation sequence:
3905 // - ExitCXXTryStmt opens a RunCleanupsScope
3906 // - EmitAutoVarAlloca creates the variable and debug info
3907 // - InitCatchParam initializes the variable from the exception
3908 // - CallBeginCatch calls __cxa_begin_catch
3909 // - CallBeginCatch enters the __cxa_end_catch cleanup
3910 // - EmitAutoVarCleanups enters the variable destructor cleanup
3911 // - EmitCXXTryStmt emits the code for the catch body
3912 // - EmitCXXTryStmt close the RunCleanupsScope
3913
3914 VarDecl *CatchParam = S->getExceptionDecl();
3915 if (!CatchParam) {
3916 llvm::Value *Exn = CGF.getExceptionFromSlot();
3917 CallBeginCatch(CGF, Exn, true);
3918 return;
3919 }
3920
3921 // Emit the local.
3922 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
3923 InitCatchParam(CGF, *CatchParam, var.getObjectAddress(CGF), S->getLocStart());
3924 CGF.EmitAutoVarCleanups(var);
3925}
3926
3927/// Get or define the following function:
3928/// void @__clang_call_terminate(i8* %exn) nounwind noreturn
3929/// This code is used only in C++.
3930static llvm::Constant *getClangCallTerminateFn(CodeGenModule &CGM) {
3931 llvm::FunctionType *fnTy =
3932 llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
Reid Klecknerde864822017-03-21 16:57:30 +00003933 llvm::Constant *fnRef = CGM.CreateRuntimeFunction(
3934 fnTy, "__clang_call_terminate", llvm::AttributeList(), /*Local=*/true);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003935
3936 llvm::Function *fn = dyn_cast<llvm::Function>(fnRef);
3937 if (fn && fn->empty()) {
3938 fn->setDoesNotThrow();
3939 fn->setDoesNotReturn();
3940
3941 // What we really want is to massively penalize inlining without
3942 // forbidding it completely. The difference between that and
3943 // 'noinline' is negligible.
3944 fn->addFnAttr(llvm::Attribute::NoInline);
3945
3946 // Allow this function to be shared across translation units, but
3947 // we don't want it to turn into an exported symbol.
3948 fn->setLinkage(llvm::Function::LinkOnceODRLinkage);
3949 fn->setVisibility(llvm::Function::HiddenVisibility);
NAKAMURA Takumic7da6da2015-05-09 21:10:07 +00003950 if (CGM.supportsCOMDAT())
3951 fn->setComdat(CGM.getModule().getOrInsertComdat(fn->getName()));
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003952
3953 // Set up the function.
3954 llvm::BasicBlock *entry =
3955 llvm::BasicBlock::Create(CGM.getLLVMContext(), "", fn);
John McCall7f416cc2015-09-08 08:05:57 +00003956 CGBuilderTy builder(CGM, entry);
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003957
3958 // Pull the exception pointer out of the parameter list.
3959 llvm::Value *exn = &*fn->arg_begin();
3960
3961 // Call __cxa_begin_catch(exn).
3962 llvm::CallInst *catchCall = builder.CreateCall(getBeginCatchFn(CGM), exn);
3963 catchCall->setDoesNotThrow();
3964 catchCall->setCallingConv(CGM.getRuntimeCC());
3965
3966 // Call std::terminate().
David Blaikie4ba525b2015-07-14 17:27:39 +00003967 llvm::CallInst *termCall = builder.CreateCall(CGM.getTerminateFn());
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003968 termCall->setDoesNotThrow();
3969 termCall->setDoesNotReturn();
3970 termCall->setCallingConv(CGM.getRuntimeCC());
3971
3972 // std::terminate cannot return.
3973 builder.CreateUnreachable();
3974 }
3975
3976 return fnRef;
3977}
3978
3979llvm::CallInst *
3980ItaniumCXXABI::emitTerminateForUnexpectedException(CodeGenFunction &CGF,
3981 llvm::Value *Exn) {
3982 // In C++, we want to call __cxa_begin_catch() before terminating.
3983 if (Exn) {
3984 assert(CGF.CGM.getLangOpts().CPlusPlus);
3985 return CGF.EmitNounwindRuntimeCall(getClangCallTerminateFn(CGF.CGM), Exn);
3986 }
3987 return CGF.EmitNounwindRuntimeCall(CGF.CGM.getTerminateFn());
3988}