From patchwork Sun Feb 2 23:21:36 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Dmitry Osipenko X-Patchwork-Id: 861440 Delivered-To: patch@linaro.org Received: by 2002:adf:fb05:0:b0:385:e875:8a9e with SMTP id c5csp1776649wrr; Sun, 2 Feb 2025 15:28:35 -0800 (PST) X-Forwarded-Encrypted: i=3; AJvYcCUbWzmKuyGDVFxVLJrlnEwon8cfoNAALbeilsrBu33uFktyQzJJRNuyqKbgGbb3iSwAJtYNzA==@linaro.org X-Google-Smtp-Source: AGHT+IEij55aEwlmVmHFs4BrLFkDTsJZy1jXXcC3cTXY5270ezx+5JaJJGGddKfB9L6nFeMWecUn X-Received: by 2002:a05:6214:ccb:b0:6d8:a258:68bc with SMTP id 6a1803df08f44-6e251b5d6f2mr211006096d6.11.1738538915757; Sun, 02 Feb 2025 15:28:35 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1738538915; cv=pass; d=google.com; s=arc-20240605; b=Yp0Xm4iAGLnLvVEoa9Hy27gtLS/o9Y9N+IXfHT/RrLWeLCIg3pUcsmsyzAisKY+FFV b4WauACuNLTB4aoBRxQz2/HDTXhZiiC4LNiMvbrojrEwAD8s+E0GZvuF0JqHz3oDVh3E whxloMoXHG+LB2IRjyMJ8dsmV50C8ByVJ+atGtK/Dbd9OQWa/m8nGVBXFfPq+vsoSn6b qUrVoEVt7ozM6/UF+MSFFpG6Cbw42SVeYEKy2X10wRD52o8GPhDsm3Ro/FNl0jcMWPk1 6cMJ5Tq/2anD9RT8WezCFfJlBM4Mno/cb1xH0H7IsTHq8tw1iPfGVfbFeE1VRBGrXHwG adiQ== 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=MdlrDBVL5mxVDB27OYZYYdy/66+pKF7zkU8ban+3B1s=; fh=j2ngPnbUv+er2uRoyxJ/dvQ7gYZ2LB4w1UTG25rpeFs=; b=LL74vEn5BQN1DHaciVbB5emJqvplLI+CX4DW2yDkgYk6P+6wxd0J2j0wsVX6hQSmE7 U5yausemHan3P44wA8Y+TsIVHiDWkfnigdBtCtYhB+etu/gpMz207Ke1neNl7RWSVh0H cY1jVa5aDr0D/9sgxowRynVpfjpAEJ0eNn9SAD4ooWwOAEGB8GysoEEXSEEUo0Hv2eCk e/ZuwaxGqBfxnCxHC/l9knbZkaOgnwRlQe1UXysDCmNXlYFXOlIDqILQg4yhTkHZfxC9 BpuOP6/wPmKEyRpreccZ2Dkgja+Cko4rW6MsOtY2X4ud5QhXtMXZ0mhAba6vMFRYACTE BGWQ==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@collabora.com header.s=zohomail header.b=FpxiEaMm; 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 6a1803df08f44-6e2549c6d02si85882116d6.405.2025.02.02.15.28.35 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Sun, 02 Feb 2025 15:28:35 -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=FpxiEaMm; 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 1tejNl-0003eb-Ni; Sun, 02 Feb 2025 18:28:06 -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 1tejNf-0003Vs-UX for qemu-devel@nongnu.org; Sun, 02 Feb 2025 18:28:00 -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 1tejNd-0003bD-Dh for qemu-devel@nongnu.org; Sun, 02 Feb 2025 18:27:59 -0500 ARC-Seal: i=1; a=rsa-sha256; t=1738538863; cv=none; d=zohomail.com; s=zohoarc; b=KSwhHymRGXU9MRTYVlXbBIIv75ZxqIN+L3LDxQi1EWm3RHt0fGomT7ohE+xpo2aPy2qMJYai5FQJcQufIWVfuZ+gs+R5t3v1ociGeeUAMeBrl6w3lblXy6lPgWaZ0+FhIuDxMz9jHdE4motquvz+w4bFpecrijEhMSxbuHR90to= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1738538863; 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=MdlrDBVL5mxVDB27OYZYYdy/66+pKF7zkU8ban+3B1s=; b=EdEiF4RYOrGnESCSTtwCCFrVY8WmnNRx4cjYxOn0ITbZNYoRbXmLwFxeKhkkjqo3ptADyrJngvsuC5TBQUEZhZi2JI7/8OdPGbepKdAkRSBQNnG28EthlTSIpTuid7RiwDPtJOKkUbpVuB/IMl6G5XIdxui53TZL0H1oI0O1r1E= 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=1738538863; 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=MdlrDBVL5mxVDB27OYZYYdy/66+pKF7zkU8ban+3B1s=; b=FpxiEaMm4Uk+1Ptod5D4FdhnJTPOzBtScbELy2Mkl08xj3BBNhXJyoUq2f8V7e0N ch51JdA4XwCNIIF4Sr8pY6QxZUjaw0P+q1ijkz2aYuoFu70f2tsB+x07q1NUJMtW/d6 btwgUmNJ5YCC5ny57JCkKKQOufCcHOI0MYPr1BqY= Received: by mx.zohomail.com with SMTPS id 1738538857014988.1498560462146; Sun, 2 Feb 2025 15:27:37 -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 v7 10/10] docs/system: virtio-gpu: Document host/guest requirements Date: Mon, 3 Feb 2025 02:21:36 +0300 Message-ID: <20250202232136.919342-11-dmitry.osipenko@collabora.com> X-Mailer: git-send-email 2.47.1 In-Reply-To: <20250202232136.919342-1-dmitry.osipenko@collabora.com> References: <20250202232136.919342-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: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.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_H2=-0.01, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_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 | 92 +++++++++++++++++++++++++++++- 1 file changed, 91 insertions(+), 1 deletion(-) diff --git a/docs/system/devices/virtio-gpu.rst b/docs/system/devices/virtio-gpu.rst index ea3eb052df3c..56950a76aa2e 100644 --- a/docs/system/devices/virtio-gpu.rst +++ b/docs/system/devices/virtio-gpu.rst @@ -5,7 +5,9 @@ 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. Linux kernel support -------------------- @@ -56,6 +58,17 @@ on typical modern Linux distributions. .. _Mesa: https://www.mesa3d.org/ .. _SwiftShader: https://github.com/google/swiftshader +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. + virtio-gpu virglrenderer ------------------------ @@ -94,6 +107,61 @@ 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 + + * - Mode + - Kernel + - libvirglrenderer build flags + * - OpenGL pass-through + - Linux any stable version + - 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 + - Linux 6.13+ + - -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 + + * - Mode + - 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 +201,25 @@ 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 + + * - Mode + - Kernel + - Userspace + * - rutabaga-gfxstream + - Linux 6.13+ + - rutabaga_gfx_ffi or vhost-user client with `gfxstream support`_ + +.. _gfxstream support: https://github.com/rust-vmm/vhost-device/tree/main/staging/vhost-device-gpu + +.. list-table:: Linux Guest Requirements + :header-rows: 1 + + * - Mode + - Mesa Version + - Mesa build flags + * - rutabaga-gfxstream + - 24.3.0+ + - -Dvulkan-drivers=gfxstream