https://github.com/nuta/microkernel-book
『自作OSで学ぶマイクロカーネルの設計と実装』サポートサイト
https://github.com/nuta/microkernel-book
educational microkernel operating-system
Last synced: about 2 months ago
JSON representation
『自作OSで学ぶマイクロカーネルの設計と実装』サポートサイト
- Host: GitHub
- URL: https://github.com/nuta/microkernel-book
- Owner: nuta
- License: mit
- Created: 2023-03-31T08:08:43.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T13:13:36.000Z (4 months ago)
- Last Synced: 2025-03-27T09:14:20.546Z (about 2 months ago)
- Topics: educational, microkernel, operating-system
- Language: C
- Homepage:
- Size: 1.1 MB
- Stars: 210
- Watchers: 8
- Forks: 25
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 『自作OSで学ぶマイクロカーネルの設計と実装』サポートサイト
このリポジトリは、[『自作OSで学ぶマイクロカーネルの設計と実装』(秀和システム、ISBN: 978-4-7980-6871-8)](https://www.hanmoto.com/bd/isbn/9784798068718) のサポートサイト兼、教育用マイクロカーネルOS「HinaOS」のソースコードの配布場所です。
- [質問・バグ報告など (GitHub Discussions)](https://github.com/nuta/microkernel-book/discussions)
- [HinaOS: ビルド・実行方法](#開発環境構築)
- [HinaOS: 内部構造の概要](ARCHITECTURE.md)
- [HinaOS: 実験テーマのアイデア集](IDEAS.md)
- [HinaOS: デバッグガイド](DEBUG.md)
## HinaOSをベースに自作OSをしたい方（おすすめ）
`printf`関数で変数の中身を追ったり、デバッガを使って処理の流れを追ったりしながら、まずはHinaOSを改造して全体を理解していくアプローチです。
HinaOSに手を加えながら本書を読み進めていくことで、OSの仕組みをより深く理解することができます。一通り読んだあとは、[こちらのドキュメント](IDEAS.md) にまとめてある実験テーマから興味のあるものを選んで実装してみるとより楽しめるでしょう。
序盤に実装する必要があるくせにデバッグの難易度が非常に高く苦しいCPU初期化処理・割り込み周りの実装を、HinaOSをベースにすればスキップできるのでおすすめです。
## ゼロから自作OSをしたい方
本書はOSを体系的に学べるように各機能ごとにまとめて実装例を紹介しています。ただこのアプローチでは、ゼロから作って漸進的に学ぶことが難しく、一体どこから手をつければいいのか分かりにくいものです。
「HinaOSベースではなく、ゼロからステップバイステップで自作OSを作りたい」という方のために [1,000行で小さなRISC-V用OSを作る資料](https://operating-system-in-1000-lines.vercel.app) を用意しました。最初の一歩さえ乗り越えられれば、あとは本書の興味のある部分をHinaOSを参考にしながら自作するための知識・自信がつくはずです。
> [!NOTE]
> 「ゼロからの実装の雰囲気を手っ取り早く動画で感じてみたい」という方は [筆者の45分OS自作ライブコーディング (オープンソースカンファレンス)](https://www.youtube.com/watch?v=dPEsTeL2F98) がおすすめです。
----
## HinaOSとは
HinaOS (ひなおーえす) はマイクロカーネルベースの教育用オペレーティングシステムです。次の特徴・機能を持っています。
- 32ビット RISC-V ([QEMU virtマシン](https://www.qemu.org/docs/master/system/riscv/virt.html)) に対応
- マルチプロセッサ対応マイクロカーネル
- 独自ファイルシステム (HinaFS)
- TCP/IP プロトコルスタック
- virtio-blk デバイスドライバ (仮想ストレージデバイス)
- virtio-net デバイスドライバ (仮想ネットワークデバイス)
- コマンドラインシェル
## 開発環境構築
HinaOSの開発には次のパッケージが必要です。筆者が利用しているバージョンも記載していますが、同じバージョンでなくとも新しめのものであれば問題ありません。もしビルド時にエラーが出る場合には、バージョンが古すぎないか確認してください。
- Git バージョン 2.38.0
- Python バージョン 3.11.2
- GNU Make バージョン 3.81
- QEMU バージョン 7.1.0
- LLVMツールチェーン バージョン 15.0.2
Ubuntu 22.04 (Jammy) の場合は次のコマンドで必要なパッケージをインストールできます。
```
$ sudo apt update
$ sudo apt install llvm clang lld python3-pip qemu-system gdb-multiarch git
$ cd
$ pip3 install --user -r tools/requirements.txt
```
macOS 13 (Ventura) の場合は次のコマンドで必要なパッケージをインストールできます。
```
$ brew install llvm lld python3 qemu riscv-software-src/riscv/riscv-tools
$ cd
$ pip3 install --user -r tools/requirements.txt
```
> [!NOTE]
>
> macOS上で `ld.lld` コマンドが見つからないというエラーが出る場合は、次の通りに `lld` パッケージをインストールしてください。
>
> ```
> brew install lld
> ```
> [!NOTE]
>
> Windowsでもwingetを利用して上記のパッケージをインストールすることでネイティブな開発環境を構築できます（詳細なステップは本書の付録で解説しています）。ただし環境構築がかえって面倒であるため、[WSL2](https://learn.microsoft.com/ja-jp/windows/wsl/install)上でUbuntuを利用するのがお勧めです。
## ソースコードのダウンロード
`git`コマンドでソースコードをダウンロードできます。
```
$ git clone https://github.com/nuta/microkernel-book
```
## ビルド・実行
次のコマンドでビルドできます。`-j8` は8並列ビルドを意味します。CPUコア数程度を指定すると良いでしょう。`V=1`や`RELEASE=1`はビルドオプションで、組み合わせて使うことができます。
```
$ make -j8 # OSをビルドする
$ make -j8 V=1 # OSをビルドする (詳細なビルドログを出力)
$ make -j8 RELEASE=1 # OSをビルドする (コンパイラのより高度な最適化を有効化)
$ make -j8 run # OSをビルドしてQEMUで実行する (シングルコア)
$ make -j8 run CPUS=4 # OSをビルドしてQEMUで実行する (4コア)
```
## デバッグ
[HinaOSのデバッグ](./DEBUG.md) を参照してください。
## ライセンス
HinaOSは [MITライセンス](./LICENSE.md) で公開されています。
## プルリクエスト受諾方針
HinaOSはシンプルさと分かりやすさを保つため、新機能を追加するプルリクエストは受け付けていません。誤字の修正やバグフィックスのような変更のみ受け付けています。ただし、各ドキュメント (`ARCHITECTURE.md` など) の改善は大歓迎です :D