1 //===----- CGCXXABI.h - Interface to C++ ABIs -------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This provides an abstract class for C++ code generation. Concrete subclasses
11 // of this implement code generation for specific C++ ABIs.
13 //===----------------------------------------------------------------------===//
15 #ifndef CLANG_CODEGEN_CXXABI_H
16 #define CLANG_CODEGEN_CXXABI_H
18 #include "clang/Basic/LLVM.h"
20 #include "CodeGenFunction.h"
30 class CXXConstructorDecl;
31 class CXXDestructorDecl;
38 class CodeGenFunction;
41 /// \brief Implements C++ ABI-specific code generation functions.
45 OwningPtr<MangleContext> MangleCtx;
47 CGCXXABI(CodeGenModule &CGM)
48 : CGM(CGM), MangleCtx(CGM.getContext().createMangleContext()) {}
51 ImplicitParamDecl *&getThisDecl(CodeGenFunction &CGF) {
52 return CGF.CXXABIThisDecl;
54 llvm::Value *&getThisValue(CodeGenFunction &CGF) {
55 return CGF.CXXABIThisValue;
58 ImplicitParamDecl *&getVTTDecl(CodeGenFunction &CGF) {
59 return CGF.CXXVTTDecl;
61 llvm::Value *&getVTTValue(CodeGenFunction &CGF) {
62 return CGF.CXXVTTValue;
65 /// Build a parameter variable suitable for 'this'.
66 void BuildThisParam(CodeGenFunction &CGF, FunctionArgList &Params);
68 /// Perform prolog initialization of the parameter variable suitable
69 /// for 'this' emitted by BuildThisParam.
70 void EmitThisParam(CodeGenFunction &CGF);
72 ASTContext &getContext() const { return CGM.getContext(); }
74 virtual bool requiresArrayCookie(const CXXDeleteExpr *E, QualType eltType);
75 virtual bool requiresArrayCookie(const CXXNewExpr *E);
81 /// Gets the mangle context.
82 MangleContext &getMangleContext() {
86 /// Find the LLVM type used to represent the given member pointer
89 ConvertMemberPointerType(const MemberPointerType *MPT);
91 /// Load a member function from an object and a member function
92 /// pointer. Apply the this-adjustment and set 'This' to the
95 EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF,
98 const MemberPointerType *MPT);
100 /// Calculate an l-value from an object and a data member pointer.
101 virtual llvm::Value *EmitMemberDataPointerAddress(CodeGenFunction &CGF,
104 const MemberPointerType *MPT);
106 /// Perform a derived-to-base, base-to-derived, or bitcast member
107 /// pointer conversion.
108 virtual llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
112 /// Perform a derived-to-base, base-to-derived, or bitcast member
113 /// pointer conversion on a constant value.
114 virtual llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
115 llvm::Constant *Src);
117 /// Return true if the given member pointer can be zero-initialized
118 /// (in the C++ sense) with an LLVM zeroinitializer.
119 virtual bool isZeroInitializable(const MemberPointerType *MPT);
121 /// Create a null member pointer of the given type.
122 virtual llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT);
124 /// Create a member pointer for the given method.
125 virtual llvm::Constant *EmitMemberPointer(const CXXMethodDecl *MD);
127 /// Create a member pointer for the given field.
128 virtual llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
131 /// Create a member pointer for the given member pointer constant.
132 virtual llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT);
134 /// Emit a comparison between two member pointers. Returns an i1.
135 virtual llvm::Value *
136 EmitMemberPointerComparison(CodeGenFunction &CGF,
139 const MemberPointerType *MPT,
142 /// Determine if a member pointer is non-null. Returns an i1.
143 virtual llvm::Value *
144 EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
146 const MemberPointerType *MPT);
149 /// A utility method for computing the offset required for the given
150 /// base-to-derived or derived-to-base member-pointer conversion.
151 /// Does not handle virtual conversions (in case we ever fully
152 /// support an ABI that allows this). Returns null if no adjustment
154 llvm::Constant *getMemberPointerAdjustment(const CastExpr *E);
157 /// Adjust the given non-null pointer to an object of polymorphic
158 /// type to point to the complete object.
160 /// The IR type of the result should be a pointer but is otherwise
162 virtual llvm::Value *adjustToCompleteObject(CodeGenFunction &CGF,
166 /// Build the signature of the given constructor variant by adding
167 /// any required parameters. For convenience, ResTy has been
168 /// initialized to 'void', and ArgTys has been initialized with the
169 /// type of 'this' (although this may be changed by the ABI) and
170 /// will have the formal parameters added to it afterwards.
172 /// If there are ever any ABIs where the implicit parameters are
173 /// intermixed with the formal parameters, we can address those
175 virtual void BuildConstructorSignature(const CXXConstructorDecl *Ctor,
178 SmallVectorImpl<CanQualType> &ArgTys) = 0;
180 /// Build the signature of the given destructor variant by adding
181 /// any required parameters. For convenience, ResTy has been
182 /// initialized to 'void' and ArgTys has been initialized with the
183 /// type of 'this' (although this may be changed by the ABI).
184 virtual void BuildDestructorSignature(const CXXDestructorDecl *Dtor,
187 SmallVectorImpl<CanQualType> &ArgTys) = 0;
189 /// Build the ABI-specific portion of the parameter list for a
190 /// function. This generally involves a 'this' parameter and
191 /// possibly some extra data for constructors and destructors.
193 /// ABIs may also choose to override the return type, which has been
194 /// initialized with the formal return type of the function.
195 virtual void BuildInstanceFunctionParams(CodeGenFunction &CGF,
197 FunctionArgList &Params) = 0;
199 /// Emit the ABI-specific prolog for the function.
200 virtual void EmitInstanceFunctionProlog(CodeGenFunction &CGF) = 0;
202 virtual void EmitReturnFromThunk(CodeGenFunction &CGF,
203 RValue RV, QualType ResultType);
205 /// Gets the pure virtual member call function.
206 virtual StringRef GetPureVirtualCallName() = 0;
208 /// Gets the deleted virtual member call name.
209 virtual StringRef GetDeletedVirtualCallName() = 0;
211 /**************************** Array cookies ******************************/
213 /// Returns the extra size required in order to store the array
214 /// cookie for the given new-expression. May return 0 to indicate that no
215 /// array cookie is required.
217 /// Several cases are filtered out before this method is called:
218 /// - non-array allocations never need a cookie
219 /// - calls to \::operator new(size_t, void*) never need a cookie
221 /// \param expr - the new-expression being allocated.
222 virtual CharUnits GetArrayCookieSize(const CXXNewExpr *expr);
224 /// Initialize the array cookie for the given allocation.
226 /// \param NewPtr - a char* which is the presumed-non-null
227 /// return value of the allocation function
228 /// \param NumElements - the computed number of elements,
229 /// potentially collapsed from the multidimensional array case;
231 /// \param ElementType - the base element allocated type,
232 /// i.e. the allocated type after stripping all array types
233 virtual llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
235 llvm::Value *NumElements,
236 const CXXNewExpr *expr,
237 QualType ElementType);
239 /// Reads the array cookie associated with the given pointer,
242 /// \param Ptr - a pointer to the first element in the array
243 /// \param ElementType - the base element type of elements of the array
244 /// \param NumElements - an out parameter which will be initialized
245 /// with the number of elements allocated, or zero if there is no
247 /// \param AllocPtr - an out parameter which will be initialized
248 /// with a char* pointing to the address returned by the allocation
250 /// \param CookieSize - an out parameter which will be initialized
251 /// with the size of the cookie, or zero if there is no cookie
252 virtual void ReadArrayCookie(CodeGenFunction &CGF, llvm::Value *Ptr,
253 const CXXDeleteExpr *expr,
254 QualType ElementType, llvm::Value *&NumElements,
255 llvm::Value *&AllocPtr, CharUnits &CookieSize);
258 /// Returns the extra size required in order to store the array
259 /// cookie for the given type. Assumes that an array cookie is
261 virtual CharUnits getArrayCookieSizeImpl(QualType elementType);
263 /// Reads the array cookie for an allocation which is known to have one.
264 /// This is called by the standard implementation of ReadArrayCookie.
266 /// \param ptr - a pointer to the allocation made for an array, as a char*
267 /// \param cookieSize - the computed cookie size of an array
269 /// Other parameters are as above.
272 virtual llvm::Value *readArrayCookieImpl(CodeGenFunction &IGF,
274 CharUnits cookieSize);
278 /*************************** Static local guards ****************************/
280 /// Emits the guarded initializer and destructor setup for the given
281 /// variable, given that it couldn't be emitted as a constant.
282 /// If \p PerformInit is false, the initialization has been folded to a
283 /// constant and should not be performed.
285 /// The variable may be:
286 /// - a static local variable
287 /// - a static data member of a class template instantiation
288 virtual void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
289 llvm::GlobalVariable *DeclPtr, bool PerformInit);
291 /// Emit code to force the execution of a destructor during global
292 /// teardown. The default implementation of this uses atexit.
294 /// \param dtor - a function taking a single pointer argument
295 /// \param addr - a pointer to pass to the destructor function.
296 virtual void registerGlobalDtor(CodeGenFunction &CGF, llvm::Constant *dtor,
297 llvm::Constant *addr);
299 /***************************** Virtual Tables *******************************/
301 /// Generates and emits the virtual tables for a class.
302 virtual void EmitVTables(const CXXRecordDecl *Class) = 0;
305 /// Creates an instance of a C++ ABI class.
306 CGCXXABI *CreateARMCXXABI(CodeGenModule &CGM);
307 CGCXXABI *CreateItaniumCXXABI(CodeGenModule &CGM);
308 CGCXXABI *CreateMicrosoftCXXABI(CodeGenModule &CGM);