Merge pull request #8 from ViktorPopp/logging

Improved logging system

Author: ViktorPopp

.gitignore

@@ -1,4 +1,6 @@
 /ovmf
 *.iso
 *.hdd
-*.log
+*.log
+
+docs/

.gitmodules

@@ -2,6 +2,3 @@
 	path = limine
 	url = https://github.com/limine-bootloader/limine.git
 	branch = v9.x-binary
-[submodule "docs"]
-	path = docs
-	url = https://github.com/HexiumOS/Documentation.git

GNUmakefile

@@ -81,6 +81,12 @@ ovmf/ovmf-vars-$(KARCH).fd:
 	mkdir -p ovmf
 	curl -Lo $@ https://github.com/osdev0/edk2-ovmf-nightly/releases/latest/download/ovmf-vars-$(KARCH).fd
 
+#
+# Download the docs
+#
+docs:
+	git clone https://github.com/HexiumOS/Documentation.git
+
 #
 # Build the bootloader (Limine)
 #

docs

@@ -99,14 +99,14 @@ pub static GDT: Mutex<GlobalDescriptorTable> = Mutex::new(GlobalDescriptorTable
     ],
 });
 
-pub fn init() {
+pub fn init() -> (u64, u8) {
     let gdt = GDT.lock();
-    load(&*gdt, 0x08, 0x10);
-    crate::trace!("Initialized GDT");
+    load(&*gdt, 0x08, 0x10)
 }
 
-// Loads the GDT and update the code and data segments
-pub fn load(gdt: &GlobalDescriptorTable, cs: u16, ds: u16) {
+/// Loads the GDT and update the code and data segments
+/// Returns a tuple containing loaded address and amount of entries
+pub fn load(gdt: &GlobalDescriptorTable, cs: u16, ds: u16) -> (u64, u8) {
     let gdt_ptr: DescriptorTablePointer = DescriptorTablePointer {
         limit: gdt.limit,
         base: gdt.entries.as_ptr() as u64,
@@ -119,7 +119,6 @@ pub fn load(gdt: &GlobalDescriptorTable, cs: u16, ds: u16) {
             options(nostack, preserves_flags),
         );
     }
-    crate::debug!("Loaded GDT");
 
     unsafe {
         asm!(
@@ -140,5 +139,5 @@ pub fn load(gdt: &GlobalDescriptorTable, cs: u16, ds: u16) {
         );
     }
 
-    crate::debug!("Updated segments registers");
+    (gdt.entries.as_ptr() as u64, gdt.entries.len() as u8)
 }

kernel/src/arch/x86_64/gdt.rs

@@ -323,5 +323,4 @@ static IDT: Lazy<InterruptDescriptorTable> = Lazy::new(|| {
 
 pub fn init() {
     IDT.load();
-    crate::trace!("Initialized IDT");
 }

kernel/src/arch/x86_64/idt.rs

@@ -3,7 +3,7 @@ use crate::{
         boot::HHDM_REQUEST,
         memory::pmm::{FRAME_SIZE, alloc_contiguous},
     },
-    trace,
+    info,
 };
 use core::{mem::MaybeUninit, slice};
 use talc::{ErrOnOom, Talc, Talck};
@@ -32,8 +32,8 @@ pub fn init() {
         unsafe { talc.claim(span) }.unwrap();
     }
 
-    trace!(
-        "Initialized heap memory at {:#x} with size of {:#x}",
+    info!(
+        "Heap initalized at {:#010x} (size {:#010x})",
         allocator_frame.unwrap().start_address().as_u64(),
         allocator_size
     );

kernel/src/arch/x86_64/memory/heap.rs

@@ -3,7 +3,7 @@ use crate::{
         addr::PhysAddr,
         boot::{HHDM_REQUEST, MEMMAP_REQUEST},
     },
-    debug, trace,
+    debug, info, println,
 };
 use limine::memory_map::EntryType;
 
@@ -46,27 +46,27 @@ pub fn create_bitmap_allocator() -> BitmapAllocator {
     let memmap = MEMMAP_REQUEST.get_response().unwrap();
     let hhdm = HHDM_REQUEST.get_response().unwrap().offset();
 
+    info!("Detecting physical memory");
+    debug!("Usable memory regions:");
     let mut high: u64 = 0;
     for entry in memmap.entries() {
         if entry.entry_type == EntryType::USABLE {
             let top: u64 = entry.base + entry.length;
             if top > high {
                 high = top;
             }
-            debug!(
-                "Found usable memory region from: {:#x} to {:#x}",
-                entry.base, top
-            );
+            println!("        {:#010x} - {:#010x}", entry.base, top);
         }
     }
 
     let frame_count = (high / FRAME_SIZE) as usize;
     let bitmap_size_bytes = (frame_count + 7) / 8;
     let bitmap_size_u64s = (bitmap_size_bytes + 7) / 8;
 
-    trace!(
-        "Total frames: {}, bitmap size: {} bytes ({} u64s)",
-        frame_count, bitmap_size_bytes, bitmap_size_u64s
+    debug!("Total frames: {}", frame_count);
+    debug!(
+        "Bitmap size: {} ({} u64s)",
+        bitmap_size_bytes, bitmap_size_u64s
     );
 
     let mut best_region: Option<(u64, u64)> = None;
@@ -83,7 +83,7 @@ pub fn create_bitmap_allocator() -> BitmapAllocator {
 
     let (bitmap_base, _) = best_region.expect("No suitable memory region found for bitmap");
 
-    trace!("Placing bitmap at physical address: {:#x}", bitmap_base);
+    debug!("Bitmap placed at: {:#010x}", bitmap_base);
 
     // Create the bitmap slice from the chosen memory region with HHDM added to the base
     let bitmap_ptr = (bitmap_base + hhdm) as *mut u64;
@@ -109,11 +109,11 @@ pub fn create_bitmap_allocator() -> BitmapAllocator {
                     }
                 }
             }
-
-            debug!("Freed frames {:#x} to {:#x}", start_frame, end_frame);
         }
     }
 
+    debug!("Freed frames in usable ranges");
+
     let bitmap_start_frame = bitmap_base / FRAME_SIZE;
     let bitmap_end_frame = (bitmap_base + bitmap_size_bytes as u64 + FRAME_SIZE - 1) / FRAME_SIZE;
 
@@ -129,11 +129,6 @@ pub fn create_bitmap_allocator() -> BitmapAllocator {
         }
     }
 
-    trace!(
-        "Marked bitmap region frames {:#x} to {:#x} as used",
-        bitmap_start_frame, bitmap_end_frame
-    );
-
     // Print memory information
     let total_memory = frame_count as u64 * FRAME_SIZE;
     let mut free_frames = 0usize;
@@ -146,11 +141,10 @@ pub fn create_bitmap_allocator() -> BitmapAllocator {
     }
     let free_memory = free_frames as u64 * FRAME_SIZE;
 
-    trace!(
-        "Physical memory: total = {} MiB, free = {} MiB ({} frames free)",
+    info!(
+        "Total memory: {} MiB, usable: {} MiB",
         total_memory / 1024 / 1024,
         free_memory / 1024 / 1024,
-        free_frames
     );
 
     BitmapAllocator {

kernel/src/arch/x86_64/memory/pmm.rs

@@ -11,17 +11,6 @@ pub mod registers;
 pub mod stdext;
 pub mod writer;
 
-pub fn init() {
-    interrupts::disable();
-    assert!(boot::BASE_REVISION.is_supported());
-    writer::init();
-    gdt::init();
-    idt::init();
-    memory::pmm::init();
-    memory::heap::init();
-    interrupts::enable();
-}
-
 #[repr(C, packed)]
 struct DescriptorTablePointer {
     limit: u16,

kernel/src/arch/x86_64/mod.rs

@@ -41,8 +41,6 @@ pub fn init() {
             });
         }
     }
-
-    crate::trace!("Initialized Flanterm context");
 }
 
 pub static FLANTERM_CTX: Lazy<Mutex<FlantermContext>> =