From patchwork Sun Feb 9 16:56:49 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Dmitry Osipenko X-Patchwork-Id: 863601 Delivered-To: patch@linaro.org Received: by 2002:a5d:4e42:0:b0:385:e875:8a9e with SMTP id r2csp1249765wrt; Sun, 9 Feb 2025 08:59:50 -0800 (PST) X-Forwarded-Encrypted: i=3; AJvYcCWMxVLZhN5LvOjljKl2t9qgHwFS1C4fNrtRPBa+eqnT8A8DcjS4rYdrMNnsW+LZzJwyrKtfRw==@linaro.org X-Google-Smtp-Source: AGHT+IFYbY4NgE9y7Dh3BiatcI36p5bVpryvVGdqkKy7iIVpY9gNmimD7iK50p9XCVPgrDD4RhJY X-Received: by 2002:a05:622a:578d:b0:470:1fc6:f821 with SMTP id d75a77b69052e-47167ac3cafmr185497081cf.35.1739120390137; Sun, 09 Feb 2025 08:59:50 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1739120390; cv=pass; d=google.com; s=arc-20240605; b=WpWPU+mpkyk7fUMfHAMczom2CLCc5rVG/p93LwVkyv+t69dNkP+CaN1+LhLBax+ZHR OkSGdcF++slbFBaAStzwbIjaAUDkqVp8ju1reRksYMY2ah6HjkkNbAUcb4vEkWVSO/rz zLUVxS6dvtQjf53MKRESNPprCjWor8gZDe4sr2YvSLOtfxyAwKuTsWCh1jDL2Xbm3nUN KVq9nTMm3oGWkXF35HrEsEmR8Y2euv+s+HJjizOmj2fVRjTcVdbNYDAErKfez7XGg+4M nY4yfEMVU2Y+j8KxkQCUUQrbz2GI3hkkcGmTcQwYZFAQHdJ0Jiu4iIq9a4fstZhifpDk iinA== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20240605; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=64uV+I0WgV7YvBrDsehY8khnJNZ+HrjZx/C48Sc9hm8=; fh=j2ngPnbUv+er2uRoyxJ/dvQ7gYZ2LB4w1UTG25rpeFs=; b=HwRdB0AwhaiDBJTEBBQOKmVRjWlcqK1EEeGrRE1x4EJfJxPTMWQhGg4g8A4na6P4ZP OXGhDqA8Wf7BKW6xooahfyG5N/zhlsn7UwsixC1Ccd/1qqY0l0oIuzyVke2IoPMKyg4R R6fDoB3x7qO2IECiEIWvJDhLdiQVoRF0Ax9j6jMcAdBNEUd9ITPs/2nizE+rtt6CshAD 1w1+POcX14W5IxbUY9YIINWgR1MrU9o8VYM5ApLNHWFoBlb7mE1ULpyOpVMq8wWLVCHk I9ixYf4/pfizAl1yRwXF6yY1qfInVrMcKlv+7cTnLdC+2la/4PApizCJPWCy271Tv0Eu 0JSA==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@collabora.com header.s=zohomail header.b=DWUeyxiO; arc=pass (i=1 spf=pass spfdomain=collabora.com dkim=pass dkdomain=collabora.com dmarc=pass fromdomain=collabora.com>); spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=collabora.com Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id d75a77b69052e-47153b933c0si76903191cf.373.2025.02.09.08.59.49 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Sun, 09 Feb 2025 08:59:50 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@collabora.com header.s=zohomail header.b=DWUeyxiO; arc=pass (i=1 spf=pass spfdomain=collabora.com dkim=pass dkdomain=collabora.com dmarc=pass fromdomain=collabora.com>); spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=collabora.com Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1thAeg-0003AX-VA; Sun, 09 Feb 2025 11:59:39 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1thAeb-0002pr-AV for qemu-devel@nongnu.org; Sun, 09 Feb 2025 11:59:33 -0500 Received: from sender4-pp-f112.zoho.com ([136.143.188.112]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1thAeY-0007Sp-PS for qemu-devel@nongnu.org; Sun, 09 Feb 2025 11:59:32 -0500 ARC-Seal: i=1; a=rsa-sha256; t=1739120359; cv=none; d=zohomail.com; s=zohoarc; b=Ch7Wr0WpEnC6kcEhkYTOQKUQFr3yp3PZ5y20NQzHWW4mydEfrRSOKJUQyHsVn1jCSF5i6k+kZdxtOlitguLL+jKCdr0BnzQ6DlMltecXPCaStb6PDu1a2shKfOS2rd9qeM0HJRXJyAg17gIjD3GqFCWgksiDTutsU40SCxaGO10= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1739120359; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:Subject:To:To:Message-Id:Reply-To; bh=64uV+I0WgV7YvBrDsehY8khnJNZ+HrjZx/C48Sc9hm8=; b=V/JsZ9DjxCjTfCb9tb+jusBJK3TnYhaDRS4QXqarJN4SU/VLGxdthyuNGO9aKOIx3VK4BNEePQWn3UgQ0N97pXygjgor7JMAVrNBPha0V0Z09wksnak4UyGNxuDGBdv+vw5XVEcF9NxR50grKUfx2QwsBVy+7uOKJZP8Rlzc1gM= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=collabora.com; spf=pass smtp.mailfrom=dmitry.osipenko@collabora.com; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1739120359; s=zohomail; d=collabora.com; i=dmitry.osipenko@collabora.com; h=From:From:To:To:Cc:Cc:Subject:Subject:Date:Date:Message-ID:In-Reply-To:References:MIME-Version:Content-Type:Content-Transfer-Encoding:Message-Id:Reply-To; bh=64uV+I0WgV7YvBrDsehY8khnJNZ+HrjZx/C48Sc9hm8=; b=DWUeyxiO9qFHRMA7ks5bgDeX3fyTuSMoDzSB0rGXk8ASGFykiu1q2FJvk8b4soYN KHDTAerP2YBadXRlDQfs0UNV76NV/4SpuBtHD02zVJwEmuoA5LmZSvDmdp0CIQkECJG EOwwOXrjDT8+nlK5X8P3F7R8vh7R3Atj5Mn1nc5A= Received: by mx.zohomail.com with SMTPS id 1739120356466466.17990285617464; Sun, 9 Feb 2025 08:59:16 -0800 (PST) From: Dmitry Osipenko To: Akihiko Odaki , Huang Rui , =?utf-8?q?Marc-Andr=C3=A9_Lureau?= , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Gerd Hoffmann , =?utf-8?q?Alex_Benn=C3=A9e?= , Pierre-Eric Pelloux-Prayer , "Michael S . Tsirkin" , Paolo Bonzini Cc: Gert Wollny , qemu-devel@nongnu.org, Gurchetan Singh , Alyssa Ross , =?utf-8?q?Roger_Pau_Monn=C3=A9?= , Alex Deucher , Stefano Stabellini , =?utf-8?q?Christian_K?= =?utf-8?q?=C3=B6nig?= , Xenia Ragiadakou , Honglei Huang , Julia Zhang , Chen Jiqian , Rob Clark , Yiwei Zhang , Sergio Lopez Pascual Subject: [PATCH v8 10/10] docs/system: virtio-gpu: Document host/guest requirements Date: Sun, 9 Feb 2025 19:56:49 +0300 Message-ID: <20250209165649.544005-11-dmitry.osipenko@collabora.com> X-Mailer: git-send-email 2.47.1 In-Reply-To: <20250209165649.544005-1-dmitry.osipenko@collabora.com> References: <20250209165649.544005-1-dmitry.osipenko@collabora.com> MIME-Version: 1.0 X-ZohoMailClient: External Received-SPF: pass client-ip=136.143.188.112; envelope-from=dmitry.osipenko@collabora.com; helo=sender4-pp-f112.zoho.com X-Spam_score_int: -30 X-Spam_score: -3.1 X-Spam_bar: --- X-Spam_report: (-3.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=-1, RCVD_IN_MSPIKE_WL=-0.01, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org From: Alex Bennée This attempts to tidy up the VirtIO GPU documentation to make the list of requirements clearer. There are still a lot of moving parts and the distros have some catching up to do before this is all handled automatically. Signed-off-by: Alex Bennée Cc: Sergio Lopez Pascual Signed-off-by: Dmitry Osipenko [dmitry.osipenko@collabora.com: Extended and corrected doc] --- docs/system/devices/virtio-gpu.rst | 106 ++++++++++++++++++++++++++++- 1 file changed, 104 insertions(+), 2 deletions(-) diff --git a/docs/system/devices/virtio-gpu.rst b/docs/system/devices/virtio-gpu.rst index ea3eb052df3c..664fc4000fa9 100644 --- a/docs/system/devices/virtio-gpu.rst +++ b/docs/system/devices/virtio-gpu.rst @@ -5,14 +5,34 @@ virtio-gpu ========== This document explains the setup and usage of the virtio-gpu device. -The virtio-gpu device paravirtualizes the GPU and display controller. +The virtio-gpu device provides a GPU and display controller +paravirtualized using VirtIO. It supports a number of different modes +from simple 2D displays to fully accelerated 3D graphics. + +virtio-gpu requirements +----------------------- Linux kernel support --------------------- +^^^^^^^^^^^^^^^^^^^^ virtio-gpu requires a guest Linux kernel built with the ``CONFIG_DRM_VIRTIO_GPU`` option. +Host Linux kernel requirements vary depending on a used virtio-gpu +capabilities. See further sections for a detailed descriptions. + +3D acceleration +^^^^^^^^^^^^^^^ + +3D acceleration of a virtualized GPU is still an evolving field. +Depending on the 3D mode you are running you may need to override +distribution supplied libraries with more recent versions or enable +build options. There are a number of requirements the host must meet +to be able to be able to support guests. QEMU must be able to access the +host's GPU and for the best performance be able to reliably share GPU +memory with the guest. Details of 3D acceleration requirements are +described in a further sections. + QEMU virtio-gpu variants ------------------------ @@ -65,8 +85,14 @@ intermediate representation is communicated to the host and the `virglrenderer`_ library on the host translates the intermediate representation back to OpenGL API calls. +By default OpenGL version on guest is limited to 4.3. In order to enable +OpenGL 4.6 support, virtio-gpu host blobs feature (``hostmem`` and ``blob`` +fields) should be enabled. The ``hostmem`` field specifies the size of +virtio-gpu host memory window. This is typically between 256M and 8G. + .. parsed-literal:: -device virtio-gpu-gl + -device virtio-gpu-gl,hostmem=8G,blob=true .. _virgl: https://docs.mesa3d.org/drivers/virgl.html .. _Gallium3D: https://www.freedesktop.org/wiki/Software/gallium/ @@ -94,6 +120,62 @@ of virtio-gpu host memory window. This is typically between 256M and 8G. .. _drm: https://gitlab.freedesktop.org/virgl/virglrenderer/-/tree/main/src/drm +.. list-table:: Linux Host Requirements + :header-rows: 1 + + * - Capability + - Kernel + - virglrenderer build flags + * - OpenGL pass-through + - Any Linux version compatible with QEMU if not using host blobs feature, + Linux 6.13+ otherwise + - N/A + * - Vulkan pass-through + - Linux 6.13+ + - -Dvenus=true -Drender-server=true + * - AMDGPU DRM native context + - Linux 6.13+ + - -Ddrm-renderers=amdgpu-experimental + * - Freedreno DRM native context + - Linux 6.4+ + - -Ddrm-renderers=msm + * - Intel i915 DRM native context + - Linux 6.13+ + - -Ddrm-renderers=i915-experimental `mr1384`_ + * - Asahi DRM native context + - Downstream version of Asahi Linux kernel + - -Ddrm-renderers=asahi-experimental `mr1274`_ + +.. _mr1384: https://gitlab.freedesktop.org/virgl/virglrenderer/-/merge_requests/1384 +.. _mr1274: https://gitlab.freedesktop.org/virgl/virglrenderer/-/merge_requests/1274 + +.. list-table:: Linux Guest Requirements + :header-rows: 1 + + * - Capability + - Mesa Version + - Mesa build flags + * - OpenGL pass-through + - 16.0.0+ + - -Dgallium-drivers=virgl + * - Vulkan pass-through + - 24.2.0+ + - -Dvulkan-drivers=virtio + * - AMDGPU DRM native context + - 25.0.0+ + - -Dgallium-drivers=radeonsi -Dvulkan-drivers=amd -Damdgpu-virtio=true + * - Freedreno DRM native context + - 23.1.0+ + - -Dgallium-drivers=freedreno -Dvulkan-drivers=freedreno + * - Intel i915 DRM native context + - `mr29870`_ + - -Dgallium-drivers=iris -Dvulkan-drivers=intel -Dintel-virtio-experimental=true + * - Asahi DRM native context + - 24.2.0+ + - -Dgallium-drivers=asahi -Dvulkan-drivers=asahi + +.. _mr29870: https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/29870 + virtio-gpu rutabaga ------------------- @@ -133,3 +215,23 @@ Surfaceless is the default if ``wsi`` is not specified. .. _Wayland display passthrough: https://www.youtube.com/watch?v=OZJiHMtIQ2M .. _gfxstream-enabled rutabaga: https://crosvm.dev/book/appendix/rutabaga_gfx.html .. _guest Wayland proxy: https://crosvm.dev/book/devices/wayland.html + +.. list-table:: Linux Host Requirements + :header-rows: 1 + + * - Capability + - Kernel + - Rutabaga build flags + * - Vulkan+Wayland pass-through + - Linux 6.13+ + - Follow `gfxstream-enabled rutabaga`_ build instructions + +.. list-table:: Linux Guest Requirements + :header-rows: 1 + + * - Capability + - Mesa Version + - Mesa build flags + * - Vulkan pass-through + - 24.3.0+ + - -Dvulkan-drivers=gfxstream