blob: 62f1293ff66753f32671eeee4b0334bbd13cbb35 [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"
Craig Topperc9ee1d02012-09-15 18:47:51 +000028#include "clang/AST/Mangle.h"
29#include "clang/AST/Type.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000030#include "clang/AST/StmtCXX.h"
David Majnemer1162d252014-06-22 19:05:33 +000031#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000032#include "llvm/IR/DataLayout.h"
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000033#include "llvm/IR/Instructions.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000034#include "llvm/IR/Intrinsics.h"
35#include "llvm/IR/Value.h"
Charles Davis4e786dd2010-05-25 19:52:27 +000036
37using namespace clang;
John McCall475999d2010-08-22 00:05:51 +000038using namespace CodeGen;
Charles Davis4e786dd2010-05-25 19:52:27 +000039
40namespace {
Charles Davis53c59df2010-08-16 03:33:14 +000041class ItaniumCXXABI : public CodeGen::CGCXXABI {
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +000042 /// VTables - All the vtables which have been defined.
43 llvm::DenseMap<const CXXRecordDecl *, llvm::GlobalVariable *> VTables;
44
John McCall475999d2010-08-22 00:05:51 +000045protected:
Mark Seabornedf0d382013-07-24 16:25:13 +000046 bool UseARMMethodPtrABI;
47 bool UseARMGuardVarABI;
John McCall7a9aac22010-08-23 01:21:21 +000048
Timur Iskhodzhanov67455222013-10-03 06:26:13 +000049 ItaniumMangleContext &getMangleContext() {
50 return cast<ItaniumMangleContext>(CodeGen::CGCXXABI::getMangleContext());
51 }
52
Charles Davis4e786dd2010-05-25 19:52:27 +000053public:
Mark Seabornedf0d382013-07-24 16:25:13 +000054 ItaniumCXXABI(CodeGen::CodeGenModule &CGM,
55 bool UseARMMethodPtrABI = false,
56 bool UseARMGuardVarABI = false) :
57 CGCXXABI(CGM), UseARMMethodPtrABI(UseARMMethodPtrABI),
58 UseARMGuardVarABI(UseARMGuardVarABI) { }
John McCall475999d2010-08-22 00:05:51 +000059
Reid Kleckner40ca9132014-05-13 22:05:45 +000060 bool classifyReturnType(CGFunctionInfo &FI) const override;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000061
Craig Topper4f12f102014-03-12 06:41:41 +000062 RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const override {
Reid Klecknerd355ca72014-05-15 01:26:32 +000063 // Structures with either a non-trivial destructor or a non-trivial
64 // copy constructor are always indirect.
65 // FIXME: Use canCopyArgument() when it is fixed to handle lazily declared
66 // special members.
67 if (RD->hasNonTrivialDestructor() || RD->hasNonTrivialCopyConstructor())
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +000068 return RAA_Indirect;
69 return RAA_Default;
70 }
71
Craig Topper4f12f102014-03-12 06:41:41 +000072 bool isZeroInitializable(const MemberPointerType *MPT) override;
John McCall84fa5102010-08-22 04:16:24 +000073
Craig Topper4f12f102014-03-12 06:41:41 +000074 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT) override;
John McCall7a9aac22010-08-23 01:21:21 +000075
Craig Topper4f12f102014-03-12 06:41:41 +000076 llvm::Value *
77 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF,
78 const Expr *E,
79 llvm::Value *&This,
80 llvm::Value *MemFnPtr,
81 const MemberPointerType *MPT) override;
John McCalla8bbb822010-08-22 03:04:22 +000082
Craig Topper4f12f102014-03-12 06:41:41 +000083 llvm::Value *
84 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
85 llvm::Value *Base,
86 llvm::Value *MemPtr,
87 const MemberPointerType *MPT) override;
John McCallc134eb52010-08-31 21:07:20 +000088
John McCall7a9aac22010-08-23 01:21:21 +000089 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
90 const CastExpr *E,
Craig Topper4f12f102014-03-12 06:41:41 +000091 llvm::Value *Src) override;
John McCallc62bb392012-02-15 01:22:51 +000092 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
Craig Topper4f12f102014-03-12 06:41:41 +000093 llvm::Constant *Src) override;
John McCall84fa5102010-08-22 04:16:24 +000094
Craig Topper4f12f102014-03-12 06:41:41 +000095 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT) override;
John McCall84fa5102010-08-22 04:16:24 +000096
Craig Topper4f12f102014-03-12 06:41:41 +000097 llvm::Constant *EmitMemberPointer(const CXXMethodDecl *MD) override;
John McCallf3a88602011-02-03 08:15:49 +000098 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
Craig Topper4f12f102014-03-12 06:41:41 +000099 CharUnits offset) override;
100 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT) override;
Richard Smithdafff942012-01-14 04:30:29 +0000101 llvm::Constant *BuildMemberPointer(const CXXMethodDecl *MD,
102 CharUnits ThisAdjustment);
John McCall1c456c82010-08-22 06:43:33 +0000103
John McCall7a9aac22010-08-23 01:21:21 +0000104 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000105 llvm::Value *L, llvm::Value *R,
John McCall7a9aac22010-08-23 01:21:21 +0000106 const MemberPointerType *MPT,
Craig Topper4f12f102014-03-12 06:41:41 +0000107 bool Inequality) override;
John McCall131d97d2010-08-22 08:30:07 +0000108
John McCall7a9aac22010-08-23 01:21:21 +0000109 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +0000110 llvm::Value *Addr,
111 const MemberPointerType *MPT) override;
John McCall5d865c322010-08-31 07:33:07 +0000112
David Majnemer08681372014-11-01 07:37:17 +0000113 void emitVirtualObjectDelete(CodeGenFunction &CGF, const CXXDeleteExpr *DE,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000114 llvm::Value *Ptr, QualType ElementType,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000115 const CXXDestructorDecl *Dtor) override;
John McCall82fb8922012-09-25 10:10:39 +0000116
David Majnemer442d0a22014-11-25 07:20:20 +0000117 void emitRethrow(CodeGenFunction &CGF, bool isNoReturn) override;
David Majnemer7c237072015-03-05 00:46:22 +0000118 void emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) override;
David Majnemer442d0a22014-11-25 07:20:20 +0000119
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000120 void emitBeginCatch(CodeGenFunction &CGF, const CXXCatchStmt *C) override;
121
122 llvm::CallInst *
123 emitTerminateForUnexpectedException(CodeGenFunction &CGF,
124 llvm::Value *Exn) override;
125
David Majnemere2cb8d12014-07-07 06:20:47 +0000126 void EmitFundamentalRTTIDescriptor(QualType Type);
127 void EmitFundamentalRTTIDescriptors();
David Majnemer443250f2015-03-17 20:35:00 +0000128 llvm::Constant *getAddrOfRTTIDescriptor(QualType Ty) override;
Justin Bogner0729afa2015-03-17 22:31:34 +0000129 llvm::Constant *
David Majnemer37b417f2015-03-29 21:55:10 +0000130 getAddrOfCXXCatchHandlerType(QualType Ty,
131 QualType CatchHandlerType) override {
David Majnemer443250f2015-03-17 20:35:00 +0000132 return getAddrOfRTTIDescriptor(Ty);
133 }
David Majnemere2cb8d12014-07-07 06:20:47 +0000134
David Majnemer1162d252014-06-22 19:05:33 +0000135 bool shouldTypeidBeNullChecked(bool IsDeref, QualType SrcRecordTy) override;
136 void EmitBadTypeidCall(CodeGenFunction &CGF) override;
137 llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy,
138 llvm::Value *ThisPtr,
139 llvm::Type *StdTypeInfoPtrTy) override;
140
141 bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
142 QualType SrcRecordTy) override;
143
144 llvm::Value *EmitDynamicCastCall(CodeGenFunction &CGF, llvm::Value *Value,
145 QualType SrcRecordTy, QualType DestTy,
146 QualType DestRecordTy,
147 llvm::BasicBlock *CastEnd) override;
148
149 llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF, llvm::Value *Value,
150 QualType SrcRecordTy,
151 QualType DestTy) override;
152
153 bool EmitBadCastCall(CodeGenFunction &CGF) override;
154
Craig Topper4f12f102014-03-12 06:41:41 +0000155 llvm::Value *
156 GetVirtualBaseClassOffset(CodeGenFunction &CGF, llvm::Value *This,
157 const CXXRecordDecl *ClassDecl,
158 const CXXRecordDecl *BaseClassDecl) override;
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000159
Craig Topper4f12f102014-03-12 06:41:41 +0000160 void EmitCXXConstructors(const CXXConstructorDecl *D) override;
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000161
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000162 void buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
163 SmallVectorImpl<CanQualType> &ArgTys) override;
John McCall5d865c322010-08-31 07:33:07 +0000164
Reid Klecknere7de47e2013-07-22 13:51:44 +0000165 bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
Craig Topper4f12f102014-03-12 06:41:41 +0000166 CXXDtorType DT) const override {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000167 // Itanium does not emit any destructor variant as an inline thunk.
168 // Delegating may occur as an optimization, but all variants are either
169 // emitted with external linkage or as linkonce if they are inline and used.
170 return false;
171 }
172
Craig Topper4f12f102014-03-12 06:41:41 +0000173 void EmitCXXDestructors(const CXXDestructorDecl *D) override;
Reid Klecknere7de47e2013-07-22 13:51:44 +0000174
Reid Kleckner89077a12013-12-17 19:46:40 +0000175 void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
Craig Topper4f12f102014-03-12 06:41:41 +0000176 FunctionArgList &Params) override;
John McCall5d865c322010-08-31 07:33:07 +0000177
Craig Topper4f12f102014-03-12 06:41:41 +0000178 void EmitInstanceFunctionProlog(CodeGenFunction &CGF) override;
John McCall8ed55a52010-09-02 09:58:18 +0000179
Reid Kleckner89077a12013-12-17 19:46:40 +0000180 unsigned addImplicitConstructorArgs(CodeGenFunction &CGF,
181 const CXXConstructorDecl *D,
182 CXXCtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000183 bool Delegating,
184 CallArgList &Args) override;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000185
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000186 void EmitDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *DD,
187 CXXDtorType Type, bool ForVirtualBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000188 bool Delegating, llvm::Value *This) override;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000189
Craig Topper4f12f102014-03-12 06:41:41 +0000190 void emitVTableDefinitions(CodeGenVTables &CGVT,
191 const CXXRecordDecl *RD) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000192
193 llvm::Value *getVTableAddressPointInStructor(
194 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass,
195 BaseSubobject Base, const CXXRecordDecl *NearestVBase,
Craig Topper4f12f102014-03-12 06:41:41 +0000196 bool &NeedsVirtualOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000197
198 llvm::Constant *
199 getVTableAddressPointForConstExpr(BaseSubobject Base,
Craig Topper4f12f102014-03-12 06:41:41 +0000200 const CXXRecordDecl *VTableClass) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000201
202 llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
Craig Topper4f12f102014-03-12 06:41:41 +0000203 CharUnits VPtrOffset) override;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000204
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000205 llvm::Value *getVirtualFunctionPointer(CodeGenFunction &CGF, GlobalDecl GD,
Craig Topper4f12f102014-03-12 06:41:41 +0000206 llvm::Value *This,
207 llvm::Type *Ty) override;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000208
David Majnemer0c0b6d92014-10-31 20:09:12 +0000209 llvm::Value *EmitVirtualDestructorCall(CodeGenFunction &CGF,
210 const CXXDestructorDecl *Dtor,
211 CXXDtorType DtorType,
212 llvm::Value *This,
213 const CXXMemberCallExpr *CE) override;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000214
Craig Topper4f12f102014-03-12 06:41:41 +0000215 void emitVirtualInheritanceTables(const CXXRecordDecl *RD) override;
Reid Kleckner7810af02013-06-19 15:20:38 +0000216
Hans Wennborgc94391d2014-06-06 20:04:01 +0000217 void setThunkLinkage(llvm::Function *Thunk, bool ForVTable, GlobalDecl GD,
218 bool ReturnAdjustment) override {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000219 // Allow inlining of thunks by emitting them with available_externally
220 // linkage together with vtables when needed.
221 if (ForVTable)
222 Thunk->setLinkage(llvm::GlobalValue::AvailableExternallyLinkage);
223 }
224
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000225 llvm::Value *performThisAdjustment(CodeGenFunction &CGF, llvm::Value *This,
Craig Topper4f12f102014-03-12 06:41:41 +0000226 const ThisAdjustment &TA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000227
228 llvm::Value *performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
Craig Topper4f12f102014-03-12 06:41:41 +0000229 const ReturnAdjustment &RA) override;
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000230
David Majnemer196ac332014-09-11 23:05:02 +0000231 size_t getSrcArgforCopyCtor(const CXXConstructorDecl *,
232 FunctionArgList &Args) const override {
233 assert(!Args.empty() && "expected the arglist to not be empty!");
234 return Args.size() - 1;
235 }
236
Craig Topper4f12f102014-03-12 06:41:41 +0000237 StringRef GetPureVirtualCallName() override { return "__cxa_pure_virtual"; }
238 StringRef GetDeletedVirtualCallName() override
239 { return "__cxa_deleted_virtual"; }
Joao Matos2ce88ef2012-07-17 17:10:11 +0000240
Craig Topper4f12f102014-03-12 06:41:41 +0000241 CharUnits getArrayCookieSizeImpl(QualType elementType) override;
John McCall8ed55a52010-09-02 09:58:18 +0000242 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
243 llvm::Value *NewPtr,
244 llvm::Value *NumElements,
John McCall284c48f2011-01-27 09:37:56 +0000245 const CXXNewExpr *expr,
Craig Topper4f12f102014-03-12 06:41:41 +0000246 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000247 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF,
248 llvm::Value *allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000249 CharUnits cookieSize) override;
John McCall68ff0372010-09-08 01:44:27 +0000250
John McCallcdf7ef52010-11-06 09:44:32 +0000251 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Craig Topper4f12f102014-03-12 06:41:41 +0000252 llvm::GlobalVariable *DeclPtr,
253 bool PerformInit) override;
Richard Smithdbf74ba2013-04-14 23:01:42 +0000254 void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
Craig Topper4f12f102014-03-12 06:41:41 +0000255 llvm::Constant *dtor, llvm::Constant *addr) override;
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000256
257 llvm::Function *getOrCreateThreadLocalWrapper(const VarDecl *VD,
Alexander Musmanf94c3182014-09-26 06:28:25 +0000258 llvm::Value *Val);
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000259 void EmitThreadLocalInitFuncs(
David Majnemerb3341ea2014-10-05 05:05:40 +0000260 CodeGenModule &CGM,
261 ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *>>
262 CXXThreadLocals,
263 ArrayRef<llvm::Function *> CXXThreadLocalInits,
264 ArrayRef<llvm::GlobalVariable *> CXXThreadLocalInitVars) override;
265
266 bool usesThreadWrapperFunction() const override { return true; }
Richard Smith0f383742014-03-26 22:48:22 +0000267 LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF, const VarDecl *VD,
268 QualType LValType) override;
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000269
Craig Topper4f12f102014-03-12 06:41:41 +0000270 bool NeedsVTTParameter(GlobalDecl GD) override;
David Majnemere2cb8d12014-07-07 06:20:47 +0000271
272 /**************************** RTTI Uniqueness ******************************/
273
274protected:
275 /// Returns true if the ABI requires RTTI type_info objects to be unique
276 /// across a program.
277 virtual bool shouldRTTIBeUnique() const { return true; }
278
279public:
280 /// What sort of unique-RTTI behavior should we use?
281 enum RTTIUniquenessKind {
282 /// We are guaranteeing, or need to guarantee, that the RTTI string
283 /// is unique.
284 RUK_Unique,
285
286 /// We are not guaranteeing uniqueness for the RTTI string, so we
287 /// can demote to hidden visibility but must use string comparisons.
288 RUK_NonUniqueHidden,
289
290 /// We are not guaranteeing uniqueness for the RTTI string, so we
291 /// have to use string comparisons, but we also have to emit it with
292 /// non-hidden visibility.
293 RUK_NonUniqueVisible
294 };
295
296 /// Return the required visibility status for the given type and linkage in
297 /// the current ABI.
298 RTTIUniquenessKind
299 classifyRTTIUniqueness(QualType CanTy,
300 llvm::GlobalValue::LinkageTypes Linkage) const;
301 friend class ItaniumRTTIBuilder;
Rafael Espindola91f68b42014-09-15 19:20:10 +0000302
303 void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) override;
Charles Davis4e786dd2010-05-25 19:52:27 +0000304};
John McCall86353412010-08-21 22:46:04 +0000305
306class ARMCXXABI : public ItaniumCXXABI {
307public:
Mark Seabornedf0d382013-07-24 16:25:13 +0000308 ARMCXXABI(CodeGen::CodeGenModule &CGM) :
309 ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true,
310 /* UseARMGuardVarABI = */ true) {}
John McCall5d865c322010-08-31 07:33:07 +0000311
Craig Topper4f12f102014-03-12 06:41:41 +0000312 bool HasThisReturn(GlobalDecl GD) const override {
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000313 return (isa<CXXConstructorDecl>(GD.getDecl()) || (
314 isa<CXXDestructorDecl>(GD.getDecl()) &&
315 GD.getDtorType() != Dtor_Deleting));
316 }
John McCall5d865c322010-08-31 07:33:07 +0000317
Craig Topper4f12f102014-03-12 06:41:41 +0000318 void EmitReturnFromThunk(CodeGenFunction &CGF, RValue RV,
319 QualType ResTy) override;
John McCall5d865c322010-08-31 07:33:07 +0000320
Craig Topper4f12f102014-03-12 06:41:41 +0000321 CharUnits getArrayCookieSizeImpl(QualType elementType) override;
John McCall8ed55a52010-09-02 09:58:18 +0000322 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
323 llvm::Value *NewPtr,
324 llvm::Value *NumElements,
John McCall284c48f2011-01-27 09:37:56 +0000325 const CXXNewExpr *expr,
Craig Topper4f12f102014-03-12 06:41:41 +0000326 QualType ElementType) override;
John McCallb91cd662012-05-01 05:23:51 +0000327 llvm::Value *readArrayCookieImpl(CodeGenFunction &CGF, llvm::Value *allocPtr,
Craig Topper4f12f102014-03-12 06:41:41 +0000328 CharUnits cookieSize) override;
John McCall86353412010-08-21 22:46:04 +0000329};
Tim Northovera2ee4332014-03-29 15:09:45 +0000330
331class iOS64CXXABI : public ARMCXXABI {
332public:
333 iOS64CXXABI(CodeGen::CodeGenModule &CGM) : ARMCXXABI(CGM) {}
Tim Northover65f582f2014-03-30 17:32:48 +0000334
335 // ARM64 libraries are prepared for non-unique RTTI.
David Majnemere2cb8d12014-07-07 06:20:47 +0000336 bool shouldRTTIBeUnique() const override { return false; }
Tim Northovera2ee4332014-03-29 15:09:45 +0000337};
Charles Davis4e786dd2010-05-25 19:52:27 +0000338}
339
Charles Davis53c59df2010-08-16 03:33:14 +0000340CodeGen::CGCXXABI *CodeGen::CreateItaniumCXXABI(CodeGenModule &CGM) {
John McCallc8e01702013-04-16 22:48:15 +0000341 switch (CGM.getTarget().getCXXABI().getKind()) {
John McCall57625922013-01-25 23:36:14 +0000342 // For IR-generation purposes, there's no significant difference
343 // between the ARM and iOS ABIs.
344 case TargetCXXABI::GenericARM:
345 case TargetCXXABI::iOS:
346 return new ARMCXXABI(CGM);
Charles Davis4e786dd2010-05-25 19:52:27 +0000347
Tim Northovera2ee4332014-03-29 15:09:45 +0000348 case TargetCXXABI::iOS64:
349 return new iOS64CXXABI(CGM);
350
Tim Northover9bb857a2013-01-31 12:13:10 +0000351 // Note that AArch64 uses the generic ItaniumCXXABI class since it doesn't
352 // include the other 32-bit ARM oddities: constructor/destructor return values
353 // and array cookies.
354 case TargetCXXABI::GenericAArch64:
Mark Seabornedf0d382013-07-24 16:25:13 +0000355 return new ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true,
356 /* UseARMGuardVarABI = */ true);
Tim Northover9bb857a2013-01-31 12:13:10 +0000357
Zoran Jovanovic26a12162015-02-18 15:21:35 +0000358 case TargetCXXABI::GenericMIPS:
359 return new ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true);
360
John McCall57625922013-01-25 23:36:14 +0000361 case TargetCXXABI::GenericItanium:
Mark Seabornedf0d382013-07-24 16:25:13 +0000362 if (CGM.getContext().getTargetInfo().getTriple().getArch()
363 == llvm::Triple::le32) {
364 // For PNaCl, use ARM-style method pointers so that PNaCl code
365 // does not assume anything about the alignment of function
366 // pointers.
367 return new ItaniumCXXABI(CGM, /* UseARMMethodPtrABI = */ true,
368 /* UseARMGuardVarABI = */ false);
369 }
John McCall57625922013-01-25 23:36:14 +0000370 return new ItaniumCXXABI(CGM);
371
372 case TargetCXXABI::Microsoft:
373 llvm_unreachable("Microsoft ABI is not Itanium-based");
374 }
375 llvm_unreachable("bad ABI kind");
John McCall86353412010-08-21 22:46:04 +0000376}
377
Chris Lattnera5f58b02011-07-09 17:41:47 +0000378llvm::Type *
John McCall7a9aac22010-08-23 01:21:21 +0000379ItaniumCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
380 if (MPT->isMemberDataPointer())
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000381 return CGM.PtrDiffTy;
Reid Kleckneree7cf842014-12-01 22:02:27 +0000382 return llvm::StructType::get(CGM.PtrDiffTy, CGM.PtrDiffTy, nullptr);
John McCall1c456c82010-08-22 06:43:33 +0000383}
384
John McCalld9c6c0b2010-08-22 00:59:17 +0000385/// In the Itanium and ARM ABIs, method pointers have the form:
386/// struct { ptrdiff_t ptr; ptrdiff_t adj; } memptr;
387///
388/// In the Itanium ABI:
389/// - method pointers are virtual if (memptr.ptr & 1) is nonzero
390/// - the this-adjustment is (memptr.adj)
391/// - the virtual offset is (memptr.ptr - 1)
392///
393/// In the ARM ABI:
394/// - method pointers are virtual if (memptr.adj & 1) is nonzero
395/// - the this-adjustment is (memptr.adj >> 1)
396/// - the virtual offset is (memptr.ptr)
397/// ARM uses 'adj' for the virtual flag because Thumb functions
398/// may be only single-byte aligned.
399///
400/// If the member is virtual, the adjusted 'this' pointer points
401/// to a vtable pointer from which the virtual offset is applied.
402///
403/// If the member is non-virtual, memptr.ptr is the address of
404/// the function to call.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000405llvm::Value *ItaniumCXXABI::EmitLoadOfMemberFunctionPointer(
406 CodeGenFunction &CGF, const Expr *E, llvm::Value *&This,
407 llvm::Value *MemFnPtr, const MemberPointerType *MPT) {
John McCall475999d2010-08-22 00:05:51 +0000408 CGBuilderTy &Builder = CGF.Builder;
409
410 const FunctionProtoType *FPT =
411 MPT->getPointeeType()->getAs<FunctionProtoType>();
412 const CXXRecordDecl *RD =
413 cast<CXXRecordDecl>(MPT->getClass()->getAs<RecordType>()->getDecl());
414
Chris Lattner2192fe52011-07-18 04:24:23 +0000415 llvm::FunctionType *FTy =
John McCalla729c622012-02-17 03:33:10 +0000416 CGM.getTypes().GetFunctionType(
417 CGM.getTypes().arrangeCXXMethodType(RD, FPT));
John McCall475999d2010-08-22 00:05:51 +0000418
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000419 llvm::Constant *ptrdiff_1 = llvm::ConstantInt::get(CGM.PtrDiffTy, 1);
John McCall475999d2010-08-22 00:05:51 +0000420
John McCalld9c6c0b2010-08-22 00:59:17 +0000421 llvm::BasicBlock *FnVirtual = CGF.createBasicBlock("memptr.virtual");
422 llvm::BasicBlock *FnNonVirtual = CGF.createBasicBlock("memptr.nonvirtual");
423 llvm::BasicBlock *FnEnd = CGF.createBasicBlock("memptr.end");
424
John McCalla1dee5302010-08-22 10:59:02 +0000425 // Extract memptr.adj, which is in the second field.
426 llvm::Value *RawAdj = Builder.CreateExtractValue(MemFnPtr, 1, "memptr.adj");
John McCalld9c6c0b2010-08-22 00:59:17 +0000427
428 // Compute the true adjustment.
429 llvm::Value *Adj = RawAdj;
Mark Seabornedf0d382013-07-24 16:25:13 +0000430 if (UseARMMethodPtrABI)
John McCalld9c6c0b2010-08-22 00:59:17 +0000431 Adj = Builder.CreateAShr(Adj, ptrdiff_1, "memptr.adj.shifted");
John McCall475999d2010-08-22 00:05:51 +0000432
433 // Apply the adjustment and cast back to the original struct type
434 // for consistency.
John McCalld9c6c0b2010-08-22 00:59:17 +0000435 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy());
436 Ptr = Builder.CreateInBoundsGEP(Ptr, Adj);
437 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted");
John McCall475999d2010-08-22 00:05:51 +0000438
439 // Load the function pointer.
John McCalla1dee5302010-08-22 10:59:02 +0000440 llvm::Value *FnAsInt = Builder.CreateExtractValue(MemFnPtr, 0, "memptr.ptr");
John McCall475999d2010-08-22 00:05:51 +0000441
442 // If the LSB in the function pointer is 1, the function pointer points to
443 // a virtual function.
John McCalld9c6c0b2010-08-22 00:59:17 +0000444 llvm::Value *IsVirtual;
Mark Seabornedf0d382013-07-24 16:25:13 +0000445 if (UseARMMethodPtrABI)
John McCalld9c6c0b2010-08-22 00:59:17 +0000446 IsVirtual = Builder.CreateAnd(RawAdj, ptrdiff_1);
447 else
448 IsVirtual = Builder.CreateAnd(FnAsInt, ptrdiff_1);
449 IsVirtual = Builder.CreateIsNotNull(IsVirtual, "memptr.isvirtual");
John McCall475999d2010-08-22 00:05:51 +0000450 Builder.CreateCondBr(IsVirtual, FnVirtual, FnNonVirtual);
451
452 // In the virtual path, the adjustment left 'This' pointing to the
453 // vtable of the correct base subobject. The "function pointer" is an
John McCalld9c6c0b2010-08-22 00:59:17 +0000454 // offset within the vtable (+1 for the virtual flag on non-ARM).
John McCall475999d2010-08-22 00:05:51 +0000455 CGF.EmitBlock(FnVirtual);
456
457 // Cast the adjusted this to a pointer to vtable pointer and load.
Chris Lattner2192fe52011-07-18 04:24:23 +0000458 llvm::Type *VTableTy = Builder.getInt8PtrTy();
Richard Smith0fc7bdc2014-03-12 18:26:14 +0000459 llvm::Value *VTable = CGF.GetVTablePtr(This, VTableTy);
John McCall475999d2010-08-22 00:05:51 +0000460
461 // Apply the offset.
John McCalld9c6c0b2010-08-22 00:59:17 +0000462 llvm::Value *VTableOffset = FnAsInt;
Mark Seabornedf0d382013-07-24 16:25:13 +0000463 if (!UseARMMethodPtrABI)
464 VTableOffset = Builder.CreateSub(VTableOffset, ptrdiff_1);
John McCalld9c6c0b2010-08-22 00:59:17 +0000465 VTable = Builder.CreateGEP(VTable, VTableOffset);
John McCall475999d2010-08-22 00:05:51 +0000466
467 // Load the virtual function to call.
468 VTable = Builder.CreateBitCast(VTable, FTy->getPointerTo()->getPointerTo());
John McCalld9c6c0b2010-08-22 00:59:17 +0000469 llvm::Value *VirtualFn = Builder.CreateLoad(VTable, "memptr.virtualfn");
John McCall475999d2010-08-22 00:05:51 +0000470 CGF.EmitBranch(FnEnd);
471
472 // In the non-virtual path, the function pointer is actually a
473 // function pointer.
474 CGF.EmitBlock(FnNonVirtual);
475 llvm::Value *NonVirtualFn =
John McCalld9c6c0b2010-08-22 00:59:17 +0000476 Builder.CreateIntToPtr(FnAsInt, FTy->getPointerTo(), "memptr.nonvirtualfn");
John McCall475999d2010-08-22 00:05:51 +0000477
478 // We're done.
479 CGF.EmitBlock(FnEnd);
Jay Foad20c0f022011-03-30 11:28:58 +0000480 llvm::PHINode *Callee = Builder.CreatePHI(FTy->getPointerTo(), 2);
John McCall475999d2010-08-22 00:05:51 +0000481 Callee->addIncoming(VirtualFn, FnVirtual);
482 Callee->addIncoming(NonVirtualFn, FnNonVirtual);
483 return Callee;
484}
John McCalla8bbb822010-08-22 03:04:22 +0000485
John McCallc134eb52010-08-31 21:07:20 +0000486/// Compute an l-value by applying the given pointer-to-member to a
487/// base object.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000488llvm::Value *ItaniumCXXABI::EmitMemberDataPointerAddress(
489 CodeGenFunction &CGF, const Expr *E, llvm::Value *Base, llvm::Value *MemPtr,
490 const MemberPointerType *MPT) {
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000491 assert(MemPtr->getType() == CGM.PtrDiffTy);
John McCallc134eb52010-08-31 21:07:20 +0000492
493 CGBuilderTy &Builder = CGF.Builder;
494
Micah Villmowea2fea22012-10-25 15:39:14 +0000495 unsigned AS = Base->getType()->getPointerAddressSpace();
John McCallc134eb52010-08-31 21:07:20 +0000496
497 // Cast to char*.
498 Base = Builder.CreateBitCast(Base, Builder.getInt8Ty()->getPointerTo(AS));
499
500 // Apply the offset, which we assume is non-null.
501 llvm::Value *Addr = Builder.CreateInBoundsGEP(Base, MemPtr, "memptr.offset");
502
503 // Cast the address to the appropriate pointer type, adopting the
504 // address space of the base pointer.
Chris Lattner2192fe52011-07-18 04:24:23 +0000505 llvm::Type *PType
Douglas Gregor04f36212010-09-02 17:38:50 +0000506 = CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
John McCallc134eb52010-08-31 21:07:20 +0000507 return Builder.CreateBitCast(Addr, PType);
508}
509
John McCallc62bb392012-02-15 01:22:51 +0000510/// Perform a bitcast, derived-to-base, or base-to-derived member pointer
511/// conversion.
512///
513/// Bitcast conversions are always a no-op under Itanium.
John McCall7a9aac22010-08-23 01:21:21 +0000514///
515/// Obligatory offset/adjustment diagram:
516/// <-- offset --> <-- adjustment -->
517/// |--------------------------|----------------------|--------------------|
518/// ^Derived address point ^Base address point ^Member address point
519///
520/// So when converting a base member pointer to a derived member pointer,
521/// we add the offset to the adjustment because the address point has
522/// decreased; and conversely, when converting a derived MP to a base MP
523/// we subtract the offset from the adjustment because the address point
524/// has increased.
525///
526/// The standard forbids (at compile time) conversion to and from
527/// virtual bases, which is why we don't have to consider them here.
528///
529/// The standard forbids (at run time) casting a derived MP to a base
530/// MP when the derived MP does not point to a member of the base.
531/// This is why -1 is a reasonable choice for null data member
532/// pointers.
John McCalla1dee5302010-08-22 10:59:02 +0000533llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000534ItaniumCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
535 const CastExpr *E,
John McCallc62bb392012-02-15 01:22:51 +0000536 llvm::Value *src) {
John McCalle3027922010-08-25 11:45:40 +0000537 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
John McCallc62bb392012-02-15 01:22:51 +0000538 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
539 E->getCastKind() == CK_ReinterpretMemberPointer);
540
541 // Under Itanium, reinterprets don't require any additional processing.
542 if (E->getCastKind() == CK_ReinterpretMemberPointer) return src;
543
544 // Use constant emission if we can.
545 if (isa<llvm::Constant>(src))
546 return EmitMemberPointerConversion(E, cast<llvm::Constant>(src));
547
548 llvm::Constant *adj = getMemberPointerAdjustment(E);
549 if (!adj) return src;
John McCalla8bbb822010-08-22 03:04:22 +0000550
551 CGBuilderTy &Builder = CGF.Builder;
John McCallc62bb392012-02-15 01:22:51 +0000552 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
John McCalla8bbb822010-08-22 03:04:22 +0000553
John McCallc62bb392012-02-15 01:22:51 +0000554 const MemberPointerType *destTy =
555 E->getType()->castAs<MemberPointerType>();
John McCall1c456c82010-08-22 06:43:33 +0000556
John McCall7a9aac22010-08-23 01:21:21 +0000557 // For member data pointers, this is just a matter of adding the
558 // offset if the source is non-null.
John McCallc62bb392012-02-15 01:22:51 +0000559 if (destTy->isMemberDataPointer()) {
560 llvm::Value *dst;
561 if (isDerivedToBase)
562 dst = Builder.CreateNSWSub(src, adj, "adj");
John McCall7a9aac22010-08-23 01:21:21 +0000563 else
John McCallc62bb392012-02-15 01:22:51 +0000564 dst = Builder.CreateNSWAdd(src, adj, "adj");
John McCall7a9aac22010-08-23 01:21:21 +0000565
566 // Null check.
John McCallc62bb392012-02-15 01:22:51 +0000567 llvm::Value *null = llvm::Constant::getAllOnesValue(src->getType());
568 llvm::Value *isNull = Builder.CreateICmpEQ(src, null, "memptr.isnull");
569 return Builder.CreateSelect(isNull, src, dst);
John McCall7a9aac22010-08-23 01:21:21 +0000570 }
571
John McCalla1dee5302010-08-22 10:59:02 +0000572 // The this-adjustment is left-shifted by 1 on ARM.
Mark Seabornedf0d382013-07-24 16:25:13 +0000573 if (UseARMMethodPtrABI) {
John McCallc62bb392012-02-15 01:22:51 +0000574 uint64_t offset = cast<llvm::ConstantInt>(adj)->getZExtValue();
575 offset <<= 1;
576 adj = llvm::ConstantInt::get(adj->getType(), offset);
John McCalla1dee5302010-08-22 10:59:02 +0000577 }
578
John McCallc62bb392012-02-15 01:22:51 +0000579 llvm::Value *srcAdj = Builder.CreateExtractValue(src, 1, "src.adj");
580 llvm::Value *dstAdj;
581 if (isDerivedToBase)
582 dstAdj = Builder.CreateNSWSub(srcAdj, adj, "adj");
John McCalla1dee5302010-08-22 10:59:02 +0000583 else
John McCallc62bb392012-02-15 01:22:51 +0000584 dstAdj = Builder.CreateNSWAdd(srcAdj, adj, "adj");
John McCalla1dee5302010-08-22 10:59:02 +0000585
John McCallc62bb392012-02-15 01:22:51 +0000586 return Builder.CreateInsertValue(src, dstAdj, 1);
587}
588
589llvm::Constant *
590ItaniumCXXABI::EmitMemberPointerConversion(const CastExpr *E,
591 llvm::Constant *src) {
592 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
593 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
594 E->getCastKind() == CK_ReinterpretMemberPointer);
595
596 // Under Itanium, reinterprets don't require any additional processing.
597 if (E->getCastKind() == CK_ReinterpretMemberPointer) return src;
598
599 // If the adjustment is trivial, we don't need to do anything.
600 llvm::Constant *adj = getMemberPointerAdjustment(E);
601 if (!adj) return src;
602
603 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
604
605 const MemberPointerType *destTy =
606 E->getType()->castAs<MemberPointerType>();
607
608 // For member data pointers, this is just a matter of adding the
609 // offset if the source is non-null.
610 if (destTy->isMemberDataPointer()) {
611 // null maps to null.
612 if (src->isAllOnesValue()) return src;
613
614 if (isDerivedToBase)
615 return llvm::ConstantExpr::getNSWSub(src, adj);
616 else
617 return llvm::ConstantExpr::getNSWAdd(src, adj);
618 }
619
620 // The this-adjustment is left-shifted by 1 on ARM.
Mark Seabornedf0d382013-07-24 16:25:13 +0000621 if (UseARMMethodPtrABI) {
John McCallc62bb392012-02-15 01:22:51 +0000622 uint64_t offset = cast<llvm::ConstantInt>(adj)->getZExtValue();
623 offset <<= 1;
624 adj = llvm::ConstantInt::get(adj->getType(), offset);
625 }
626
627 llvm::Constant *srcAdj = llvm::ConstantExpr::getExtractValue(src, 1);
628 llvm::Constant *dstAdj;
629 if (isDerivedToBase)
630 dstAdj = llvm::ConstantExpr::getNSWSub(srcAdj, adj);
631 else
632 dstAdj = llvm::ConstantExpr::getNSWAdd(srcAdj, adj);
633
634 return llvm::ConstantExpr::getInsertValue(src, dstAdj, 1);
John McCalla8bbb822010-08-22 03:04:22 +0000635}
John McCall84fa5102010-08-22 04:16:24 +0000636
637llvm::Constant *
John McCall7a9aac22010-08-23 01:21:21 +0000638ItaniumCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
John McCall7a9aac22010-08-23 01:21:21 +0000639 // Itanium C++ ABI 2.3:
640 // A NULL pointer is represented as -1.
641 if (MPT->isMemberDataPointer())
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000642 return llvm::ConstantInt::get(CGM.PtrDiffTy, -1ULL, /*isSigned=*/true);
John McCalla1dee5302010-08-22 10:59:02 +0000643
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000644 llvm::Constant *Zero = llvm::ConstantInt::get(CGM.PtrDiffTy, 0);
John McCalla1dee5302010-08-22 10:59:02 +0000645 llvm::Constant *Values[2] = { Zero, Zero };
Chris Lattnere64d7ba2011-06-20 04:01:35 +0000646 return llvm::ConstantStruct::getAnon(Values);
John McCall84fa5102010-08-22 04:16:24 +0000647}
648
John McCallf3a88602011-02-03 08:15:49 +0000649llvm::Constant *
650ItaniumCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
651 CharUnits offset) {
John McCall7a9aac22010-08-23 01:21:21 +0000652 // Itanium C++ ABI 2.3:
653 // A pointer to data member is an offset from the base address of
654 // the class object containing it, represented as a ptrdiff_t
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000655 return llvm::ConstantInt::get(CGM.PtrDiffTy, offset.getQuantity());
John McCall7a9aac22010-08-23 01:21:21 +0000656}
657
John McCall2979fe02011-04-12 00:42:48 +0000658llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const CXXMethodDecl *MD) {
Richard Smithdafff942012-01-14 04:30:29 +0000659 return BuildMemberPointer(MD, CharUnits::Zero());
660}
661
662llvm::Constant *ItaniumCXXABI::BuildMemberPointer(const CXXMethodDecl *MD,
663 CharUnits ThisAdjustment) {
John McCalla1dee5302010-08-22 10:59:02 +0000664 assert(MD->isInstance() && "Member function must not be static!");
665 MD = MD->getCanonicalDecl();
666
667 CodeGenTypes &Types = CGM.getTypes();
John McCalla1dee5302010-08-22 10:59:02 +0000668
669 // Get the function pointer (or index if this is a virtual function).
670 llvm::Constant *MemPtr[2];
671 if (MD->isVirtual()) {
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000672 uint64_t Index = CGM.getItaniumVTableContext().getMethodVTableIndex(MD);
John McCalla1dee5302010-08-22 10:59:02 +0000673
Ken Dyckdf016282011-04-09 01:30:02 +0000674 const ASTContext &Context = getContext();
675 CharUnits PointerWidth =
Douglas Gregore8bbc122011-09-02 00:18:52 +0000676 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
Ken Dyckdf016282011-04-09 01:30:02 +0000677 uint64_t VTableOffset = (Index * PointerWidth.getQuantity());
John McCalla1dee5302010-08-22 10:59:02 +0000678
Mark Seabornedf0d382013-07-24 16:25:13 +0000679 if (UseARMMethodPtrABI) {
John McCalla1dee5302010-08-22 10:59:02 +0000680 // ARM C++ ABI 3.2.1:
681 // This ABI specifies that adj contains twice the this
682 // adjustment, plus 1 if the member function is virtual. The
683 // least significant bit of adj then makes exactly the same
684 // discrimination as the least significant bit of ptr does for
685 // Itanium.
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000686 MemPtr[0] = llvm::ConstantInt::get(CGM.PtrDiffTy, VTableOffset);
687 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy,
Richard Smithdafff942012-01-14 04:30:29 +0000688 2 * ThisAdjustment.getQuantity() + 1);
John McCalla1dee5302010-08-22 10:59:02 +0000689 } else {
690 // Itanium C++ ABI 2.3:
691 // For a virtual function, [the pointer field] is 1 plus the
692 // virtual table offset (in bytes) of the function,
693 // represented as a ptrdiff_t.
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000694 MemPtr[0] = llvm::ConstantInt::get(CGM.PtrDiffTy, VTableOffset + 1);
695 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy,
Richard Smithdafff942012-01-14 04:30:29 +0000696 ThisAdjustment.getQuantity());
John McCalla1dee5302010-08-22 10:59:02 +0000697 }
698 } else {
John McCall2979fe02011-04-12 00:42:48 +0000699 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Chris Lattner2192fe52011-07-18 04:24:23 +0000700 llvm::Type *Ty;
John McCall2979fe02011-04-12 00:42:48 +0000701 // Check whether the function has a computable LLVM signature.
Chris Lattner8806e322011-07-10 00:18:59 +0000702 if (Types.isFuncTypeConvertible(FPT)) {
John McCall2979fe02011-04-12 00:42:48 +0000703 // The function has a computable LLVM signature; use the correct type.
John McCalla729c622012-02-17 03:33:10 +0000704 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
John McCalla1dee5302010-08-22 10:59:02 +0000705 } else {
John McCall2979fe02011-04-12 00:42:48 +0000706 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
707 // function type is incomplete.
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000708 Ty = CGM.PtrDiffTy;
John McCalla1dee5302010-08-22 10:59:02 +0000709 }
John McCall2979fe02011-04-12 00:42:48 +0000710 llvm::Constant *addr = CGM.GetAddrOfFunction(MD, Ty);
John McCalla1dee5302010-08-22 10:59:02 +0000711
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000712 MemPtr[0] = llvm::ConstantExpr::getPtrToInt(addr, CGM.PtrDiffTy);
Mark Seabornedf0d382013-07-24 16:25:13 +0000713 MemPtr[1] = llvm::ConstantInt::get(CGM.PtrDiffTy,
714 (UseARMMethodPtrABI ? 2 : 1) *
Richard Smithdafff942012-01-14 04:30:29 +0000715 ThisAdjustment.getQuantity());
John McCalla1dee5302010-08-22 10:59:02 +0000716 }
John McCall1c456c82010-08-22 06:43:33 +0000717
Chris Lattnere64d7ba2011-06-20 04:01:35 +0000718 return llvm::ConstantStruct::getAnon(MemPtr);
John McCall1c456c82010-08-22 06:43:33 +0000719}
720
Richard Smithdafff942012-01-14 04:30:29 +0000721llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const APValue &MP,
722 QualType MPType) {
723 const MemberPointerType *MPT = MPType->castAs<MemberPointerType>();
724 const ValueDecl *MPD = MP.getMemberPointerDecl();
725 if (!MPD)
726 return EmitNullMemberPointer(MPT);
727
Reid Kleckner452abac2013-05-09 21:01:17 +0000728 CharUnits ThisAdjustment = getMemberPointerPathAdjustment(MP);
Richard Smithdafff942012-01-14 04:30:29 +0000729
730 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD))
731 return BuildMemberPointer(MD, ThisAdjustment);
732
733 CharUnits FieldOffset =
734 getContext().toCharUnitsFromBits(getContext().getFieldOffset(MPD));
735 return EmitMemberDataPointer(MPT, ThisAdjustment + FieldOffset);
736}
737
John McCall131d97d2010-08-22 08:30:07 +0000738/// The comparison algorithm is pretty easy: the member pointers are
739/// the same if they're either bitwise identical *or* both null.
740///
741/// ARM is different here only because null-ness is more complicated.
742llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000743ItaniumCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
744 llvm::Value *L,
745 llvm::Value *R,
746 const MemberPointerType *MPT,
747 bool Inequality) {
John McCall131d97d2010-08-22 08:30:07 +0000748 CGBuilderTy &Builder = CGF.Builder;
749
John McCall131d97d2010-08-22 08:30:07 +0000750 llvm::ICmpInst::Predicate Eq;
751 llvm::Instruction::BinaryOps And, Or;
752 if (Inequality) {
753 Eq = llvm::ICmpInst::ICMP_NE;
754 And = llvm::Instruction::Or;
755 Or = llvm::Instruction::And;
756 } else {
757 Eq = llvm::ICmpInst::ICMP_EQ;
758 And = llvm::Instruction::And;
759 Or = llvm::Instruction::Or;
760 }
761
John McCall7a9aac22010-08-23 01:21:21 +0000762 // Member data pointers are easy because there's a unique null
763 // value, so it just comes down to bitwise equality.
764 if (MPT->isMemberDataPointer())
765 return Builder.CreateICmp(Eq, L, R);
766
767 // For member function pointers, the tautologies are more complex.
768 // The Itanium tautology is:
John McCall61a14882010-08-23 06:56:36 +0000769 // (L == R) <==> (L.ptr == R.ptr && (L.ptr == 0 || L.adj == R.adj))
John McCall7a9aac22010-08-23 01:21:21 +0000770 // The ARM tautology is:
John McCall61a14882010-08-23 06:56:36 +0000771 // (L == R) <==> (L.ptr == R.ptr &&
772 // (L.adj == R.adj ||
773 // (L.ptr == 0 && ((L.adj|R.adj) & 1) == 0)))
John McCall7a9aac22010-08-23 01:21:21 +0000774 // The inequality tautologies have exactly the same structure, except
775 // applying De Morgan's laws.
776
777 llvm::Value *LPtr = Builder.CreateExtractValue(L, 0, "lhs.memptr.ptr");
778 llvm::Value *RPtr = Builder.CreateExtractValue(R, 0, "rhs.memptr.ptr");
779
John McCall131d97d2010-08-22 08:30:07 +0000780 // This condition tests whether L.ptr == R.ptr. This must always be
781 // true for equality to hold.
782 llvm::Value *PtrEq = Builder.CreateICmp(Eq, LPtr, RPtr, "cmp.ptr");
783
784 // This condition, together with the assumption that L.ptr == R.ptr,
785 // tests whether the pointers are both null. ARM imposes an extra
786 // condition.
787 llvm::Value *Zero = llvm::Constant::getNullValue(LPtr->getType());
788 llvm::Value *EqZero = Builder.CreateICmp(Eq, LPtr, Zero, "cmp.ptr.null");
789
790 // This condition tests whether L.adj == R.adj. If this isn't
791 // true, the pointers are unequal unless they're both null.
John McCalla1dee5302010-08-22 10:59:02 +0000792 llvm::Value *LAdj = Builder.CreateExtractValue(L, 1, "lhs.memptr.adj");
793 llvm::Value *RAdj = Builder.CreateExtractValue(R, 1, "rhs.memptr.adj");
John McCall131d97d2010-08-22 08:30:07 +0000794 llvm::Value *AdjEq = Builder.CreateICmp(Eq, LAdj, RAdj, "cmp.adj");
795
796 // Null member function pointers on ARM clear the low bit of Adj,
797 // so the zero condition has to check that neither low bit is set.
Mark Seabornedf0d382013-07-24 16:25:13 +0000798 if (UseARMMethodPtrABI) {
John McCall131d97d2010-08-22 08:30:07 +0000799 llvm::Value *One = llvm::ConstantInt::get(LPtr->getType(), 1);
800
801 // Compute (l.adj | r.adj) & 1 and test it against zero.
802 llvm::Value *OrAdj = Builder.CreateOr(LAdj, RAdj, "or.adj");
803 llvm::Value *OrAdjAnd1 = Builder.CreateAnd(OrAdj, One);
804 llvm::Value *OrAdjAnd1EqZero = Builder.CreateICmp(Eq, OrAdjAnd1, Zero,
805 "cmp.or.adj");
806 EqZero = Builder.CreateBinOp(And, EqZero, OrAdjAnd1EqZero);
807 }
808
809 // Tie together all our conditions.
810 llvm::Value *Result = Builder.CreateBinOp(Or, EqZero, AdjEq);
811 Result = Builder.CreateBinOp(And, PtrEq, Result,
812 Inequality ? "memptr.ne" : "memptr.eq");
813 return Result;
814}
815
816llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000817ItaniumCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
818 llvm::Value *MemPtr,
819 const MemberPointerType *MPT) {
John McCall131d97d2010-08-22 08:30:07 +0000820 CGBuilderTy &Builder = CGF.Builder;
John McCall7a9aac22010-08-23 01:21:21 +0000821
822 /// For member data pointers, this is just a check against -1.
823 if (MPT->isMemberDataPointer()) {
Reid Kleckner9cffbc12013-03-22 16:13:10 +0000824 assert(MemPtr->getType() == CGM.PtrDiffTy);
John McCall7a9aac22010-08-23 01:21:21 +0000825 llvm::Value *NegativeOne =
826 llvm::Constant::getAllOnesValue(MemPtr->getType());
827 return Builder.CreateICmpNE(MemPtr, NegativeOne, "memptr.tobool");
828 }
John McCall131d97d2010-08-22 08:30:07 +0000829
Daniel Dunbar914bc412011-04-19 23:10:47 +0000830 // In Itanium, a member function pointer is not null if 'ptr' is not null.
John McCalla1dee5302010-08-22 10:59:02 +0000831 llvm::Value *Ptr = Builder.CreateExtractValue(MemPtr, 0, "memptr.ptr");
John McCall131d97d2010-08-22 08:30:07 +0000832
833 llvm::Constant *Zero = llvm::ConstantInt::get(Ptr->getType(), 0);
834 llvm::Value *Result = Builder.CreateICmpNE(Ptr, Zero, "memptr.tobool");
835
Daniel Dunbar914bc412011-04-19 23:10:47 +0000836 // On ARM, a member function pointer is also non-null if the low bit of 'adj'
837 // (the virtual bit) is set.
Mark Seabornedf0d382013-07-24 16:25:13 +0000838 if (UseARMMethodPtrABI) {
John McCall131d97d2010-08-22 08:30:07 +0000839 llvm::Constant *One = llvm::ConstantInt::get(Ptr->getType(), 1);
John McCalla1dee5302010-08-22 10:59:02 +0000840 llvm::Value *Adj = Builder.CreateExtractValue(MemPtr, 1, "memptr.adj");
John McCall131d97d2010-08-22 08:30:07 +0000841 llvm::Value *VirtualBit = Builder.CreateAnd(Adj, One, "memptr.virtualbit");
Daniel Dunbar914bc412011-04-19 23:10:47 +0000842 llvm::Value *IsVirtual = Builder.CreateICmpNE(VirtualBit, Zero,
843 "memptr.isvirtual");
844 Result = Builder.CreateOr(Result, IsVirtual);
John McCall131d97d2010-08-22 08:30:07 +0000845 }
846
847 return Result;
848}
John McCall1c456c82010-08-22 06:43:33 +0000849
Reid Kleckner40ca9132014-05-13 22:05:45 +0000850bool ItaniumCXXABI::classifyReturnType(CGFunctionInfo &FI) const {
851 const CXXRecordDecl *RD = FI.getReturnType()->getAsCXXRecordDecl();
852 if (!RD)
853 return false;
854
Reid Klecknerd355ca72014-05-15 01:26:32 +0000855 // Return indirectly if we have a non-trivial copy ctor or non-trivial dtor.
856 // FIXME: Use canCopyArgument() when it is fixed to handle lazily declared
857 // special members.
858 if (RD->hasNonTrivialDestructor() || RD->hasNonTrivialCopyConstructor()) {
Reid Kleckner40ca9132014-05-13 22:05:45 +0000859 FI.getReturnInfo() = ABIArgInfo::getIndirect(0, /*ByVal=*/false);
860 return true;
861 }
Reid Kleckner40ca9132014-05-13 22:05:45 +0000862 return false;
863}
864
John McCall614dbdc2010-08-22 21:01:12 +0000865/// The Itanium ABI requires non-zero initialization only for data
866/// member pointers, for which '0' is a valid offset.
867bool ItaniumCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
868 return MPT->getPointeeType()->isFunctionType();
John McCall84fa5102010-08-22 04:16:24 +0000869}
John McCall5d865c322010-08-31 07:33:07 +0000870
John McCall82fb8922012-09-25 10:10:39 +0000871/// The Itanium ABI always places an offset to the complete object
872/// at entry -2 in the vtable.
David Majnemer08681372014-11-01 07:37:17 +0000873void ItaniumCXXABI::emitVirtualObjectDelete(CodeGenFunction &CGF,
874 const CXXDeleteExpr *DE,
875 llvm::Value *Ptr,
876 QualType ElementType,
877 const CXXDestructorDecl *Dtor) {
878 bool UseGlobalDelete = DE->isGlobalDelete();
David Majnemer0c0b6d92014-10-31 20:09:12 +0000879 if (UseGlobalDelete) {
880 // Derive the complete-object pointer, which is what we need
881 // to pass to the deallocation function.
John McCall82fb8922012-09-25 10:10:39 +0000882
David Majnemer0c0b6d92014-10-31 20:09:12 +0000883 // Grab the vtable pointer as an intptr_t*.
884 llvm::Value *VTable = CGF.GetVTablePtr(Ptr, CGF.IntPtrTy->getPointerTo());
John McCall82fb8922012-09-25 10:10:39 +0000885
David Majnemer0c0b6d92014-10-31 20:09:12 +0000886 // Track back to entry -2 and pull out the offset there.
887 llvm::Value *OffsetPtr = CGF.Builder.CreateConstInBoundsGEP1_64(
888 VTable, -2, "complete-offset.ptr");
889 llvm::LoadInst *Offset = CGF.Builder.CreateLoad(OffsetPtr);
890 Offset->setAlignment(CGF.PointerAlignInBytes);
891
892 // Apply the offset.
893 llvm::Value *CompletePtr = CGF.Builder.CreateBitCast(Ptr, CGF.Int8PtrTy);
894 CompletePtr = CGF.Builder.CreateInBoundsGEP(CompletePtr, Offset);
895
896 // If we're supposed to call the global delete, make sure we do so
897 // even if the destructor throws.
David Majnemer08681372014-11-01 07:37:17 +0000898 CGF.pushCallObjectDeleteCleanup(DE->getOperatorDelete(), CompletePtr,
899 ElementType);
David Majnemer0c0b6d92014-10-31 20:09:12 +0000900 }
901
902 // FIXME: Provide a source location here even though there's no
903 // CXXMemberCallExpr for dtor call.
904 CXXDtorType DtorType = UseGlobalDelete ? Dtor_Complete : Dtor_Deleting;
905 EmitVirtualDestructorCall(CGF, Dtor, DtorType, Ptr, /*CE=*/nullptr);
906
907 if (UseGlobalDelete)
908 CGF.PopCleanupBlock();
John McCall82fb8922012-09-25 10:10:39 +0000909}
910
David Majnemer442d0a22014-11-25 07:20:20 +0000911void ItaniumCXXABI::emitRethrow(CodeGenFunction &CGF, bool isNoReturn) {
912 // void __cxa_rethrow();
913
914 llvm::FunctionType *FTy =
915 llvm::FunctionType::get(CGM.VoidTy, /*IsVarArgs=*/false);
916
917 llvm::Constant *Fn = CGM.CreateRuntimeFunction(FTy, "__cxa_rethrow");
918
919 if (isNoReturn)
920 CGF.EmitNoreturnRuntimeCallOrInvoke(Fn, None);
921 else
922 CGF.EmitRuntimeCallOrInvoke(Fn);
923}
924
David Majnemer7c237072015-03-05 00:46:22 +0000925static llvm::Constant *getAllocateExceptionFn(CodeGenModule &CGM) {
926 // void *__cxa_allocate_exception(size_t thrown_size);
927
928 llvm::FunctionType *FTy =
929 llvm::FunctionType::get(CGM.Int8PtrTy, CGM.SizeTy, /*IsVarArgs=*/false);
930
931 return CGM.CreateRuntimeFunction(FTy, "__cxa_allocate_exception");
932}
933
934static llvm::Constant *getThrowFn(CodeGenModule &CGM) {
935 // void __cxa_throw(void *thrown_exception, std::type_info *tinfo,
936 // void (*dest) (void *));
937
938 llvm::Type *Args[3] = { CGM.Int8PtrTy, CGM.Int8PtrTy, CGM.Int8PtrTy };
939 llvm::FunctionType *FTy =
940 llvm::FunctionType::get(CGM.VoidTy, Args, /*IsVarArgs=*/false);
941
942 return CGM.CreateRuntimeFunction(FTy, "__cxa_throw");
943}
944
945void ItaniumCXXABI::emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) {
946 QualType ThrowType = E->getSubExpr()->getType();
947 // Now allocate the exception object.
948 llvm::Type *SizeTy = CGF.ConvertType(getContext().getSizeType());
949 uint64_t TypeSize = getContext().getTypeSizeInChars(ThrowType).getQuantity();
950
951 llvm::Constant *AllocExceptionFn = getAllocateExceptionFn(CGM);
952 llvm::CallInst *ExceptionPtr = CGF.EmitNounwindRuntimeCall(
953 AllocExceptionFn, llvm::ConstantInt::get(SizeTy, TypeSize), "exception");
954
955 CGF.EmitAnyExprToExn(E->getSubExpr(), ExceptionPtr);
956
957 // Now throw the exception.
958 llvm::Constant *TypeInfo = CGM.GetAddrOfRTTIDescriptor(ThrowType,
959 /*ForEH=*/true);
960
961 // The address of the destructor. If the exception type has a
962 // trivial destructor (or isn't a record), we just pass null.
963 llvm::Constant *Dtor = nullptr;
964 if (const RecordType *RecordTy = ThrowType->getAs<RecordType>()) {
965 CXXRecordDecl *Record = cast<CXXRecordDecl>(RecordTy->getDecl());
966 if (!Record->hasTrivialDestructor()) {
967 CXXDestructorDecl *DtorD = Record->getDestructor();
968 Dtor = CGM.getAddrOfCXXStructor(DtorD, StructorType::Complete);
969 Dtor = llvm::ConstantExpr::getBitCast(Dtor, CGM.Int8PtrTy);
970 }
971 }
972 if (!Dtor) Dtor = llvm::Constant::getNullValue(CGM.Int8PtrTy);
973
974 llvm::Value *args[] = { ExceptionPtr, TypeInfo, Dtor };
975 CGF.EmitNoreturnRuntimeCallOrInvoke(getThrowFn(CGM), args);
976}
977
David Majnemer1162d252014-06-22 19:05:33 +0000978static llvm::Constant *getItaniumDynamicCastFn(CodeGenFunction &CGF) {
979 // void *__dynamic_cast(const void *sub,
980 // const abi::__class_type_info *src,
981 // const abi::__class_type_info *dst,
982 // std::ptrdiff_t src2dst_offset);
983
984 llvm::Type *Int8PtrTy = CGF.Int8PtrTy;
985 llvm::Type *PtrDiffTy =
986 CGF.ConvertType(CGF.getContext().getPointerDiffType());
987
988 llvm::Type *Args[4] = { Int8PtrTy, Int8PtrTy, Int8PtrTy, PtrDiffTy };
989
990 llvm::FunctionType *FTy = llvm::FunctionType::get(Int8PtrTy, Args, false);
991
992 // Mark the function as nounwind readonly.
993 llvm::Attribute::AttrKind FuncAttrs[] = { llvm::Attribute::NoUnwind,
994 llvm::Attribute::ReadOnly };
995 llvm::AttributeSet Attrs = llvm::AttributeSet::get(
996 CGF.getLLVMContext(), llvm::AttributeSet::FunctionIndex, FuncAttrs);
997
998 return CGF.CGM.CreateRuntimeFunction(FTy, "__dynamic_cast", Attrs);
999}
1000
1001static llvm::Constant *getBadCastFn(CodeGenFunction &CGF) {
1002 // void __cxa_bad_cast();
1003 llvm::FunctionType *FTy = llvm::FunctionType::get(CGF.VoidTy, false);
1004 return CGF.CGM.CreateRuntimeFunction(FTy, "__cxa_bad_cast");
1005}
1006
1007/// \brief Compute the src2dst_offset hint as described in the
1008/// Itanium C++ ABI [2.9.7]
1009static CharUnits computeOffsetHint(ASTContext &Context,
1010 const CXXRecordDecl *Src,
1011 const CXXRecordDecl *Dst) {
1012 CXXBasePaths Paths(/*FindAmbiguities=*/true, /*RecordPaths=*/true,
1013 /*DetectVirtual=*/false);
1014
1015 // If Dst is not derived from Src we can skip the whole computation below and
1016 // return that Src is not a public base of Dst. Record all inheritance paths.
1017 if (!Dst->isDerivedFrom(Src, Paths))
1018 return CharUnits::fromQuantity(-2ULL);
1019
1020 unsigned NumPublicPaths = 0;
1021 CharUnits Offset;
1022
1023 // Now walk all possible inheritance paths.
1024 for (CXXBasePaths::paths_iterator I = Paths.begin(), E = Paths.end(); I != E;
1025 ++I) {
1026 if (I->Access != AS_public) // Ignore non-public inheritance.
1027 continue;
1028
1029 ++NumPublicPaths;
1030
1031 for (CXXBasePath::iterator J = I->begin(), JE = I->end(); J != JE; ++J) {
1032 // If the path contains a virtual base class we can't give any hint.
1033 // -1: no hint.
1034 if (J->Base->isVirtual())
1035 return CharUnits::fromQuantity(-1ULL);
1036
1037 if (NumPublicPaths > 1) // Won't use offsets, skip computation.
1038 continue;
1039
1040 // Accumulate the base class offsets.
1041 const ASTRecordLayout &L = Context.getASTRecordLayout(J->Class);
1042 Offset += L.getBaseClassOffset(J->Base->getType()->getAsCXXRecordDecl());
1043 }
1044 }
1045
1046 // -2: Src is not a public base of Dst.
1047 if (NumPublicPaths == 0)
1048 return CharUnits::fromQuantity(-2ULL);
1049
1050 // -3: Src is a multiple public base type but never a virtual base type.
1051 if (NumPublicPaths > 1)
1052 return CharUnits::fromQuantity(-3ULL);
1053
1054 // Otherwise, the Src type is a unique public nonvirtual base type of Dst.
1055 // Return the offset of Src from the origin of Dst.
1056 return Offset;
1057}
1058
1059static llvm::Constant *getBadTypeidFn(CodeGenFunction &CGF) {
1060 // void __cxa_bad_typeid();
1061 llvm::FunctionType *FTy = llvm::FunctionType::get(CGF.VoidTy, false);
1062
1063 return CGF.CGM.CreateRuntimeFunction(FTy, "__cxa_bad_typeid");
1064}
1065
1066bool ItaniumCXXABI::shouldTypeidBeNullChecked(bool IsDeref,
1067 QualType SrcRecordTy) {
1068 return IsDeref;
1069}
1070
1071void ItaniumCXXABI::EmitBadTypeidCall(CodeGenFunction &CGF) {
1072 llvm::Value *Fn = getBadTypeidFn(CGF);
1073 CGF.EmitRuntimeCallOrInvoke(Fn).setDoesNotReturn();
1074 CGF.Builder.CreateUnreachable();
1075}
1076
1077llvm::Value *ItaniumCXXABI::EmitTypeid(CodeGenFunction &CGF,
1078 QualType SrcRecordTy,
1079 llvm::Value *ThisPtr,
1080 llvm::Type *StdTypeInfoPtrTy) {
1081 llvm::Value *Value =
1082 CGF.GetVTablePtr(ThisPtr, StdTypeInfoPtrTy->getPointerTo());
1083
1084 // Load the type info.
1085 Value = CGF.Builder.CreateConstInBoundsGEP1_64(Value, -1ULL);
1086 return CGF.Builder.CreateLoad(Value);
1087}
1088
1089bool ItaniumCXXABI::shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
1090 QualType SrcRecordTy) {
1091 return SrcIsPtr;
1092}
1093
1094llvm::Value *ItaniumCXXABI::EmitDynamicCastCall(
1095 CodeGenFunction &CGF, llvm::Value *Value, QualType SrcRecordTy,
1096 QualType DestTy, QualType DestRecordTy, llvm::BasicBlock *CastEnd) {
1097 llvm::Type *PtrDiffLTy =
1098 CGF.ConvertType(CGF.getContext().getPointerDiffType());
1099 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
1100
1101 llvm::Value *SrcRTTI =
1102 CGF.CGM.GetAddrOfRTTIDescriptor(SrcRecordTy.getUnqualifiedType());
1103 llvm::Value *DestRTTI =
1104 CGF.CGM.GetAddrOfRTTIDescriptor(DestRecordTy.getUnqualifiedType());
1105
1106 // Compute the offset hint.
1107 const CXXRecordDecl *SrcDecl = SrcRecordTy->getAsCXXRecordDecl();
1108 const CXXRecordDecl *DestDecl = DestRecordTy->getAsCXXRecordDecl();
1109 llvm::Value *OffsetHint = llvm::ConstantInt::get(
1110 PtrDiffLTy,
1111 computeOffsetHint(CGF.getContext(), SrcDecl, DestDecl).getQuantity());
1112
1113 // Emit the call to __dynamic_cast.
1114 Value = CGF.EmitCastToVoidPtr(Value);
1115
1116 llvm::Value *args[] = {Value, SrcRTTI, DestRTTI, OffsetHint};
1117 Value = CGF.EmitNounwindRuntimeCall(getItaniumDynamicCastFn(CGF), args);
1118 Value = CGF.Builder.CreateBitCast(Value, DestLTy);
1119
1120 /// C++ [expr.dynamic.cast]p9:
1121 /// A failed cast to reference type throws std::bad_cast
1122 if (DestTy->isReferenceType()) {
1123 llvm::BasicBlock *BadCastBlock =
1124 CGF.createBasicBlock("dynamic_cast.bad_cast");
1125
1126 llvm::Value *IsNull = CGF.Builder.CreateIsNull(Value);
1127 CGF.Builder.CreateCondBr(IsNull, BadCastBlock, CastEnd);
1128
1129 CGF.EmitBlock(BadCastBlock);
1130 EmitBadCastCall(CGF);
1131 }
1132
1133 return Value;
1134}
1135
1136llvm::Value *ItaniumCXXABI::EmitDynamicCastToVoid(CodeGenFunction &CGF,
1137 llvm::Value *Value,
1138 QualType SrcRecordTy,
1139 QualType DestTy) {
1140 llvm::Type *PtrDiffLTy =
1141 CGF.ConvertType(CGF.getContext().getPointerDiffType());
1142 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
1143
1144 // Get the vtable pointer.
1145 llvm::Value *VTable = CGF.GetVTablePtr(Value, PtrDiffLTy->getPointerTo());
1146
1147 // Get the offset-to-top from the vtable.
1148 llvm::Value *OffsetToTop =
1149 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, -2ULL);
1150 OffsetToTop = CGF.Builder.CreateLoad(OffsetToTop, "offset.to.top");
1151
1152 // Finally, add the offset to the pointer.
1153 Value = CGF.EmitCastToVoidPtr(Value);
1154 Value = CGF.Builder.CreateInBoundsGEP(Value, OffsetToTop);
1155
1156 return CGF.Builder.CreateBitCast(Value, DestLTy);
1157}
1158
1159bool ItaniumCXXABI::EmitBadCastCall(CodeGenFunction &CGF) {
1160 llvm::Value *Fn = getBadCastFn(CGF);
1161 CGF.EmitRuntimeCallOrInvoke(Fn).setDoesNotReturn();
1162 CGF.Builder.CreateUnreachable();
1163 return true;
1164}
1165
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001166llvm::Value *
1167ItaniumCXXABI::GetVirtualBaseClassOffset(CodeGenFunction &CGF,
1168 llvm::Value *This,
1169 const CXXRecordDecl *ClassDecl,
1170 const CXXRecordDecl *BaseClassDecl) {
1171 llvm::Value *VTablePtr = CGF.GetVTablePtr(This, CGM.Int8PtrTy);
1172 CharUnits VBaseOffsetOffset =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001173 CGM.getItaniumVTableContext().getVirtualBaseOffsetOffset(ClassDecl,
1174 BaseClassDecl);
Reid Klecknerd8cbeec2013-05-29 18:02:47 +00001175
1176 llvm::Value *VBaseOffsetPtr =
1177 CGF.Builder.CreateConstGEP1_64(VTablePtr, VBaseOffsetOffset.getQuantity(),
1178 "vbase.offset.ptr");
1179 VBaseOffsetPtr = CGF.Builder.CreateBitCast(VBaseOffsetPtr,
1180 CGM.PtrDiffTy->getPointerTo());
1181
1182 llvm::Value *VBaseOffset =
1183 CGF.Builder.CreateLoad(VBaseOffsetPtr, "vbase.offset");
1184
1185 return VBaseOffset;
1186}
1187
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001188void ItaniumCXXABI::EmitCXXConstructors(const CXXConstructorDecl *D) {
1189 // Just make sure we're in sync with TargetCXXABI.
1190 assert(CGM.getTarget().getCXXABI().hasConstructorVariants());
1191
Rafael Espindolac3cde362013-12-09 14:51:17 +00001192 // The constructor used for constructing this as a base class;
1193 // ignores virtual bases.
1194 CGM.EmitGlobal(GlobalDecl(D, Ctor_Base));
1195
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001196 // The constructor used for constructing this as a complete class;
Nico Weber4c2ffb22015-01-07 05:25:05 +00001197 // constructs the virtual bases, then calls the base constructor.
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001198 if (!D->getParent()->isAbstract()) {
1199 // We don't need to emit the complete ctor if the class is abstract.
1200 CGM.EmitGlobal(GlobalDecl(D, Ctor_Complete));
1201 }
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +00001202}
1203
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001204void
1205ItaniumCXXABI::buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
1206 SmallVectorImpl<CanQualType> &ArgTys) {
John McCall9bca9232010-09-02 10:25:57 +00001207 ASTContext &Context = getContext();
John McCall5d865c322010-08-31 07:33:07 +00001208
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001209 // All parameters are already in place except VTT, which goes after 'this'.
1210 // These are Clang types, so we don't need to worry about sret yet.
John McCall5d865c322010-08-31 07:33:07 +00001211
1212 // Check if we need to add a VTT parameter (which has type void **).
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001213 if (T == StructorType::Base && MD->getParent()->getNumVBases() != 0)
1214 ArgTys.insert(ArgTys.begin() + 1,
1215 Context.getPointerType(Context.VoidPtrTy));
John McCall5d865c322010-08-31 07:33:07 +00001216}
1217
Reid Klecknere7de47e2013-07-22 13:51:44 +00001218void ItaniumCXXABI::EmitCXXDestructors(const CXXDestructorDecl *D) {
Rafael Espindolac3cde362013-12-09 14:51:17 +00001219 // The destructor used for destructing this as a base class; ignores
1220 // virtual bases.
1221 CGM.EmitGlobal(GlobalDecl(D, Dtor_Base));
Reid Klecknere7de47e2013-07-22 13:51:44 +00001222
1223 // The destructor used for destructing this as a most-derived class;
1224 // call the base destructor and then destructs any virtual bases.
1225 CGM.EmitGlobal(GlobalDecl(D, Dtor_Complete));
1226
Rafael Espindolac3cde362013-12-09 14:51:17 +00001227 // The destructor in a virtual table is always a 'deleting'
1228 // destructor, which calls the complete destructor and then uses the
1229 // appropriate operator delete.
1230 if (D->isVirtual())
1231 CGM.EmitGlobal(GlobalDecl(D, Dtor_Deleting));
Reid Klecknere7de47e2013-07-22 13:51:44 +00001232}
1233
Reid Kleckner89077a12013-12-17 19:46:40 +00001234void ItaniumCXXABI::addImplicitStructorParams(CodeGenFunction &CGF,
1235 QualType &ResTy,
1236 FunctionArgList &Params) {
John McCall5d865c322010-08-31 07:33:07 +00001237 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
Reid Kleckner89077a12013-12-17 19:46:40 +00001238 assert(isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD));
John McCall5d865c322010-08-31 07:33:07 +00001239
1240 // Check if we need a VTT parameter as well.
Peter Collingbourne66f82e62013-06-28 20:45:28 +00001241 if (NeedsVTTParameter(CGF.CurGD)) {
John McCall9bca9232010-09-02 10:25:57 +00001242 ASTContext &Context = getContext();
John McCall5d865c322010-08-31 07:33:07 +00001243
1244 // FIXME: avoid the fake decl
1245 QualType T = Context.getPointerType(Context.VoidPtrTy);
1246 ImplicitParamDecl *VTTDecl
Craig Topper8a13c412014-05-21 05:09:00 +00001247 = ImplicitParamDecl::Create(Context, nullptr, MD->getLocation(),
John McCall5d865c322010-08-31 07:33:07 +00001248 &Context.Idents.get("vtt"), T);
Reid Kleckner89077a12013-12-17 19:46:40 +00001249 Params.insert(Params.begin() + 1, VTTDecl);
Reid Kleckner2af6d732013-12-13 00:09:59 +00001250 getStructorImplicitParamDecl(CGF) = VTTDecl;
John McCall5d865c322010-08-31 07:33:07 +00001251 }
1252}
1253
John McCall5d865c322010-08-31 07:33:07 +00001254void ItaniumCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
1255 /// Initialize the 'this' slot.
1256 EmitThisParam(CGF);
1257
1258 /// Initialize the 'vtt' slot if needed.
Reid Kleckner2af6d732013-12-13 00:09:59 +00001259 if (getStructorImplicitParamDecl(CGF)) {
1260 getStructorImplicitParamValue(CGF) = CGF.Builder.CreateLoad(
1261 CGF.GetAddrOfLocalVar(getStructorImplicitParamDecl(CGF)), "vtt");
John McCall5d865c322010-08-31 07:33:07 +00001262 }
John McCall5d865c322010-08-31 07:33:07 +00001263
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001264 /// If this is a function that the ABI specifies returns 'this', initialize
1265 /// the return slot to 'this' at the start of the function.
1266 ///
1267 /// Unlike the setting of return types, this is done within the ABI
1268 /// implementation instead of by clients of CGCXXABI because:
1269 /// 1) getThisValue is currently protected
1270 /// 2) in theory, an ABI could implement 'this' returns some other way;
1271 /// HasThisReturn only specifies a contract, not the implementation
John McCall5d865c322010-08-31 07:33:07 +00001272 if (HasThisReturn(CGF.CurGD))
Eli Friedman9fbeba02012-02-11 02:57:39 +00001273 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
John McCall5d865c322010-08-31 07:33:07 +00001274}
1275
Reid Kleckner89077a12013-12-17 19:46:40 +00001276unsigned ItaniumCXXABI::addImplicitConstructorArgs(
1277 CodeGenFunction &CGF, const CXXConstructorDecl *D, CXXCtorType Type,
1278 bool ForVirtualBase, bool Delegating, CallArgList &Args) {
1279 if (!NeedsVTTParameter(GlobalDecl(D, Type)))
1280 return 0;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001281
Reid Kleckner89077a12013-12-17 19:46:40 +00001282 // Insert the implicit 'vtt' argument as the second argument.
1283 llvm::Value *VTT =
1284 CGF.GetVTTParameter(GlobalDecl(D, Type), ForVirtualBase, Delegating);
1285 QualType VTTTy = getContext().getPointerType(getContext().VoidPtrTy);
1286 Args.insert(Args.begin() + 1,
1287 CallArg(RValue::get(VTT), VTTTy, /*needscopy=*/false));
1288 return 1; // Added one arg.
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001289}
1290
1291void ItaniumCXXABI::EmitDestructorCall(CodeGenFunction &CGF,
1292 const CXXDestructorDecl *DD,
1293 CXXDtorType Type, bool ForVirtualBase,
1294 bool Delegating, llvm::Value *This) {
1295 GlobalDecl GD(DD, Type);
1296 llvm::Value *VTT = CGF.GetVTTParameter(GD, ForVirtualBase, Delegating);
1297 QualType VTTTy = getContext().getPointerType(getContext().VoidPtrTy);
1298
Craig Topper8a13c412014-05-21 05:09:00 +00001299 llvm::Value *Callee = nullptr;
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001300 if (getContext().getLangOpts().AppleKext)
1301 Callee = CGF.BuildAppleKextVirtualDestructorCall(DD, Type, DD->getParent());
1302
1303 if (!Callee)
Rafael Espindola1ac0ec82014-09-11 15:42:06 +00001304 Callee = CGM.getAddrOfCXXStructor(DD, getFromDtorType(Type));
Reid Kleckner6fe771a2013-12-13 00:53:54 +00001305
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001306 CGF.EmitCXXMemberOrOperatorCall(DD, Callee, ReturnValueSlot(), This, VTT,
1307 VTTTy, nullptr);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001308}
1309
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001310void ItaniumCXXABI::emitVTableDefinitions(CodeGenVTables &CGVT,
1311 const CXXRecordDecl *RD) {
1312 llvm::GlobalVariable *VTable = getAddrOfVTable(RD, CharUnits());
1313 if (VTable->hasInitializer())
1314 return;
1315
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001316 ItaniumVTableContext &VTContext = CGM.getItaniumVTableContext();
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001317 const VTableLayout &VTLayout = VTContext.getVTableLayout(RD);
1318 llvm::GlobalVariable::LinkageTypes Linkage = CGM.getVTableLinkage(RD);
David Majnemerd905da42014-07-01 20:30:31 +00001319 llvm::Constant *RTTI =
1320 CGM.GetAddrOfRTTIDescriptor(CGM.getContext().getTagDeclType(RD));
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001321
1322 // Create and set the initializer.
1323 llvm::Constant *Init = CGVT.CreateVTableInitializer(
1324 RD, VTLayout.vtable_component_begin(), VTLayout.getNumVTableComponents(),
David Majnemerd905da42014-07-01 20:30:31 +00001325 VTLayout.vtable_thunk_begin(), VTLayout.getNumVTableThunks(), RTTI);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001326 VTable->setInitializer(Init);
1327
1328 // Set the correct linkage.
1329 VTable->setLinkage(Linkage);
1330
Rafael Espindolacb92c192015-01-15 23:18:01 +00001331 if (CGM.supportsCOMDAT() && VTable->isWeakForLinker())
1332 VTable->setComdat(CGM.getModule().getOrInsertComdat(VTable->getName()));
1333
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001334 // Set the right visibility.
John McCall8f80a612014-02-08 00:41:16 +00001335 CGM.setGlobalVisibility(VTable, RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001336
Benjamin Kramer5d34a2b2014-09-10 12:50:59 +00001337 // Use pointer alignment for the vtable. Otherwise we would align them based
1338 // on the size of the initializer which doesn't make sense as only single
1339 // values are read.
1340 unsigned PAlign = CGM.getTarget().getPointerAlign(0);
1341 VTable->setAlignment(getContext().toCharUnitsFromBits(PAlign).getQuantity());
1342
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001343 // If this is the magic class __cxxabiv1::__fundamental_type_info,
1344 // we will emit the typeinfo for the fundamental types. This is the
1345 // same behaviour as GCC.
1346 const DeclContext *DC = RD->getDeclContext();
1347 if (RD->getIdentifier() &&
1348 RD->getIdentifier()->isStr("__fundamental_type_info") &&
1349 isa<NamespaceDecl>(DC) && cast<NamespaceDecl>(DC)->getIdentifier() &&
1350 cast<NamespaceDecl>(DC)->getIdentifier()->isStr("__cxxabiv1") &&
1351 DC->getParent()->isTranslationUnit())
David Majnemere2cb8d12014-07-07 06:20:47 +00001352 EmitFundamentalRTTIDescriptors();
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001353
1354 CGM.EmitVTableBitSetEntries(VTable, VTLayout);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001355}
1356
1357llvm::Value *ItaniumCXXABI::getVTableAddressPointInStructor(
1358 CodeGenFunction &CGF, const CXXRecordDecl *VTableClass, BaseSubobject Base,
1359 const CXXRecordDecl *NearestVBase, bool &NeedsVirtualOffset) {
1360 bool NeedsVTTParam = CGM.getCXXABI().NeedsVTTParameter(CGF.CurGD);
1361 NeedsVirtualOffset = (NeedsVTTParam && NearestVBase);
1362
1363 llvm::Value *VTableAddressPoint;
1364 if (NeedsVTTParam && (Base.getBase()->getNumVBases() || NearestVBase)) {
1365 // Get the secondary vpointer index.
1366 uint64_t VirtualPointerIndex =
1367 CGM.getVTables().getSecondaryVirtualPointerIndex(VTableClass, Base);
1368
1369 /// Load the VTT.
1370 llvm::Value *VTT = CGF.LoadCXXVTT();
1371 if (VirtualPointerIndex)
1372 VTT = CGF.Builder.CreateConstInBoundsGEP1_64(VTT, VirtualPointerIndex);
1373
1374 // And load the address point from the VTT.
1375 VTableAddressPoint = CGF.Builder.CreateLoad(VTT);
1376 } else {
1377 llvm::Constant *VTable =
1378 CGM.getCXXABI().getAddrOfVTable(VTableClass, CharUnits());
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001379 uint64_t AddressPoint = CGM.getItaniumVTableContext()
1380 .getVTableLayout(VTableClass)
1381 .getAddressPoint(Base);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001382 VTableAddressPoint =
1383 CGF.Builder.CreateConstInBoundsGEP2_64(VTable, 0, AddressPoint);
1384 }
1385
1386 return VTableAddressPoint;
1387}
1388
1389llvm::Constant *ItaniumCXXABI::getVTableAddressPointForConstExpr(
1390 BaseSubobject Base, const CXXRecordDecl *VTableClass) {
1391 llvm::Constant *VTable = getAddrOfVTable(VTableClass, CharUnits());
1392
1393 // Find the appropriate vtable within the vtable group.
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001394 uint64_t AddressPoint = CGM.getItaniumVTableContext()
1395 .getVTableLayout(VTableClass)
1396 .getAddressPoint(Base);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001397 llvm::Value *Indices[] = {
1398 llvm::ConstantInt::get(CGM.Int64Ty, 0),
1399 llvm::ConstantInt::get(CGM.Int64Ty, AddressPoint)
1400 };
1401
1402 return llvm::ConstantExpr::getInBoundsGetElementPtr(VTable, Indices);
1403}
1404
1405llvm::GlobalVariable *ItaniumCXXABI::getAddrOfVTable(const CXXRecordDecl *RD,
1406 CharUnits VPtrOffset) {
1407 assert(VPtrOffset.isZero() && "Itanium ABI only supports zero vptr offsets");
1408
1409 llvm::GlobalVariable *&VTable = VTables[RD];
1410 if (VTable)
1411 return VTable;
1412
1413 // Queue up this v-table for possible deferred emission.
1414 CGM.addDeferredVTable(RD);
1415
1416 SmallString<256> OutName;
1417 llvm::raw_svector_ostream Out(OutName);
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00001418 getMangleContext().mangleCXXVTable(RD, Out);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001419 Out.flush();
1420 StringRef Name = OutName.str();
1421
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001422 ItaniumVTableContext &VTContext = CGM.getItaniumVTableContext();
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001423 llvm::ArrayType *ArrayType = llvm::ArrayType::get(
1424 CGM.Int8PtrTy, VTContext.getVTableLayout(RD).getNumVTableComponents());
1425
1426 VTable = CGM.CreateOrReplaceCXXRuntimeVariable(
1427 Name, ArrayType, llvm::GlobalValue::ExternalLinkage);
1428 VTable->setUnnamedAddr(true);
Hans Wennborgda24e9c2014-06-02 23:13:03 +00001429
1430 if (RD->hasAttr<DLLImportAttr>())
1431 VTable->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
1432 else if (RD->hasAttr<DLLExportAttr>())
1433 VTable->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
1434
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001435 return VTable;
1436}
1437
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001438llvm::Value *ItaniumCXXABI::getVirtualFunctionPointer(CodeGenFunction &CGF,
1439 GlobalDecl GD,
1440 llvm::Value *This,
1441 llvm::Type *Ty) {
1442 GD = GD.getCanonicalDecl();
1443 Ty = Ty->getPointerTo()->getPointerTo();
1444 llvm::Value *VTable = CGF.GetVTablePtr(This, Ty);
1445
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001446 CGF.EmitVTablePtrCheckForCall(cast<CXXMethodDecl>(GD.getDecl()), VTable);
1447
Timur Iskhodzhanov58776632013-11-05 15:54:58 +00001448 uint64_t VTableIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(GD);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001449 llvm::Value *VFuncPtr =
1450 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, VTableIndex, "vfn");
1451 return CGF.Builder.CreateLoad(VFuncPtr);
1452}
1453
David Majnemer0c0b6d92014-10-31 20:09:12 +00001454llvm::Value *ItaniumCXXABI::EmitVirtualDestructorCall(
1455 CodeGenFunction &CGF, const CXXDestructorDecl *Dtor, CXXDtorType DtorType,
1456 llvm::Value *This, const CXXMemberCallExpr *CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001457 assert(CE == nullptr || CE->arg_begin() == CE->arg_end());
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001458 assert(DtorType == Dtor_Deleting || DtorType == Dtor_Complete);
1459
Rafael Espindola8d2a19b2014-09-08 16:01:27 +00001460 const CGFunctionInfo *FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
1461 Dtor, getFromDtorType(DtorType));
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001462 llvm::Type *Ty = CGF.CGM.getTypes().GetFunctionType(*FInfo);
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +00001463 llvm::Value *Callee =
1464 getVirtualFunctionPointer(CGF, GlobalDecl(Dtor, DtorType), This, Ty);
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001465
Alexey Samsonova5bf76b2014-08-25 20:17:35 +00001466 CGF.EmitCXXMemberOrOperatorCall(Dtor, Callee, ReturnValueSlot(), This,
1467 /*ImplicitParam=*/nullptr, QualType(), CE);
David Majnemer0c0b6d92014-10-31 20:09:12 +00001468 return nullptr;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +00001469}
1470
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001471void ItaniumCXXABI::emitVirtualInheritanceTables(const CXXRecordDecl *RD) {
Reid Kleckner7810af02013-06-19 15:20:38 +00001472 CodeGenVTables &VTables = CGM.getVTables();
1473 llvm::GlobalVariable *VTT = VTables.GetAddrOfVTT(RD);
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00001474 VTables.EmitVTTDefinition(VTT, CGM.getVTableLinkage(RD), RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00001475}
1476
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001477static llvm::Value *performTypeAdjustment(CodeGenFunction &CGF,
1478 llvm::Value *Ptr,
1479 int64_t NonVirtualAdjustment,
1480 int64_t VirtualAdjustment,
1481 bool IsReturnAdjustment) {
1482 if (!NonVirtualAdjustment && !VirtualAdjustment)
1483 return Ptr;
1484
1485 llvm::Type *Int8PtrTy = CGF.Int8PtrTy;
1486 llvm::Value *V = CGF.Builder.CreateBitCast(Ptr, Int8PtrTy);
1487
1488 if (NonVirtualAdjustment && !IsReturnAdjustment) {
1489 // Perform the non-virtual adjustment for a base-to-derived cast.
1490 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
1491 }
1492
1493 if (VirtualAdjustment) {
1494 llvm::Type *PtrDiffTy =
1495 CGF.ConvertType(CGF.getContext().getPointerDiffType());
1496
1497 // Perform the virtual adjustment.
1498 llvm::Value *VTablePtrPtr =
1499 CGF.Builder.CreateBitCast(V, Int8PtrTy->getPointerTo());
1500
1501 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr);
1502
1503 llvm::Value *OffsetPtr =
1504 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment);
1505
1506 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo());
1507
1508 // Load the adjustment offset from the vtable.
1509 llvm::Value *Offset = CGF.Builder.CreateLoad(OffsetPtr);
1510
1511 // Adjust our pointer.
1512 V = CGF.Builder.CreateInBoundsGEP(V, Offset);
1513 }
1514
1515 if (NonVirtualAdjustment && IsReturnAdjustment) {
1516 // Perform the non-virtual adjustment for a derived-to-base cast.
1517 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
1518 }
1519
1520 // Cast back to the original type.
1521 return CGF.Builder.CreateBitCast(V, Ptr->getType());
1522}
1523
1524llvm::Value *ItaniumCXXABI::performThisAdjustment(CodeGenFunction &CGF,
1525 llvm::Value *This,
1526 const ThisAdjustment &TA) {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00001527 return performTypeAdjustment(CGF, This, TA.NonVirtual,
1528 TA.Virtual.Itanium.VCallOffsetOffset,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00001529 /*IsReturnAdjustment=*/false);
1530}
1531
1532llvm::Value *
1533ItaniumCXXABI::performReturnAdjustment(CodeGenFunction &CGF, llvm::Value *Ret,
1534 const ReturnAdjustment &RA) {
1535 return performTypeAdjustment(CGF, Ret, RA.NonVirtual,
1536 RA.Virtual.Itanium.VBaseOffsetOffset,
1537 /*IsReturnAdjustment=*/true);
1538}
1539
John McCall5d865c322010-08-31 07:33:07 +00001540void ARMCXXABI::EmitReturnFromThunk(CodeGenFunction &CGF,
1541 RValue RV, QualType ResultType) {
1542 if (!isa<CXXDestructorDecl>(CGF.CurGD.getDecl()))
1543 return ItaniumCXXABI::EmitReturnFromThunk(CGF, RV, ResultType);
1544
1545 // Destructor thunks in the ARM ABI have indeterminate results.
Chris Lattner2192fe52011-07-18 04:24:23 +00001546 llvm::Type *T =
John McCall5d865c322010-08-31 07:33:07 +00001547 cast<llvm::PointerType>(CGF.ReturnValue->getType())->getElementType();
1548 RValue Undef = RValue::get(llvm::UndefValue::get(T));
1549 return ItaniumCXXABI::EmitReturnFromThunk(CGF, Undef, ResultType);
1550}
John McCall8ed55a52010-09-02 09:58:18 +00001551
1552/************************** Array allocation cookies **************************/
1553
John McCallb91cd662012-05-01 05:23:51 +00001554CharUnits ItaniumCXXABI::getArrayCookieSizeImpl(QualType elementType) {
1555 // The array cookie is a size_t; pad that up to the element alignment.
1556 // The cookie is actually right-justified in that space.
1557 return std::max(CharUnits::fromQuantity(CGM.SizeSizeInBytes),
1558 CGM.getContext().getTypeAlignInChars(elementType));
John McCall8ed55a52010-09-02 09:58:18 +00001559}
1560
1561llvm::Value *ItaniumCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
1562 llvm::Value *NewPtr,
1563 llvm::Value *NumElements,
John McCall284c48f2011-01-27 09:37:56 +00001564 const CXXNewExpr *expr,
John McCall8ed55a52010-09-02 09:58:18 +00001565 QualType ElementType) {
John McCallb91cd662012-05-01 05:23:51 +00001566 assert(requiresArrayCookie(expr));
John McCall8ed55a52010-09-02 09:58:18 +00001567
Micah Villmowea2fea22012-10-25 15:39:14 +00001568 unsigned AS = NewPtr->getType()->getPointerAddressSpace();
John McCall8ed55a52010-09-02 09:58:18 +00001569
John McCall9bca9232010-09-02 10:25:57 +00001570 ASTContext &Ctx = getContext();
John McCall8ed55a52010-09-02 09:58:18 +00001571 QualType SizeTy = Ctx.getSizeType();
1572 CharUnits SizeSize = Ctx.getTypeSizeInChars(SizeTy);
1573
1574 // The size of the cookie.
1575 CharUnits CookieSize =
1576 std::max(SizeSize, Ctx.getTypeAlignInChars(ElementType));
John McCallb91cd662012-05-01 05:23:51 +00001577 assert(CookieSize == getArrayCookieSizeImpl(ElementType));
John McCall8ed55a52010-09-02 09:58:18 +00001578
1579 // Compute an offset to the cookie.
1580 llvm::Value *CookiePtr = NewPtr;
1581 CharUnits CookieOffset = CookieSize - SizeSize;
1582 if (!CookieOffset.isZero())
1583 CookiePtr = CGF.Builder.CreateConstInBoundsGEP1_64(CookiePtr,
1584 CookieOffset.getQuantity());
1585
1586 // Write the number of elements into the appropriate slot.
Kostya Serebryany4ee69042014-08-26 02:29:59 +00001587 llvm::Type *NumElementsTy = CGF.ConvertType(SizeTy)->getPointerTo(AS);
1588 llvm::Value *NumElementsPtr =
1589 CGF.Builder.CreateBitCast(CookiePtr, NumElementsTy);
1590 llvm::Instruction *SI = CGF.Builder.CreateStore(NumElements, NumElementsPtr);
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001591 if (CGM.getLangOpts().Sanitize.has(SanitizerKind::Address) && AS == 0 &&
Kostya Serebryany4ee69042014-08-26 02:29:59 +00001592 expr->getOperatorNew()->isReplaceableGlobalAllocationFunction()) {
Kostya Serebryany4a9187a2014-08-29 01:01:32 +00001593 // The store to the CookiePtr does not need to be instrumented.
Kostya Serebryany4ee69042014-08-26 02:29:59 +00001594 CGM.getSanitizerMetadata()->disableSanitizerForInstruction(SI);
1595 llvm::FunctionType *FTy =
1596 llvm::FunctionType::get(CGM.VoidTy, NumElementsTy, false);
1597 llvm::Constant *F =
1598 CGM.CreateRuntimeFunction(FTy, "__asan_poison_cxx_array_cookie");
1599 CGF.Builder.CreateCall(F, NumElementsPtr);
1600 }
John McCall8ed55a52010-09-02 09:58:18 +00001601
1602 // Finally, compute a pointer to the actual data buffer by skipping
1603 // over the cookie completely.
1604 return CGF.Builder.CreateConstInBoundsGEP1_64(NewPtr,
1605 CookieSize.getQuantity());
1606}
1607
John McCallb91cd662012-05-01 05:23:51 +00001608llvm::Value *ItaniumCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
1609 llvm::Value *allocPtr,
1610 CharUnits cookieSize) {
1611 // The element size is right-justified in the cookie.
1612 llvm::Value *numElementsPtr = allocPtr;
1613 CharUnits numElementsOffset =
1614 cookieSize - CharUnits::fromQuantity(CGF.SizeSizeInBytes);
1615 if (!numElementsOffset.isZero())
1616 numElementsPtr =
1617 CGF.Builder.CreateConstInBoundsGEP1_64(numElementsPtr,
1618 numElementsOffset.getQuantity());
John McCall8ed55a52010-09-02 09:58:18 +00001619
Micah Villmowea2fea22012-10-25 15:39:14 +00001620 unsigned AS = allocPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001621 numElementsPtr =
1622 CGF.Builder.CreateBitCast(numElementsPtr, CGF.SizeTy->getPointerTo(AS));
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001623 if (!CGM.getLangOpts().Sanitize.has(SanitizerKind::Address) || AS != 0)
Kostya Serebryany4a9187a2014-08-29 01:01:32 +00001624 return CGF.Builder.CreateLoad(numElementsPtr);
1625 // In asan mode emit a function call instead of a regular load and let the
1626 // run-time deal with it: if the shadow is properly poisoned return the
1627 // cookie, otherwise return 0 to avoid an infinite loop calling DTORs.
1628 // We can't simply ignore this load using nosanitize metadata because
1629 // the metadata may be lost.
1630 llvm::FunctionType *FTy =
1631 llvm::FunctionType::get(CGF.SizeTy, CGF.SizeTy->getPointerTo(0), false);
1632 llvm::Constant *F =
1633 CGM.CreateRuntimeFunction(FTy, "__asan_load_cxx_array_cookie");
1634 return CGF.Builder.CreateCall(F, numElementsPtr);
John McCall8ed55a52010-09-02 09:58:18 +00001635}
1636
John McCallb91cd662012-05-01 05:23:51 +00001637CharUnits ARMCXXABI::getArrayCookieSizeImpl(QualType elementType) {
John McCallc19c7062013-01-25 23:36:19 +00001638 // ARM says that the cookie is always:
John McCall8ed55a52010-09-02 09:58:18 +00001639 // struct array_cookie {
1640 // std::size_t element_size; // element_size != 0
1641 // std::size_t element_count;
1642 // };
John McCallc19c7062013-01-25 23:36:19 +00001643 // But the base ABI doesn't give anything an alignment greater than
1644 // 8, so we can dismiss this as typical ABI-author blindness to
1645 // actual language complexity and round up to the element alignment.
1646 return std::max(CharUnits::fromQuantity(2 * CGM.SizeSizeInBytes),
1647 CGM.getContext().getTypeAlignInChars(elementType));
John McCall8ed55a52010-09-02 09:58:18 +00001648}
1649
1650llvm::Value *ARMCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
John McCallc19c7062013-01-25 23:36:19 +00001651 llvm::Value *newPtr,
1652 llvm::Value *numElements,
John McCall284c48f2011-01-27 09:37:56 +00001653 const CXXNewExpr *expr,
John McCallc19c7062013-01-25 23:36:19 +00001654 QualType elementType) {
John McCallb91cd662012-05-01 05:23:51 +00001655 assert(requiresArrayCookie(expr));
John McCall8ed55a52010-09-02 09:58:18 +00001656
John McCallc19c7062013-01-25 23:36:19 +00001657 // NewPtr is a char*, but we generalize to arbitrary addrspaces.
1658 unsigned AS = newPtr->getType()->getPointerAddressSpace();
John McCall8ed55a52010-09-02 09:58:18 +00001659
1660 // The cookie is always at the start of the buffer.
John McCallc19c7062013-01-25 23:36:19 +00001661 llvm::Value *cookie = newPtr;
John McCall8ed55a52010-09-02 09:58:18 +00001662
1663 // The first element is the element size.
John McCallc19c7062013-01-25 23:36:19 +00001664 cookie = CGF.Builder.CreateBitCast(cookie, CGF.SizeTy->getPointerTo(AS));
1665 llvm::Value *elementSize = llvm::ConstantInt::get(CGF.SizeTy,
1666 getContext().getTypeSizeInChars(elementType).getQuantity());
1667 CGF.Builder.CreateStore(elementSize, cookie);
John McCall8ed55a52010-09-02 09:58:18 +00001668
1669 // The second element is the element count.
John McCallc19c7062013-01-25 23:36:19 +00001670 cookie = CGF.Builder.CreateConstInBoundsGEP1_32(cookie, 1);
1671 CGF.Builder.CreateStore(numElements, cookie);
John McCall8ed55a52010-09-02 09:58:18 +00001672
1673 // Finally, compute a pointer to the actual data buffer by skipping
1674 // over the cookie completely.
John McCallc19c7062013-01-25 23:36:19 +00001675 CharUnits cookieSize = ARMCXXABI::getArrayCookieSizeImpl(elementType);
1676 return CGF.Builder.CreateConstInBoundsGEP1_64(newPtr,
1677 cookieSize.getQuantity());
John McCall8ed55a52010-09-02 09:58:18 +00001678}
1679
John McCallb91cd662012-05-01 05:23:51 +00001680llvm::Value *ARMCXXABI::readArrayCookieImpl(CodeGenFunction &CGF,
1681 llvm::Value *allocPtr,
1682 CharUnits cookieSize) {
1683 // The number of elements is at offset sizeof(size_t) relative to
1684 // the allocated pointer.
1685 llvm::Value *numElementsPtr
1686 = CGF.Builder.CreateConstInBoundsGEP1_64(allocPtr, CGF.SizeSizeInBytes);
John McCall8ed55a52010-09-02 09:58:18 +00001687
Micah Villmowea2fea22012-10-25 15:39:14 +00001688 unsigned AS = allocPtr->getType()->getPointerAddressSpace();
John McCallb91cd662012-05-01 05:23:51 +00001689 numElementsPtr =
1690 CGF.Builder.CreateBitCast(numElementsPtr, CGF.SizeTy->getPointerTo(AS));
1691 return CGF.Builder.CreateLoad(numElementsPtr);
John McCall8ed55a52010-09-02 09:58:18 +00001692}
1693
John McCall68ff0372010-09-08 01:44:27 +00001694/*********************** Static local initialization **************************/
1695
1696static llvm::Constant *getGuardAcquireFn(CodeGenModule &CGM,
Chris Lattnera5f58b02011-07-09 17:41:47 +00001697 llvm::PointerType *GuardPtrTy) {
John McCall68ff0372010-09-08 01:44:27 +00001698 // int __cxa_guard_acquire(__guard *guard_object);
Chris Lattner2192fe52011-07-18 04:24:23 +00001699 llvm::FunctionType *FTy =
John McCall68ff0372010-09-08 01:44:27 +00001700 llvm::FunctionType::get(CGM.getTypes().ConvertType(CGM.getContext().IntTy),
Jay Foad5709f7c2011-07-29 13:56:53 +00001701 GuardPtrTy, /*isVarArg=*/false);
Nick Lewyckyadcec492012-02-13 23:45:02 +00001702 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_acquire",
Bill Wendling8594fcb2013-01-31 00:30:05 +00001703 llvm::AttributeSet::get(CGM.getLLVMContext(),
1704 llvm::AttributeSet::FunctionIndex,
Bill Wendling207f0532012-12-20 19:27:06 +00001705 llvm::Attribute::NoUnwind));
John McCall68ff0372010-09-08 01:44:27 +00001706}
1707
1708static llvm::Constant *getGuardReleaseFn(CodeGenModule &CGM,
Chris Lattnera5f58b02011-07-09 17:41:47 +00001709 llvm::PointerType *GuardPtrTy) {
John McCall68ff0372010-09-08 01:44:27 +00001710 // void __cxa_guard_release(__guard *guard_object);
Chris Lattner2192fe52011-07-18 04:24:23 +00001711 llvm::FunctionType *FTy =
Chris Lattnerece04092012-02-07 00:39:47 +00001712 llvm::FunctionType::get(CGM.VoidTy, GuardPtrTy, /*isVarArg=*/false);
Nick Lewyckyadcec492012-02-13 23:45:02 +00001713 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_release",
Bill Wendling8594fcb2013-01-31 00:30:05 +00001714 llvm::AttributeSet::get(CGM.getLLVMContext(),
1715 llvm::AttributeSet::FunctionIndex,
Bill Wendling207f0532012-12-20 19:27:06 +00001716 llvm::Attribute::NoUnwind));
John McCall68ff0372010-09-08 01:44:27 +00001717}
1718
1719static llvm::Constant *getGuardAbortFn(CodeGenModule &CGM,
Chris Lattnera5f58b02011-07-09 17:41:47 +00001720 llvm::PointerType *GuardPtrTy) {
John McCall68ff0372010-09-08 01:44:27 +00001721 // void __cxa_guard_abort(__guard *guard_object);
Chris Lattner2192fe52011-07-18 04:24:23 +00001722 llvm::FunctionType *FTy =
Chris Lattnerece04092012-02-07 00:39:47 +00001723 llvm::FunctionType::get(CGM.VoidTy, GuardPtrTy, /*isVarArg=*/false);
Nick Lewyckyadcec492012-02-13 23:45:02 +00001724 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_abort",
Bill Wendling8594fcb2013-01-31 00:30:05 +00001725 llvm::AttributeSet::get(CGM.getLLVMContext(),
1726 llvm::AttributeSet::FunctionIndex,
Bill Wendling207f0532012-12-20 19:27:06 +00001727 llvm::Attribute::NoUnwind));
John McCall68ff0372010-09-08 01:44:27 +00001728}
1729
1730namespace {
1731 struct CallGuardAbort : EHScopeStack::Cleanup {
1732 llvm::GlobalVariable *Guard;
Chandler Carruth84537952012-03-30 19:44:53 +00001733 CallGuardAbort(llvm::GlobalVariable *Guard) : Guard(Guard) {}
John McCall68ff0372010-09-08 01:44:27 +00001734
Craig Topper4f12f102014-03-12 06:41:41 +00001735 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall882987f2013-02-28 19:01:20 +00001736 CGF.EmitNounwindRuntimeCall(getGuardAbortFn(CGF.CGM, Guard->getType()),
1737 Guard);
John McCall68ff0372010-09-08 01:44:27 +00001738 }
1739 };
1740}
1741
1742/// The ARM code here follows the Itanium code closely enough that we
1743/// just special-case it at particular places.
John McCallcdf7ef52010-11-06 09:44:32 +00001744void ItaniumCXXABI::EmitGuardedInit(CodeGenFunction &CGF,
1745 const VarDecl &D,
John McCallb88a5662012-03-30 21:00:39 +00001746 llvm::GlobalVariable *var,
1747 bool shouldPerformInit) {
John McCall68ff0372010-09-08 01:44:27 +00001748 CGBuilderTy &Builder = CGF.Builder;
John McCallcdf7ef52010-11-06 09:44:32 +00001749
Richard Smithdbf74ba2013-04-14 23:01:42 +00001750 // We only need to use thread-safe statics for local non-TLS variables;
John McCallcdf7ef52010-11-06 09:44:32 +00001751 // global initialization is always single-threaded.
Richard Smithdbf74ba2013-04-14 23:01:42 +00001752 bool threadsafe = getContext().getLangOpts().ThreadsafeStatics &&
1753 D.isLocalVarDecl() && !D.getTLSKind();
Anders Carlssonc5d3ba12011-04-27 04:37:08 +00001754
Anders Carlssonc5d3ba12011-04-27 04:37:08 +00001755 // If we have a global variable with internal linkage and thread-safe statics
1756 // are disabled, we can just let the guard variable be of type i8.
John McCallb88a5662012-03-30 21:00:39 +00001757 bool useInt8GuardVariable = !threadsafe && var->hasInternalLinkage();
1758
1759 llvm::IntegerType *guardTy;
John McCall5aa52592011-06-17 07:33:57 +00001760 if (useInt8GuardVariable) {
John McCallb88a5662012-03-30 21:00:39 +00001761 guardTy = CGF.Int8Ty;
John McCall5aa52592011-06-17 07:33:57 +00001762 } else {
Tim Northover9bb857a2013-01-31 12:13:10 +00001763 // Guard variables are 64 bits in the generic ABI and size width on ARM
1764 // (i.e. 32-bit on AArch32, 64-bit on AArch64).
Mark Seabornedf0d382013-07-24 16:25:13 +00001765 guardTy = (UseARMGuardVarABI ? CGF.SizeTy : CGF.Int64Ty);
Anders Carlssonc5d3ba12011-04-27 04:37:08 +00001766 }
John McCallb88a5662012-03-30 21:00:39 +00001767 llvm::PointerType *guardPtrTy = guardTy->getPointerTo();
John McCall68ff0372010-09-08 01:44:27 +00001768
John McCallb88a5662012-03-30 21:00:39 +00001769 // Create the guard variable if we don't already have it (as we
1770 // might if we're double-emitting this function body).
1771 llvm::GlobalVariable *guard = CGM.getStaticLocalDeclGuardAddress(&D);
1772 if (!guard) {
1773 // Mangle the name for the guard.
1774 SmallString<256> guardName;
1775 {
1776 llvm::raw_svector_ostream out(guardName);
Reid Klecknerd8110b62013-09-10 20:14:30 +00001777 getMangleContext().mangleStaticGuardVariable(&D, out);
John McCallb88a5662012-03-30 21:00:39 +00001778 out.flush();
1779 }
John McCall8e7cb6d2010-11-02 21:04:24 +00001780
John McCallb88a5662012-03-30 21:00:39 +00001781 // Create the guard variable with a zero-initializer.
1782 // Just absorb linkage and visibility from the guarded variable.
1783 guard = new llvm::GlobalVariable(CGM.getModule(), guardTy,
1784 false, var->getLinkage(),
1785 llvm::ConstantInt::get(guardTy, 0),
1786 guardName.str());
1787 guard->setVisibility(var->getVisibility());
Richard Smithdbf74ba2013-04-14 23:01:42 +00001788 // If the variable is thread-local, so is its guard variable.
1789 guard->setThreadLocalMode(var->getThreadLocalMode());
John McCallb88a5662012-03-30 21:00:39 +00001790
Rafael Espindola2ae4b632014-09-19 19:43:18 +00001791 // The ABI says: It is suggested that it be emitted in the same COMDAT group
1792 // as the associated data object
Rafael Espindola0d4fb982015-01-12 22:13:53 +00001793 llvm::Comdat *C = var->getComdat();
1794 if (!D.isLocalVarDecl() && C) {
Rafael Espindola2ae4b632014-09-19 19:43:18 +00001795 guard->setComdat(C);
Rafael Espindola2ae4b632014-09-19 19:43:18 +00001796 CGF.CurFn->setComdat(C);
Rafael Espindola0d4fb982015-01-12 22:13:53 +00001797 } else if (CGM.supportsCOMDAT() && guard->isWeakForLinker()) {
1798 guard->setComdat(CGM.getModule().getOrInsertComdat(guard->getName()));
Rafael Espindola2ae4b632014-09-19 19:43:18 +00001799 }
1800
John McCallb88a5662012-03-30 21:00:39 +00001801 CGM.setStaticLocalDeclGuardAddress(&D, guard);
1802 }
John McCall87590e62012-03-30 07:09:50 +00001803
John McCall68ff0372010-09-08 01:44:27 +00001804 // Test whether the variable has completed initialization.
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001805 //
John McCall68ff0372010-09-08 01:44:27 +00001806 // Itanium C++ ABI 3.3.2:
1807 // The following is pseudo-code showing how these functions can be used:
1808 // if (obj_guard.first_byte == 0) {
1809 // if ( __cxa_guard_acquire (&obj_guard) ) {
1810 // try {
1811 // ... initialize the object ...;
1812 // } catch (...) {
1813 // __cxa_guard_abort (&obj_guard);
1814 // throw;
1815 // }
1816 // ... queue object destructor with __cxa_atexit() ...;
1817 // __cxa_guard_release (&obj_guard);
1818 // }
1819 // }
Tim Northovera2ee4332014-03-29 15:09:45 +00001820
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001821 // Load the first byte of the guard variable.
1822 llvm::LoadInst *LI =
John McCallb88a5662012-03-30 21:00:39 +00001823 Builder.CreateLoad(Builder.CreateBitCast(guard, CGM.Int8PtrTy));
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001824 LI->setAlignment(1);
John McCall68ff0372010-09-08 01:44:27 +00001825
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001826 // Itanium ABI:
1827 // An implementation supporting thread-safety on multiprocessor
1828 // systems must also guarantee that references to the initialized
1829 // object do not occur before the load of the initialization flag.
1830 //
1831 // In LLVM, we do this by marking the load Acquire.
1832 if (threadsafe)
1833 LI->setAtomic(llvm::Acquire);
Eli Friedman84d28122011-09-13 22:21:56 +00001834
Justin Bogner0cbb6d82014-04-23 01:50:10 +00001835 // For ARM, we should only check the first bit, rather than the entire byte:
1836 //
1837 // ARM C++ ABI 3.2.3.1:
1838 // To support the potential use of initialization guard variables
1839 // as semaphores that are the target of ARM SWP and LDREX/STREX
1840 // synchronizing instructions we define a static initialization
1841 // guard variable to be a 4-byte aligned, 4-byte word with the
1842 // following inline access protocol.
1843 // #define INITIALIZED 1
1844 // if ((obj_guard & INITIALIZED) != INITIALIZED) {
1845 // if (__cxa_guard_acquire(&obj_guard))
1846 // ...
1847 // }
1848 //
1849 // and similarly for ARM64:
1850 //
1851 // ARM64 C++ ABI 3.2.2:
1852 // This ABI instead only specifies the value bit 0 of the static guard
1853 // variable; all other bits are platform defined. Bit 0 shall be 0 when the
1854 // variable is not initialized and 1 when it is.
1855 llvm::Value *V =
1856 (UseARMGuardVarABI && !useInt8GuardVariable)
1857 ? Builder.CreateAnd(LI, llvm::ConstantInt::get(CGM.Int8Ty, 1))
1858 : LI;
1859 llvm::Value *isInitialized = Builder.CreateIsNull(V, "guard.uninitialized");
John McCall68ff0372010-09-08 01:44:27 +00001860
1861 llvm::BasicBlock *InitCheckBlock = CGF.createBasicBlock("init.check");
1862 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
1863
1864 // Check if the first byte of the guard variable is zero.
John McCallb88a5662012-03-30 21:00:39 +00001865 Builder.CreateCondBr(isInitialized, InitCheckBlock, EndBlock);
John McCall68ff0372010-09-08 01:44:27 +00001866
1867 CGF.EmitBlock(InitCheckBlock);
1868
1869 // Variables used when coping with thread-safe statics and exceptions.
John McCall5aa52592011-06-17 07:33:57 +00001870 if (threadsafe) {
John McCall68ff0372010-09-08 01:44:27 +00001871 // Call __cxa_guard_acquire.
1872 llvm::Value *V
John McCall882987f2013-02-28 19:01:20 +00001873 = CGF.EmitNounwindRuntimeCall(getGuardAcquireFn(CGM, guardPtrTy), guard);
John McCall68ff0372010-09-08 01:44:27 +00001874
1875 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
1876
1877 Builder.CreateCondBr(Builder.CreateIsNotNull(V, "tobool"),
1878 InitBlock, EndBlock);
1879
1880 // Call __cxa_guard_abort along the exceptional edge.
John McCallb88a5662012-03-30 21:00:39 +00001881 CGF.EHStack.pushCleanup<CallGuardAbort>(EHCleanup, guard);
John McCall68ff0372010-09-08 01:44:27 +00001882
1883 CGF.EmitBlock(InitBlock);
1884 }
1885
1886 // Emit the initializer and add a global destructor if appropriate.
John McCallb88a5662012-03-30 21:00:39 +00001887 CGF.EmitCXXGlobalVarDeclInit(D, var, shouldPerformInit);
John McCall68ff0372010-09-08 01:44:27 +00001888
John McCall5aa52592011-06-17 07:33:57 +00001889 if (threadsafe) {
John McCall68ff0372010-09-08 01:44:27 +00001890 // Pop the guard-abort cleanup if we pushed one.
1891 CGF.PopCleanupBlock();
1892
1893 // Call __cxa_guard_release. This cannot throw.
John McCall882987f2013-02-28 19:01:20 +00001894 CGF.EmitNounwindRuntimeCall(getGuardReleaseFn(CGM, guardPtrTy), guard);
John McCall68ff0372010-09-08 01:44:27 +00001895 } else {
John McCallb88a5662012-03-30 21:00:39 +00001896 Builder.CreateStore(llvm::ConstantInt::get(guardTy, 1), guard);
John McCall68ff0372010-09-08 01:44:27 +00001897 }
1898
1899 CGF.EmitBlock(EndBlock);
1900}
John McCallc84ed6a2012-05-01 06:13:13 +00001901
1902/// Register a global destructor using __cxa_atexit.
1903static void emitGlobalDtorWithCXAAtExit(CodeGenFunction &CGF,
1904 llvm::Constant *dtor,
Richard Smithdbf74ba2013-04-14 23:01:42 +00001905 llvm::Constant *addr,
1906 bool TLS) {
Bill Wendling95cae882013-05-02 19:18:03 +00001907 const char *Name = "__cxa_atexit";
1908 if (TLS) {
1909 const llvm::Triple &T = CGF.getTarget().getTriple();
1910 Name = T.isMacOSX() ? "_tlv_atexit" : "__cxa_thread_atexit";
1911 }
Richard Smithdbf74ba2013-04-14 23:01:42 +00001912
John McCallc84ed6a2012-05-01 06:13:13 +00001913 // We're assuming that the destructor function is something we can
1914 // reasonably call with the default CC. Go ahead and cast it to the
1915 // right prototype.
1916 llvm::Type *dtorTy =
1917 llvm::FunctionType::get(CGF.VoidTy, CGF.Int8PtrTy, false)->getPointerTo();
1918
1919 // extern "C" int __cxa_atexit(void (*f)(void *), void *p, void *d);
1920 llvm::Type *paramTys[] = { dtorTy, CGF.Int8PtrTy, CGF.Int8PtrTy };
1921 llvm::FunctionType *atexitTy =
1922 llvm::FunctionType::get(CGF.IntTy, paramTys, false);
1923
1924 // Fetch the actual function.
Richard Smithdbf74ba2013-04-14 23:01:42 +00001925 llvm::Constant *atexit = CGF.CGM.CreateRuntimeFunction(atexitTy, Name);
John McCallc84ed6a2012-05-01 06:13:13 +00001926 if (llvm::Function *fn = dyn_cast<llvm::Function>(atexit))
1927 fn->setDoesNotThrow();
1928
1929 // Create a variable that binds the atexit to this shared object.
1930 llvm::Constant *handle =
1931 CGF.CGM.CreateRuntimeVariable(CGF.Int8Ty, "__dso_handle");
1932
1933 llvm::Value *args[] = {
1934 llvm::ConstantExpr::getBitCast(dtor, dtorTy),
1935 llvm::ConstantExpr::getBitCast(addr, CGF.Int8PtrTy),
1936 handle
1937 };
John McCall882987f2013-02-28 19:01:20 +00001938 CGF.EmitNounwindRuntimeCall(atexit, args);
John McCallc84ed6a2012-05-01 06:13:13 +00001939}
1940
1941/// Register a global destructor as best as we know how.
1942void ItaniumCXXABI::registerGlobalDtor(CodeGenFunction &CGF,
Richard Smithdbf74ba2013-04-14 23:01:42 +00001943 const VarDecl &D,
John McCallc84ed6a2012-05-01 06:13:13 +00001944 llvm::Constant *dtor,
1945 llvm::Constant *addr) {
1946 // Use __cxa_atexit if available.
Richard Smithdbf74ba2013-04-14 23:01:42 +00001947 if (CGM.getCodeGenOpts().CXAAtExit)
1948 return emitGlobalDtorWithCXAAtExit(CGF, dtor, addr, D.getTLSKind());
1949
1950 if (D.getTLSKind())
1951 CGM.ErrorUnsupported(&D, "non-trivial TLS destruction");
John McCallc84ed6a2012-05-01 06:13:13 +00001952
1953 // In Apple kexts, we want to add a global destructor entry.
1954 // FIXME: shouldn't this be guarded by some variable?
Richard Smith9c6890a2012-11-01 22:30:59 +00001955 if (CGM.getLangOpts().AppleKext) {
John McCallc84ed6a2012-05-01 06:13:13 +00001956 // Generate a global destructor entry.
1957 return CGM.AddCXXDtorEntry(dtor, addr);
1958 }
1959
David Blaikieebe87e12013-08-27 23:57:18 +00001960 CGF.registerGlobalDtorWithAtExit(D, dtor, addr);
John McCallc84ed6a2012-05-01 06:13:13 +00001961}
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001962
David Majnemer9b21c332014-07-11 20:28:10 +00001963static bool isThreadWrapperReplaceable(const VarDecl *VD,
1964 CodeGen::CodeGenModule &CGM) {
1965 assert(!VD->isStaticLocal() && "static local VarDecls don't need wrappers!");
1966 // OS X prefers to have references to thread local variables to go through
1967 // the thread wrapper instead of directly referencing the backing variable.
1968 return VD->getTLSKind() == VarDecl::TLS_Dynamic &&
1969 CGM.getTarget().getTriple().isMacOSX();
1970}
1971
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001972/// Get the appropriate linkage for the wrapper function. This is essentially
David Majnemer4632e1e2014-06-27 16:56:27 +00001973/// the weak form of the variable's linkage; every translation unit which needs
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001974/// the wrapper emits a copy, and we want the linker to merge them.
David Majnemer35ab3282014-06-11 04:08:55 +00001975static llvm::GlobalValue::LinkageTypes
1976getThreadLocalWrapperLinkage(const VarDecl *VD, CodeGen::CodeGenModule &CGM) {
1977 llvm::GlobalValue::LinkageTypes VarLinkage =
1978 CGM.getLLVMLinkageVarDefinition(VD, /*isConstant=*/false);
1979
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001980 // For internal linkage variables, we don't need an external or weak wrapper.
1981 if (llvm::GlobalValue::isLocalLinkage(VarLinkage))
1982 return VarLinkage;
David Majnemer35ab3282014-06-11 04:08:55 +00001983
David Majnemer9b21c332014-07-11 20:28:10 +00001984 // If the thread wrapper is replaceable, give it appropriate linkage.
1985 if (isThreadWrapperReplaceable(VD, CGM)) {
1986 if (llvm::GlobalVariable::isLinkOnceLinkage(VarLinkage) ||
1987 llvm::GlobalVariable::isWeakODRLinkage(VarLinkage))
1988 return llvm::GlobalVariable::WeakAnyLinkage;
1989 return VarLinkage;
1990 }
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001991 return llvm::GlobalValue::WeakODRLinkage;
1992}
1993
1994llvm::Function *
1995ItaniumCXXABI::getOrCreateThreadLocalWrapper(const VarDecl *VD,
Alexander Musmanf94c3182014-09-26 06:28:25 +00001996 llvm::Value *Val) {
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001997 // Mangle the name for the thread_local wrapper function.
1998 SmallString<256> WrapperName;
1999 {
2000 llvm::raw_svector_ostream Out(WrapperName);
2001 getMangleContext().mangleItaniumThreadLocalWrapper(VD, Out);
2002 Out.flush();
2003 }
2004
Alexander Musmanf94c3182014-09-26 06:28:25 +00002005 if (llvm::Value *V = CGM.getModule().getNamedValue(WrapperName))
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002006 return cast<llvm::Function>(V);
2007
Alexander Musmanf94c3182014-09-26 06:28:25 +00002008 llvm::Type *RetTy = Val->getType();
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002009 if (VD->getType()->isReferenceType())
2010 RetTy = RetTy->getPointerElementType();
2011
2012 llvm::FunctionType *FnTy = llvm::FunctionType::get(RetTy, false);
David Majnemer35ab3282014-06-11 04:08:55 +00002013 llvm::Function *Wrapper =
2014 llvm::Function::Create(FnTy, getThreadLocalWrapperLinkage(VD, CGM),
2015 WrapperName.str(), &CGM.getModule());
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002016 // Always resolve references to the wrapper at link time.
David Majnemer9b21c332014-07-11 20:28:10 +00002017 if (!Wrapper->hasLocalLinkage() && !isThreadWrapperReplaceable(VD, CGM))
Duncan P. N. Exon Smith4434d362014-05-07 22:36:11 +00002018 Wrapper->setVisibility(llvm::GlobalValue::HiddenVisibility);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002019 return Wrapper;
2020}
2021
2022void ItaniumCXXABI::EmitThreadLocalInitFuncs(
David Majnemerb3341ea2014-10-05 05:05:40 +00002023 CodeGenModule &CGM,
2024 ArrayRef<std::pair<const VarDecl *, llvm::GlobalVariable *>>
2025 CXXThreadLocals, ArrayRef<llvm::Function *> CXXThreadLocalInits,
2026 ArrayRef<llvm::GlobalVariable *> CXXThreadLocalInitVars) {
2027 llvm::Function *InitFunc = nullptr;
2028 if (!CXXThreadLocalInits.empty()) {
2029 // Generate a guarded initialization function.
2030 llvm::FunctionType *FTy =
2031 llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
2032 InitFunc = CGM.CreateGlobalInitOrDestructFunction(FTy, "__tls_init",
Alexey Samsonov1444bb92014-10-17 00:20:19 +00002033 SourceLocation(),
David Majnemerb3341ea2014-10-05 05:05:40 +00002034 /*TLS=*/true);
2035 llvm::GlobalVariable *Guard = new llvm::GlobalVariable(
2036 CGM.getModule(), CGM.Int8Ty, /*isConstant=*/false,
2037 llvm::GlobalVariable::InternalLinkage,
2038 llvm::ConstantInt::get(CGM.Int8Ty, 0), "__tls_guard");
2039 Guard->setThreadLocal(true);
2040 CodeGenFunction(CGM)
2041 .GenerateCXXGlobalInitFunc(InitFunc, CXXThreadLocalInits, Guard);
2042 }
2043 for (unsigned I = 0, N = CXXThreadLocals.size(); I != N; ++I) {
2044 const VarDecl *VD = CXXThreadLocals[I].first;
2045 llvm::GlobalVariable *Var = CXXThreadLocals[I].second;
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002046
David Majnemer9b21c332014-07-11 20:28:10 +00002047 // Some targets require that all access to thread local variables go through
2048 // the thread wrapper. This means that we cannot attempt to create a thread
2049 // wrapper or a thread helper.
2050 if (isThreadWrapperReplaceable(VD, CGM) && !VD->hasDefinition())
2051 continue;
2052
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002053 // Mangle the name for the thread_local initialization function.
2054 SmallString<256> InitFnName;
2055 {
2056 llvm::raw_svector_ostream Out(InitFnName);
2057 getMangleContext().mangleItaniumThreadLocalInit(VD, Out);
2058 Out.flush();
2059 }
2060
2061 // If we have a definition for the variable, emit the initialization
2062 // function as an alias to the global Init function (if any). Otherwise,
2063 // produce a declaration of the initialization function.
Craig Topper8a13c412014-05-21 05:09:00 +00002064 llvm::GlobalValue *Init = nullptr;
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002065 bool InitIsInitFunc = false;
2066 if (VD->hasDefinition()) {
2067 InitIsInitFunc = true;
2068 if (InitFunc)
Rafael Espindola234405b2014-05-17 21:30:14 +00002069 Init = llvm::GlobalAlias::create(Var->getLinkage(), InitFnName.str(),
2070 InitFunc);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002071 } else {
2072 // Emit a weak global function referring to the initialization function.
2073 // This function will not exist if the TU defining the thread_local
2074 // variable in question does not need any dynamic initialization for
2075 // its thread_local variables.
2076 llvm::FunctionType *FnTy = llvm::FunctionType::get(CGM.VoidTy, false);
2077 Init = llvm::Function::Create(
2078 FnTy, llvm::GlobalVariable::ExternalWeakLinkage, InitFnName.str(),
2079 &CGM.getModule());
2080 }
2081
2082 if (Init)
2083 Init->setVisibility(Var->getVisibility());
2084
2085 llvm::Function *Wrapper = getOrCreateThreadLocalWrapper(VD, Var);
2086 llvm::LLVMContext &Context = CGM.getModule().getContext();
2087 llvm::BasicBlock *Entry = llvm::BasicBlock::Create(Context, "", Wrapper);
2088 CGBuilderTy Builder(Entry);
2089 if (InitIsInitFunc) {
2090 if (Init)
2091 Builder.CreateCall(Init);
2092 } else {
2093 // Don't know whether we have an init function. Call it if it exists.
2094 llvm::Value *Have = Builder.CreateIsNotNull(Init);
2095 llvm::BasicBlock *InitBB = llvm::BasicBlock::Create(Context, "", Wrapper);
2096 llvm::BasicBlock *ExitBB = llvm::BasicBlock::Create(Context, "", Wrapper);
2097 Builder.CreateCondBr(Have, InitBB, ExitBB);
2098
2099 Builder.SetInsertPoint(InitBB);
2100 Builder.CreateCall(Init);
2101 Builder.CreateBr(ExitBB);
2102
2103 Builder.SetInsertPoint(ExitBB);
2104 }
2105
2106 // For a reference, the result of the wrapper function is a pointer to
2107 // the referenced object.
2108 llvm::Value *Val = Var;
2109 if (VD->getType()->isReferenceType()) {
2110 llvm::LoadInst *LI = Builder.CreateLoad(Val);
2111 LI->setAlignment(CGM.getContext().getDeclAlign(VD).getQuantity());
2112 Val = LI;
2113 }
Alexander Musmanf94c3182014-09-26 06:28:25 +00002114 if (Val->getType() != Wrapper->getReturnType())
2115 Val = Builder.CreatePointerBitCastOrAddrSpaceCast(
2116 Val, Wrapper->getReturnType(), "");
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002117 Builder.CreateRet(Val);
2118 }
2119}
2120
Richard Smith0f383742014-03-26 22:48:22 +00002121LValue ItaniumCXXABI::EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
2122 const VarDecl *VD,
2123 QualType LValType) {
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002124 QualType T = VD->getType();
2125 llvm::Type *Ty = CGF.getTypes().ConvertTypeForMem(T);
2126 llvm::Value *Val = CGF.CGM.GetAddrOfGlobalVar(VD, Ty);
Alexander Musmanf94c3182014-09-26 06:28:25 +00002127 llvm::Function *Wrapper = getOrCreateThreadLocalWrapper(VD, Val);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002128
2129 Val = CGF.Builder.CreateCall(Wrapper);
2130
2131 LValue LV;
2132 if (VD->getType()->isReferenceType())
Richard Smith0f383742014-03-26 22:48:22 +00002133 LV = CGF.MakeNaturalAlignAddrLValue(Val, LValType);
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002134 else
Richard Smith0f383742014-03-26 22:48:22 +00002135 LV = CGF.MakeAddrLValue(Val, LValType, CGF.getContext().getDeclAlign(VD));
Richard Smith2fd1d7a2013-04-19 16:42:07 +00002136 // FIXME: need setObjCGCLValueClass?
2137 return LV;
2138}
Peter Collingbourne66f82e62013-06-28 20:45:28 +00002139
2140/// Return whether the given global decl needs a VTT parameter, which it does
2141/// if it's a base constructor or destructor with virtual bases.
2142bool ItaniumCXXABI::NeedsVTTParameter(GlobalDecl GD) {
2143 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2144
2145 // We don't have any virtual bases, just return early.
2146 if (!MD->getParent()->getNumVBases())
2147 return false;
2148
2149 // Check if we have a base constructor.
2150 if (isa<CXXConstructorDecl>(MD) && GD.getCtorType() == Ctor_Base)
2151 return true;
2152
2153 // Check if we have a base destructor.
2154 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
2155 return true;
2156
2157 return false;
2158}
David Majnemere2cb8d12014-07-07 06:20:47 +00002159
2160namespace {
2161class ItaniumRTTIBuilder {
2162 CodeGenModule &CGM; // Per-module state.
2163 llvm::LLVMContext &VMContext;
2164 const ItaniumCXXABI &CXXABI; // Per-module state.
2165
2166 /// Fields - The fields of the RTTI descriptor currently being built.
2167 SmallVector<llvm::Constant *, 16> Fields;
2168
2169 /// GetAddrOfTypeName - Returns the mangled type name of the given type.
2170 llvm::GlobalVariable *
2171 GetAddrOfTypeName(QualType Ty, llvm::GlobalVariable::LinkageTypes Linkage);
2172
2173 /// GetAddrOfExternalRTTIDescriptor - Returns the constant for the RTTI
2174 /// descriptor of the given type.
2175 llvm::Constant *GetAddrOfExternalRTTIDescriptor(QualType Ty);
2176
2177 /// BuildVTablePointer - Build the vtable pointer for the given type.
2178 void BuildVTablePointer(const Type *Ty);
2179
2180 /// BuildSIClassTypeInfo - Build an abi::__si_class_type_info, used for single
2181 /// inheritance, according to the Itanium C++ ABI, 2.9.5p6b.
2182 void BuildSIClassTypeInfo(const CXXRecordDecl *RD);
2183
2184 /// BuildVMIClassTypeInfo - Build an abi::__vmi_class_type_info, used for
2185 /// classes with bases that do not satisfy the abi::__si_class_type_info
2186 /// constraints, according ti the Itanium C++ ABI, 2.9.5p5c.
2187 void BuildVMIClassTypeInfo(const CXXRecordDecl *RD);
2188
2189 /// BuildPointerTypeInfo - Build an abi::__pointer_type_info struct, used
2190 /// for pointer types.
2191 void BuildPointerTypeInfo(QualType PointeeTy);
2192
2193 /// BuildObjCObjectTypeInfo - Build the appropriate kind of
2194 /// type_info for an object type.
2195 void BuildObjCObjectTypeInfo(const ObjCObjectType *Ty);
2196
2197 /// BuildPointerToMemberTypeInfo - Build an abi::__pointer_to_member_type_info
2198 /// struct, used for member pointer types.
2199 void BuildPointerToMemberTypeInfo(const MemberPointerType *Ty);
2200
2201public:
2202 ItaniumRTTIBuilder(const ItaniumCXXABI &ABI)
2203 : CGM(ABI.CGM), VMContext(CGM.getModule().getContext()), CXXABI(ABI) {}
2204
2205 // Pointer type info flags.
2206 enum {
2207 /// PTI_Const - Type has const qualifier.
2208 PTI_Const = 0x1,
2209
2210 /// PTI_Volatile - Type has volatile qualifier.
2211 PTI_Volatile = 0x2,
2212
2213 /// PTI_Restrict - Type has restrict qualifier.
2214 PTI_Restrict = 0x4,
2215
2216 /// PTI_Incomplete - Type is incomplete.
2217 PTI_Incomplete = 0x8,
2218
2219 /// PTI_ContainingClassIncomplete - Containing class is incomplete.
2220 /// (in pointer to member).
2221 PTI_ContainingClassIncomplete = 0x10
2222 };
2223
2224 // VMI type info flags.
2225 enum {
2226 /// VMI_NonDiamondRepeat - Class has non-diamond repeated inheritance.
2227 VMI_NonDiamondRepeat = 0x1,
2228
2229 /// VMI_DiamondShaped - Class is diamond shaped.
2230 VMI_DiamondShaped = 0x2
2231 };
2232
2233 // Base class type info flags.
2234 enum {
2235 /// BCTI_Virtual - Base class is virtual.
2236 BCTI_Virtual = 0x1,
2237
2238 /// BCTI_Public - Base class is public.
2239 BCTI_Public = 0x2
2240 };
2241
2242 /// BuildTypeInfo - Build the RTTI type info struct for the given type.
2243 ///
2244 /// \param Force - true to force the creation of this RTTI value
2245 llvm::Constant *BuildTypeInfo(QualType Ty, bool Force = false);
2246};
2247}
2248
2249llvm::GlobalVariable *ItaniumRTTIBuilder::GetAddrOfTypeName(
2250 QualType Ty, llvm::GlobalVariable::LinkageTypes Linkage) {
2251 SmallString<256> OutName;
2252 llvm::raw_svector_ostream Out(OutName);
2253 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(Ty, Out);
2254 Out.flush();
2255 StringRef Name = OutName.str();
2256
2257 // We know that the mangled name of the type starts at index 4 of the
2258 // mangled name of the typename, so we can just index into it in order to
2259 // get the mangled name of the type.
2260 llvm::Constant *Init = llvm::ConstantDataArray::getString(VMContext,
2261 Name.substr(4));
2262
2263 llvm::GlobalVariable *GV =
2264 CGM.CreateOrReplaceCXXRuntimeVariable(Name, Init->getType(), Linkage);
2265
2266 GV->setInitializer(Init);
2267
2268 return GV;
2269}
2270
2271llvm::Constant *
2272ItaniumRTTIBuilder::GetAddrOfExternalRTTIDescriptor(QualType Ty) {
2273 // Mangle the RTTI name.
2274 SmallString<256> OutName;
2275 llvm::raw_svector_ostream Out(OutName);
2276 CGM.getCXXABI().getMangleContext().mangleCXXRTTI(Ty, Out);
2277 Out.flush();
2278 StringRef Name = OutName.str();
2279
2280 // Look for an existing global.
2281 llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name);
2282
2283 if (!GV) {
2284 // Create a new global variable.
2285 GV = new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
2286 /*Constant=*/true,
2287 llvm::GlobalValue::ExternalLinkage, nullptr,
2288 Name);
David Majnemer1fb1a042014-11-07 07:26:38 +00002289 if (const RecordType *RecordTy = dyn_cast<RecordType>(Ty)) {
2290 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RecordTy->getDecl());
2291 if (RD->hasAttr<DLLImportAttr>())
2292 GV->setDLLStorageClass(llvm::GlobalVariable::DLLImportStorageClass);
2293 }
David Majnemere2cb8d12014-07-07 06:20:47 +00002294 }
2295
2296 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
2297}
2298
2299/// TypeInfoIsInStandardLibrary - Given a builtin type, returns whether the type
2300/// info for that type is defined in the standard library.
2301static bool TypeInfoIsInStandardLibrary(const BuiltinType *Ty) {
2302 // Itanium C++ ABI 2.9.2:
2303 // Basic type information (e.g. for "int", "bool", etc.) will be kept in
2304 // the run-time support library. Specifically, the run-time support
2305 // library should contain type_info objects for the types X, X* and
2306 // X const*, for every X in: void, std::nullptr_t, bool, wchar_t, char,
2307 // unsigned char, signed char, short, unsigned short, int, unsigned int,
2308 // long, unsigned long, long long, unsigned long long, float, double,
2309 // long double, char16_t, char32_t, and the IEEE 754r decimal and
2310 // half-precision floating point types.
2311 switch (Ty->getKind()) {
2312 case BuiltinType::Void:
2313 case BuiltinType::NullPtr:
2314 case BuiltinType::Bool:
2315 case BuiltinType::WChar_S:
2316 case BuiltinType::WChar_U:
2317 case BuiltinType::Char_U:
2318 case BuiltinType::Char_S:
2319 case BuiltinType::UChar:
2320 case BuiltinType::SChar:
2321 case BuiltinType::Short:
2322 case BuiltinType::UShort:
2323 case BuiltinType::Int:
2324 case BuiltinType::UInt:
2325 case BuiltinType::Long:
2326 case BuiltinType::ULong:
2327 case BuiltinType::LongLong:
2328 case BuiltinType::ULongLong:
2329 case BuiltinType::Half:
2330 case BuiltinType::Float:
2331 case BuiltinType::Double:
2332 case BuiltinType::LongDouble:
2333 case BuiltinType::Char16:
2334 case BuiltinType::Char32:
2335 case BuiltinType::Int128:
2336 case BuiltinType::UInt128:
2337 case BuiltinType::OCLImage1d:
2338 case BuiltinType::OCLImage1dArray:
2339 case BuiltinType::OCLImage1dBuffer:
2340 case BuiltinType::OCLImage2d:
2341 case BuiltinType::OCLImage2dArray:
2342 case BuiltinType::OCLImage3d:
2343 case BuiltinType::OCLSampler:
2344 case BuiltinType::OCLEvent:
2345 return true;
2346
2347 case BuiltinType::Dependent:
2348#define BUILTIN_TYPE(Id, SingletonId)
2349#define PLACEHOLDER_TYPE(Id, SingletonId) \
2350 case BuiltinType::Id:
2351#include "clang/AST/BuiltinTypes.def"
2352 llvm_unreachable("asking for RRTI for a placeholder type!");
2353
2354 case BuiltinType::ObjCId:
2355 case BuiltinType::ObjCClass:
2356 case BuiltinType::ObjCSel:
2357 llvm_unreachable("FIXME: Objective-C types are unsupported!");
2358 }
2359
2360 llvm_unreachable("Invalid BuiltinType Kind!");
2361}
2362
2363static bool TypeInfoIsInStandardLibrary(const PointerType *PointerTy) {
2364 QualType PointeeTy = PointerTy->getPointeeType();
2365 const BuiltinType *BuiltinTy = dyn_cast<BuiltinType>(PointeeTy);
2366 if (!BuiltinTy)
2367 return false;
2368
2369 // Check the qualifiers.
2370 Qualifiers Quals = PointeeTy.getQualifiers();
2371 Quals.removeConst();
2372
2373 if (!Quals.empty())
2374 return false;
2375
2376 return TypeInfoIsInStandardLibrary(BuiltinTy);
2377}
2378
2379/// IsStandardLibraryRTTIDescriptor - Returns whether the type
2380/// information for the given type exists in the standard library.
2381static bool IsStandardLibraryRTTIDescriptor(QualType Ty) {
2382 // Type info for builtin types is defined in the standard library.
2383 if (const BuiltinType *BuiltinTy = dyn_cast<BuiltinType>(Ty))
2384 return TypeInfoIsInStandardLibrary(BuiltinTy);
2385
2386 // Type info for some pointer types to builtin types is defined in the
2387 // standard library.
2388 if (const PointerType *PointerTy = dyn_cast<PointerType>(Ty))
2389 return TypeInfoIsInStandardLibrary(PointerTy);
2390
2391 return false;
2392}
2393
2394/// ShouldUseExternalRTTIDescriptor - Returns whether the type information for
2395/// the given type exists somewhere else, and that we should not emit the type
2396/// information in this translation unit. Assumes that it is not a
2397/// standard-library type.
2398static bool ShouldUseExternalRTTIDescriptor(CodeGenModule &CGM,
2399 QualType Ty) {
2400 ASTContext &Context = CGM.getContext();
2401
2402 // If RTTI is disabled, assume it might be disabled in the
2403 // translation unit that defines any potential key function, too.
2404 if (!Context.getLangOpts().RTTI) return false;
2405
2406 if (const RecordType *RecordTy = dyn_cast<RecordType>(Ty)) {
2407 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RecordTy->getDecl());
2408 if (!RD->hasDefinition())
2409 return false;
2410
2411 if (!RD->isDynamicClass())
2412 return false;
2413
2414 // FIXME: this may need to be reconsidered if the key function
2415 // changes.
David Majnemer1fb1a042014-11-07 07:26:38 +00002416 if (CGM.getVTables().isVTableExternal(RD))
2417 return true;
2418
2419 if (RD->hasAttr<DLLImportAttr>())
2420 return true;
David Majnemere2cb8d12014-07-07 06:20:47 +00002421 }
2422
2423 return false;
2424}
2425
2426/// IsIncompleteClassType - Returns whether the given record type is incomplete.
2427static bool IsIncompleteClassType(const RecordType *RecordTy) {
2428 return !RecordTy->getDecl()->isCompleteDefinition();
2429}
2430
2431/// ContainsIncompleteClassType - Returns whether the given type contains an
2432/// incomplete class type. This is true if
2433///
2434/// * The given type is an incomplete class type.
2435/// * The given type is a pointer type whose pointee type contains an
2436/// incomplete class type.
2437/// * The given type is a member pointer type whose class is an incomplete
2438/// class type.
2439/// * The given type is a member pointer type whoise pointee type contains an
2440/// incomplete class type.
2441/// is an indirect or direct pointer to an incomplete class type.
2442static bool ContainsIncompleteClassType(QualType Ty) {
2443 if (const RecordType *RecordTy = dyn_cast<RecordType>(Ty)) {
2444 if (IsIncompleteClassType(RecordTy))
2445 return true;
2446 }
2447
2448 if (const PointerType *PointerTy = dyn_cast<PointerType>(Ty))
2449 return ContainsIncompleteClassType(PointerTy->getPointeeType());
2450
2451 if (const MemberPointerType *MemberPointerTy =
2452 dyn_cast<MemberPointerType>(Ty)) {
2453 // Check if the class type is incomplete.
2454 const RecordType *ClassType = cast<RecordType>(MemberPointerTy->getClass());
2455 if (IsIncompleteClassType(ClassType))
2456 return true;
2457
2458 return ContainsIncompleteClassType(MemberPointerTy->getPointeeType());
2459 }
2460
2461 return false;
2462}
2463
2464// CanUseSingleInheritance - Return whether the given record decl has a "single,
2465// public, non-virtual base at offset zero (i.e. the derived class is dynamic
2466// iff the base is)", according to Itanium C++ ABI, 2.95p6b.
2467static bool CanUseSingleInheritance(const CXXRecordDecl *RD) {
2468 // Check the number of bases.
2469 if (RD->getNumBases() != 1)
2470 return false;
2471
2472 // Get the base.
2473 CXXRecordDecl::base_class_const_iterator Base = RD->bases_begin();
2474
2475 // Check that the base is not virtual.
2476 if (Base->isVirtual())
2477 return false;
2478
2479 // Check that the base is public.
2480 if (Base->getAccessSpecifier() != AS_public)
2481 return false;
2482
2483 // Check that the class is dynamic iff the base is.
2484 const CXXRecordDecl *BaseDecl =
2485 cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl());
2486 if (!BaseDecl->isEmpty() &&
2487 BaseDecl->isDynamicClass() != RD->isDynamicClass())
2488 return false;
2489
2490 return true;
2491}
2492
2493void ItaniumRTTIBuilder::BuildVTablePointer(const Type *Ty) {
2494 // abi::__class_type_info.
2495 static const char * const ClassTypeInfo =
2496 "_ZTVN10__cxxabiv117__class_type_infoE";
2497 // abi::__si_class_type_info.
2498 static const char * const SIClassTypeInfo =
2499 "_ZTVN10__cxxabiv120__si_class_type_infoE";
2500 // abi::__vmi_class_type_info.
2501 static const char * const VMIClassTypeInfo =
2502 "_ZTVN10__cxxabiv121__vmi_class_type_infoE";
2503
2504 const char *VTableName = nullptr;
2505
2506 switch (Ty->getTypeClass()) {
2507#define TYPE(Class, Base)
2508#define ABSTRACT_TYPE(Class, Base)
2509#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base) case Type::Class:
2510#define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
2511#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2512#include "clang/AST/TypeNodes.def"
2513 llvm_unreachable("Non-canonical and dependent types shouldn't get here");
2514
2515 case Type::LValueReference:
2516 case Type::RValueReference:
2517 llvm_unreachable("References shouldn't get here");
2518
2519 case Type::Auto:
2520 llvm_unreachable("Undeduced auto type shouldn't get here");
2521
2522 case Type::Builtin:
2523 // GCC treats vector and complex types as fundamental types.
2524 case Type::Vector:
2525 case Type::ExtVector:
2526 case Type::Complex:
2527 case Type::Atomic:
2528 // FIXME: GCC treats block pointers as fundamental types?!
2529 case Type::BlockPointer:
2530 // abi::__fundamental_type_info.
2531 VTableName = "_ZTVN10__cxxabiv123__fundamental_type_infoE";
2532 break;
2533
2534 case Type::ConstantArray:
2535 case Type::IncompleteArray:
2536 case Type::VariableArray:
2537 // abi::__array_type_info.
2538 VTableName = "_ZTVN10__cxxabiv117__array_type_infoE";
2539 break;
2540
2541 case Type::FunctionNoProto:
2542 case Type::FunctionProto:
2543 // abi::__function_type_info.
2544 VTableName = "_ZTVN10__cxxabiv120__function_type_infoE";
2545 break;
2546
2547 case Type::Enum:
2548 // abi::__enum_type_info.
2549 VTableName = "_ZTVN10__cxxabiv116__enum_type_infoE";
2550 break;
2551
2552 case Type::Record: {
2553 const CXXRecordDecl *RD =
2554 cast<CXXRecordDecl>(cast<RecordType>(Ty)->getDecl());
2555
2556 if (!RD->hasDefinition() || !RD->getNumBases()) {
2557 VTableName = ClassTypeInfo;
2558 } else if (CanUseSingleInheritance(RD)) {
2559 VTableName = SIClassTypeInfo;
2560 } else {
2561 VTableName = VMIClassTypeInfo;
2562 }
2563
2564 break;
2565 }
2566
2567 case Type::ObjCObject:
2568 // Ignore protocol qualifiers.
2569 Ty = cast<ObjCObjectType>(Ty)->getBaseType().getTypePtr();
2570
2571 // Handle id and Class.
2572 if (isa<BuiltinType>(Ty)) {
2573 VTableName = ClassTypeInfo;
2574 break;
2575 }
2576
2577 assert(isa<ObjCInterfaceType>(Ty));
2578 // Fall through.
2579
2580 case Type::ObjCInterface:
2581 if (cast<ObjCInterfaceType>(Ty)->getDecl()->getSuperClass()) {
2582 VTableName = SIClassTypeInfo;
2583 } else {
2584 VTableName = ClassTypeInfo;
2585 }
2586 break;
2587
2588 case Type::ObjCObjectPointer:
2589 case Type::Pointer:
2590 // abi::__pointer_type_info.
2591 VTableName = "_ZTVN10__cxxabiv119__pointer_type_infoE";
2592 break;
2593
2594 case Type::MemberPointer:
2595 // abi::__pointer_to_member_type_info.
2596 VTableName = "_ZTVN10__cxxabiv129__pointer_to_member_type_infoE";
2597 break;
2598 }
2599
2600 llvm::Constant *VTable =
2601 CGM.getModule().getOrInsertGlobal(VTableName, CGM.Int8PtrTy);
2602
2603 llvm::Type *PtrDiffTy =
2604 CGM.getTypes().ConvertType(CGM.getContext().getPointerDiffType());
2605
2606 // The vtable address point is 2.
2607 llvm::Constant *Two = llvm::ConstantInt::get(PtrDiffTy, 2);
2608 VTable = llvm::ConstantExpr::getInBoundsGetElementPtr(VTable, Two);
2609 VTable = llvm::ConstantExpr::getBitCast(VTable, CGM.Int8PtrTy);
2610
2611 Fields.push_back(VTable);
2612}
2613
2614/// \brief Return the linkage that the type info and type info name constants
2615/// should have for the given type.
2616static llvm::GlobalVariable::LinkageTypes getTypeInfoLinkage(CodeGenModule &CGM,
2617 QualType Ty) {
2618 // Itanium C++ ABI 2.9.5p7:
2619 // In addition, it and all of the intermediate abi::__pointer_type_info
2620 // structs in the chain down to the abi::__class_type_info for the
2621 // incomplete class type must be prevented from resolving to the
2622 // corresponding type_info structs for the complete class type, possibly
2623 // by making them local static objects. Finally, a dummy class RTTI is
2624 // generated for the incomplete type that will not resolve to the final
2625 // complete class RTTI (because the latter need not exist), possibly by
2626 // making it a local static object.
2627 if (ContainsIncompleteClassType(Ty))
2628 return llvm::GlobalValue::InternalLinkage;
2629
2630 switch (Ty->getLinkage()) {
2631 case NoLinkage:
2632 case InternalLinkage:
2633 case UniqueExternalLinkage:
2634 return llvm::GlobalValue::InternalLinkage;
2635
2636 case VisibleNoLinkage:
2637 case ExternalLinkage:
2638 if (!CGM.getLangOpts().RTTI) {
2639 // RTTI is not enabled, which means that this type info struct is going
2640 // to be used for exception handling. Give it linkonce_odr linkage.
2641 return llvm::GlobalValue::LinkOnceODRLinkage;
2642 }
2643
2644 if (const RecordType *Record = dyn_cast<RecordType>(Ty)) {
2645 const CXXRecordDecl *RD = cast<CXXRecordDecl>(Record->getDecl());
2646 if (RD->hasAttr<WeakAttr>())
2647 return llvm::GlobalValue::WeakODRLinkage;
2648 if (RD->isDynamicClass())
2649 return CGM.getVTableLinkage(RD);
2650 }
2651
2652 return llvm::GlobalValue::LinkOnceODRLinkage;
2653 }
2654
2655 llvm_unreachable("Invalid linkage!");
2656}
2657
2658llvm::Constant *ItaniumRTTIBuilder::BuildTypeInfo(QualType Ty, bool Force) {
2659 // We want to operate on the canonical type.
2660 Ty = CGM.getContext().getCanonicalType(Ty);
2661
2662 // Check if we've already emitted an RTTI descriptor for this type.
2663 SmallString<256> OutName;
2664 llvm::raw_svector_ostream Out(OutName);
2665 CGM.getCXXABI().getMangleContext().mangleCXXRTTI(Ty, Out);
2666 Out.flush();
2667 StringRef Name = OutName.str();
2668
2669 llvm::GlobalVariable *OldGV = CGM.getModule().getNamedGlobal(Name);
2670 if (OldGV && !OldGV->isDeclaration()) {
2671 assert(!OldGV->hasAvailableExternallyLinkage() &&
2672 "available_externally typeinfos not yet implemented");
2673
2674 return llvm::ConstantExpr::getBitCast(OldGV, CGM.Int8PtrTy);
2675 }
2676
2677 // Check if there is already an external RTTI descriptor for this type.
2678 bool IsStdLib = IsStandardLibraryRTTIDescriptor(Ty);
2679 if (!Force && (IsStdLib || ShouldUseExternalRTTIDescriptor(CGM, Ty)))
2680 return GetAddrOfExternalRTTIDescriptor(Ty);
2681
2682 // Emit the standard library with external linkage.
2683 llvm::GlobalVariable::LinkageTypes Linkage;
2684 if (IsStdLib)
2685 Linkage = llvm::GlobalValue::ExternalLinkage;
2686 else
2687 Linkage = getTypeInfoLinkage(CGM, Ty);
2688
2689 // Add the vtable pointer.
2690 BuildVTablePointer(cast<Type>(Ty));
2691
2692 // And the name.
2693 llvm::GlobalVariable *TypeName = GetAddrOfTypeName(Ty, Linkage);
2694 llvm::Constant *TypeNameField;
2695
2696 // If we're supposed to demote the visibility, be sure to set a flag
2697 // to use a string comparison for type_info comparisons.
2698 ItaniumCXXABI::RTTIUniquenessKind RTTIUniqueness =
2699 CXXABI.classifyRTTIUniqueness(Ty, Linkage);
2700 if (RTTIUniqueness != ItaniumCXXABI::RUK_Unique) {
2701 // The flag is the sign bit, which on ARM64 is defined to be clear
2702 // for global pointers. This is very ARM64-specific.
2703 TypeNameField = llvm::ConstantExpr::getPtrToInt(TypeName, CGM.Int64Ty);
2704 llvm::Constant *flag =
2705 llvm::ConstantInt::get(CGM.Int64Ty, ((uint64_t)1) << 63);
2706 TypeNameField = llvm::ConstantExpr::getAdd(TypeNameField, flag);
2707 TypeNameField =
2708 llvm::ConstantExpr::getIntToPtr(TypeNameField, CGM.Int8PtrTy);
2709 } else {
2710 TypeNameField = llvm::ConstantExpr::getBitCast(TypeName, CGM.Int8PtrTy);
2711 }
2712 Fields.push_back(TypeNameField);
2713
2714 switch (Ty->getTypeClass()) {
2715#define TYPE(Class, Base)
2716#define ABSTRACT_TYPE(Class, Base)
2717#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base) case Type::Class:
2718#define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
2719#define DEPENDENT_TYPE(Class, Base) case Type::Class:
2720#include "clang/AST/TypeNodes.def"
2721 llvm_unreachable("Non-canonical and dependent types shouldn't get here");
2722
2723 // GCC treats vector types as fundamental types.
2724 case Type::Builtin:
2725 case Type::Vector:
2726 case Type::ExtVector:
2727 case Type::Complex:
2728 case Type::BlockPointer:
2729 // Itanium C++ ABI 2.9.5p4:
2730 // abi::__fundamental_type_info adds no data members to std::type_info.
2731 break;
2732
2733 case Type::LValueReference:
2734 case Type::RValueReference:
2735 llvm_unreachable("References shouldn't get here");
2736
2737 case Type::Auto:
2738 llvm_unreachable("Undeduced auto type shouldn't get here");
2739
2740 case Type::ConstantArray:
2741 case Type::IncompleteArray:
2742 case Type::VariableArray:
2743 // Itanium C++ ABI 2.9.5p5:
2744 // abi::__array_type_info adds no data members to std::type_info.
2745 break;
2746
2747 case Type::FunctionNoProto:
2748 case Type::FunctionProto:
2749 // Itanium C++ ABI 2.9.5p5:
2750 // abi::__function_type_info adds no data members to std::type_info.
2751 break;
2752
2753 case Type::Enum:
2754 // Itanium C++ ABI 2.9.5p5:
2755 // abi::__enum_type_info adds no data members to std::type_info.
2756 break;
2757
2758 case Type::Record: {
2759 const CXXRecordDecl *RD =
2760 cast<CXXRecordDecl>(cast<RecordType>(Ty)->getDecl());
2761 if (!RD->hasDefinition() || !RD->getNumBases()) {
2762 // We don't need to emit any fields.
2763 break;
2764 }
2765
2766 if (CanUseSingleInheritance(RD))
2767 BuildSIClassTypeInfo(RD);
2768 else
2769 BuildVMIClassTypeInfo(RD);
2770
2771 break;
2772 }
2773
2774 case Type::ObjCObject:
2775 case Type::ObjCInterface:
2776 BuildObjCObjectTypeInfo(cast<ObjCObjectType>(Ty));
2777 break;
2778
2779 case Type::ObjCObjectPointer:
2780 BuildPointerTypeInfo(cast<ObjCObjectPointerType>(Ty)->getPointeeType());
2781 break;
2782
2783 case Type::Pointer:
2784 BuildPointerTypeInfo(cast<PointerType>(Ty)->getPointeeType());
2785 break;
2786
2787 case Type::MemberPointer:
2788 BuildPointerToMemberTypeInfo(cast<MemberPointerType>(Ty));
2789 break;
2790
2791 case Type::Atomic:
2792 // No fields, at least for the moment.
2793 break;
2794 }
2795
2796 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Fields);
2797
Rafael Espindolacb92c192015-01-15 23:18:01 +00002798 llvm::Module &M = CGM.getModule();
David Majnemere2cb8d12014-07-07 06:20:47 +00002799 llvm::GlobalVariable *GV =
Rafael Espindolacb92c192015-01-15 23:18:01 +00002800 new llvm::GlobalVariable(M, Init->getType(),
2801 /*Constant=*/true, Linkage, Init, Name);
2802
2803 if (CGM.supportsCOMDAT() && GV->isWeakForLinker())
2804 GV->setComdat(M.getOrInsertComdat(GV->getName()));
David Majnemere2cb8d12014-07-07 06:20:47 +00002805
2806 // If there's already an old global variable, replace it with the new one.
2807 if (OldGV) {
2808 GV->takeName(OldGV);
2809 llvm::Constant *NewPtr =
2810 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
2811 OldGV->replaceAllUsesWith(NewPtr);
2812 OldGV->eraseFromParent();
2813 }
2814
2815 // The Itanium ABI specifies that type_info objects must be globally
2816 // unique, with one exception: if the type is an incomplete class
2817 // type or a (possibly indirect) pointer to one. That exception
2818 // affects the general case of comparing type_info objects produced
2819 // by the typeid operator, which is why the comparison operators on
2820 // std::type_info generally use the type_info name pointers instead
2821 // of the object addresses. However, the language's built-in uses
2822 // of RTTI generally require class types to be complete, even when
2823 // manipulating pointers to those class types. This allows the
2824 // implementation of dynamic_cast to rely on address equality tests,
2825 // which is much faster.
2826
2827 // All of this is to say that it's important that both the type_info
2828 // object and the type_info name be uniqued when weakly emitted.
2829
2830 // Give the type_info object and name the formal visibility of the
2831 // type itself.
2832 llvm::GlobalValue::VisibilityTypes llvmVisibility;
2833 if (llvm::GlobalValue::isLocalLinkage(Linkage))
2834 // If the linkage is local, only default visibility makes sense.
2835 llvmVisibility = llvm::GlobalValue::DefaultVisibility;
2836 else if (RTTIUniqueness == ItaniumCXXABI::RUK_NonUniqueHidden)
2837 llvmVisibility = llvm::GlobalValue::HiddenVisibility;
2838 else
2839 llvmVisibility = CodeGenModule::GetLLVMVisibility(Ty->getVisibility());
2840 TypeName->setVisibility(llvmVisibility);
2841 GV->setVisibility(llvmVisibility);
2842
2843 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
2844}
2845
2846/// ComputeQualifierFlags - Compute the pointer type info flags from the
2847/// given qualifier.
2848static unsigned ComputeQualifierFlags(Qualifiers Quals) {
2849 unsigned Flags = 0;
2850
2851 if (Quals.hasConst())
2852 Flags |= ItaniumRTTIBuilder::PTI_Const;
2853 if (Quals.hasVolatile())
2854 Flags |= ItaniumRTTIBuilder::PTI_Volatile;
2855 if (Quals.hasRestrict())
2856 Flags |= ItaniumRTTIBuilder::PTI_Restrict;
2857
2858 return Flags;
2859}
2860
2861/// BuildObjCObjectTypeInfo - Build the appropriate kind of type_info
2862/// for the given Objective-C object type.
2863void ItaniumRTTIBuilder::BuildObjCObjectTypeInfo(const ObjCObjectType *OT) {
2864 // Drop qualifiers.
2865 const Type *T = OT->getBaseType().getTypePtr();
2866 assert(isa<BuiltinType>(T) || isa<ObjCInterfaceType>(T));
2867
2868 // The builtin types are abi::__class_type_infos and don't require
2869 // extra fields.
2870 if (isa<BuiltinType>(T)) return;
2871
2872 ObjCInterfaceDecl *Class = cast<ObjCInterfaceType>(T)->getDecl();
2873 ObjCInterfaceDecl *Super = Class->getSuperClass();
2874
2875 // Root classes are also __class_type_info.
2876 if (!Super) return;
2877
2878 QualType SuperTy = CGM.getContext().getObjCInterfaceType(Super);
2879
2880 // Everything else is single inheritance.
2881 llvm::Constant *BaseTypeInfo =
2882 ItaniumRTTIBuilder(CXXABI).BuildTypeInfo(SuperTy);
2883 Fields.push_back(BaseTypeInfo);
2884}
2885
2886/// BuildSIClassTypeInfo - Build an abi::__si_class_type_info, used for single
2887/// inheritance, according to the Itanium C++ ABI, 2.95p6b.
2888void ItaniumRTTIBuilder::BuildSIClassTypeInfo(const CXXRecordDecl *RD) {
2889 // Itanium C++ ABI 2.9.5p6b:
2890 // It adds to abi::__class_type_info a single member pointing to the
2891 // type_info structure for the base type,
2892 llvm::Constant *BaseTypeInfo =
2893 ItaniumRTTIBuilder(CXXABI).BuildTypeInfo(RD->bases_begin()->getType());
2894 Fields.push_back(BaseTypeInfo);
2895}
2896
2897namespace {
2898 /// SeenBases - Contains virtual and non-virtual bases seen when traversing
2899 /// a class hierarchy.
2900 struct SeenBases {
2901 llvm::SmallPtrSet<const CXXRecordDecl *, 16> NonVirtualBases;
2902 llvm::SmallPtrSet<const CXXRecordDecl *, 16> VirtualBases;
2903 };
2904}
2905
2906/// ComputeVMIClassTypeInfoFlags - Compute the value of the flags member in
2907/// abi::__vmi_class_type_info.
2908///
2909static unsigned ComputeVMIClassTypeInfoFlags(const CXXBaseSpecifier *Base,
2910 SeenBases &Bases) {
2911
2912 unsigned Flags = 0;
2913
2914 const CXXRecordDecl *BaseDecl =
2915 cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl());
2916
2917 if (Base->isVirtual()) {
2918 // Mark the virtual base as seen.
David Blaikie82e95a32014-11-19 07:49:47 +00002919 if (!Bases.VirtualBases.insert(BaseDecl).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00002920 // If this virtual base has been seen before, then the class is diamond
2921 // shaped.
2922 Flags |= ItaniumRTTIBuilder::VMI_DiamondShaped;
2923 } else {
2924 if (Bases.NonVirtualBases.count(BaseDecl))
2925 Flags |= ItaniumRTTIBuilder::VMI_NonDiamondRepeat;
2926 }
2927 } else {
2928 // Mark the non-virtual base as seen.
David Blaikie82e95a32014-11-19 07:49:47 +00002929 if (!Bases.NonVirtualBases.insert(BaseDecl).second) {
David Majnemere2cb8d12014-07-07 06:20:47 +00002930 // If this non-virtual base has been seen before, then the class has non-
2931 // diamond shaped repeated inheritance.
2932 Flags |= ItaniumRTTIBuilder::VMI_NonDiamondRepeat;
2933 } else {
2934 if (Bases.VirtualBases.count(BaseDecl))
2935 Flags |= ItaniumRTTIBuilder::VMI_NonDiamondRepeat;
2936 }
2937 }
2938
2939 // Walk all bases.
2940 for (const auto &I : BaseDecl->bases())
2941 Flags |= ComputeVMIClassTypeInfoFlags(&I, Bases);
2942
2943 return Flags;
2944}
2945
2946static unsigned ComputeVMIClassTypeInfoFlags(const CXXRecordDecl *RD) {
2947 unsigned Flags = 0;
2948 SeenBases Bases;
2949
2950 // Walk all bases.
2951 for (const auto &I : RD->bases())
2952 Flags |= ComputeVMIClassTypeInfoFlags(&I, Bases);
2953
2954 return Flags;
2955}
2956
2957/// BuildVMIClassTypeInfo - Build an abi::__vmi_class_type_info, used for
2958/// classes with bases that do not satisfy the abi::__si_class_type_info
2959/// constraints, according ti the Itanium C++ ABI, 2.9.5p5c.
2960void ItaniumRTTIBuilder::BuildVMIClassTypeInfo(const CXXRecordDecl *RD) {
2961 llvm::Type *UnsignedIntLTy =
2962 CGM.getTypes().ConvertType(CGM.getContext().UnsignedIntTy);
2963
2964 // Itanium C++ ABI 2.9.5p6c:
2965 // __flags is a word with flags describing details about the class
2966 // structure, which may be referenced by using the __flags_masks
2967 // enumeration. These flags refer to both direct and indirect bases.
2968 unsigned Flags = ComputeVMIClassTypeInfoFlags(RD);
2969 Fields.push_back(llvm::ConstantInt::get(UnsignedIntLTy, Flags));
2970
2971 // Itanium C++ ABI 2.9.5p6c:
2972 // __base_count is a word with the number of direct proper base class
2973 // descriptions that follow.
2974 Fields.push_back(llvm::ConstantInt::get(UnsignedIntLTy, RD->getNumBases()));
2975
2976 if (!RD->getNumBases())
2977 return;
2978
2979 llvm::Type *LongLTy =
2980 CGM.getTypes().ConvertType(CGM.getContext().LongTy);
2981
2982 // Now add the base class descriptions.
2983
2984 // Itanium C++ ABI 2.9.5p6c:
2985 // __base_info[] is an array of base class descriptions -- one for every
2986 // direct proper base. Each description is of the type:
2987 //
2988 // struct abi::__base_class_type_info {
2989 // public:
2990 // const __class_type_info *__base_type;
2991 // long __offset_flags;
2992 //
2993 // enum __offset_flags_masks {
2994 // __virtual_mask = 0x1,
2995 // __public_mask = 0x2,
2996 // __offset_shift = 8
2997 // };
2998 // };
2999 for (const auto &Base : RD->bases()) {
3000 // The __base_type member points to the RTTI for the base type.
3001 Fields.push_back(ItaniumRTTIBuilder(CXXABI).BuildTypeInfo(Base.getType()));
3002
3003 const CXXRecordDecl *BaseDecl =
3004 cast<CXXRecordDecl>(Base.getType()->getAs<RecordType>()->getDecl());
3005
3006 int64_t OffsetFlags = 0;
3007
3008 // All but the lower 8 bits of __offset_flags are a signed offset.
3009 // For a non-virtual base, this is the offset in the object of the base
3010 // subobject. For a virtual base, this is the offset in the virtual table of
3011 // the virtual base offset for the virtual base referenced (negative).
3012 CharUnits Offset;
3013 if (Base.isVirtual())
3014 Offset =
3015 CGM.getItaniumVTableContext().getVirtualBaseOffsetOffset(RD, BaseDecl);
3016 else {
3017 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3018 Offset = Layout.getBaseClassOffset(BaseDecl);
3019 };
3020
3021 OffsetFlags = uint64_t(Offset.getQuantity()) << 8;
3022
3023 // The low-order byte of __offset_flags contains flags, as given by the
3024 // masks from the enumeration __offset_flags_masks.
3025 if (Base.isVirtual())
3026 OffsetFlags |= BCTI_Virtual;
3027 if (Base.getAccessSpecifier() == AS_public)
3028 OffsetFlags |= BCTI_Public;
3029
3030 Fields.push_back(llvm::ConstantInt::get(LongLTy, OffsetFlags));
3031 }
3032}
3033
3034/// BuildPointerTypeInfo - Build an abi::__pointer_type_info struct,
3035/// used for pointer types.
3036void ItaniumRTTIBuilder::BuildPointerTypeInfo(QualType PointeeTy) {
3037 Qualifiers Quals;
3038 QualType UnqualifiedPointeeTy =
3039 CGM.getContext().getUnqualifiedArrayType(PointeeTy, Quals);
3040
3041 // Itanium C++ ABI 2.9.5p7:
3042 // __flags is a flag word describing the cv-qualification and other
3043 // attributes of the type pointed to
3044 unsigned Flags = ComputeQualifierFlags(Quals);
3045
3046 // Itanium C++ ABI 2.9.5p7:
3047 // When the abi::__pbase_type_info is for a direct or indirect pointer to an
3048 // incomplete class type, the incomplete target type flag is set.
3049 if (ContainsIncompleteClassType(UnqualifiedPointeeTy))
3050 Flags |= PTI_Incomplete;
3051
3052 llvm::Type *UnsignedIntLTy =
3053 CGM.getTypes().ConvertType(CGM.getContext().UnsignedIntTy);
3054 Fields.push_back(llvm::ConstantInt::get(UnsignedIntLTy, Flags));
3055
3056 // Itanium C++ ABI 2.9.5p7:
3057 // __pointee is a pointer to the std::type_info derivation for the
3058 // unqualified type being pointed to.
3059 llvm::Constant *PointeeTypeInfo =
3060 ItaniumRTTIBuilder(CXXABI).BuildTypeInfo(UnqualifiedPointeeTy);
3061 Fields.push_back(PointeeTypeInfo);
3062}
3063
3064/// BuildPointerToMemberTypeInfo - Build an abi::__pointer_to_member_type_info
3065/// struct, used for member pointer types.
3066void
3067ItaniumRTTIBuilder::BuildPointerToMemberTypeInfo(const MemberPointerType *Ty) {
3068 QualType PointeeTy = Ty->getPointeeType();
3069
3070 Qualifiers Quals;
3071 QualType UnqualifiedPointeeTy =
3072 CGM.getContext().getUnqualifiedArrayType(PointeeTy, Quals);
3073
3074 // Itanium C++ ABI 2.9.5p7:
3075 // __flags is a flag word describing the cv-qualification and other
3076 // attributes of the type pointed to.
3077 unsigned Flags = ComputeQualifierFlags(Quals);
3078
3079 const RecordType *ClassType = cast<RecordType>(Ty->getClass());
3080
3081 // Itanium C++ ABI 2.9.5p7:
3082 // When the abi::__pbase_type_info is for a direct or indirect pointer to an
3083 // incomplete class type, the incomplete target type flag is set.
3084 if (ContainsIncompleteClassType(UnqualifiedPointeeTy))
3085 Flags |= PTI_Incomplete;
3086
3087 if (IsIncompleteClassType(ClassType))
3088 Flags |= PTI_ContainingClassIncomplete;
3089
3090 llvm::Type *UnsignedIntLTy =
3091 CGM.getTypes().ConvertType(CGM.getContext().UnsignedIntTy);
3092 Fields.push_back(llvm::ConstantInt::get(UnsignedIntLTy, Flags));
3093
3094 // Itanium C++ ABI 2.9.5p7:
3095 // __pointee is a pointer to the std::type_info derivation for the
3096 // unqualified type being pointed to.
3097 llvm::Constant *PointeeTypeInfo =
3098 ItaniumRTTIBuilder(CXXABI).BuildTypeInfo(UnqualifiedPointeeTy);
3099 Fields.push_back(PointeeTypeInfo);
3100
3101 // Itanium C++ ABI 2.9.5p9:
3102 // __context is a pointer to an abi::__class_type_info corresponding to the
3103 // class type containing the member pointed to
3104 // (e.g., the "A" in "int A::*").
3105 Fields.push_back(
3106 ItaniumRTTIBuilder(CXXABI).BuildTypeInfo(QualType(ClassType, 0)));
3107}
3108
David Majnemer443250f2015-03-17 20:35:00 +00003109llvm::Constant *ItaniumCXXABI::getAddrOfRTTIDescriptor(QualType Ty) {
David Majnemere2cb8d12014-07-07 06:20:47 +00003110 return ItaniumRTTIBuilder(*this).BuildTypeInfo(Ty);
3111}
3112
3113void ItaniumCXXABI::EmitFundamentalRTTIDescriptor(QualType Type) {
3114 QualType PointerType = getContext().getPointerType(Type);
3115 QualType PointerTypeConst = getContext().getPointerType(Type.withConst());
3116 ItaniumRTTIBuilder(*this).BuildTypeInfo(Type, true);
3117 ItaniumRTTIBuilder(*this).BuildTypeInfo(PointerType, true);
3118 ItaniumRTTIBuilder(*this).BuildTypeInfo(PointerTypeConst, true);
3119}
3120
3121void ItaniumCXXABI::EmitFundamentalRTTIDescriptors() {
3122 QualType FundamentalTypes[] = {
3123 getContext().VoidTy, getContext().NullPtrTy,
3124 getContext().BoolTy, getContext().WCharTy,
3125 getContext().CharTy, getContext().UnsignedCharTy,
3126 getContext().SignedCharTy, getContext().ShortTy,
3127 getContext().UnsignedShortTy, getContext().IntTy,
3128 getContext().UnsignedIntTy, getContext().LongTy,
3129 getContext().UnsignedLongTy, getContext().LongLongTy,
3130 getContext().UnsignedLongLongTy, getContext().HalfTy,
3131 getContext().FloatTy, getContext().DoubleTy,
3132 getContext().LongDoubleTy, getContext().Char16Ty,
3133 getContext().Char32Ty,
3134 };
3135 for (const QualType &FundamentalType : FundamentalTypes)
3136 EmitFundamentalRTTIDescriptor(FundamentalType);
3137}
3138
3139/// What sort of uniqueness rules should we use for the RTTI for the
3140/// given type?
3141ItaniumCXXABI::RTTIUniquenessKind ItaniumCXXABI::classifyRTTIUniqueness(
3142 QualType CanTy, llvm::GlobalValue::LinkageTypes Linkage) const {
3143 if (shouldRTTIBeUnique())
3144 return RUK_Unique;
3145
3146 // It's only necessary for linkonce_odr or weak_odr linkage.
3147 if (Linkage != llvm::GlobalValue::LinkOnceODRLinkage &&
3148 Linkage != llvm::GlobalValue::WeakODRLinkage)
3149 return RUK_Unique;
3150
3151 // It's only necessary with default visibility.
3152 if (CanTy->getVisibility() != DefaultVisibility)
3153 return RUK_Unique;
3154
3155 // If we're not required to publish this symbol, hide it.
3156 if (Linkage == llvm::GlobalValue::LinkOnceODRLinkage)
3157 return RUK_NonUniqueHidden;
3158
3159 // If we're required to publish this symbol, as we might be under an
3160 // explicit instantiation, leave it with default visibility but
3161 // enable string-comparisons.
3162 assert(Linkage == llvm::GlobalValue::WeakODRLinkage);
3163 return RUK_NonUniqueVisible;
3164}
Rafael Espindola91f68b42014-09-15 19:20:10 +00003165
Rafael Espindola1e4df922014-09-16 15:18:21 +00003166// Find out how to codegen the complete destructor and constructor
3167namespace {
3168enum class StructorCodegen { Emit, RAUW, Alias, COMDAT };
3169}
3170static StructorCodegen getCodegenToUse(CodeGenModule &CGM,
3171 const CXXMethodDecl *MD) {
3172 if (!CGM.getCodeGenOpts().CXXCtorDtorAliases)
3173 return StructorCodegen::Emit;
Rafael Espindola91f68b42014-09-15 19:20:10 +00003174
Rafael Espindola1e4df922014-09-16 15:18:21 +00003175 // The complete and base structors are not equivalent if there are any virtual
3176 // bases, so emit separate functions.
3177 if (MD->getParent()->getNumVBases())
3178 return StructorCodegen::Emit;
3179
3180 GlobalDecl AliasDecl;
3181 if (const auto *DD = dyn_cast<CXXDestructorDecl>(MD)) {
3182 AliasDecl = GlobalDecl(DD, Dtor_Complete);
3183 } else {
3184 const auto *CD = cast<CXXConstructorDecl>(MD);
3185 AliasDecl = GlobalDecl(CD, Ctor_Complete);
3186 }
3187 llvm::GlobalValue::LinkageTypes Linkage = CGM.getFunctionLinkage(AliasDecl);
3188
3189 if (llvm::GlobalValue::isDiscardableIfUnused(Linkage))
3190 return StructorCodegen::RAUW;
3191
3192 // FIXME: Should we allow available_externally aliases?
3193 if (!llvm::GlobalAlias::isValidLinkage(Linkage))
3194 return StructorCodegen::RAUW;
3195
Rafael Espindola0806f982014-09-16 20:19:43 +00003196 if (llvm::GlobalValue::isWeakForLinker(Linkage)) {
3197 // Only ELF supports COMDATs with arbitrary names (C5/D5).
3198 if (CGM.getTarget().getTriple().isOSBinFormatELF())
3199 return StructorCodegen::COMDAT;
3200 return StructorCodegen::Emit;
3201 }
Rafael Espindola1e4df922014-09-16 15:18:21 +00003202
3203 return StructorCodegen::Alias;
Rafael Espindola91f68b42014-09-15 19:20:10 +00003204}
3205
Rafael Espindola1e4df922014-09-16 15:18:21 +00003206static void emitConstructorDestructorAlias(CodeGenModule &CGM,
3207 GlobalDecl AliasDecl,
3208 GlobalDecl TargetDecl) {
3209 llvm::GlobalValue::LinkageTypes Linkage = CGM.getFunctionLinkage(AliasDecl);
3210
3211 StringRef MangledName = CGM.getMangledName(AliasDecl);
3212 llvm::GlobalValue *Entry = CGM.GetGlobalValue(MangledName);
3213 if (Entry && !Entry->isDeclaration())
3214 return;
3215
3216 auto *Aliasee = cast<llvm::GlobalValue>(CGM.GetAddrOfGlobal(TargetDecl));
3217 llvm::PointerType *AliasType = Aliasee->getType();
3218
3219 // Create the alias with no name.
3220 auto *Alias = llvm::GlobalAlias::create(
3221 AliasType->getElementType(), 0, Linkage, "", Aliasee, &CGM.getModule());
3222
3223 // Switch any previous uses to the alias.
3224 if (Entry) {
3225 assert(Entry->getType() == AliasType &&
3226 "declaration exists with different type");
3227 Alias->takeName(Entry);
3228 Entry->replaceAllUsesWith(Alias);
3229 Entry->eraseFromParent();
3230 } else {
3231 Alias->setName(MangledName);
3232 }
3233
3234 // Finally, set up the alias with its proper name and attributes.
Dario Domiziolic4fb8ca72014-09-19 22:06:24 +00003235 CGM.setAliasAttributes(cast<NamedDecl>(AliasDecl.getDecl()), Alias);
Rafael Espindola1e4df922014-09-16 15:18:21 +00003236}
3237
3238void ItaniumCXXABI::emitCXXStructor(const CXXMethodDecl *MD,
3239 StructorType Type) {
3240 auto *CD = dyn_cast<CXXConstructorDecl>(MD);
3241 const CXXDestructorDecl *DD = CD ? nullptr : cast<CXXDestructorDecl>(MD);
3242
3243 StructorCodegen CGType = getCodegenToUse(CGM, MD);
3244
3245 if (Type == StructorType::Complete) {
3246 GlobalDecl CompleteDecl;
3247 GlobalDecl BaseDecl;
3248 if (CD) {
3249 CompleteDecl = GlobalDecl(CD, Ctor_Complete);
3250 BaseDecl = GlobalDecl(CD, Ctor_Base);
3251 } else {
3252 CompleteDecl = GlobalDecl(DD, Dtor_Complete);
3253 BaseDecl = GlobalDecl(DD, Dtor_Base);
3254 }
3255
3256 if (CGType == StructorCodegen::Alias || CGType == StructorCodegen::COMDAT) {
3257 emitConstructorDestructorAlias(CGM, CompleteDecl, BaseDecl);
3258 return;
3259 }
3260
3261 if (CGType == StructorCodegen::RAUW) {
3262 StringRef MangledName = CGM.getMangledName(CompleteDecl);
3263 auto *Aliasee = cast<llvm::GlobalValue>(CGM.GetAddrOfGlobal(BaseDecl));
3264 CGM.addReplacement(MangledName, Aliasee);
3265 return;
Rafael Espindola91f68b42014-09-15 19:20:10 +00003266 }
3267 }
3268
3269 // The base destructor is equivalent to the base destructor of its
3270 // base class if there is exactly one non-virtual base class with a
3271 // non-trivial destructor, there are no fields with a non-trivial
3272 // destructor, and the body of the destructor is trivial.
Rafael Espindola1e4df922014-09-16 15:18:21 +00003273 if (DD && Type == StructorType::Base && CGType != StructorCodegen::COMDAT &&
3274 !CGM.TryEmitBaseDestructorAsAlias(DD))
Rafael Espindola91f68b42014-09-15 19:20:10 +00003275 return;
3276
Rafael Espindola1e4df922014-09-16 15:18:21 +00003277 llvm::Function *Fn = CGM.codegenCXXStructor(MD, Type);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003278
Rafael Espindola1e4df922014-09-16 15:18:21 +00003279 if (CGType == StructorCodegen::COMDAT) {
3280 SmallString<256> Buffer;
3281 llvm::raw_svector_ostream Out(Buffer);
3282 if (DD)
3283 getMangleContext().mangleCXXDtorComdat(DD, Out);
3284 else
3285 getMangleContext().mangleCXXCtorComdat(CD, Out);
3286 llvm::Comdat *C = CGM.getModule().getOrInsertComdat(Out.str());
3287 Fn->setComdat(C);
Rafael Espindoladbee8a72015-01-15 21:36:08 +00003288 } else {
3289 CGM.maybeSetTrivialComdat(*MD, *Fn);
Rafael Espindola91f68b42014-09-15 19:20:10 +00003290 }
Rafael Espindola91f68b42014-09-15 19:20:10 +00003291}
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00003292
3293static llvm::Constant *getBeginCatchFn(CodeGenModule &CGM) {
3294 // void *__cxa_begin_catch(void*);
3295 llvm::FunctionType *FTy = llvm::FunctionType::get(
3296 CGM.Int8PtrTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
3297
3298 return CGM.CreateRuntimeFunction(FTy, "__cxa_begin_catch");
3299}
3300
3301static llvm::Constant *getEndCatchFn(CodeGenModule &CGM) {
3302 // void __cxa_end_catch();
3303 llvm::FunctionType *FTy =
3304 llvm::FunctionType::get(CGM.VoidTy, /*IsVarArgs=*/false);
3305
3306 return CGM.CreateRuntimeFunction(FTy, "__cxa_end_catch");
3307}
3308
3309static llvm::Constant *getGetExceptionPtrFn(CodeGenModule &CGM) {
3310 // void *__cxa_get_exception_ptr(void*);
3311 llvm::FunctionType *FTy = llvm::FunctionType::get(
3312 CGM.Int8PtrTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
3313
3314 return CGM.CreateRuntimeFunction(FTy, "__cxa_get_exception_ptr");
3315}
3316
3317namespace {
3318 /// A cleanup to call __cxa_end_catch. In many cases, the caught
3319 /// exception type lets us state definitively that the thrown exception
3320 /// type does not have a destructor. In particular:
3321 /// - Catch-alls tell us nothing, so we have to conservatively
3322 /// assume that the thrown exception might have a destructor.
3323 /// - Catches by reference behave according to their base types.
3324 /// - Catches of non-record types will only trigger for exceptions
3325 /// of non-record types, which never have destructors.
3326 /// - Catches of record types can trigger for arbitrary subclasses
3327 /// of the caught type, so we have to assume the actual thrown
3328 /// exception type might have a throwing destructor, even if the
3329 /// caught type's destructor is trivial or nothrow.
3330 struct CallEndCatch : EHScopeStack::Cleanup {
3331 CallEndCatch(bool MightThrow) : MightThrow(MightThrow) {}
3332 bool MightThrow;
3333
3334 void Emit(CodeGenFunction &CGF, Flags flags) override {
3335 if (!MightThrow) {
3336 CGF.EmitNounwindRuntimeCall(getEndCatchFn(CGF.CGM));
3337 return;
3338 }
3339
3340 CGF.EmitRuntimeCallOrInvoke(getEndCatchFn(CGF.CGM));
3341 }
3342 };
3343}
3344
3345/// Emits a call to __cxa_begin_catch and enters a cleanup to call
3346/// __cxa_end_catch.
3347///
3348/// \param EndMightThrow - true if __cxa_end_catch might throw
3349static llvm::Value *CallBeginCatch(CodeGenFunction &CGF,
3350 llvm::Value *Exn,
3351 bool EndMightThrow) {
3352 llvm::CallInst *call =
3353 CGF.EmitNounwindRuntimeCall(getBeginCatchFn(CGF.CGM), Exn);
3354
3355 CGF.EHStack.pushCleanup<CallEndCatch>(NormalAndEHCleanup, EndMightThrow);
3356
3357 return call;
3358}
3359
3360/// A "special initializer" callback for initializing a catch
3361/// parameter during catch initialization.
3362static void InitCatchParam(CodeGenFunction &CGF,
3363 const VarDecl &CatchParam,
3364 llvm::Value *ParamAddr,
3365 SourceLocation Loc) {
3366 // Load the exception from where the landing pad saved it.
3367 llvm::Value *Exn = CGF.getExceptionFromSlot();
3368
3369 CanQualType CatchType =
3370 CGF.CGM.getContext().getCanonicalType(CatchParam.getType());
3371 llvm::Type *LLVMCatchTy = CGF.ConvertTypeForMem(CatchType);
3372
3373 // If we're catching by reference, we can just cast the object
3374 // pointer to the appropriate pointer.
3375 if (isa<ReferenceType>(CatchType)) {
3376 QualType CaughtType = cast<ReferenceType>(CatchType)->getPointeeType();
3377 bool EndCatchMightThrow = CaughtType->isRecordType();
3378
3379 // __cxa_begin_catch returns the adjusted object pointer.
3380 llvm::Value *AdjustedExn = CallBeginCatch(CGF, Exn, EndCatchMightThrow);
3381
3382 // We have no way to tell the personality function that we're
3383 // catching by reference, so if we're catching a pointer,
3384 // __cxa_begin_catch will actually return that pointer by value.
3385 if (const PointerType *PT = dyn_cast<PointerType>(CaughtType)) {
3386 QualType PointeeType = PT->getPointeeType();
3387
3388 // When catching by reference, generally we should just ignore
3389 // this by-value pointer and use the exception object instead.
3390 if (!PointeeType->isRecordType()) {
3391
3392 // Exn points to the struct _Unwind_Exception header, which
3393 // we have to skip past in order to reach the exception data.
3394 unsigned HeaderSize =
3395 CGF.CGM.getTargetCodeGenInfo().getSizeOfUnwindException();
3396 AdjustedExn = CGF.Builder.CreateConstGEP1_32(Exn, HeaderSize);
3397
3398 // However, if we're catching a pointer-to-record type that won't
3399 // work, because the personality function might have adjusted
3400 // the pointer. There's actually no way for us to fully satisfy
3401 // the language/ABI contract here: we can't use Exn because it
3402 // might have the wrong adjustment, but we can't use the by-value
3403 // pointer because it's off by a level of abstraction.
3404 //
3405 // The current solution is to dump the adjusted pointer into an
3406 // alloca, which breaks language semantics (because changing the
3407 // pointer doesn't change the exception) but at least works.
3408 // The better solution would be to filter out non-exact matches
3409 // and rethrow them, but this is tricky because the rethrow
3410 // really needs to be catchable by other sites at this landing
3411 // pad. The best solution is to fix the personality function.
3412 } else {
3413 // Pull the pointer for the reference type off.
3414 llvm::Type *PtrTy =
3415 cast<llvm::PointerType>(LLVMCatchTy)->getElementType();
3416
3417 // Create the temporary and write the adjusted pointer into it.
3418 llvm::Value *ExnPtrTmp = CGF.CreateTempAlloca(PtrTy, "exn.byref.tmp");
3419 llvm::Value *Casted = CGF.Builder.CreateBitCast(AdjustedExn, PtrTy);
3420 CGF.Builder.CreateStore(Casted, ExnPtrTmp);
3421
3422 // Bind the reference to the temporary.
3423 AdjustedExn = ExnPtrTmp;
3424 }
3425 }
3426
3427 llvm::Value *ExnCast =
3428 CGF.Builder.CreateBitCast(AdjustedExn, LLVMCatchTy, "exn.byref");
3429 CGF.Builder.CreateStore(ExnCast, ParamAddr);
3430 return;
3431 }
3432
3433 // Scalars and complexes.
3434 TypeEvaluationKind TEK = CGF.getEvaluationKind(CatchType);
3435 if (TEK != TEK_Aggregate) {
3436 llvm::Value *AdjustedExn = CallBeginCatch(CGF, Exn, false);
3437
3438 // If the catch type is a pointer type, __cxa_begin_catch returns
3439 // the pointer by value.
3440 if (CatchType->hasPointerRepresentation()) {
3441 llvm::Value *CastExn =
3442 CGF.Builder.CreateBitCast(AdjustedExn, LLVMCatchTy, "exn.casted");
3443
3444 switch (CatchType.getQualifiers().getObjCLifetime()) {
3445 case Qualifiers::OCL_Strong:
3446 CastExn = CGF.EmitARCRetainNonBlock(CastExn);
3447 // fallthrough
3448
3449 case Qualifiers::OCL_None:
3450 case Qualifiers::OCL_ExplicitNone:
3451 case Qualifiers::OCL_Autoreleasing:
3452 CGF.Builder.CreateStore(CastExn, ParamAddr);
3453 return;
3454
3455 case Qualifiers::OCL_Weak:
3456 CGF.EmitARCInitWeak(ParamAddr, CastExn);
3457 return;
3458 }
3459 llvm_unreachable("bad ownership qualifier!");
3460 }
3461
3462 // Otherwise, it returns a pointer into the exception object.
3463
3464 llvm::Type *PtrTy = LLVMCatchTy->getPointerTo(0); // addrspace 0 ok
3465 llvm::Value *Cast = CGF.Builder.CreateBitCast(AdjustedExn, PtrTy);
3466
3467 LValue srcLV = CGF.MakeNaturalAlignAddrLValue(Cast, CatchType);
3468 LValue destLV = CGF.MakeAddrLValue(ParamAddr, CatchType,
3469 CGF.getContext().getDeclAlign(&CatchParam));
3470 switch (TEK) {
3471 case TEK_Complex:
3472 CGF.EmitStoreOfComplex(CGF.EmitLoadOfComplex(srcLV, Loc), destLV,
3473 /*init*/ true);
3474 return;
3475 case TEK_Scalar: {
3476 llvm::Value *ExnLoad = CGF.EmitLoadOfScalar(srcLV, Loc);
3477 CGF.EmitStoreOfScalar(ExnLoad, destLV, /*init*/ true);
3478 return;
3479 }
3480 case TEK_Aggregate:
3481 llvm_unreachable("evaluation kind filtered out!");
3482 }
3483 llvm_unreachable("bad evaluation kind");
3484 }
3485
3486 assert(isa<RecordType>(CatchType) && "unexpected catch type!");
3487
3488 llvm::Type *PtrTy = LLVMCatchTy->getPointerTo(0); // addrspace 0 ok
3489
3490 // Check for a copy expression. If we don't have a copy expression,
3491 // that means a trivial copy is okay.
3492 const Expr *copyExpr = CatchParam.getInit();
3493 if (!copyExpr) {
3494 llvm::Value *rawAdjustedExn = CallBeginCatch(CGF, Exn, true);
3495 llvm::Value *adjustedExn = CGF.Builder.CreateBitCast(rawAdjustedExn, PtrTy);
3496 CGF.EmitAggregateCopy(ParamAddr, adjustedExn, CatchType);
3497 return;
3498 }
3499
3500 // We have to call __cxa_get_exception_ptr to get the adjusted
3501 // pointer before copying.
3502 llvm::CallInst *rawAdjustedExn =
3503 CGF.EmitNounwindRuntimeCall(getGetExceptionPtrFn(CGF.CGM), Exn);
3504
3505 // Cast that to the appropriate type.
3506 llvm::Value *adjustedExn = CGF.Builder.CreateBitCast(rawAdjustedExn, PtrTy);
3507
3508 // The copy expression is defined in terms of an OpaqueValueExpr.
3509 // Find it and map it to the adjusted expression.
3510 CodeGenFunction::OpaqueValueMapping
3511 opaque(CGF, OpaqueValueExpr::findInCopyConstruct(copyExpr),
3512 CGF.MakeAddrLValue(adjustedExn, CatchParam.getType()));
3513
3514 // Call the copy ctor in a terminate scope.
3515 CGF.EHStack.pushTerminate();
3516
3517 // Perform the copy construction.
3518 CharUnits Alignment = CGF.getContext().getDeclAlign(&CatchParam);
3519 CGF.EmitAggExpr(copyExpr,
3520 AggValueSlot::forAddr(ParamAddr, Alignment, Qualifiers(),
3521 AggValueSlot::IsNotDestructed,
3522 AggValueSlot::DoesNotNeedGCBarriers,
3523 AggValueSlot::IsNotAliased));
3524
3525 // Leave the terminate scope.
3526 CGF.EHStack.popTerminate();
3527
3528 // Undo the opaque value mapping.
3529 opaque.pop();
3530
3531 // Finally we can call __cxa_begin_catch.
3532 CallBeginCatch(CGF, Exn, true);
3533}
3534
3535/// Begins a catch statement by initializing the catch variable and
3536/// calling __cxa_begin_catch.
3537void ItaniumCXXABI::emitBeginCatch(CodeGenFunction &CGF,
3538 const CXXCatchStmt *S) {
3539 // We have to be very careful with the ordering of cleanups here:
3540 // C++ [except.throw]p4:
3541 // The destruction [of the exception temporary] occurs
3542 // immediately after the destruction of the object declared in
3543 // the exception-declaration in the handler.
3544 //
3545 // So the precise ordering is:
3546 // 1. Construct catch variable.
3547 // 2. __cxa_begin_catch
3548 // 3. Enter __cxa_end_catch cleanup
3549 // 4. Enter dtor cleanup
3550 //
3551 // We do this by using a slightly abnormal initialization process.
3552 // Delegation sequence:
3553 // - ExitCXXTryStmt opens a RunCleanupsScope
3554 // - EmitAutoVarAlloca creates the variable and debug info
3555 // - InitCatchParam initializes the variable from the exception
3556 // - CallBeginCatch calls __cxa_begin_catch
3557 // - CallBeginCatch enters the __cxa_end_catch cleanup
3558 // - EmitAutoVarCleanups enters the variable destructor cleanup
3559 // - EmitCXXTryStmt emits the code for the catch body
3560 // - EmitCXXTryStmt close the RunCleanupsScope
3561
3562 VarDecl *CatchParam = S->getExceptionDecl();
3563 if (!CatchParam) {
3564 llvm::Value *Exn = CGF.getExceptionFromSlot();
3565 CallBeginCatch(CGF, Exn, true);
3566 return;
3567 }
3568
3569 // Emit the local.
3570 CodeGenFunction::AutoVarEmission var = CGF.EmitAutoVarAlloca(*CatchParam);
3571 InitCatchParam(CGF, *CatchParam, var.getObjectAddress(CGF), S->getLocStart());
3572 CGF.EmitAutoVarCleanups(var);
3573}
3574
3575/// Get or define the following function:
3576/// void @__clang_call_terminate(i8* %exn) nounwind noreturn
3577/// This code is used only in C++.
3578static llvm::Constant *getClangCallTerminateFn(CodeGenModule &CGM) {
3579 llvm::FunctionType *fnTy =
3580 llvm::FunctionType::get(CGM.VoidTy, CGM.Int8PtrTy, /*IsVarArgs=*/false);
3581 llvm::Constant *fnRef =
3582 CGM.CreateRuntimeFunction(fnTy, "__clang_call_terminate");
3583
3584 llvm::Function *fn = dyn_cast<llvm::Function>(fnRef);
3585 if (fn && fn->empty()) {
3586 fn->setDoesNotThrow();
3587 fn->setDoesNotReturn();
3588
3589 // What we really want is to massively penalize inlining without
3590 // forbidding it completely. The difference between that and
3591 // 'noinline' is negligible.
3592 fn->addFnAttr(llvm::Attribute::NoInline);
3593
3594 // Allow this function to be shared across translation units, but
3595 // we don't want it to turn into an exported symbol.
3596 fn->setLinkage(llvm::Function::LinkOnceODRLinkage);
3597 fn->setVisibility(llvm::Function::HiddenVisibility);
3598 if (CGM.supportsCOMDAT())
3599 fn->setComdat(CGM.getModule().getOrInsertComdat(fn->getName()));
3600
3601 // Set up the function.
3602 llvm::BasicBlock *entry =
3603 llvm::BasicBlock::Create(CGM.getLLVMContext(), "", fn);
3604 CGBuilderTy builder(entry);
3605
3606 // Pull the exception pointer out of the parameter list.
3607 llvm::Value *exn = &*fn->arg_begin();
3608
3609 // Call __cxa_begin_catch(exn).
3610 llvm::CallInst *catchCall = builder.CreateCall(getBeginCatchFn(CGM), exn);
3611 catchCall->setDoesNotThrow();
3612 catchCall->setCallingConv(CGM.getRuntimeCC());
3613
3614 // Call std::terminate().
3615 llvm::CallInst *termCall = builder.CreateCall(CGM.getTerminateFn());
3616 termCall->setDoesNotThrow();
3617 termCall->setDoesNotReturn();
3618 termCall->setCallingConv(CGM.getRuntimeCC());
3619
3620 // std::terminate cannot return.
3621 builder.CreateUnreachable();
3622 }
3623
3624 return fnRef;
3625}
3626
3627llvm::CallInst *
3628ItaniumCXXABI::emitTerminateForUnexpectedException(CodeGenFunction &CGF,
3629 llvm::Value *Exn) {
3630 // In C++, we want to call __cxa_begin_catch() before terminating.
3631 if (Exn) {
3632 assert(CGF.CGM.getLangOpts().CPlusPlus);
3633 return CGF.EmitNounwindRuntimeCall(getClangCallTerminateFn(CGF.CGM), Exn);
3634 }
3635 return CGF.EmitNounwindRuntimeCall(CGF.CGM.getTerminateFn());
3636}