ktf

KTF-內核測試框架

KTF是一個小型且簡單的OS內核，它可以為受支持的機器體系結構編寫低級軟件測試（當前：X86-64）。

功能概述

• 機器架構： x86-64 ， x86-32在烘焙中
• SMP支持基本每CPU頁面
• （非常）基本的物理內存管理（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生成工具 - 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兼容兼容的小精靈文件，您可以直接使用QEMU啟動。 make ktf.iso命令將kernel64.bin帶入grub/boot/ directory層次結構中，然後從grub/中生成ktf.iso （使用grub/boot/grub/grub.cfg作為默認的grub config）。

軟呢帽

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 Run進行調試：

 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相同。可以在grub.cfg中啟用測試，並在鍵tests中添加該選項，並值函數名稱的逗號分隔列表，例如tests=test1,test2,unit_tests 。

風格

該項目的樣式在此存儲庫的主目錄中的.clang-format文件中定義。

使用以下命令將樣式自動應用於您修改的文件：

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

有關更多信息，請參閱：https：//clang.llvm.org/docs/clangformat.html

該項目使用https://github.com/doozyx/clang-format-lint-action-action-action工作流程自動檢測樣式不匹配。有關更多信息，請參閱：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

本地運行單行掃描工作流

構建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提交之間的差異一線掃描

make onelinescan

學分和歸因

• KTF項目的一部分是受Citrix的Andrew Cooper開發的XTF項目的啟發和啟發。

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

安全

有關更多信息，請參見貢獻。

社區

KTF的維護者和用戶在Slack中通信。我們設置了一個鬆弛的工作空間，我們正在積極分享與KTF有關的想法，錯誤以及任何與KTF相關的任何內容。隨時加入我們：Slack邀請鏈接

執照

該項目是根據BSD 2-CAREASE許可證獲得許可的。