Compare commits

..

4 Commits

Author SHA1 Message Date
Philipp Oppermann
ca8cd46863 Update 2020-03-22 11:58:16 +01:00
Philipp Oppermann
816f8746fb Implement a ScancodeStream type 2020-03-20 14:14:45 +01:00
Philipp Oppermann
255982a8b7 Implement scancode queue 2020-03-20 13:03:41 +01:00
Philipp Oppermann
f885f17b70 Implement a simple poll-loop executor 2020-03-19 16:46:37 +01:00
26 changed files with 366 additions and 551 deletions

5
.cargo/config Normal file
View File

@@ -0,0 +1,5 @@
[build]
target = "x86_64-blog_os.json"
[target.'cfg(target_os = "none")']
runner = "bootimage runner"

View File

@@ -1,9 +0,0 @@
[unstable]
build-std = ["core", "compiler_builtins", "alloc"]
build-std-features = ["compiler-builtins-mem"]
[build]
target = "x86_64-blog_os.json"
[target.'cfg(target_os = "none")']
runner = "bootimage runner"

96
.github/workflows/build-code.yml vendored Normal file
View File

@@ -0,0 +1,96 @@
name: Build Code
on:
push:
branches:
- '*'
- '!staging.tmp'
tags:
- '*'
schedule:
- cron: '40 3 * * *' # every day at 3:40
pull_request:
jobs:
test:
name: "Test"
strategy:
matrix:
platform: [
ubuntu-latest,
macos-latest,
windows-latest
]
runs-on: ${{ matrix.platform }}
timeout-minutes: 15
steps:
- name: "Checkout Repository"
uses: actions/checkout@v1
- name: Install Rustup
run: |
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain nightly
echo ::add-path::$HOME/.cargo/bin
if: runner.os == 'macOS'
- name: "Print Rust Version"
run: |
rustc -Vv
cargo -Vv
- name: "Install Rustup Components"
run: rustup component add rust-src llvm-tools-preview
- name: "Install cargo-xbuild"
run: cargo install cargo-xbuild --debug
- name: "Install bootimage"
run: cargo install bootimage --debug
- name: "Run cargo xbuild"
run: cargo xbuild
- name: "Create Bootimage"
run: cargo bootimage
# install QEMU
- name: Install QEMU (Linux)
run: sudo apt update && sudo apt install qemu-system-x86
if: runner.os == 'Linux'
- name: Install QEMU (macOS)
run: brew install qemu
if: runner.os == 'macOS'
env:
HOMEBREW_NO_AUTO_UPDATE: 1
HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK: 1
HOMEBREW_NO_INSTALL_CLEANUP: 1
- name: Install Scoop (Windows)
run: |
Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://get.scoop.sh')
echo ::add-path::$HOME\scoop\shims
if: runner.os == 'Windows'
shell: pwsh
- name: Install QEMU (Windows)
run: scoop install qemu
if: runner.os == 'Windows'
shell: pwsh
- name: "Print QEMU Version"
run: qemu-system-x86_64 --version
- name: "Run cargo xtest"
run: cargo xtest
check_formatting:
name: "Check Formatting"
runs-on: ubuntu-latest
timeout-minutes: 2
steps:
- uses: actions/checkout@v1
- name: "Use the latest Rust nightly with rustfmt"
uses: actions-rs/toolchain@v1
with:
toolchain: nightly
profile: minimal
components: rustfmt
override: true
- run: cargo fmt -- --check

View File

@@ -1,130 +0,0 @@
name: Code
on:
push:
branches:
- '*'
- '!staging.tmp'
tags:
- '*'
schedule:
- cron: '40 3 * * *' # every day at 3:40
pull_request:
workflow_dispatch:
jobs:
check:
name: Check
strategy:
fail-fast: false
matrix:
platform: [
ubuntu-latest,
macos-latest,
windows-latest
]
runs-on: ${{ matrix.platform }}
steps:
- name: Checkout Repository
uses: actions/checkout@v2
- name: Install Rust Toolchain
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
- name: Install `rust-src` Rustup Component
run: rustup component add rust-src
- name: Run `cargo check`
uses: actions-rs/cargo@v1
with:
command: check
test:
name: Test
strategy:
fail-fast: false
matrix:
platform: [
ubuntu-latest,
macos-latest,
windows-latest
]
runs-on: ${{ matrix.platform }}
steps:
- name: Install Rust Toolchain
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
- name: Install bootimage
run: cargo install bootimage --debug
- name: Checkout Repository
uses: actions/checkout@v2
- name: Install Rustup Components
run: rustup component add rust-src llvm-tools-preview
- name: Run `cargo bootimage`
uses: actions-rs/cargo@v1
with:
command: bootimage
# install QEMU
- name: Install QEMU (Linux)
run: sudo apt update && sudo apt install qemu-system-x86
if: runner.os == 'Linux'
- name: Install QEMU (macOS)
run: brew install qemu
if: runner.os == 'macOS'
env:
HOMEBREW_NO_AUTO_UPDATE: 1
HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK: 1
HOMEBREW_NO_INSTALL_CLEANUP: 1
- name: Install QEMU (Windows)
run: |
choco install qemu --version 2021.5.5
echo "$Env:Programfiles\qemu" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
if: runner.os == 'Windows'
shell: pwsh
- name: "Print QEMU Version"
run: qemu-system-x86_64 --version
- name: Run `cargo test`
uses: actions-rs/cargo@v1
with:
command: test
check_formatting:
name: Check Formatting
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v2
- name: Install Rust Toolchain
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
components: rustfmt
override: true
- name: Run `cargo fmt`
uses: actions-rs/cargo@v1
with:
command: fmt
args: --all -- --check
clippy:
name: Clippy
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v2
- name: Install Rust Toolchain
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
components: clippy, rust-src
override: true
- name: Run `cargo clippy`
uses: actions-rs/cargo@v1
with:
command: clippy

154
Cargo.lock generated
View File

@@ -1,30 +1,22 @@
# This file is automatically @generated by Cargo. # This file is automatically @generated by Cargo.
# It is not intended for manual editing. # It is not intended for manual editing.
version = 4
[[package]] [[package]]
name = "autocfg" name = "autocfg"
version = "1.5.0" version = "1.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8" checksum = "f8aac770f1885fd7e387acedd76065302551364496e46b3dd00860b2f8359b9d"
[[package]] [[package]]
name = "bit_field" name = "bit_field"
version = "0.10.2" version = "0.9.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "dc827186963e592360843fb5ba4b973e145841266c1357f7180c43526f2e5b61" checksum = "ed8765909f9009617974ab6b7d332625b320b33c326b1e9321382ef1999b5d56"
[[package]] [[package]]
name = "bitflags" name = "bitflags"
version = "1.3.2" version = "1.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" checksum = "cf1de2fe8c75bc145a2f577add951f8134889b4795d47466a54a5c846d691693"
[[package]]
name = "bitflags"
version = "2.9.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6a65b545ab31d687cff52899d4890855fec459eb6afe0da6417b8a18da87aa29"
[[package]] [[package]]
name = "blog_os" name = "blog_os"
@@ -37,24 +29,28 @@ dependencies = [
"lazy_static", "lazy_static",
"linked_list_allocator", "linked_list_allocator",
"pc-keyboard", "pc-keyboard",
"pic8259", "pic8259_simple",
"spin 0.5.2", "spin",
"uart_16550", "uart_16550",
"volatile 0.2.7", "volatile",
"x86_64", "x86_64",
] ]
[[package]] [[package]]
name = "bootloader" name = "bootloader"
version = "0.9.33" version = "0.8.8"
[[package]]
name = "cfg-if"
version = "0.1.10"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7bdfddac270bbdd45903296bc1caf29a7fdce6b326aaf0bbab7f04c5f98b7447" checksum = "4785bdd1c96b2a846b2bd7cc02e86b6b3dbf14e7e53446c4f54c92a361040822"
[[package]] [[package]]
name = "conquer-once" name = "conquer-once"
version = "0.2.1" version = "0.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "96eb12fb69466716fbae9009d389e6a30830ae8975e170eff2d2cff579f9efa3" checksum = "6f7644600a548ecad74e4a918392af1798f7dd045be610be3203b9e129b4f98f"
dependencies = [ dependencies = [
"conquer-util", "conquer-util",
] ]
@@ -66,110 +62,107 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "654fb2472cc369d311c547103a1fa81d467bef370ae7a0680f65939895b1182a" checksum = "654fb2472cc369d311c547103a1fa81d467bef370ae7a0680f65939895b1182a"
[[package]] [[package]]
name = "crossbeam-queue" name = "cpuio"
version = "0.3.12" version = "0.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0f58bbc28f91df819d0aa2a2c00cd19754769c2fad90579b3592b1c9ba7a3115" checksum = "22b8e308ccfc5acf3b82f79c0eac444cf6114cb2ac67a230ca6c177210068daa"
[[package]]
name = "crossbeam-queue"
version = "0.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c695eeca1e7173472a32221542ae469b3e9aac3a4fc81f7696bcad82029493db"
dependencies = [ dependencies = [
"cfg-if",
"crossbeam-utils", "crossbeam-utils",
] ]
[[package]] [[package]]
name = "crossbeam-utils" name = "crossbeam-utils"
version = "0.8.21" version = "0.7.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28" checksum = "c3c7c73a2d1e9fc0886a08b93e98eb643461230d5f1925e4036204d5f2e261a8"
dependencies = [
"autocfg",
"cfg-if",
]
[[package]] [[package]]
name = "futures-core" name = "futures-core"
version = "0.3.31" version = "0.3.4"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "05f29059c0c2090612e8d742178b0580d2dc940c837851ad723096f87af6663e" checksum = "f25592f769825e89b92358db00d26f965761e094951ac44d3663ef25b7ac464a"
[[package]] [[package]]
name = "futures-task" name = "futures-task"
version = "0.3.31" version = "0.3.4"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f90f7dce0722e95104fcb095585910c0977252f286e354b5e3bd38902cd99988" checksum = "7b0a34e53cf6cdcd0178aa573aed466b646eb3db769570841fda0c7ede375a27"
[[package]] [[package]]
name = "futures-util" name = "futures-util"
version = "0.3.31" version = "0.3.4"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9fa08315bb612088cc391249efdc3bc77536f16c91f6cf495e6fbe85b20a4a81" checksum = "22766cf25d64306bedf0384da004d05c9974ab104fcc4528f1236181c18004c5"
dependencies = [ dependencies = [
"futures-core", "futures-core",
"futures-task", "futures-task",
"pin-project-lite",
"pin-utils", "pin-utils",
] ]
[[package]] [[package]]
name = "lazy_static" name = "lazy_static"
version = "1.5.0" version = "1.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe" checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
dependencies = [ dependencies = [
"spin 0.9.8", "spin",
] ]
[[package]] [[package]]
name = "linked_list_allocator" name = "linked_list_allocator"
version = "0.9.1" version = "0.8.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "549ce1740e46b291953c4340adcd74c59bcf4308f4cac050fd33ba91b7168f4a" checksum = "18c618c431dfe4419afbe22852f6aceffbc17bd82ba0a18b982def291000824c"
dependencies = [ dependencies = [
"spinning_top", "spinning_top",
] ]
[[package]] [[package]]
name = "lock_api" name = "lock_api"
version = "0.4.13" version = "0.3.3"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "96936507f153605bddfcda068dd804796c84324ed2510809e5b2a624c81da765" checksum = "79b2de95ecb4691949fea4716ca53cdbcfccb2c612e19644a8bad05edcf9f47b"
dependencies = [ dependencies = [
"autocfg",
"scopeguard", "scopeguard",
] ]
[[package]] [[package]]
name = "pc-keyboard" name = "pc-keyboard"
version = "0.7.0" version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ed089a1fbffe3337a1a345501c981f1eb1e47e69de5a40e852433e12953c3174" checksum = "c48392db76c4e9a69e0b3be356c5f97ebb7b14413c5e4fd0af4755dbf86e2fce"
[[package]] [[package]]
name = "pic8259" name = "pic8259_simple"
version = "0.10.4" version = "0.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "cb844b5b01db1e0b17938685738f113bfc903846f18932b378bc0eabfa40e194" checksum = "dc64b2fd10828da8521b6cdabe0679385d7d2a3a6d4c336b819d1fa31ba35c72"
dependencies = [ dependencies = [
"x86_64", "cpuio",
] ]
[[package]]
name = "pin-project-lite"
version = "0.2.16"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3b3cff922bd51709b605d9ead9aa71031d81447142d828eb4a6eba76fe619f9b"
[[package]] [[package]]
name = "pin-utils" name = "pin-utils"
version = "0.1.0" version = "0.1.0-alpha.4"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184" checksum = "5894c618ce612a3fa23881b152b608bafb8c56cfc22f434a3ba3120b40f7b587"
[[package]]
name = "rustversion"
version = "1.0.22"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
[[package]] [[package]]
name = "scopeguard" name = "scopeguard"
version = "1.2.0" version = "1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" checksum = "d29ab0c6d3fc0ee92fe66e2d99f700eab17a8d57d1c1d3b748380fb20baa78cd"
[[package]] [[package]]
name = "spin" name = "spin"
@@ -177,52 +170,37 @@ version = "0.5.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d" checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d"
[[package]]
name = "spin"
version = "0.9.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6980e8d7511241f8acf4aebddbb1ff938df5eebe98691418c4468d0b72a96a67"
[[package]] [[package]]
name = "spinning_top" name = "spinning_top"
version = "0.2.5" version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5b9eb1a2f4c41445a3a0ff9abc5221c5fcd28e1f13cd7c0397706f9ac938ddb0" checksum = "32d801a3a53bcf5071f85fef8d5cab9e5f638fc5580a37e6eb7aba4b37438d24"
dependencies = [ dependencies = [
"lock_api", "lock_api",
] ]
[[package]] [[package]]
name = "uart_16550" name = "uart_16550"
version = "0.2.19" version = "0.2.4"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "614ff2a87880d4bd4374722268598a970bbad05ced8bf630439417347254ab2e" checksum = "d44b0f30cb82b0fbc15b78ade1064226529ad52028bc8cb8accb98ff6f3d7131"
dependencies = [ dependencies = [
"bitflags 1.3.2", "bitflags",
"rustversion",
"x86_64", "x86_64",
] ]
[[package]] [[package]]
name = "volatile" name = "volatile"
version = "0.2.7" version = "0.2.6"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f6b06ad3ed06fef1713569d547cdbdb439eafed76341820fb0e0344f29a41945" checksum = "6af0edf5b4faacc31fc51159244d78d65ec580f021afcef7bd53c04aeabc7f29"
[[package]]
name = "volatile"
version = "0.4.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "442887c63f2c839b346c192d047a7c87e73d0689c9157b00b53dcc27dd5ea793"
[[package]] [[package]]
name = "x86_64" name = "x86_64"
version = "0.14.13" version = "0.9.6"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c101112411baafbb4bf8d33e4c4a80ab5b02d74d2612331c61e8192fc9710491" checksum = "4206b60c9f99766329b66962aa8ddc01df6c7edd02edc046b7a69d5df9fcdbcf"
dependencies = [ dependencies = [
"bit_field", "bit_field",
"bitflags 2.9.2", "bitflags",
"rustversion",
"volatile 0.4.6",
] ]

View File

@@ -2,7 +2,7 @@
name = "blog_os" name = "blog_os"
version = "0.1.0" version = "0.1.0"
authors = ["Philipp Oppermann <dev@phil-opp.com>"] authors = ["Philipp Oppermann <dev@phil-opp.com>"]
edition = "2024" edition = "2018"
[[test]] [[test]]
name = "should_panic" name = "should_panic"
@@ -13,26 +13,21 @@ name = "stack_overflow"
harness = false harness = false
[dependencies] [dependencies]
bootloader = { version = "0.9", features = ["map_physical_memory"] } bootloader = { version = "0.8.0", features = ["map_physical_memory"]}
volatile = "0.2.6" volatile = "0.2.6"
spin = "0.5.2" spin = "0.5.2"
x86_64 = "0.14.2" x86_64 = "0.9.6"
uart_16550 = "0.2.0" uart_16550 = "0.2.0"
pic8259 = "0.10.1" pic8259_simple = "0.1.1"
pc-keyboard = "0.7.0" pc-keyboard = "0.5.0"
linked_list_allocator = "0.9.0" linked_list_allocator = "0.8.0"
[dependencies.lazy_static] [dependencies.lazy_static]
version = "1.0" version = "1.0"
features = ["spin_no_std"] features = ["spin_no_std"]
[[bin]]
name = "blog_os"
test = true
bench = false
[dependencies.crossbeam-queue] [dependencies.crossbeam-queue]
version = "0.3.11" version = "0.2.1"
default-features = false default-features = false
features = ["alloc"] features = ["alloc"]
@@ -43,15 +38,11 @@ default-features = false
[dependencies.futures-util] [dependencies.futures-util]
version = "0.3.4" version = "0.3.4"
default-features = false default-features = false
features = ["alloc"] features = ["alloc", "async-await"]
[package.metadata.bootimage] [package.metadata.bootimage]
test-args = [ test-args = [
"-device", "-device", "isa-debug-exit,iobase=0xf4,iosize=0x04", "-serial", "stdio",
"isa-debug-exit,iobase=0xf4,iosize=0x04", "-display", "none"
"-serial",
"stdio",
"-display",
"none",
] ]
test-success-exit-code = 33 # (0x10 << 1) | 1 test-success-exit-code = 33 # (0x10 << 1) | 1

View File

@@ -1,32 +1,28 @@
# Blog OS (Async/Await) # Blog OS (Heap Allocation)
[![Build Status](https://github.com/phil-opp/blog_os/workflows/Code/badge.svg?branch=post-12)](https://github.com/phil-opp/blog_os/actions?query=workflow%3A%22Code%22+branch%3Apost-12) [![Build Status](https://github.com/phil-opp/blog_os/workflows/Build%20Code/badge.svg?branch=post-10)](https://github.com/phil-opp/blog_os/actions?query=workflow%3A%22Build+Code%22+branch%3Apost-10)
This repository contains the source code for the [Async/Await][post] post of the [Writing an OS in Rust](https://os.phil-opp.com) series. This repository contains the source code for the [Heap Allocation][post] post of the [Writing an OS in Rust](https://os.phil-opp.com) series.
[post]: https://os.phil-opp.com/async-await/ [post]: https://os.phil-opp.com/heap-allocation/
**Check out the [master branch](https://github.com/phil-opp/blog_os) for more information.** **Check out the [master branch](https://github.com/phil-opp/blog_os) for more information.**
## Building ## Building
This project requires a nightly version of Rust because it uses some unstable features. At least nightly _2020-07-15_ is required for building. You might need to run `rustup update nightly --force` to update to the latest nightly even if some components such as `rustfmt` are missing it. You need a nightly Rust compiler. First you need to install the `cargo-xbuild` and `bootimage` tools:
You can build the project by running:
``` ```
cargo build cargo install cargo-xbuild bootimage
``` ```
To create a bootable disk image from the compiled kernel, you need to install the [`bootimage`] tool: Then you can build the project by running:
[`bootimage`]: https://github.com/rust-osdev/bootimage
``` ```
cargo install bootimage cargo xbuild
``` ```
After installing, you can create the bootable disk image by running: To create a bootable disk image, run:
``` ```
cargo bootimage cargo bootimage
@@ -43,10 +39,10 @@ You can run the disk image in [QEMU] through:
[QEMU]: https://www.qemu.org/ [QEMU]: https://www.qemu.org/
``` ```
cargo run cargo xrun
``` ```
[QEMU] and the [`bootimage`] tool need to be installed for this. Of course [QEMU] needs to be installed for this.
You can also write the image to an USB stick for booting it on a real machine. On Linux, the command for this is: You can also write the image to an USB stick for booting it on a real machine. On Linux, the command for this is:

View File

@@ -2,10 +2,10 @@ use alloc::alloc::{GlobalAlloc, Layout};
use core::ptr::null_mut; use core::ptr::null_mut;
use fixed_size_block::FixedSizeBlockAllocator; use fixed_size_block::FixedSizeBlockAllocator;
use x86_64::{ use x86_64::{
VirtAddr,
structures::paging::{ structures::paging::{
FrameAllocator, Mapper, Page, PageTableFlags, Size4KiB, mapper::MapToError, mapper::MapToError, FrameAllocator, Mapper, Page, PageTableFlags, Size4KiB,
}, },
VirtAddr,
}; };
pub mod bump; pub mod bump;
@@ -35,7 +35,7 @@ pub fn init_heap(
.allocate_frame() .allocate_frame()
.ok_or(MapToError::FrameAllocationFailed)?; .ok_or(MapToError::FrameAllocationFailed)?;
let flags = PageTableFlags::PRESENT | PageTableFlags::WRITABLE; let flags = PageTableFlags::PRESENT | PageTableFlags::WRITABLE;
unsafe { mapper.map_to(page, frame, flags, frame_allocator)?.flush() }; mapper.map_to(page, frame, flags, frame_allocator)?.flush();
} }
unsafe { unsafe {

View File

@@ -1,4 +1,4 @@
use super::{Locked, align_up}; use super::{align_up, Locked};
use alloc::alloc::{GlobalAlloc, Layout}; use alloc::alloc::{GlobalAlloc, Layout};
use core::ptr; use core::ptr;

View File

@@ -31,9 +31,8 @@ pub struct FixedSizeBlockAllocator {
impl FixedSizeBlockAllocator { impl FixedSizeBlockAllocator {
/// Creates an empty FixedSizeBlockAllocator. /// Creates an empty FixedSizeBlockAllocator.
pub const fn new() -> Self { pub const fn new() -> Self {
const EMPTY: Option<&'static mut ListNode> = None;
FixedSizeBlockAllocator { FixedSizeBlockAllocator {
list_heads: [EMPTY; BLOCK_SIZES.len()], list_heads: [None; BLOCK_SIZES.len()],
fallback_allocator: linked_list_allocator::Heap::empty(), fallback_allocator: linked_list_allocator::Heap::empty(),
} }
} }
@@ -44,10 +43,8 @@ impl FixedSizeBlockAllocator {
/// heap bounds are valid and that the heap is unused. This method must be /// heap bounds are valid and that the heap is unused. This method must be
/// called only once. /// called only once.
pub unsafe fn init(&mut self, heap_start: usize, heap_size: usize) { pub unsafe fn init(&mut self, heap_start: usize, heap_size: usize) {
unsafe {
self.fallback_allocator.init(heap_start, heap_size); self.fallback_allocator.init(heap_start, heap_size);
} }
}
/// Allocates using the fallback allocator. /// Allocates using the fallback allocator.
fn fallback_alloc(&mut self, layout: Layout) -> *mut u8 { fn fallback_alloc(&mut self, layout: Layout) -> *mut u8 {
@@ -93,17 +90,13 @@ unsafe impl GlobalAlloc for Locked<FixedSizeBlockAllocator> {
assert!(mem::size_of::<ListNode>() <= BLOCK_SIZES[index]); assert!(mem::size_of::<ListNode>() <= BLOCK_SIZES[index]);
assert!(mem::align_of::<ListNode>() <= BLOCK_SIZES[index]); assert!(mem::align_of::<ListNode>() <= BLOCK_SIZES[index]);
let new_node_ptr = ptr as *mut ListNode; let new_node_ptr = ptr as *mut ListNode;
unsafe {
new_node_ptr.write(new_node); new_node_ptr.write(new_node);
allocator.list_heads[index] = Some(&mut *new_node_ptr); allocator.list_heads[index] = Some(&mut *new_node_ptr);
} }
}
None => { None => {
let ptr = NonNull::new(ptr).unwrap(); let ptr = NonNull::new(ptr).unwrap();
unsafe {
allocator.fallback_allocator.deallocate(ptr, layout); allocator.fallback_allocator.deallocate(ptr, layout);
} }
} }
} }
} }
}

View File

@@ -1,4 +1,4 @@
use super::{Locked, align_up}; use super::{align_up, Locked};
use alloc::alloc::{GlobalAlloc, Layout}; use alloc::alloc::{GlobalAlloc, Layout};
use core::{mem, ptr}; use core::{mem, ptr};
@@ -39,25 +39,21 @@ impl LinkedListAllocator {
/// heap bounds are valid and that the heap is unused. This method must be /// heap bounds are valid and that the heap is unused. This method must be
/// called only once. /// called only once.
pub unsafe fn init(&mut self, heap_start: usize, heap_size: usize) { pub unsafe fn init(&mut self, heap_start: usize, heap_size: usize) {
unsafe {
self.add_free_region(heap_start, heap_size); self.add_free_region(heap_start, heap_size);
} }
}
/// Adds the given memory region to the front of the list. /// Adds the given memory region to the front of the list.
unsafe fn add_free_region(&mut self, addr: usize, size: usize) { unsafe fn add_free_region(&mut self, addr: usize, size: usize) {
// ensure that the freed region is capable of holding ListNode // ensure that the freed region is capable of holding ListNode
assert_eq!(align_up(addr, mem::align_of::<ListNode>()), addr); assert!(align_up(addr, mem::align_of::<ListNode>()) == addr);
assert!(size >= mem::size_of::<ListNode>()); assert!(size >= mem::size_of::<ListNode>());
// create a new list node and append it at the start of the list // create a new list node and append it at the start of the list
let mut node = ListNode::new(size); let mut node = ListNode::new(size);
node.next = self.head.next.take(); node.next = self.head.next.take();
let node_ptr = addr as *mut ListNode; let node_ptr = addr as *mut ListNode;
unsafe {
node_ptr.write(node); node_ptr.write(node);
self.head.next = Some(&mut *node_ptr); self.head.next = Some(&mut *node_ptr)
}
} }
/// Looks for a free region with the given size and alignment and removes /// Looks for a free region with the given size and alignment and removes
@@ -132,10 +128,8 @@ unsafe impl GlobalAlloc for Locked<LinkedListAllocator> {
let alloc_end = alloc_start.checked_add(size).expect("overflow"); let alloc_end = alloc_start.checked_add(size).expect("overflow");
let excess_size = region.end_addr() - alloc_end; let excess_size = region.end_addr() - alloc_end;
if excess_size > 0 { if excess_size > 0 {
unsafe {
allocator.add_free_region(alloc_end, excess_size); allocator.add_free_region(alloc_end, excess_size);
} }
}
alloc_start as *mut u8 alloc_start as *mut u8
} else { } else {
ptr::null_mut() ptr::null_mut()
@@ -146,6 +140,6 @@ unsafe impl GlobalAlloc for Locked<LinkedListAllocator> {
// perform layout adjustments // perform layout adjustments
let (size, _) = LinkedListAllocator::size_align(layout); let (size, _) = LinkedListAllocator::size_align(layout);
unsafe { self.lock().add_free_region(ptr as usize, size) } self.lock().add_free_region(ptr as usize, size)
} }
} }

View File

@@ -1,7 +1,7 @@
use lazy_static::lazy_static; use lazy_static::lazy_static;
use x86_64::VirtAddr;
use x86_64::structures::gdt::{Descriptor, GlobalDescriptorTable, SegmentSelector}; use x86_64::structures::gdt::{Descriptor, GlobalDescriptorTable, SegmentSelector};
use x86_64::structures::tss::TaskStateSegment; use x86_64::structures::tss::TaskStateSegment;
use x86_64::VirtAddr;
pub const DOUBLE_FAULT_IST_INDEX: u16 = 0; pub const DOUBLE_FAULT_IST_INDEX: u16 = 0;
@@ -9,10 +9,10 @@ lazy_static! {
static ref TSS: TaskStateSegment = { static ref TSS: TaskStateSegment = {
let mut tss = TaskStateSegment::new(); let mut tss = TaskStateSegment::new();
tss.interrupt_stack_table[DOUBLE_FAULT_IST_INDEX as usize] = { tss.interrupt_stack_table[DOUBLE_FAULT_IST_INDEX as usize] = {
const STACK_SIZE: usize = 4096 * 5; const STACK_SIZE: usize = 4096;
static mut STACK: [u8; STACK_SIZE] = [0; STACK_SIZE]; static mut STACK: [u8; STACK_SIZE] = [0; STACK_SIZE];
let stack_start = VirtAddr::from_ptr(&raw const STACK); let stack_start = VirtAddr::from_ptr(unsafe { &STACK });
let stack_end = stack_start + STACK_SIZE; let stack_end = stack_start + STACK_SIZE;
stack_end stack_end
}; };
@@ -41,12 +41,12 @@ struct Selectors {
} }
pub fn init() { pub fn init() {
use x86_64::instructions::segmentation::{CS, Segment}; use x86_64::instructions::segmentation::set_cs;
use x86_64::instructions::tables::load_tss; use x86_64::instructions::tables::load_tss;
GDT.0.load(); GDT.0.load();
unsafe { unsafe {
CS::set_reg(GDT.1.code_selector); set_cs(GDT.1.code_selector);
load_tss(GDT.1.tss_selector); load_tss(GDT.1.tss_selector);
} }
} }

View File

@@ -1,6 +1,6 @@
use crate::{gdt, hlt_loop, print, println}; use crate::{gdt, hlt_loop, print, println};
use lazy_static::lazy_static; use lazy_static::lazy_static;
use pic8259::ChainedPics; use pic8259_simple::ChainedPics;
use spin; use spin;
use x86_64::structures::idt::{InterruptDescriptorTable, InterruptStackFrame, PageFaultErrorCode}; use x86_64::structures::idt::{InterruptDescriptorTable, InterruptStackFrame, PageFaultErrorCode};
@@ -47,12 +47,12 @@ pub fn init_idt() {
IDT.load(); IDT.load();
} }
extern "x86-interrupt" fn breakpoint_handler(stack_frame: InterruptStackFrame) { extern "x86-interrupt" fn breakpoint_handler(stack_frame: &mut InterruptStackFrame) {
println!("EXCEPTION: BREAKPOINT\n{:#?}", stack_frame); println!("EXCEPTION: BREAKPOINT\n{:#?}", stack_frame);
} }
extern "x86-interrupt" fn page_fault_handler( extern "x86-interrupt" fn page_fault_handler(
stack_frame: InterruptStackFrame, stack_frame: &mut InterruptStackFrame,
error_code: PageFaultErrorCode, error_code: PageFaultErrorCode,
) { ) {
use x86_64::registers::control::Cr2; use x86_64::registers::control::Cr2;
@@ -65,13 +65,13 @@ extern "x86-interrupt" fn page_fault_handler(
} }
extern "x86-interrupt" fn double_fault_handler( extern "x86-interrupt" fn double_fault_handler(
stack_frame: InterruptStackFrame, stack_frame: &mut InterruptStackFrame,
_error_code: u64, _error_code: u64,
) -> ! { ) -> ! {
panic!("EXCEPTION: DOUBLE FAULT\n{:#?}", stack_frame); panic!("EXCEPTION: DOUBLE FAULT\n{:#?}", stack_frame);
} }
extern "x86-interrupt" fn timer_interrupt_handler(_stack_frame: InterruptStackFrame) { extern "x86-interrupt" fn timer_interrupt_handler(_stack_frame: &mut InterruptStackFrame) {
print!("."); print!(".");
unsafe { unsafe {
PICS.lock() PICS.lock()
@@ -79,12 +79,29 @@ extern "x86-interrupt" fn timer_interrupt_handler(_stack_frame: InterruptStackFr
} }
} }
extern "x86-interrupt" fn keyboard_interrupt_handler(_stack_frame: InterruptStackFrame) { 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; use x86_64::instructions::port::Port;
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 mut port = Port::new(0x60);
let scancode: u8 = unsafe { port.read() }; let scancode: u8 = unsafe { port.read() };
crate::task::keyboard::add_scancode(scancode); 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 { unsafe {
PICS.lock() PICS.lock()
@@ -92,8 +109,13 @@ extern "x86-interrupt" fn keyboard_interrupt_handler(_stack_frame: InterruptStac
} }
} }
#[cfg(test)]
use crate::{serial_print, serial_println};
#[test_case] #[test_case]
fn test_breakpoint_exception() { fn test_breakpoint_exception() {
serial_print!("test_breakpoint_exception...");
// invoke a breakpoint exception // invoke a breakpoint exception
x86_64::instructions::interrupts::int3(); x86_64::instructions::interrupts::int3();
serial_println!("[ok]");
} }

View File

@@ -2,10 +2,17 @@
#![cfg_attr(test, no_main)] #![cfg_attr(test, no_main)]
#![feature(custom_test_frameworks)] #![feature(custom_test_frameworks)]
#![feature(abi_x86_interrupt)] #![feature(abi_x86_interrupt)]
#![feature(alloc_error_handler)]
#![feature(const_fn)]
#![feature(alloc_layout_extra)]
#![feature(const_in_array_repeat_expressions)]
#![feature(wake_trait)]
#![feature(async_closure)]
#![test_runner(crate::test_runner)] #![test_runner(crate::test_runner)]
#![reexport_test_harness_main = "test_main"] #![reexport_test_harness_main = "test_main"]
extern crate alloc; extern crate alloc;
use core::panic::PanicInfo; use core::panic::PanicInfo;
pub mod allocator; pub mod allocator;
@@ -22,25 +29,11 @@ pub fn init() {
unsafe { interrupts::PICS.lock().initialize() }; unsafe { interrupts::PICS.lock().initialize() };
x86_64::instructions::interrupts::enable(); x86_64::instructions::interrupts::enable();
} }
pub trait Testable {
fn run(&self) -> ();
}
impl<T> Testable for T pub fn test_runner(tests: &[&dyn Fn()]) {
where
T: Fn(),
{
fn run(&self) {
serial_print!("{}...\t", core::any::type_name::<T>());
self();
serial_println!("[ok]");
}
}
pub fn test_runner(tests: &[&dyn Testable]) {
serial_println!("Running {} tests", tests.len()); serial_println!("Running {} tests", tests.len());
for test in tests { for test in tests {
test.run(); test();
} }
exit_qemu(QemuExitCode::Success); exit_qemu(QemuExitCode::Success);
} }
@@ -75,7 +68,7 @@ pub fn hlt_loop() -> ! {
} }
#[cfg(test)] #[cfg(test)]
use bootloader::{BootInfo, entry_point}; use bootloader::{entry_point, BootInfo};
#[cfg(test)] #[cfg(test)]
entry_point!(test_kernel_main); entry_point!(test_kernel_main);
@@ -93,3 +86,8 @@ fn test_kernel_main(_boot_info: &'static BootInfo) -> ! {
fn panic(info: &PanicInfo) -> ! { fn panic(info: &PanicInfo) -> ! {
test_panic_handler(info) test_panic_handler(info)
} }
#[alloc_error_handler]
fn alloc_error_handler(layout: alloc::alloc::Layout) -> ! {
panic!("allocation error: {:?}", layout)
}

View File

@@ -7,8 +7,7 @@
extern crate alloc; extern crate alloc;
use blog_os::println; use blog_os::println;
use blog_os::task::{Task, executor::Executor, keyboard}; use bootloader::{entry_point, BootInfo};
use bootloader::{BootInfo, entry_point};
use core::panic::PanicInfo; use core::panic::PanicInfo;
entry_point!(kernel_main); entry_point!(kernel_main);
@@ -16,6 +15,7 @@ entry_point!(kernel_main);
fn kernel_main(boot_info: &'static BootInfo) -> ! { fn kernel_main(boot_info: &'static BootInfo) -> ! {
use blog_os::allocator; use blog_os::allocator;
use blog_os::memory::{self, BootInfoFrameAllocator}; use blog_os::memory::{self, BootInfoFrameAllocator};
use blog_os::task::{simple_executor::SimpleExecutor, Task, keyboard};
use x86_64::VirtAddr; use x86_64::VirtAddr;
println!("Hello World{}", "!"); println!("Hello World{}", "!");
@@ -27,13 +27,25 @@ fn kernel_main(boot_info: &'static BootInfo) -> ! {
allocator::init_heap(&mut mapper, &mut frame_allocator).expect("heap initialization failed"); allocator::init_heap(&mut mapper, &mut frame_allocator).expect("heap initialization failed");
#[cfg(test)] let mut executor = SimpleExecutor::new();
test_main();
let mut executor = Executor::new();
executor.spawn(Task::new(example_task())); executor.spawn(Task::new(example_task()));
executor.spawn(Task::new(keyboard::print_keypresses())); executor.spawn(Task::new(keyboard::print_keypresses()));
executor.run(); 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. /// This function is called on panic.
@@ -49,17 +61,3 @@ fn panic(info: &PanicInfo) -> ! {
fn panic(info: &PanicInfo) -> ! { fn panic(info: &PanicInfo) -> ! {
blog_os::test_panic_handler(info) blog_os::test_panic_handler(info)
} }
async fn async_number() -> u32 {
42
}
async fn example_task() {
let number = async_number().await;
println!("async number: {}", number);
}
#[test_case]
fn trivial_assertion() {
assert_eq!(1, 1);
}

View File

@@ -1,7 +1,10 @@
use bootloader::bootinfo::{MemoryMap, MemoryRegionType}; use bootloader::bootinfo::{MemoryMap, MemoryRegionType};
use x86_64::{ use x86_64::{
structures::paging::{
FrameAllocator, Mapper, OffsetPageTable, Page, PageTable, PhysFrame, Size4KiB,
UnusedPhysFrame,
},
PhysAddr, VirtAddr, PhysAddr, VirtAddr,
structures::paging::{FrameAllocator, OffsetPageTable, PageTable, PhysFrame, Size4KiB},
}; };
/// Initialize a new OffsetPageTable. /// Initialize a new OffsetPageTable.
@@ -11,11 +14,9 @@ use x86_64::{
/// `physical_memory_offset`. Also, this function must be only called once /// `physical_memory_offset`. Also, this function must be only called once
/// to avoid aliasing `&mut` references (which is undefined behavior). /// to avoid aliasing `&mut` references (which is undefined behavior).
pub unsafe fn init(physical_memory_offset: VirtAddr) -> OffsetPageTable<'static> { pub unsafe fn init(physical_memory_offset: VirtAddr) -> OffsetPageTable<'static> {
unsafe {
let level_4_table = active_level_4_table(physical_memory_offset); let level_4_table = active_level_4_table(physical_memory_offset);
OffsetPageTable::new(level_4_table, physical_memory_offset) OffsetPageTable::new(level_4_table, physical_memory_offset)
} }
}
/// Returns a mutable reference to the active level 4 table. /// Returns a mutable reference to the active level 4 table.
/// ///
@@ -32,14 +33,31 @@ unsafe fn active_level_4_table(physical_memory_offset: VirtAddr) -> &'static mut
let virt = physical_memory_offset + phys.as_u64(); let virt = physical_memory_offset + phys.as_u64();
let page_table_ptr: *mut PageTable = virt.as_mut_ptr(); let page_table_ptr: *mut PageTable = virt.as_mut_ptr();
unsafe { &mut *page_table_ptr } &mut *page_table_ptr // unsafe
}
/// Creates an example mapping for the given page to frame `0xb8000`.
pub fn create_example_mapping(
page: Page,
mapper: &mut OffsetPageTable,
frame_allocator: &mut impl FrameAllocator<Size4KiB>,
) {
use x86_64::structures::paging::PageTableFlags as Flags;
let frame = PhysFrame::containing_address(PhysAddr::new(0xb8000));
// FIXME: ONLY FOR TEMPORARY TESTING
let unused_frame = unsafe { UnusedPhysFrame::new(frame) };
let flags = Flags::PRESENT | Flags::WRITABLE;
let map_to_result = mapper.map_to(page, unused_frame, flags, frame_allocator);
map_to_result.expect("map_to failed").flush();
} }
/// A FrameAllocator that always returns `None`. /// A FrameAllocator that always returns `None`.
pub struct EmptyFrameAllocator; pub struct EmptyFrameAllocator;
unsafe impl FrameAllocator<Size4KiB> for EmptyFrameAllocator { unsafe impl FrameAllocator<Size4KiB> for EmptyFrameAllocator {
fn allocate_frame(&mut self) -> Option<PhysFrame> { fn allocate_frame(&mut self) -> Option<UnusedPhysFrame> {
None None
} }
} }
@@ -64,7 +82,7 @@ impl BootInfoFrameAllocator {
} }
/// Returns an iterator over the usable frames specified in the memory map. /// Returns an iterator over the usable frames specified in the memory map.
fn usable_frames(&self) -> impl Iterator<Item = PhysFrame> { fn usable_frames(&self) -> impl Iterator<Item = UnusedPhysFrame> {
// get usable regions from memory map // get usable regions from memory map
let regions = self.memory_map.iter(); let regions = self.memory_map.iter();
let usable_regions = regions.filter(|r| r.region_type == MemoryRegionType::Usable); let usable_regions = regions.filter(|r| r.region_type == MemoryRegionType::Usable);
@@ -73,12 +91,14 @@ impl BootInfoFrameAllocator {
// transform to an iterator of frame start addresses // transform to an iterator of frame start addresses
let frame_addresses = addr_ranges.flat_map(|r| r.step_by(4096)); let frame_addresses = addr_ranges.flat_map(|r| r.step_by(4096));
// create `PhysFrame` types from the start addresses // create `PhysFrame` types from the start addresses
frame_addresses.map(|addr| PhysFrame::containing_address(PhysAddr::new(addr))) let frames = frame_addresses.map(|addr| PhysFrame::containing_address(PhysAddr::new(addr)));
// we know that the frames are really unused
frames.map(|f| unsafe { UnusedPhysFrame::new(f) })
} }
} }
unsafe impl FrameAllocator<Size4KiB> for BootInfoFrameAllocator { unsafe impl FrameAllocator<Size4KiB> for BootInfoFrameAllocator {
fn allocate_frame(&mut self) -> Option<PhysFrame> { fn allocate_frame(&mut self) -> Option<UnusedPhysFrame> {
let frame = self.usable_frames().nth(self.next); let frame = self.usable_frames().nth(self.next);
self.next += 1; self.next += 1;
frame frame

View File

@@ -1,102 +0,0 @@
use super::{Task, TaskId};
use alloc::{collections::BTreeMap, sync::Arc, task::Wake};
use core::task::{Context, Poll, Waker};
use crossbeam_queue::ArrayQueue;
pub struct Executor {
tasks: BTreeMap<TaskId, Task>,
task_queue: Arc<ArrayQueue<TaskId>>,
waker_cache: BTreeMap<TaskId, Waker>,
}
impl Executor {
pub fn new() -> Self {
Executor {
tasks: BTreeMap::new(),
task_queue: Arc::new(ArrayQueue::new(100)),
waker_cache: BTreeMap::new(),
}
}
pub fn spawn(&mut self, task: Task) {
let task_id = task.id;
if self.tasks.insert(task.id, task).is_some() {
panic!("task with same ID already in tasks");
}
self.task_queue.push(task_id).expect("queue full");
}
pub fn run(&mut self) -> ! {
loop {
self.run_ready_tasks();
self.sleep_if_idle();
}
}
fn run_ready_tasks(&mut self) {
// destructure `self` to avoid borrow checker errors
let Self {
tasks,
task_queue,
waker_cache,
} = self;
while let Some(task_id) = task_queue.pop() {
let task = match tasks.get_mut(&task_id) {
Some(task) => task,
None => continue, // task no longer exists
};
let waker = waker_cache
.entry(task_id)
.or_insert_with(|| TaskWaker::new(task_id, task_queue.clone()));
let mut context = Context::from_waker(waker);
match task.poll(&mut context) {
Poll::Ready(()) => {
// task done -> remove it and its cached waker
tasks.remove(&task_id);
waker_cache.remove(&task_id);
}
Poll::Pending => {}
}
}
}
fn sleep_if_idle(&self) {
use x86_64::instructions::interrupts::{self, enable_and_hlt};
interrupts::disable();
if self.task_queue.is_empty() {
enable_and_hlt();
} else {
interrupts::enable();
}
}
}
struct TaskWaker {
task_id: TaskId,
task_queue: Arc<ArrayQueue<TaskId>>,
}
impl TaskWaker {
fn new(task_id: TaskId, task_queue: Arc<ArrayQueue<TaskId>>) -> Waker {
Waker::from(Arc::new(TaskWaker {
task_id,
task_queue,
}))
}
fn wake_task(&self) {
self.task_queue.push(self.task_id).expect("task_queue full");
}
}
impl Wake for TaskWaker {
fn wake(self: Arc<Self>) {
self.wake_task();
}
fn wake_by_ref(self: &Arc<Self>) {
self.wake_task();
}
}

View File

@@ -1,33 +1,11 @@
use crate::{print, println};
use conquer_once::spin::OnceCell; use conquer_once::spin::OnceCell;
use core::{
pin::Pin,
task::{Context, Poll},
};
use crossbeam_queue::ArrayQueue; use crossbeam_queue::ArrayQueue;
use futures_util::{ use futures_util::stream::{Stream, StreamExt};
stream::{Stream, StreamExt}, use core::{pin::Pin, task::{Context, Poll}};
task::AtomicWaker, use pc_keyboard::{layouts, DecodedKey, HandleControl, Keyboard, ScancodeSet1};
}; use crate::print;
use pc_keyboard::{DecodedKey, HandleControl, Keyboard, ScancodeSet1, layouts};
static SCANCODE_QUEUE: OnceCell<ArrayQueue<u8>> = OnceCell::uninit(); static SCANCODE_QUEUE: OnceCell<ArrayQueue<u8>> = OnceCell::uninit();
static WAKER: AtomicWaker = AtomicWaker::new();
/// Called by the keyboard interrupt handler
///
/// Must not block or allocate.
pub(crate) fn add_scancode(scancode: u8) {
if let Ok(queue) = SCANCODE_QUEUE.try_get() {
if let Err(_) = queue.push(scancode) {
println!("WARNING: scancode queue full; dropping keyboard input");
} else {
WAKER.wake();
}
} else {
println!("WARNING: scancode queue uninitialized");
}
}
pub struct ScancodeStream { pub struct ScancodeStream {
_private: (), _private: (),
@@ -35,44 +13,31 @@ pub struct ScancodeStream {
impl ScancodeStream { impl ScancodeStream {
pub fn new() -> Self { pub fn new() -> Self {
SCANCODE_QUEUE SCANCODE_QUEUE.try_init_once(|| ArrayQueue::new(100))
.try_init_once(|| ArrayQueue::new(100))
.expect("ScancodeStream::new should only be called once"); .expect("ScancodeStream::new should only be called once");
ScancodeStream { _private: () } ScancodeStream {
_private: (),
}
} }
} }
impl Stream for ScancodeStream { impl Stream for ScancodeStream {
type Item = u8; type Item = u8;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<u8>> { fn poll_next(self: Pin<&mut Self>, context: &mut Context) -> Poll<Option<u8>> {
let queue = SCANCODE_QUEUE let queue = SCANCODE_QUEUE
.try_get() .try_get()
.expect("scancode queue not initialized"); .expect("scancode queue not initialized");
// fast path
if let Some(scancode) = queue.pop() {
return Poll::Ready(Some(scancode));
}
WAKER.register(&cx.waker());
match queue.pop() { match queue.pop() {
Some(scancode) => { Ok(scancode) => Poll::Ready(Some(scancode)),
WAKER.take(); Err(crossbeam_queue::PopError) => Poll::Pending,
Poll::Ready(Some(scancode))
}
None => Poll::Pending,
} }
} }
} }
pub async fn print_keypresses() { pub async fn print_keypresses() {
let mut scancodes = ScancodeStream::new(); let mut scancodes = ScancodeStream::new();
let mut keyboard = Keyboard::new( let mut keyboard = Keyboard::new(layouts::Us104Key, ScancodeSet1, HandleControl::Ignore);
ScancodeSet1::new(),
layouts::Us104Key,
HandleControl::Ignore,
);
while let Some(scancode) = scancodes.next().await { while let Some(scancode) = scancodes.next().await {
if let Ok(Some(key_event)) = keyboard.add_byte(scancode) { if let Ok(Some(key_event)) = keyboard.add_byte(scancode) {

View File

@@ -1,24 +1,17 @@
use alloc::boxed::Box; use alloc::boxed::Box;
use core::{ use core::task::{Context, Poll};
future::Future, use core::{future::Future, pin::Pin};
pin::Pin,
sync::atomic::{AtomicU64, Ordering},
task::{Context, Poll},
};
pub mod executor;
pub mod keyboard; pub mod keyboard;
pub mod simple_executor; pub mod simple_executor;
pub struct Task { pub struct Task {
id: TaskId,
future: Pin<Box<dyn Future<Output = ()>>>, future: Pin<Box<dyn Future<Output = ()>>>,
} }
impl Task { impl Task {
pub fn new(future: impl Future<Output = ()> + 'static) -> Task { pub fn new(future: impl Future<Output = ()> + 'static) -> Task {
Task { Task {
id: TaskId::new(),
future: Box::pin(future), future: Box::pin(future),
} }
} }
@@ -27,13 +20,3 @@ impl Task {
self.future.as_mut().poll(context) self.future.as_mut().poll(context)
} }
} }
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
struct TaskId(u64);
impl TaskId {
fn new() -> Self {
static NEXT_ID: AtomicU64 = AtomicU64::new(0);
TaskId(NEXT_ID.fetch_add(1, Ordering::Relaxed))
}
}

View File

@@ -1,6 +1,6 @@
use super::Task; use super::Task;
use alloc::collections::VecDeque; use alloc::{collections::VecDeque, sync::Arc, task::Wake};
use core::task::{Context, Poll, RawWaker, RawWakerVTable, Waker}; use core::task::{Context, Poll, Waker};
pub struct SimpleExecutor { pub struct SimpleExecutor {
task_queue: VecDeque<Task>, task_queue: VecDeque<Task>,
@@ -19,7 +19,7 @@ impl SimpleExecutor {
pub fn run(&mut self) { pub fn run(&mut self) {
while let Some(mut task) = self.task_queue.pop_front() { while let Some(mut task) = self.task_queue.pop_front() {
let waker = dummy_waker(); let waker = DummyWaker.to_waker();
let mut context = Context::from_waker(&waker); let mut context = Context::from_waker(&waker);
match task.poll(&mut context) { match task.poll(&mut context) {
Poll::Ready(()) => {} // task done Poll::Ready(()) => {} // task done
@@ -29,16 +29,16 @@ impl SimpleExecutor {
} }
} }
fn dummy_raw_waker() -> RawWaker { struct DummyWaker;
fn no_op(_: *const ()) {}
fn clone(_: *const ()) -> RawWaker { impl Wake for DummyWaker {
dummy_raw_waker() fn wake(self: Arc<Self>) {
// do nothing
}
} }
let vtable = &RawWakerVTable::new(clone, no_op, no_op, no_op); impl DummyWaker {
RawWaker::new(0 as *const (), vtable) fn to_waker(self) -> Waker {
Waker::from(Arc::new(self))
} }
fn dummy_waker() -> Waker {
unsafe { Waker::from_raw(dummy_raw_waker()) }
} }

View File

@@ -3,6 +3,9 @@ use lazy_static::lazy_static;
use spin::Mutex; use spin::Mutex;
use volatile::Volatile; use volatile::Volatile;
#[cfg(test)]
use crate::{serial_print, serial_println};
lazy_static! { lazy_static! {
/// A global `Writer` instance that can be used for printing to the VGA text buffer. /// A global `Writer` instance that can be used for printing to the VGA text buffer.
/// ///
@@ -177,14 +180,18 @@ pub fn _print(args: fmt::Arguments) {
#[test_case] #[test_case]
fn test_println_simple() { fn test_println_simple() {
serial_print!("test_println... ");
println!("test_println_simple output"); println!("test_println_simple output");
serial_println!("[ok]");
} }
#[test_case] #[test_case]
fn test_println_many() { fn test_println_many() {
serial_print!("test_println_many... ");
for _ in 0..200 { for _ in 0..200 {
println!("test_println_many output"); println!("test_println_many output");
} }
serial_println!("[ok]");
} }
#[test_case] #[test_case]
@@ -192,6 +199,8 @@ fn test_println_output() {
use core::fmt::Write; use core::fmt::Write;
use x86_64::instructions::interrupts; use x86_64::instructions::interrupts;
serial_print!("test_println_output... ");
let s = "Some test string that fits on a single line"; let s = "Some test string that fits on a single line";
interrupts::without_interrupts(|| { interrupts::without_interrupts(|| {
let mut writer = WRITER.lock(); let mut writer = WRITER.lock();
@@ -201,4 +210,6 @@ fn test_println_output() {
assert_eq!(char::from(screen_char.ascii_character), c); assert_eq!(char::from(screen_char.ascii_character), c);
} }
}); });
serial_println!("[ok]");
} }

View File

@@ -4,10 +4,10 @@
#![test_runner(blog_os::test_runner)] #![test_runner(blog_os::test_runner)]
#![reexport_test_harness_main = "test_main"] #![reexport_test_harness_main = "test_main"]
use blog_os::println; use blog_os::{println, serial_print, serial_println};
use core::panic::PanicInfo; use core::panic::PanicInfo;
#[unsafe(no_mangle)] // don't mangle the name of this function #[no_mangle] // don't mangle the name of this function
pub extern "C" fn _start() -> ! { pub extern "C" fn _start() -> ! {
test_main(); test_main();
@@ -21,5 +21,7 @@ fn panic(info: &PanicInfo) -> ! {
#[test_case] #[test_case]
fn test_println() { fn test_println() {
serial_print!("test_println... ");
println!("test_println output"); println!("test_println output");
serial_println!("[ok]");
} }

View File

@@ -7,8 +7,8 @@
extern crate alloc; extern crate alloc;
use alloc::{boxed::Box, vec::Vec}; use alloc::{boxed::Box, vec::Vec};
use blog_os::allocator::HEAP_SIZE; use blog_os::{allocator::HEAP_SIZE, serial_print, serial_println};
use bootloader::{BootInfo, entry_point}; use bootloader::{entry_point, BootInfo};
use core::panic::PanicInfo; use core::panic::PanicInfo;
entry_point!(main); entry_point!(main);
@@ -30,38 +30,44 @@ fn main(boot_info: &'static BootInfo) -> ! {
#[test_case] #[test_case]
fn simple_allocation() { fn simple_allocation() {
let heap_value_1 = Box::new(41); serial_print!("simple_allocation... ");
let heap_value_2 = Box::new(13); let heap_value = Box::new(41);
assert_eq!(*heap_value_1, 41); assert_eq!(*heap_value, 41);
assert_eq!(*heap_value_2, 13); serial_println!("[ok]");
} }
#[test_case] #[test_case]
fn large_vec() { fn large_vec() {
serial_print!("large_vec... ");
let n = 1000; let n = 1000;
let mut vec = Vec::new(); let mut vec = Vec::new();
for i in 0..n { for i in 0..n {
vec.push(i); vec.push(i);
} }
assert_eq!(vec.iter().sum::<u64>(), (n - 1) * n / 2); assert_eq!(vec.iter().sum::<u64>(), (n - 1) * n / 2);
serial_println!("[ok]");
} }
#[test_case] #[test_case]
fn many_boxes() { fn many_boxes() {
serial_print!("many_boxes... ");
for i in 0..HEAP_SIZE { for i in 0..HEAP_SIZE {
let x = Box::new(i); let x = Box::new(i);
assert_eq!(*x, i); assert_eq!(*x, i);
} }
serial_println!("[ok]");
} }
#[test_case] #[test_case]
fn many_boxes_long_lived() { fn many_boxes_long_lived() {
serial_print!("many_boxes_long_lived... ");
let long_lived = Box::new(1); // new let long_lived = Box::new(1); // new
for i in 0..HEAP_SIZE { for i in 0..HEAP_SIZE {
let x = Box::new(i); let x = Box::new(i);
assert_eq!(*x, i); assert_eq!(*x, i);
} }
assert_eq!(*long_lived, 1); // new assert_eq!(*long_lived, 1); // new
serial_println!("[ok]");
} }
#[panic_handler] #[panic_handler]

View File

@@ -1,10 +1,10 @@
#![no_std] #![no_std]
#![no_main] #![no_main]
use blog_os::{QemuExitCode, exit_qemu, serial_print, serial_println}; use blog_os::{exit_qemu, serial_print, serial_println, QemuExitCode};
use core::panic::PanicInfo; use core::panic::PanicInfo;
#[unsafe(no_mangle)] #[no_mangle]
pub extern "C" fn _start() -> ! { pub extern "C" fn _start() -> ! {
should_fail(); should_fail();
serial_println!("[test did not panic]"); serial_println!("[test did not panic]");
@@ -13,7 +13,7 @@ pub extern "C" fn _start() -> ! {
} }
fn should_fail() { fn should_fail() {
serial_print!("should_panic::should_fail...\t"); serial_print!("should_fail... ");
assert_eq!(0, 1); assert_eq!(0, 1);
} }

View File

@@ -2,14 +2,14 @@
#![no_main] #![no_main]
#![feature(abi_x86_interrupt)] #![feature(abi_x86_interrupt)]
use blog_os::{QemuExitCode, exit_qemu, serial_print, serial_println}; use blog_os::{exit_qemu, serial_print, serial_println, QemuExitCode};
use core::panic::PanicInfo; use core::panic::PanicInfo;
use lazy_static::lazy_static; use lazy_static::lazy_static;
use x86_64::structures::idt::{InterruptDescriptorTable, InterruptStackFrame}; use x86_64::structures::idt::{InterruptDescriptorTable, InterruptStackFrame};
#[unsafe(no_mangle)] #[no_mangle]
pub extern "C" fn _start() -> ! { pub extern "C" fn _start() -> ! {
serial_print!("stack_overflow::stack_overflow...\t"); serial_print!("stack_overflow... ");
blog_os::gdt::init(); blog_os::gdt::init();
init_test_idt(); init_test_idt();
@@ -23,7 +23,6 @@ pub extern "C" fn _start() -> ! {
#[allow(unconditional_recursion)] #[allow(unconditional_recursion)]
fn stack_overflow() { fn stack_overflow() {
stack_overflow(); // for each recursion, the return address is pushed stack_overflow(); // for each recursion, the return address is pushed
volatile::Volatile::new(0).read(); // prevent tail recursion optimizations
} }
lazy_static! { lazy_static! {
@@ -44,7 +43,7 @@ pub fn init_test_idt() {
} }
extern "x86-interrupt" fn test_double_fault_handler( extern "x86-interrupt" fn test_double_fault_handler(
_stack_frame: InterruptStackFrame, _stack_frame: &mut InterruptStackFrame,
_error_code: u64, _error_code: u64,
) -> ! { ) -> ! {
serial_println!("[ok]"); serial_println!("[ok]");

View File

@@ -1,16 +1,15 @@
{ {
"llvm-target": "x86_64-unknown-none", "llvm-target": "x86_64-unknown-none",
"data-layout": "e-m:e-p270:32:32-p271:32:32-p272:64:64-i64:64-i128:128-f80:128-n8:16:32:64-S128", "data-layout": "e-m:e-i64:64-f80:128-n8:16:32:64-S128",
"arch": "x86_64", "arch": "x86_64",
"target-endian": "little", "target-endian": "little",
"target-pointer-width": 64, "target-pointer-width": "64",
"target-c-int-width": 32, "target-c-int-width": "32",
"os": "none", "os": "none",
"executables": true, "executables": true,
"linker-flavor": "ld.lld", "linker-flavor": "ld.lld",
"linker": "rust-lld", "linker": "rust-lld",
"panic-strategy": "abort", "panic-strategy": "abort",
"disable-redzone": true, "disable-redzone": true,
"features": "-mmx,-sse,+soft-float", "features": "-mmx,-sse,+soft-float"
"rustc-abi": "x86-softfloat"
} }