asmjit::x86::Mem Class Reference

Inheritance diagram for asmjit::x86::Mem:

Memory operand specific to X86 and X86_64 architecture.

Public Types

Constants

enum AdditionalBits : uint32_t

enum class AddrType : uint32_t

enum class Broadcast : uint32_t

 Public Types inherited from asmjit::Operand_

enum DataIndex : uint32_t

enum VirtIdConstants : uint32_t

typedef OperandSignature Signature

Member Functions

Construction & Destruction

constexpr Mem() noexcept

constexpr Mem(const Mem& other) noexcept

Mem(Globals::NoInit_) noexcept

constexpr Mem(const Signature& signature, uint32_t baseId, uint32_t indexId, int32_t offset) noexcept

constexpr Mem(const Label& base, int32_t off, uint32_t size = 0, Signature signature = OperandSignature {0}) noexcept

constexpr Mem(const Label& base, const BaseReg& index, uint32_t shift, int32_t off, uint32_t size = 0, Signature signature = OperandSignature {0}) noexcept

constexpr Mem(const BaseReg& base, int32_t off, uint32_t size = 0, Signature signature = OperandSignature {0}) noexcept

constexpr Mem(const BaseReg& base, const BaseReg& index, uint32_t shift, int32_t off, uint32_t size = 0, Signature signature = OperandSignature {0}) noexcept

constexpr Mem(uint64_t base, uint32_t size = 0, Signature signature = OperandSignature {0}) noexcept

constexpr Mem(uint64_t base, const BaseReg& index, uint32_t shift = 0, uint32_t size = 0, Signature signature = OperandSignature {0}) noexcept

Overloaded Operators

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

Clone

constexpr Mem clone() const noexcept

Mem cloneAdjusted(int64_t off) const noexcept

Mem cloneResized(uint32_t size) const noexcept

constexpr Mem cloneBroadcasted(Broadcast bcst) const noexcept

Base & Index

Reg baseReg() const noexcept

Reg indexReg() const noexcept

void setIndex(const BaseReg& index, uint32_t shift) noexcept

void setIndex(const BaseReg& index) noexcept

Memory Size

constexpr bool hasSize() const noexcept

constexpr bool hasSize(uint32_t s) const noexcept

constexpr uint32_t size() const noexcept

void setSize(uint32_t size) noexcept

Address Type

constexpr AddrType addrType() const noexcept

void setAddrType(AddrType addrType) noexcept

void resetAddrType() noexcept

constexpr bool isAbs() const noexcept

void setAbs() noexcept

constexpr bool isRel() const noexcept

void setRel() noexcept

Segment

constexpr bool hasSegment() const noexcept

constexpr SReg segment() const noexcept

constexpr uint32_t segmentId() const noexcept

void setSegment(const SReg& seg) noexcept

void setSegment(uint32_t rId) noexcept

void resetSegment() noexcept

Shift

constexpr bool hasShift() const noexcept

constexpr uint32_t shift() const noexcept

void setShift(uint32_t shift) noexcept

void resetShift() noexcept

Broadcast

constexpr bool hasBroadcast() const noexcept

constexpr Broadcast getBroadcast() const noexcept

void setBroadcast(Broadcast b) noexcept

void resetBroadcast() noexcept

constexpr Mem _1to1() const noexcept

constexpr Mem _1to2() const noexcept

constexpr Mem _1to4() const noexcept

constexpr Mem _1to8() const noexcept

constexpr Mem _1to16() const noexcept

constexpr Mem _1to32() const noexcept

constexpr Mem _1to64() const noexcept

 Public Member Functions inherited from asmjit::BaseMem

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

BaseMem& operator=(const BaseMem& other) noexcept

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]

 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

Member Enumeration Documentation

x86::Mem::AdditionalBits : uint32_tenum

Additional bits of operand's signature used by x86::Mem.

class x86::Mem::AddrType : uint32_tenumstrong

Address type.

Constant	Description
kDefault	Default address type, Assembler will select the best type when necessary.
kAbs	Absolute address type.
kRel	Relative address type.
kMaxValue	Maximum value of AddrType.

class x86::Mem::Broadcast : uint32_tenumstrong

Memory broadcast type.

Constant	Description
kNone	No broadcast (regular memory operand).
k1To2	Broadcast {1to2}.
k1To4	Broadcast {1to4}.
k1To8	Broadcast {1to8}.
k1To16	Broadcast {1to16}.
k1To32	Broadcast {1to32}.
k1To64	Broadcast {1to64}.
kMaxValue	Maximum value of Broadcast.

Constructor & Destructor Documentation

x86::Mem::Mem()constexprconstexprnoexcept

Creates a default Mem operand that points to [0].

Member Function Documentation

Mem x86::Mem::clone() constconstexprconstexprnoexcept

Clones the memory operand.

Mem x86::Mem::cloneAdjusted(int64_t off) constnoexcept

Creates a copy of this memory operand adjusted by off.

Mem x86::Mem::cloneResized(uint32_t size) constnoexcept

Creates a copy of this memory operand resized to size.

Mem x86::Mem::cloneBroadcasted(Broadcast bcst) constconstexprconstexprnoexcept

Creates a copy of this memory operand with a broadcast bcst.

Reg x86::Mem::baseReg() constnoexcept

Converts memory baseType and baseId to x86::Reg instance.

The memory must have a valid base register otherwise the result will be wrong.

Reg x86::Mem::indexReg() constnoexcept

Converts memory indexType and indexId to x86::Reg instance.

The memory must have a valid index register otherwise the result will be wrong.

bool x86::Mem::hasSize() constconstexprconstexprnoexcept[1/2]

Tests whether the memory operand specifies a size (i.e. the size is not zero).

bool x86::Mem::hasSize(uint32_t s) constconstexprconstexprnoexcept[2/2]

Tests whether the memory operand size matches size s.

uint32_t x86::Mem::size() constconstexprconstexprnoexcept

Returns the size of the memory operand in bytes.

Note

Most instructions would deduce the size of the memory operand, so in most cases it's expected that the returned value would be zero. However, some instruction require the size to select between multiple variations, so in some cases size is required would be non-zero (for example inc [mem], immediate requires size to distinguish between 8-bit, 16-bit, 32-bit, and 64-bit increments.

void x86::Mem::setSize(uint32_t size)noexcept

Sets the memory operand size (in bytes).

AddrType x86::Mem::addrType() constconstexprconstexprnoexcept

Returns the address type of the memory operand.

By default, address type of newly created memory operands is always AddrType::kDefault.

void x86::Mem::setAddrType(AddrType addrType)noexcept

Sets the address type to addrType.

void x86::Mem::resetAddrType()noexcept

Resets the address type to AddrType::kDefault.

bool x86::Mem::isAbs() constconstexprconstexprnoexcept

Tests whether the address type is AddrType::kAbs.

void x86::Mem::setAbs()noexcept

Sets the address type to AddrType::kAbs.

bool x86::Mem::isRel() constconstexprconstexprnoexcept

Tests whether the address type is AddrType::kRel.

void x86::Mem::setRel()noexcept

Sets the address type to AddrType::kRel.

bool x86::Mem::hasSegment() constconstexprconstexprnoexcept

Tests whether the memory operand has a segment override.

SReg x86::Mem::segment() constconstexprconstexprnoexcept

Returns the associated segment override as SReg operand.

uint32_t x86::Mem::segmentId() constconstexprconstexprnoexcept

Returns segment override register id, see SReg::Id.

void x86::Mem::setSegment(const SReg& seg)noexcept[1/2]

Sets the segment override to seg.

void x86::Mem::setSegment(uint32_t rId)noexcept[2/2]

Sets the segment override to id.

void x86::Mem::resetSegment()noexcept

Resets the segment override.

bool x86::Mem::hasShift() constconstexprconstexprnoexcept

Tests whether the memory operand has shift (aka scale) value.

uint32_t x86::Mem::shift() constconstexprconstexprnoexcept

Returns the memory operand's shift (aka scale) value.

void x86::Mem::setShift(uint32_t shift)noexcept

Sets the memory operand's shift (aka scale) value.

void x86::Mem::resetShift()noexcept

Resets the memory operand's shift (aka scale) value to zero.

bool x86::Mem::hasBroadcast() constconstexprconstexprnoexcept

Tests whether the memory operand has broadcast {1tox}.

Broadcast x86::Mem::getBroadcast() constconstexprconstexprnoexcept

Returns the memory operand's broadcast.

void x86::Mem::setBroadcast(Broadcast b)noexcept

Sets the memory operand's broadcast.

void x86::Mem::resetBroadcast()noexcept

Resets the memory operand's broadcast to none.

Mem x86::Mem::_1to1() constconstexprconstexprnoexcept

Returns a new Mem without a broadcast (the possible broadcast is cleared).

Mem x86::Mem::_1to2() constconstexprconstexprnoexcept

Returns a new Mem with {1to2} broadcast (AVX-512).

Mem x86::Mem::_1to4() constconstexprconstexprnoexcept

Returns a new Mem with {1to4} broadcast (AVX-512).

Mem x86::Mem::_1to8() constconstexprconstexprnoexcept

Returns a new Mem with {1to8} broadcast (AVX-512).

Mem x86::Mem::_1to16() constconstexprconstexprnoexcept

Returns a new Mem with {1to16} broadcast (AVX-512).

Mem x86::Mem::_1to32() constconstexprconstexprnoexcept

Returns a new Mem with {1to32} broadcast (AVX-512).

Mem x86::Mem::_1to64() constconstexprconstexprnoexcept

Returns a new Mem with {1to64} broadcast (AVX-512).

void BaseMem::setIndex(const BaseReg& index)noexcept

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