Async/Await

[utterances-bot]

This is a general purpose comment thread for the Async/Await post.

[Cerber-Ursi]

The thing I was trying to wrap my head around for quite some time, thanks for so detailed explanation!

Two minor points:

1. The following code in run_ready_tasks:

if !self.waker_cache.contains_key(&task_id) {
    self.waker_cache.insert(task_id, self.create_waker(task_id));
}
let waker = self.waker_cache.get(&task_id).expect("should exist");

- why not use the Entry API instead?
2. "it's both simpler and safer to instead implement the Arc-based Wake trait" - the link on "Wake" leads to wake method on Waker - probably it should be this trait instead?

[jounathaen]

The statemachine in https://os.phil-opp.com/async-await/#the-async-await-pattern

    fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output> {
        loop {
            match self { // TODO: handle pinning
                ExampleStateMachine::Start(state) => {…}
                ExampleStateMachine::WaitingOnFooTxt(state) => {…}
                ExampleStateMachine::WaitingOnFooTxt(state) => {…}
                ExampleStateMachine::End(state) => {…}
            }
        }
    }

Contains the state ExampleStateMachine::WaitingOnFooTxt twice. Should probably be ExampleStateMachine::WaitingOnBarTxt 😉

edit: Fix in #769

[senseiod]

Excellent! Looking forward to the next article

[phil-opp]

@Cerberuser Great to hear that the post is useful to you!

• why not use the Entry API instead?

Good question! I tried using it, but it leads to borrowing errors here because we need to borrow self again for the create_waker method. Of course we could work around this, for example by destructuring self and defining the create_waker methods in a way that it only needs access to the wake_queue field. However, the variant with expect was shorter and easier to explain, so I found it the better choice for this post.

the link on "Wake" leads to wake method on Waker - probably it should be this trait instead?

Thanks for reporting! Fixed in f32ee7f.

[phil-opp]

@jounathaen Thanks for reporting and providing the fix!

[phil-opp]

@senseiod I already started working on it :).

[p2mate]

I'm surprised that on x86 you need to re-enable interrupts before doing a hlt. On cortex m you can do:
cortex_m::interrupt::free(|_| {
if self.wake_queue.is_empty() {
cortex_m::asm::wfi()
}
})

So the CPU will wake from wfi even with the interrupts disabled. Ofcourse the interrupt handler will only be executed when the interrupts are re-enabled.

[phil-opp]

@p2mate Yeah, I think the approach of ARM is definitely better. As far as I know, there is no equivalent to the wfi instruction on x86 unfortunately.

[andyx719]

thank you , it's very detailed/clear and very useful.

[AlphaHot]

Thank you very much for the detailed lesson, and I look forward to continuing.

[LordSparhawk]

There is a repetition typo: "have to have to" in the first paragraph of
Executors and Wakers

Thanks for a fascinating article.

[ghost]

Isn't the uniqueness of TaskId not be guaranteed for zero-sized futures? Box would give the same address for multiple "instances" of the zero sized type.

Edit: See this playground link for an example: https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=72f510e1edcb7657ce46becab9179977

[camorimd]

Great article! Thank you so much :)

[phil-opp]

Thank you all for the nice feedback :).

@LordSparhawk

There is a repetition typo: "have to have to" in the first paragraph of Executors and Wakers

Thanks for reporting! Fixed in b6d09c8.

[phil-opp]

@ZoeyR

Isn't the uniqueness of TaskId not be guaranteed for zero-sized futures? Box would give the same address for multiple "instances" of the zero sized type.

Very good catch! While zero-sized futures are rare in practice, we should still ensure that they can be used without problems. I opened #782 and #783 to create task IDs using a static counter instead.

[sytzemeijer]

Please write on

[sinjenda]

will there be a new post?

[phil-opp]

I'm currently working on a new third edition of the blog with UEFI and framebuffer support. So yes, there will be new content, but I don't know when it will be ready.

[Joelcgx]

How do I remove the dots that appear when launching the kernel?

[phil-opp]

These are from the timer interrupt handler. Just remove this print! call:

blog_os/src/interrupts.rs

Line 75 in c9cdf56

print!(".");

[Portgas-D-Asce]

ddd

[Croug]

Just a quick note, the OnceCell struct is now included at core::cell::OnceCell

[Croug]

Actually looks like they've split it into thread safe and non thread safe, the thread safe version is called OnceLock

[Croug]

and I suppose I should've tried it before commenting because it seems that OnceLock isn't available in core, only in std.

[ebkalderon]

Yeah, it seems that conquer_once::OnceCell is more akin to std::sync::OnceLock, except that conquer_once::OnceCell works with #![no_std]. On the other hand, std::sync::OnceLock relies on std::sync::Once, which in turn depends on an operating system.

[sampathsris]

Not sure if anyone's still following this post, but turns out after making the changes in this post, cargo test would hang. The reason obviously is that executor.run() never returns, so test_main() which is the line immediately after that is unreachable code (So is the println and the hlt_loop).

To fix this what I did was:

// main.rs
#[cfg(test)]
async fn invoke_test_main() {
    test_main();
}

pub fn kernel_main(boot_info: &'static BootInfo) -> ! {
    // ....
    #[cfg(test)] // new
    executor.spawn(Task::new(invoke_test_main())); // new

    // this will be the returning expression in kernel_main (note the missing semicolon)
    executor.run()
}

[yijun-tang]

// in src/main.rs

use blog_os::task::executor::Executor; // new

fn kernel_main(boot_info: &'static BootInfo) -> ! {
    // […] initialization routines, including init_heap, test_main

    let mut executor = Executor::new(); // new
    executor.spawn(Task::new(example_task()));
    executor.spawn(Task::new(keyboard::print_keypresses()));
    executor.run();
}

Actually, author moved the test_main above the executor though.

[ebkalderon]

Small correction:

this would never happen since our keyboard_task never finishes

No such async keyboard_task was ever mentioned before. I presume you instead meant to write here:

this would never happen since our keyboard::print_keypresses() task never finishes

[phil-opp]

Yes, should be keyboard::print_keypresses(). Do you want to create a PR for this? The post is rendered from this file: https://github.com/phil-opp/blog_os/blob/main/blog/content/edition-2/posts/12-async-await/index.md

[ebkalderon]

Sure, I can open a PR! Thanks for the guidance, and awesome blog BTW. ❤️

[phil-opp]

Thanks!

[ebkalderon]

It's about 2 years late, but I finally got around to opening a PR for this! 🫣 #1452

[yijun-tang]

Since our ScancodeStream implementation registers wakers before checking whether a task needs to be put to sleep, it might happen that a wake-up occurs for a task that no longer exists.

Is there anyone can help me understand this sentence?

[phil-opp]

We call WAKER.register(&cx.waker()) before calling queue.pop(). If the queue isn't empty, the task can continue and doesn't need to be woken. So we call WAKER.take() in that case to remove the registered waker again. However, when the user presses a key in between the register and take calls, we instruct the executor to wake up the task, which was never paused. In that case, the executor doesn't find the corresponding task because it's still running. In that case, we simply ignore the wake up signal in the executor.

[yijun-tang]

Thanks for your detailed explanation!

[MatthewG4mz3r]

are you going to continue the blog?

[tpdenk]

Yes, see #979 #1025 #1063 #1279 (and probably more).

[GCPanic]

Considering we now using async, is it worthy to use tracing for logging? Or is tracing is too hard to implement or too expensive to using in kernel space?

[matveitolochko]

You may, but I would refrain from using it. I prefer something lighter.

[Aria-iu]

make it too fast, can't say a good or bad idea

[ChocolateLoverRaj]

What about instead of making an executor which executes multiple futures, there was an executor which executed a single future, and then main.rs can use join to join as many futures as it wants to run "in parallel"?

[tpdenk]

For that you wouldn't even need an executor. You can do a join! loop (join! is unstable right now though) to drive the futures to completion. (Read: you are 100% right, this could be done).

However, you probably need more than a handful of futures to join at some point, or you want recovery in case one crashes. So you'll implement create functions for your futures, create recovery points, create a join! loop, and before you know it, you've built a scheduler in your main function. Better to have a clean design beforehand.

Thing is, an executor can be really simple like this one (which can be enough for your use case), or can be really complex like tokio or maitake.
This allows you to have powerful scheduling algorithms hidden behind an interface that comes from core, which is awesome IMO.

Edit: Oh and also you would be limited to a single thread. When creating an executor, you can make it Send or even Sync and have multiple threads (dynamically even) drive it.

[Mrgoblings]

Hello, and Happy New Year!

Thank you for the amazing article—it’s incredibly useful!

I was wondering if anyone could provide some guidance on implementing a framebuffer on top of the current implementation. I’ve read about the possibility of using two buffers and swapping them to switch between frames, but I’m unsure if this approach is valid or optimal.

Any advice or suggestions would be greatly appreciated.

[viktorpopp]

When is the next edition planned to release and what are the major changes? Is it easily to migrate from @phil-opp ?

[ChocolateLoverRaj]

You can already take a look at the first posts of edition 3. With edition 3 + edition 2 posts, you can get to the end of edition 2 with UEFI support!

[BindraAgamjot256]

first posts of edition 3

Where are the posts available? On the GitHub repository?

[tpdenk]

Yes, the edition-3 branch

[zen-zap]

Is there any update on when the new posts are gonna come out? This is a great series!❤️

I searched the edition-3 branch and threads branch. I did find some posts but I don't think they are in order or something. Should I try filling in the blanks myself? .. I just started out so I don't really have any idea. Can anyone help ?

[bjoernp116]

I agree! Just found this blog the other day. Loved it!
Sad to see it discontinued though...
You should probably check out the OSDev Wiki for more information, it is less hands-on, but if you read about it, and research the different topics, it will probably put you in the right direction!

[ChocolateLoverRaj]

Sad to see it discontinued though...

It's not

[JohnDowson]

Sad to see it discontinued though...

It's not

If your standard for being discontinued is "the author came out and said it is discontinued", sure

[ChocolateLoverRaj]

@zen-zap if you want to, you can follow my tutorial: https://github.com/ChocolateLoverRaj/rust-os-tutorial

[zen-zap]

@zen-zap if you want to, you can follow my tutorial: https://github.com/ChocolateLoverRaj/rust-os-tutorial

Thanks! I can see some new stuff. I'll definitely go through this. On my side, I went through OSTEP and tried making the file system. Not finished tho, not enough time :(