Update

Cargo.lock

@@ -39,8 +39,6 @@ dependencies = [
 [[package]]
 name = "bootloader"
 version = "0.8.8"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c3ed4f735c4e455ba86a3d2939b1c0729414153642106c9d035693355630a42c"
 
 [[package]]
 name = "cfg-if"

Cargo.toml

@@ -31,15 +31,15 @@ version = "0.2.1"
 default-features = false
 features = ["alloc"]
 
+[dependencies.conquer-once]
+version = "0.2.0"
+default-features = false
+
 [dependencies.futures-util]
 version = "0.3.4"
 default-features = false
 features = ["alloc", "async-await"]
 
-[dependencies.conquer-once]
-version = "0.2.0"
-default-features = false
-
 [package.metadata.bootimage]
 test-args = [
     "-device", "isa-debug-exit,iobase=0xf4,iosize=0x04", "-serial", "stdio",

src/driver/keyboard.rs

@@ -1,75 +0,0 @@
-use crate::{print, println, task::interrupt_wake};
-use conquer_once::spin::OnceCell;
-use core::future::Future;
-use core::{
-    pin::Pin,
-    task::{Context, Poll},
-};
-use crossbeam_queue::ArrayQueue;
-use futures_util::task::AtomicWaker;
-use pc_keyboard::{layouts, DecodedKey, HandleControl, Keyboard, ScancodeSet1};
-
-static WAKER: AtomicWaker = AtomicWaker::new();
-static SCANCODE_QUEUE: OnceCell<ArrayQueue<u8>> = OnceCell::uninit();
-
-pub fn init() {
-    SCANCODE_QUEUE
-        .try_init_once(|| ArrayQueue::new(10))
-        .expect("failed to init scancode queue");
-}
-
-/// Called by the keyboard interrupt handler
-///
-/// Must not block (including spinlocks).
-pub(crate) fn keyboard_scancode(scancode: u8) {
-    let scancode_queue = SCANCODE_QUEUE
-        .try_get()
-        .expect("scancode queue not initialized");
-    if let Err(_) = scancode_queue.push(scancode) {
-        println!("WARNING: dropping keyboard input");
-    }
-    if let Some(waker) = WAKER.take() {
-        interrupt_wake(waker);
-    }
-}
-
-fn next_scancode() -> impl Future<Output = u8> {
-    NextScancode
-}
-
-struct NextScancode;
-
-impl Future for NextScancode {
-    type Output = u8;
-
-    fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<u8> {
-        let scancodes = SCANCODE_QUEUE
-            .try_get()
-            .expect("scancode queue not initialized");
-        // fast path
-        if let Ok(scancode) = scancodes.pop() {
-            return Poll::Ready(scancode);
-        }
-
-        WAKER.register(&cx.waker());
-        match scancodes.pop() {
-            Ok(scancode) => Poll::Ready(scancode),
-            Err(crossbeam_queue::PopError) => Poll::Pending,
-        }
-    }
-}
-
-pub async fn keyboard_task() {
-    let mut keyboard = Keyboard::new(layouts::Us104Key, ScancodeSet1, HandleControl::Ignore);
-
-    loop {
-        if let Ok(Some(key_event)) = keyboard.add_byte(next_scancode().await) {
-            if let Some(key) = keyboard.process_keyevent(key_event) {
-                match key {
-                    DecodedKey::Unicode(character) => print!("{}", character),
-                    DecodedKey::RawKey(key) => print!("{:?}", key),
-                }
-            }
-        }
-    }
-}

src/driver/mod.rs

@@ -1,6 +0,0 @@
-pub mod keyboard;
-pub mod timer;
-
-pub fn init() {
-    keyboard::init();
-}

src/driver/timer.rs

@@ -1,55 +0,0 @@
-use crate::{print, task::interrupt_wake};
-use core::future::Future;
-use core::{
-    pin::Pin,
-    sync::atomic::{AtomicU64, Ordering},
-    task::{Context, Poll},
-};
-use futures_util::task::AtomicWaker;
-
-static TICKS: AtomicU64 = AtomicU64::new(0);
-static WAKER: AtomicWaker = AtomicWaker::new();
-
-/// Called by the timer interrupt handler
-///
-/// Must not block (including spinlocks).
-pub(crate) fn tick() {
-    TICKS.fetch_add(1, Ordering::Release);
-    if let Some(waker) = WAKER.take() {
-        interrupt_wake(waker);
-    }
-}
-
-fn next_tick() -> impl Future<Output = u64> {
-    static NEXT_TICK: AtomicU64 = AtomicU64::new(1);
-
-    NextTick {
-        ticks: NEXT_TICK.fetch_add(1, Ordering::Release),
-    }
-}
-
-struct NextTick {
-    ticks: u64,
-}
-
-impl Future for NextTick {
-    type Output = u64;
-
-    fn poll(mut self: Pin<&mut Self>, cx: &mut Context) -> Poll<u64> {
-        WAKER.register(&cx.waker());
-        let current_ticks = TICKS.load(Ordering::Acquire);
-        if self.ticks < current_ticks {
-            self.ticks += 1;
-            Poll::Ready(self.ticks)
-        } else {
-            Poll::Pending
-        }
-    }
-}
-
-pub async fn timer_task() {
-    loop {
-        next_tick().await;
-        print!(".");
-    }
-}

src/interrupts.rs

@@ -1,4 +1,4 @@
-use crate::{gdt, hlt_loop, println};
+use crate::{gdt, hlt_loop, print, println};
 use lazy_static::lazy_static;
 use pic8259_simple::ChainedPics;
 use spin;
@@ -72,8 +72,7 @@ extern "x86-interrupt" fn double_fault_handler(
 }
 
 extern "x86-interrupt" fn timer_interrupt_handler(_stack_frame: &mut InterruptStackFrame) {
-    crate::driver::timer::tick();
-
+    print!(".");
     unsafe {
         PICS.lock()
             .notify_end_of_interrupt(InterruptIndex::Timer.as_u8());
@@ -81,11 +80,28 @@ extern "x86-interrupt" fn timer_interrupt_handler(_stack_frame: &mut InterruptSt
 }
 
 extern "x86-interrupt" fn keyboard_interrupt_handler(_stack_frame: &mut InterruptStackFrame) {
+    use pc_keyboard::{layouts, DecodedKey, HandleControl, Keyboard, ScancodeSet1};
+    use spin::Mutex;
     use x86_64::instructions::port::Port;
-    let mut port = Port::new(0x60);
-    let scancode: u8 = unsafe { port.read() };
 
-    crate::driver::keyboard::keyboard_scancode(scancode);
+    lazy_static! {
+        static ref KEYBOARD: Mutex<Keyboard<layouts::Us104Key, ScancodeSet1>> = Mutex::new(
+            Keyboard::new(layouts::Us104Key, ScancodeSet1, HandleControl::Ignore)
+        );
+    }
+
+    let mut keyboard = KEYBOARD.lock();
+    let mut port = Port::new(0x60);
+
+    let scancode: u8 = unsafe { port.read() };
+    if let Ok(Some(key_event)) = keyboard.add_byte(scancode) {
+        if let Some(key) = keyboard.process_keyevent(key_event) {
+            match key {
+                DecodedKey::Unicode(character) => print!("{}", character),
+                DecodedKey::RawKey(key) => print!("{:?}", key),
+            }
+        }
+    }
 
     unsafe {
         PICS.lock()

src/lib.rs

@@ -5,10 +5,9 @@
 #![feature(alloc_error_handler)]
 #![feature(const_fn)]
 #![feature(alloc_layout_extra)]
-#![feature(wake_trait)]
 #![feature(const_in_array_repeat_expressions)]
-#![feature(type_alias_impl_trait)]
-#![feature(asm)]
+#![feature(wake_trait)]
+#![feature(async_closure)]
 #![test_runner(crate::test_runner)]
 #![reexport_test_harness_main = "test_main"]
 
@@ -17,7 +16,6 @@ extern crate alloc;
 use core::panic::PanicInfo;
 
 pub mod allocator;
-pub mod driver;
 pub mod gdt;
 pub mod interrupts;
 pub mod memory;
@@ -29,11 +27,7 @@ pub fn init() {
     gdt::init();
     interrupts::init_idt();
     unsafe { interrupts::PICS.lock().initialize() };
-}
-
-pub fn init_heap_structures() {
-    task::init();
-    driver::init();
+    x86_64::instructions::interrupts::enable();
 }
 
 pub fn test_runner(tests: &[&dyn Fn()]) {

src/main.rs

@@ -6,7 +6,6 @@
 
 extern crate alloc;
 
-use alloc::{boxed::Box, rc::Rc, vec, vec::Vec};
 use blog_os::println;
 use bootloader::{entry_point, BootInfo};
 use core::panic::PanicInfo;
@@ -16,6 +15,7 @@ entry_point!(kernel_main);
 fn kernel_main(boot_info: &'static BootInfo) -> ! {
     use blog_os::allocator;
     use blog_os::memory::{self, BootInfoFrameAllocator};
+    use blog_os::task::{simple_executor::SimpleExecutor, Task, keyboard};
     use x86_64::VirtAddr;
 
     println!("Hello World{}", "!");
@@ -26,50 +26,26 @@ fn kernel_main(boot_info: &'static BootInfo) -> ! {
     let mut frame_allocator = unsafe { BootInfoFrameAllocator::init(&boot_info.memory_map) };
 
     allocator::init_heap(&mut mapper, &mut frame_allocator).expect("heap initialization failed");
-    blog_os::init_heap_structures();
-
-    // allocate a number on the heap
-    let heap_value = Box::new(41);
-    println!("heap_value at {:p}", heap_value);
-
-    // create a dynamically sized vector
-    let mut vec = Vec::new();
-    for i in 0..500 {
-        vec.push(i);
-    }
-    println!("vec at {:p}", vec.as_slice());
-
-    // create a reference counted vector -> will be freed when count reaches 0
-    let reference_counted = Rc::new(vec![1, 2, 3]);
-    let cloned_reference = reference_counted.clone();
-    println!(
-        "current reference count is {}",
-        Rc::strong_count(&cloned_reference)
-    );
-    core::mem::drop(reference_counted);
-    println!(
-        "reference count is {} now",
-        Rc::strong_count(&cloned_reference)
-    );
-
-    use blog_os::task::executor::Executor;
-
-    let mut executor = Executor::new();
-    executor.spawn(bar());
-
-    executor.spawn(async {
-        #[cfg(test)]
-        test_main();
-    });
-
-    executor.spawn(async {
-        println!("It did not crash!");
-    });
-
-    executor.spawn(blog_os::driver::timer::timer_task());
-    executor.spawn(blog_os::driver::keyboard::keyboard_task());
 
+    let mut executor = SimpleExecutor::new();
+    executor.spawn(Task::new(example_task()));
+    executor.spawn(Task::new(keyboard::print_keypresses()));
     executor.run();
+
+    #[cfg(test)]
+    test_main();
+
+    println!("It did not crash!");
+    blog_os::hlt_loop();
+}
+
+async fn async_number() -> u32 {
+    42
+}
+
+async fn example_task() {
+    let number = async_number().await;
+    println!("async number: {}", number);
 }
 
 /// This function is called on panic.
@@ -85,15 +61,3 @@ fn panic(info: &PanicInfo) -> ! {
 fn panic(info: &PanicInfo) -> ! {
     blog_os::test_panic_handler(info)
 }
-
-async fn test() -> u32 {
-    42
-}
-
-async fn foo() -> u32 {
-    test().await * 2
-}
-
-async fn bar() {
-    println!("foo result: {}", foo().await);
-}

src/task/executor.rs

@@ -1,127 +0,0 @@
-use super::interrupt_wakeups::interrupt_wakeups;
-use crate::println;
-use alloc::{
-    boxed::Box,
-    collections::{BTreeMap, VecDeque},
-    sync::Arc,
-    task::Wake,
-};
-use core::{
-    future::Future,
-    pin::Pin,
-    task::{Context, Poll},
-};
-use crossbeam_queue::SegQueue;
-
-pub type Task = Pin<Box<dyn Future<Output = ()>>>;
-type TaskId = usize;
-
-pub struct Executor {
-    task_queue: VecDeque<Task>,
-    wake_queue: Arc<SegQueue<TaskId>>,
-    pending_tasks: BTreeMap<TaskId, Task>,
-}
-
-impl Executor {
-    pub fn new() -> Self {
-        Executor {
-            task_queue: VecDeque::new(),
-            wake_queue: Arc::new(SegQueue::new()),
-            pending_tasks: BTreeMap::new(),
-        }
-    }
-
-    pub fn spawn(&mut self, task: impl Future<Output = ()> + 'static) {
-        self.task_queue.push_back(Box::pin(task))
-    }
-
-    pub fn run(&mut self) -> ! {
-        loop {
-            self.run_ready_tasks();
-            self.apply_interrupt_wakeups();
-            self.wake_waiting_tasks();
-            self.hlt_if_idle();
-        }
-    }
-
-    fn run_ready_tasks(&mut self) {
-        while let Some(mut task) = self.task_queue.pop_front() {
-            let waker = self.create_waker(&task).into();
-            let mut context = Context::from_waker(&waker);
-            match task.as_mut().poll(&mut context) {
-                Poll::Ready(()) => {} // task done
-                Poll::Pending => {
-                    // add task to pending_tasks and wait for wakeup
-                    let task_id = Self::task_id(&task);
-                    if self.pending_tasks.insert(task_id, task).is_some() {
-                        panic!("Task with same ID already in pending_tasks");
-                    }
-                }
-            }
-        }
-    }
-
-    /// Invoke wakers for tasks woken by interrupts
-    ///
-    /// The interrupt handlers can't invoke the waker directly since wakers
-    /// might execute arbitrary code, e.g. allocate, which should not be done
-    /// in interrupt handlers to avoid deadlocks.
-    fn apply_interrupt_wakeups(&mut self) {
-        while let Ok(waker) = interrupt_wakeups().pop() {
-            waker.wake();
-        }
-    }
-
-    fn wake_waiting_tasks(&mut self) {
-        while let Ok(task_id) = self.wake_queue.pop() {
-            if let Some(task) = self.pending_tasks.remove(&task_id) {
-                self.task_queue.push_back(task);
-            } else {
-                println!("WARNING: woken task not found in pending_tasks");
-            }
-        }
-    }
-
-    /// Executes the `hlt` instruction if there are no ready tasks
-    fn hlt_if_idle(&self) {
-        if self.task_queue.is_empty() {
-            // disable interrupts to avoid races
-            x86_64::instructions::interrupts::disable();
-            // check if relevant interrupts occured since the last check
-            if interrupt_wakeups().is_empty() {
-                // no interrupts occured -> hlt to wait for next interrupt
-                x86_64::instructions::interrupts::enable_interrupts_and_hlt();
-            } else {
-                // there were some new wakeups -> continue execution
-                x86_64::instructions::interrupts::enable();
-            }
-        }
-    }
-
-    fn task_id(task: &Task) -> TaskId {
-        let future_ref: &dyn Future<Output = ()> = &**task;
-        future_ref as *const _ as *const () as usize
-    }
-
-    fn create_waker(&self, task: &Task) -> Arc<Waker> {
-        Arc::new(Waker {
-            wake_queue: self.wake_queue.clone(),
-            task_id: Self::task_id(task),
-        })
-    }
-}
-
-pub struct Waker {
-    wake_queue: Arc<SegQueue<TaskId>>,
-    task_id: TaskId,
-}
-
-impl Wake for Waker {
-    fn wake(self: Arc<Self>) {
-        self.wake_by_ref();
-    }
-
-    fn wake_by_ref(self: &Arc<Self>) {
-        self.wake_queue.push(self.task_id);
-    }
-}

src/task/interrupt_wakeups.rs

@@ -1,25 +0,0 @@
-use crate::println;
-use conquer_once::spin::OnceCell;
-use core::task::Waker;
-use crossbeam_queue::ArrayQueue;
-
-static INTERRUPT_WAKEUPS: OnceCell<ArrayQueue<Waker>> = OnceCell::uninit();
-
-pub fn init() {
-    INTERRUPT_WAKEUPS
-        .try_init_once(|| ArrayQueue::new(10))
-        .expect("failed to init interrupt wakeup queue");
-}
-
-/// Queues a waker for waking in an interrupt-safe way
-pub(crate) fn interrupt_wake(waker: Waker) {
-    if let Err(_) = interrupt_wakeups().push(waker) {
-        println!("WARNING: dropping interrupt wakeup");
-    }
-}
-
-pub(super) fn interrupt_wakeups() -> &'static ArrayQueue<Waker> {
-    INTERRUPT_WAKEUPS
-        .try_get()
-        .expect("interrupt wakeup queue not initialized")
-}

src/task/keyboard.rs

@@ -0,0 +1,52 @@
+use conquer_once::spin::OnceCell;
+use crossbeam_queue::ArrayQueue;
+use futures_util::stream::{Stream, StreamExt};
+use core::{pin::Pin, task::{Context, Poll}};
+use pc_keyboard::{layouts, DecodedKey, HandleControl, Keyboard, ScancodeSet1};
+use crate::print;
+
+static SCANCODE_QUEUE: OnceCell<ArrayQueue<u8>> = OnceCell::uninit();
+
+pub struct ScancodeStream {
+    _private: (),
+}
+
+impl ScancodeStream {
+    pub fn new() -> Self {
+        SCANCODE_QUEUE.try_init_once(|| ArrayQueue::new(100))
+            .expect("ScancodeStream::new should only be called once");
+        ScancodeStream {
+            _private: (),
+        }
+    }
+}
+
+impl Stream for ScancodeStream {
+    type Item = u8;
+
+    fn poll_next(self: Pin<&mut Self>, context: &mut Context) -> Poll<Option<u8>> {
+        let queue = SCANCODE_QUEUE
+            .try_get()
+            .expect("scancode queue not initialized");
+        match queue.pop() {
+            Ok(scancode) => Poll::Ready(Some(scancode)),
+            Err(crossbeam_queue::PopError) => Poll::Pending,
+        }
+    }
+}
+
+pub async fn print_keypresses() {
+    let mut scancodes = ScancodeStream::new();
+    let mut keyboard = Keyboard::new(layouts::Us104Key, ScancodeSet1, HandleControl::Ignore);
+
+    while let Some(scancode) = scancodes.next().await {
+        if let Ok(Some(key_event)) = keyboard.add_byte(scancode) {
+            if let Some(key) = keyboard.process_keyevent(key_event) {
+                match key {
+                    DecodedKey::Unicode(character) => print!("{}", character),
+                    DecodedKey::RawKey(key) => print!("{:?}", key),
+                }
+            }
+        }
+    }
+}

src/task/mod.rs

@@ -1,8 +1,22 @@
-pub(crate) use interrupt_wakeups::interrupt_wake;
+use alloc::boxed::Box;
+use core::task::{Context, Poll};
+use core::{future::Future, pin::Pin};
 
-pub mod executor;
-mod interrupt_wakeups;
+pub mod keyboard;
+pub mod simple_executor;
 
-pub fn init() {
-    interrupt_wakeups::init();
+pub struct Task {
+    future: Pin<Box<dyn Future<Output = ()>>>,
+}
+
+impl Task {
+    pub fn new(future: impl Future<Output = ()> + 'static) -> Task {
+        Task {
+            future: Box::pin(future),
+        }
+    }
+
+    fn poll(&mut self, context: &mut Context) -> Poll<()> {
+        self.future.as_mut().poll(context)
+    }
 }

src/task/simple_executor.rs

@@ -0,0 +1,44 @@
+use super::Task;
+use alloc::{collections::VecDeque, sync::Arc, task::Wake};
+use core::task::{Context, Poll, Waker};
+
+pub struct SimpleExecutor {
+    task_queue: VecDeque<Task>,
+}
+
+impl SimpleExecutor {
+    pub fn new() -> SimpleExecutor {
+        SimpleExecutor {
+            task_queue: VecDeque::new(),
+        }
+    }
+
+    pub fn spawn(&mut self, task: Task) {
+        self.task_queue.push_back(task)
+    }
+
+    pub fn run(&mut self) {
+        while let Some(mut task) = self.task_queue.pop_front() {
+            let waker = DummyWaker.to_waker();
+            let mut context = Context::from_waker(&waker);
+            match task.poll(&mut context) {
+                Poll::Ready(()) => {} // task done
+                Poll::Pending => self.task_queue.push_back(task),
+            }
+        }
+    }
+}
+
+struct DummyWaker;
+
+impl Wake for DummyWaker {
+    fn wake(self: Arc<Self>) {
+        // do nothing
+    }
+}
+
+impl DummyWaker {
+    fn to_waker(self) -> Waker {
+        Waker::from(Arc::new(self))
+    }
+}