180 lines · c
1//===----- ABIInfo.h - ABI information access & encapsulation ---*- 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-exception6//7//===----------------------------------------------------------------------===//8 9#ifndef LLVM_CLANG_LIB_CODEGEN_ABIINFO_H10#define LLVM_CLANG_LIB_CODEGEN_ABIINFO_H11 12#include "clang/AST/Attr.h"13#include "clang/AST/CharUnits.h"14#include "clang/AST/Type.h"15#include "llvm/IR/CallingConv.h"16#include "llvm/IR/Type.h"17 18namespace llvm {19class Value;20class LLVMContext;21class DataLayout;22class Type;23class FixedVectorType;24} // namespace llvm25 26namespace clang {27class ASTContext;28class CodeGenOptions;29class TargetInfo;30 31namespace CodeGen {32class ABIArgInfo;33class Address;34class CGCXXABI;35class CGFunctionInfo;36class CodeGenFunction;37class CodeGenTypes;38class RValue;39class AggValueSlot;40 41// FIXME: All of this stuff should be part of the target interface42// somehow. It is currently here because it is not clear how to factor43// the targets to support this, since the Targets currently live in a44// layer below types n'stuff.45 46/// ABIInfo - Target specific hooks for defining how a type should be47/// passed or returned from functions.48class ABIInfo {49protected:50 CodeGen::CodeGenTypes &CGT;51 llvm::CallingConv::ID RuntimeCC;52 53public:54 ABIInfo(CodeGen::CodeGenTypes &cgt)55 : CGT(cgt), RuntimeCC(llvm::CallingConv::C) {}56 57 virtual ~ABIInfo();58 59 virtual bool allowBFloatArgsAndRet() const { return false; }60 61 CodeGen::CGCXXABI &getCXXABI() const;62 ASTContext &getContext() const;63 llvm::LLVMContext &getVMContext() const;64 const llvm::DataLayout &getDataLayout() const;65 const TargetInfo &getTarget() const;66 const CodeGenOptions &getCodeGenOpts() const;67 68 /// Return the calling convention to use for system runtime69 /// functions.70 llvm::CallingConv::ID getRuntimeCC() const { return RuntimeCC; }71 72 virtual void computeInfo(CodeGen::CGFunctionInfo &FI) const = 0;73 74 /// EmitVAArg - Emit the target dependent code to load a value of75 /// \arg Ty from the va_list pointed to by \arg VAListAddr.76 77 // FIXME: This is a gaping layering violation if we wanted to drop78 // the ABI information any lower than CodeGen. Of course, for79 // VAArg handling it has to be at this level; there is no way to80 // abstract this out.81 virtual RValue EmitVAArg(CodeGen::CodeGenFunction &CGF,82 CodeGen::Address VAListAddr, QualType Ty,83 AggValueSlot Slot) const = 0;84 85 bool isAndroid() const;86 bool isOHOSFamily() const;87 88 /// Emit the target dependent code to load a value of89 /// \arg Ty from the \c __builtin_ms_va_list pointed to by \arg VAListAddr.90 virtual RValue EmitMSVAArg(CodeGen::CodeGenFunction &CGF,91 CodeGen::Address VAListAddr, QualType Ty,92 AggValueSlot Slot) const;93 94 virtual bool isHomogeneousAggregateBaseType(QualType Ty) const;95 96 virtual bool isHomogeneousAggregateSmallEnough(const Type *Base,97 uint64_t Members) const;98 virtual bool isZeroLengthBitfieldPermittedInHomogeneousAggregate() const;99 100 /// isHomogeneousAggregate - Return true if a type is an ELFv2 homogeneous101 /// aggregate. Base is set to the base element type, and Members is set102 /// to the number of base elements.103 bool isHomogeneousAggregate(QualType Ty, const Type *&Base,104 uint64_t &Members) const;105 106 // Implement the Type::IsPromotableIntegerType for ABI specific needs. The107 // only difference is that this considers bit-precise integer types as well.108 bool isPromotableIntegerTypeForABI(QualType Ty) const;109 110 /// A convenience method to return an indirect ABIArgInfo with an111 /// expected alignment equal to the ABI alignment of the given type.112 CodeGen::ABIArgInfo113 getNaturalAlignIndirect(QualType Ty, unsigned AddrSpace, bool ByVal = true,114 bool Realign = false,115 llvm::Type *Padding = nullptr) const;116 117 CodeGen::ABIArgInfo getNaturalAlignIndirectInReg(QualType Ty,118 bool Realign = false) const;119 120 virtual void appendAttributeMangling(TargetAttr *Attr,121 raw_ostream &Out) const;122 virtual void appendAttributeMangling(TargetVersionAttr *Attr,123 raw_ostream &Out) const;124 virtual void appendAttributeMangling(TargetClonesAttr *Attr, unsigned Index,125 raw_ostream &Out) const;126 virtual void appendAttributeMangling(StringRef AttrStr,127 raw_ostream &Out) const;128 129 /// Returns the optimal vector memory type based on the given vector type. For130 /// example, on certain targets, a vector with 3 elements might be promoted to131 /// one with 4 elements to improve performance.132 virtual llvm::FixedVectorType *133 getOptimalVectorMemoryType(llvm::FixedVectorType *T,134 const LangOptions &Opt) const;135 136 virtual llvm::Value *createCoercedLoad(Address SrcAddr, const ABIArgInfo &AI,137 CodeGenFunction &CGF) const;138 virtual void createCoercedStore(llvm::Value *Val, Address DstAddr,139 const ABIArgInfo &AI, bool DestIsVolatile,140 CodeGenFunction &CGF) const;141 142 /// Used by Arm64EC calling convention code to call into x86 calling143 /// convention code for varargs function.144 virtual ABIArgInfo classifyArgForArm64ECVarArg(QualType Ty) const;145};146 147/// Target specific hooks for defining how a type should be passed or returned148/// from functions with one of the Swift calling conventions.149class SwiftABIInfo {150protected:151 CodeGenTypes &CGT;152 bool SwiftErrorInRegister;153 154 bool occupiesMoreThan(ArrayRef<llvm::Type *> scalarTypes,155 unsigned maxAllRegisters) const;156 157public:158 SwiftABIInfo(CodeGen::CodeGenTypes &CGT, bool SwiftErrorInRegister)159 : CGT(CGT), SwiftErrorInRegister(SwiftErrorInRegister) {}160 161 virtual ~SwiftABIInfo();162 163 /// Returns true if an aggregate which expands to the given type sequence164 /// should be passed / returned indirectly.165 virtual bool shouldPassIndirectly(ArrayRef<llvm::Type *> ComponentTys,166 bool AsReturnValue) const;167 168 /// Returns true if the given vector type is legal from Swift's calling169 /// convention perspective.170 virtual bool isLegalVectorType(CharUnits VectorSize, llvm::Type *EltTy,171 unsigned NumElts) const;172 173 /// Returns true if swifterror is lowered to a register by the target ABI.174 bool isSwiftErrorInRegister() const { return SwiftErrorInRegister; };175};176} // end namespace CodeGen177} // end namespace clang178 179#endif180