GPU (Linux): add full GPU detection support in WSL

With DX12 API ;)
2026-09-13 02:42:09 +02:00 · 2023-09-20 23:55:36 +08:00
parent ec8ee1a509
commit 8cbe3f6453
6 changed files with 144 additions and 9 deletions
@@ -13,11 +13,15 @@ jobs:
      fail-fast: false
      matrix:
        os: [ubuntu-22.04, ubuntu-20.04]
-        compiler: [gcc, clang, "musl-gcc"]
+        compiler: [
+          { cc: gcc, cxx: "g++" },
+          { cc: clang, cxx: "clang++" },
+          { cc: "musl-gcc", cxx: "musl-g++" }
+        ]
        enableFeatures: [ON, OFF]
        exclude:
          # The feature libraries are all build against glibc, so they can't be used with musl
-          - compiler: "musl-gcc"
+          - compiler: { cc: "musl-gcc", cxx: "musl-g++" }
            enableFeatures: ON
    runs-on: ${{ matrix.os }}
    steps:
@@ -25,12 +29,13 @@ jobs:
        uses: actions/checkout@v4

      - name: install required packages
-        run: sudo apt-get update && sudo apt-get install -y musl-dev musl-tools linux-headers-generic libpci-dev libvulkan-dev libwayland-dev libxrandr-dev libxcb-randr0-dev libdconf-dev libdbus-1-dev libmagickcore-dev libxfconf-0-dev libsqlite3-dev rpm librpm-dev libzstd-dev libegl-dev libglx-dev libosmesa6-dev ocl-icd-opencl-dev libnm-dev libpulse-dev
+        run: sudo apt-get update && sudo apt-get install -y musl-dev musl-tools linux-headers-generic libpci-dev libvulkan-dev libwayland-dev libxrandr-dev libxcb-randr0-dev libdconf-dev libdbus-1-dev libmagickcore-dev libxfconf-0-dev libsqlite3-dev rpm librpm-dev libzstd-dev libegl-dev libglx-dev libosmesa6-dev ocl-icd-opencl-dev libnm-dev libpulse-dev directx-headers-dev

      - name: configure project
        env:
-          CC: ${{ matrix.compiler }}
-        run: cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_LIBPCI=${{ matrix.enableFeatures }} -DENABLE_VULKAN=${{ matrix.enableFeatures }} -DENABLE_WAYLAND=${{ matrix.enableFeatures }} -DENABLE_XCB_RANDR=${{ matrix.enableFeatures }} -DENABLE_XCB=${{ matrix.enableFeatures }} -DENABLE_XRANDR=${{ matrix.enableFeatures }} -DENABLE_X11=${{ matrix.enableFeatures }} -DENABLE_GIO=${{ matrix.enableFeatures }} -DENABLE_DCONF=${{ matrix.enableFeatures }} -DENABLE_DBUS=${{ matrix.enableFeatures }} -DENABLE_XFCONF=${{ matrix.enableFeatures }} -DENABLE_SQLITE3=${{ matrix.enableFeatures }} -DENABLE_RPM=${{ matrix.enableFeatures }} -DENABLE_IMAGEMAGICK7=${{ matrix.enableFeatures }} -DENABLE_IMAGEMAGICK6=${{ matrix.enableFeatures }} -DENABLE_CHAFA=${{ matrix.enableFeatures }} -DENABLE_ZLIB=${{ matrix.enableFeatures }} -DENABLE_EGL=${{ matrix.enableFeatures }} -DENABLE_GLX=${{ matrix.enableFeatures }} -DENABLE_OSMESA=${{ matrix.enableFeatures }} -DENABLE_OPENCL=${{ matrix.enableFeatures }} -DENABLE_LIBNM=${{ matrix.enableFeatures }} -DENABLE_PULSE=${{ matrix.enableFeatures }} -DENABLE_JSONC=${{ matrix.enableFeatures }} .
+          CC: ${{ matrix.compiler.cc }}
+          CXX: ${{ matrix.compiler.cxx }}
+        run: cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_LIBPCI=${{ matrix.enableFeatures }} -DENABLE_VULKAN=${{ matrix.enableFeatures }} -DENABLE_WAYLAND=${{ matrix.enableFeatures }} -DENABLE_XCB_RANDR=${{ matrix.enableFeatures }} -DENABLE_XCB=${{ matrix.enableFeatures }} -DENABLE_XRANDR=${{ matrix.enableFeatures }} -DENABLE_X11=${{ matrix.enableFeatures }} -DENABLE_GIO=${{ matrix.enableFeatures }} -DENABLE_DCONF=${{ matrix.enableFeatures }} -DENABLE_DBUS=${{ matrix.enableFeatures }} -DENABLE_XFCONF=${{ matrix.enableFeatures }} -DENABLE_SQLITE3=${{ matrix.enableFeatures }} -DENABLE_RPM=${{ matrix.enableFeatures }} -DENABLE_IMAGEMAGICK7=${{ matrix.enableFeatures }} -DENABLE_IMAGEMAGICK6=${{ matrix.enableFeatures }} -DENABLE_CHAFA=${{ matrix.enableFeatures }} -DENABLE_ZLIB=${{ matrix.enableFeatures }} -DENABLE_EGL=${{ matrix.enableFeatures }} -DENABLE_GLX=${{ matrix.enableFeatures }} -DENABLE_OSMESA=${{ matrix.enableFeatures }} -DENABLE_OPENCL=${{ matrix.enableFeatures }} -DENABLE_LIBNM=${{ matrix.enableFeatures }} -DENABLE_PULSE=${{ matrix.enableFeatures }} -DENABLE_JSONC=${{ matrix.enableFeatures }} -DENABLE_DIRECTX_HEADERS=${{ matrix.enableFeatures }} .

      - name: build project
        run: cmake --build .
@@ -39,7 +44,7 @@ jobs:
        run: ctest

      - name: run fastfetch
-        run: ./fastfetch --disable-linewrap false --hide-cursor false --show-errors --no-buffer --load-config presets/all
+        run: ./fastfetch --stat --show-errors --no-buffer --load-config presets/all

      - name: run flashfetch
        run: ./flashfetch
@@ -57,7 +62,7 @@ jobs:
        uses: actions/checkout@v4

      - name: install required packages
-        run: sudo apt-get update && sudo apt-get install -y libpci-dev libvulkan-dev libwayland-dev libxrandr-dev libxcb-randr0-dev libdconf-dev libdbus-1-dev libmagickcore-dev libxfconf-0-dev libsqlite3-dev rpm librpm-dev libzstd-dev libegl-dev libglx-dev libosmesa6-dev ocl-icd-opencl-dev libnm-dev libpulse-dev
+        run: sudo apt-get update && sudo apt-get install -y libpci-dev libvulkan-dev libwayland-dev libxrandr-dev libxcb-randr0-dev libdconf-dev libdbus-1-dev libmagickcore-dev libxfconf-0-dev libsqlite3-dev rpm librpm-dev libzstd-dev libegl-dev libglx-dev libosmesa6-dev ocl-icd-opencl-dev libnm-dev libpulse-dev directx-headers-dev

      - name: Initialize CodeQL
        uses: github/codeql-action/init@v2
@@ -20,6 +20,7 @@ Features:
 * Support user login time detection (Users)
 * Support winget package manager detection, guarded behind `--allow-slow-operations` (Packages, Windows)
 * Print monitor type (built-in or external) (Display)
+* Support full GPU detection in WSL (Linux, GPU)

 Bugfixes:
 * Fix fastfetch hanging in specific environment (#561)
@@ -67,6 +67,7 @@ cmake_dependent_option(ENABLE_LIBNM "Enable libnm" ON "LINUX" OFF)
 cmake_dependent_option(ENABLE_FREETYPE "Enable freetype" ON "ANDROID" OFF)
 cmake_dependent_option(ENABLE_PULSE "Enable pulse" ON "LINUX OR BSD" OFF)
 cmake_dependent_option(ENABLE_DDCUTIL "Enable ddcutil" ON "LINUX" OFF)
+cmake_dependent_option(ENABLE_DIRECTX_HEADERS "Enable DirectX headers for WSL" ON "LINUX" OFF)
 cmake_dependent_option(ENABLE_THREADS "Enable multithreading" ON "Threads_FOUND" OFF)
 cmake_dependent_option(ENABLE_PCI_MEMORY "Enable detecting GPU memory size with libpci" OFF "LINUX OR BSD" OFF)
 cmake_dependent_option(ENABLE_SYSTEM_YYJSON "Use system provided (instead of fastfetch embeded) yyjson library" OFF "LINUX OR APPLE OR BSD OR WIN32 OR ANDROID" OFF)
@@ -98,10 +99,13 @@ set(WARNING_FLAGS "-Wall -Wextra -Wconversion -Werror=uninitialized -Werror=retu
 set(CMAKE_C_STANDARD 11)
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${WARNING_FLAGS} -Werror=incompatible-pointer-types -Werror=implicit-function-declaration")

-if(WIN32)
+if(WIN32 OR ENABLE_DIRECTX_HEADERS)
    enable_language(CXX)
    set(CMAKE_CXX_STANDARD 17)
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${WARNING_FLAGS} -fno-exceptions -fno-rtti")
+endif()
+
+if(WIN32)
    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--tsaware -Wl,--build-id -Wl,--subsystem,console:6.1,--major-os-version,6,--minor-os-version,1")
 endif()

@@ -121,8 +125,8 @@ if(NOT WIN32)
    set(CMAKE_EXE_LINKER_FLAGS_DEBUG "${CMAKE_EXE_LINKER_FLAGS_DEBUG} -rdynamic")
 endif()

-
 if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
+    message(STATUS "Enabling LTO")
    include(CheckIPOSupported)
    check_ipo_supported(RESULT IPO_SUPPORTED)
    if(IPO_SUPPORTED)
@@ -601,6 +605,11 @@ elseif(WIN32)
    )
 endif()

+if(ENABLE_DIRECTX_HEADERS)
+    message(STATUS "Enabling DirectX headers for WSL")
+    list(APPEND LIBFASTFETCH_SRC src/detection/gpu/gpu_wsl.cpp)
+endif()
+
 include(CheckFunctionExists)
 check_function_exists(wcwidth HAVE_WCWIDTH)
 if(NOT HAVE_WCWIDTH)
@@ -623,6 +632,7 @@ endif()
 add_library(libfastfetch OBJECT
    ${LIBFASTFETCH_SRC}
 )
+
 if(yyjson_FOUND)
    target_compile_definitions(libfastfetch PRIVATE FF_USE_SYSTEM_YYJSON)
    target_link_libraries(libfastfetch PRIVATE yyjson)
@@ -775,6 +785,10 @@ ff_lib_enable(DDCUTIL
    "ddcutil"
    "Ddcutil"
 )
+ff_lib_enable(DIRECTX_HEADERS
+    "DirectX-Headers"
+    "DirectX-Headers"
+)

 if(ENABLE_THREADS)
    target_compile_definitions(libfastfetch PRIVATE FF_HAVE_THREADS)
@@ -879,6 +893,12 @@ target_link_libraries(flashfetch
    PRIVATE libfastfetch
 )

+# Prevent fastfetch from linking to libstdc++
+set(CMAKE_CXX_IMPLICIT_LINK_LIBRARIES "")
+set(CMAKE_CXX_IMPLICIT_LINK_DIRECTORIES "")
+set_target_properties(fastfetch PROPERTIES LINKER_LANGUAGE C)
+set_target_properties(flashfetch PROPERTIES LINKER_LANGUAGE C)
+
 if(WIN32)
    set(TARGET_NAME fastfetch)
    target_sources(fastfetch
@@ -71,6 +71,7 @@ The following libraries are used if present at runtime:
 * [`libnm`](https://networkmanager.dev/docs/libnm/latest/): Used for Wifi detection.
 * [`libpulse`](https://freedesktop.org/software/pulseaudio/doxygen/): Used for Sound detection.
 * [`libddcutil`](https://github.com/rockowitz/ddcutil): Used for brightness detection of external displays
+* [`DirectX-Headers`](https://github.com/microsoft/DirectX-Headers): Used for GPU detection in WSL

 ### macOS

@@ -311,6 +311,12 @@ static const char* pciDetectGPUs(const FFGPUOptions* options, FFlist* gpus)

 const char* ffDetectGPUImpl(const FFGPUOptions* options, FFlist* gpus)
 {
+    #ifdef FF_HAVE_DIRECTX_HEADERS
+        const char* ffGPUDetectByDirectX(const FFGPUOptions* options, FFlist* gpus);
+        if (!ffGPUDetectByDirectX(options, gpus))
+            return NULL;
+    #endif
+
    #ifdef FF_HAVE_LIBPCI
        return pciDetectGPUs(options, gpus);
    #else
@@ -0,0 +1,102 @@
+#ifdef FF_HAVE_DIRECTX_HEADERS
+
+#define INITGUID
+extern "C" {
+#include "common/library.h"
+#include "detection/gpu/gpu.h"
+}
+
+#include <wsl/winadapter.h>
+#include <directx/dxcore.h>
+#include <directx/d3d12.h>
+#include <dxguids/dxguids.h>
+#include <utility>
+#include <cinttypes>
+
+template <typename Fn>
+struct on_scope_exit {
+    on_scope_exit(Fn &&fn): _fn(std::move(fn)) {}
+    ~on_scope_exit() { this->_fn(); }
+
+private:
+    Fn _fn;
+};
+
+extern "C"
+const char* ffGPUDetectByDirectX(FF_MAYBE_UNUSED const FFGPUOptions* options, FFlist* gpus)
+{
+    FF_LIBRARY_LOAD(libdxcore, nullptr, "dlopen libdxcore.so failed. Make sure WSLg is enabled", "/usr/lib/wsl/lib/libdxcore" FF_LIBRARY_EXTENSION, 4)
+    // DXCoreCreateAdapterFactory is a reloaded function, so we can't use FF_LIBRARY_LOAD_SYMBOL_MESSAGE here
+    typedef HRESULT (*DXCoreCreateAdapterFactory_t)(REFIID riid, void** ppvFactory);
+    auto ffDXCoreCreateAdapterFactory = (DXCoreCreateAdapterFactory_t) dlsym(libdxcore, "DXCoreCreateAdapterFactory");
+    if(ffDXCoreCreateAdapterFactory == nullptr) return "dlsym DXCoreCreateAdapterFactory failed";
+
+    IDXCoreAdapterFactory *factory = nullptr;
+
+    if (FAILED(ffDXCoreCreateAdapterFactory(IID_PPV_ARGS(&factory))))
+        return "DXCoreCreateAdapterFactory(IID_PPV_ARGS(&factory)) failed";
+    on_scope_exit destroyFactory([&] { factory->Release(); });
+
+    IDXCoreAdapterList *list = NULL;
+    if (FAILED(factory->CreateAdapterList(1, &DXCORE_ADAPTER_ATTRIBUTE_D3D11_GRAPHICS, &list)))
+        return "factory->CreateAdapterList(1, &DXCORE_ADAPTER_ATTRIBUTE_D3D11_GRAPHICS, &list) failed";
+    on_scope_exit destroyList([&] { list->Release(); });
+
+    for (uint32_t i = 0, count = list->GetAdapterCount(); i < count; i++)
+    {
+        IDXCoreAdapter *adapter = nullptr;
+        if (FAILED(list->GetAdapter(i, &adapter)))
+            continue;
+        on_scope_exit destroyAdapter([&] { adapter->Release(); });
+
+        // https://learn.microsoft.com/en-us/windows/win32/api/dxcore_interface/ne-dxcore_interface-dxcoreadapterproperty
+        {
+            bool value = 0;
+            if (SUCCEEDED(adapter->GetProperty(DXCoreAdapterProperty::IsHardware, sizeof(value), &value)) && !value)
+                continue;
+        }
+
+        char desc[256];
+        if (FAILED(adapter->GetProperty(DXCoreAdapterProperty::DriverDescription, sizeof(desc), desc)))
+            continue;
+
+        FFGPUResult* gpu = (FFGPUResult*) ffListAdd(gpus);
+        ffStrbufInitS(&gpu->name, desc);
+        gpu->coreCount = FF_GPU_CORE_COUNT_UNSET;
+        gpu->temperature = FF_GPU_TEMP_UNSET;
+
+        ffStrbufInit(&gpu->driver);
+        uint64_t value = 0;
+        if (SUCCEEDED(adapter->GetProperty(DXCoreAdapterProperty::DriverVersion, sizeof(value), &value)))
+        {
+            ffStrbufSetF(&gpu->driver, "%" PRIu64 ".%" PRIu64 ".%" PRIu64 ".%" PRIu64,
+                (value >> 48) & 0xFFFF,
+                (value >> 32) & 0xFFFF,
+                (value >> 16) & 0xFFFF,
+                (value >>  0) & 0xFFFF);
+        }
+
+        gpu->dedicated.used = gpu->shared.used = gpu->dedicated.total = gpu->shared.total = FF_GPU_VMEM_SIZE_UNSET;
+        if (SUCCEEDED(adapter->GetProperty(DXCoreAdapterProperty::DedicatedAdapterMemory, sizeof(value), &value)))
+            gpu->dedicated.total = value;
+        if (SUCCEEDED(adapter->GetProperty(DXCoreAdapterProperty::SharedSystemMemory, sizeof(value), &value)))
+            gpu->shared.total = value;
+
+        gpu->type = FF_GPU_TYPE_UNKNOWN;
+        bool integrated;
+        if (SUCCEEDED(adapter->GetProperty(DXCoreAdapterProperty::IsIntegrated, sizeof(integrated), &integrated)))
+            gpu->type = integrated ? FF_GPU_TYPE_INTEGRATED : FF_GPU_TYPE_DISCRETE;
+
+        ffStrbufInit(&gpu->vendor);
+        DXCoreHardwareID hardwareId;
+        if (SUCCEEDED(adapter->GetProperty(DXCoreAdapterProperty::HardwareID, sizeof(hardwareId), &hardwareId)))
+        {
+            const char* vendorStr = ffGetGPUVendorString((unsigned) hardwareId.vendorID);
+            ffStrbufAppendS(&gpu->vendor, vendorStr);
+        }
+    }
+
+    return NULL;
+}
+
+#endif