Struct NyxVM 

pub struct NyxVM {
    pub vmm: Arc<Mutex<Vmm>>,
    pub vcpu: Vcpu,
    pub event_thread_handle: JoinHandle<Result<(), Error>>,
    pub vm_resources: VmResources,
    pub block_devices: Vec<Arc<Mutex<Block>>>,
    pub timeout_timer: Arc<Mutex<TimerEvent>>,
    pub continuation_state: VMContinuationState,
    pub breakpoint_manager: Box<dyn BreakpointManagerTrait>,
    pub hw_breakpoints: HwBreakpoints,
    pub active_snapshot: Option<Arc<NyxSnapshot>>,
    pub serial_pty: Option<SerialPty>,
    /* private fields */
}

Fields

vmm: Arc<Mutex<Vmm>>

vcpu: Vcpu

event_thread_handle: JoinHandle<Result<(), Error>>

vm_resources: VmResources

block_devices: Vec<Arc<Mutex<Block>>>

timeout_timer: Arc<Mutex<TimerEvent>>

continuation_state: VMContinuationState

breakpoint_manager: Box<dyn BreakpointManagerTrait>

hw_breakpoints: HwBreakpoints

active_snapshot: Option<Arc<NyxSnapshot>>

serial_pty: Option<SerialPty>

Implementations

impl NyxVM

pub fn new(instance_id: String, config_json: &str) -> NyxVM

pub fn process_memory(&self, cr3: u64) -> ProcessMemory<LockedVmm>

pub fn current_process_memory(&self) -> ProcessMemory<LockedVmm>

pub fn register_shared_region( &mut self, cr3: u64, vaddr: u64, len: usize, policy: SharedMemoryPolicy, ) -> Result<SharedMemoryRegion<LockedVmm>, MemoryError>

Registers a guest memory range as shared and optionally excludes it from snapshot resets.

pub fn register_shared_region_current( &mut self, vaddr: u64, len: usize, policy: SharedMemoryPolicy, ) -> Result<SharedMemoryRegion<LockedVmm>, MemoryError>

pub fn inject_mapping( &self, cr3: u64, vaddr: u64, paddr: u64, mapping: PageMapping, allocator: Option<&mut dyn PageAllocator>, ) -> Result<(), MemoryError>

pub fn inject_code( &self, cr3: u64, vaddr: u64, paddr: u64, code: &[u8], mapping: PageMapping, allocator: Option<&mut dyn PageAllocator>, ) -> Result<(), MemoryError>

pub fn take_snapshot(&mut self) -> Arc<NyxSnapshot>

pub fn take_base_snapshot(&mut self) -> Arc<NyxSnapshot>

pub fn take_snapshot_with_type( &mut self, snap_type: SnapshotType, ) -> Arc<NyxSnapshot>

pub fn apply_snapshot(&mut self, snapshot: &Arc<NyxSnapshot>)

Applies a snapshot. If there is no active snapshot, only a root snapshot is accepted.

pub fn sregs(&self) -> kvm_sregs

pub fn regs(&self) -> kvm_regs

pub fn set_regs(&mut self, regs: &kvm_regs)

pub fn configure_bts( &mut self, ds_area_paddr: u64, config: BtsConfig, ) -> Result<(), MemoryError>

Configures BTS tracing and DS area pointer for the current vCPU.

pub fn set_debug_state(&mut self, run_mode: RunMode, vmexit_on_swbp: bool)

pub fn is_nyx_hypercall(&self) -> bool

pub fn parse_hypercall(&self) -> ExitReason

pub fn parse_bad_memory_access(&self) -> ExitReason

pub fn run_inner(&mut self, timeout: Duration) -> UnparsedExitReason

pub fn parse_exit_reason(&self, unparsed: VMExitUserEvent) -> ExitReason

pub fn continue_vm( &mut self, run_mode: RunMode, timeout: Duration, ) -> ExitReason

pub fn run(&mut self, timeout: Duration) -> ExitReason

pub fn single_step(&mut self, timeout: Duration) -> ExitReason

pub fn add_breakpoint(&mut self, cr3: u64, vaddr: u64)

pub fn remove_all_breakpoints(&mut self)

pub fn read_cstr_current(&self, guest_vaddr: u64) -> Vec<u8>

pub fn read_current_u64(&self, vaddr: u64) -> u64

pub fn write_current_u64(&self, vaddr: u64, val: u64)

pub fn write_current_bytes(&self, vaddr: u64, buffer: &[u8]) -> usize

pub fn read_current_bytes(&self, vaddr: u64, num_bytes: usize) -> Vec<u8>

pub fn branch_step(&mut self, timeout: Duration) -> ExitReason

pub fn set_lbr(&mut self)

pub fn get_lbr(&mut self)