Index ⭢ Instruction DB ⭢ asmjit::BaseInst

asmjit::BaseInst Class Reference [¶]

Instruction id, options, and extraReg in a single structure.

This structure exists mainly to simplify analysis and validation API that requires BaseInst and Operand[] array.

Member Functions

Construction & Destruction

BaseInst(InstId instId = 0, InstOptions options = InstOptions::kNone) noexcept

BaseInst(InstId instId, InstOptions options, const RegOnly& extraReg) noexcept

BaseInst(InstId instId, InstOptions options, const BaseReg& extraReg) noexcept

Instruction id and modifiers

InstId id() const noexcept

void setId(InstId id) noexcept

void resetId() noexcept

InstId realId() const noexcept

template<InstIdParts kPart>

uint32_t getInstIdPart() const noexcept

template<InstIdParts kPart>

void setInstIdPart(uint32_t value) noexcept

Instruction Options

InstOptions options() const noexcept

bool hasOption(InstOptions option) const noexcept

void setOptions(InstOptions options) noexcept

void addOptions(InstOptions options) noexcept

void clearOptions(InstOptions options) noexcept

void resetOptions() noexcept

Extra Register

bool hasExtraReg() const noexcept

RegOnly& extraReg() noexcept

const RegOnly& extraReg() const noexcept

void setExtraReg(const BaseReg& reg) noexcept

void setExtraReg(const RegOnly& reg) noexcept

void resetExtraReg() noexcept

ARM Specific

arm::CondCode armCondCode() const noexcept

void setArmCondCode(arm::CondCode cc) noexcept

a32::DataType armDt() const noexcept

a32::DataType armDt2() const noexcept

Static Functions

Statics

static constexpr InstId composeARMInstId(uint32_t id, arm::CondCode cc) noexcept

static constexpr InstId composeARMInstId(uint32_t id, a32::DataType dt, arm::CondCode cc = arm::CondCode::kAL) noexcept

static constexpr InstId composeARMInstId(uint32_t id, a32::DataType dt, a32::DataType dt2, arm::CondCode cc = arm::CondCode::kAL) noexcept

static constexpr InstId extractRealId(uint32_t id) noexcept

static constexpr arm::CondCode extractARMCondCode(uint32_t id) noexcept

Members

enum Id : uint32_t

InstId _id

InstOptions _options

RegOnly _extraReg

BaseInst::Id : uint32_tenum[¶]

Constant	Description
kIdNone	Invalid or uninitialized instruction id.
kIdAbstract	Abstract instruction (BaseBuilder and BaseCompiler).

BaseInst::BaseInst(
InstId instId = 0,
InstOptions options = InstOptions::kNone
)explicitnoexcept[¶]

Creates a new BaseInst instance with id and options set.

Default values of id and options are zero, which means 'none' instruction. Such instruction is guaranteed to never exist for any architecture supported by AsmJit.

InstId BaseInst::id() constnoexcept[¶]

Returns the instruction id with modifiers.

void BaseInst::setId(
InstId id
)noexcept[¶]

Sets the instruction id and modiiers from id.

void BaseInst::resetId()noexcept[¶]

Resets the instruction id and modifiers to zero, see kIdNone.

InstId BaseInst::realId() constnoexcept[¶]

Returns a real instruction id that doesn't contain any modifiers.

InstOptions BaseInst::options() constnoexcept[¶]

Returns instruction options associated with this instruction.

bool BaseInst::hasOption(
InstOptions option
) constnoexcept[¶]

Tests whether the given instruction option is enabled.

void BaseInst::setOptions(
InstOptions options
)noexcept[¶]

Replaces all instruction options by the given options.

void BaseInst::addOptions(
InstOptions options
)noexcept[¶]

Adds instruction options provided by options.

void BaseInst::clearOptions(
InstOptions options
)noexcept[¶]

Clears instruction options provided by options.

void BaseInst::resetOptions()noexcept[¶]

Resets all instruction options to InstOptions::kNone (there will be no instruction options active after reset).

bool BaseInst::hasExtraReg() constnoexcept[¶]

Tests whether the instruction has associated an extra register.

Note: Extra registers are currently only used on X86 by AVX-512 masking such as {k} and {k}{z} and by repeated instructions to explicitly assign a virtual register that would be ECX/RCX.

InstId BaseInst::_id[¶]

Instruction id with modifiers.

InstOptions BaseInst::_options[¶]

Instruction options.

RegOnly BaseInst::_extraReg[¶]

Extra register used by the instruction (either REP register or AVX-512 selector).