Merge pull request #2229 from hermit-os/vfs-node-sync-send

refactor: clean up docs, `core::fmt` imports and `VfsNode + Send + Sync`

Author: mkroening

src/arch/aarch64/kernel/processor.rs

@@ -21,9 +21,9 @@ use crate::env;
 pub struct FPUState {
 	/// Advanced SIMD 128-bit vector registers.
 	q: [u128; 32],
-	/// fpcr register.
+	/// FPCR register.
 	fpcr: u64,
-	/// fpsr register.
+	/// FPSR register.
 	fpsr: u64,
 }
 

src/arch/aarch64/kernel/scheduler.rs

@@ -21,7 +21,7 @@ use crate::{DEFAULT_STACK_SIZE, KERNEL_STACK_SIZE};
 #[derive(Debug)]
 #[repr(C, packed)]
 pub(crate) struct State {
-	/// stack selector
+	/// Stack selector
 	pub spsel: u64,
 	/// Exception Link Register
 	pub elr_el1: extern "C" fn(extern "C" fn(usize), usize) -> !,
@@ -96,16 +96,16 @@ pub(crate) struct State {
 }
 
 pub struct BootStack {
-	/// stack for kernel tasks
+	/// Stack for kernel tasks
 	stack: VirtAddr,
 }
 
 pub struct CommonStack {
-	/// start address of allocated virtual memory region
+	/// Start address of allocated virtual memory region
 	virt_addr: VirtAddr,
-	/// start address of allocated virtual memory region
+	/// Start address of allocated virtual memory region
 	phys_addr: PhysAddr,
-	/// total size of all stacks
+	/// Total size of all stacks
 	total_size: usize,
 }
 

src/arch/riscv64/kernel/core_local.rs

@@ -19,7 +19,7 @@ pub struct CoreLocal {
 	core_id: CoreId,
 	/// Scheduler of the current Core.
 	scheduler: Cell<*mut PerCoreScheduler>,
-	/// start address of the kernel stack
+	/// Start address of the kernel stack
 	pub kernel_stack: Cell<u64>,
 	/// The core-local async executor.
 	ex: StaticLocalExecutor<RawSpinMutex, RawRwSpinLock>,

src/arch/riscv64/kernel/interrupts.rs

@@ -16,7 +16,7 @@ use crate::drivers::mmio::get_interrupt_handlers;
 use crate::drivers::pci::get_interrupt_handlers;
 use crate::scheduler;
 
-/// base address of the PLIC, only one access at the same time is allowed
+/// Base address of the PLIC, only one access at the same time is allowed
 static PLIC_BASE: SpinMutex<usize> = SpinMutex::new(0x0);
 
 /// PLIC context for new interrupt handlers

src/arch/riscv64/kernel/scheduler.rs

@@ -14,13 +14,13 @@ use crate::{DEFAULT_STACK_SIZE, KERNEL_STACK_SIZE};
 #[repr(C, packed)]
 #[derive(Clone, Copy, Debug)]
 pub struct State {
-	/// return address register
+	/// Return address register
 	ra: unsafe extern "C" fn(extern "C" fn(usize), usize, u64),
-	/// stack pointer register
+	/// Stack pointer register
 	sp: usize,
-	/// global pointer register
+	/// Global pointer register
 	gp: usize,
-	/// thread pointer register
+	/// Thread pointer register
 	tp: usize,
 	/// x5 register
 	x5: usize,
@@ -79,16 +79,16 @@ pub struct State {
 }
 
 pub struct BootStack {
-	/// stack for kernel tasks
+	/// Stack for kernel tasks
 	stack: VirtAddr,
 }
 
 pub struct CommonStack {
-	/// start address of allocated virtual memory region
+	/// Start address of allocated virtual memory region
 	virt_addr: VirtAddr,
-	/// start address of allocated virtual memory region
+	/// Start address of allocated virtual memory region
 	phys_addr: PhysAddr,
-	/// total size of all stacks
+	/// Total size of all stacks
 	total_size: usize,
 }
 

src/arch/x86_64/kernel/apic.rs

@@ -384,7 +384,7 @@ fn detect_from_acpi() -> Result<PhysAddr, ()> {
 	Ok(PhysAddr::new(madt_header.local_apic_address.into()))
 }
 
-/// Helper function to search Floating Pointer Structure of the Multiprocessing Specification
+/// Search Floating Pointer Structure of the Multiprocessing Specification
 fn search_mp_floating(memory_range: AddrRange<PhysAddr>) -> Result<&'static ApicMP, ()> {
 	let layout = PageLayout::from_size(BasePageSize::SIZE as usize).unwrap();
 	let page_range = PageBox::new(layout).unwrap();
@@ -415,7 +415,7 @@ fn search_mp_floating(memory_range: AddrRange<PhysAddr>) -> Result<&'static Apic
 	Err(())
 }
 
-/// Helper function to detect APIC by the Multiprocessor Specification
+/// Detect APIC by the Multiprocessor Specification
 fn detect_from_mp() -> Result<PhysAddr, ()> {
 	let mp_float = if let Ok(mpf) = search_mp_floating(
 		AddrRange::new(PhysAddr::new(0x9f000u64), PhysAddr::new(0xa0000u64)).unwrap(),

src/arch/x86_64/kernel/core_local.rs

@@ -28,7 +28,7 @@ pub(crate) struct CoreLocal {
 	scheduler: Cell<*mut PerCoreScheduler>,
 	/// Task State Segment (TSS) allocated for this CPU Core.
 	pub tss: Cell<*mut TaskStateSegment>,
-	/// start address of the kernel stack
+	/// Start address of the kernel stack
 	pub kernel_stack: Cell<*mut u8>,
 	/// Interface to the interrupt counters
 	irq_statistics: &'static IrqStatistics,

src/arch/x86_64/kernel/processor.rs

@@ -30,7 +30,7 @@ use crate::arch::x86_64::kernel::acpi;
 use crate::arch::x86_64::kernel::{interrupts, pic, pit};
 use crate::env;
 
-/// see <http://biosbits.org>.
+/// See <http://biosbits.org>.
 const MSR_PLATFORM_INFO: u32 = 0xce;
 
 /// See Table 35-2. See Section 14.1, Enhanced Intel  Speedstep® Technology.
@@ -45,7 +45,7 @@ const IA32_MISC_ENABLE_TURBO_DISABLE: u64 = 1 << 38;
 /// Maximum Ratio Limit of Turbo Mode RO if MSR_PLATFORM_INFO.\[28\] = 0, RW if MSR_PLATFORM_INFO.\[28\] = 1
 const MSR_TURBO_RATIO_LIMIT: u32 = 0x1ad;
 
-/// if CPUID.6H:ECX\[3\] = 1
+/// If CPUID.6H:ECX\[3\] = 1
 const IA32_ENERGY_PERF_BIAS: u32 = 0x1b0;
 
 // See Intel SDM - Volume 1 - Section 7.3.17.1

src/arch/x86_64/kernel/scheduler.rs

@@ -56,25 +56,25 @@ struct State {
 	rcx: u64,
 	/// RAX register
 	rax: u64,
-	/// status flags
+	/// Status flags
 	rflags: u64,
-	/// instruction pointer
+	/// Instruction pointer
 	rip: extern "C" fn(extern "C" fn(usize), usize, u64) -> !,
 }
 
 pub struct BootStack {
-	/// stack for kernel tasks
+	/// Stack for kernel tasks
 	stack: VirtAddr,
-	/// stack to handle interrupts
+	/// Stack to handle interrupts
 	ist1: VirtAddr,
 }
 
 pub struct CommonStack {
-	/// start address of allocated virtual memory region
+	/// Start address of allocated virtual memory region
 	virt_addr: VirtAddr,
-	/// start address of allocated virtual memory region
+	/// Start address of allocated virtual memory region
 	phys_addr: PhysAddr,
-	/// total size of all stacks
+	/// Total size of all stacks
 	total_size: usize,
 }
 

src/arch/x86_64/mm/paging.rs

@@ -1,5 +1,4 @@
-use core::fmt::Debug;
-use core::ptr;
+use core::{fmt, ptr};
 
 use free_list::PageLayout;
 use x86_64::registers::control::{Cr0, Cr0Flags, Cr2, Cr3};
@@ -146,7 +145,7 @@ pub fn map<S>(
 	count: usize,
 	flags: PageTableEntryFlags,
 ) where
-	S: PageSize + Debug,
+	S: PageSize + fmt::Debug,
 	for<'a> OffsetPageTable<'a>: Mapper<S>,
 {
 	let pages = {
@@ -173,7 +172,7 @@ pub fn map<S>(
 	) -> bool
 	where
 		M: Mapper<S>,
-		S: PageSize + Debug,
+		S: PageSize + fmt::Debug,
 	{
 		let mut unmapped = false;
 		for (page, frame) in pages.zip(frames) {
@@ -205,7 +204,7 @@ pub fn map<S>(
 /// the number of successful mapped pages are returned as error value.
 pub fn map_heap<S>(virt_addr: VirtAddr, count: usize) -> Result<(), usize>
 where
-	S: PageSize + Debug,
+	S: PageSize + fmt::Debug,
 	for<'a> OffsetPageTable<'a>: Mapper<S>,
 {
 	let flags = {
@@ -228,7 +227,7 @@ where
 
 pub fn identity_map<S>(phys_addr: PhysAddr)
 where
-	S: PageSize + Debug,
+	S: PageSize + fmt::Debug,
 	for<'a> OffsetPageTable<'a>: Mapper<S>,
 {
 	let frame = PhysFrame::<S>::from_start_address(phys_addr.into()).unwrap();
@@ -253,7 +252,7 @@ where
 
 pub fn unmap<S>(virtual_address: VirtAddr, count: usize)
 where
-	S: PageSize + Debug,
+	S: PageSize + fmt::Debug,
 	for<'a> OffsetPageTable<'a>: Mapper<S>,
 {
 	trace!("Unmapping virtual address {virtual_address:p} ({count} pages)");