forked from AbleOS/holey-bytes
docs
This commit is contained in:
parent
a7cf5e4847
commit
bb50c09538
0
hbvm/README.md
Normal file
0
hbvm/README.md
Normal file
|
@ -1,4 +1,6 @@
|
||||||
|
#![doc = include_str!("../README.md")]
|
||||||
#![no_std]
|
#![no_std]
|
||||||
|
|
||||||
extern crate alloc;
|
extern crate alloc;
|
||||||
|
|
||||||
pub mod validate;
|
pub mod validate;
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
//! Validate if program is sound to execute
|
||||||
|
|
||||||
/// Program validation error kind
|
/// Program validation error kind
|
||||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||||
pub enum ErrorKind {
|
pub enum ErrorKind {
|
||||||
|
|
|
@ -1,10 +1,11 @@
|
||||||
mod paging;
|
//! Program memory implementation
|
||||||
|
|
||||||
use core::mem::MaybeUninit;
|
pub mod paging;
|
||||||
|
|
||||||
use self::paging::{PageTable, Permission, PtEntry};
|
use self::paging::{PageTable, Permission, PtEntry};
|
||||||
use super::{trap::HandleTrap, VmRunError};
|
use super::{trap::HandleTrap, VmRunError};
|
||||||
use alloc::boxed::Box;
|
use alloc::boxed::Box;
|
||||||
|
use core::mem::MaybeUninit;
|
||||||
use derive_more::Display;
|
use derive_more::Display;
|
||||||
|
|
||||||
/// HoleyBytes virtual memory
|
/// HoleyBytes virtual memory
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
//! Page table and associated structures implementation
|
||||||
|
|
||||||
use core::{
|
use core::{
|
||||||
fmt::Debug,
|
fmt::Debug,
|
||||||
mem::MaybeUninit,
|
mem::MaybeUninit,
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
//! Program trap handling interfaces
|
||||||
|
|
||||||
use super::{
|
use super::{
|
||||||
mem::{Memory, MemoryAccessReason, PageSize},
|
mem::{Memory, MemoryAccessReason, PageSize},
|
||||||
value::Value,
|
value::Value,
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
//! HoleyBytes register value definition
|
||||||
|
|
||||||
use core::fmt::Debug;
|
use core::fmt::Debug;
|
||||||
|
|
||||||
/// Define [`Value`] union
|
/// Define [`Value`] union
|
||||||
|
|
Loading…
Reference in a new issue