Improved source code, added doxygen docs, added new commands meminfo and heapinfo, added vnc for github actions, improved github actions.

Author: pradosh-arduino

.github/workflows/build.yml

@@ -36,4 +36,4 @@ jobs:
       run: sudo pkill qemu
 
     - name: Upload to file.io
-      run: ls && curl -F "file=@./FrostWing.iso"  https://file.io
+      run: curl -F "file=@./FrostWing.iso"  https://file.io

Makefile

@@ -70,6 +70,18 @@ run-x86-uefi:
 	-device ide-hd,drive=disk,bus=ahci.0 \
 	-m 512
 
+run-x86-vnc:
+	@qemu-system-x86_64 \
+	-vga std \
+	-debugcon stdio \
+	-serial file:serial.log \
+	-device rtl8139,netdev=eth0 \
+	-netdev user,hostfwd=tcp::5555-:22,id=eth0 \
+	-cdrom FrostWing.iso \
+	-m 256 \
+	-no-reboot \
+	-vnc :1 -display none &
+
 everything:
 	@make clean all -C source && make iso tarball run-x86
 

source/includes/idt.h

@@ -1,3 +1,15 @@
+/**
+ * @file idt.h
+ * @author Pradosh ([email protected]) & GAMINGNOOB
+ * @brief 
+ * @version 0.1
+ * @date 2025-02-03
+ * 
+ * @copyright Copyright Pradosh (c) 2025
+ * 
+ */
+
+
 #ifndef IDT_H
 #define IDT_H
 

source/includes/isr.h

@@ -1,3 +1,13 @@
+/**
+ * @file isr.h
+ * @author Pradosh ([email protected]) & GAMINGNOOB
+ * @brief Interrupts handler header.
+ * @version 0.1
+ * @date 2025-02-03
+ * 
+ * @copyright Copyright Pradosh (c) 2025
+ * 
+ */
 #ifndef ISR_H
 #define ISR_H
 

source/includes/memory2.h

@@ -9,6 +9,24 @@
 
 #include <basics.h>
 
+#ifndef MEMORY_H
+#define MEMORY_H
+
+struct memory_context {
+    int64 total;
+    int64 usable;
+    int64 reserved;
+    int64 acpi_reclaimable;
+    int64 acpi_nvs;
+    int64 bad;
+    int64 bootloader_reclaimable;
+    int64 kernel_modules;
+    int64 framebuffer;            // Mostly unneeded because frame buffer struct separately gives it,
+    int64 unknown;                // This value must be always 0.
+};
+
+extern struct memory_context memory;
+
 /**
  * @brief Copies a block of memory from a source location to a destination location.
  *
@@ -79,4 +97,20 @@ void memory_dump(const void* start, const void* end);
  * @param size Size of the memory to allocate.
  * @return Pointer to the allocated memory, or NULL if allocation fails.
  */
-void* allocate_memory_at_address(int64 phys_addr, size_t size);
+void* allocate_memory_at_address(int64 phys_addr, size_t size);
+
+/**
+ * @brief Display the formatted memory context.
+ * 
+ * @param memory The memory context to display.
+ */
+void display_memory_formatted(struct memory_context memory);
+
+/**
+ * @brief Returns the CR2 register.
+ * 
+ * @return uint64_t value of CR2.
+ */
+uint64_t getCR2();
+
+#endif // MEMORY_H

source/kernel/C/heap.c

@@ -12,6 +12,7 @@
 #include <heap.h>
 #include <stddef.h>
 #include <graphics.h>
+#include <memory2.h>
 
 uint32_t last_alloc = 0;
 uint32_t heap_end = 0;
@@ -47,6 +48,19 @@ void mm_extend(uint32_t additional_size)
     done("Heap extended.", __FILE__);
 }
 
+void mm_constrict(uint32_t removal_size)
+{
+    if (removal_size <= 0){
+        warn("mm_extend: Invalid size.", __FILE__);
+        return;
+    }
+
+    info("Constricting heap.", __FILE__);
+    heap_end -= removal_size;
+    printf("Heap constricting by %d bytes. New heap end: 0x%x", removal_size, heap_end);
+    done("Heap Constricted.", __FILE__);
+}
+
 void mm_print_out()
 {
     printf("%sMemory used :%s %d bytes", yellow_color, reset_color, memory_used);
@@ -56,6 +70,11 @@ void mm_print_out()
 
 void free(void *mem)
 {
+	if(mem == 0){
+		warn("free: Cannot free null pointer.", __FILE__);
+		return;
+	}
+
 	alloc_t *alloc = (mem - sizeof(alloc_t));
 	memory_used -= alloc->size + sizeof(alloc_t);
 	alloc->status = 0;
@@ -75,7 +94,11 @@ void pfree(void *mem)
 
 char* pmalloc(size_t size)
 {
-	/* Loop through the avail_list */
+	if(size <= 0){
+		warn("pmalloc: Cannot allocate 0 bytes.", __FILE__);
+		return 0;
+	}
+
 	for(int i = 0; i < MAX_PAGE_ALIGNED_ALLOCS; i++)
 	{
 		if(pheap_desc[i]) continue;
@@ -89,7 +112,10 @@ char* pmalloc(size_t size)
 
 char* malloc(size_t size)
 {
-	if(!size) return 0;
+	if(size <= 0){
+		warn("malloc: Cannot allocate 0 bytes.", __FILE__);
+		return 0;
+	}
 
 	/* Loop through blocks and find a block sized the same or bigger */
 	uint8_t *mem = (uint8_t *)heap_begin;
@@ -134,7 +160,7 @@ char* malloc(size_t size)
 	nalloc:;
 	if(last_alloc+size+sizeof(alloc_t) >= heap_end)
 	{
-        meltdown_screen("Heap out of memory!", __FILE__, __LINE__, 0, 0, 0);
+        meltdown_screen("Heap out of memory!", __FILE__, __LINE__, 0, getCR2(), 0);
         hcf();
 	}
 	alloc_t *alloc = (alloc_t *)last_alloc;
@@ -144,6 +170,7 @@ char* malloc(size_t size)
 	last_alloc += size;
 	last_alloc += sizeof(alloc_t);
 	last_alloc += 4;
+
 	// printf("Allocated %d bytes from  to 0x%x", size, (uint32_t)alloc + sizeof(alloc_t), last_alloc);
 	memory_used += size + 4 + sizeof(alloc_t);
 	memset((char *)((uint32_t)alloc + sizeof(alloc_t)), 0, size);

source/kernel/C/interrupts/idt.c

@@ -1,3 +1,14 @@
+/**
+ * @file idt.c
+ * @author Pradosh ([email protected]) & GAMINGNOOB
+ * @brief Interrupt descriptor table code.
+ * @version 0.1
+ * @date 2025-02-03
+ * 
+ * @copyright Copyright Pradosh (c) 2025
+ * 
+ */
+
 #include <idt.h>
 #include <isr.h>
 #include <keyboard.h>

source/kernel/C/interrupts/isr.c

@@ -1,15 +1,20 @@
+/**
+ * @file isr.c
+ * @author Pradosh ([email protected])
+ * @brief Interrupts handler code.
+ * @version 0.1
+ * @date 2025-02-03
+ * 
+ * @copyright Copyright (c) 2025
+ * 
+ */
+
 #include <isr.h>
 #include <keyboard.h>
+#include <memory2.h>
 
 irq_handler interrupt_handlers[256];
 
-static inline uint64_t getCR2(void)
-{
-	uint64_t val;
-	__asm__ volatile ( "mov %%cr2, %0" : "=r"(val) );
-    return val;
-}
-
 void exceptionHandler(InterruptFrame* frame) {
 	switch (frame->int_no) {
         case 0:

source/kernel/C/kernel.c

@@ -58,25 +58,10 @@ struct limine_module_request module_request = {
     LIMINE_MODULE_REQUEST, 0, null
 };
 
-struct memory_context {
-    int64 total;
-    int64 usable;
-    int64 reserved;
-    int64 acpi_reclaimable;
-    int64 acpi_nvs;
-    int64 bad;
-    int64 bootloader_reclaimable;
-    int64 kernel_modules;
-    int64 framebuffer;            // Mostly unneeded because frame buffer struct separately gives it,
-    int64 unknown;                // This value must be always 0.
-};
-
-
 struct flanterm_context *ft_ctx = null;
 struct limine_framebuffer *framebuffer = null;
 
 bool isBufferReady = no;
-// bool logoBoot = no;
 
 int32 ctr = 0;
 
@@ -140,6 +125,8 @@ void mouseButtonHandler(uint8_t button, uint8_t action)
     }
 }
 
+struct memory_context memory;
+
 void main(void) {
     if (framebuffer_request.response == null) {
         hcf2();
@@ -168,9 +155,10 @@ void main(void) {
 
     mm_init(kend);
 
+    mm_extend(2 MiB);
+
     RTL8139 = (struct rtl8139*)malloc(sizeof(struct rtl8139));
 
-    struct memory_context memory;
     memory.total = 0;
     memory.usable = 0;
     memory.reserved = 0;
@@ -254,16 +242,7 @@ void main(void) {
     printf("Display Resolution: %dx%d (%d) pixels. Pitch: %d", framebuffer->width, framebuffer->height, framebuffer->width*framebuffer->height, framebuffer->pitch);
 
     info("Memory Values begin! ===", __FILE__);
-    printf("Usable                 : %d KiB", memory.usable / 1024);
-    printf("Reserved               : %d KiB", memory.reserved / 1024);
-    printf("ACPI Reclaimable       : %d KiB", memory.acpi_reclaimable / 1024);
-    printf("ACPI NVS               : %d KiB", memory.acpi_nvs / 1024);
-    printf("Bad                    : %d KiB", memory.bad / 1024);
-    printf("Bootloader Reclaimable : %d KiB", memory.bootloader_reclaimable / 1024);
-    printf("Kernel Modules         : %d KiB", memory.kernel_modules / 1024);
-    printf("Framebuffer            : %d KiB", memory.framebuffer / 1024);
-    printf("Unknown                : %d KiB", memory.unknown / 1024);   print(yellow_color);
-    printf("Grand Total            : %d MiB", ((memory.total / 1024)/1024)-3); // There is an error of 3MB always for some reason
+    display_memory_formatted(memory);
     info(reset_color "Memory values end! =====", __FILE__);
 
     if(memory.bad != 0){

source/kernel/C/memory.c

@@ -9,6 +9,7 @@
  * 
  */
 #include <memory2.h>
+#include <graphics.h>
 
 // GCC and Clang reserve the right to generate calls to the following
 // 4 functions even if they are not directly called.
@@ -132,4 +133,24 @@ void* allocate_memory_at_address(int64 phys_addr, size_t size) {
     void* ptr = (void*)phys_addr;
 
     return ptr;
+}
+
+void display_memory_formatted(struct memory_context memory) {
+    printf("Usable                 : %d KiB", memory.usable / 1024);
+    printf("Reserved               : %d KiB", memory.reserved / 1024);
+    printf("ACPI Reclaimable       : %d KiB", memory.acpi_reclaimable / 1024);
+    printf("ACPI NVS               : %d KiB", memory.acpi_nvs / 1024);
+    printf("Bad                    : %d KiB", memory.bad / 1024);
+    printf("Bootloader Reclaimable : %d KiB", memory.bootloader_reclaimable / 1024);
+    printf("Kernel Modules         : %d KiB", memory.kernel_modules / 1024);
+    printf("Framebuffer            : %d KiB", memory.framebuffer / 1024);
+    printf("Unknown                : %d KiB", memory.unknown / 1024);   print(yellow_color);
+    printf("Grand Total            : %d MiB", ((memory.total / 1024)/1024)-3); // There is an error of 3MB always for some reason
+}
+
+uint64_t getCR2()
+{
+	uint64_t val;
+	__asm__ volatile ( "mov %%cr2, %0" : "=r"(val) );
+    return val;
 }