ktf

KTF - рамка испытания ядра

KTF-это небольшое и простое ядро ​​ОС, которое позволяет записать низкоуровневые программные тесты для поддерживаемых машинных архитектур (в настоящее время: x86-64).

Обзор функций

• Машетная архитектура: x86-64 , x86-32 в выпечке
• Поддержка SMP с основными страницами на CPU
• (очень) базовое управление физической памятью (PMM) и управление виртуальной памятью (VMM)
• Основной распределитель плиты
• Местная поддержка APIC
• Первоначальный анализ таблиц MP
• Базовые таблицы ACPI
• Простой драйвер UART
• (очень) простой драйвер VGA

Еще некоторые функции в создании. Проверьте проблемы.

Начиная

Быстрый старт - запустить следующие команды. Содержание файловых тестов/test.c будет выполнен. Примечание, последняя команда будет блокировать.

Создайте ktf.iso с нуля, в контейнере Docker.

 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

• Докер

 make docker:all

Bootable ISO Generation (например, для загрузки KTF в качестве гостя под Xen или на машине с обнаженным металлом)

• Родной

 make ktf.iso

• Докер

 make docker:ktf.iso

Команда make генерирует эльф-файл MultiBoot, совместимый с kernel64.bin , который вы можете напрямую загружаться с QEMU. Команда make ktf.iso принимает kernel64.bin , помещает его в иерархию grub/boot/ Directory и генерирует ktf.iso из grub/ (используя grub/boot/grub/grub.cfg в качестве конфигурации по умолчанию).

Федора

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 или нет)

Основной Makefile имеет несколько целей, которые облегчают загрузку KTF с QEMU. Makefile обнаруживает, если хост -система является Linux, и обеспечивает поддержку KVM, если это так. Параметры по умолчанию для QEMU можно найти в Makefile в рамках переменной QEMU_PARAMS .

Для загрузки запуска:

 make boot

Для отладки бег:

 make boot_debug

Для отладки с помощью GDB Run:

 make gdb

Ксен Гость

Используйте следующий пример конфигурации домена гостя для загрузки KTF с Xen:

 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_fn представленная в test.h Тесты могут быть включены в 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, чтобы автоматически обнаружить несоответствие стиля. Для получения дополнительной информации см. В качестве: https://github.com/marketplace/actions/clang-format-lint

Запуск рабочего процесса в формате кланг локально

Постройте контейнер 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 вдохновлены и основаны на проекте XTF [1], разработанной Эндрю Купером из Citrix.

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

Безопасность

Смотрите Anploying для получения дополнительной информации.

Сообщество

Содействия и пользователи KTF общаются в Slack. Мы создали слабые рабочее пространство, и мы активно делимся идеями, ошибками и всем, что связано с KTF. Не стесняйтесь присоединиться к нам: Slack Invite Link

Лицензия

Этот проект лицензирован по лицензии BSD 2-CLAUSE.