blob: 65b50e14f436db3a2e4d91c141eacc5ec041d625 [file] [log] [blame]
Charles Davis4e786dd2010-05-25 19:52:27 +00001//===----- CGCXXABI.h - Interface to C++ ABIs -------------------*- C++ -*-===//
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//
10// This provides an abstract class for C++ code generation. Concrete subclasses
11// of this implement code generation for specific C++ ABIs.
12//
13//===----------------------------------------------------------------------===//
14
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000015#ifndef LLVM_CLANG_LIB_CODEGEN_CGCXXABI_H
16#define LLVM_CLANG_LIB_CODEGEN_CGCXXABI_H
Charles Davis4e786dd2010-05-25 19:52:27 +000017
John McCall5d865c322010-08-31 07:33:07 +000018#include "CodeGenFunction.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000019#include "clang/Basic/LLVM.h"
John McCall5d865c322010-08-31 07:33:07 +000020
John McCall475999d2010-08-22 00:05:51 +000021namespace llvm {
Rafael Espindola14048092014-05-09 00:26:20 +000022class Constant;
23class Type;
24class Value;
Reid Klecknerfff8e7f2015-03-03 19:21:04 +000025class CallInst;
John McCall475999d2010-08-22 00:05:51 +000026}
27
Charles Davis4e786dd2010-05-25 19:52:27 +000028namespace clang {
Rafael Espindola14048092014-05-09 00:26:20 +000029class CastExpr;
30class CXXConstructorDecl;
31class CXXDestructorDecl;
32class CXXMethodDecl;
33class CXXRecordDecl;
34class FieldDecl;
35class MangleContext;
John McCall475999d2010-08-22 00:05:51 +000036
Charles Davis4e786dd2010-05-25 19:52:27 +000037namespace CodeGen {
John McCallb92ab1a2016-10-26 23:46:34 +000038class CGCallee;
Rafael Espindola14048092014-05-09 00:26:20 +000039class CodeGenFunction;
40class CodeGenModule;
Reid Kleckner10aa7702015-09-16 20:15:55 +000041struct CatchTypeInfo;
Charles Davis4e786dd2010-05-25 19:52:27 +000042
Adrian Prantl9fc8faf2018-05-09 01:00:01 +000043/// Implements C++ ABI-specific code generation functions.
Charles Davis53c59df2010-08-16 03:33:14 +000044class CGCXXABI {
John McCalla1dee5302010-08-22 10:59:02 +000045protected:
46 CodeGenModule &CGM;
Ahmed Charlesb8984322014-03-07 20:03:18 +000047 std::unique_ptr<MangleContext> MangleCtx;
John McCalla1dee5302010-08-22 10:59:02 +000048
Peter Collingbourne0ff0b372011-01-13 18:57:25 +000049 CGCXXABI(CodeGenModule &CGM)
50 : CGM(CGM), MangleCtx(CGM.getContext().createMangleContext()) {}
John McCalla1dee5302010-08-22 10:59:02 +000051
John McCall5d865c322010-08-31 07:33:07 +000052protected:
John McCall7f416cc2015-09-08 08:05:57 +000053 ImplicitParamDecl *getThisDecl(CodeGenFunction &CGF) {
Eli Friedman9fbeba02012-02-11 02:57:39 +000054 return CGF.CXXABIThisDecl;
John McCall5d865c322010-08-31 07:33:07 +000055 }
John McCall7f416cc2015-09-08 08:05:57 +000056 llvm::Value *getThisValue(CodeGenFunction &CGF) {
Eli Friedman9fbeba02012-02-11 02:57:39 +000057 return CGF.CXXABIThisValue;
John McCall5d865c322010-08-31 07:33:07 +000058 }
John McCall7f416cc2015-09-08 08:05:57 +000059 Address getThisAddress(CodeGenFunction &CGF) {
60 return Address(CGF.CXXABIThisValue, CGF.CXXABIThisAlignment);
61 }
John McCall5d865c322010-08-31 07:33:07 +000062
Reid Kleckner407e8b62013-03-22 19:02:54 +000063 /// Issue a diagnostic about unsupported features in the ABI.
64 void ErrorUnsupportedABI(CodeGenFunction &CGF, StringRef S);
65
66 /// Get a null value for unsupported member pointers.
67 llvm::Constant *GetBogusMemberPointer(QualType T);
68
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +000069 ImplicitParamDecl *&getStructorImplicitParamDecl(CodeGenFunction &CGF) {
70 return CGF.CXXStructorImplicitParamDecl;
71 }
72 llvm::Value *&getStructorImplicitParamValue(CodeGenFunction &CGF) {
73 return CGF.CXXStructorImplicitParamValue;
John McCall5d865c322010-08-31 07:33:07 +000074 }
75
Reid Kleckner06239e42017-11-16 19:09:36 +000076 /// Loads the incoming C++ this pointer as it was passed by the caller.
77 llvm::Value *loadIncomingCXXThis(CodeGenFunction &CGF);
78
79 void setCXXABIThisValue(CodeGenFunction &CGF, llvm::Value *ThisPtr);
John McCall5d865c322010-08-31 07:33:07 +000080
John McCall8ed55a52010-09-02 09:58:18 +000081 ASTContext &getContext() const { return CGM.getContext(); }
82
John McCallb91cd662012-05-01 05:23:51 +000083 virtual bool requiresArrayCookie(const CXXDeleteExpr *E, QualType eltType);
84 virtual bool requiresArrayCookie(const CXXNewExpr *E);
85
John McCall7f416cc2015-09-08 08:05:57 +000086 /// Determine whether there's something special about the rules of
87 /// the ABI tell us that 'this' is a complete object within the
88 /// given function. Obvious common logic like being defined on a
89 /// final class will have been taken care of by the caller.
90 virtual bool isThisCompleteObject(GlobalDecl GD) const = 0;
91
Charles Davis4e786dd2010-05-25 19:52:27 +000092public:
John McCalla1dee5302010-08-22 10:59:02 +000093
Anders Carlssone8ba4732010-11-28 17:50:09 +000094 virtual ~CGCXXABI();
Charles Davis4e786dd2010-05-25 19:52:27 +000095
96 /// Gets the mangle context.
Peter Collingbourne0ff0b372011-01-13 18:57:25 +000097 MangleContext &getMangleContext() {
98 return *MangleCtx;
99 }
John McCall475999d2010-08-22 00:05:51 +0000100
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000101 /// Returns true if the given constructor or destructor is one of the
102 /// kinds that the ABI says returns 'this' (only applies when called
103 /// non-virtually for destructors).
104 ///
105 /// There currently is no way to indicate if a destructor returns 'this'
106 /// when called virtually, and code generation does not support the case.
Manman Ren01754612013-03-20 16:59:38 +0000107 virtual bool HasThisReturn(GlobalDecl GD) const { return false; }
108
David Majnemer0c0b6d92014-10-31 20:09:12 +0000109 virtual bool hasMostDerivedReturn(GlobalDecl GD) const { return false; }
110
Derek Schuff8179be42016-05-10 17:44:55 +0000111 /// Returns true if the target allows calling a function through a pointer
112 /// with a different signature than the actual function (or equivalently,
113 /// bitcasting a function or function pointer to a different function type).
114 /// In principle in the most general case this could depend on the target, the
115 /// calling convention, and the actual types of the arguments and return
116 /// value. Here it just means whether the signature mismatch could *ever* be
117 /// allowed; in other words, does the target do strict checking of signatures
118 /// for all calls.
119 virtual bool canCallMismatchedFunctionType() const { return true; }
120
Reid Kleckner40ca9132014-05-13 22:05:45 +0000121 /// If the C++ ABI requires the given type be returned in a particular way,
122 /// this method sets RetAI and returns true.
123 virtual bool classifyReturnType(CGFunctionInfo &FI) const = 0;
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +0000124
125 /// Specify how one should pass an argument of a record type.
126 enum RecordArgABI {
127 /// Pass it using the normal C aggregate rules for the ABI, potentially
128 /// introducing extra copies and passing some or all of it in registers.
129 RAA_Default = 0,
130
131 /// Pass it on the stack using its defined layout. The argument must be
132 /// evaluated directly into the correct stack position in the arguments area,
133 /// and the call machinery must not move it or introduce extra copies.
134 RAA_DirectInMemory,
135
136 /// Pass it as a pointer to temporary memory.
137 RAA_Indirect
138 };
139
Reid Klecknercf87e102014-05-14 16:02:09 +0000140 /// Returns true if C++ allows us to copy the memory of an object of type RD
141 /// when it is passed as an argument.
142 bool canCopyArgument(const CXXRecordDecl *RD) const;
143
Timur Iskhodzhanov8fe501d2013-04-17 12:54:10 +0000144 /// Returns how an argument of the given record type should be passed.
145 virtual RecordArgABI getRecordArgABI(const CXXRecordDecl *RD) const = 0;
146
Reid Kleckner37abaca2014-05-09 22:46:15 +0000147 /// Returns true if the implicit 'sret' parameter comes after the implicit
148 /// 'this' parameter of C++ instance methods.
149 virtual bool isSRetParameterAfterThis() const { return false; }
150
John McCall7a9aac22010-08-23 01:21:21 +0000151 /// Find the LLVM type used to represent the given member pointer
152 /// type.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000153 virtual llvm::Type *
John McCall7a9aac22010-08-23 01:21:21 +0000154 ConvertMemberPointerType(const MemberPointerType *MPT);
155
156 /// Load a member function from an object and a member function
157 /// pointer. Apply the this-adjustment and set 'This' to the
158 /// adjusted value.
John McCallb92ab1a2016-10-26 23:46:34 +0000159 virtual CGCallee EmitLoadOfMemberFunctionPointer(
John McCall7f416cc2015-09-08 08:05:57 +0000160 CodeGenFunction &CGF, const Expr *E, Address This,
161 llvm::Value *&ThisPtrForCall, llvm::Value *MemPtr,
162 const MemberPointerType *MPT);
John McCalla8bbb822010-08-22 03:04:22 +0000163
John McCallc134eb52010-08-31 21:07:20 +0000164 /// Calculate an l-value from an object and a data member pointer.
David Majnemer2b0d66d2014-02-20 23:22:07 +0000165 virtual llvm::Value *
166 EmitMemberDataPointerAddress(CodeGenFunction &CGF, const Expr *E,
John McCall7f416cc2015-09-08 08:05:57 +0000167 Address Base, llvm::Value *MemPtr,
David Majnemer2b0d66d2014-02-20 23:22:07 +0000168 const MemberPointerType *MPT);
John McCallc134eb52010-08-31 21:07:20 +0000169
John McCallc62bb392012-02-15 01:22:51 +0000170 /// Perform a derived-to-base, base-to-derived, or bitcast member
171 /// pointer conversion.
John McCall7a9aac22010-08-23 01:21:21 +0000172 virtual llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
173 const CastExpr *E,
174 llvm::Value *Src);
John McCall84fa5102010-08-22 04:16:24 +0000175
John McCallc62bb392012-02-15 01:22:51 +0000176 /// Perform a derived-to-base, base-to-derived, or bitcast member
177 /// pointer conversion on a constant value.
178 virtual llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
179 llvm::Constant *Src);
180
John McCall7a9aac22010-08-23 01:21:21 +0000181 /// Return true if the given member pointer can be zero-initialized
182 /// (in the C++ sense) with an LLVM zeroinitializer.
John McCall614dbdc2010-08-22 21:01:12 +0000183 virtual bool isZeroInitializable(const MemberPointerType *MPT);
John McCall84fa5102010-08-22 04:16:24 +0000184
David Majnemerb3e56542014-08-07 22:56:13 +0000185 /// Return whether or not a member pointers type is convertible to an IR type.
186 virtual bool isMemberPointerConvertible(const MemberPointerType *MPT) const {
187 return true;
188 }
189
John McCall7a9aac22010-08-23 01:21:21 +0000190 /// Create a null member pointer of the given type.
191 virtual llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT);
John McCall84fa5102010-08-22 04:16:24 +0000192
John McCall7a9aac22010-08-23 01:21:21 +0000193 /// Create a member pointer for the given method.
David Majnemere2be95b2015-06-23 07:31:01 +0000194 virtual llvm::Constant *EmitMemberFunctionPointer(const CXXMethodDecl *MD);
John McCall1c456c82010-08-22 06:43:33 +0000195
John McCall7a9aac22010-08-23 01:21:21 +0000196 /// Create a member pointer for the given field.
John McCallf3a88602011-02-03 08:15:49 +0000197 virtual llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
198 CharUnits offset);
John McCall131d97d2010-08-22 08:30:07 +0000199
Richard Smithdafff942012-01-14 04:30:29 +0000200 /// Create a member pointer for the given member pointer constant.
201 virtual llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT);
202
John McCall7a9aac22010-08-23 01:21:21 +0000203 /// Emit a comparison between two member pointers. Returns an i1.
John McCall131d97d2010-08-22 08:30:07 +0000204 virtual llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000205 EmitMemberPointerComparison(CodeGenFunction &CGF,
206 llvm::Value *L,
207 llvm::Value *R,
208 const MemberPointerType *MPT,
209 bool Inequality);
John McCall131d97d2010-08-22 08:30:07 +0000210
John McCall7a9aac22010-08-23 01:21:21 +0000211 /// Determine if a member pointer is non-null. Returns an i1.
John McCall131d97d2010-08-22 08:30:07 +0000212 virtual llvm::Value *
John McCall7a9aac22010-08-23 01:21:21 +0000213 EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
214 llvm::Value *MemPtr,
215 const MemberPointerType *MPT);
John McCall5d865c322010-08-31 07:33:07 +0000216
John McCallc62bb392012-02-15 01:22:51 +0000217protected:
218 /// A utility method for computing the offset required for the given
219 /// base-to-derived or derived-to-base member-pointer conversion.
220 /// Does not handle virtual conversions (in case we ever fully
221 /// support an ABI that allows this). Returns null if no adjustment
222 /// is required.
223 llvm::Constant *getMemberPointerAdjustment(const CastExpr *E);
224
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000225 /// Computes the non-virtual adjustment needed for a member pointer
Reid Kleckner452abac2013-05-09 21:01:17 +0000226 /// conversion along an inheritance path stored in an APValue. Unlike
227 /// getMemberPointerAdjustment(), the adjustment can be negative if the path
228 /// is from a derived type to a base type.
229 CharUnits getMemberPointerPathAdjustment(const APValue &MP);
230
John McCallc62bb392012-02-15 01:22:51 +0000231public:
David Majnemer0c0b6d92014-10-31 20:09:12 +0000232 virtual void emitVirtualObjectDelete(CodeGenFunction &CGF,
David Majnemer08681372014-11-01 07:37:17 +0000233 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +0000234 Address Ptr, QualType ElementType,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000235 const CXXDestructorDecl *Dtor) = 0;
David Majnemer442d0a22014-11-25 07:20:20 +0000236 virtual void emitRethrow(CodeGenFunction &CGF, bool isNoReturn) = 0;
David Majnemer7c237072015-03-05 00:46:22 +0000237 virtual void emitThrow(CodeGenFunction &CGF, const CXXThrowExpr *E) = 0;
David Majnemerba3e5ec2015-03-13 18:26:17 +0000238 virtual llvm::GlobalVariable *getThrowInfo(QualType T) { return nullptr; }
John McCall82fb8922012-09-25 10:10:39 +0000239
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000240 /// Determine whether it's possible to emit a vtable for \p RD, even
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000241 /// though we do not know that the vtable has been marked as used by semantic
242 /// analysis.
243 virtual bool canSpeculativelyEmitVTable(const CXXRecordDecl *RD) const = 0;
Piotr Padlewskia68a7872015-07-24 04:04:49 +0000244
Reid Klecknerfff8e7f2015-03-03 19:21:04 +0000245 virtual void emitBeginCatch(CodeGenFunction &CGF, const CXXCatchStmt *C) = 0;
246
247 virtual llvm::CallInst *
248 emitTerminateForUnexpectedException(CodeGenFunction &CGF,
249 llvm::Value *Exn);
250
David Majnemer443250f2015-03-17 20:35:00 +0000251 virtual llvm::Constant *getAddrOfRTTIDescriptor(QualType Ty) = 0;
Reid Kleckner10aa7702015-09-16 20:15:55 +0000252 virtual CatchTypeInfo
David Majnemer37b417f2015-03-29 21:55:10 +0000253 getAddrOfCXXCatchHandlerType(QualType Ty, QualType CatchHandlerType) = 0;
Reid Kleckner10aa7702015-09-16 20:15:55 +0000254 virtual CatchTypeInfo getCatchAllTypeInfo();
David Majnemere2cb8d12014-07-07 06:20:47 +0000255
David Majnemer1162d252014-06-22 19:05:33 +0000256 virtual bool shouldTypeidBeNullChecked(bool IsDeref,
257 QualType SrcRecordTy) = 0;
258 virtual void EmitBadTypeidCall(CodeGenFunction &CGF) = 0;
259 virtual llvm::Value *EmitTypeid(CodeGenFunction &CGF, QualType SrcRecordTy,
John McCall7f416cc2015-09-08 08:05:57 +0000260 Address ThisPtr,
David Majnemer1162d252014-06-22 19:05:33 +0000261 llvm::Type *StdTypeInfoPtrTy) = 0;
262
263 virtual bool shouldDynamicCastCallBeNullChecked(bool SrcIsPtr,
264 QualType SrcRecordTy) = 0;
265
266 virtual llvm::Value *
John McCall7f416cc2015-09-08 08:05:57 +0000267 EmitDynamicCastCall(CodeGenFunction &CGF, Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000268 QualType SrcRecordTy, QualType DestTy,
269 QualType DestRecordTy, llvm::BasicBlock *CastEnd) = 0;
270
271 virtual llvm::Value *EmitDynamicCastToVoid(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000272 Address Value,
David Majnemer1162d252014-06-22 19:05:33 +0000273 QualType SrcRecordTy,
274 QualType DestTy) = 0;
275
276 virtual bool EmitBadCastCall(CodeGenFunction &CGF) = 0;
277
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000278 virtual llvm::Value *GetVirtualBaseClassOffset(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000279 Address This,
Reid Klecknerd8cbeec2013-05-29 18:02:47 +0000280 const CXXRecordDecl *ClassDecl,
281 const CXXRecordDecl *BaseClassDecl) = 0;
282
Reid Kleckner7810af02013-06-19 15:20:38 +0000283 virtual llvm::BasicBlock *EmitCtorCompleteObjectHandler(CodeGenFunction &CGF,
284 const CXXRecordDecl *RD);
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000285
Timur Iskhodzhanovb6487322013-10-09 18:16:58 +0000286 /// Emit the code to initialize hidden members required
287 /// to handle virtual inheritance, if needed by the ABI.
288 virtual void
289 initializeHiddenVirtualInheritanceMembers(CodeGenFunction &CGF,
290 const CXXRecordDecl *RD) {}
291
Timur Iskhodzhanov40f2fa92013-08-04 17:30:04 +0000292 /// Emit constructor variants required by this ABI.
293 virtual void EmitCXXConstructors(const CXXConstructorDecl *D) = 0;
294
George Burgess IVf203dbf2017-02-22 20:28:02 +0000295 /// Notes how many arguments were added to the beginning (Prefix) and ending
296 /// (Suffix) of an arg list.
297 ///
298 /// Note that Prefix actually refers to the number of args *after* the first
299 /// one: `this` arguments always come first.
300 struct AddedStructorArgs {
301 unsigned Prefix = 0;
302 unsigned Suffix = 0;
303 AddedStructorArgs() = default;
304 AddedStructorArgs(unsigned P, unsigned S) : Prefix(P), Suffix(S) {}
305 static AddedStructorArgs prefix(unsigned N) { return {N, 0}; }
306 static AddedStructorArgs suffix(unsigned N) { return {0, N}; }
307 };
308
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000309 /// Build the signature of the given constructor or destructor variant by
310 /// adding any required parameters. For convenience, ArgTys has been
311 /// initialized with the type of 'this'.
George Burgess IVf203dbf2017-02-22 20:28:02 +0000312 virtual AddedStructorArgs
313 buildStructorSignature(const CXXMethodDecl *MD, StructorType T,
314 SmallVectorImpl<CanQualType> &ArgTys) = 0;
John McCall5d865c322010-08-31 07:33:07 +0000315
Reid Klecknere7de47e2013-07-22 13:51:44 +0000316 /// Returns true if the given destructor type should be emitted as a linkonce
317 /// delegating thunk, regardless of whether the dtor is defined in this TU or
318 /// not.
319 virtual bool useThunkForDtorVariant(const CXXDestructorDecl *Dtor,
320 CXXDtorType DT) const = 0;
321
Reid Klecknerae9b0702018-03-16 19:40:50 +0000322 virtual void setCXXDestructorDLLStorage(llvm::GlobalValue *GV,
323 const CXXDestructorDecl *Dtor,
324 CXXDtorType DT) const;
325
326 virtual llvm::GlobalValue::LinkageTypes
327 getCXXDestructorLinkage(GVALinkage Linkage, const CXXDestructorDecl *Dtor,
328 CXXDtorType DT) const;
329
Reid Klecknere7de47e2013-07-22 13:51:44 +0000330 /// Emit destructor variants required by this ABI.
331 virtual void EmitCXXDestructors(const CXXDestructorDecl *D) = 0;
332
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000333 /// Get the type of the implicit "this" parameter used by a method. May return
334 /// zero if no specific type is applicable, e.g. if the ABI expects the "this"
335 /// parameter to point to some artificial offset in a complete object due to
336 /// vbases being reordered.
337 virtual const CXXRecordDecl *
338 getThisArgumentTypeForMethod(const CXXMethodDecl *MD) {
339 return MD->getParent();
340 }
341
342 /// Perform ABI-specific "this" argument adjustment required prior to
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000343 /// a call of a virtual function.
344 /// The "VirtualCall" argument is true iff the call itself is virtual.
John McCall7f416cc2015-09-08 08:05:57 +0000345 virtual Address
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000346 adjustThisArgumentForVirtualFunctionCall(CodeGenFunction &CGF, GlobalDecl GD,
John McCall7f416cc2015-09-08 08:05:57 +0000347 Address This, bool VirtualCall) {
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000348 return This;
349 }
350
Reid Kleckner89077a12013-12-17 19:46:40 +0000351 /// Build a parameter variable suitable for 'this'.
352 void buildThisParam(CodeGenFunction &CGF, FunctionArgList &Params);
353
354 /// Insert any ABI-specific implicit parameters into the parameter list for a
355 /// function. This generally involves extra data for constructors and
356 /// destructors.
John McCall5d865c322010-08-31 07:33:07 +0000357 ///
358 /// ABIs may also choose to override the return type, which has been
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000359 /// initialized with the type of 'this' if HasThisReturn(CGF.CurGD) is true or
360 /// the formal return type of the function otherwise.
Reid Kleckner89077a12013-12-17 19:46:40 +0000361 virtual void addImplicitStructorParams(CodeGenFunction &CGF, QualType &ResTy,
362 FunctionArgList &Params) = 0;
John McCall5d865c322010-08-31 07:33:07 +0000363
Reid Kleckner0358cbf2016-07-01 02:41:25 +0000364 /// Get the ABI-specific "this" parameter adjustment to apply in the prologue
365 /// of a virtual function.
366 virtual CharUnits getVirtualFunctionPrologueThisAdjustment(GlobalDecl GD) {
367 return CharUnits::Zero();
368 }
369
John McCall5d865c322010-08-31 07:33:07 +0000370 /// Emit the ABI-specific prolog for the function.
371 virtual void EmitInstanceFunctionProlog(CodeGenFunction &CGF) = 0;
372
Reid Kleckner89077a12013-12-17 19:46:40 +0000373 /// Add any ABI-specific implicit arguments needed to call a constructor.
374 ///
George Burgess IVf203dbf2017-02-22 20:28:02 +0000375 /// \return The number of arguments added at the beginning and end of the
376 /// call, which is typically zero or one.
377 virtual AddedStructorArgs
Reid Kleckner89077a12013-12-17 19:46:40 +0000378 addImplicitConstructorArgs(CodeGenFunction &CGF, const CXXConstructorDecl *D,
379 CXXCtorType Type, bool ForVirtualBase,
380 bool Delegating, CallArgList &Args) = 0;
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000381
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000382 /// Emit the destructor call.
383 virtual void EmitDestructorCall(CodeGenFunction &CGF,
384 const CXXDestructorDecl *DD, CXXDtorType Type,
385 bool ForVirtualBase, bool Delegating,
John McCall7f416cc2015-09-08 08:05:57 +0000386 Address This) = 0;
Reid Kleckner6fe771a2013-12-13 00:53:54 +0000387
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000388 /// Emits the VTable definitions required for the given record type.
389 virtual void emitVTableDefinitions(CodeGenVTables &CGVT,
390 const CXXRecordDecl *RD) = 0;
391
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000392 /// Checks if ABI requires extra virtual offset for vtable field.
393 virtual bool
394 isVirtualOffsetNeededForVTableField(CodeGenFunction &CGF,
395 CodeGenFunction::VPtr Vptr) = 0;
396
Simon Pilgrim2c518802017-03-30 14:13:19 +0000397 /// Checks if ABI requires to initialize vptrs for given dynamic class.
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000398 virtual bool doStructorsInitializeVPtrs(const CXXRecordDecl *VTableClass) = 0;
399
400 /// Get the address point of the vtable for the given base subobject.
401 virtual llvm::Constant *
402 getVTableAddressPoint(BaseSubobject Base,
403 const CXXRecordDecl *VTableClass) = 0;
404
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000405 /// Get the address point of the vtable for the given base subobject while
Piotr Padlewskid679d7e2015-09-15 00:37:06 +0000406 /// building a constructor or a destructor.
407 virtual llvm::Value *
408 getVTableAddressPointInStructor(CodeGenFunction &CGF, const CXXRecordDecl *RD,
409 BaseSubobject Base,
410 const CXXRecordDecl *NearestVBase) = 0;
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000411
412 /// Get the address point of the vtable for the given base subobject while
413 /// building a constexpr.
414 virtual llvm::Constant *
415 getVTableAddressPointForConstExpr(BaseSubobject Base,
416 const CXXRecordDecl *VTableClass) = 0;
417
418 /// Get the address of the vtable for the given record decl which should be
419 /// used for the vptr at the given offset in RD.
420 virtual llvm::GlobalVariable *getAddrOfVTable(const CXXRecordDecl *RD,
421 CharUnits VPtrOffset) = 0;
422
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000423 /// Build a virtual function pointer in the ABI-specific way.
John McCall9831b842018-02-06 18:52:44 +0000424 virtual CGCallee getVirtualFunctionPointer(CodeGenFunction &CGF,
425 GlobalDecl GD, Address This,
426 llvm::Type *Ty,
427 SourceLocation Loc) = 0;
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000428
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000429 /// Emit the ABI-specific virtual destructor call.
David Majnemer0c0b6d92014-10-31 20:09:12 +0000430 virtual llvm::Value *
431 EmitVirtualDestructorCall(CodeGenFunction &CGF, const CXXDestructorDecl *Dtor,
John McCall7f416cc2015-09-08 08:05:57 +0000432 CXXDtorType DtorType, Address This,
David Majnemer0c0b6d92014-10-31 20:09:12 +0000433 const CXXMemberCallExpr *CE) = 0;
Timur Iskhodzhanovd6197112013-02-15 14:45:22 +0000434
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000435 virtual void adjustCallArgsForDestructorThunk(CodeGenFunction &CGF,
436 GlobalDecl GD,
437 CallArgList &CallArgs) {}
438
Reid Kleckner7810af02013-06-19 15:20:38 +0000439 /// Emit any tables needed to implement virtual inheritance. For Itanium,
440 /// this emits virtual table tables. For the MSVC++ ABI, this emits virtual
441 /// base tables.
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +0000442 virtual void emitVirtualInheritanceTables(const CXXRecordDecl *RD) = 0;
Reid Kleckner7810af02013-06-19 15:20:38 +0000443
Rafael Espindolab7350042018-03-01 00:35:47 +0000444 virtual bool exportThunk() = 0;
Hans Wennborgc94391d2014-06-06 20:04:01 +0000445 virtual void setThunkLinkage(llvm::Function *Thunk, bool ForVTable,
446 GlobalDecl GD, bool ReturnAdjustment) = 0;
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +0000447
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000448 virtual llvm::Value *performThisAdjustment(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000449 Address This,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000450 const ThisAdjustment &TA) = 0;
451
452 virtual llvm::Value *performReturnAdjustment(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000453 Address Ret,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +0000454 const ReturnAdjustment &RA) = 0;
455
John McCall5d865c322010-08-31 07:33:07 +0000456 virtual void EmitReturnFromThunk(CodeGenFunction &CGF,
457 RValue RV, QualType ResultType);
John McCall8ed55a52010-09-02 09:58:18 +0000458
David Majnemer196ac332014-09-11 23:05:02 +0000459 virtual size_t getSrcArgforCopyCtor(const CXXConstructorDecl *,
460 FunctionArgList &Args) const = 0;
461
David Majnemer8671c6e2015-11-02 09:01:44 +0000462 /// Gets the offsets of all the virtual base pointers in a given class.
463 virtual std::vector<CharUnits> getVBPtrOffsets(const CXXRecordDecl *RD);
464
Joao Matos2ce88ef2012-07-17 17:10:11 +0000465 /// Gets the pure virtual member call function.
466 virtual StringRef GetPureVirtualCallName() = 0;
467
David Blaikieeb7d5982012-10-16 22:56:05 +0000468 /// Gets the deleted virtual member call name.
469 virtual StringRef GetDeletedVirtualCallName() = 0;
470
John McCall8ed55a52010-09-02 09:58:18 +0000471 /**************************** Array cookies ******************************/
472
473 /// Returns the extra size required in order to store the array
James Dennett41725122012-06-22 10:16:05 +0000474 /// cookie for the given new-expression. May return 0 to indicate that no
John McCall8ed55a52010-09-02 09:58:18 +0000475 /// array cookie is required.
476 ///
477 /// Several cases are filtered out before this method is called:
478 /// - non-array allocations never need a cookie
James Dennetta02e11f2012-06-20 00:57:15 +0000479 /// - calls to \::operator new(size_t, void*) never need a cookie
John McCall8ed55a52010-09-02 09:58:18 +0000480 ///
James Dennett41725122012-06-22 10:16:05 +0000481 /// \param expr - the new-expression being allocated.
John McCall284c48f2011-01-27 09:37:56 +0000482 virtual CharUnits GetArrayCookieSize(const CXXNewExpr *expr);
John McCall8ed55a52010-09-02 09:58:18 +0000483
484 /// Initialize the array cookie for the given allocation.
485 ///
486 /// \param NewPtr - a char* which is the presumed-non-null
487 /// return value of the allocation function
488 /// \param NumElements - the computed number of elements,
John McCallb91cd662012-05-01 05:23:51 +0000489 /// potentially collapsed from the multidimensional array case;
490 /// always a size_t
John McCall8ed55a52010-09-02 09:58:18 +0000491 /// \param ElementType - the base element allocated type,
492 /// i.e. the allocated type after stripping all array types
John McCall7f416cc2015-09-08 08:05:57 +0000493 virtual Address InitializeArrayCookie(CodeGenFunction &CGF,
494 Address NewPtr,
495 llvm::Value *NumElements,
496 const CXXNewExpr *expr,
497 QualType ElementType);
John McCall8ed55a52010-09-02 09:58:18 +0000498
499 /// Reads the array cookie associated with the given pointer,
500 /// if it has one.
501 ///
502 /// \param Ptr - a pointer to the first element in the array
503 /// \param ElementType - the base element type of elements of the array
504 /// \param NumElements - an out parameter which will be initialized
505 /// with the number of elements allocated, or zero if there is no
506 /// cookie
507 /// \param AllocPtr - an out parameter which will be initialized
508 /// with a char* pointing to the address returned by the allocation
509 /// function
510 /// \param CookieSize - an out parameter which will be initialized
511 /// with the size of the cookie, or zero if there is no cookie
John McCall7f416cc2015-09-08 08:05:57 +0000512 virtual void ReadArrayCookie(CodeGenFunction &CGF, Address Ptr,
John McCall284c48f2011-01-27 09:37:56 +0000513 const CXXDeleteExpr *expr,
John McCall8ed55a52010-09-02 09:58:18 +0000514 QualType ElementType, llvm::Value *&NumElements,
515 llvm::Value *&AllocPtr, CharUnits &CookieSize);
516
Peter Collingbourne66f82e62013-06-28 20:45:28 +0000517 /// Return whether the given global decl needs a VTT parameter.
518 virtual bool NeedsVTTParameter(GlobalDecl GD);
519
John McCallb91cd662012-05-01 05:23:51 +0000520protected:
521 /// Returns the extra size required in order to store the array
522 /// cookie for the given type. Assumes that an array cookie is
523 /// required.
524 virtual CharUnits getArrayCookieSizeImpl(QualType elementType);
525
526 /// Reads the array cookie for an allocation which is known to have one.
527 /// This is called by the standard implementation of ReadArrayCookie.
528 ///
529 /// \param ptr - a pointer to the allocation made for an array, as a char*
530 /// \param cookieSize - the computed cookie size of an array
James Dennett6e5cffb2012-06-15 07:35:42 +0000531 ///
John McCallb91cd662012-05-01 05:23:51 +0000532 /// Other parameters are as above.
James Dennett6e5cffb2012-06-15 07:35:42 +0000533 ///
John McCallb91cd662012-05-01 05:23:51 +0000534 /// \return a size_t
John McCall7f416cc2015-09-08 08:05:57 +0000535 virtual llvm::Value *readArrayCookieImpl(CodeGenFunction &IGF, Address ptr,
John McCallb91cd662012-05-01 05:23:51 +0000536 CharUnits cookieSize);
537
538public:
539
John McCall68ff0372010-09-08 01:44:27 +0000540 /*************************** Static local guards ****************************/
541
John McCallcdf7ef52010-11-06 09:44:32 +0000542 /// Emits the guarded initializer and destructor setup for the given
543 /// variable, given that it couldn't be emitted as a constant.
Richard Smith6331c402012-02-13 22:16:19 +0000544 /// If \p PerformInit is false, the initialization has been folded to a
545 /// constant and should not be performed.
John McCallcdf7ef52010-11-06 09:44:32 +0000546 ///
547 /// The variable may be:
548 /// - a static local variable
549 /// - a static data member of a class template instantiation
550 virtual void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Reid Klecknerd8110b62013-09-10 20:14:30 +0000551 llvm::GlobalVariable *DeclPtr,
552 bool PerformInit) = 0;
John McCall68ff0372010-09-08 01:44:27 +0000553
John McCallc84ed6a2012-05-01 06:13:13 +0000554 /// Emit code to force the execution of a destructor during global
555 /// teardown. The default implementation of this uses atexit.
556 ///
David Majnemerb3341ea2014-10-05 05:05:40 +0000557 /// \param Dtor - a function taking a single pointer argument
558 /// \param Addr - a pointer to pass to the destructor function.
Richard Smithdbf74ba2013-04-14 23:01:42 +0000559 virtual void registerGlobalDtor(CodeGenFunction &CGF, const VarDecl &D,
David Majnemerb3341ea2014-10-05 05:05:40 +0000560 llvm::Constant *Dtor,
561 llvm::Constant *Addr) = 0;
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000562
563 /*************************** thread_local initialization ********************/
564
565 /// Emits ABI-required functions necessary to initialize thread_local
566 /// variables in this translation unit.
567 ///
David Majnemerb3341ea2014-10-05 05:05:40 +0000568 /// \param CXXThreadLocals - The thread_local declarations in this translation
569 /// unit.
570 /// \param CXXThreadLocalInits - If this translation unit contains any
571 /// non-constant initialization or non-trivial destruction for
572 /// thread_local variables, a list of functions to perform the
573 /// initialization.
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000574 virtual void EmitThreadLocalInitFuncs(
Richard Smith5a99c492015-12-01 01:10:48 +0000575 CodeGenModule &CGM, ArrayRef<const VarDecl *> CXXThreadLocals,
David Majnemerb3341ea2014-10-05 05:05:40 +0000576 ArrayRef<llvm::Function *> CXXThreadLocalInits,
Richard Smith5a99c492015-12-01 01:10:48 +0000577 ArrayRef<const VarDecl *> CXXThreadLocalInitVars) = 0;
David Majnemerb3341ea2014-10-05 05:05:40 +0000578
579 // Determine if references to thread_local global variables can be made
580 // directly or require access through a thread wrapper function.
581 virtual bool usesThreadWrapperFunction() const = 0;
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000582
583 /// Emit a reference to a non-local thread_local variable (including
584 /// triggering the initialization of all thread_local variables in its
585 /// translation unit).
Richard Smith0f383742014-03-26 22:48:22 +0000586 virtual LValue EmitThreadLocalVarDeclLValue(CodeGenFunction &CGF,
587 const VarDecl *VD,
David Majnemerb3341ea2014-10-05 05:05:40 +0000588 QualType LValType) = 0;
Rafael Espindola91f68b42014-09-15 19:20:10 +0000589
590 /// Emit a single constructor/destructor with the given type from a C++
591 /// constructor Decl.
592 virtual void emitCXXStructor(const CXXMethodDecl *MD, StructorType Type) = 0;
Peter Collingbourne60108802017-12-13 21:53:04 +0000593
594 /// Load a vtable from This, an object of polymorphic type RD, or from one of
595 /// its virtual bases if it does not have its own vtable. Returns the vtable
596 /// and the class from which the vtable was loaded.
597 virtual std::pair<llvm::Value *, const CXXRecordDecl *>
598 LoadVTablePtr(CodeGenFunction &CGF, Address This,
599 const CXXRecordDecl *RD) = 0;
Charles Davis4e786dd2010-05-25 19:52:27 +0000600};
601
John McCall57625922013-01-25 23:36:14 +0000602// Create an instance of a C++ ABI class:
603
604/// Creates an Itanium-family ABI.
Charles Davis53c59df2010-08-16 03:33:14 +0000605CGCXXABI *CreateItaniumCXXABI(CodeGenModule &CGM);
John McCall57625922013-01-25 23:36:14 +0000606
607/// Creates a Microsoft-family ABI.
Charles Davis53c59df2010-08-16 03:33:14 +0000608CGCXXABI *CreateMicrosoftCXXABI(CodeGenModule &CGM);
John McCall475999d2010-08-22 00:05:51 +0000609
Heejin Ahnc6479192018-05-31 22:18:13 +0000610struct CatchRetScope final : EHScopeStack::Cleanup {
611 llvm::CatchPadInst *CPI;
612
613 CatchRetScope(llvm::CatchPadInst *CPI) : CPI(CPI) {}
614
615 void Emit(CodeGenFunction &CGF, Flags flags) override {
616 llvm::BasicBlock *BB = CGF.createBasicBlock("catchret.dest");
617 CGF.Builder.CreateCatchRet(CPI, BB);
618 CGF.EmitBlock(BB);
619 }
620};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000621}
622}
Charles Davis4e786dd2010-05-25 19:52:27 +0000623
624#endif