asmjit::InstNode Class Reference

Inheritance diagram for asmjit::InstNode:

Instruction node.

Wraps an instruction with its options and operands.

Public Members

Members

BaseInst _baseInst

 Public Attributes inherited from asmjit::BaseNode

union {

  struct {

    BaseNode* _prev

    BaseNode* _next

  }

  BaseNode* _links[2]

};

union {

  AnyData _any

  AlignData _alignData

  InstData _inst

  EmbedData _embed

  SentinelData _sentinel

};

uint32_t _position

union {

  uint64_t _userDataU64

  void* _userDataPtr

};

void* _passData

const char* _inlineComment

Static Public Attributes

Constants

static constexpr uint32_t kBaseOpCapacity = uint32_t((128 - sizeof(BaseNode) - sizeof(BaseInst)) / sizeof(Operand_))

static constexpr uint32_t kFullOpCapacity = Globals::kMaxOpCount

Member Functions

InstNode(const InstNode& other) = delete

InstNode& operator=(const InstNode& other) = delete

Construction & Destruction

InstNode(BaseBuilder* cb, InstId instId, InstOptions options, uint32_t opCount, uint32_t opCapacity = kBaseOpCapacity) noexcept

Instruction Object

BaseInst& baseInst() noexcept

const BaseInst& baseInst() const noexcept

Instruction Id

InstId id() const noexcept

InstId realId() const noexcept

void setId(InstId id) 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

Instruction Operands

uint32_t opCount() const noexcept

uint32_t opCapacity() const noexcept

void setOpCount(uint32_t opCount) noexcept

Operand* operands() noexcept

const Operand* operands() const noexcept

Operand& op(uint32_t index) noexcept

const Operand& op(uint32_t index) const noexcept

void setOp(uint32_t index, const Operand_& op) noexcept

void resetOp(uint32_t index) noexcept

void resetOpRange(uint32_t start, uint32_t end) noexcept

Utilities

bool hasOpType(OperandType opType) const noexcept

bool hasRegOp() const noexcept

bool hasMemOp() const noexcept

bool hasImmOp() const noexcept

bool hasLabelOp() const noexcept

uint32_t indexOfOpType(OperandType opType) const noexcept

uint32_t indexOfMemOp() const noexcept

uint32_t indexOfImmOp() const noexcept

uint32_t indexOfLabelOp() const noexcept

 Public Member Functions inherited from asmjit::BaseNode

BaseNode(const BaseNode& other) = delete

BaseNode& operator=(const BaseNode& other) = delete

BaseNode(BaseBuilder* cb, NodeType nodeType, NodeFlags nodeFlags = NodeFlags::kNone) noexcept

template<typename T>

T* as() noexcept

template<typename T>

const T* as() const noexcept

BaseNode* prev() const noexcept

BaseNode* next() const noexcept

NodeType type() const noexcept

void setType(NodeType type) noexcept

bool isInst() const noexcept

bool isSection() const noexcept

bool isLabel() const noexcept

bool isAlign() const noexcept

bool isEmbedData() const noexcept

bool isEmbedLabel() const noexcept

bool isEmbedLabelDelta() const noexcept

bool isConstPool() const noexcept

bool isComment() const noexcept

bool isSentinel() const noexcept

bool isFunc() const noexcept

bool isFuncRet() const noexcept

bool isInvoke() const noexcept

NodeFlags flags() const noexcept

bool hasFlag(NodeFlags flag) const noexcept

void setFlags(NodeFlags flags) noexcept

void addFlags(NodeFlags flags) noexcept

void clearFlags(NodeFlags flags) noexcept

bool isCode() const noexcept

bool isData() const noexcept

bool isInformative() const noexcept

bool isRemovable() const noexcept

bool hasNoEffect() const noexcept

bool isActive() const noexcept

bool hasPosition() const noexcept

uint32_t position() const noexcept

void setPosition(uint32_t position) noexcept

template<typename T>

T* userDataAsPtr() const noexcept

int64_t userDataAsInt64() const noexcept

uint64_t userDataAsUInt64() const noexcept

template<typename T>

void setUserDataAsPtr(T* data) noexcept

void setUserDataAsInt64(int64_t value) noexcept

void setUserDataAsUInt64(uint64_t value) noexcept

void resetUserData() noexcept

bool hasPassData() const noexcept

template<typename T>

T* passData() const noexcept

template<typename T>

void setPassData(T* data) noexcept

void resetPassData() noexcept

bool hasInlineComment() const noexcept

const char* inlineComment() const noexcept

void setInlineComment(const char* s) noexcept

void resetInlineComment() noexcept

Constructor & Destructor Documentation

InstNode::InstNode(BaseBuilder* cb, InstId instId, InstOptions options, uint32_t opCount, uint32_t opCapacity = kBaseOpCapacity)noexcept

Creates a new InstNode instance.

Member Function Documentation

InstId InstNode::id() constnoexcept

Returns the instruction id, see BaseInst::Id.

InstId InstNode::realId() constnoexcept

Returns the instruction real id, see BaseInst::Id.

void InstNode::setId(InstId id)noexcept

Sets the instruction id to id, see BaseInst::Id.

InstOptions InstNode::options() constnoexcept

Returns instruction options, see InstOptions for more details.

bool InstNode::hasOption(InstOptions option) constnoexcept

Tests whether instruction has the given \option` set/enabled.

void InstNode::setOptions(InstOptions options)noexcept

Sets instruction options to the provided value, resetting all others.

void InstNode::addOptions(InstOptions options)noexcept

Adds instruction options to the instruction.

void InstNode::clearOptions(InstOptions options)noexcept

Clears instruction options of the instruction (disables the given options).

void InstNode::resetOptions()noexcept

Resets instruction options to none - disabling all instruction options.

bool InstNode::hasExtraReg() constnoexcept

Tests whether the node has an extra register operand.

RegOnly& InstNode::extraReg()noexcept[1/2]

Returns extra register operand.

const RegOnly& InstNode::extraReg() constnoexcept[2/2]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void InstNode::setExtraReg(const BaseReg& reg)noexcept[1/2]

Sets extra register operand to reg.

void InstNode::setExtraReg(const RegOnly& reg)noexcept[2/2]

Sets extra register operand to reg.

void InstNode::resetExtraReg()noexcept

Resets extra register operand.

uint32_t InstNode::opCount() constnoexcept

Returns operand count.

uint32_t InstNode::opCapacity() constnoexcept

Returns operand capacity.

void InstNode::setOpCount(uint32_t opCount)noexcept

Sets operand count.

Operand* InstNode::operands()noexcept[1/2]

Returns operands array.

const Operand* InstNode::operands() constnoexcept[2/2]

Returns operands array (const).

Operand& InstNode::op(uint32_t index)noexcept[1/2]

Returns operand at the given index.

const Operand& InstNode::op(uint32_t index) constnoexcept[2/2]

Returns operand at the given index (const).

void InstNode::setOp(uint32_t index, const Operand_& op)noexcept

Sets operand at the given index to op.

void InstNode::resetOp(uint32_t index)noexcept

Resets operand at the given index to none.

void InstNode::resetOpRange(uint32_t start, uint32_t end)noexcept

Resets operands at [start, end) range.

bool InstNode::hasOpType(OperandType opType) constnoexcept

Tests whether the given operand type opType is used by the instruction.

bool InstNode::hasRegOp() constnoexcept

Tests whether the instruction uses at least one register operand.

bool InstNode::hasMemOp() constnoexcept

Tests whether the instruction uses at least one memory operand.

bool InstNode::hasImmOp() constnoexcept

Tests whether the instruction uses at least one immediate operand.

bool InstNode::hasLabelOp() constnoexcept

Tests whether the instruction uses at least one label operand.

uint32_t InstNode::indexOfOpType(OperandType opType) constnoexcept

Returns the index of the given operand type opType.

Note

If the operand type wa found, the value returned represents its index in operands() array, otherwise Globals::kNotFound is returned to signalize that the operand was not found.

uint32_t InstNode::indexOfMemOp() constnoexcept

A shortcut that calls indexOfOpType(OperandType::kMem).

uint32_t InstNode::indexOfImmOp() constnoexcept

A shortcut that calls indexOfOpType(OperandType::kImm).

uint32_t InstNode::indexOfLabelOp() constnoexcept

A shortcut that calls indexOfOpType(OperandType::kLabel).

Member Data Documentation

uint32_t InstNode::kBaseOpCapacity = uint32_t((128 - sizeof(BaseNode) - sizeof(BaseInst)) / sizeof(Operand_))constexprstaticconstexpr

The number of embedded operands for a default InstNode instance that are always allocated as a part of the instruction itself.

Minimum embedded operands is 4, but in 32-bit more pointers are smaller and we can embed 5. The rest (up to 6 operands) is considered extended.

The number of operands InstNode holds is decided when InstNode is created.

uint32_t InstNode::kFullOpCapacity = Globals::kMaxOpCountconstexprstaticconstexpr

Count of maximum number of operands InstNode can hold.

BaseInst InstNode::_baseInst

Base instruction data.