GPU-pass-through-compatibility-check

Introduction

This project consists of 3 parts.

1. A script (gpu-pt-check.sh) that automatically checks to what extend a computer is compatible with GPU pass-through in its given configuration.
2. A script (setup.sh) that automatically installs and configures your system for GPU pass-through (Only tested on fresh installs of Fedora 28 x64 with Gnome, booted in UEFI mode!)
3. Instructions on how to create a bootable Linux USB stick that automatically runs the gpu-pt-check.sh script when you boot from it without any user interaction required.

Update: There now is an additional script that installs Bumblebee and the Nvidia proprietary driver. (Doesn't appear to work properly yet.)

This project has primarely be created to check notebooks. It will probably also work on desktop computers, but checking how and if the conenction between the GPU and the display is MUXED (and if so how) wouldn't make much sense on a desktop computer.

Screenshot

(The output does not represent an existing laptop. It's just an example ran using some mock data from a laptop on a desktop.)

TODO

• Instructions on creating a bootable Linux stick with persistent storage, UEFI compability and a recent kernel (4.17+)
• check if Linux still boots if you add iommu kernel params for Intel and AMD at the same time
• if it works: write a script to automatically add the kernel parameters to the system
• install basic tools like git in the script which might come in handy
• install virtualization software using the script
• find a way to skip the login screen and automatically run a bash script with root privileges that:
• checks if AMD-V / VT-X is enabled
• checks if AMD's IOMMU / Intels VT-D is enabled
• checks if the IOMMU kernel parameters are set
• checks for every GPU if it could be passed through to a VM or if other devices in the same IOMMU group would prevent that
• provides inforamtion about which USB devices are connected to USB controllers that is in the IOMMU group of a GPU
• finds out the GPU is connected to the screen and the external outputs (MUX-less, MUXED etc.)
• does extremely detailled hw logging
• detects if device is a laptop
• detects laptop name and model
• detects BIOS version
• verifies that it works by actually booting a VM and passing the GPU through to it.
• Verify if the MUX detection works
• Add logic to check if the iGPU is disabled in the UEFI
• the VM should be used with looking glass

Prerequisites

• a USB stick with at least 16GB of storage (let's call this one the Fedora stick)
• an x64 installation image for Fedora 28 or above: https://getfedora.org/en/workstation/download/
• another USB stick with at least 2GB of storage (let's call this one the install stick) OR some experience with virtual machines

Setup

Installing Fedora 28 x64 on a USB stick

You have two options:

Installing Fedora using another USB stick

This this case you a install stick. You need to follow the instructions on the Fedora website to turn it into a bootable Fedora installation USB stick: https://getfedora.org/en/workstation/download/ Then you need to boot from it in EFI / UEFI / non-BIOS mode. Usually when you open up the boot menu when you PC starts, you get multiple entries for your USB stick. You want to pick the one that says UEFI or EFI / or non-BIOS ... Then you wait for it to boot up and follow the instructions to install Fedora on the Fedora stick.

Installing Fedora using a virtual machine

Alternatively you can create a VM with a UEFI firmare (in virtual machine manager: screenshot 1, screenshot 2) and pass the Fedora stick through to it (in virtual machine manager: screenshot 3) and tell the VM to boot from the Fedora iso image directly. You don't need a storage device (vhd)! Then you simply boot the VM (make sure it boots from the iso image and follow the instructions to install Fedora on the Fedora stick.

Adding the setup script.

Now to add the setup script to the USB stick, simply boot from the USB stick (either using the VM (you should remove the virtual CD drive frist, so that it won't boot from the iso again) or boot from it directly (in EFI / UEFI ... mode!)). Then run the following commands to download the setup script and execute it with root privileges:

sudo dnf install -y git && git clone https://github.com/T-vK/GPU-pass-through-compatibility-check.git && sudo ./GPU-pass-through-compatibility-check/setup.sh

Usage

• On the computer you want to check you first have to go to the UEFI and enable virtualization. On AMD CPU systems: AMD-V and IOMMU. And on Intel CPU systems: VT-x and VT-d. (Beware: Some motherboard vendors get pretty creative when it comes to giving these options other names.)
• You should enable the internal GPU of the CPU so that you have two (one for the host one for the guest system) (some vendors actually disable the CPU internal GPU completely and don't offer UEFI options to enable it)
• You might also have to disable secure boot in the UEFI.
• It might also be necessary to disable fastboot in the UEFI.
• Once you saved the settings and rebooted, enter the boot menu (usually with Esc, F1-F12 or Del) and boot your Fedora stick in EFI / UEFI / non-BIOS mode.
• Finally when it boots the rest should happen automatically. (It will automatically log you in and start gpu-pt-check.sh.)