Index ⭢ Instruction DB ⭢ asmjit::BaseInst

asmjit::BaseInst Class Reference [¶]

Instruction id, options, and extra_reg 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 inst_id = 0, InstOptions options = InstOptions::kNone) noexcept

BaseInst(InstId inst_id, InstOptions options, const RegOnly& extra_reg) noexcept

BaseInst(InstId inst_id, InstOptions options, const Reg& extra_reg) noexcept

Instruction id and modifiers

InstId inst_id() const noexcept

void set_inst_id(InstId inst_id) noexcept

void reset_inst_id() noexcept

InstId real_id() const noexcept

template<InstIdParts kPart>

uint32_t inst_id_part() const noexcept

template<InstIdParts kPart>

void set_inst_id_part(uint32_t value) noexcept

Instruction Options

InstOptions options() const noexcept

bool has_option(InstOptions option) const noexcept

void set_options(InstOptions options) noexcept

void add_options(InstOptions options) noexcept

void clear_options(InstOptions options) noexcept

void reset_options() noexcept

Extra Register

bool has_extra_reg() const noexcept

RegOnly& extra_reg() noexcept

const RegOnly& extra_reg() const noexcept

void set_extra_reg(const Reg& reg) noexcept

void set_extra_reg(const RegOnly& reg) noexcept

void reset_extra_reg() noexcept

ARM Specific

arm::CondCode arm_cond_code() const noexcept

void set_arm_cond_code(arm::CondCode cc) noexcept

a32::DataType arm_dt() const noexcept

a32::DataType arm_dt2() const noexcept

Static Functions

Statics

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

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

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

static constexpr InstId extract_real_id(uint32_t id) noexcept

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

Members

enum Id : uint32_t

InstId _inst_id

InstOptions _options

RegOnly _extra_reg

BaseInst::Id : uint32_tenum[¶]

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

BaseInst::BaseInst(
InstId inst_id = 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::inst_id() constnodiscardnoexcept[¶]

Returns the instruction id with modifiers.

void BaseInst::set_inst_id(
InstId inst_id
)noexcept[¶]

Sets the instruction id and modifiers from inst_id.

void BaseInst::reset_inst_id()noexcept[¶]

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

InstId BaseInst::real_id() constnodiscardnoexcept[¶]

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

InstOptions BaseInst::options() constnodiscardnoexcept[¶]

Returns instruction options associated with this instruction.

bool BaseInst::has_option(
InstOptions option
) constnodiscardnoexcept[¶]

Tests whether the given instruction option is enabled.

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

Replaces all instruction options by the given options.

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

Adds instruction options provided by options.

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

Clears instruction options provided by options.

void BaseInst::reset_options()noexcept[¶]

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

bool BaseInst::has_extra_reg() constnodiscardnoexcept[¶]

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::_inst_id[¶]

Instruction id with modifiers.

InstOptions BaseInst::_options[¶]

Instruction options.

RegOnly BaseInst::_extra_reg[¶]

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