You are going to need meson, autoconf, automake, libtool, cmake, ninja, gcc, g++, gcc-multilib, g++-multilib and many lib development packages required by all the components.
IMPORTANT: Install "spirv-tools". It's required by some piglit tests, but piglit doesn't check for that dependency.
Copy the files from this repository into the directory where you are going to clone all git repositories, so that the files are above the repository directories.
Use git to clone these:
- firmware: https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/ (open the page)
- kernel: the amd-staging-drm-next branch is recommended. Use the internal AMD repository or the public mirror of the branch at https://gitlab.freedesktop.org/agd5f/linux/.
- libdrm: https://gitlab.freedesktop.org/mesa/drm (open the page)
- llvm-project: https://github.com/llvm/llvm-project.git (clone directly)
- mesa: https://gitlab.freedesktop.org/mesa/mesa (open the page)
- xf86-video-amdgpu: https://gitlab.freedesktop.org/xorg/driver/xf86-video-amdgpu (open the page)
- waffle: https://gitlab.freedesktop.org/mesa/waffle (open the page)
- piglit: https://gitlab.freedesktop.org/mareko/piglit.git (clone directly) - Check out the
deqpbranch in piglit. - deqp: https://android.googlesource.com/platform/external/deqp/ (clone directly)
- glcts: https://github.com/KhronosGroup/VK-GL-CTS.git glcts (clone directly into the glcts directory) - Check out commit 26b37d8c2 because nothing compiles after that.
You can skip firmware if you already have firmware for your GPU.
You can usually skip xf86-video-amdgpu. All distributions should ship a version that's a good enough.
You can skip kernel and llvm if you don't intend to work on those. If you skip them, you will need llvm development packages.
Configure and build everything in the listed order, because there are dependencies:
- kernel depends on firmware
- libdrm and llvm don't depend on anything
- mesa depends on libdrm and llvm
- xf86-video-amdgpu depends on libdrm and mesa
- waffle depends on mesa
- piglit depends on mesa and waffle
- deqp depends on mesa
- glcts depends on mesa
Getting the firmware is not necessary if your distribution already contains firmware for your GPU. You can find your current firmware in /lib/firmware/amdgpu. The firmware is installed by copying files from the firmware repository into that directory and re-installing the kernel (which packs the firmware into /boot/initrd*). The kernel only loads firmware from initrd.
Most components require installation of additional development library packages. Follow error messages to resolve them.
Kernel: Go to the kernel directory and type:
make menuconfig # (to create the config; just exit if you don't want to change anything)
../build_kernel.sh
It will build and install the kernel.
libdrm: Go to the libdrm directory and type:
../conf_drm.sh
ninja -Cbuild
sudo ninja -Cbuild install
LLVM: Go to the llvm-project directory and type:
../conf_llvm.sh
ninja -Cbuild
sudo ninja -Cbuild install
LLVM is installed in /usr/local/llvm. You need to copy the contents of the etc directory from this repository into /etc. Then, type this to notify ld about it:
sudo ldconfig
Now ld will be able to find LLVM.
Mesa: If you want to use LLVM installed in the standard directory paths, remove --native-file from conf_mesa.sh. Otherwise, it will get the LLVM installation path from the llvm_config_* files.
Go to the mesa directory and type:
../conf_mesa.sh
ninja -Cbuild
sudo ninja -Cbuild install
Mesa contains libGL, libEGL, libgbm, and libglapi, and drivers.
xf86-video-amdgpu: Go to the xf86-video-amdgpu directory and type:
./autogen --prefix=/usr
make -j`nproc`
sudo make install
Waffle: Go to the waffle directory and type:
../conf_waffle.sh
ninja
sudo ninja install
There is no installation step for the test suites. They are run from the build directory directly.
Piglit: Go to the piglit directory and type:
../conf_piglit.sh
ninja
DEQP: Go to the deqp directory and type:
../conf_deqp.sh
ninja
GLCTS: You need to have a Khronos account and you need to upload your ssh public key into your Khronos Gitlab account. Then the conf_glcts.sh script will fetch confidential Khronos source code that you need for building the desktop OpenGL Conformance Test Suite.
Go to the glcts directory and type:
../conf_glcts.sh
ninja
To verify that everything is installed properly, run driver-load-sanity-test and driver-render-sanity-test from this repository. They have to pass for X to be able to even start. Those two are also the first tests to run when debugging X startup issues, because they use the same APIs as X (that is GBM + EGL).
Now reboot your machine and everything should work.
X crashes can also be debugged via gdb over ssh: sudo gdb /usr/lib/xorg/Xorg
This step is unnecessary if you don't expect to test certain Steam games. You only need 32-bit libdrm, llvm, and Mesa. You don't need anything else.
It's the same as above except that you add these parameters:
../conf_drm.sh 32
../conf_mesa.sh 32
LLVM is already configured for the 32-bit build in its build32 directory.
Then the build steps for libdrm, llvm, and mesa use build32 instead of build:
ninja -Cbuild32
sudo ninja -Cbuild32 install
You have to do ninja install for Mesa for the first time, so that waffle and piglit can find the latest Mesa headers, but you don't have to do that for any subsequent rebuilds of Mesa if you want to use the following method.
Run make-mesa-symlinks.sh. It will create symlinks pointing from the Mesa installation locations (/usr/lib/....) into your mesa/build and mesa/build32 directories. Now, rebuilding Mesa is all you need for updating it.
Use run-piglit.sh from this repository. It will run piglit and create an HTML report in the piglit-summary directory.
To run piglit for the first time, type:
./run-piglit.sh
It will print the name of the run, for example:
Name: 04-11_19:35_VEGA12
The name of the run will also be on the first row of the HTML report table.
If you want to run piglit and compare it against a baseline, specify the baseline name on the command line. It will create an HTML report comparing your current run with the baseline:
./run-piglit.sh 04-11_19:35_VEGA12
The piglit results are stored in the piglit-results directory, while the HTML reports are stored separately in the piglit-summary directory. You can always regenerate the reports from the results or generate comparisons between two or more sets of results using the ./piglit summary html command in the piglit repository.
Other examples:
./run-piglit.sh 04-11_19:35_VEGA12 -x view: exclude all tests containingviewin their name./run-piglit.sh 04-11_19:35_VEGA12 -t clear: run only tests containingclearin their name./run-piglit.sh 04-11_19:35_VEGA12 -t clear -x view: run tests containingclearbut not containingview./run-piglit.sh 04-11_19:35_VEGA12 -j1: disable concurrency
All those options and more can be found by running piglit/piglit run --help.
Disabling concurrency can help if you have an unstable kernel driver.
Run piglit with the -isol parameter before the baseline name:
./run-piglit.sh -isol 04-11_19:35_VEGA12
-isol enables process isolation for tests, meaning that tests are run as separate processes instead of combined into one process. This will make full test executable command lines visible to ps.
When it hangs, run ps aux|grep home over ssh to get command lines of currently running tests. After reboot, you can run each line separately to find the hanging test.