Setup env

Automatic

Direnv configuration is available so you can use direnv allow to setup shell.

Manual

On NixOS:

You just need to start you shell with nix-shell.

On other distros:

You need to install kernel-devel to compile C code, rust rust-src bindgen-cli rustfmt clippy to compile rust code and just. You also need to setup LINUX_MODULES_FOLDER to linux modules folder of your distro (ex: /lib/modules/$(uname -r)) in your shell (ex: .bashrc)

Note for Rust

Check required kernel conf CONFIG_RUST=y

cat /boot/config-$(uname -r) | grep CONFIG_RUST

Generate rust-analyzer conf

make LLVM=1 -C $LINUX_MODULES_FOLDER/build M=$(pwd) rust-analyzer

make : targets list

• all : Compiling kernel (by default)
• clean : Cleaning build folder

All subfolder is configured to use LINUX_MODULES_FOLDER env variable set by flake develop

How test module

Step 1: Load module

sudo insmod [module_name].ko

Warning: Can fail if secure boot is enabled (see notes about secure boot in below)

Step 2: Check logs

sudo dmesg | tail

Step 3: Unload module

sudo rmmod [module_name].ko

Usefull links

• https://www.kernel.org/doc/html/latest/
• https://elixir.bootlin.com/linux/v6.13/source/
• https://static.lwn.net/images/pdf/LDD3/ch01.pdf
• https://sysprog21.github.io/lkmpg
• https://github.com/Rust-for-Linux/rust-out-of-tree-module
• https://github.com/NixOS/nixpkgs/issues/386164 (My issue to missing rust/Makefile)

Notes

Find required headers files

nix shell nixpkgs#bear
cd 01_basic_module/
bear --append --output ../.vscode/compile_commands.json -- make -C $LINUX_MODULES_FOLDER/build M=$PWD modules

Search -I args and -D args

Sign kernel module for testing with secure boot enabled

Prerequisites: Own secure boot keys configured.

Secure boot keys can be found in :

• Fedora : /etc/pki/akmods
• With sbctl : /var/lib/sbctl

sign-file sha256 $SECUREBOOT_KEYS_PATH/private_key.priv $SECUREBOOT_KEYS_PATH/public_key.der <module_file>.ko

sign-file executable is in /usr/src/kernels/$(uname -r)/scripts

Full example (run as root):

1. Fedora

/usr/src/kernels/$(uname -r)/scripts/sign-file sha256 /etc/pki/akmods/private/private_key.priv /etc/pki/akmods/certs/public_key.der <module_file>.ko

Format

1. .clang-format

How update .clang-format

curl https://raw.githubusercontent.com/torvalds/linux/refs/heads/master/.clang-format -o .clang-format

Format files

clang-format -i **/*.c

Checkpatch

./<linux-source>/scripts/checkpatch.pl --no-tree -f <file>

For example from NixOS development environment

$LINUX_MODULES_FOLDER/source/scripts/checkpatch.pl --no-tree -f 01_basic_module/basic_module_in_c.c