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许可证获得许可的。