mirror of
https://github.com/phil-opp/blog_os.git
synced 2025-12-16 14:27:49 +00:00
Compare commits
65 Commits
94d87308f4
...
edition-3
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bd3550ea87 | ||
|
|
ecb60ec326 | ||
|
|
8a1267477a | ||
|
|
ce01059620 | ||
|
|
4d0c3ac188 | ||
|
|
d565cd125b | ||
|
|
ca86085360 | ||
|
|
5f3d38884c | ||
|
|
f557d1c698 | ||
|
|
0c248d027e | ||
|
|
2cf0675a2d | ||
|
|
916ad36e78 | ||
|
|
3c2e91fa4e | ||
|
|
c9683a2cd9 | ||
|
|
514736b1d8 | ||
|
|
647b509971 | ||
|
|
1118350b16 | ||
|
|
fb096a7484 | ||
|
|
8a41fd65bf | ||
|
|
50802c8332 | ||
|
|
ba410f40ba | ||
|
|
a119d36cc9 | ||
|
|
9080e69a09 | ||
|
|
2676d69c31 | ||
|
|
c31f3c2728 | ||
|
|
5799263124 | ||
|
|
ded60de8d0 | ||
|
|
171956adc8 | ||
|
|
e2a4464835 | ||
|
|
f0fe3929ab | ||
|
|
c728cf8225 | ||
|
|
f38c11ae8e | ||
|
|
a1b195ede0 | ||
|
|
cfd31a977d | ||
|
|
06dd5edb3f | ||
|
|
685f55dd31 | ||
|
|
0b6b053c54 | ||
|
|
e0464fbd44 | ||
|
|
5e88b86d1e | ||
|
|
e6b507e6d2 | ||
|
|
5681d3f0f7 | ||
|
|
68d0c946f4 | ||
|
|
9baab55788 | ||
|
|
2bc74ce8f7 | ||
|
|
7ce9ae1caf | ||
|
|
646e5ba502 | ||
|
|
bb754eadba | ||
|
|
f377050605 | ||
|
|
5baf50a5b4 | ||
|
|
5d63300512 | ||
|
|
739d9e1a3c | ||
|
|
8a1063df5f | ||
|
|
d2c6b281c8 | ||
|
|
dd228c4bb1 | ||
|
|
020f2d7e8e | ||
|
|
c337650fb3 | ||
|
|
7262e552ae | ||
|
|
3900ddeb2c | ||
|
|
a7f4647e73 | ||
|
|
a7cfc562e9 | ||
|
|
2d6fc6bd76 | ||
|
|
5f5320f8e0 | ||
|
|
6f6e6698c4 | ||
|
|
1d0e7950fd | ||
|
|
33b6b6ebe8 |
2
.github/workflows/blog.yml
vendored
2
.github/workflows/blog.yml
vendored
@@ -20,7 +20,7 @@ jobs:
|
||||
- uses: actions/checkout@v1
|
||||
|
||||
- name: 'Download Zola'
|
||||
run: curl -sL https://github.com/getzola/zola/releases/download/v0.16.1/zola-v0.16.1-x86_64-unknown-linux-gnu.tar.gz | tar zxv
|
||||
run: curl -sL https://github.com/getzola/zola/releases/download/v0.17.2/zola-v0.17.2-x86_64-unknown-linux-gnu.tar.gz | tar zxv
|
||||
- name: 'Install Python Libraries'
|
||||
run: python -m pip install --user -r requirements.txt
|
||||
working-directory: "blog"
|
||||
|
||||
2
.github/workflows/check-links.yml
vendored
2
.github/workflows/check-links.yml
vendored
@@ -20,7 +20,7 @@ jobs:
|
||||
- uses: actions/checkout@v1
|
||||
|
||||
- name: "Download Zola"
|
||||
run: curl -sL https://github.com/getzola/zola/releases/download/v0.16.1/zola-v0.16.1-x86_64-unknown-linux-gnu.tar.gz | tar zxv
|
||||
run: curl -sL https://github.com/getzola/zola/releases/download/v0.17.2/zola-v0.17.2-x86_64-unknown-linux-gnu.tar.gz | tar zxv
|
||||
|
||||
- name: "Run zola check"
|
||||
run: ../zola check
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
base_url = "https://os.phil-opp.com"
|
||||
title = "Writing an OS in Rust"
|
||||
description = "This blog series creates a small operating system in the Rust programming language. Each post is a small tutorial and includes all needed code."
|
||||
|
||||
generate_feed = true
|
||||
feed_filename = "rss.xml"
|
||||
@@ -34,10 +36,7 @@ author = { name = "Philipp Oppermann" }
|
||||
default_language = "en"
|
||||
languages = ["en", "zh-CN", "zh-TW", "fr", "ja", "fa", "ru", "ko"]
|
||||
|
||||
[languages.en]
|
||||
title = "Writing an OS in Rust"
|
||||
description = "This blog series creates a small operating system in the Rust programming language. Each post is a small tutorial and includes all needed code."
|
||||
[languages.en.translations]
|
||||
[translations]
|
||||
lang_name = "English (original)"
|
||||
toc = "Table of Contents"
|
||||
all_posts = "« All Posts"
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
+++
|
||||
title = "Un binaire Rust autonome"
|
||||
title = "Un binaire Rust autoporté"
|
||||
weight = 1
|
||||
path = "fr/freestanding-rust-binary"
|
||||
date = 2018-02-10
|
||||
@@ -29,7 +29,7 @@ Ce blog est développé sur [GitHub]. Si vous avez un problème ou une question,
|
||||
|
||||
## Introduction
|
||||
Pour écrire un noyau de système d'exploitation, nous avons besoin d'un code qui ne dépend pas de fonctionnalités de système d'exploitation. Cela signifie que nous ne pouvons pas utiliser les fils d'exécution, les fichiers, la mémoire sur le tas, le réseau, les nombres aléatoires, la sortie standard ou tout autre fonctionnalité nécessitant une abstraction du système d'exploitation ou un matériel spécifique. Cela a du sens, étant donné que nous essayons d'écrire notre propre OS et nos propres pilotes.
|
||||
Cela signifie que nous ne pouvons pas utiliser la majeure partie de la [bibliothèque standard de Rust]. Il y a néanmoins beaucoup de fonctionnalités de Rust que nous _pouvons_ utiliser. Par exemple, nous pouvons utiliser les [iterators], les [closures], le [pattern matching], l'[option] et le [result], le [string formatting], et bien-sûr l'[ownership system]. Ces fonctionnalités permettent l'écriture d'un noyau d'une façon expressive et haut-niveau sans se soucier des [comportements indéfinis] ou de la [sécurité de la mémoire].
|
||||
Cela signifie que nous ne pouvons pas utiliser la majeure partie de la [bibliothèque standard de Rust]. Il y a néanmoins beaucoup de fonctionnalités de Rust que nous _pouvons_ utiliser. Par exemple, nous pouvons utiliser les [iterators], les [closures], le [pattern matching], l'[option] et le [result], le [string formatting], et bien sûr l'[ownership system]. Ces fonctionnalités permettent l'écriture d'un noyau d'une façon expressive et haut-niveau sans se soucier des [comportements indéfinis] ou de la [sécurité de la mémoire].
|
||||
|
||||
[option]: https://doc.rust-lang.org/core/option/
|
||||
[result]:https://doc.rust-lang.org/core/result/
|
||||
@@ -47,18 +47,18 @@ Cet article décrit les étapes nécessaires pour créer un exécutable Rust aut
|
||||
|
||||
## Désactiver la Bibliothèque Standard
|
||||
|
||||
Par défaut, tous les crates Rust relient la [bibliothèque standard], qui dépend du système d'exploitation pour les fonctionnalités telles que les fils d'exécution, les fichiers ou le réseau. Elle dépend aussi de la bibliothèque standard de C `libc`, qui intéragit de près avec les services de l'OS. Comme notre plan est d'écrire un système d'exploitation, nous ne pouvons pas utiliser des bibliothèques dépendant de l'OS. Nous devons donc désactiver l'inclusion automatique de la bibliothèque standard en utilisant l'[attribut `no std`].
|
||||
Par défaut, toutes les crates Rust sont liées à la bibliothèque standard, qui repose sur les fonctionnalités du système d’exploitation telles que les fils d'exécution, les fichiers et la connectivité réseau. Elle est également liée à la bibliothèque standard C `libc`, qui interagit étroitement avec les services fournis par l'OS. Comme notre plan est d'écrire un système d'exploitation, nous ne pouvons pas utiliser des bibliothèques dépendant de l'OS. Nous devons donc désactiver l'inclusion automatique de la bibliothèque standard en utilisant l'[attribut `no std`].
|
||||
|
||||
[bibliothèque standard]: https://doc.rust-lang.org/std/
|
||||
[attribut `no std`]: https://doc.rust-lang.org/1.30.0/book/first-edition/using-rust-without-the-standard-library.html
|
||||
|
||||
Nous commencons par créer un nouveau projet d'application cargo. La manière la plus simple de faire est avec la ligne de commande :
|
||||
Nous commençons par créer un nouveau projet d'application cargo. La manière la plus simple de faire est avec la ligne de commande :
|
||||
|
||||
```
|
||||
cargo new blog_os --bin --edition 2018
|
||||
```
|
||||
|
||||
J'ai nommé le projet `blog_os`, mais vous pouvez bien-sûr choisir le nom qu'il vous convient. Le flag `--bin` indique que nous voulons créer un exécutable (contrairement à une bibliothèque) et le flag `--edition 2018` indique que nous voulons utiliser l'[édition 2018] de Rust pour notre crate. Quand nous lançons la commande, cargo crée la structure de répertoire suivante pour nous :
|
||||
J'ai nommé le projet `blog_os`, mais vous pouvez évidemment choisir le nom qu'il vous convient. Le flag `--bin` indique que nous voulons créer un exécutable (contrairement à une bibliothèque) et le flag `--edition 2018` indique que nous voulons utiliser l'[édition 2018] de Rust pour notre crate. Quand nous lançons la commande, cargo crée la structure de répertoire suivante pour nous :
|
||||
|
||||
[édition 2018]: https://doc.rust-lang.org/nightly/edition-guide/rust-2018/index.html
|
||||
|
||||
@@ -75,7 +75,7 @@ Le fichier `Cargo.toml` contient la configuration de la crate, par exemple le no
|
||||
|
||||
### L'Attribut `no_std`
|
||||
|
||||
Pour l'instant, notre crate relie la bilbiothèque standard implicitement. Désactivons cela en ajoutant l'[attribut `no std`] :
|
||||
Pour l'instant, notre crate relie la bibliothèque standard implicitement. Désactivons cela en ajoutant l'[attribut `no std`] :
|
||||
|
||||
```rust
|
||||
// main.rs
|
||||
|
||||
@@ -383,7 +383,7 @@ error: linking with `cc` failed: exit code: 1
|
||||
cargo rustc -- -C link-args="-e __start"
|
||||
```
|
||||
|
||||
`-e` 表示肉口點的函式名稱,然後由於 macOS 上所有的函式都會加上前綴 `_`,我們需要設置入口點為 `__start` 而不是 `_start`。
|
||||
`-e` 表示入口點的函式名稱,然後由於 macOS 上所有的函式都會加上前綴 `_`,我們需要設置入口點為 `__start` 而不是 `_start`。
|
||||
|
||||
接下來會出現另一個連結器錯誤:
|
||||
|
||||
|
||||
@@ -323,7 +323,7 @@ build-std-features = ["compiler-builtins-mem"]
|
||||
در پشت صحنه، این پرچم [ویژگی `mem`] از کریت `compiler_builtins` را فعال میکند. اثرش این است که صفت `[no_mangle]#` بر روی [پیادهسازی `memcpy` و بقیه موارد] از کریت اعمال میشود، که آنها در دسترس لینکر قرار میدهد. شایان ذکر است که این توابع در حال حاضر [بهینه نشدهاند]، بنابراین ممکن است عملکرد آنها در بهترین حالت نباشد، اما حداقل صحیح هستند. برای `x86_64` ، یک pull request باز برای [بهینه سازی این توابع با استفاده از دستورالعملهای خاص اسمبلی][memcpy rep movsb] وجود دارد.
|
||||
|
||||
[ویژگی `mem`]: https://github.com/rust-lang/compiler-builtins/blob/eff506cd49b637f1ab5931625a33cef7e91fbbf6/Cargo.toml#L51-L52
|
||||
[پیادهسازی `memcpy` و بقیه موارد]: (https://github.com/rust-lang/compiler-builtins/blob/eff506cd49b637f1ab5931625a33cef7e91fbbf6/src/mem.rs#L12-L69)
|
||||
[پیادهسازی `memcpy` و بقیه موارد]: https://github.com/rust-lang/compiler-builtins/blob/eff506cd49b637f1ab5931625a33cef7e91fbbf6/src/mem.rs#L12-L69
|
||||
[بهینه نشدهاند]: https://github.com/rust-lang/compiler-builtins/issues/339
|
||||
[memcpy rep movsb]: https://github.com/rust-lang/compiler-builtins/pull/365
|
||||
|
||||
|
||||
@@ -317,7 +317,7 @@ build-std-features = ["compiler-builtins-mem"]
|
||||
このとき、裏で`compiler_builtins`クレートの[`mem`機能][`mem` feature]が有効化されています。これにより、このクレートの[`memcpy`などの実装][`memcpy` etc. implementations]に`#[no_mangle]`アトリビュートが適用され、リンカがこれらを利用できるようになっています。
|
||||
|
||||
[`mem` feature]: https://github.com/rust-lang/compiler-builtins/blob/eff506cd49b637f1ab5931625a33cef7e91fbbf6/Cargo.toml#L51-L52
|
||||
[`memcpy` etc. implementations]: (https://github.com/rust-lang/compiler-builtins/blob/eff506cd49b637f1ab5931625a33cef7e91fbbf6/src/mem.rs#L12-L69)
|
||||
[`memcpy` etc. implementations]: https://github.com/rust-lang/compiler-builtins/blob/eff506cd49b637f1ab5931625a33cef7e91fbbf6/src/mem.rs#L12-L69
|
||||
|
||||
この変更をもって、私達のカーネルはコンパイラに必要とされているすべての関数の有効な実装を手に入れたので、コードがもっと複雑になっても変わらずコンパイルできるでしょう。
|
||||
|
||||
|
||||
@@ -99,7 +99,7 @@ UEFI 표준으로 동작하는 최신 기기들도 가상 BIOS를 지원하기
|
||||
지난 포스트에서 우리는 `cargo`를 통해 freestanding 실행파일을 만들었었는데, 호스트 시스템의 운영체제에 따라 프로그램 실행 시작 지점의 이름 및 컴파일 인자들을 다르게 설정해야 했습니다. 이것은 `cargo`가 기본적으로 _호스트 시스템_ (여러 분이 실행 중인 컴퓨터 시스템) 을 목표로 빌드하기 때문이었습니다. 우리의 커널은 다른 운영체제 (예를 들어 Windows) 위에서 실행될 것이 아니기에, 호스트 시스템에 설정 값을 맞추는 대신에 우리가 명확히 정의한 _목표 시스템 (target system)_ 을 목표로 컴파일할 것입니다.
|
||||
|
||||
### Rust Nightly 설치하기 {#installing-rust-nightly}
|
||||
Rust는 _stable_, _beta_ 그리고 _nightly_ 이렇게 세 가지의 채널을 통해 배포됩니다. Rust Book에 [세 채널들 간의 차이에 대해 잘 정리한 챕터]((https://doc.rust-lang.org/book/appendix-07-nightly-rust.html#choo-choo-release-channels-and-riding-the-trains))가 있습니다. 운영체제를 빌드하기 위해서는 _nightly_ 채널에서만 제공하는 실험적인 기능들을 이용해야 하기에 _nightly_ 버전의 Rust를 설치하셔야 합니다.
|
||||
Rust는 _stable_, _beta_ 그리고 _nightly_ 이렇게 세 가지의 채널을 통해 배포됩니다. Rust Book에 [세 채널들 간의 차이에 대해 잘 정리한 챕터](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html#choo-choo-release-channels-and-riding-the-trains)가 있습니다. 운영체제를 빌드하기 위해서는 _nightly_ 채널에서만 제공하는 실험적인 기능들을 이용해야 하기에 _nightly_ 버전의 Rust를 설치하셔야 합니다.
|
||||
|
||||
여러 버전의 Rust 언어 설치 파일들을 관리할 때 [rustup]을 사용하는 것을 강력 추천합니다. rustup을 통해 nightly, beta 그리고 stable 컴파일러들을 모두 설치하고 업데이트할 수 있습니다. `rustup override set nightly` 명령어를 통해 현재 디렉토리에서 항상 nightly 버전의 Rust를 사용하도록 설정할 수 있습니다.
|
||||
`rust-toolchain`이라는 파일을 프로젝트 루트 디렉토리에 만들고 이 파일에 `nightly`라는 텍스트를 적어 놓아도 같은 효과를 볼 수 있습니다. `rustc --version` 명령어를 통해 현재 nightly 버전이 설치되어 있는지 확인할 수 있습니다 (출력되는 버전 넘버가 `-nightly`라는 텍스트로 끝나야 합니다).
|
||||
|
||||
@@ -49,7 +49,7 @@ pub extern "C" fn _start() -> ! {
|
||||
|
||||
// trigger a page fault
|
||||
unsafe {
|
||||
*(0xdeadbeef as *mut u64) = 42;
|
||||
*(0xdeadbeef as *mut u8) = 42;
|
||||
};
|
||||
|
||||
// as before
|
||||
|
||||
@@ -45,7 +45,7 @@ pub extern "C" fn _start() -> ! {
|
||||
|
||||
// ページフォルトを起こす
|
||||
unsafe {
|
||||
*(0xdeadbeef as *mut u64) = 42;
|
||||
*(0xdeadbeef as *mut u8) = 42;
|
||||
};
|
||||
|
||||
// 前回同様
|
||||
|
||||
@@ -48,7 +48,7 @@ pub extern "C" fn _start() -> ! {
|
||||
|
||||
// 페이지 폴트 일으키기
|
||||
unsafe {
|
||||
*(0xdeadbeef as *mut u64) = 42;
|
||||
*(0xdeadbeef as *mut u8) = 42;
|
||||
};
|
||||
|
||||
// 이전과 동일
|
||||
|
||||
@@ -42,7 +42,7 @@ pub extern "C" fn _start() -> ! {
|
||||
|
||||
// trigger a page fault
|
||||
unsafe {
|
||||
*(0xdeadbeef as *mut u64) = 42;
|
||||
*(0xdeadbeef as *mut u8) = 42;
|
||||
};
|
||||
|
||||
// as before
|
||||
@@ -374,9 +374,9 @@ pub fn init() {
|
||||
}
|
||||
```
|
||||
|
||||
We reload the code segment register using [`set_cs`] and load the TSS using [`load_tss`]. The functions are marked as `unsafe`, so we need an `unsafe` block to invoke them. The reason is that it might be possible to break memory safety by loading invalid selectors.
|
||||
We reload the code segment register using [`CS::set_reg`] and load the TSS using [`load_tss`]. The functions are marked as `unsafe`, so we need an `unsafe` block to invoke them. The reason is that it might be possible to break memory safety by loading invalid selectors.
|
||||
|
||||
[`set_cs`]: https://docs.rs/x86_64/0.14.2/x86_64/instructions/segmentation/fn.set_cs.html
|
||||
[`CS::set_reg`]: https://docs.rs/x86_64/0.14.5/x86_64/instructions/segmentation/struct.CS.html#method.set_reg
|
||||
[`load_tss`]: https://docs.rs/x86_64/0.14.2/x86_64/instructions/tables/fn.load_tss.html
|
||||
|
||||
Now that we have loaded a valid TSS and interrupt stack table, we can set the stack index for our double fault handler in the IDT:
|
||||
|
||||
@@ -47,7 +47,7 @@ pub extern "C" fn _start() -> ! {
|
||||
|
||||
// trigger a page fault
|
||||
unsafe {
|
||||
*(0xdeadbeef as *mut u64) = 42;
|
||||
*(0xdeadbeef as *mut u8) = 42;
|
||||
};
|
||||
|
||||
// as before
|
||||
|
||||
@@ -322,7 +322,7 @@ pub extern "C" fn _start() -> ! {
|
||||
blog_os::init();
|
||||
|
||||
// new
|
||||
let ptr = 0xdeadbeaf as *mut u32;
|
||||
let ptr = 0xdeadbeaf as *mut u8;
|
||||
unsafe { *ptr = 42; }
|
||||
|
||||
// as before
|
||||
@@ -347,7 +347,7 @@ pub extern "C" fn _start() -> ! {
|
||||
```rust
|
||||
// Note: The actual address might be different for you. Use the address that
|
||||
// your page fault handler reports.
|
||||
let ptr = 0x2031b2 as *mut u32;
|
||||
let ptr = 0x2031b2 as *mut u8;
|
||||
|
||||
// read from a code page
|
||||
unsafe { let x = *ptr; }
|
||||
|
||||
@@ -329,7 +329,7 @@ pub extern "C" fn _start() -> ! {
|
||||
blog_os::init();
|
||||
|
||||
// ここを追加
|
||||
let ptr = 0xdeadbeaf as *mut u32;
|
||||
let ptr = 0xdeadbeaf as *mut u8;
|
||||
unsafe { *ptr = 42; }
|
||||
|
||||
// ここはこれまでと同じ
|
||||
@@ -354,7 +354,7 @@ pub extern "C" fn _start() -> ! {
|
||||
```rust
|
||||
// 注意:実際のアドレスは個々人で違うかもしれません。
|
||||
// あなたのページフォルトハンドラが報告した値を使ってください。
|
||||
let ptr = 0x2031b2 as *mut u32;
|
||||
let ptr = 0x2031b2 as *mut u8;
|
||||
|
||||
// コードページから読み込む
|
||||
unsafe { let x = *ptr; }
|
||||
|
||||
@@ -316,7 +316,7 @@ pub extern "C" fn _start() -> ! {
|
||||
blog_os::init();
|
||||
|
||||
// new
|
||||
let ptr = 0xdeadbeaf as *mut u32;
|
||||
let ptr = 0xdeadbeaf as *mut u8;
|
||||
unsafe { *ptr = 42; }
|
||||
|
||||
// as before
|
||||
@@ -341,7 +341,7 @@ We see that the current instruction pointer is `0x2031b2`, so we know that this
|
||||
```rust
|
||||
// Note: The actual address might be different for you. Use the address that
|
||||
// your page fault handler reports.
|
||||
let ptr = 0x2031b2 as *mut u32;
|
||||
let ptr = 0x2031b2 as *mut u8;
|
||||
|
||||
// read from a code page
|
||||
unsafe { let x = *ptr; }
|
||||
|
||||
@@ -325,7 +325,7 @@ pub extern "C" fn _start() -> ! {
|
||||
blog_os::init();
|
||||
|
||||
// new
|
||||
let ptr = 0xdeadbeaf as *mut u32;
|
||||
let ptr = 0xdeadbeaf as *mut u8;
|
||||
unsafe { *ptr = 42; }
|
||||
|
||||
// as before
|
||||
@@ -350,7 +350,7 @@ pub extern "C" fn _start() -> ! {
|
||||
```rust
|
||||
// Note: The actual address might be different for you. Use the address that
|
||||
// your page fault handler reports.
|
||||
let ptr = 0x2031b2 as *mut u32;
|
||||
let ptr = 0x2031b2 as *mut u8;
|
||||
|
||||
// read from a code page
|
||||
unsafe { let x = *ptr; }
|
||||
|
||||
@@ -214,7 +214,7 @@ Since we are compiling for a custom target, we can't use the precompiled version
|
||||
|
||||
[unstable]
|
||||
build-std = ["core", "compiler_builtins", "alloc"]
|
||||
````
|
||||
```
|
||||
|
||||
Now the compiler will recompile and include the `alloc` crate in our kernel.
|
||||
|
||||
@@ -223,18 +223,12 @@ The reason that the `alloc` crate is disabled by default in `#[no_std]` crates i
|
||||
```
|
||||
error: no global memory allocator found but one is required; link to std or add
|
||||
#[global_allocator] to a static item that implements the GlobalAlloc trait.
|
||||
|
||||
error: `#[alloc_error_handler]` function required, but not found
|
||||
```
|
||||
|
||||
The first error occurs because the `alloc` crate requires a heap allocator, which is an object that provides the `allocate` and `deallocate` functions. In Rust, heap allocators are described by the [`GlobalAlloc`] trait, which is mentioned in the error message. To set the heap allocator for the crate, the `#[global_allocator]` attribute must be applied to a `static` variable that implements the `GlobalAlloc` trait.
|
||||
|
||||
The second error occurs because calls to `allocate` can fail, most commonly when there is no more memory available. Our program must be able to react to this case, which is what the `#[alloc_error_handler]` function is for.
|
||||
The error occurs because the `alloc` crate requires a heap allocator, which is an object that provides the `allocate` and `deallocate` functions. In Rust, heap allocators are described by the [`GlobalAlloc`] trait, which is mentioned in the error message. To set the heap allocator for the crate, the `#[global_allocator]` attribute must be applied to a `static` variable that implements the `GlobalAlloc` trait.
|
||||
|
||||
[`GlobalAlloc`]: https://doc.rust-lang.org/alloc/alloc/trait.GlobalAlloc.html
|
||||
|
||||
We will describe these traits and attributes in detail in the following sections.
|
||||
|
||||
### The `GlobalAlloc` Trait
|
||||
|
||||
The [`GlobalAlloc`] trait defines the functions that a heap allocator must provide. The trait is special because it is almost never used directly by the programmer. Instead, the compiler will automatically insert the appropriate calls to the trait methods when using the allocation and collection types of `alloc`.
|
||||
@@ -329,32 +323,7 @@ static ALLOCATOR: Dummy = Dummy;
|
||||
|
||||
Since the `Dummy` allocator is a [zero-sized type], we don't need to specify any fields in the initialization expression.
|
||||
|
||||
When we now try to compile it, the first error should be gone. Let's fix the remaining second error:
|
||||
|
||||
```
|
||||
error: `#[alloc_error_handler]` function required, but not found
|
||||
```
|
||||
|
||||
### The `#[alloc_error_handler]` Attribute
|
||||
|
||||
As we learned when discussing the `GlobalAlloc` trait, the `alloc` function can signal an allocation error by returning a null pointer. The question is: how should the Rust runtime react to such an allocation failure? This is where the `#[alloc_error_handler]` attribute comes in. It specifies a function that is called when an allocation error occurs, similar to how our panic handler is called when a panic occurs.
|
||||
|
||||
Let's add such a function to fix the compilation error:
|
||||
|
||||
```rust
|
||||
// in src/lib.rs
|
||||
|
||||
#![feature(alloc_error_handler)] // at the top of the file
|
||||
|
||||
#[alloc_error_handler]
|
||||
fn alloc_error_handler(layout: alloc::alloc::Layout) -> ! {
|
||||
panic!("allocation error: {:?}", layout)
|
||||
}
|
||||
```
|
||||
|
||||
The `alloc_error_handler` function is still unstable, so we need a feature gate to enable it. The function receives a single argument: the `Layout` instance that was passed to `alloc` when the allocation failure occurred. There's nothing we can do to resolve the failure, so we just panic with a message that contains the `Layout` instance.
|
||||
|
||||
With this function, the compilation errors should be fixed. Now we can use the allocation and collection types of `alloc`. For example, we can use a [`Box`] to allocate a value on the heap:
|
||||
With this static, the compilation errors should be fixed. Now we can use the allocation and collection types of `alloc`. For example, we can use a [`Box`] to allocate a value on the heap:
|
||||
|
||||
[`Box`]: https://doc.rust-lang.org/alloc/boxed/struct.Box.html
|
||||
|
||||
@@ -380,11 +349,11 @@ fn kernel_main(boot_info: &'static BootInfo) -> ! {
|
||||
|
||||
Note that we need to specify the `extern crate alloc` statement in our `main.rs` too. This is required because the `lib.rs` and `main.rs` parts are treated as separate crates. However, we don't need to create another `#[global_allocator]` static because the global allocator applies to all crates in the project. In fact, specifying an additional allocator in another crate would be an error.
|
||||
|
||||
When we run the above code, we see that our `alloc_error_handler` function is called:
|
||||
When we run the above code, we see that a panic occurs:
|
||||
|
||||

|
||||
|
||||
The error handler is called because the `Box::new` function implicitly calls the `alloc` function of the global allocator. Our dummy allocator always returns a null pointer, so every allocation fails. To fix this, we need to create an allocator that actually returns usable memory.
|
||||
The panic occurs because the `Box::new` function implicitly calls the `alloc` function of the global allocator. Our dummy allocator always returns a null pointer, so every allocation fails. To fix this, we need to create an allocator that actually returns usable memory.
|
||||
|
||||
## Creating a Kernel Heap
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ translation_contributors = ["asami-kawasaki", "Foo-x"]
|
||||
[コールスタック]: https://ja.wikipedia.org/wiki/%E3%82%B3%E3%83%BC%E3%83%AB%E3%82%B9%E3%82%BF%E3%83%83%E3%82%AF
|
||||
[コンテキスト・スイッチ (context switch)]: https://ja.wikipedia.org/wiki/%E3%82%B3%E3%83%B3%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%82%B9%E3%82%A4%E3%83%83%E3%83%81
|
||||
|
||||
コールスタックは非常に大きくなる可能性があるため、OSは通常、各タスクのスイッチでコールスタックの内容をバックアップする代わりに、各タスクに個別のコールスタックを設定します。このような独立したスタックを持つタスクは、[_thread of execution_](略して**スレッド**)と呼ばれます。タスクごとに独立したスタックを使用することで、コンテキスト・スイッチの際に保存する必要があるのはレジスタの内容だけになります(プログラム・カウンタとスタック・ポインタを含む)。この方法を取ることで、コンテキスト・スイッチの性能上のオーバーヘッドが最小限になります。これは、コンテキスト・スイッチが1秒間に100回も行われることがあるため、非常に重要なことです。
|
||||
コールスタックは非常に大きくなる可能性があるため、OSは通常、各タスクのスイッチでコールスタックの内容をバックアップする代わりに、各タスクに個別のコールスタックを設定します。このような独立したスタックを持つタスクは、[略して**スレッド**][_thread of execution_]と呼ばれます。タスクごとに独立したスタックを使用することで、コンテキスト・スイッチの際に保存する必要があるのはレジスタの内容だけになります(プログラム・カウンタとスタック・ポインタを含む)。この方法を取ることで、コンテキスト・スイッチの性能上のオーバーヘッドが最小限になります。これは、コンテキスト・スイッチが1秒間に100回も行われることがあるため、非常に重要なことです。
|
||||
|
||||
[_thread of execution_]: https://ja.wikipedia.org/wiki/%E3%82%B9%E3%83%AC%E3%83%83%E3%83%89_(%E3%82%B3%E3%83%B3%E3%83%94%E3%83%A5%E3%83%BC%E3%82%BF)
|
||||
|
||||
|
||||
@@ -82,7 +82,7 @@ We name the project `kernel` here, but of course you can choose your own name.
|
||||
The `--bin` flag specifies that we want to create an executable binary (in contrast to a library) and the `--edition 2021` flag specifies that we want to use the [2021 edition] of Rust for our crate.
|
||||
When we run the command, cargo creates the following directory structure for us:
|
||||
|
||||
[2021 edition]: https://doc.rust-lang.org/nightly/edition-guide/rust-2021/index.html
|
||||
[2021 edition]: https://doc.rust-lang.org/edition-guide/rust-2021/index.html
|
||||
|
||||
```
|
||||
kernel
|
||||
@@ -181,9 +181,9 @@ The [`PanicInfo` parameter][PanicInfo] contains the file and line where the pani
|
||||
The handler function should never return, so it is marked as a [diverging function] by returning the [“never” type] `!`.
|
||||
There is not much we can do in this function for now, so we just loop indefinitely.
|
||||
|
||||
[PanicInfo]: https://doc.rust-lang.org/nightly/core/panic/struct.PanicInfo.html
|
||||
[PanicInfo]: https://doc.rust-lang.org/core/panic/struct.PanicInfo.html
|
||||
[diverging function]: https://doc.rust-lang.org/1.30.0/book/first-edition/functions.html#diverging-functions
|
||||
[“never” type]: https://doc.rust-lang.org/nightly/std/primitive.never.html
|
||||
[“never” type]: https://doc.rust-lang.org/std/primitive.never.html
|
||||
|
||||
After defining a panic handler, only the `eh_personality` language item error remains:
|
||||
|
||||
@@ -314,10 +314,26 @@ For example, the `thumbv7em-none-eabihf` target triple can be used to compile fo
|
||||
|
||||
Our kernel should run on a bare-metal `x86_64` system, so the suitable target triple is [`x86_64-unknown-none`].
|
||||
The `-none` suffix indicates that there is no underlying operating system.
|
||||
To be able to compile for this target, we need to add it using [`rustup`]:
|
||||
To be able to compile for this target, we need to add it using [`rustup`].
|
||||
|
||||
[`x86_64-unknown-none`]: https://doc.rust-lang.org/rustc/platform-support/x86_64-unknown-none.html
|
||||
[`rustup`]: https://doc.rust-lang.org/rustc/platform-support/x86_64-unknown-none.html
|
||||
|
||||
<div class = "note"><details>
|
||||
<summary><em>What is <code>rustup</code></em>?</summary>
|
||||
|
||||
The [`rustup`] tool is the [officially recommended] way of installing Rust.
|
||||
It supports having multiple versions of Rust installed simultaneously and makes upgrading Rust easy.
|
||||
It also provides access to optional tools and components such as [`rustfmt`] or [`rust-analyzer`].
|
||||
This guide requires `rustup`, so please install it if you haven't already.
|
||||
|
||||
[`rustup`]: https://rustup.rs/
|
||||
[officially recommended]: https://www.rust-lang.org/learn/get-started
|
||||
[`rustfmt`]: https://github.com/rust-lang/rustfmt/
|
||||
[`rust-analyzer`]: https://github.com/rust-lang/rust-analyzer
|
||||
|
||||
</details></div>
|
||||
|
||||
To download and set up the `x86_64-unknown-none` target, we use the following `rustup` command:
|
||||
|
||||
```
|
||||
rustup target add x86_64-unknown-none
|
||||
@@ -334,7 +350,12 @@ Afterwards, we can [cross compile] our executable for a bare metal environment b
|
||||
error: requires `start` lang_item
|
||||
```
|
||||
|
||||
We still get the error about a missing `start` language item because we're still depending on the Rust runtime. To remove that dependency, we can use the `#[no_main]` attribute.
|
||||
We still get the error about a missing `start` language item because the custom target only removed the dependency on the C library.
|
||||
To remove the dependency on the Rust runtime as well, we can use the `#[no_main]` attribute.
|
||||
|
||||
Before that, we can do a small cleanup.
|
||||
The `x86_64-unknown-none` target defaults to `panic = "abort"`, so the we can remove the `profile.dev` and `profile.release` tables from our `Cargo.toml` again.
|
||||
|
||||
|
||||
### The `#[no_main]` Attribute
|
||||
|
||||
@@ -424,7 +445,7 @@ Afterwards, you can run the tools through `rust-nm`, `rust-objdump`, and `rust-s
|
||||
|
||||
[`cargo-binutils`]: https://github.com/rust-embedded/cargo-binutils
|
||||
|
||||
### `nm`
|
||||
### List Symbols using `nm`
|
||||
|
||||
We defined a `_start` function as the entry point of our kernel.
|
||||
To verify that it is properly exposed in the executable, we can run `nm` to list all the symbols defined in the executable:
|
||||
@@ -442,7 +463,7 @@ If we comment out the `_start` function or if we remove the `#[no_mangle]` attri
|
||||
|
||||
This way we can ensure that we set the `_start` function correctly.
|
||||
|
||||
### `objdump`
|
||||
### Inspect ELF File using `objdump`
|
||||
|
||||
The `objdump` tool can inspect different parts of executables that use the [ELF file format]. This is the file format that the `x86_64-unknown-none` target uses, so we can use `objdump` to inspect our kernel executable.
|
||||
|
||||
@@ -468,7 +489,7 @@ The start address specifies the memory address of our `_start` function.
|
||||
Here the function name `_start` becomes important.
|
||||
If we rename the function to something else (e.g., `_start_here`) and recompile, we see that no start address is set in the ELF file anymore:
|
||||
|
||||
```hl_lines=5
|
||||
```bash,hl_lines=5
|
||||
❯ rust-objdump -f target/x86_64-unknown-none/debug/kernel
|
||||
|
||||
target/x86_64-unknown-none/debug/kernel: file format elf64-x86-64
|
||||
@@ -480,7 +501,7 @@ start address: 0x0000000000000000
|
||||
|
||||
Using `objdump -h`, we can print the various sections of our kernel executable:
|
||||
|
||||
```
|
||||
```bash,hl_lines=12
|
||||
❯ rust-objdump -h target/x86_64-unknown-none/debug/kernel
|
||||
|
||||
target/x86_64-unknown-none/debug/kernel: file format elf64-x86-64
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 5.0 KiB |
@@ -12,14 +12,480 @@ icon = '''<svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" class="bi
|
||||
</svg>'''
|
||||
+++
|
||||
|
||||
Dolores qui incidunt sit fugiat amet consequatur. Qui ab vel et molestias ex nemo corporis consequatur. Quia consequuntur itaque sequi quia autem. Maxime vel quis maxime at. Tenetur eveniet velit dolor quidem temporibus tenetur.
|
||||
In this post we focus on the [framebuffer], a special memory region that controls the screen output.
|
||||
Using an [external crate], we will create functions for writing individual pixels, lines, and various shapes.
|
||||
In the the second half of this post, we will explore text rendering and learn how to print the obligatory _["Hello, World!"]_.
|
||||
|
||||
[framebuffer]: https://en.wikipedia.org/wiki/Framebuffer
|
||||
[external crate]: https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html
|
||||
["Hello, World!"]: https://en.wikipedia.org/wiki/Hello_world
|
||||
|
||||
<!-- more -->
|
||||
|
||||
Molestiae quidem ipsa nihil laboriosam sapiente laudantium quia. Praesentium et repudiandae minima voluptas et. Repellendus voluptatem distinctio enim et alias distinctio recusandae quos. Dolores ex eum culpa quo sunt sint voluptate voluptates. Facere unde sequi quo ea vel nihil. Rem deleniti repellat rem molestias
|
||||
This blog is openly developed on [GitHub].
|
||||
If you have any problems or questions, please open an issue there.
|
||||
You can also leave comments [at the bottom].
|
||||
The complete source code for this post can be found in the [`post-3.3`][post branch] branch.
|
||||
|
||||
[GitHub]: https://github.com/phil-opp/blog_os
|
||||
[at the bottom]: #comments
|
||||
<!-- fix for zola anchor checker (target is in template): <a id="comments"> -->
|
||||
[post branch]: https://github.com/phil-opp/blog_os/tree/post-3.3
|
||||
|
||||
<!-- toc -->
|
||||
Molestiae quidem ipsa nihil laboriosam sapiente laudantium quia. Praesentium et repudiandae minima voluptas et. Repellendus voluptatem distinctio enim et alias distinctio recusandae quos. Dolores ex eum culpa quo sunt sint voluptate voluptates. Facere unde sequi quo ea vel nihil. Rem deleniti repellat rem molestias
|
||||
|
||||
## Bitmap Images
|
||||
|
||||
In the [previous post], we learned how to make our minimal kernel bootable.
|
||||
Using the [`BootInfo`] provided by the bootloader, we were able to access a special memory region called the _[framebuffer]_, which controls the screen output.
|
||||
We wrote some example code to display a gray background:
|
||||
|
||||
[previous post]: @/edition-3/posts/02-booting/index.md
|
||||
[`BootInfo`]: https://docs.rs/bootloader_api/0.11/bootloader_api/info/struct.BootInfo.html
|
||||
|
||||
```rust
|
||||
// in kernel/src/main.rs
|
||||
|
||||
fn kernel_main(boot_info: &'static mut BootInfo) -> ! {
|
||||
if let Some(framebuffer) = boot_info.framebuffer.as_mut() {
|
||||
for byte in framebuffer.buffer_mut() {
|
||||
*byte = 0x90;
|
||||
}
|
||||
}
|
||||
loop {}
|
||||
}
|
||||
```
|
||||
|
||||
The reason that the above code affects the screen output is because the graphics card interprets the framebuffer memory as a [bitmap] image.
|
||||
A bitmap describes an image through a predefined number of bytes per pixel.
|
||||
The pixels are laid out line by line, typically starting at the top.
|
||||
|
||||
[bitmap]: https://en.wikipedia.org/wiki/Bitmap
|
||||
[RGB]: https://en.wikipedia.org/wiki/Rgb
|
||||
|
||||
For example, the pixels of an image with width 10 and height 3 would be typically stored in this order:
|
||||
|
||||
<table style = "width: fit-content;"><tbody>
|
||||
<tr><td>0</td><td>1</td><td>2</td><td>3</td><td>4</td><td>5</td><td>6</td><td>7</td><td>8</td><td>9</td></tr>
|
||||
<tr><td>10</td><td>11</td><td>12</td><td>13</td><td>14</td><td>15</td><td>16</td><td>17</td><td>18</td><td>19</td></tr>
|
||||
<tr><td>20</td><td>21</td><td>22</td><td>23</td><td>24</td><td>25</td><td>26</td><td>27</td><td>28</td><td>29</td></tr>
|
||||
</tbody></table>
|
||||
|
||||
So top left pixel is stored at offset 0 in the bitmap array.
|
||||
The pixel on its right is at pixel offset 1.
|
||||
The first pixel of the next line starts at pixel offset `line_length`, which is 10 in this case.
|
||||
The last line starts at pixel offset 20, which is `line_length * 2`.
|
||||
|
||||
### Padding
|
||||
|
||||
Depending on the hardware and GPU firmware, it is often more efficient to make lines start at well-aligned offsets.
|
||||
Because of this, there is often some additional padding at the end of each line.
|
||||
So the actual memory layout of the 10x3 example image might look like this, with the padding marked as yellow:
|
||||
|
||||
<table style = "width: fit-content;"><tbody>
|
||||
<tr><td>0</td><td>1</td><td>2</td><td>3</td><td>4</td><td>5</td><td>6</td><td>7</td><td>8</td><td>9</td><td style="background-color:yellow;">10</td><td style="background-color:yellow;">11</td></tr>
|
||||
<tr><td>12</td><td>13</td><td>14</td><td>15</td><td>16</td><td>17</td><td>18</td><td>19</td><td>20</td><td>21</td><td style="background-color:yellow;">22</td><td style="background-color:yellow;">23</td></tr>
|
||||
<tr><td>24</td><td>25</td><td>26</td><td>27</td><td>28</td><td>29</td><td>30</td><td>31</td><td>32</td><td>33</td><td style="background-color:yellow;">34</td><td style="background-color:yellow;">35</td></tr>
|
||||
</tbody></table>
|
||||
|
||||
So now the second line starts at pixel offset 12.
|
||||
The two pixels at the end of each line are considered as padding and ignored.
|
||||
So if we want to set the first pixel of the second line, we need to be aware of the additional padding and set the pixel at offset 12 instead of offset 10.
|
||||
|
||||
The line length plus the padding bytes is typically called the _stride_ or _pitch_ of the buffer.
|
||||
In the example above, the stride is 12 and the line length is 10.
|
||||
|
||||
Since the amount of padding depends on the hardware, the stride is only known at runtime.
|
||||
The `bootloader` crate queries the framebuffer parameters from the UEFI or BIOS firmware and reports them as part of the `BootInfo`.
|
||||
It provides the stride of the framebuffer, among other parameters, in form of a [`FrameBufferInfo`] struct that can be created using the [`FrameBuffer::info`] method.
|
||||
|
||||
[`FrameBufferInfo`]: https://docs.rs/bootloader_api/0.11/bootloader_api/info/struct.FrameBufferInfo.html
|
||||
[`FrameBuffer::info`]: https://docs.rs/bootloader_api/0.11/bootloader_api/info/struct.FrameBuffer.html#method.info
|
||||
|
||||
### Color formats
|
||||
|
||||
The [`FrameBufferInfo`] also specifies the [`PixelFormat`] of the framebuffer, which also depends on the underlying hardware.
|
||||
Using this information, we can set pixels to different colors.
|
||||
For example, the [`PixelFormat::Rgb`] variant specifies that each pixel is represented in the [RGB color space], which stores the red, green, and blue parts of the pixel as separate bytes.
|
||||
In this model, the color red would be represented as the three bytes `[255, 0, 0]`, or `0xff0000` in [hexadecimal representation].
|
||||
The color yellow is represented the addition of red and green, which results in `[255, 255, 0]` (or `0xffff00` in hexadecimal representation).
|
||||
|
||||
[`PixelFormat`]: https://docs.rs/bootloader_api/0.11/bootloader_api/info/enum.PixelFormat.html
|
||||
[`PixelFormat::Rgb`]: https://docs.rs/bootloader_api/0.11/bootloader_api/info/enum.PixelFormat.html#variant.Rgb
|
||||
[RGB color space]: https://en.wikipedia.org/wiki/RGB_color_spaces
|
||||
[hexadecimal representation]: https://en.wikipedia.org/wiki/RGB_color_model#Numeric_representations
|
||||
|
||||
While the `Rgb` format is most common, there are also framebuffers that use a different color format.
|
||||
For example, the [`PixelFormat::Bgr`] stores the three colors in inverted order, i.e. blue first and red last.
|
||||
There are also buffers that don't support colors at all and can represent only grayscale pixels.
|
||||
The `bootloader_api` crate reports such buffers as [`PixelFormat::U8`].
|
||||
|
||||
[`PixelFormat::Bgr`]: https://docs.rs/bootloader_api/0.11.5/bootloader_api/info/enum.PixelFormat.html#variant.Bgr
|
||||
[`PixelFormat::U8`]: https://docs.rs/bootloader_api/0.11.5/bootloader_api/info/enum.PixelFormat.html#variant.U8
|
||||
|
||||
Note that there might be some additional padding at the pixel-level as well.
|
||||
For example, an `Rgb` pixel might be stored as 4 bytes instead of 3 to ensure 32-bit alignment.
|
||||
The number of bytes per pixel is reported by the bootloader in the [`FrameBufferInfo::bytes_per_pixel`] field.
|
||||
|
||||
[`FrameBufferInfo::bytes_per_pixel`]: https://docs.rs/bootloader_api/0.11/bootloader_api/info/struct.FrameBufferInfo.html#structfield.bytes_per_pixel
|
||||
|
||||
## Setting specific Pixels
|
||||
|
||||
Based on this above details, we can now create a function to set a specific pixel to a certain color.
|
||||
We start by creating a new `framebuffer` [module]:
|
||||
|
||||
[module]: https://doc.rust-lang.org/book/ch07-02-defining-modules-to-control-scope-and-privacy.html
|
||||
|
||||
```rust ,hl_lines=3-5
|
||||
// in kernel/src/main.rs
|
||||
|
||||
// declare a submodule -> the compiler will automatically look
|
||||
// for a file named `framebuffer.rs` or `framebuffer/mod.rs`
|
||||
mod framebuffer;
|
||||
```
|
||||
|
||||
In the new module, we create basic structs for representing pixel positions and colors:
|
||||
|
||||
```rust ,hl_lines=3-16
|
||||
// in new kernel/src/framebuffer.rs file
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub struct Position {
|
||||
pub x: usize,
|
||||
pub y: usize,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub struct Color {
|
||||
pub red: u8,
|
||||
pub green: u8,
|
||||
pub blue: u8,
|
||||
}
|
||||
```
|
||||
|
||||
By marking the structs and their fields as `pub`, we make them accessible from the parent `kernel` module.
|
||||
We use the `#[derive]` attribute to implement the [`Debug`], [`Clone`], [`Copy`], [`PartialEq`], and [`Eq`] traits of Rust's core library.
|
||||
These traits allow us to duplicate, compare, and print the structs.
|
||||
|
||||
[`Debug`]: https://doc.rust-lang.org/stable/core/fmt/trait.Debug.html
|
||||
[`Clone`]: https://doc.rust-lang.org/stable/core/clone/trait.Clone.html
|
||||
[`Copy`]: https://doc.rust-lang.org/stable/core/marker/trait.Copy.html
|
||||
[`PartialEq`]: https://doc.rust-lang.org/stable/core/cmp/trait.PartialEq.html
|
||||
[`Eq`]: https://doc.rust-lang.org/stable/core/cmp/trait.Eq.html
|
||||
|
||||
Next, we create a function for setting a specific pixel in the framebuffer to a given color:
|
||||
|
||||
```rust ,hl_lines=3 5-39
|
||||
// in new kernel/src/framebuffer.rs file
|
||||
|
||||
use bootloader_api::info::{FrameBuffer, PixelFormat};
|
||||
|
||||
pub fn set_pixel_in(framebuffer: &mut FrameBuffer, position: Position, color: Color) {
|
||||
let info = framebuffer.info();
|
||||
|
||||
// calculate offset to first byte of pixel
|
||||
let byte_offset = {
|
||||
// use stride to calculate pixel offset of target line
|
||||
let line_offset = position.y * info.stride;
|
||||
// add x position to get the absolute pixel offset in buffer
|
||||
let pixel_offset = line_offset + position.x;
|
||||
// convert to byte offset
|
||||
pixel_offset * info.bytes_per_pixel
|
||||
};
|
||||
|
||||
// set pixel based on color format
|
||||
let pixel_buffer = &mut framebuffer.buffer_mut()[byte_offset..];
|
||||
match info.pixel_format {
|
||||
PixelFormat::Rgb => {
|
||||
pixel_buffer[0] = color.red;
|
||||
pixel_buffer[1] = color.green;
|
||||
pixel_buffer[2] = color.blue;
|
||||
}
|
||||
PixelFormat::Bgr => {
|
||||
pixel_buffer[0] = color.blue;
|
||||
pixel_buffer[1] = color.green;
|
||||
pixel_buffer[2] = color.red;
|
||||
}
|
||||
PixelFormat::U8 => {
|
||||
// use a simple average-based grayscale transform
|
||||
let gray = color.red / 3 + color.green / 3 + color.blue / 3;
|
||||
pixel_buffer[0] = gray;
|
||||
}
|
||||
other => panic!("unknown pixel format {other:?}"),
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The first step is to calculate the byte offset within the framebuffer slice at which the pixel starts.
|
||||
For this, we first calculate the pixel offset of the line by multiplying the `y` position with the stride of the framebuffer, i.e. its line width plus the line padding.
|
||||
We then add the `x` position to get the absolute index of the pixel.
|
||||
As the framebuffer slice is a byte slice, we need to transform the pixel index to a byte offset by multiplying it with the number of `bytes_per_pixel`.
|
||||
|
||||
[`FrameBuffer::buffer_mut`]: https://docs.rs/bootloader_api/0.11.5/bootloader_api/info/struct.FrameBuffer.html#method.buffer_mut
|
||||
|
||||
The second step is to set the pixel to the desired color.
|
||||
We first use the [`FrameBuffer::buffer_mut`] method to get access to the actual bytes of the framebuffer in form of a slice.
|
||||
Then, we use the slicing operator `[byte_offset..]` to get a sub-slice starting at the `byte_offset` of the target pixel.
|
||||
As the write operation depends on the pixel format, we use a [`match`] statement:
|
||||
|
||||
[`match`]: https://doc.rust-lang.org/stable/std/keyword.match.html
|
||||
|
||||
- For `Rgb` framebuffers, we write three bytes; first red, then green, then blue.
|
||||
- For `Bgr` framebuffers, we also write three bytes, but blue first and red last.
|
||||
- For `U8` framebuffers, we first convert the color to grayscale by taking the average of the three color channels.
|
||||
Note that there are multiple [different ways to convert colors to grayscale], so you can also use different factors here.
|
||||
- For all other framebuffer formats, we [panic] for now.
|
||||
|
||||
[different ways to convert colors to grayscale]: https://www.baeldung.com/cs/convert-rgb-to-grayscale#bd-convert-rgb-to-grayscale
|
||||
[panic]: https://doc.rust-lang.org/stable/core/macro.panic.html
|
||||
|
||||
Let's try to use our new function to write a blue pixel in our `kernel_main` function:
|
||||
|
||||
```rust ,hl_lines=5-11
|
||||
// in kernel/src/main.rs
|
||||
|
||||
fn kernel_main(boot_info: &'static mut BootInfo) -> ! {
|
||||
if let Some(framebuffer) = boot_info.framebuffer.as_mut() {
|
||||
let position = framebuffer::Position { x: 20, y: 100 };
|
||||
let color = framebuffer::Color {
|
||||
red: 0,
|
||||
green: 0,
|
||||
blue: 255,
|
||||
};
|
||||
framebuffer::set_pixel_in(framebuffer, position, color);
|
||||
}
|
||||
loop {}
|
||||
}
|
||||
```
|
||||
|
||||
When we run our code in QEMU using `cargo run --bin qemu-bios` (or `--bin qemu-uefi`) and look _very closely_, we can see the blue pixel.
|
||||
It's really difficult to see, so I marked with an arrow below:
|
||||
|
||||

|
||||
|
||||
As this single pixel is too difficult to see, let's draw a filled square of 100x100 pixels instead:
|
||||
|
||||
```rust ,hl_lines=10-18
|
||||
// in kernel/src/main.rs
|
||||
|
||||
fn kernel_main(boot_info: &'static mut BootInfo) -> ! {
|
||||
if let Some(framebuffer) = boot_info.framebuffer.as_mut() {
|
||||
let color = framebuffer::Color {
|
||||
red: 0,
|
||||
green: 0,
|
||||
blue: 255,
|
||||
};
|
||||
for x in 0..100 {
|
||||
for y in 0..100 {
|
||||
let position = framebuffer::Position {
|
||||
x: 20 + x,
|
||||
y: 100 + y,
|
||||
};
|
||||
framebuffer::set_pixel_in(framebuffer, position, color);
|
||||
}
|
||||
}
|
||||
}
|
||||
loop {}
|
||||
}
|
||||
```
|
||||
|
||||
Now we clearly see that our code works as intended:
|
||||
|
||||

|
||||
|
||||
Feel free to experiment with different positions and colors if you like.
|
||||
You can also try to draw a circle instead of a square, or a line with a certain thickness.
|
||||
|
||||
As you can probably imagine, it would be a lot of work to draw more complex shapes this way.
|
||||
One example for such complex shapes is _text_, i.e. the rendering of letters and punctuation.
|
||||
Fortunately, there is the nice `no_std`-compatible [`embedded-graphics`] crate, which provides draw functions for text, various shapes, and image data.
|
||||
|
||||
[`embedded-graphics`]: https://docs.rs/embedded-graphics/latest/embedded_graphics/index.html
|
||||
|
||||
## The `embedded-graphics` crate
|
||||
|
||||
|
||||
|
||||
### Implementing `DrawTarget`
|
||||
|
||||
```rust ,hl_lines=3
|
||||
// in kernel/src/framebuffer.rs
|
||||
use embedded_graphics::{
|
||||
Pixel,
|
||||
draw_target::DrawTarget,
|
||||
geometry::{OriginDimensions, Size},
|
||||
pixelcolor::{Rgb888, RgbColor},
|
||||
};
|
||||
|
||||
pub struct Display<'f> {
|
||||
framebuffer: &'f mut FrameBuffer,
|
||||
}
|
||||
|
||||
impl<'f> Display<'f> {
|
||||
pub fn new(framebuffer: &'f mut FrameBuffer) -> Display {
|
||||
Display { framebuffer }
|
||||
}
|
||||
|
||||
fn draw_pixel(&mut self, Pixel(coordinates, color): Pixel<Rgb888>) {
|
||||
// ignore any out of bounds pixels
|
||||
let (width, height) = {
|
||||
let info = self.framebuffer.info();
|
||||
|
||||
(info.width, info.height)
|
||||
};
|
||||
|
||||
let (x, y) = {
|
||||
let c: (i32, i32) = coordinates.into();
|
||||
(c.0 as usize, c.1 as usize)
|
||||
};
|
||||
|
||||
if (0..width).contains(&x) && (0..height).contains(&y) {
|
||||
let color = Color { red: color.r(), green: color.g(), blue: color.b() };
|
||||
|
||||
set_pixel_in(self.framebuffer, Position { x, y }, color);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
impl<'f> DrawTarget for Display<'f> {
|
||||
type Color = Rgb888;
|
||||
|
||||
/// Drawing operations can never fail.
|
||||
type Error = core::convert::Infallible;
|
||||
|
||||
fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>
|
||||
where
|
||||
I: IntoIterator<Item = Pixel<Self::Color>>,
|
||||
{
|
||||
for pixel in pixels.into_iter() {
|
||||
self.draw_pixel(pixel);
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl<'f> OriginDimensions for Display<'f> {
|
||||
fn size(&self) -> Size {
|
||||
let info = self.framebuffer.info();
|
||||
|
||||
Size::new(info.width as u32, info.height as u32)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
So far, we have drawn shapes and pixels directly onto the framebuffer. That's fine and all, but how is one able to go from that to displaying text on the screen? Understanding this requires taking a deep dive into how characters are rendered behind the scenes.
|
||||
|
||||
When a key is pressed on the keyboard, it sends a character code to the CPU. It's the CPU's job at that point to then interpret the character code and match it with an image to draw on the screen. The image is then sent to either the GPU or the framebuffer (the latter in our case) to be drawn on the screen, and the user sees that image as a letter, number, CJK character, emoji, or whatever else he or she wanted to have displayed by pressing that key.
|
||||
|
||||
In most other programming languages, implementing this behind the scenes can be a daunting task. With Rust, however, we have a toolset at our disposal that can pave the way for setting up proper framebuffer logging using very little code of our own.
|
||||
|
||||
# The `log` crate
|
||||
|
||||
Rust developers used to writing user-mode code will recognize the `log` crate from a mile away:
|
||||
|
||||
```toml
|
||||
# in Cargo.toml
|
||||
[dependencies]
|
||||
log = { version = "0.4.17", default-features = false }
|
||||
```
|
||||
|
||||
This crate has both a set of macros for logging either to the console or to a log file for later reading and a trait — also called `Log` with a capital L — that can be implemented to provide a backend, called a `Logger` in Rust parlance. Loggers are provided by a myriad of crates for a wide variety of use cases, and some of them even run on bare metal. We already used one such extant logger in the UEFI booting module when we used the logger provided by the `uefi` crate to print text to the UEFI console. That won't work in the kernel, however, because UEFI boot services need to be active in order for the UEFI logger to be usable.
|
||||
|
||||
If you were paying attention to the post before that one, however, you may have noticed that the bootloader is itself able to log directly to the framebuffer as it did when we booted the barebones kernel for the first time, and unlike the UEFI console logger, this logger is usable long after UEFI boot services are exited. It's this logger, therefore, that provides the easiest means of implementation on our end.
|
||||
|
||||
## `bootloader-x86_64-common`
|
||||
|
||||
In version 0.11.x of the bootloader crate, each component is separate, unlike in 0.10.x where the bootloader was a huge monolith. This is fantastic as it means that a lot of the APIs that the bootloader uses behind the scenes are also free for kernels to use, including, of course, the logger. The set of APIs that the logger belongs to are in a crate called `bootloader-x86_64-common` which also contains some other useful abstractions related to things like memory management that will come in handy later:
|
||||
|
||||
```toml
|
||||
# in Cargo.toml
|
||||
[dependencies]
|
||||
bootloader-x86_64-common = "0.11.3"
|
||||
```
|
||||
|
||||
For now, however, only the logger will be used. If you are curious as to how this logger is written behind the scenes, however, don't worry; a sub-module of this chapter will include a tutorial on how to write a custom logger from scratch.
|
||||
|
||||
# Putting it all together
|
||||
|
||||
Before we use the bootloader's logger, we first need to initialize it. This requires creating a static instance, since it needs to live for as long as the kernel lives — which would mean for as long as the computer is powered on. Unfortunately, this is easier said than done, as Rust statics can be rather finicky — understandably so for security reasons. Luckily, there's a crate for this too.
|
||||
|
||||
## The `conquer_once` crate
|
||||
|
||||
Those used to using the standard library know that it provides a `OnceCell` which is exactly what it sounds like: you write to it only once, and then after that it's just there to use whenever. We're in a kernel and don't have access to the standard library, however, so is there a crate on crates.io that provides a replacement? Ah, yes there is:
|
||||
|
||||
```toml
|
||||
# in Cargo.toml
|
||||
[dependencies]
|
||||
conquer-once = { version = "0.4.0", default-features = false }
|
||||
```
|
||||
|
||||
Note that we need to add `default-features = false` to our `conquer-once` dependency —that's because the [`conquer-once` crate](https://crates.io/crates/conquer-once) tries to pull in the standard library by default, which in the kernel will result in compilation errors.
|
||||
|
||||
Now that we've added our two dependencies, it's time to use them:
|
||||
|
||||
```rust
|
||||
// in src/main.rs
|
||||
use conquer_once::spin::OnceCell;
|
||||
use bootloader_x86_64_common::logger::LockedLogger;
|
||||
// ...
|
||||
pub(crate) static LOGGER: OnceCell<LockedLogger> = OnceCell::uninit();
|
||||
```
|
||||
|
||||
By setting the logger up as a static `OnceCell` it becomes much easier to initialize. We use `pub(crate)` to ensure that the kernel can see it but nothing else can.
|
||||
|
||||
After this, it's time to actually initialize it. To do that, we use a function:
|
||||
|
||||
```rust
|
||||
// in src/main.rs
|
||||
use bootloader_api::info::FrameBufferInfo;
|
||||
// ...
|
||||
pub(crate) fn init_logger(buffer: &'static mut [u8], info: FrameBufferInfo) {
|
||||
let logger = LOGGER.get_or_init(move || LockedLogger::new(buffer, info, true, false));
|
||||
log::set_logger(logger).expect("Logger already set");
|
||||
log::set_max_level(log::LevelFilter::Trace);
|
||||
log::info!("Hello, Kernel Mode!");
|
||||
}
|
||||
```
|
||||
|
||||
This function takes two parameters: a byte slice representing a raw framebuffer and a `FrameBufferInfo` structure containing information about the first parameter. Getting those parameters, however, requires jumping through some hoops to satisfy the borrow checker:
|
||||
|
||||
```rust
|
||||
// in src/main.rs
|
||||
fn kernel_main(boot_info: &'static mut bootloader_api::BootInfo) -> ! {
|
||||
// ...
|
||||
// free the doubly wrapped framebuffer from the boot info struct
|
||||
let frame_buffer_optional = &mut boot_info.framebuffer;
|
||||
|
||||
// free the wrapped framebuffer from the FFI-safe abstraction provided by bootloader_api
|
||||
let frame_buffer_option = frame_buffer_optional.as_mut();
|
||||
|
||||
// unwrap the framebuffer
|
||||
let frame_buffer_struct = frame_buffer_option.unwrap();
|
||||
|
||||
// extract the framebuffer info and, to satisfy the borrow checker, clone it
|
||||
let frame_buffer_info = frame_buffer_struct.info().clone();
|
||||
|
||||
// get the framebuffer's mutable raw byte slice
|
||||
let raw_frame_buffer = frame_buffer_struct.buffer_mut();
|
||||
|
||||
// finally, initialize the logger using the last two variables
|
||||
init_logger(raw_frame_buffer, frame_buffer_info);
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
Any one of these steps, if skipped, will cause the borrow checker to throw a hissy fit due to the use of the `move ||` closure by the initializer function. With this, however, you're done, and you'll know the logger has been initialized when you see "Hello, Kernel Mode!" printed on the screen.
|
||||
|
||||
<!-- more -->
|
||||
<!-- toc -->
|
||||
|
||||
<!-- TODO: update relative link in 02-booting/uefi/index.md when this post is finished -->
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 107 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 100 KiB |
@@ -22,13 +22,13 @@
|
||||
*/
|
||||
|
||||
/* Fonts */
|
||||
|
||||
@font-face {
|
||||
font-family: "Iosevka";
|
||||
src: url("/fonts/iosevka-regular.woff2") format("woff2"), url("/fonts/iosevka-regular.woff") format("woff");
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
font-display: swap;
|
||||
font-family: 'Iosevka Web';
|
||||
font-display: swap;
|
||||
font-weight: 400;
|
||||
font-stretch: normal;
|
||||
font-style: normal;
|
||||
src: url('/fonts/ttf/iosevka-regular.ttf') format('truetype'), url('/fonts/woff2/iosevka-regular.woff2') format('woff2');
|
||||
}
|
||||
|
||||
/*
|
||||
@@ -221,7 +221,7 @@ abbr[title] {
|
||||
/* Code */
|
||||
code,
|
||||
pre {
|
||||
font-family: "Iosevka", monospace;
|
||||
font-family: "Iosevka Web", monospace;
|
||||
}
|
||||
code {
|
||||
padding: 0.25em 0.5em;
|
||||
|
||||
@@ -22,13 +22,29 @@
|
||||
*/
|
||||
|
||||
/* Fonts */
|
||||
|
||||
@font-face {
|
||||
font-family: "Iosevka";
|
||||
src: url("/fonts/iosevka-regular.woff2") format("woff2"), url("/fonts/iosevka-regular.woff") format("woff");
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
font-display: swap;
|
||||
font-family: 'Iosevka Web';
|
||||
font-display: swap;
|
||||
font-weight: 400;
|
||||
font-stretch: normal;
|
||||
font-style: normal;
|
||||
src: url('/fonts/ttf/iosevka-regular.ttf') format('truetype'), url('/fonts/woff2/iosevka-regular.woff2') format('woff2');
|
||||
}
|
||||
@font-face {
|
||||
font-family: 'Iosevka Web';
|
||||
font-display: swap;
|
||||
font-weight: 700;
|
||||
font-stretch: normal;
|
||||
font-style: normal;
|
||||
src: url('ttf/iosevka-bold.ttf') format('truetype'), url('woff2/iosevka-bold.woff2') format('woff2');
|
||||
}
|
||||
@font-face {
|
||||
font-family: 'Iosevka Web';
|
||||
font-display: swap;
|
||||
font-weight: 400;
|
||||
font-stretch: normal;
|
||||
font-style: italic;
|
||||
src: url('ttf/iosevka-italic.ttf') format('truetype'), url('woff2/iosevka-italic.woff2') format('woff2');
|
||||
}
|
||||
|
||||
/*
|
||||
@@ -60,7 +76,7 @@ html {
|
||||
--background-color: #fff;
|
||||
--text-color: #515151;
|
||||
--heading-color: #313131;
|
||||
--heading-code-color: #a0565c;
|
||||
--heading-code-color: #313131;
|
||||
--link-color: #268bd2;
|
||||
--hr-color-top: #eee;
|
||||
--hr-color-bottom: #fff;
|
||||
@@ -77,8 +93,8 @@ html {
|
||||
--border-color-section-basic-io: #99ff99;
|
||||
|
||||
// colors with transparency that work for both light and dark mode
|
||||
--background-color-note: #00ff001a;
|
||||
--border-color-note: #00ff0050;
|
||||
--background-color-note: #6666cc1a;
|
||||
--border-color-note: #6666cc50;
|
||||
}
|
||||
|
||||
@mixin set-colors-dark {
|
||||
@@ -165,11 +181,11 @@ h6 {
|
||||
text-rendering: optimizeLegibility;
|
||||
}
|
||||
h1 {
|
||||
font-size: 2rem;
|
||||
font-size: 2.25rem;
|
||||
}
|
||||
h2 {
|
||||
margin-top: 1rem;
|
||||
font-size: 1.5rem;
|
||||
font-size: 1.75rem;
|
||||
}
|
||||
h3 {
|
||||
margin-top: 1.5rem;
|
||||
@@ -180,6 +196,7 @@ h5,
|
||||
h6 {
|
||||
margin-top: 1rem;
|
||||
font-size: 1rem;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* Body text */
|
||||
@@ -243,7 +260,7 @@ abbr[title] {
|
||||
/* Code */
|
||||
code,
|
||||
pre {
|
||||
font-family: "Iosevka", monospace;
|
||||
font-family: "Iosevka Web", monospace;
|
||||
}
|
||||
code {
|
||||
padding: 0.25em 0.5em;
|
||||
@@ -263,6 +280,19 @@ pre {
|
||||
overflow: auto;
|
||||
word-wrap: normal;
|
||||
background-color: var(--code-background-color);
|
||||
&.language-rust, &.language-toml {
|
||||
padding-left: 15px;
|
||||
mark {
|
||||
border-left: 3px solid rgba(0, 200, 0, 1);
|
||||
margin-left: -10px;
|
||||
padding-left: 7px;
|
||||
font-weight: bold;
|
||||
}
|
||||
}
|
||||
&.language-bash mark {
|
||||
font-weight: bold;
|
||||
color: rgba(255, 255, 255, 1);
|
||||
}
|
||||
}
|
||||
pre code {
|
||||
padding: 0;
|
||||
@@ -275,8 +305,8 @@ pre mark {
|
||||
display: block;
|
||||
// use the code color (instead of black)
|
||||
color: inherit;
|
||||
// override the background color (instead of black)
|
||||
background-color: rgba(0, 255, 0, 0.1) !important;
|
||||
// override the hardcoded background color (set to black by the theme)
|
||||
background-color: transparent !important;
|
||||
}
|
||||
|
||||
.highlight {
|
||||
|
||||
Binary file not shown.
Binary file not shown.
BIN
blog/static/fonts/ttf/iosevka-bold.ttf
Normal file
BIN
blog/static/fonts/ttf/iosevka-bold.ttf
Normal file
Binary file not shown.
BIN
blog/static/fonts/ttf/iosevka-italic.ttf
Normal file
BIN
blog/static/fonts/ttf/iosevka-italic.ttf
Normal file
Binary file not shown.
BIN
blog/static/fonts/ttf/iosevka-regular.ttf
Normal file
BIN
blog/static/fonts/ttf/iosevka-regular.ttf
Normal file
Binary file not shown.
BIN
blog/static/fonts/woff2/iosevka-bold.woff2
Normal file
BIN
blog/static/fonts/woff2/iosevka-bold.woff2
Normal file
Binary file not shown.
BIN
blog/static/fonts/woff2/iosevka-italic.woff2
Normal file
BIN
blog/static/fonts/woff2/iosevka-italic.woff2
Normal file
Binary file not shown.
BIN
blog/static/fonts/woff2/iosevka-regular.woff2
Normal file
BIN
blog/static/fonts/woff2/iosevka-regular.woff2
Normal file
Binary file not shown.
@@ -10,9 +10,11 @@
|
||||
{% macro giscus(search_term, lang) %}
|
||||
{% if lang != "en" %}
|
||||
{% set category = "Post Comments (translated)" %}
|
||||
{% set category_id = "DIC_kwDOAlvePc4CPg4c" %}
|
||||
{% set category_path = "post-comments-translated" %}
|
||||
{% else %}
|
||||
{% set category = "Post Comments" %}
|
||||
{% set category_id = "MDE4OkRpc2N1c3Npb25DYXRlZ29yeTMzMDE4OTg1" %}
|
||||
{% set category_path = "post-comments" %}
|
||||
{% endif %}
|
||||
|
||||
@@ -33,7 +35,7 @@
|
||||
data-repo="phil-opp/blog_os"
|
||||
data-repo-id="MDEwOlJlcG9zaXRvcnkzOTU3NTEwMQ=="
|
||||
data-category="{{ category }}"
|
||||
data-category-id="MDE4OkRpc2N1c3Npb25DYXRlZ29yeTMzMDE4OTg1"
|
||||
data-category-id="{{ category_id }}"
|
||||
{% if search_term is number %}
|
||||
data-mapping="number"
|
||||
{% else %}
|
||||
|
||||
Reference in New Issue
Block a user