Add more detailed GPU information to logs

RHI and ANGLE may use different GPUs and this may lead to various
errors. Try to detect these cases from log messages.

Enable the following logging rules to compare GPUs in use:
QT_LOGGING_RULES="qt.webenginecontext=true;qt.webengine.compositor=true"

Pick-to: 6.9
Task-number: QTBUG-135786
Change-Id: I1097acf3d20128b259533a3657532d068f244752
Reviewed-by: Moss Heim <[email protected]>
Reviewed-by: Allan Sandfeld Jensen <[email protected]>

Author: stampho

src/core/content_client_qt.cpp

@@ -3,6 +3,8 @@
 
 #include "content_client_qt.h"
 
+#include "compositor/compositor.h"
+
 #include "base/command_line.h"
 #include "base/files/file_util.h"
 #include "base/json/json_string_value_serializer.h"
@@ -29,7 +31,7 @@
 #include <QLibraryInfo>
 #include <QString>
 #include <QSysInfo>
-
+#include <QThread>
 
 #if BUILDFLAG(ENABLE_LIBRARY_CDMS)
 #include "media/cdm/cdm_paths.h"  // nogncheck
@@ -485,4 +487,104 @@ blink::OriginTrialPolicy *ContentClientQt::GetOriginTrialPolicy()
     return origin_trial_policy_.get();
 }
 
+void ContentClientQt::SetGpuInfo(const gpu::GPUInfo &gpu_info)
+{
+    if (Q_LIKELY(!lcWebEngineCompositor().isDebugEnabled()))
+        return;
+
+    base::CommandLine *commandLine = base::CommandLine::ForCurrentProcess();
+    const bool isBrowserProcess = !commandLine->HasSwitch(switches::kProcessType);
+    const bool isMainThread = QThread::currentThread() == qApp->thread();
+
+    // Limit this to the main thread of the browser process for now.
+    if (!isBrowserProcess || !isMainThread)
+        return;
+
+    if (!gpu_info.IsInitialized()) {
+        // This is probably not an issue but suspicious.
+        qCDebug(lcWebEngineCompositor, "Failed to initialize GPUInfo.");
+        return;
+    }
+
+    const gpu::GPUInfo::GPUDevice &primary = gpu_info.gpu;
+
+    // Do not print the info again if the device hasn't been changed.
+    // Change of the device is unexpected: we don't support or implement fallback yet.
+    // It is suspicious if the info is logged twice.
+    if (m_gpuInfo && m_gpuInfo->gpu.device_string == primary.device_string)
+        return;
+    m_gpuInfo = gpu_info;
+
+    auto deviceToString = [](const gpu::GPUInfo::GPUDevice &device) -> QString {
+        if (device.vendor_id == 0x0)
+            return "Disabled"_L1;
+
+        QString log;
+
+        // TODO: Factor vendor translation out from QtWebEngineCore::GPUInfo.
+        // Only name the most commmon desktop GPU hardware vendors for now.
+        switch (device.vendor_id) {
+        case 0x1002:
+            log += "AMD"_L1;
+            break;
+        case 0x10DE:
+            log += "Nvidia"_L1;
+            break;
+        case 0x8086:
+            log += "Intel"_L1;
+            break;
+        default:
+            log += "vendor id: 0x"_L1 + QString::number(device.vendor_id, 16);
+        }
+
+        log += ", device id: 0x"_L1 + QString::number(device.device_id, 16);
+
+        if (!device.driver_vendor.empty()) {
+            log += ", driver: "_L1 + QLatin1StringView(device.driver_vendor) + u' '
+                    + QLatin1StringView(device.driver_version);
+        }
+        log += ", system device id: 0x"_L1 + QString::number(device.system_device_id, 16);
+
+        log += ", preference: "_L1;
+        switch (device.gpu_preference) {
+        case gl::GpuPreference::kNone:
+            log += "None"_L1;
+            break;
+        case gl::GpuPreference::kDefault:
+            log += "Default"_L1;
+            break;
+        case gl::GpuPreference::kLowPower:
+            log += "LowPower"_L1;
+            break;
+        case gl::GpuPreference::kHighPerformance:
+            log += "HighPerformance"_L1;
+            break;
+        }
+
+        log += ", active: "_L1 + (device.active ? "yes"_L1 : "no"_L1);
+        return log;
+    };
+
+    QString log;
+    if (gpu_info.gl_vendor.empty() || gpu_info.gl_vendor == "Disabled") {
+        log += "ANGLE is disabled:\n"_L1;
+        log += "  GL Renderer: "_L1 + QLatin1StringView(gpu_info.gl_renderer) + u'\n';
+        log += "  Software Renderer: "_L1 + (primary.IsSoftwareRenderer() ? "yes"_L1 : "no"_L1)
+                + u'\n';
+        log += "  Primary GPU: "_L1 + deviceToString(primary) + u'\n';
+    } else {
+        log += QLatin1StringView(gpu_info.display_type) + " display is initialized:\n"_L1;
+        log += "  GL Renderer: "_L1 + QLatin1StringView(gpu_info.gl_renderer) + u'\n';
+        log += "  "_L1 + QString::number(gpu_info.GpuCount()) + " GPU(s) detected:\n"_L1;
+        log += "    "_L1 + deviceToString(primary) + u'\n';
+        for (auto &secondary : gpu_info.secondary_gpus)
+            log += "    "_L1 + deviceToString(secondary) + u'\n';
+
+        log += "  NVIDIA Optimus: "_L1 + (gpu_info.optimus ? "enabled"_L1 : "disabled"_L1) + u'\n';
+        log += "  AMD Switchable: "_L1 + (gpu_info.amd_switchable ? "enabled"_L1 : "disabled"_L1);
+    }
+
+    qCDebug(lcWebEngineCompositor, "%ls", qUtf16Printable(log));
+}
+
 } // namespace QtWebEngineCore

src/core/content_client_qt.h

@@ -9,9 +9,11 @@
 #include "base/synchronization/lock.h"
 #include "components/embedder_support/origin_trials/origin_trial_policy_impl.h"
 #include "content/public/common/content_client.h"
+#include "gpu/config/gpu_info.h"
 #include "ui/base/layout.h"
 
 #include <memory>
+#include <optional>
 
 namespace QtWebEngineCore {
 
@@ -29,11 +31,13 @@ class ContentClientQt : public content::ContentClient {
     gfx::Image &GetNativeImageNamed(int resource_id) override;
     std::u16string GetLocalizedString(int message_id) override;
     blink::OriginTrialPolicy *GetOriginTrialPolicy() override;
+    void SetGpuInfo(const gpu::GPUInfo &gpu_info) override;
 
 private:
     // Used to lock when |origin_trial_policy_| is initialized.
     base::Lock origin_trial_policy_lock_;
     std::unique_ptr<embedder_support::OriginTrialPolicyImpl> origin_trial_policy_;
+    std::optional<gpu::GPUInfo> m_gpuInfo;
 };
 
 } // namespace QtWebEngineCore

src/core/web_engine_context.cpp

@@ -266,6 +266,7 @@ class GPUInfo
     }
 
     Vendor vendor() const { return m_vendor; }
+    QString deviceName() const { return m_deviceName; }
     QString getAdapterLuid() const { return m_adapterLuid; }
 
 private:
@@ -288,6 +289,7 @@ class GPUInfo
             }
             if (d3d11Rhi) {
                 m_vendor = vendorIdToVendor(d3d11Rhi->driverInfo().vendorId);
+                m_deviceName = QString::fromUtf8(d3d11Rhi->driverInfo().deviceName);
 
                 const QRhiD3D11NativeHandles *handles =
                         static_cast<const QRhiD3D11NativeHandles *>(d3d11Rhi->nativeHandles());
@@ -301,8 +303,10 @@ class GPUInfo
             QRhiMetalInitParams params;
             QScopedPointer<QRhi> metalRhi(
                     QRhi::create(QRhi::Metal, &params, QRhi::Flags(), nullptr));
-            if (metalRhi)
+            if (metalRhi) {
                 m_vendor = deviceNameToVendor(QLatin1StringView(metalRhi->driverInfo().deviceName));
+                m_deviceName = QString::fromUtf8(metalRhi->driverInfo().deviceName);
+            }
         }
 #endif
 
@@ -312,8 +316,10 @@ class GPUInfo
             params.fallbackSurface = QRhiGles2InitParams::newFallbackSurface();
             QScopedPointer<QRhi> glRhi(
                     QRhi::create(QRhi::OpenGLES2, &params, QRhi::Flags(), nullptr));
-            if (glRhi)
+            if (glRhi) {
                 m_vendor = deviceNameToVendor(QLatin1StringView(glRhi->driverInfo().deviceName));
+                m_deviceName = QString::fromUtf8(glRhi->driverInfo().deviceName);
+            }
         }
 #endif
 
@@ -333,6 +339,7 @@ class GPUInfo
                     // see https://www.phoronix.com/news/Mesa-20.1-Vulkan-Dev-Selection
                     // Try to detect this case and at least warn about it.
                     m_vendor = vendorIdToVendor(vulkanRhi->driverInfo().vendorId);
+                    m_deviceName = QString::fromUtf8(vulkanRhi->driverInfo().deviceName);
                 }
             }
         }
@@ -343,6 +350,7 @@ class GPUInfo
     }
 
     Vendor m_vendor = Unknown;
+    QString m_deviceName;
     QString m_adapterLuid;
 };
 
@@ -430,7 +438,8 @@ static void logContext(const std::string &glType, base::CommandLine *cmd)
         log += "QSG RHI Backend: "_L1 + QSGRhiSupport::instance()->rhiBackendName() + u'\n';
         log += "QSG RHI Backend Supported: "_L1 + (usingSupportedSGBackend() ? "yes"_L1 : "no"_L1)
                 + u'\n';
-        log += "GPU Vendor: "_L1
+        log += "QSG RHI Device: "_L1 + GPUInfo::instance()->deviceName() + u'\n';
+        log += "QSG RHI GPU Vendor: "_L1
                 + QLatin1StringView(GPUInfo::vendorToString(GPUInfo::instance()->vendor())) + u'\n';
         log += u'\n';