forked from AbleOS/holey-bytes
more docs
This commit is contained in:
parent
a47b556317
commit
6356b7dd24
|
@ -124,8 +124,7 @@ impl<'a, T: HandleTrap> Vm<'a, T> {
|
||||||
|
|
||||||
/// Execute program
|
/// Execute program
|
||||||
///
|
///
|
||||||
/// Program returns [`HaltReason`] which is either [`HaltReason::ProgramEnd`] in case
|
/// Program can return [`VmRunError`] if a trap handling failed
|
||||||
/// of sucessful VM run or other in case of unhandled trap.
|
|
||||||
pub fn run(&mut self) -> Result<(), VmRunError> {
|
pub fn run(&mut self) -> Result<(), VmRunError> {
|
||||||
use hbbytecode::opcode::*;
|
use hbbytecode::opcode::*;
|
||||||
loop {
|
loop {
|
||||||
|
|
|
@ -3,6 +3,7 @@ use super::{
|
||||||
value::Value,
|
value::Value,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/// Handle VM traps
|
||||||
pub trait HandleTrap {
|
pub trait HandleTrap {
|
||||||
/// Handle page fault
|
/// Handle page fault
|
||||||
fn page_fault(&mut self, memory: &mut Memory, addr: u64, size: PageSize, dst: *mut u8) -> bool;
|
fn page_fault(&mut self, memory: &mut Memory, addr: u64, size: PageSize, dst: *mut u8) -> bool;
|
||||||
|
|
|
@ -1,7 +1,13 @@
|
||||||
use core::fmt::Debug;
|
use core::fmt::Debug;
|
||||||
|
|
||||||
|
/// Define [`Value`] union
|
||||||
|
///
|
||||||
|
/// # Safety
|
||||||
|
/// Union variants have to be sound to byte-reinterpretate
|
||||||
|
/// between each other. Otherwise the behaviour is undefined.
|
||||||
macro_rules! value_def {
|
macro_rules! value_def {
|
||||||
($($ty:ident),* $(,)?) => {
|
($($ty:ident),* $(,)?) => {
|
||||||
|
/// HBVM register value
|
||||||
#[derive(Copy, Clone)]
|
#[derive(Copy, Clone)]
|
||||||
#[repr(packed)]
|
#[repr(packed)]
|
||||||
pub union Value {
|
pub union Value {
|
||||||
|
@ -10,6 +16,7 @@ macro_rules! value_def {
|
||||||
|
|
||||||
paste::paste! {
|
paste::paste! {
|
||||||
impl Value {$(
|
impl Value {$(
|
||||||
|
#[doc = "Byte-reinterpret [`Value`] as [`" $ty "`]"]
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn [<as_ $ty>](&self) -> $ty {
|
pub fn [<as_ $ty>](&self) -> $ty {
|
||||||
unsafe { self.$ty }
|
unsafe { self.$ty }
|
||||||
|
@ -29,9 +36,11 @@ macro_rules! value_def {
|
||||||
}
|
}
|
||||||
|
|
||||||
value_def!(u64, i64, f64);
|
value_def!(u64, i64, f64);
|
||||||
|
static_assertions::const_assert_eq!(core::mem::size_of::<Value>(), 8);
|
||||||
|
|
||||||
impl Debug for Value {
|
impl Debug for Value {
|
||||||
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
|
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
|
||||||
self.as_u64().fmt(f)
|
// Print formatted as hexadecimal, unsigned integer
|
||||||
|
write!(f, "{:x}", self.as_u64())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue