diff --git a/src/kernel/system.rs b/src/kernel/system.rs index 8e06e1f..c7748e7 100644 --- a/src/kernel/system.rs +++ b/src/kernel/system.rs @@ -1,3 +1,7 @@ +//! # System module +//! +//! Module containing structs and methods pertaining to the state of the operating system + use std::{cell::RefCell, rc::Rc}; use crate::simulator::machine::Machine; diff --git a/src/kernel/thread.rs b/src/kernel/thread.rs index 26703f6..370c1e2 100644 --- a/src/kernel/thread.rs +++ b/src/kernel/thread.rs @@ -3,6 +3,15 @@ use crate::{simulator::machine::{NUM_INT_REGS, NUM_FP_REGS, STACK_REG}}; const STACK_FENCEPOST: u32 = 0xdeadbeef; +/// Polymorphic macro to get thread without passing a name by default +#[macro_export] +macro_rules! get_new_thread { + () => { Thread::new(DEFAULT_THREAD_NAME) }; + ($a:literal) => { + Thread::new(&$a.to_string()) + }; +} + #[derive(PartialEq, Debug)] pub struct ThreadContext { pub int_registers: [i64; NUM_INT_REGS], @@ -102,14 +111,6 @@ mod test { use super::{Thread, ThreadContext, NUM_INT_REGS, NUM_FP_REGS, ObjectType}; const DEFAULT_THREAD_NAME: &str = "test_thread"; - /// Polymorphic macro to get thread without passing a name by default - macro_rules! get_new_thread { - () => { Thread::new(DEFAULT_THREAD_NAME) }; - ($a:literal) => { - Thread::new(&$a.to_string()) - }; - } - /// This macro allows for getting a Thread for which we've ensured proper initial state /// in case a commit further down the line changes the initial state of threads generated /// from Thread::new diff --git a/src/utility/list.rs b/src/utility/list.rs index b3cc66f..bfb3207 100644 --- a/src/utility/list.rs +++ b/src/utility/list.rs @@ -1,7 +1,5 @@ +//! Data structure and definition of a genericsingle-linked LIFO list. -/// Data structure and definition of a genericsingle-linked LIFO list. -/// -/// This is a #[derive(PartialEq)] pub struct List { head: Link,