WSL2-Linux-Kernel README

The project's README from github.com/microsoft/WSL2-Linux-Kernel. As one markdown file: README.md.

Introduction

The WSL2-Linux-Kernel repo contains the kernel source code and configuration files for the WSL2 kernel.

Reporting Bugs

If you discover an issue relating to WSL or the WSL2 kernel, please report it on the WSL GitHub project. It is not possible to report issues on the WSL2-Linux-Kernel project.

If you're able to determine that the bug is present in the upstream Linux kernel, you may want to work directly with the upstream developers. Please note that there are separate processes for reporting a normal bug and a security bug.

Feature Requests

Is there a missing feature that you'd like to see? Please request it on the WSL GitHub project.

If you're able and interested in contributing kernel code for your feature request, we encourage you to submit the change upstream.

Build Instructions

Instructions for building an x86_64 WSL2 kernel with an Ubuntu distribution using bash are as follows:

  1. Install the build dependencies:
    sudo apt install build-essential flex bison dwarves libssl-dev libelf-dev cpio qemu-utils rsync

  2. Modify WSL2 kernel configs (optional):
    make menuconfig KCONFIG_CONFIG=Microsoft/config-wsl

  3. Build the kernel using the WSL2 kernel configuration and put the modules in a modules folder under the current working directory:
    make KCONFIG_CONFIG=Microsoft/config-wsl && make INSTALL_MOD_PATH="$PWD/modules" modules_install

    You may wish to include -j$(nproc) on the first make command to build in parallel.

  4. Install the kernel's UAPI headers into a headers folder:
    make headers_install INSTALL_HDR_PATH="$PWD/headers"

  5. Build the perf tooling into a perf folder:
    make -C tools/perf NO_JEVENTS=1 NO_JVMTI=1 NO_LIBTRACEEVENT=1 install DESTDIR="$PWD/perf" prefix=/

Then, you can use a provided script to create a VHDX containing the modules, headers, and perf tooling: ./Microsoft/scripts/gen_artifacts_vhdx.sh "$PWD/modules" "$PWD/headers" "$PWD/perf" $(make -s kernelrelease) modules.vhdx

To save space, you can now delete the compilation artifacts: make clean && rm -r "$PWD/modules" "$PWD/headers" "$PWD/perf"

If you prefer, you can also build the VHDX manually as follows. WSL expects the artifacts laid out under <kernelrelease>/{modules,linux-headers,perf}, so first assemble a staging directory:

  1. Stage the modules, headers, and perf tooling under the kernel release directory:

    release=$(make -s kernelrelease)
mkdir -p "$PWD/staging/$release/linux-headers"
cp -r "$PWD/modules/lib/modules/$release" "$PWD/staging/$release/modules"
rm -f "$PWD/staging/$release/modules/build" "$PWD/staging/$release/modules/source"
cp -r "$PWD/headers/." "$PWD/staging/$release/linux-headers"
cp -r "$PWD/perf" "$PWD/staging/$release/perf"

  2. Calculate the image size (plus 256MiB for slack): image_size=$(du -bs "$PWD/staging" | awk '{print $1;}'); image_size=$((image_size + (256 * (1<<20))));

  3. Build a populated ext4 image: mke2fs -L '' -d "$PWD/staging" -N $(( $(find "$PWD/staging" | wc -l) + 4096 )) -b 1024 -t ext4 "$PWD/modules.img" $((image_size / 1024))

  4. Convert the img to VHDX: qemu-img convert -O vhdx "$PWD/modules.img" "$PWD/modules.vhdx"

  5. Clean up: rm "$PWD/modules.img" # optionally the $PWD/staging, $PWD/modules, $PWD/headers, and $PWD/perf dirs too

Install Instructions

Please see the documentation on the .wslconfig configuration file for information on using a custom built kernel.

WSL2-Linux-Kernel (microsoft/WSL2-Linux-Kernel)

Searching Database…

10.6K ·GitHub
WSL2-Linux-Kernel
Что это такое?Это официальный репозиторий исходного кода ядра Linux, на котором работает WSL2 (Windows Subsystem for Linux 2), включая исходники ядра и файлы конфигурации, используемые Microsoft.
Это готовое к использованию приложение или просто исходный код ядра?Это сырой исходный код ядра и конфигурация сборки, а не устанавливаемое приложение. Вы компилируете его сами, если вам нужно собственное ядро WSL2 вместо того, что Microsoft поставляет по умолчанию.
Как собрать из этого собственное ядро WSL2?Установите зависимости для сборки, выполните «make menuconfig KCONFIGCONFIG=Microsoft/config-wsl», чтобы подправить конфиг, затем «make KCONFIGCONFIG=Microsoft/config-wsl» для сборки и установки модулей, после чего соберите заголовки и утилиту perf и упакуйте всё в VHDX прилагаемым скриптом.
Что нужно установить перед сборкой?Нужна Linux-среда для сборки (например, Ubuntu) с build-essential, flex, bison, dwarves, libssl-dev, libelf-dev, cpio, qemu-utils и rsync.
Кому на самом деле нужно собирать это самому?В основном продвинутым пользователям WSL или разработчикам ядра, которым нужны собственные модули ядра, драйверы или опции конфигурации, не входящие в ядро, поставляемое Microsoft по умолчанию.
Где потом используется собранное ядро?Собранное ядро/VHDX подгружается WSL2 на Windows через файл .wslconfig, заменяя ядро по умолчанию для ваших Linux-дистрибутивов, работающих под WSL2.
Как на деле использовать ядро, которое я собрал сам?Укажите WSL на него через настройку кастомного ядра в файле конфигурации .wslconfig, как описано в разделе Install Instructions.
Стоит ли присылать изменения функций ядра в этот репозиторий?Если ваша функция релевантна апстримному Linux, лучше отправить патч напрямую в апстрим, а не ограничиваться правкой форка этого репозитория.
Какую целевую архитектуру охватывают инструкции по сборке?Описанные шаги сборки предназначены именно для сборки ядра WSL2 x86_64 в bash-окружении на базе Ubuntu.
What are similar projects?lowlevelprogramming-university, linux, openwrt, mu300-linux, linux, open-gpu-kernel-modules, lua, lytlnyblOS
Which topics is it in?build-system, linux-kernel, wsl, embedded-systems, kernel, virtualization, low-level, microsoft, compiler, hardware, sysadmin, c
Creator
microsoft
Size
2.9 GB
Stars
10.6K
Updated
CommitOct 06Releaselinux-msft-wsl-6.18.54.1Oct 06
Age
7y
Commits · 90 Days