emulator

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/momo5502/sogen/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

• cpu_interface - CPU register and execution control
• memory_interface - Memory read/write operations
• hook_interface - Event hooks for monitoring and control

​

Class Definition

class emulator : public cpu_interface, 
                 public memory_interface, 
                 public hook_interface

​

Constructors and Assignment

emulator() = default;
~emulator() override = default;

emulator(const emulator&) = delete;
emulator& operator=(const emulator&) = delete;

emulator(emulator&&) = delete;
emulator& operator=(emulator&&) = delete;

​

Pure Virtual Methods

​

get_name()

virtual std::string get_name() const = 0

​

serialize_state()

virtual void serialize_state(
    utils::buffer_serializer& buffer,
    bool is_snapshot
) const = 0

​

deserialize_state()

virtual void deserialize_state(
    utils::buffer_deserializer& buffer,
    bool is_snapshot
) = 0

​

Inherited Interfaces

​

From cpu_interface

• start(size_t count) - Start CPU execution
• stop() - Stop CPU execution
• read_raw_register() - Read CPU register values
• write_raw_register() - Write CPU register values
• save_registers() - Save all registers to a buffer
• restore_registers() - Restore registers from a buffer
• read_descriptor_table() - Read descriptor table registers (GDTR, IDTR, etc.)
• has_violation() - Check if a memory violation occurred

​

From memory_interface

• read_memory() - Read memory at an address
• try_read_memory() - Attempt to read memory without throwing
• write_memory() - Write memory at an address
• try_write_memory() - Attempt to write memory without throwing
• move_memory() - Move memory from one location to another

​

From hook_interface

• hook_memory_execution() - Hook memory execution
• hook_memory_read() - Hook memory read operations
• hook_memory_write() - Hook memory write operations
• hook_instruction() - Hook specific instruction types
• hook_interrupt() - Hook interrupts
• hook_memory_violation() - Hook memory access violations
• hook_basic_block() - Hook basic block execution
• delete_hook() - Remove a hook

​

Usage Example

// Emulator is an abstract base class
// Use a concrete implementation like x86_64_emulator

std::unique_ptr<emulator> emu = create_x86_64_emulator();

// Get emulator name
std::string name = emu->get_name();
printf("Using emulator: %s\n", name.c_str());

// Serialize state
utils::buffer_serializer serializer;
emu->serialize_state(serializer, false);

// ... later, restore state
utils::buffer_deserializer deserializer(serializer.data());
emu->deserialize_state(deserializer, false);

// Use inherited interfaces
emu->write_memory(0x1000, my_data, sizeof(my_data));
emu->start(1000); // Execute 1000 instructions

​

Implementation Notes

• Implementations must provide thread-safe state serialization
• The is_snapshot parameter allows optimizations for temporary state saves
• Snapshots may exclude persistent state like module mappings
• Full serialization should capture all state needed to resume execution
• The emulator name should be a unique, stable identifier for the backend

​

Related Types

• memory_interface - Memory operations
• emulator_callbacks - Event callbacks for monitoring