zx_vcpu_read_state

NAME

vcpu_read_state - read the state of a VCPU

SYNOPSIS

#include <zircon/syscalls.h>
#include <zircon/syscalls/hypervisor.h>

zx_status_t zx_vcpu_read_state(zx_handle_t vcpu, uint32_t kind, void* buffer,
                               size_t len);

DESCRIPTION

vcpu_read_state() reads the state of vcpu as specified by kind into buffer. It is only valid to read the state of vcpu when execution has been paused.

kind must be ZX_VCPU_STATE.

RETURN VALUE

vcpu_read_state() returns ZX_OK on success. On failure, an error value is returned.

ERRORS

ZX_ERR_ACCESS_DENIED vcpu does not have the ZX_RIGHT_READ right.

ZX_ERR_BAD_HANDLE vcpu is an invalid handle.

ZX_ERR_BAD_STATE vcpu is in a bad state, and state can not be read.

ZX_ERR_INVALID_ARGS kind does not name a known VCPU state, buffer is an invalid pointer, or len does not match the expected size of kind.

ZX_ERR_WRONG_TYPE vcpu is not a handle to a VCPU.

SEE ALSO

guest_create, guest_set_trap, vcpu_create, vcpu_resume, vcpu_interrupt, vcpu_write_state.