AsmJit

Low-Latency Machine Code Generation

Docs

Interactive Parser

Support

GitHub

API Reference

Index Class List Build Instructions Breaking Changes Core Assembler Builder Compiler Function Logging Error Handling Instruction DB Virtual Memory Zone Memory Utilities X86 Backend ARM Commons AArch64 Backend

Index ⭢ Function ⭢ asmjit::FuncArgsAssignment

asmjit::FuncArgsAssignment Class Reference

A helper class that can be used to assign a physical register for each function argument.

Use with BaseEmitter::emitArgsAssignment().

Public Members

Members

const FuncDetail* _funcDetail {}

uint8_t _saRegId = uint8_t(Reg::kIdBad)

uint8_t _reserved[3] {}

FuncValuePack _argPacks[Globals::kMaxFuncArgs] {}

Member Functions

Construction & Destruction

FuncArgsAssignment(const FuncDetail* fd = nullptr) noexcept

FuncArgsAssignment(const FuncArgsAssignment& other) noexcept = default

void reset(const FuncDetail* fd = nullptr) noexcept

Overloaded Operators

FuncArgsAssignment& operator=(const FuncArgsAssignment& other) noexcept = default

Accessors

const FuncDetail* funcDetail() const noexcept

void setFuncDetail(const FuncDetail* fd) noexcept

bool hasSARegId() const noexcept

uint32_t saRegId() const noexcept

void setSARegId(uint32_t regId)

void resetSARegId()

FuncValue& arg(size_t argIndex, size_t valueIndex) noexcept

const FuncValue& arg(size_t argIndex, size_t valueIndex) const noexcept

bool isAssigned(size_t argIndex, size_t valueIndex) const noexcept

void assignReg(size_t argIndex, const Reg& reg, TypeId typeId = TypeId::kVoid) noexcept

void assignReg(size_t argIndex, RegType regType, uint32_t regId, TypeId typeId = TypeId::kVoid) noexcept

void assignStack(size_t argIndex, int32_t offset, TypeId typeId = TypeId::kVoid) noexcept

void assignRegInPack(size_t argIndex, size_t valueIndex, const Reg& reg, TypeId typeId = TypeId::kVoid) noexcept

void assignRegInPack(size_t argIndex, size_t valueIndex, RegType regType, uint32_t regId, TypeId typeId = TypeId::kVoid) noexcept

void assignStackInPack(size_t argIndex, size_t valueIndex, int32_t offset, TypeId typeId = TypeId::kVoid) noexcept

void _assignAllInternal(size_t argIndex, const Reg& reg) noexcept

template<typename... Args>

void _assignAllInternal(size_t argIndex, const Reg& reg, Args&&... args) noexcept

template<typename... Args>

void assignAll(Args&&... args) noexcept

Utilities

Error updateFuncFrame(FuncFrame& frame) const noexcept

FuncArgsAssignment::FuncArgsAssignment(

const FuncDetail* fd = nullptr

)explicitnoexcept[1/2]

Creates either a default initialized FuncArgsAssignment or to assignment that links to fd, if non-null.

FuncArgsAssignment::FuncArgsAssignment(

const FuncArgsAssignment& other

)defaultnoexcept[2/2]

Copy constructor.

void FuncArgsAssignment::reset(

const FuncDetail* fd = nullptr

)noexcept

Resets this FuncArgsAssignment to either default constructed state or to assignment that links to fd, if non-null.

FuncArgsAssignment& FuncArgsAssignment::operator=(

const FuncArgsAssignment& other

)defaultnoexcept

Copy assignment.

const FuncDetail* FuncArgsAssignment::funcDetail() constnoexcept

Returns the associated FuncDetail of this FuncArgsAssignment.

void FuncArgsAssignment::setFuncDetail(

const FuncDetail* fd

)noexcept

Associates FuncDetail with this FuncArgsAssignment.

FuncValue& FuncArgsAssignment::arg(

size_t argIndex,

size_t valueIndex

)noexcept[1/2]

Returns assigned argument at argIndex and valueIndex.

Note

argIndex refers to he function argument and valueIndex refers to a value pack (in case multiple values are passed as a single argument).

const FuncValue& FuncArgsAssignment::arg(

size_t argIndex,

size_t valueIndex

) constnoexcept[2/2]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool FuncArgsAssignment::isAssigned(

size_t argIndex,

size_t valueIndex

) constnoexcept

Tests whether argument at argIndex and valueIndex has been assigned.

void FuncArgsAssignment::assignReg(

size_t argIndex,

const Reg& reg,

TypeId typeId = TypeId::kVoid

)noexcept[1/2]

Assigns register at argIndex and value index of 0 to reg and an optional typeId.

void FuncArgsAssignment::assignReg(

size_t argIndex,

RegType regType,

uint32_t regId,

TypeId typeId = TypeId::kVoid

)noexcept[2/2]

Assigns register at argIndex and value index of 0 to regType, regId, and an optional typeId.

void FuncArgsAssignment::assignStack(

size_t argIndex,

int32_t offset,

TypeId typeId = TypeId::kVoid

)noexcept

Assigns stack at argIndex and value index of 0 to offset and an optional typeId.

void FuncArgsAssignment::assignRegInPack(

size_t argIndex,

size_t valueIndex,

const Reg& reg,

TypeId typeId = TypeId::kVoid

)noexcept[1/2]

Assigns register at argIndex and valueIndex to reg and an optional typeId.

void FuncArgsAssignment::assignRegInPack(

size_t argIndex,

size_t valueIndex,

RegType regType,

uint32_t regId,

TypeId typeId = TypeId::kVoid

)noexcept[2/2]

Assigns register at argIndex and valueIndex to regType, regId, and an optional typeId.

void FuncArgsAssignment::assignStackInPack(

size_t argIndex,

size_t valueIndex,

int32_t offset,

TypeId typeId = TypeId::kVoid

)noexcept

Assigns stack at argIndex and valueIndex to offset and an optional typeId.

template<typename... Args>

void FuncArgsAssignment::assignAll(

Args&&... args

)noexcept

Assigns all argument at once.

Note

This function can be only used if the arguments don't contain value packs (multiple values per argument).

Error FuncArgsAssignment::updateFuncFrame(

FuncFrame& frame

) constnoexcept

Update FuncFrame based on function's arguments assignment.

Note

This function must be called in order to use BaseEmitter::emitArgsAssignment(), otherwise the FuncFrame would not contain the information necessary to assign all arguments into the registers and/or stack specified.

const FuncDetail* FuncArgsAssignment::_funcDetail {}

Function detail.

uint8_t FuncArgsAssignment::_saRegId = uint8_t(

Reg::kIdBad

)

Register that can be used to access arguments passed by stack.

uint8_t FuncArgsAssignment::_reserved[3] {}

Reserved for future use.

FuncValuePack FuncArgsAssignment::_argPacks[Globals::kMaxFuncArgs] {}

Mapping of each function argument.

© 2018-2024 AsmJit Authors | GitHub | Chat | Blog

AsmJit and AsmTK libraries are open source software released under the Zlib license and can be used safely in any open-source or commercial product, statically or dynamically linked, and without having to advertise the use of the libraries. Code snippets and examples are released into public domain, see Unlicense for more details.