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 ⭢ Assembler ⭢ asmjit::BaseMem

asmjit::BaseMem Class Reference

Inheritance diagram for asmjit::BaseMem:

Base class for all memory operands.

The data is split into the following parts:

• BASE - Base register or label - requires 36 bits total. 4 bits are used to encode the type of the BASE operand (label vs. register type) and the remaining 32 bits define the BASE id, which can be a physical or virtual register index. If BASE type is zero, which is never used as a register type and label doesn't use it as well then BASE field contains a high DWORD of a possible 64-bit absolute address, which is possible on X64.
• INDEX - Index register (or theoretically Label, which doesn't make sense). Encoding is similar to BASE - it also requires 36 bits and splits the encoding to INDEX type (4 bits defining the register type) and 32-bit id.
• OFFSET - A relative offset of the address. Basically if BASE is specified the relative displacement adjusts BASE and an optional INDEX. if BASE is not specified then the OFFSET should be considered as ABSOLUTE address (at least on X86). In that case its low 32 bits are stored in DISPLACEMENT field and the remaining high 32 bits are stored in BASE.
• OTHER - There is rest 8 bits that can be used for whatever purpose. For example x86::Mem operand uses these bits to store segment override prefix and index shift (or scale).

Member Functions

Construction & Destruction

constexpr BaseMem() noexcept

constexpr BaseMem(const BaseMem& other) noexcept

constexpr BaseMem(const BaseReg& baseReg, int32_t offset = 0) noexcept

BaseMem(Globals::NoInit_) noexcept

void reset() noexcept

Overloaded Operators

BaseMem& operator=(const BaseMem& other) noexcept

Accessors

constexpr BaseMem clone() const noexcept

BaseMem cloneAdjusted(int64_t off) const noexcept

constexpr bool isRegHome() const noexcept

void setRegHome() noexcept

void clearRegHome() noexcept

constexpr bool hasBase() const noexcept

constexpr bool hasIndex() const noexcept

constexpr bool hasBaseOrIndex() const noexcept

constexpr bool hasBaseAndIndex() const noexcept

constexpr bool hasBaseLabel() const noexcept

constexpr bool hasBaseReg() const noexcept

constexpr bool hasIndexReg() const noexcept

constexpr RegType baseType() const noexcept

constexpr RegType indexType() const noexcept

constexpr uint32_t baseAndIndexTypes() const noexcept

constexpr uint32_t baseId() const noexcept

constexpr uint32_t indexId() const noexcept

void setBaseId(uint32_t id) noexcept

void setBaseType(RegType regType) noexcept

void setIndexId(uint32_t id) noexcept

void setIndexType(RegType regType) noexcept

void setBase(const BaseReg& base) noexcept

void setIndex(const BaseReg& index) noexcept

void resetBase() noexcept

void resetIndex() noexcept

constexpr bool isOffset64Bit() const noexcept

constexpr bool hasOffset() const noexcept

constexpr int64_t offset() const noexcept

constexpr int32_t offsetLo32() const noexcept

constexpr int32_t offsetHi32() const noexcept

void setOffset(int64_t offset) noexcept

void setOffsetLo32(int32_t offset) noexcept

void addOffset(int64_t offset) noexcept

void addOffsetLo32(int32_t offset) noexcept

void resetOffset() noexcept

void resetOffsetLo32() noexcept

 Public Member Functions inherited from asmjit::Operand

constexpr Operand() noexcept

constexpr Operand(const Operand& other) noexcept = default

constexpr Operand(const Operand_& other)

constexpr Operand(Globals::Init_, const Signature& u0, uint32_t u1, uint32_t u2, uint32_t u3) noexcept

Operand(Globals::NoInit_) noexcept

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

Operand& operator=(const Operand_& other) noexcept

constexpr Operand clone() const noexcept

 Public Member Functions inherited from asmjit::Operand_

void copyFrom(const Operand_& other) noexcept

void reset() noexcept

constexpr bool operator==(const Operand_& other) const noexcept

constexpr bool operator!=(const Operand_& other) const noexcept

template<typename T>

T& as() noexcept

template<typename T>

const T& as() const noexcept

constexpr bool equals(const Operand_& other) const noexcept

constexpr bool hasSignature(const Operand_& other) const noexcept

constexpr bool hasSignature(const Signature& other) const noexcept

constexpr Signature signature() const noexcept

void setSignature(const Signature& signature) noexcept

void setSignature(uint32_t signature) noexcept

constexpr OperandType opType() const noexcept

constexpr bool isNone() const noexcept

constexpr bool isReg() const noexcept

constexpr bool isRegList() const noexcept

constexpr bool isMem() const noexcept

constexpr bool isImm() const noexcept

constexpr bool isLabel() const noexcept

constexpr bool isPhysReg() const noexcept

constexpr bool isVirtReg() const noexcept

constexpr uint32_t id() const noexcept

constexpr bool isReg(RegType type) const noexcept

constexpr bool isReg(RegGroup regGroup) const noexcept

constexpr bool isReg(RegType regType, uint32_t regId) const noexcept

constexpr bool isReg(RegGroup regGroup, uint32_t regId) const noexcept

constexpr bool isGp() const noexcept

constexpr bool isGp32() const noexcept

constexpr bool isGp64() const noexcept

constexpr bool isVec() const noexcept

constexpr bool isVec8() const noexcept

constexpr bool isVec16() const noexcept

constexpr bool isVec32() const noexcept

constexpr bool isVec64() const noexcept

constexpr bool isVec128() const noexcept

constexpr bool isVec256() const noexcept

constexpr bool isVec512() const noexcept

constexpr bool isMask() const noexcept

constexpr bool isRegList(RegType type) const noexcept

constexpr bool isRegOrMem() const noexcept

constexpr bool isRegOrRegListOrMem() const noexcept

constexpr uint32_t x86RmSize() const noexcept

Additional Inherited Members

 Public Attributes inherited from asmjit::Operand_

Signature _signature

uint32_t _baseId

uint32_t _data[2]

 Public Types inherited from asmjit::Operand_

enum DataIndex : uint32_t

enum VirtIdConstants : uint32_t

typedef OperandSignature Signature

 Static Public Member Functions inherited from asmjit::Operand_

static bool isVirtId(uint32_t id) noexcept

static uint32_t indexToVirtId(uint32_t id) noexcept

static uint32_t virtIdToIndex(uint32_t id) noexcept

BaseMem::BaseMem()constexprnoexcept[1/4]

Creates a default BaseMem operand, that points to [0].

BaseMem::BaseMem(

const BaseMem& other

)constexprnoexcept[2/4]

Creates a BaseMem operand that is a clone of other.

BaseMem::BaseMem(

const BaseReg& baseReg,

int32_t offset = 0

)constexprexplicitnoexcept[3/4]

Creates a BaseMem operand from baseReg and offset.

Note

This is an architecture independent constructor that can be used to create an architecture independent memory operand to be used in portable code that can handle multiple architectures.

BaseMem::BaseMem(

Globals::NoInit_

)explicitnoexcept[4/4]

Creates a completely uninitialized BaseMem operand.

void BaseMem::reset()noexcept

Resets the memory operand - after the reset the memory points to [0].

BaseMem BaseMem::clone() constconstexprnoexcept

Clones the memory operand.

BaseMem BaseMem::cloneAdjusted(

int64_t off

) constnoexcept

Creates a new copy of this memory operand adjusted by off.

bool BaseMem::isRegHome() constconstexprnoexcept

Tests whether this memory operand is a register home (only used by Compiler)

void BaseMem::setRegHome()noexcept

Mark this memory operand as register home (only used by Compiler).

void BaseMem::clearRegHome()noexcept

Marks this operand to not be a register home (only used by Compiler).

bool BaseMem::hasBase() constconstexprnoexcept

Tests whether the memory operand has a BASE register or label specified.

bool BaseMem::hasIndex() constconstexprnoexcept

Tests whether the memory operand has an INDEX register specified.

bool BaseMem::hasBaseOrIndex() constconstexprnoexcept

Tests whether the memory operand has BASE or INDEX register.

bool BaseMem::hasBaseAndIndex() constconstexprnoexcept

Tests whether the memory operand has BASE and INDEX register.

bool BaseMem::hasBaseLabel() constconstexprnoexcept

Tests whether the BASE operand is a label.

bool BaseMem::hasBaseReg() constconstexprnoexcept

Tests whether the BASE operand is a register (registers start after RegType::kLabelTag).

bool BaseMem::hasIndexReg() constconstexprnoexcept

Tests whether the INDEX operand is a register (registers start after RegType::kLabelTag).

RegType BaseMem::baseType() constconstexprnoexcept

Returns the type of the BASE register (0 if this memory operand doesn't use the BASE register).

Note

If the returned type is one (a value never associated to a register type) the BASE is not register, but it is a label. One equals to kLabelTag. You should always check hasBaseLabel() before using baseId() result.

RegType BaseMem::indexType() constconstexprnoexcept

Returns the type of an INDEX register (0 if this memory operand doesn't use the INDEX register).

uint32_t BaseMem::baseAndIndexTypes() constconstexprnoexcept

This is used internally for BASE+INDEX validation.

uint32_t BaseMem::baseId() constconstexprnoexcept

Returns both BASE (4:0 bits) and INDEX (9:5 bits) types combined into a single value.

Remarks

Returns id of the BASE register or label (if the BASE was specified as label).

uint32_t BaseMem::indexId() constconstexprnoexcept

Returns the id of the INDEX register.

void BaseMem::setBaseId(

uint32_t id

)noexcept

Sets the id of the BASE register (without modifying its type).

void BaseMem::setBaseType(

RegType regType

)noexcept

Sets the register type of the BASE register (without modifying its id).

void BaseMem::setIndexId(

uint32_t id

)noexcept

Sets the id of the INDEX register (without modifying its type).

void BaseMem::setIndexType(

RegType regType

)noexcept

Sets the register type of the INDEX register (without modifying its id).

void BaseMem::setBase(

const BaseReg& base

)noexcept

Sets the base register to type and id of the given base operand.

void BaseMem::setIndex(

const BaseReg& index

)noexcept

Sets the index register to type and id of the given index operand.

void BaseMem::resetBase()noexcept

Resets the memory operand's BASE register or label.

void BaseMem::resetIndex()noexcept

Resets the memory operand's INDEX register.

bool BaseMem::isOffset64Bit() constconstexprnoexcept

Tests whether the memory operand has a 64-bit offset or absolute address.

If this is true then hasBase() must always report false.

bool BaseMem::hasOffset() constconstexprnoexcept

Tests whether the memory operand has a non-zero offset or absolute address.

int64_t BaseMem::offset() constconstexprnoexcept

Returns either relative offset or absolute address as 64-bit integer.

int32_t BaseMem::offsetLo32() constconstexprnoexcept

Returns a 32-bit low part of a 64-bit offset or absolute address.

int32_t BaseMem::offsetHi32() constconstexprnoexcept

Returns a 32-but high part of a 64-bit offset or absolute address.

Note

This function is UNSAFE and returns garbage if isOffset64Bit() returns false. Never use it blindly without checking it first.

void BaseMem::setOffset(

int64_t offset

)noexcept

Sets a 64-bit offset or an absolute address to offset.

Note

This functions attempts to set both high and low parts of a 64-bit offset, however, if the operand has a BASE register it will store only the low 32 bits of the offset / address as there is no way to store both BASE and 64-bit offset, and there is currently no architecture that has such capability targeted by AsmJit.

void BaseMem::setOffsetLo32(

int32_t offset

)noexcept

Sets a low 32-bit offset to offset (don't use without knowing how BaseMem works).

void BaseMem::addOffset(

int64_t offset

)noexcept

Adjusts the offset by offset.

Note

This is a fast function that doesn't use the HI 32-bits of a 64-bit offset. Use it only if you know that there is a BASE register and the offset is only 32 bits anyway. Adjusts the memory operand offset by a offset.

void BaseMem::addOffsetLo32(

int32_t offset

)noexcept

Adds offset to a low 32-bit offset part (don't use without knowing how BaseMem works).

void BaseMem::resetOffset()noexcept

Resets the memory offset to zero.

void BaseMem::resetOffsetLo32()noexcept

Resets the lo part of the memory offset to zero (don't use without knowing how BaseMem works).

© 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.