clang 19.0.0git
CodeGenTypes.h
Go to the documentation of this file.
1//===--- CodeGenTypes.h - Type translation for LLVM CodeGen -----*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This is the code that handles AST -> LLVM type lowering.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENTYPES_H
14#define LLVM_CLANG_LIB_CODEGEN_CODEGENTYPES_H
15
16#include "CGCall.h"
17#include "clang/Basic/ABI.h"
19#include "llvm/ADT/DenseMap.h"
20#include "llvm/IR/Module.h"
21
22namespace llvm {
23class FunctionType;
24class DataLayout;
25class Type;
26class LLVMContext;
27class StructType;
28}
29
30namespace clang {
31class ASTContext;
32template <typename> class CanQual;
33class CXXConstructorDecl;
34class CXXMethodDecl;
35class CodeGenOptions;
36class FunctionProtoType;
37class QualType;
38class RecordDecl;
39class TagDecl;
40class TargetInfo;
41class Type;
42typedef CanQual<Type> CanQualType;
43class GlobalDecl;
44
45namespace CodeGen {
46class ABIInfo;
47class CGCXXABI;
48class CGRecordLayout;
49class CodeGenModule;
50class RequiredArgs;
51
52/// This class organizes the cross-module state that is used while lowering
53/// AST types to LLVM types.
55 CodeGenModule &CGM;
56 // Some of this stuff should probably be left on the CGM.
57 ASTContext &Context;
58 llvm::Module &TheModule;
59 const TargetInfo &Target;
60 CGCXXABI &TheCXXABI;
61
62 // This should not be moved earlier, since its initialization depends on some
63 // of the previous reference members being already initialized
64 const ABIInfo &TheABIInfo;
65
66 /// The opaque type map for Objective-C interfaces. All direct
67 /// manipulation is done by the runtime interfaces, which are
68 /// responsible for coercing to the appropriate type; these opaque
69 /// types are never refined.
70 llvm::DenseMap<const ObjCInterfaceType*, llvm::Type *> InterfaceTypes;
71
72 /// Maps clang struct type with corresponding record layout info.
73 llvm::DenseMap<const Type*, std::unique_ptr<CGRecordLayout>> CGRecordLayouts;
74
75 /// Contains the LLVM IR type for any converted RecordDecl.
76 llvm::DenseMap<const Type*, llvm::StructType *> RecordDeclTypes;
77
78 /// Hold memoized CGFunctionInfo results.
79 llvm::FoldingSet<CGFunctionInfo> FunctionInfos{FunctionInfosLog2InitSize};
80
81 llvm::SmallPtrSet<const CGFunctionInfo*, 4> FunctionsBeingProcessed;
82
83 /// True if we didn't layout a function due to a being inside
84 /// a recursive struct conversion, set this to true.
85 bool SkippedLayout;
86
87 /// True if any instance of long double types are used.
88 bool LongDoubleReferenced;
89
90 /// This map keeps cache of llvm::Types and maps clang::Type to
91 /// corresponding llvm::Type.
92 llvm::DenseMap<const Type *, llvm::Type *> TypeCache;
93
94 llvm::DenseMap<const Type *, llvm::Type *> RecordsWithOpaqueMemberPointers;
95
96 static constexpr unsigned FunctionInfosLog2InitSize = 9;
97 /// Helper for ConvertType.
98 llvm::Type *ConvertFunctionTypeInternal(QualType FT);
99
100public:
103
104 const llvm::DataLayout &getDataLayout() const {
105 return TheModule.getDataLayout();
106 }
107 CodeGenModule &getCGM() const { return CGM; }
108 ASTContext &getContext() const { return Context; }
109 const ABIInfo &getABIInfo() const { return TheABIInfo; }
110 const TargetInfo &getTarget() const { return Target; }
111 CGCXXABI &getCXXABI() const { return TheCXXABI; }
112 llvm::LLVMContext &getLLVMContext() { return TheModule.getContext(); }
113 const CodeGenOptions &getCodeGenOpts() const;
114
115 /// Convert clang calling convention to LLVM callilng convention.
117
118 /// Derives the 'this' type for codegen purposes, i.e. ignoring method CVR
119 /// qualification.
121
122 /// ConvertType - Convert type T into a llvm::Type.
123 llvm::Type *ConvertType(QualType T);
124
125 /// ConvertTypeForMem - Convert type T into a llvm::Type. This differs from
126 /// ConvertType in that it is used to convert to the memory representation for
127 /// a type. For example, the scalar representation for _Bool is i1, but the
128 /// memory representation is usually i8 or i32, depending on the target.
129 llvm::Type *ConvertTypeForMem(QualType T, bool ForBitField = false);
130
131 /// GetFunctionType - Get the LLVM function type for \arg Info.
132 llvm::FunctionType *GetFunctionType(const CGFunctionInfo &Info);
133
134 llvm::FunctionType *GetFunctionType(GlobalDecl GD);
135
136 /// isFuncTypeConvertible - Utility to check whether a function type can
137 /// be converted to an LLVM type (i.e. doesn't depend on an incomplete tag
138 /// type).
139 bool isFuncTypeConvertible(const FunctionType *FT);
141
142 /// Determine if a C++ inheriting constructor should have parameters matching
143 /// those of its inherited constructor.
144 bool inheritingCtorHasParams(const InheritedConstructor &Inherited,
146
147 /// GetFunctionTypeForVTable - Get the LLVM function type for use in a vtable,
148 /// given a CXXMethodDecl. If the method to has an incomplete return type,
149 /// and/or incomplete argument types, this will return the opaque type.
150 llvm::Type *GetFunctionTypeForVTable(GlobalDecl GD);
151
153
154 /// UpdateCompletedType - When we find the full definition for a TagDecl,
155 /// replace the 'opaque' type we previously made for it if applicable.
156 void UpdateCompletedType(const TagDecl *TD);
157
158 /// Remove stale types from the type cache when an inheritance model
159 /// gets assigned to a class.
161
162 // The arrangement methods are split into three families:
163 // - those meant to drive the signature and prologue/epilogue
164 // of a function declaration or definition,
165 // - those meant for the computation of the LLVM type for an abstract
166 // appearance of a function, and
167 // - those meant for performing the IR-generation of a call.
168 // They differ mainly in how they deal with optional (i.e. variadic)
169 // arguments, as well as unprototyped functions.
170 //
171 // Key points:
172 // - The CGFunctionInfo for emitting a specific call site must include
173 // entries for the optional arguments.
174 // - The function type used at the call site must reflect the formal
175 // signature of the declaration being called, or else the call will
176 // go awry.
177 // - For the most part, unprototyped functions are called by casting to
178 // a formal signature inferred from the specific argument types used
179 // at the call-site. However, some targets (e.g. x86-64) screw with
180 // this for compatibility reasons.
181
183
184 /// Given a function info for a declaration, return the function info
185 /// for a call with the given arguments.
186 ///
187 /// Often this will be able to simply return the declaration info.
188 const CGFunctionInfo &arrangeCall(const CGFunctionInfo &declFI,
189 const CallArgList &args);
190
191 /// Free functions are functions that are compatible with an ordinary
192 /// C function pointer type.
195 const FunctionType *Ty,
196 bool ChainCall);
199
200 /// A nullary function is a freestanding function of type 'void ()'.
201 /// This method works for both calls and declarations.
203
204 /// A builtin function is a freestanding function using the default
205 /// C conventions.
206 const CGFunctionInfo &
208 const FunctionArgList &args);
209 const CGFunctionInfo &
211 ArrayRef<CanQualType> argTypes);
213 const CallArgList &args);
214
215 /// Objective-C methods are C functions with some implicit parameters.
218 QualType receiverType);
220 QualType returnType,
221 const CallArgList &args);
222
223 /// Block invocation functions are C functions with an implicit parameter.
225 const FunctionProtoType *type,
226 const FunctionArgList &args);
228 const FunctionType *type);
229
230 /// C++ methods have some special rules and also have implicit parameters.
234 const CXXConstructorDecl *D,
235 CXXCtorType CtorKind,
236 unsigned ExtraPrefixArgs,
237 unsigned ExtraSuffixArgs,
238 bool PassProtoArgs = true);
239
241 const FunctionProtoType *type,
242 RequiredArgs required,
243 unsigned numPrefixArgs);
244 const CGFunctionInfo &
247 CXXCtorType CT);
249 const FunctionProtoType *FTP,
250 const CXXMethodDecl *MD);
251
252 /// "Arrange" the LLVM information for a call or type with the given
253 /// signature. This is largely an internal method; other clients
254 /// should use one of the above routines, which ultimately defer to
255 /// this.
256 ///
257 /// \param argTypes - must all actually be canonical as params
259 CanQualType returnType, FnInfoOpts opts, ArrayRef<CanQualType> argTypes,
262 RequiredArgs args);
263
264 /// Compute a new LLVM record layout object for the given record.
265 std::unique_ptr<CGRecordLayout> ComputeRecordLayout(const RecordDecl *D,
266 llvm::StructType *Ty);
267
268 /// addRecordTypeName - Compute a name from the given record decl with an
269 /// optional suffix and name the given LLVM type using it.
270 void addRecordTypeName(const RecordDecl *RD, llvm::StructType *Ty,
271 StringRef suffix);
272
273
274public: // These are internal details of CGT that shouldn't be used externally.
275 /// ConvertRecordDeclType - Lay out a tagged decl type like struct or union.
276 llvm::StructType *ConvertRecordDeclType(const RecordDecl *TD);
277
278 /// getExpandedTypes - Expand the type \arg Ty into the LLVM
279 /// argument types it would be passed as. See ABIArgInfo::Expand.
282
283 /// IsZeroInitializable - Return whether a type can be
284 /// zero-initialized (in the C++ sense) with an LLVM zeroinitializer.
286
287 /// Check if the pointer type can be zero-initialized (in the C++ sense)
288 /// with an LLVM zeroinitializer.
290
291 /// IsZeroInitializable - Return whether a record type can be
292 /// zero-initialized (in the C++ sense) with an LLVM zeroinitializer.
293 bool isZeroInitializable(const RecordDecl *RD);
294
295 bool isLongDoubleReferenced() const { return LongDoubleReferenced; }
296 bool isRecordLayoutComplete(const Type *Ty) const;
297 unsigned getTargetAddressSpace(QualType T) const;
298};
299
300} // end namespace CodeGen
301} // end namespace clang
302
303#endif
Enums/classes describing ABI related information about constructors, destructors and thunks.
MatchType Type
llvm::MachO::Target Target
Definition: MachO.h:50
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:182
Represents a C++ constructor within a class.
Definition: DeclCXX.h:2535
Represents a static or instance method of a struct/union/class.
Definition: DeclCXX.h:2060
Represents a C++ struct/union/class.
Definition: DeclCXX.h:258
CodeGenOptions - Track various options which control how the code is optimized and passed to the back...
ABIInfo - Target specific hooks for defining how a type should be passed or returned from functions.
Definition: ABIInfo.h:45
Implements C++ ABI-specific code generation functions.
Definition: CGCXXABI.h:43
CGFunctionInfo - Class to encapsulate the information about a function definition.
CGRecordLayout - This class handles struct and union layout info while lowering AST types to LLVM typ...
CallArgList - Type for representing both the value and type of arguments in a call.
Definition: CGCall.h:258
This class organizes the cross-function state that is used while generating LLVM code.
This class organizes the cross-module state that is used while lowering AST types to LLVM types.
Definition: CodeGenTypes.h:54
const CGFunctionInfo & arrangeCXXMethodType(const CXXRecordDecl *RD, const FunctionProtoType *FTP, const CXXMethodDecl *MD)
Arrange the argument and result information for a call to an unknown C++ non-static member function o...
Definition: CGCall.cpp:279
llvm::Type * ConvertType(QualType T)
ConvertType - Convert type T into a llvm::Type.
const CGFunctionInfo & arrangeCXXMethodDeclaration(const CXXMethodDecl *MD)
C++ methods have some special rules and also have implicit parameters.
Definition: CGCall.cpp:307
bool isPointerZeroInitializable(QualType T)
Check if the pointer type can be zero-initialized (in the C++ sense) with an LLVM zeroinitializer.
const CodeGenOptions & getCodeGenOpts() const
ASTContext & getContext() const
Definition: CodeGenTypes.h:108
const CGFunctionInfo & arrangeLLVMFunctionInfo(CanQualType returnType, FnInfoOpts opts, ArrayRef< CanQualType > argTypes, FunctionType::ExtInfo info, ArrayRef< FunctionProtoType::ExtParameterInfo > paramInfos, RequiredArgs args)
"Arrange" the LLVM information for a call or type with the given signature.
Definition: CGCall.cpp:766
const ABIInfo & getABIInfo() const
Definition: CodeGenTypes.h:109
const CGFunctionInfo & arrangeFreeFunctionType(CanQual< FunctionProtoType > Ty)
Arrange the argument and result information for a value of the given freestanding function type.
Definition: CGCall.cpp:206
CanQualType DeriveThisType(const CXXRecordDecl *RD, const CXXMethodDecl *MD)
Derives the 'this' type for codegen purposes, i.e.
Definition: CGCall.cpp:87
llvm::FunctionType * GetFunctionType(const CGFunctionInfo &Info)
GetFunctionType - Get the LLVM function type for.
Definition: CGCall.cpp:1632
bool inheritingCtorHasParams(const InheritedConstructor &Inherited, CXXCtorType Type)
Determine if a C++ inheriting constructor should have parameters matching those of its inherited cons...
Definition: CGCall.cpp:324
bool isFuncTypeConvertible(const FunctionType *FT)
isFuncTypeConvertible - Utility to check whether a function type can be converted to an LLVM type (i....
const CGFunctionInfo & arrangeBlockFunctionCall(const CallArgList &args, const FunctionType *type)
A block function is essentially a free function with an extra implicit argument.
Definition: CGCall.cpp:649
const CGFunctionInfo & arrangeBuiltinFunctionDeclaration(QualType resultType, const FunctionArgList &args)
A builtin function is a freestanding function using the default C conventions.
Definition: CGCall.cpp:680
const CGFunctionInfo & arrangeUnprototypedObjCMessageSend(QualType returnType, const CallArgList &args)
Definition: CGCall.cpp:533
const TargetInfo & getTarget() const
Definition: CodeGenTypes.h:110
std::unique_ptr< CGRecordLayout > ComputeRecordLayout(const RecordDecl *D, llvm::StructType *Ty)
Compute a new LLVM record layout object for the given record.
const CGRecordLayout & getCGRecordLayout(const RecordDecl *)
getCGRecordLayout - Return record layout info for the given record decl.
unsigned getTargetAddressSpace(QualType T) const
void getExpandedTypes(QualType Ty, SmallVectorImpl< llvm::Type * >::iterator &TI)
getExpandedTypes - Expand the type
Definition: CGCall.cpp:1014
llvm::StructType * ConvertRecordDeclType(const RecordDecl *TD)
ConvertRecordDeclType - Lay out a tagged decl type like struct or union.
void RefreshTypeCacheForClass(const CXXRecordDecl *RD)
Remove stale types from the type cache when an inheritance model gets assigned to a class.
bool isRecordLayoutComplete(const Type *Ty) const
isRecordLayoutComplete - Return true if the specified type is already completely laid out.
const CGFunctionInfo & arrangeObjCMethodDeclaration(const ObjCMethodDecl *MD)
Objective-C methods are C functions with some implicit parameters.
Definition: CGCall.cpp:487
CodeGenModule & getCGM() const
Definition: CodeGenTypes.h:107
void UpdateCompletedType(const TagDecl *TD)
UpdateCompletedType - When we find the full definition for a TagDecl, replace the 'opaque' type we pr...
llvm::LLVMContext & getLLVMContext()
Definition: CodeGenTypes.h:112
const CGFunctionInfo & arrangeGlobalDeclaration(GlobalDecl GD)
Definition: CGCall.cpp:543
bool isLongDoubleReferenced() const
Definition: CodeGenTypes.h:295
const CGFunctionInfo & arrangeUnprototypedMustTailThunk(const CXXMethodDecl *MD)
Arrange a thunk that takes 'this' as the first parameter followed by varargs.
Definition: CGCall.cpp:560
const CGFunctionInfo & arrangeCXXMethodCall(const CallArgList &args, const FunctionProtoType *type, RequiredArgs required, unsigned numPrefixArgs)
Arrange a call to a C++ method, passing the given arguments.
Definition: CGCall.cpp:702
const llvm::DataLayout & getDataLayout() const
Definition: CodeGenTypes.h:104
CGCXXABI & getCXXABI() const
Definition: CodeGenTypes.h:111
const CGFunctionInfo & arrangeFreeFunctionCall(const CallArgList &Args, const FunctionType *Ty, bool ChainCall)
Figure out the rules for calling a function with the given formal type using the given arguments.
Definition: CGCall.cpp:639
bool isFuncParamTypeConvertible(QualType Ty)
isFuncParamTypeConvertible - Return true if the specified type in a function parameter or result posi...
const CGFunctionInfo & arrangeBuiltinFunctionCall(QualType resultType, const CallArgList &args)
Definition: CGCall.cpp:668
const CGFunctionInfo & arrangeFunctionDeclaration(const FunctionDecl *FD)
Free functions are functions that are compatible with an ordinary C function pointer type.
Definition: CGCall.cpp:463
bool isZeroInitializable(QualType T)
IsZeroInitializable - Return whether a type can be zero-initialized (in the C++ sense) with an LLVM z...
const CGFunctionInfo & arrangeBlockFunctionDeclaration(const FunctionProtoType *type, const FunctionArgList &args)
Block invocation functions are C functions with an implicit parameter.
Definition: CGCall.cpp:656
unsigned ClangCallConvToLLVMCallConv(CallingConv CC)
Convert clang calling convention to LLVM callilng convention.
Definition: CGCall.cpp:50
llvm::Type * ConvertTypeForMem(QualType T, bool ForBitField=false)
ConvertTypeForMem - Convert type T into a llvm::Type.
llvm::Type * GetFunctionTypeForVTable(GlobalDecl GD)
GetFunctionTypeForVTable - Get the LLVM function type for use in a vtable, given a CXXMethodDecl.
Definition: CGCall.cpp:1759
void addRecordTypeName(const RecordDecl *RD, llvm::StructType *Ty, StringRef suffix)
addRecordTypeName - Compute a name from the given record decl with an optional suffix and name the gi...
const CGFunctionInfo & arrangeCXXConstructorCall(const CallArgList &Args, const CXXConstructorDecl *D, CXXCtorType CtorKind, unsigned ExtraPrefixArgs, unsigned ExtraSuffixArgs, bool PassProtoArgs=true)
Arrange a call to a C++ method, passing the given arguments.
Definition: CGCall.cpp:419
const CGFunctionInfo & arrangeObjCMessageSendSignature(const ObjCMethodDecl *MD, QualType receiverType)
Arrange the argument and result information for the function type through which to perform a send to ...
Definition: CGCall.cpp:500
const CGFunctionInfo & arrangeCXXStructorDeclaration(GlobalDecl GD)
Definition: CGCall.cpp:334
const CGFunctionInfo & arrangeMSCtorClosure(const CXXConstructorDecl *CD, CXXCtorType CT)
Definition: CGCall.cpp:569
const CGFunctionInfo & arrangeCall(const CGFunctionInfo &declFI, const CallArgList &args)
Given a function info for a declaration, return the function info for a call with the given arguments...
Definition: CGCall.cpp:729
const CGFunctionInfo & arrangeNullaryFunction()
A nullary function is a freestanding function of type 'void ()'.
Definition: CGCall.cpp:722
FunctionArgList - Type for representing both the decl and type of parameters to a function.
Definition: CGCall.h:352
A class for recording the number of arguments that a function signature requires.
Represents a function declaration or definition.
Definition: Decl.h:1971
Represents a prototype with parameter type info, e.g.
Definition: Type.h:4657
A class which abstracts out some details necessary for making a call.
Definition: Type.h:4368
FunctionType - C99 6.7.5.3 - Function Declarators.
Definition: Type.h:4257
GlobalDecl - represents a global declaration.
Definition: GlobalDecl.h:56
Description of a constructor that was inherited from a base class.
Definition: DeclCXX.h:2506
ObjCMethodDecl - Represents an instance or class method declaration.
Definition: DeclObjC.h:140
A (possibly-)qualified type.
Definition: Type.h:940
Represents a struct/union/class.
Definition: Decl.h:4168
Represents the declaration of a struct/union/class/enum.
Definition: Decl.h:3584
Exposes information about the current target.
Definition: TargetInfo.h:218
The base class of the type hierarchy.
Definition: Type.h:1813
const internal::VariadicAllOfMatcher< Type > type
Matches Types in the clang AST.
The JSON file list parser is used to communicate input to InstallAPI.
CXXCtorType
C++ constructor types.
Definition: ABI.h:24
CanQual< Type > CanQualType
Represents a canonical, potentially-qualified type.
const FunctionProtoType * T
CallingConv
CallingConv - Specifies the calling convention that a function uses.
Definition: Specifiers.h:275
Diagnostic wrappers for TextAPI types for error reporting.
Definition: Dominators.h:30