asmjit::BaseAssembler Class Reference

Inheritance diagram for asmjit::BaseAssembler:

Base assembler.

This is a base class that provides interface used by architecture specific assembler implementations. Assembler doesn't hold any data, instead it's attached to CodeHolder, which provides all the data that Assembler needs and which can be altered by it.

Check out architecture specific assemblers for more details and examples:

• x86::Assembler - X86/X64 assembler implementation.
• a64::Assembler - AArch64 assembler implementation.

Public Members

Section* _section = nullptr

uint8_t* _bufferData = nullptr

uint8_t* _bufferEnd = nullptr

uint8_t* _bufferPtr = nullptr

 Public Attributes inherited from asmjit::BaseEmitter

EmitterType _emitterType = EmitterType::kNone

EmitterFlags _emitterFlags = EmitterFlags::kNone

uint8_t _instructionAlignment = 0u

ValidationFlags _validationFlags = ValidationFlags::kNone

DiagnosticOptions _diagnosticOptions = DiagnosticOptions::kNone

uint64_t _archMask = 0

EncodingOptions _encodingOptions = EncodingOptions::kNone

InstOptions _forcedInstOptions = InstOptions::kReserved

uint32_t _privateData = 0

CodeHolder* _code = nullptr

Logger* _logger = nullptr

ErrorHandler* _errorHandler = nullptr

Environment _environment {}

OperandSignature _gpSignature {}

InstOptions _instOptions = InstOptions::kNone

RegOnly _extraReg {}

const char* _inlineComment = nullptr

Funcs _funcs {}

Public Types

typedef BaseEmitter Base

Member Functions

BaseAssembler(const BaseAssembler& other) = delete

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

Construction & Destruction

BaseAssembler() noexcept

~BaseAssembler() noexcept override

Code-Buffer Management

size_t bufferCapacity() const noexcept

size_t remainingSpace() const noexcept

size_t offset() const noexcept

Error setOffset(size_t offset)

uint8_t* bufferData() const noexcept

uint8_t* bufferEnd() const noexcept

uint8_t* bufferPtr() const noexcept

Section Management

Section* currentSection() const noexcept

Error section(Section* section) override

Label Management

Label newLabel() override

Label newNamedLabel(const char* name, size_t nameSize = SIZE_MAX, LabelType type = LabelType::kGlobal, uint32_t parentId = Globals::kInvalidId) override

Error bind(const Label& label) override

Embed

Error embed(const void* data, size_t dataSize) override

Error embedDataArray(TypeId typeId, const void* data, size_t itemCount, size_t repeatCount = 1) override

Error embedConstPool(const Label& label, const ConstPool& pool) override

Error embedLabel(const Label& label, size_t dataSize = 0) override

Error embedLabelDelta(const Label& label, const Label& base, size_t dataSize = 0) override

Comment

Error comment(const char* data, size_t size = SIZE_MAX) override

Events

Error onAttach(CodeHolder* code) noexcept override

Error onDetach(CodeHolder* code) noexcept override

 Public Member Functions inherited from asmjit::BaseEmitter

BaseEmitter(const BaseEmitter& other) = delete

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

BaseEmitter(EmitterType emitterType) noexcept

~BaseEmitter() noexcept

template<typename T>

T* as() noexcept

template<typename T>

const T* as() const noexcept

EmitterType emitterType() const noexcept

EmitterFlags emitterFlags() const noexcept

bool isAssembler() const noexcept

bool isBuilder() const noexcept

bool isCompiler() const noexcept

bool hasEmitterFlag(EmitterFlags flag) const noexcept

bool isFinalized() const noexcept

bool isDestroyed() const noexcept

CodeHolder* code() const noexcept

const Environment& environment() const noexcept

bool is32Bit() const noexcept

bool is64Bit() const noexcept

Arch arch() const noexcept

SubArch subArch() const noexcept

uint32_t registerSize() const noexcept

OperandSignature gpSignature() const noexcept

uint32_t instructionAlignment() const noexcept

bool isInitialized() const noexcept

Error finalize()

bool hasLogger() const noexcept

bool hasOwnLogger() const noexcept

Logger* logger() const noexcept

void setLogger(Logger* logger) noexcept

void resetLogger() noexcept

bool hasErrorHandler() const noexcept

bool hasOwnErrorHandler() const noexcept

ErrorHandler* errorHandler() const noexcept

void setErrorHandler(ErrorHandler* errorHandler) noexcept

void resetErrorHandler() noexcept

Error reportError(Error err, const char* message = nullptr)

EncodingOptions encodingOptions() const noexcept

bool hasEncodingOption(EncodingOptions option) const noexcept

void addEncodingOptions(EncodingOptions options) noexcept

void clearEncodingOptions(EncodingOptions options) noexcept

DiagnosticOptions diagnosticOptions() const noexcept

bool hasDiagnosticOption(DiagnosticOptions option) const noexcept

void addDiagnosticOptions(DiagnosticOptions options) noexcept

void clearDiagnosticOptions(DiagnosticOptions options) noexcept

InstOptions forcedInstOptions() const noexcept

InstOptions instOptions() const noexcept

void setInstOptions(InstOptions options) noexcept

void addInstOptions(InstOptions options) noexcept

void resetInstOptions() noexcept

bool hasExtraReg() const noexcept

const RegOnly& extraReg() const noexcept

void setExtraReg(const BaseReg& reg) noexcept

void setExtraReg(const RegOnly& reg) noexcept

void resetExtraReg() noexcept

const char* inlineComment() const noexcept

void setInlineComment(const char* s) noexcept

void resetInlineComment() noexcept

void resetState() noexcept

Label newAnonymousLabel(const char* name, size_t nameSize = SIZE_MAX)

Label newExternalLabel(const char* name, size_t nameSize = SIZE_MAX)

Label labelByName(const char* name, size_t nameSize = SIZE_MAX, uint32_t parentId = Globals::kInvalidId) noexcept

bool isLabelValid(uint32_t labelId) const noexcept

bool isLabelValid(const Label& label) const noexcept

Error _emitI(InstId instId)

Error _emitI(InstId instId, const Operand_& o0)

Error _emitI(InstId instId, const Operand_& o0, const Operand_& o1)

Error _emitI(InstId instId, const Operand_& o0, const Operand_& o1, const Operand_& o2)

Error _emitI(InstId instId, const Operand_& o0, const Operand_& o1, const Operand_& o2, const Operand_& o3)

Error _emitI(InstId instId, const Operand_& o0, const Operand_& o1, const Operand_& o2, const Operand_& o3, const Operand_& o4)

Error _emitI(InstId instId, const Operand_& o0, const Operand_& o1, const Operand_& o2, const Operand_& o3, const Operand_& o4, const Operand_& o5)

template<typename... Args>

Error emit(InstId instId, Args&&... operands)

Error emitOpArray(InstId instId, const Operand_* operands, size_t opCount)

Error emitInst(const BaseInst& inst, const Operand_* operands, size_t opCount)

Error emitProlog(const FuncFrame& frame)

Error emitEpilog(const FuncFrame& frame)

Error emitArgsAssignment(const FuncFrame& frame, const FuncArgsAssignment& args)

Error align(AlignMode alignMode, uint32_t alignment)

Error embedInt8(int8_t value, size_t repeatCount = 1)

Error embedUInt8(uint8_t value, size_t repeatCount = 1)

Error embedInt16(int16_t value, size_t repeatCount = 1)

Error embedUInt16(uint16_t value, size_t repeatCount = 1)

Error embedInt32(int32_t value, size_t repeatCount = 1)

Error embedUInt32(uint32_t value, size_t repeatCount = 1)

Error embedInt64(int64_t value, size_t repeatCount = 1)

Error embedUInt64(uint64_t value, size_t repeatCount = 1)

Error embedFloat(float value, size_t repeatCount = 1)

Error embedDouble(double value, size_t repeatCount = 1)

Error commentf(const char* fmt, ...)

Error commentv(const char* fmt, va_list ap)

void onSettingsUpdated() noexcept

Constructor & Destructor Documentation

BaseAssembler::BaseAssembler()noexcept

Creates a new BaseAssembler instance.

BaseAssembler::~BaseAssembler()overridenoexcept

Destroys the BaseAssembler instance.

Member Function Documentation

size_t BaseAssembler::bufferCapacity() constnoexcept

Returns the capacity of the current CodeBuffer.

size_t BaseAssembler::remainingSpace() constnoexcept

Returns the number of remaining bytes in the current CodeBuffer.

size_t BaseAssembler::offset() constnoexcept

Returns the current position in the CodeBuffer.

Error BaseAssembler::setOffset(size_t offset)

Sets the current position in the CodeBuffer to offset.

Note

The offset cannot be greater than buffer size even if it's within the buffer's capacity.

uint8_t* BaseAssembler::bufferData() constnoexcept

Returns the start of the CodeBuffer in the current section.

uint8_t* BaseAssembler::bufferEnd() constnoexcept

Returns the end (first invalid byte) in the current section.

uint8_t* BaseAssembler::bufferPtr() constnoexcept

Returns the current pointer in the CodeBuffer in the current section.

Section* BaseAssembler::currentSection() constnoexcept

Returns the current section.

Error BaseAssembler::section(Section* section)override

Switches the given section.

Once switched, everything is added to the given section.

Reimplemented from asmjit::BaseEmitter.

Label BaseAssembler::newLabel()override

Creates a new label.

Reimplemented from asmjit::BaseEmitter.

Label BaseAssembler::newNamedLabel(const char* name, size_t nameSize = SIZE_MAX, LabelType type = LabelType::kGlobal, uint32_t parentId = Globals::kInvalidId)override

Creates a new named label.

Reimplemented from asmjit::BaseEmitter.

Error BaseAssembler::bind(const Label& label)override

Binds the label to the current position of the current section.

Note

Attempt to bind the same label multiple times will return an error.

Reimplemented from asmjit::BaseEmitter.

Error BaseAssembler::embed(const void* data, size_t dataSize)override

Embeds raw data into the CodeBuffer.

Reimplemented from asmjit::BaseEmitter.

Error BaseAssembler::embedDataArray(TypeId typeId, const void* data, size_t itemCount, size_t repeatCount = 1)override

Embeds a typed data array.

This is the most flexible function for embedding data as it allows to:

• Assign a typeId to the data, so the emitter knows the type of items stored in data. Binary data should use TypeId::kUInt8.
• Repeat the given data repeatCount times, so the data can be used as a fill pattern for example, or as a pattern used by SIMD instructions.

Reimplemented from asmjit::BaseEmitter.

Error BaseAssembler::embedConstPool(const Label& label, const ConstPool& pool)override

Embeds a constant pool at the current offset by performing the following:

1. Aligns by using AlignMode::kData to the minimum pool alignment.
2. Binds the ConstPool label so it's bound to an aligned location.
3. Emits ConstPool content.

Reimplemented from asmjit::BaseEmitter.

Error BaseAssembler::embedLabel(const Label& label, size_t dataSize = 0)override

Embeds an absolute label address as data.

The dataSize is an optional argument that can be used to specify the size of the address data. If it's zero (default) the address size is deduced from the target architecture (either 4 or 8 bytes).

Reimplemented from asmjit::BaseEmitter.

Error BaseAssembler::embedLabelDelta(const Label& label, const Label& base, size_t dataSize = 0)override

Embeds a delta (distance) between the label and base calculating it as label - base.

This function was designed to make it easier to embed lookup tables where each index is a relative distance of two labels.

Reimplemented from asmjit::BaseEmitter.

Error BaseAssembler::comment(const char* data, size_t size = SIZE_MAX)override

Emits a comment stored in data with an optional size parameter.

Reimplemented from asmjit::BaseEmitter.

Error BaseAssembler::onAttach(CodeHolder* code)overridenoexcept

Called after the emitter was attached to CodeHolder.

Reimplemented from asmjit::BaseEmitter.

Reimplemented in asmjit::x86::Assembler.

Error BaseAssembler::onDetach(CodeHolder* code)overridenoexcept

Called after the emitter was detached from CodeHolder.

Reimplemented from asmjit::BaseEmitter.

Reimplemented in asmjit::x86::Assembler.

Member Data Documentation

Section* BaseAssembler::_section = nullptr

Current section where the assembling happens.

uint8_t* BaseAssembler::_bufferData = nullptr

Start of the CodeBuffer of the current section.

uint8_t* BaseAssembler::_bufferEnd = nullptr

End (first invalid byte) of the current section.

uint8_t* BaseAssembler::_bufferPtr = nullptr

Pointer in the CodeBuffer of the current section.