Improved README, added basic CI CD

Author: Roeegg2

.github/workflows/ci.yaml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    - cron: '0 0 * * *'  # Run nightly to catch regressions
+
+env:
+  CARGO_TERM_COLOR: always
+  RUST_BACKTRACE: 1
+
+# TODO: Add Clippy and mock Funderberker testing
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        crate: [macros, utils, kernel]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          key: crate-${{ matrix.crate }}
+      - name: Check ${{ matrix.crate }}
+        run: cargo +nightly check --manifest-path="${{ matrix.crate }}/Cargo.toml" --verbose
+
+  unit_tests:
+    name: Unit Test Individual Crates
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        crate: [macros, utils]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          key: crate-${{ matrix.crate }}
+      - name: Test ${{ matrix.crate }}
+        run: cargo +nightly test --manifest-path="${{ matrix.crate }}/Cargo.toml" --verbose
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+      - name: Build docs
+        run: cargo +nightly doc --manifest-path=kernel/Cargo.toml --no-deps --all-features
+      - name: Deploy to GitHub Pages
+        if: github.ref == 'refs/heads/main'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./target/doc

README.md

@@ -1,3 +1,13 @@
+
+<p align="center">
+  <img src="./logo-no-bg.png" alt="jason" />
+</p>
+
+[![GitHub stars](https://img.shields.io/github/stars/roeegg2/funderberker.svg)](https://github.com/roeegg2/funderberker/stargazers)
+[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![CI Status](https://img.shields.io/github/actions/workflow/status/roeegg2/funderberker/ci.yml?cacheSeconds=0)](https://github.com/roeegg2/funderberker/actions/workflows/ci.yml)
+
+
 # Funderberker
 
 Funderberker is a WIP type 1 VMM written in Rust, with a focus on customizability and performance. 
@@ -25,3 +35,4 @@ just help
 Contributions are more than welcome!
 
 Funderberker is still in its infancy, so there are many things to do.
+

kernel/src/dev/timer/hpet.rs

@@ -35,7 +35,7 @@ pub enum InterruptRoutingMode {
 
 /// The delivery mode a specific timer will use
 #[allow(dead_code)]
-#[derive(Debug, Clone, Copy, PartialEq)]
+#[derive(Debug, Clone, Copy)]
 pub enum DeliveryMode {
     /// The timer will issue interrupts as specified by `InterruptRoutingMode`.
     ///

kernel/src/main.rs

@@ -1,18 +1,15 @@
 #![no_std]
 #![no_main]
 #![feature(let_chains)]
-#![feature(nonnull_provenance)]
 #![feature(allocator_api)]
 #![feature(pointer_is_aligned_to)]
 #![feature(box_vec_non_null)]
-#![feature(non_null_from_ref)]
 #![feature(custom_test_frameworks)]
 #![feature(ptr_as_ref_unchecked)]
 #![test_runner(crate::test::test_runner)]
 #![reexport_test_harness_main = "test_main"]
 #![feature(stmt_expr_attributes)]
 #![feature(sync_unsafe_cell)]
-#![feature(naked_functions)]
 #![feature(concat_idents)]
 // TODO: Remove these after code is stable!!!
 #![allow(clippy::cast_possible_truncation)]

kernel/src/sync/spinlock.rs

@@ -53,7 +53,7 @@ where
 
     /// Spin until you can lock the spinlock, then lock it
     #[inline]
-    pub fn lock(&self) -> SpinLockGuard<T> {
+    pub fn lock(&self) -> SpinLockGuard<'_, T> {
         spin_until!(!self.lock.swap(true, Ordering::Acquire));
 
         SpinLockGuard {

logo-no-bg.png

@@ -1,5 +1,3 @@
-#![feature(naked_functions)]
-
 use proc_macro::TokenStream;
 use quote::quote;
 use syn::{parse_macro_input, ItemFn};
@@ -62,31 +60,33 @@ pub fn isr(_attr: TokenStream, item: TokenStream) -> TokenStream {
     let fn_vis = &input_fn.vis;
     let fn_args = &input_fn.sig.inputs;
     let fn_body = &input_fn.block;
-
+    
     // Generate the wrapper function name
     let wrapper_name = syn::Ident::new(&format!("__isr_stub_{}", fn_name), fn_name.span());
-
+    
     // Generate the macro output
     let expanded = quote! {
         // The original ISR function (renamed internally)
         #fn_vis fn #fn_name(#fn_args) {
             #fn_body
         }
-
+        
         // The naked wrapper function with ISR assembly
-        #[naked]
+        #[unsafe(naked)]
         #[unsafe(no_mangle)]
         #fn_vis unsafe extern "C" fn #wrapper_name() {
-            core::arch::naked_asm!(
-                // Call the actual ISR
-                "call {}",
-                // Return from interrupt
-                "iretq",
-                sym #fn_name,
-            );
+            unsafe {
+                core::arch::naked_asm!(
+                    // Call the actual ISR
+                    "call {}",
+                    // Return from interrupt
+                    "iretq",
+                    sym #fn_name,
+                );
+            }
         }
     };
-
+    
     TokenStream::from(expanded)
 }
 

macros/src/lib.rs

@@ -171,7 +171,7 @@ impl<T> StackList<T> {
     }
 
     #[inline]
-    pub fn iter_node(&self) -> IterNode<T> {
+    pub fn iter_node(&self) -> IterNode<'_, T> {
         IterNode {
             head: self.head,
             len: self.len,
@@ -180,7 +180,7 @@ impl<T> StackList<T> {
     }
 
     #[inline]
-    pub fn iter_node_mut(&mut self) -> IterNodeMut<T> {
+    pub fn iter_node_mut(&mut self) -> IterNodeMut<'_, T> {
         IterNodeMut {
             head: self.head,
             len: self.len,
@@ -189,7 +189,7 @@ impl<T> StackList<T> {
     }
 
     #[inline]
-    pub fn iter(&self) -> Iter<T> {
+    pub fn iter(&self) -> Iter<'_, T> {
         Iter {
             head: self.head,
             len: self.len,
@@ -198,7 +198,7 @@ impl<T> StackList<T> {
     }
 
     #[inline]
-    pub fn iter_mut(&mut self) -> IterMut<T> {
+    pub fn iter_mut(&mut self) -> IterMut<'_, T> {
         IterMut {
             head: self.head,
             len: self.len,