ktf

KTF - Cadre de test du noyau

KTF est un noyau de système d'exploitation petit et simple, qui permet d'écrire des tests logiciels de bas niveau pour les architectures de machines prises en charge (actuellement: x86-64).

Présentation des fonctionnalités

• Architecture de la machine: x86-64 , x86-32 dans la cuisson
• Support SMP avec des pages de base par CPU
• (très) Gestion de la mémoire physique (PMM) et gestion de la mémoire virtuelle (VMM)
• Allocateur de dalles très basique
• Support APIC local
• Tables MP initiales analyses
• Tables ACPI de base analyses
• Pilote UART simple
• (très) pilote VGA simple

Certaines autres fonctionnalités sont en préparation. Découvrez les problèmes.

Commencer

Le démarrage rapide consiste à exécuter les commandes suivantes. Le contenu des tests de fichiers / test.c sera exécuté. Remarque, la dernière commande bloquera.

Construisez un ktf.iso à partir de zéro, dans le conteneur Docker.

 make clean
make docker:ktf.iso

Démarrer l'image résultante:

 make boot

Construire des instructions

Exigences

Vous devrez peut-être installer ce qui suit (sauf si vous l'avez déjà):

• Outils Grub2 Bootloader - Package grub2-common (par exemple apt install grub2-common )
• Outils de génération ISO - Package xorriso , grub-pc-bin et mtools (par exemple apt install xorriso grub-pc-bin mtools )

Construction d'image du noyau (par exemple à utiliser avec Qemu)

• Indigène

 make

• Docker

 make docker:all

Génération d'ISO bootable (par exemple pour démarrer KTF en tant qu'invité sous Xen ou sur une machine à métal nu)

• Indigène

 make ktf.iso

• Docker

 make docker:ktf.iso

La commande make génère le fichier ELF compatible kernel64.bin compatible multiboot, que vous pouvez démarrer directement avec Qemu. La commande make ktf.iso prend le kernel64.bin , la place dans la hiérarchie grub/boot/ répertoire et génère un ktf.iso hors de la grub/ (en utilisant grub/boot/grub/grub.cfg comme configuration de grub par défaut).

Feutre

KTF construit et fonctionne sur Fedora, mais vous devrez modifier certaines des commandes. Créez un fichier makeconf.local avec le contenu suivant (testé avec 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

Courir le noyau

Qemu (KVM ou non)

Main Makefile a plusieurs cibles qui facilitent le démarrage de KTF avec QEMU. Le Makefile détecte si le système hôte est Linux et permet le support KVM si c'est le cas. Les paramètres par défaut pour Qemu peuvent être trouvés dans la variable Makefile sous QEMU_PARAMS .

Pour le démarrage de Run:

 make boot

Pour le débogage de la course:

 make boot_debug

Pour le débogage avec GDB Run:

 make gdb

Invité Xen

Utilisez l'exemple de configuration du domaine invité suivant pour démarrer KTF avec 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

Vous devez générer une ISO amorçable pour cela.

Ajout de nouveaux tests

De nouveaux tests peuvent être ajoutés en ajoutant une nouvelle fonction dans un fichier dans le dossier tests . Chaque signature de test doit être la même que test_fn fourni dans test.h Les tests peuvent être activés dans grub.cfg en ajoutant l'option avec tests de clé et valent la liste des noms de fonction séparés par les virgules, tels que tests=test1,test2,unit_tests .

Style

Le style de ce projet est défini dans le fichier .clang-format dans le répertoire principal de ce référentiel.

Utilisez la commande suivante pour appliquer automatiquement le style au fichier que vous modifiez:

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

Pour plus d'informations, reportez-vous à: https://clang.llvm.org/docs/clangformat.html

Ce projet utilise https://github.com/doozyx/clang-forat-lint-action workflow Action pour détecter automatiquement les non-matraques de style. Pour plus d'informations, reportez-vous à: https://github.com/marketplace/actions/clang-format-lint

Exécution du flux de travail Clang-Format localement

Construire un conteneur clang-format-lint

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

Cela ne doit être fait qu'une seule fois.

Papet vos fichiers

make style

Exécuter le flux de travail à un scan à une ligne localement

Construisez le conteneur ktf-one-line-scan

• Tout d'abord, téléchargez l'image de base one-line-scan

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

• Créez l'image spécifique à un scan à une ligne spécifique, y compris les outils nécessaires pour la construction

 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 .

Cela ne doit être fait qu'une seule fois.

Scannez votre répertoire de travail actuel

• par défaut, les analyses à un scan à une ligne contre le Diff entre HEAD et origin/mainline engage

make onelinescan

Crédits et attributions

• Les parties du projet KTF sont inspirées et basées sur le projet XTF [1] développé par Andrew Cooper de Citrix.

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

Sécurité

Voir contribuer pour plus d'informations.

Communauté

Les responsables et les utilisateurs de KTF communiquent en Slack. Nous avons mis en place un espace de travail Slack et nous partageons activement des idées, des bugs et tout ce qui est lié à KTF là-bas. N'hésitez pas à nous rejoindre: lien d'invitation Slack

Licence

Ce projet est sous licence en vertu de la licence BSD 2 clause.