ktf

KTF-カーネルテストフレームワーク

KTFは小さくてシンプルなOSカーネルであり、サポートされているマシンアーキテクチャの低レベルソフトウェアテストを作成できるようにします（現在：x86-64）。

機能の概要

• マシンアーキテクチャ：ベーキングのx86-64 、 x86-32
• 基本的なCPUページを使用したSMPサポート
• （非常に）基本的な物理メモリ管理（PMM）および仮想メモリ管理（VMM）
• 非常に基本的なスラブアロケーター
• ローカルAPICサポート
• 初期MPテーブルの解析
• 基本的なACPIテーブルの解析
• シンプルなUARTドライバー
• （非常に）シンプルなVGAドライバー

さらにいくつかの機能が作成されています。問題をチェックしてください。

はじめる

クイックスタートは、次のコマンドを実行することです。ファイルテスト/test.cのコンテンツが実行されます。注意してください、最後のコマンドはブロックされます。

Dockerコンテナで、ゼロからktf.isoを構築します。

 make clean
make docker:ktf.iso

結果の画像を起動します：

 make boot

指示を作成します

要件

以下をインストールする必要がある場合があります（すでに持っていない限り）：

• grub2ブートローダーツールgrub2-commonパッケージ（ apt install grub2-common ）
• ISO Generation Tools- xorriso 、 grub-pc-bin 、およびmtoolsパッケージ（ apt install xorriso grub-pc-bin mtoolsなど）

カーネル画像ビルド（たとえば、QEMUで使用する）

• ネイティブ

 make

• Docker

 make docker:all

起動可能なISO生成（たとえば、XENまたは裸の金属マシンでゲストとしてKTFを起動する）

• ネイティブ

 make ktf.iso

• Docker

 make docker:ktf.iso

makeコマンドは、 kernel64.bin multiboot互換ELFファイルを生成し、qemuで直接起動できます。 make ktf.isoコマンドはkernel64.binを取り、 grub/boot/ directory階層に配置し、 grub/ （ grub/boot/grub/grub.cfgデフォルトのgrub構成として使用して）からktf.isoを生成します。

フェドラ

KTFはFedoraで構築および実行しますが、コマンドの一部を調整する必要があります。次のコンテンツを使用してmakeconf.localファイルを作成します（Fedora 32でテスト）：

 DIST=$(shell grep NAME= /etc/os-release | cut -d= -f2)
ifeq ($(DIST),Fedora)
GRUB_FILE := grub2-file
GRUB_MKIMAGE := grub2-mkimage
GRUB_MODULES += normal
QEMU_BIN := qemu-kvm
DOCKER_MOUNT_OPTS := :Z
endif

カーネルを実行します

QEMU（KVMかどうか）

Main Makefileには、QEMUでKTFを起動するいくつかのターゲットがあります。 Makefile 、ホストシステムがLinuxであるかどうかを検出し、その場合はKVMサポートを有効にします。 QEMUのデフォルトパラメーターは、 QEMU_PARAMS変数の下のMakefileにあります。

ブートランの場合：

 make boot

デバッグ実行の場合：

 make boot_debug

GDB実行でデバッグするには：

 make gdb

xenゲスト

XENでKTFを起動するには、次のゲストドメイン設定の例を使用します。

 name = "kernel64"
builder = "hvm"
memory = 1024

serial = [ 'file:/tmp/kernel.log' , 'pty' ]

disk = [ '/home/user/ktf.iso,,hdc,cdrom' ]

on_reboot = "destroy"

vcpus = 1

このために起動可能なISOを生成する必要があります。

新しいテストの追加

testsフォルダーのファイルに新しい関数を追加することで、新しいテストを追加できます。各テスト署名は、 test.hで提供されているtest_fnと同じでなければなりません。テストはtests=test1,test2,unit_testsなど、キーtestsと値を使用してオプションを追加することにより、 grub.cfgで有効にできます。

スタイル

このプロジェクトのスタイルは、このリポジトリのメインディレクトリの.clang-formatファイルで定義されています。

次のコマンドを使用して、変更したファイルにスタイルを自動的に適用します。

clang-format -style=file -Werror -i MODIFIED_FILE

詳細については、https：//clang.llvm.org/docs/clangformat.htmlを参照してください

このプロジェクトでは、https：//github.com/doozyx/clang-format-lint-アクションワークフローを使用して、スタイルの不一致を自動的に検出します。詳細については、https：//github.com/marketplace/actions/clang-format-lintを参照してください

Clang-Formatワークフローをローカルに実行します

clang-format-lintコンテナを構築します

docker build -t clang-format-lint github.com/DoozyX/clang-format-lint-action

これは一度だけ行う必要があります。

ファイルにパッチを当てます

make style

1ラインスキャンワークフローをローカルで実行します

ktf-one-line-scanコンテナを構築します

• まず、 one-line-scanベース画像をダウンロードします

docker build -t one-line-scan 
    https://raw.githubusercontent.com/awslabs/one-line-scan/master/tools/Dockerfile

• 構築に必要なツールを含む、KTF固有のワンラインスキャン画像を作成する

 docker build -t ktf-one-line-scan 
    --build-arg USER_ID=$(id -u) 
    --build-arg GROUP_ID=$(id -g) 
    --build-arg USER=$USER 
    --file tools/docker/OnelineScanDockerfile .

これは一度だけ行う必要があります。

現在の作業ディレクトリをスキャンします

• デフォルトごとに、 HEADとorigin/mainlineコミットの間のdiffに対する1行スキャンスキャン

make onelinescan

クレジットと属性

• KTFプロジェクトの一部は、CitrixのAndrew Cooperによって開発されたXTFプロジェクト[1]に触発され、基づいています。

[1] http://xenbits.xenproject.org/docs/xtf/

安全

詳細については、貢献を参照してください。

コミュニティ

KTFのメンテナーとユーザーはSlackで通信します。 Slack Workspaceをセットアップし、そこでKTFに関連するアイデア、バグ、およびあらゆるものを積極的に共有しています。お気軽にご参加ください：Slack Invite Link

ライセンス

このプロジェクトは、BSD 2-Clauseライセンスの下でライセンスされています。