misc formatting and comments

Author: NIMogen

Makefile

@@ -882,7 +882,7 @@ ifeq ($(graphic), no)
 endif
 
 ## Set the amount of system memory (RAM) provided to the QEMU guest OS
-QEMU_MEMORY ?= 3G
+QEMU_MEMORY ?= 512M
 QEMU_FLAGS += -m $(QEMU_MEMORY) 
 
 ## Enable multicore CPUs, i.e., SMP (Symmetric Multi-Processor)

applications/test_1gb_huge_pages/Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name = "test_1gb_huge_pages"
 version = "0.1.0"
-authors = ["Noah Mogensen <[email protected]>"]
+authors = ["Noah Mogensen <[email protected]>"]
+description = "Application for testing allocation, mapping, and memory access for 1gb huge pages."
 
 [dependencies]
 
@@ -12,4 +13,4 @@ path = "../../kernel/memory"
 path = "../../kernel/app_io"
 
 # [dependencies.application_main_fn]
-# path = "../../compiler_plugins"
+# path = "../../compiler_plugins"

applications/test_1gb_huge_pages/src/lib.rs

@@ -14,6 +14,7 @@ use memory::{
 
 
 pub fn main(_args: Vec<String>) -> isize {
+    println!("NOTE: Before running, make sure you Theseus has been run with enough memory (make orun QEMU_MEMORY=3G).");
     let kernel_mmi_ref = memory::get_kernel_mmi_ref()
         .ok_or("KERNEL_MMI was not yet initialized!")
         .unwrap();

applications/test_huge_pages/Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name = "test_huge_pages"
 version = "0.1.0"
-authors = ["Noah Mogensen <[email protected]>"]
+authors = ["Noah Mogensen <[email protected]>"]
+description = "Application for testing allocation, mapping, and memory access for 2mb huge pages."
 
 [dependencies]
 
@@ -18,4 +19,4 @@ path = "../../kernel/page_allocator"
 path = "../../kernel/app_io"
 
 # [dependencies.application_main_fn]
-# path = "../../compiler_plugins"
+# path = "../../compiler_plugins"

applications/test_huge_pages/src/lib.rs

@@ -16,11 +16,12 @@ use memory::{
     allocate_frames_at, allocate_pages_at
 };
 
-// For checking valid addresses if necessary
+// For checking valid test addresses, if necessary
 // use frame_allocator::dump_frame_allocator_state;
 // use page_allocator::dump_page_allocator_state;
 
 pub fn main(_args: Vec<String>) -> isize {
+    println!("NOTE: Before running, make sure you Theseus has been run with enough memory (make orun QEMU_MEMORY=3G).");
     let kernel_mmi_ref = memory::get_kernel_mmi_ref()
         .ok_or("KERNEL_MMI was not yet initialized!")
         .unwrap();
@@ -56,7 +57,7 @@ pub fn main(_args: Vec<String>) -> isize {
 
     // frame allocator has not been modified to deal with huge frames yet
     let aligned_4k_frames = allocate_frames_at(
-            PhysicalAddress::new_canonical(0x60000000), //0x1081A000
+            PhysicalAddress::new_canonical(0x60000000),
             512).expect("Could not allocate frames. Make sure you have enough memory for the kernel (compile with make orun QEMU_MEMORY=3G).");
 
     let mut mapped_2mb_page = kernel_mmi_ref.lock().page_table.map_allocated_pages_to(
@@ -89,7 +90,7 @@ pub fn main(_args: Vec<String>) -> isize {
 
     // Dump entries to see if dropping has unmapped everything properly
     drop(mapped_2mb_page);
-    kernel_mmi_ref.lock().page_table.dump_pte(VirtualAddress::new_canonical(0x20000000));      
+    kernel_mmi_ref.lock().page_table.dump_pte(VirtualAddress::new_canonical(0x20000000));
 
     0
 }

kernel/memory_structs/src/lib.rs

@@ -605,10 +605,10 @@ macro_rules! implement_page_frame_range {
                 }
 
                 #[doc = "Returns the offset of the given [`" $address "`] within this `" $TypeName "`, \
-                i.e., `addr - self.start_address()`.\n\n \
-                If the given `addr` is not covered by this range of [`" $chunk "`]s, this returns `None`.\n\n \
-                # Examples\n \
-                If the range covers addresses `0x2000` to `0x4000`, then `offset_of_address(0x3500)` would return `Some(0x1500)`."]
+                    i.e., `addr - self.start_address()`.\n\n \
+                    If the given `addr` is not covered by this range of [`" $chunk "`]s, this returns `None`.\n\n \
+                    # Examples\n \
+                    If the range covers addresses `0x2000` to `0x4000`, then `offset_of_address(0x3500)` would return `Some(0x1500)`."]
                 pub const fn offset_of_address(&self, addr: $address) -> Option<usize> {
                     if self.contains_address(addr) {
                         Some(addr.value() - self.start_address().value())
@@ -618,11 +618,11 @@ macro_rules! implement_page_frame_range {
                 }
 
                 #[doc = "Returns the [`" $address "`] at the given `offset` into this `" $TypeName "`within this `" $TypeName "`, \
-                i.e., `self.start_address() + offset`.\n\n \
-                If the given `offset` is not within this range of [`" $chunk "`]s, this returns `None`.\n\n \
-                # Examples\n \
-                If the range covers addresses `0x2000` through `0x3FFF`, then `address_at_offset(0x1500)` would return `Some(0x3500)`, \
-                and `address_at_offset(0x2000)` would return `None`."]
+                    i.e., `self.start_address() + offset`.\n\n \
+                    If the given `offset` is not within this range of [`" $chunk "`]s, this returns `None`.\n\n \
+                    # Examples\n \
+                    If the range covers addresses `0x2000` through `0x3FFF`, then `address_at_offset(0x1500)` would return `Some(0x3500)`, \
+                    and `address_at_offset(0x2000)` would return `None`."]
                 pub const fn address_at_offset(&self, offset: usize) -> Option<$address> {
                     if offset < self.size_in_bytes() {
                         Some($address::new_canonical(self.start_address().value() + offset))

kernel/page_allocator/src/lib.rs

@@ -543,7 +543,7 @@ impl AllocatedPages {
 		}
 		self.pages = PageRangeSized::Normal4KiB(PageRange::new(*self.start(), *ap.end()));
 		// ensure the now-merged AllocatedPages doesn't run its drop handler and free its pages.
-		core::mem::forget(ap);
+		core::mem::forget(ap); 
 		Ok(())
 	}
 
@@ -599,10 +599,18 @@ impl Drop for AllocatedPages {
 		let pages = match self.page_size() {
 			MemChunkSize::Normal4K => self.pages.range().unwrap().clone(),
 			MemChunkSize::Huge2M => { 
-				self.pages.into_range_4k().unwrap().range().unwrap().clone() // NOTE: this is truly hideous :(
+				self.pages.into_range_4k()
+                    .unwrap()
+                    .range()
+                    .unwrap()
+                    .clone() 
 			},
 			MemChunkSize::Huge1G => { 
-				self.pages.into_range_4k().unwrap().range().unwrap().clone()
+				self.pages.into_range_4k()
+                    .unwrap()
+                    .range()
+                    .unwrap()
+                    .clone()
 			}
 		};