Helper class to encapsulate information about how a specific type should be passed to or returned from a function. More...

#include "llvm/ABI/FunctionInfo.h"

Public Types
enum	Kind { Direct , Extend , Indirect , Ignore }

Public Member Functions
ArgInfo &	setSignExt (bool SignExtend=true)
ArgInfo &	setZeroExt (bool ZeroExtend=true)
ArgInfo &	setCanBeFlattened (bool Flatten)
	See getCanBeFlattened.
Kind	getKind () const
bool	isDirect () const
bool	isIndirect () const
bool	isIgnore () const
bool	isExtend () const
unsigned	getDirectOffset () const
MaybeAlign	getDirectAlign () const
Align	getIndirectAlign () const
unsigned	getIndirectAddrSpace () const
bool	getIndirectByVal () const
bool	getIndirectRealign () const
bool	getCanBeFlattened () const
	Whether a Direct record coercion may be split into one wire argument per field.
bool	isSignExt () const
bool	isZeroExt () const
bool	isNoExt () const
const Type *	getCoerceToType () const

Static Public Member Functions
static ArgInfo	getDirect (const Type *T=nullptr, unsigned Offset=0, MaybeAlign Align=std::nullopt, bool CanBeFlattened=true)
static ArgInfo	getExtend (const Type *T)
static ArgInfo	getIndirect (Align Align, bool ByVal, unsigned AddrSpace=0, bool Realign=false)
	Realign: the caller couldn't guarantee sufficient alignment - the callee must copy the argument to a properly aligned temporary before use.
static ArgInfo	getIgnore ()

Detailed Description

Helper class to encapsulate information about how a specific type should be passed to or returned from a function.

Definition at line 30 of file FunctionInfo.h.

Member Enumeration Documentation

◆ Kind

enum llvm::abi::ArgInfo::Kind

Enumerator
Direct	Pass the argument directly using the normal converted LLVM type, or by coercing to another specified type stored in 'CoerceToType'.
Extend	Valid only for integer argument types. Same as 'direct' but also emit a zero/sign extension attribute.
Indirect	Pass the argument indirectly via a hidden pointer with the specified alignment and address space.
Ignore	Ignore the argument (treat as void). Useful for void and empty structs.

Definition at line 32 of file FunctionInfo.h.

Member Function Documentation

◆ getCanBeFlattened()

bool llvm::abi::ArgInfo::getCanBeFlattened ( ) const

inline

Whether a Direct record coercion may be split into one wire argument per field.

Mirrors clang::CodeGen::ABIArgInfo::CanBeFlattened.

Definition at line 195 of file FunctionInfo.h.

References assert(), and isDirect().

◆ getCoerceToType()

const Type * llvm::abi::ArgInfo::getCoerceToType ( ) const

inline

Definition at line 215 of file FunctionInfo.h.

References assert(), isDirect(), and isExtend().

◆ getDirect()

ArgInfo llvm::abi::ArgInfo::getDirect	(	const Type *	T = nullptr,
		unsigned	Offset = 0,
		MaybeAlign	Align = std::nullopt,
		bool	CanBeFlattened = true )

inlinestatic

Parameters

T	The type to coerce to. If null, the argument's original type is used directly.
Offset	Byte offset into the memory representation at which the coerced type begins. Used when only part of a larger value is passed directly (e.g. the high word of a multi-eightbyte return value on x86-64).
Align	Override for the argument's alignment. If absent, the default alignment for `T` is used.
CanBeFlattened	Whether a record coercion may be split into one wire argument per field. See getCanBeFlattened.

Definition at line 91 of file FunctionInfo.h.

References Direct, DirectAttr, llvm::Offset, and T.

◆ getDirectAlign()

MaybeAlign llvm::abi::ArgInfo::getDirectAlign ( ) const

inline

Definition at line 166 of file FunctionInfo.h.

References assert(), isDirect(), and isExtend().

◆ getDirectOffset()

unsigned llvm::abi::ArgInfo::getDirectOffset ( ) const

inline

Definition at line 161 of file FunctionInfo.h.

References assert(), DirectAttr, isDirect(), and isExtend().

◆ getExtend()

ArgInfo llvm::abi::ArgInfo::getExtend ( const Type * T )

inlinestatic

Definition at line 102 of file FunctionInfo.h.

References assert(), llvm::cast(), DirectAttr, Extend, setSignExt(), setZeroExt(), and T.

◆ getIgnore()

ArgInfo llvm::abi::ArgInfo::getIgnore ( )

inlinestatic

Definition at line 132 of file FunctionInfo.h.

References Ignore.

◆ getIndirect()

ArgInfo llvm::abi::ArgInfo::getIndirect	(	Align	Align,
		bool	ByVal,
		unsigned	AddrSpace = 0,
		bool	Realign = false )

inlinestatic

Realign: the caller couldn't guarantee sufficient alignment - the callee must copy the argument to a properly aligned temporary before use.

Definition at line 122 of file FunctionInfo.h.

References Indirect, and IndirectAttr.

Referenced by llvm::abi::TargetInfo::getNaturalAlignIndirect(), and llvm::abi::TargetInfo::maybeCommonClassifyReturnType().

◆ getIndirectAddrSpace()

unsigned llvm::abi::ArgInfo::getIndirectAddrSpace ( ) const

inline

Definition at line 178 of file FunctionInfo.h.

References assert(), IndirectAttr, and isIndirect().

◆ getIndirectAlign()

Align llvm::abi::ArgInfo::getIndirectAlign ( ) const

inline

Definition at line 171 of file FunctionInfo.h.

References assert(), and isIndirect().

◆ getIndirectByVal()

bool llvm::abi::ArgInfo::getIndirectByVal ( ) const

inline

Definition at line 183 of file FunctionInfo.h.

References assert(), and isIndirect().

◆ getIndirectRealign()

bool llvm::abi::ArgInfo::getIndirectRealign ( ) const

inline

Definition at line 188 of file FunctionInfo.h.

References assert(), and isIndirect().

◆ getKind()

Kind llvm::abi::ArgInfo::getKind ( ) const

inline

Definition at line 155 of file FunctionInfo.h.

◆ isDirect()

bool llvm::abi::ArgInfo::isDirect ( ) const

inline

Definition at line 156 of file FunctionInfo.h.

References Direct.

Referenced by getCanBeFlattened(), getCoerceToType(), getDirectAlign(), getDirectOffset(), and setCanBeFlattened().

◆ isExtend()

bool llvm::abi::ArgInfo::isExtend ( ) const

inline

Definition at line 159 of file FunctionInfo.h.

References Extend.

Referenced by getCoerceToType(), getDirectAlign(), getDirectOffset(), isNoExt(), isSignExt(), and isZeroExt().

◆ isIgnore()

bool llvm::abi::ArgInfo::isIgnore ( ) const

inline

Definition at line 158 of file FunctionInfo.h.

References Ignore.

◆ isIndirect()

bool llvm::abi::ArgInfo::isIndirect ( ) const

inline

Definition at line 157 of file FunctionInfo.h.

References Indirect.

Referenced by getIndirectAddrSpace(), getIndirectAlign(), getIndirectByVal(), and getIndirectRealign().

◆ isNoExt()

bool llvm::abi::ArgInfo::isNoExt ( ) const

inline

Definition at line 210 of file FunctionInfo.h.

References assert(), and isExtend().

◆ isSignExt()

bool llvm::abi::ArgInfo::isSignExt ( ) const

inline

Definition at line 200 of file FunctionInfo.h.

References assert(), and isExtend().

◆ isZeroExt()

bool llvm::abi::ArgInfo::isZeroExt ( ) const

inline

Definition at line 205 of file FunctionInfo.h.

References assert(), and isExtend().

◆ setCanBeFlattened()

ArgInfo & llvm::abi::ArgInfo::setCanBeFlattened ( bool Flatten )

inline

See getCanBeFlattened.

Definition at line 149 of file FunctionInfo.h.

References assert(), and isDirect().

◆ setSignExt()

ArgInfo & llvm::abi::ArgInfo::setSignExt ( bool SignExtend = true )

inline

Definition at line 134 of file FunctionInfo.h.

Referenced by getExtend().

◆ setZeroExt()

ArgInfo & llvm::abi::ArgInfo::setZeroExt ( bool ZeroExtend = true )

inline

Definition at line 141 of file FunctionInfo.h.

Referenced by getExtend().

Member Data Documentation

◆ DirectAttr

DirectAttrInfo llvm::abi::ArgInfo::DirectAttr

Definition at line 65 of file FunctionInfo.h.

Referenced by getDirect(), getDirectOffset(), and getExtend().

◆ IndirectAttr

IndirectAttrInfo llvm::abi::ArgInfo::IndirectAttr

Definition at line 66 of file FunctionInfo.h.

Referenced by getIndirect(), and getIndirectAddrSpace().

The documentation for this class was generated from the following file:

include/llvm/ABI/FunctionInfo.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Kind

Member Function Documentation

◆ getCanBeFlattened()

◆ getCoerceToType()

◆ getDirect()

◆ getDirectAlign()

◆ getDirectOffset()

◆ getExtend()

◆ getIgnore()

◆ getIndirect()

◆ getIndirectAddrSpace()

◆ getIndirectAlign()

◆ getIndirectByVal()

◆ getIndirectRealign()

◆ getKind()

◆ isDirect()

◆ isExtend()

◆ isIgnore()

◆ isIndirect()

◆ isNoExt()

◆ isSignExt()

◆ isZeroExt()

◆ setCanBeFlattened()

◆ setSignExt()

◆ setZeroExt()

Member Data Documentation

◆ DirectAttr

◆ IndirectAttr