diff --git a/.editorconfig b/.editorconfig index 055607d..329880a 100644 --- a/.editorconfig +++ b/.editorconfig @@ -9,4 +9,8 @@ trim_trailing_whitespace = false insert_final_newline = false [*.asm] -indent_style = space \ No newline at end of file +indent_style = space + +[*.yml] +indent_size = space +indent_size = 2 \ No newline at end of file diff --git a/.gitea/workflows/ci.yml b/.gitea/workflows/ci.yml new file mode 100644 index 0000000..1f146ab --- /dev/null +++ b/.gitea/workflows/ci.yml @@ -0,0 +1,56 @@ +name: CI + +on: + push: + branches: + - main + pull_request: + workflow_dispatch: + +jobs: + typos: + name: "Typos" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Check typos + uses: crate-ci/typos@master + with: + config: ./typos.toml + + clippy: + name: "Clippy" + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + + - name: "Install Rust" + run: | + sudo apt update + DEBIAN_FRONTEND=noninteractive \ + sudo apt install --yes \ + rustup + + - name: Run clippy + working-directory: ./tetros + run: cargo clippy --all-targets --all-features + + build: + name: "Build" + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + + - name: "Install Rust" + run: | + sudo apt update + DEBIAN_FRONTEND=noninteractive \ + sudo apt install --yes \ + rustup + + - name: Build + run: make diff --git a/bios/gdt.asm b/bios/gdt.asm index 0322a53..e86f696 100644 --- a/bios/gdt.asm +++ b/bios/gdt.asm @@ -1,6 +1,6 @@ SECTION .text ; cannot use .data -struc GDTEntry +struc GDTEntry ; spell:disable:line .limitl resw 1 .basel resw 1 .basem resb 1 @@ -26,21 +26,21 @@ gdt_attr: .accessed equ 1 << 0 ;system ; legacy - .tssAvailabe16 equ 0x1 + .tssAvailabe16 equ 0x1 ; spell:disable:line .ldt equ 0x2 .tssBusy16 equ 0x3 .call16 equ 0x4 .task equ 0x5 .interrupt16 equ 0x6 .trap16 equ 0x7 - .tssAvailabe32 equ 0x9 + .tssAvailabe32 equ 0x9 ; spell:disable:line .tssBusy32 equ 0xB .call32 equ 0xC .interrupt32 equ 0xE .trap32 equ 0xF ; long mode .ldt32 equ 0x2 - .tssAvailabe64 equ 0x9 + .tssAvailabe64 equ 0x9 ; spell:disable:line .tssBusy64 equ 0xB .call64 equ 0xC .interrupt64 equ 0xE diff --git a/tetros/src/idt/entry.rs b/tetros/src/idt/entry.rs index a8056d5..9b3ff91 100644 --- a/tetros/src/idt/entry.rs +++ b/tetros/src/idt/entry.rs @@ -61,6 +61,7 @@ impl fmt::Debug for Entry { } } +// spell:off impl Entry { /// Create a valid non-present IDT entry. #[inline] @@ -111,7 +112,9 @@ impl Entry { )) } } +// spell:on +// spell:off impl Entry { /// Sets the handler address for the IDT entry and sets the following defaults: /// - The code selector is the code segment currently active in the CPU @@ -125,3 +128,4 @@ impl Entry { unsafe { self.set_handler_addr(handler.to_virt_addr()) } } } +// spell:on diff --git a/tetros/src/idt/handler.rs b/tetros/src/idt/handler.rs index 66fe96c..5ca5e23 100644 --- a/tetros/src/idt/handler.rs +++ b/tetros/src/idt/handler.rs @@ -50,9 +50,9 @@ bitflags! { } } -/// -/// MARK: types -/// +// +// MARK: types +// /// A handler function for an interrupt or an exception without error code. pub type HandlerFunc = extern "x86-interrupt" fn(InterruptStackFrame); @@ -84,6 +84,7 @@ pub unsafe trait HandlerFuncType { unsafe impl HandlerFuncType for HandlerFunc { #[inline] fn to_virt_addr(self) -> VirtAddr { + #[allow(clippy::fn_to_numeric_cast_with_truncation)] VirtAddr::new(self as u32) } } @@ -91,6 +92,7 @@ unsafe impl HandlerFuncType for HandlerFunc { unsafe impl HandlerFuncType for HandlerFuncWithErrCode { #[inline] fn to_virt_addr(self) -> VirtAddr { + #[allow(clippy::fn_to_numeric_cast_with_truncation)] VirtAddr::new(self as u32) } } @@ -98,6 +100,7 @@ unsafe impl HandlerFuncType for HandlerFuncWithErrCode { unsafe impl HandlerFuncType for DivergingHandlerFunc { #[inline] fn to_virt_addr(self) -> VirtAddr { + #[allow(clippy::fn_to_numeric_cast_with_truncation)] VirtAddr::new(self as u32) } } @@ -105,6 +108,7 @@ unsafe impl HandlerFuncType for DivergingHandlerFunc { unsafe impl HandlerFuncType for DivergingHandlerFuncWithErrCode { #[inline] fn to_virt_addr(self) -> VirtAddr { + #[allow(clippy::fn_to_numeric_cast_with_truncation)] VirtAddr::new(self as u32) } } @@ -112,6 +116,7 @@ unsafe impl HandlerFuncType for DivergingHandlerFuncWithErrCode { unsafe impl HandlerFuncType for PageFaultHandlerFunc { #[inline] fn to_virt_addr(self) -> VirtAddr { + #[allow(clippy::fn_to_numeric_cast_with_truncation)] VirtAddr::new(self as u32) } } diff --git a/tetros/src/idt/table.rs b/tetros/src/idt/table.rs index 92b7478..7f31e87 100644 --- a/tetros/src/idt/table.rs +++ b/tetros/src/idt/table.rs @@ -7,7 +7,7 @@ use super::{ // TODO: comments #[repr(C, packed(2))] -struct IDTR { +struct Idtr { size: u16, offset: u32, } @@ -16,6 +16,7 @@ struct IDTR { // MARK: idt // +// spell:off #[derive(Clone, Debug)] #[repr(C)] #[repr(align(8))] @@ -410,6 +411,7 @@ pub struct InterruptDescriptorTable { /// instruction pointer points to the instruction after the INTn. interrupts: [Entry; 256 - 32], } +// spell:on // // MARK: impl @@ -469,7 +471,7 @@ impl InterruptDescriptorTable { #[inline] pub unsafe fn load_unsafe(&self) { let idtr = { - IDTR { + Idtr { size: (size_of::() - 1) as u16, offset: self as *const _ as u32, } diff --git a/tetros/src/os/panic.rs b/tetros/src/os/panic.rs index fea6607..f9de158 100644 --- a/tetros/src/os/panic.rs +++ b/tetros/src/os/panic.rs @@ -21,7 +21,6 @@ pub fn rust_begin_unwind(info: &PanicInfo<'_>) -> ! { } } -#[allow(non_snake_case)] #[no_mangle] /// Required to handle panics pub extern "C" fn _Unwind_Resume() -> ! { diff --git a/tetros/src/os/thunk.rs b/tetros/src/os/thunk.rs index 9e26ab7..e960d60 100644 --- a/tetros/src/os/thunk.rs +++ b/tetros/src/os/thunk.rs @@ -2,7 +2,6 @@ use core::ptr; use super::THUNK_STACK_ADDR; -#[allow(dead_code)] #[derive(Clone, Copy, Debug)] #[repr(C, packed)] pub struct ThunkData { diff --git a/typos.toml b/typos.toml new file mode 100644 index 0000000..eed47b0 --- /dev/null +++ b/typos.toml @@ -0,0 +1,8 @@ +[default] +extend-ignore-re = [ + # spell:disable-line + "(?Rm)^.*(%|#|//|;)\\s*spell:disable-line$", + + # spell: + "(?s)(%|#|//|;)\\s*spell:off.*?\\n\\s*(%|#|//)\\s*spell:on", +]