Isolate arch-specific and memory allocators into a separate library (kerla_runtime) (#77)

Author: nuta

Cargo.lock

@@ -1,5 +1,6 @@
 [workspace]
 members = [
+    "runtime",
     "kernel",
     "libs/*",
 ]

Cargo.toml

@@ -47,9 +47,10 @@ export RUSTFLAGS = -Z emit-stack-sizes
 CARGOFLAGS += -Z build-std=core,alloc -Z build-std-features=compiler-builtins-mem
 CARGOFLAGS += --target $(target_json)
 CARGOFLAGS += $(if $(RELEASE),--release,)
-TESTCARGOFLAGS += --package kerla -Z unstable-options
+TESTCARGOFLAGS += --package kerla_kernel -Z unstable-options
 TESTCARGOFLAGS += --config "target.$(ARCH).runner = './tools/run-unittests.sh'"
 WATCHFLAGS += --clear
+
 export CARGO_FROM_MAKE=1
 export INITRAMFS_PATH
 export ARCH
@@ -62,7 +63,7 @@ export NM
 .PHONY: build
 build:
 	$(MAKE) build-crate
-	cp target/$(ARCH)/$(build_mode)/kerla $(kernel_elf)
+	cp target/$(ARCH)/$(build_mode)/kerla_kernel $(kernel_elf)
 
 	$(PROGRESS) "NM" $(kernel_symbols)
 	$(NM) $(kernel_elf) | rustfilt | awk '{ $$2=""; print $$0 }' > $(kernel_symbols)

Makefile

@@ -1,26 +1,30 @@
 [package]
-name = "kerla"
+name = "kerla_kernel"
 version = "0.0.4"
 authors = ["Seiya Nuta <nuta@seiya.me>"]
 edition = "2018"
 
 [[bin]]
-name = "kerla"
+name = "kerla_kernel"
 path = "main.rs"
 
 [dependencies]
-kerla_utils = { path = "../libs/kerla_utils", features = ["no_std"] }
-spin = "0.9.2"
-x86 = "0.43.0"
 memoffset = "0.6.4"
-buddy_system_allocator = "0.8.0"
-arrayvec = { version = "0.7.2", default-features = false }
+log = "0.4"
+spin = "0.9.2"
 goblin = { version = "0.4", default-features = false, features = ["elf64"] }
+smoltcp = { version = "0.7.5", default-features = false, features = ["alloc", "proto-ipv4", "socket", "socket-raw", "socket-udp", "socket-tcp", "proto-dhcpv4", "ethernet"] }
+
+# Data structues.
 bitflags = "1.3.2"
+arrayvec = { version = "0.7.2", default-features = false }
 hashbrown = { version = "0.11.2", features = ["nightly"] }
-log = "0.4"
 crossbeam = { version = "0.8.1", default-features = false, features = ["alloc"] }
-smoltcp = { version = "0.7.5", default-features = false, features = ["alloc", "proto-ipv4", "socket", "socket-raw", "socket-udp", "socket-tcp", "proto-dhcpv4", "ethernet"] }
-cfg-if = "1"
 atomic_refcell = "0.1.6"
-vte = "0.10"
+
+# Arch-specific dependencies.
+x86 = "0.43.0"
+
+# Local dependencies.
+kerla_runtime = { path = "../runtime" }
+kerla_utils = { path = "../libs/kerla_utils", features = ["no_std"] }

kernel/Cargo.toml

@@ -9,7 +9,6 @@ const ARCH_SET_FS: i32 = 0x1002;
 
 pub fn arch_prctl(current: &Arc<Process>, code: i32, uaddr: UserVAddr) -> Result<()> {
     match code {
-        // TODO: Move to arch directory.
         ARCH_SET_FS => {
             let value = uaddr.value() as u64;
             current.arch().fsbase.store(value);

kernel/arch/x64/arch_prctl.rs

@@ -1,49 +1,14 @@
-global_asm!(include_str!("boot.S"));
-global_asm!(include_str!("trap.S"));
-global_asm!(include_str!("usercopy.S"));
+use kerla_runtime::{address::UserVAddr, arch::PAGE_SIZE};
+
+global_asm!(include_str!("usermode.S"));
 
-#[macro_use]
-mod cpu_local;
-mod address;
-mod apic;
 mod arch_prctl;
-mod backtrace;
-mod boot;
-mod bootinfo;
-mod gdt;
-mod idle;
-mod idt;
-mod interrupt;
-mod ioapic;
-mod lock;
-mod page_table;
-mod pit;
 mod process;
-mod profile;
-mod semihosting;
-mod serial;
-mod syscall;
-mod tss;
-mod vga;
 
 pub const KERNEL_STACK_SIZE: usize = PAGE_SIZE * 256;
 pub const USER_VALLOC_END: UserVAddr = unsafe { UserVAddr::new_unchecked(0x0000_0fff_0000_0000) };
 pub const USER_VALLOC_BASE: UserVAddr = unsafe { UserVAddr::new_unchecked(0x0000_000a_0000_0000) };
 pub const USER_STACK_TOP: UserVAddr = USER_VALLOC_BASE;
-pub const PAGE_SIZE: usize = 4096;
-pub const TICK_HZ: usize = 1000;
 
-pub use address::{PAddr, UserVAddr, VAddr};
 pub use arch_prctl::arch_prctl;
-pub use backtrace::Backtrace;
-pub use boot::init;
-pub use idle::{halt, idle};
-pub use ioapic::enable_irq;
-pub use lock::{SpinLock, SpinLockGuard};
-pub use page_table::{PageFaultReason, PageTable};
 pub use process::{switch_thread, Process};
-pub use profile::read_clock_counter;
-#[cfg(test)]
-pub use semihosting::{semihosting_halt, ExitStatus};
-pub use serial::{print_str, printchar};
-pub use syscall::SyscallFrame;

kernel/arch/x64/mod.rs

@@ -1,19 +1,15 @@
 use core::cell::UnsafeCell;
 
-use super::{
-    address::VAddr,
-    gdt::{USER_CS64, USER_DS},
-    syscall::SyscallFrame,
-    tss::TSS,
-    UserVAddr, KERNEL_STACK_SIZE, PAGE_SIZE,
-};
-use super::{cpu_local::cpu_local_head, gdt::USER_RPL};
 use crate::result::Result;
-use crate::{
-    mm::page_allocator::{alloc_pages, AllocPageFlags},
-    process::signal::Signal,
-};
+use crate::{arch::KERNEL_STACK_SIZE, process::signal::Signal};
 use crossbeam::atomic::AtomicCell;
+use kerla_runtime::address::{UserVAddr, VAddr};
+use kerla_runtime::{
+    arch::x64_specific::{cpu_local_head, TSS, USER_CS64, USER_DS, USER_RPL},
+    arch::SyscallFrame,
+    arch::PAGE_SIZE,
+    page_allocator::{alloc_pages, AllocPageFlags},
+};
 use x86::current::segmentation::wrfsbase;
 
 #[repr(C, packed)]

kernel/arch/x64/process.rs

@@ -1,6 +1,6 @@
-.set INTERRUPT_HANDLER_SIZE, 16
-.set GS_RSP0,                0
-.set GS_RSP3,                8
+// Offsets in CpuLocalHead.
+.set GS_RSP0, 0
+.set GS_RSP3, 8
 
 .global syscall_entry
 syscall_entry:
@@ -78,115 +78,6 @@ syscall_entry:
     swapgs
     sysretq
 
-//
-//  Interrupt/exception handlers
-//
-.align INTERRUPT_HANDLER_SIZE
-.global interrupt_handlers
-interrupt_handlers:
-.set i, 0
-.rept 256
-.set handler_start, .
-// Exceptions with error code.
-.if i == 8 || 10 <= i && i <= 14 || i == 17
-    .align INTERRUPT_HANDLER_SIZE
-    cli
-    push i
-    jmp interrupt_common
-    .align INTERRUPT_HANDLER_SIZE
-// Interrupts and exceptions without error code.
-.else
-    .align INTERRUPT_HANDLER_SIZE
-    cli
-    push 0 // Dummy value as error code.
-    push i
-    jmp interrupt_common
-    .align INTERRUPT_HANDLER_SIZE
-.endif
-
-// Increment the counter.
-.set i, i + 1
-.endr
-
-.extern x64_handle_interrupt
-interrupt_common:
-    //
-    //  The current stack frame:
-    //
-    //            +--------------------+
-    //     48     |        SS          |
-    //            +--------------------+
-    //     40     |        RSP         |
-    //            +--------------------+
-    //     32     |       RFLAGS       |
-    //            +--------------------+
-    //     24     |        CS          |
-    //            +--------------------+
-    //     16     |        RIP         |
-    //            +--------------------+
-    //      8     |     Error code     |
-    //            +--------------------+
-    //      0     |     IRQ Number     | <- RSP
-    //            +--------------------+
-    //
-
-    // Check CS register in the IRET frame to determine if the interrupt has
-    // occurred in user mode.
-    test qword ptr [rsp + 24], 3
-    jz 1f
-    swapgs
-1:
-    // Save RDI and set the IRQ number to RDI at once.
-    xchg rdi, [rsp]
-
-    // Save registers except RDI (we have already saved it above).
-    push r15
-    push r14
-    push r13
-    push r12
-    push r11
-    push r10
-    push r9
-    push r8
-    push rbp
-    push rsi
-    push rdx
-    push rcx
-    push rbx
-    push rax
-
-    mov rsi, rsp
-    call x64_handle_interrupt
-
-    pop rax
-    pop rbx
-    pop rcx
-    pop rdx
-    pop rsi
-    pop rbp
-    pop r8
-    pop r9
-    pop r10
-    pop r11
-    pop r12
-    pop r13
-    pop r14
-    pop r15
-    pop rdi
-
-    // Skip error code.
-    add rsp, 8
-
-    // Check CS register in the IRET frame to determine whether the exception
-    // occur in the userspace. If so, do SWAPGS.
-    test qword ptr [rsp + 8], 3
-    jz 1f
-
-    cli
-    swapgs
-1:
-    iretq
-
 .global kthread_entry
 kthread_entry:
     sti