AsmJit
Low-Latency Machine Code Generation
asmjit::Operand_ Struct Reference [¶]
Inheritance diagram for asmjit::Operand_:
Base class representing an operand in AsmJit (non-default constructed version).
Contains no initialization code and can be used safely to define an array of operands that won't be initialized. This is a Operand base structure designed to be statically initialized, static const, or to be used by user code to define an array of operands without having them default initialized at construction time.
Member Functions
Construction & Destruction
Overloaded Operators
Cast
template<typename T>
template<typename T>
Equality
Generic Accessors
Register Accessors
Register-List Accessors
X86-Specific Accessors
Static Functions
bool Operand_::isVirtId(uint32_t id)constexprstaticnoexcept[¶]
Tests whether the given id is a valid virtual register id.
Since AsmJit supports both physical and virtual registers it must be able to distinguish between these two. The idea is that physical registers are always limited in size, so virtual identifiers start from kVirtIdMin and end at kVirtIdMax.
uint32_t Operand_::indexToVirtId(uint32_t id)constexprstaticnoexcept[¶]
Converts a real-id into a packed-id that can be stored in Operand.
uint32_t Operand_::virtIdToIndex(uint32_t id)constexprstaticnoexcept[¶]
Converts a packed-id back to real-id.
void Operand_::copyFrom(const Operand_& other)constexprnoexcept[¶]
Initializes the operand from other operand (used by operator overloads).
void Operand_::reset()constexprnoexcept[¶]
Resets the Operand to none.
None operand is defined the following way:
- Its signature is zero (OperandType::kNone, and the rest zero as well).
- Its id is
0. - The reserved8_4 field is set to
0. - The reserved12_4 field is set to zero.
In other words, reset operands have all members set to zero. Reset operand must match the Operand state right after its construction. Alternatively, if you have an array of operands, you can simply use memset().
bool Operand_::operator==(const Operand_& other) constconstexprnoexcept[¶]
Tests whether this operand is the same as other.
bool Operand_::operator!=(const Operand_& other) constconstexprnoexcept[¶]
Tests whether this operand is not the same as other.
template<typename T>T& Operand_::as()constexprnoexcept[1/2][¶]
Casts this operand to T type.
template<typename T>const T& Operand_::as() constconstexprnoexcept[2/2][¶]
Casts this operand to T type (const).
bool Operand_::equals(const Operand_& other) constconstexprnoexcept[¶]
Tests whether the operand is 100% equal to other operand.
- Note
- This basically performs a binary comparison, if aby bit is different the operands are not equal.
Signature Operand_::signature() constconstexprnoexcept[¶]
Returns operand signature as unsigned 32-bit integer.
Signature is first 4 bytes of the operand data. It's used mostly for operand checking as it's much faster to check packed 4 bytes at once than having to check these bytes individually.
bool Operand_::hasSignature(const Operand_& other) constconstexprnoexcept[1/2][¶]
Tests whether the operand's signature matches the signature of the other operand.
bool Operand_::hasSignature(Signature sign) constconstexprnoexcept[2/2][¶]
Tests whether the operand's signature matches the given signature sign.
void Operand_::setSignature(const Signature& signature)constexprnoexcept[1/2][¶]
Sets the operand signature, see signature().
- Note
- Improper use of
setSignature()can lead to hard-to-debug errors.
void Operand_::setSignature(uint32_t signature)constexprnoexcept[2/2][¶]
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
OperandType Operand_::opType() constconstexprnoexcept[¶]
Returns the type of the operand, see OpType.
bool Operand_::isOpType(OperandType opType) constconstexprnoexcept[¶]
Tests whether the operand's type matches the given type.
bool Operand_::isNone() constconstexprnoexcept[¶]
Tests whether the operand is none (OperandType::kNone).
bool Operand_::isReg() constconstexprnoexcept[1/5][¶]
Tests whether the operand is a register (OperandType::kReg).
bool Operand_::isRegList() constconstexprnoexcept[1/2][¶]
Tests whether the operand is a register-list.
- Note
- Register-list is currently only used by 32-bit ARM architecture.
bool Operand_::isMem() constconstexprnoexcept[¶]
Tests whether the operand is a memory location (OperandType::kMem).
bool Operand_::isImm() constconstexprnoexcept[¶]
Tests whether the operand is an immediate (OperandType::kImm).
bool Operand_::isLabel() constconstexprnoexcept[¶]
Tests whether the operand is a label (OperandType::kLabel).
bool Operand_::isRegOrMem() constconstexprnoexcept[¶]
Tests whether the operand is a register or memory.
- Note
- This is useful on X86 and X86_64 architectures as many instructions support Reg/Mem operand combination. So if the user code works with just Operand, it's possible to check whether the operand is either a register or memory location with a single check.
bool Operand_::isRegOrRegListOrMem() constconstexprnoexcept[¶]
Tests whether the operand is a register, register-list, or memory.
- Note
- This is useful on 32-bit ARM architecture to check whether an operand references a register. It can be used in other architectures too, but it would work identically to isRegOrMem() as other architectures don't provide register lists.
uint32_t Operand_::id() constconstexprnoexcept[¶]
Returns the operand id.
The value returned should be interpreted accordingly to the operand type:
- None - Should be
0. - Reg - Physical or virtual register id.
- Mem - Multiple meanings - BASE address (register or label id), or high value of a 64-bit absolute address.
- Imm - Should be
0. - Label - Label id if it was created by using
newLabel()orGlobals::kInvalidIdif the label is invalid or not initialized.
bool Operand_::isPhysReg() constconstexprnoexcept[¶]
Tests whether the operand is a physical register.
bool Operand_::isVirtReg() constconstexprnoexcept[¶]
Tests whether the operand is a virtual register.
bool Operand_::isReg(RegType regType) constconstexprnoexcept[2/5][¶]
Tests whether the operand is a register matching the given register type.
bool Operand_::isReg(RegType regType, uint32_t regId) constconstexprnoexcept[3/5][¶]
Tests whether the operand is register and of register type regType and regId.
bool Operand_::isReg(RegGroup regGroup) constconstexprnoexcept[4/5][¶]
Tests whether the operand is a register of the provided register group regGroup.
bool Operand_::isReg(RegGroup regGroup, uint32_t regId) constconstexprnoexcept[5/5][¶]
Tests whether the operand is register and of register group regGroup and regId.
bool Operand_::isPc() constconstexprnoexcept[¶]
Tests whether the operand is a general purpose register of any type.
bool Operand_::isGp() constconstexprnoexcept[1/2][¶]
Tests whether the operand is a general purpose register of any type.
bool Operand_::isGp(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the operand is a general purpose register of any type having the given id regId.
bool Operand_::isGp8() constconstexprnoexcept[1/2][¶]
Tests whether the register is an 8-bit low or high general purpose register (X86|X86_64).
bool Operand_::isGp8(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is an 8-bit low or high general purpose register having the given id regId (X86|X86_64).
bool Operand_::isGp8Lo() constconstexprnoexcept[1/2][¶]
Tests whether the register is an 8-bit low general purpose register (X86|X86_64).
bool Operand_::isGp8Lo(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is an 8-bit low general purpose register having the given id regId (X86|X86_64).
bool Operand_::isGp8Hi() constconstexprnoexcept[1/2][¶]
Tests whether the register is an 8-bit high general purpose register (X86|X86_64 only - AH, BH, CH, DH).
bool Operand_::isGp8Hi(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is an 8-bit high general purpose register having the given id regId (X86|X86_64).
bool Operand_::isGp16() constconstexprnoexcept[1/2][¶]
Tests whether the register is a 16-bit general purpose register (X86|X86_64).
bool Operand_::isGp16(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a 16-bit general purpose register having the given id regId (X86|X86_64).
bool Operand_::isGp32() constconstexprnoexcept[1/2][¶]
Tests whether the register is a 32-bit general purpose register.
bool Operand_::isGp32(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a 32-bit general purpose register having the given id regId.
bool Operand_::isGp64() constconstexprnoexcept[1/2][¶]
Tests whether the register is a 64-bit general purpose register.
bool Operand_::isGp64(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a 64-bit general purpose register having the given id regId.
bool Operand_::isVec() constconstexprnoexcept[1/2][¶]
Tests whether the register is a vector register of any size.
bool Operand_::isVec(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a vector register of any size having the given id regId.
bool Operand_::isVec8() constconstexprnoexcept[1/2][¶]
Tests whether the register is an 8-bit vector register or view (AArch64).
bool Operand_::isVec8(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is an 8-bit vector register or view having the given id regId (AArch64).
bool Operand_::isVec16() constconstexprnoexcept[1/2][¶]
Tests whether the register is a 16-bit vector register or view (AArch64).
bool Operand_::isVec16(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a 16-bit vector register or view having the given id regId (AArch64).
bool Operand_::isVec32() constconstexprnoexcept[1/2][¶]
Tests whether the register is a 32-bit vector register or view (AArch32, AArch64).
bool Operand_::isVec32(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a 32-bit vector register or view having the given id regId (AArch32/AArch64).
bool Operand_::isVec64() constconstexprnoexcept[1/2][¶]
Tests whether the register is a 64-bit vector register or view (AArch32/AArch64).
bool Operand_::isVec64(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a 64-bit vector register or view having the given id regId (AArch32/AArch64).
bool Operand_::isVec128() constconstexprnoexcept[1/2][¶]
Tests whether the register is a 128-bit vector register or view (X86|X86_64/AArch32/AArch64).
bool Operand_::isVec128(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a 128-bit vector register or view having the given id regId (X86|X86_64/AArch32/AArch64).
bool Operand_::isVec256() constconstexprnoexcept[1/2][¶]
Tests whether the register is a 256-bit vector register or view (X86|X86_64).
bool Operand_::isVec256(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a 256-bit vector register or view having the given id regId (X86|X86_64).
bool Operand_::isVec512() constconstexprnoexcept[1/2][¶]
Tests whether the register is a 512-bit vector register or view (X86|X86_64).
bool Operand_::isVec512(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a 512-bit vector register or view having the given id regId (X86|X86_64).
bool Operand_::isMaskReg() constconstexprnoexcept[1/2][¶]
Tests whether the register is a mask register of any size.
bool Operand_::isMaskReg(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a mask register of any size having the given id regId (X86|X86_64/AArch64).
bool Operand_::isKReg() constconstexprnoexcept[1/2][¶]
Tests whether the register is a mask register (K register on X86|X86_64) - alias of isMaskReg().
bool Operand_::isKReg(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a mask register (K register on X86|X86_64) of any size having the given id regId (X86|X86_64/AArch64).
bool Operand_::isTileReg() constconstexprnoexcept[1/2][¶]
Tests whether the register is a tile register.
bool Operand_::isTileReg(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a tile register of the given id regId.
bool Operand_::isTmmReg() constconstexprnoexcept[1/2][¶]
Tests whether the register is a tile register (TMM register on X86_64) - alias of isTileReg().
bool Operand_::isTmmReg(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a tile register (TMM register on X86_64) of the given id regId - alias of isTileReg().
bool Operand_::isSegmentReg() constconstexprnoexcept[1/2][¶]
Tests whether the register is a segment register (X86|X86_64).
bool Operand_::isSegmentReg(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a segment register having the given id regId (X86|X86_64).
bool Operand_::isControlReg() constconstexprnoexcept[1/2][¶]
Tests whether the register is a control register (X86|X86_64).
bool Operand_::isControlReg(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a control register having the given id regId (X86|X86_64).
bool Operand_::isDebugReg() constconstexprnoexcept[1/2][¶]
Tests whether the register is a debug register (X86|X86_64).
bool Operand_::isDebugReg(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a debug register of the given id regId (X86|X86_64).
bool Operand_::isMmReg() constconstexprnoexcept[1/2][¶]
Tests whether the register is an MMX register (X86|X64).
bool Operand_::isMmReg(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is an MMX register of the given id regId (X86|X64).
bool Operand_::isStReg() constconstexprnoexcept[1/2][¶]
Tests whether the register is an FPU register (ST register on X86|X86_64) (X86|X64).
bool Operand_::isStReg(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is an FPU register (ST register on X86|X86_64) of the given id regId (X86|X64).
bool Operand_::isBndReg() constconstexprnoexcept[1/2][¶]
Tests whether the register is a BND register (X86|X64).
bool Operand_::isBndReg(uint32_t regId) constconstexprnoexcept[2/2][¶]
Tests whether the register is a BND register of the given id regId (X86|X64).
bool Operand_::isRegList(RegType type) constconstexprnoexcept[2/2][¶]
Tests whether the operand is a register matching the given register type.
uint32_t Operand_::x86RmSize() constconstexprnoexcept[¶]
Returns a size of a register or an X86 memory operand.
- Remarks
- At the moment only X86 and X86_64 memory operands have a size - other memory operands can use bits that represent size as an additional payload. This means that memory size is architecture specific and should be accessed via x86::Mem::size(). Sometimes when the user knows that the operand is either a register or memory operand this function can be helpful as it avoids casting, but it only works when it targets X86 and X86_64.
uint32_t Operand_::kDataMemIndexId = 0constexprstatic[¶]
Memory index offset in a _data[2] array.
uint32_t Operand_::kDataMemOffsetLo = 1constexprstatic[¶]
Low 32-bit offset value a _data[2] array.
uint32_t Operand_::kDataImmValueLo = ASMJIT_ARCH_LE ? 0 : 1constexprstatic[¶]
Low 32-bit immediate value in a _data[2] array.
uint32_t Operand_::kDataImmValueHi = ASMJIT_ARCH_LE ? 1 : 0constexprstatic[¶]
High 32-bit immediate value in a _data[2] array.
uint32_t Operand_::kVirtIdMin = 256constexprstatic[¶]
Minimum valid packed-id.
uint32_t Operand_::kVirtIdMax = Globals::kInvalidId - 1constexprstatic[¶]
Maximum valid packed-id, excludes Globals::kInvalidId.
uint32_t Operand_::kVirtIdCount = uint32_t(
Count of valid packed-ids.
uint32_t Operand_::_baseId[¶]
Either base id as used by memory operand or any id as used by others.
uint32_t Operand_::_data[2][¶]
Data specific to the operand type.
The reason we don't use union is that we have constexpr constructors that construct operands and other constexpr functions that return whether another Operand or something else. These cannot generally work with unions so we also cannot use union if we want to be standard compliant.