From patchwork Sun Jan 26 20:11:21 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Dmitry Osipenko X-Patchwork-Id: 860016 Delivered-To: patch@linaro.org Received: by 2002:a05:6000:18c8:b0:385:e875:8a9e with SMTP id w8csp1749377wrq; Sun, 26 Jan 2025 12:14:49 -0800 (PST) X-Forwarded-Encrypted: i=3; AJvYcCUnoJB/eghHJTacOLsUCRN88tdWXfB96elaM6VWrh6A5wCF6jKmc2IUk/yn65dP/CGH95DMMw==@linaro.org X-Google-Smtp-Source: AGHT+IFNnXkM2gP9DDLZCyBSn65HYR1/+X0BbUlbUm0N+t4kaCRuZuPWMIsdK1q+O8DhsN+SiMSv X-Received: by 2002:a05:622a:20b:b0:467:84a7:5147 with SMTP id d75a77b69052e-46e12c3908cmr631937371cf.39.1737922489395; Sun, 26 Jan 2025 12:14:49 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1737922489; cv=pass; d=google.com; s=arc-20240605; b=ZjokPqwWxu2kqjzbxqcxVBR9sL3v+IxoOycdqXC/0KX1aXiEcIDuV7ziCDh5MxRQK3 AhdI97N9tBKF14iIXZ+NHSs6mZwIipkLX/N7QiTOySVT5NE6yzPvTfIkUZTqqZcFnfVA 4DM5d9ejs+BcAjuLp4YAuVJReF3RSZcmK08JTyFFfKq7do/HKNnoqgXKhDcWumTImli7 3Zr818ea6LAuwR491Ap2V2epho3y4GHyiBDlBVOTEIo3CAswtFrPLmZ55POpQZyVCcKp WCd8XC+Tn1ELQccXxd88a2MgM01Vt5NgfJDYquZWKCIE111/9pZRAYIqUJD3c4XDa5eO r9oA== 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=CELht+NZbaOWA7aKErBV1ukR4Kzd5cMPD6k0OJdVh6c=; fh=qYoSDApLgNJs8TuYcqYHcnVKd7dwrie/M7rCnAIDNJI=; b=Sg0GhGI0sclNRXYhHhsZInmdmMMUTVRyvatLMcfq8TWacBP2YUjb0+DGIcgn+yNSek 5qt5r1J4ECZ53eeRSUMoWKJC+E+yaYz8P3IMwqpGVCMWT3wjrWZrqsGxPqFOJCTAEwLn dzfeEXd5V2ahWYYCNCNGuPbSQBkbBKE7la4+IsQcgdL6Q+NYI3XTPyj4T2Kp79MyofCD KtPia+ZyTdyYaHCbplKoMX0k4ivS7tipd2WEfiFJz0LjtxxMCz2aREMHUii+dYRDb+px fMlM95HmMPQLGhOYSvBtJZVhI4Z+33iXW2+wF532B2mJCqGlIcIDnQO04PKMyIUI9lfL Ibgg==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@collabora.com header.s=zohomail header.b=PcUMGNVj; 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-46e66ba64c6si87533361cf.514.2025.01.26.12.14.49 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Sun, 26 Jan 2025 12:14:49 -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=PcUMGNVj; 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 1tc91D-0003i2-KE; Sun, 26 Jan 2025 15:14:07 -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 1tc91A-0003QO-H5 for qemu-devel@nongnu.org; Sun, 26 Jan 2025 15:14:04 -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 1tc918-00060s-6Y for qemu-devel@nongnu.org; Sun, 26 Jan 2025 15:14:04 -0500 ARC-Seal: i=1; a=rsa-sha256; t=1737922428; cv=none; d=zohomail.com; s=zohoarc; b=SoBSotCTRfIzF3KUkHCv+TUIq9FCG1SKCpP22qO0wtx7Fh1wRBQFl7KE0iTl8r2dBrgs90SgXaCwMGUwYdtvlhg0puzPLunq7OvLTlPcuUe9TwrVfVr3lxICJSR5WeSyweYa3hASEKr3SytPDn0IWuFmKTn0s3E4iOymIo0zeZ8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1737922428; 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=CELht+NZbaOWA7aKErBV1ukR4Kzd5cMPD6k0OJdVh6c=; b=XxKXQ20ADdMSOCSZYdPuEO5pMuyXlT9WXS5+PWDqu54zjSO0e+LIhz3edLT07hriZF9B6yIlCwTgf92x+6BnMt3pKWs8PP5zmHvmfqX3v6+SrFypCgzePWAitTI5YCCLgkkBDyL6CkgAL983kls2gz4gaeEM69mZKZAJrqNb+yw= 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=1737922427; 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=CELht+NZbaOWA7aKErBV1ukR4Kzd5cMPD6k0OJdVh6c=; b=PcUMGNVjC1xRaaUP6T7UwwA2qdsrR7udoDE5Nl+jNJEuTZBoYfp1m4qOcVNG0tMb MCeGfbhedriLcQ6OYJ89hHe3dBPDDJIwB32IUq7TYnQb5urFR/dv5lkfKgW6Jengrku 6EPiATi5A5Jo292dZDtBDszAMr4SkZgZl/GSxMis= Received: by mx.zohomail.com with SMTPS id 1737922423344715.9777832443144; Sun, 26 Jan 2025 12:13:43 -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?= , "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 , Pierre-Eric Pelloux-Prayer , Honglei Huang , Julia Zhang , Chen Jiqian , Rob Clark , Yiwei Zhang , Sergio Lopez Pascual Subject: [PATCH v6 10/10] docs/system: virtio-gpu: Document host/guest requirements Date: Sun, 26 Jan 2025 23:11:21 +0300 Message-ID: <20250126201121.470990-11-dmitry.osipenko@collabora.com> X-Mailer: git-send-email 2.47.1 In-Reply-To: <20250126201121.470990-1-dmitry.osipenko@collabora.com> References: <20250126201121.470990-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, T_SCC_BODY_TEXT_LINE=-0.01 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 | 107 ++++++++++++++++++++++++++++- 1 file changed, 106 insertions(+), 1 deletion(-) diff --git a/docs/system/devices/virtio-gpu.rst b/docs/system/devices/virtio-gpu.rst index ea3eb052df3c..b3db984ff2d3 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 -------------------- @@ -13,6 +15,24 @@ Linux kernel support virtio-gpu requires a guest Linux kernel built with the ``CONFIG_DRM_VIRTIO_GPU`` option. +Dependencies +............ + +.. note:: + GPU virtualisation is still an evolving field. Depending on the mode + you are running you may need to override distribution supplied + libraries with more recent versions or enable build options. + + Depending on the mode there are a number of requirements the host must + meet to be able to be able to support guests. For 3D acceleration QEMU + must be able to access the hosts GPU and for the best performance be + able to reliably share GPU memory with the guest. + + Virtio-gpu requires a guest Linux kernel built with the + ``CONFIG_DRM_VIRTIO_GPU`` option. For 3D accelerations you + will need support from guest Mesa configured for whichever encapsulation + you need. + QEMU virtio-gpu variants ------------------------ @@ -56,6 +76,16 @@ on typical modern Linux distributions. .. _Mesa: https://www.mesa3d.org/ .. _SwiftShader: https://github.com/google/swiftshader +.. list-table:: Host Requirements + :header-rows: 1 + + * - Mode + - Kernel + - Userspace + * - virtio-gpu + - Framebuffer enabled + - GTK or SDL display + virtio-gpu virglrenderer ------------------------ @@ -94,6 +124,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:: Host Requirements + :header-rows: 1 + + * - Mode + - Kernel + - Userspace + * - virtio-gpu-gl (OpenGL pass-through) + - GPU enabled + - libvirglrenderer (virgl support) + * - virtio-gpu-gl (Vulkan pass-through) + - Linux 6.13+ + - libvirglrenderer (>= 1.0.0, venus support) + * - virtio-gpu-gl (vDRM native context/AMD) + - Linux 6.13+ + - libvirglrenderer (>= 1.1.0, DRM renderer support) + * - virtio-gpu-gl (vDRM native context/Freedreno) + - Linux 6.4+ + - libvirglrenderer (>= 1.0.0, DRM renderer support) + * - virtio-gpu-gl (vDRM native context/Intel i915) + - Linux 6.13+ + - libvirglrenderer (`mr1384`_, DRM renderer support) + * - virtio-gpu-gl (vDRM native context/Asahi) + - Linux 6.13+ + - libvirglrenderer (`mr1274`_, DRM renderer support) + +.. _mr1384: https://gitlab.freedesktop.org/virgl/virglrenderer/-/merge_requests/1384 +.. _mr1274: https://gitlab.freedesktop.org/virgl/virglrenderer/-/merge_requests/1274 + +.. list-table:: Guest Requirements + :header-rows: 1 + + * - Mode + - Mesa Version + - Mesa build flags + * - virtio-gpu-gl (OpenGL pass-through) + - 20.3.0+ + - -Dgallium-drivers=virgl + * - virtio-gpu-gl (Vulkan pass-through) + - 24.2.0+ + - -Dvulkan-drivers=virtio + * - virtio-gpu-gl (vDRM native context/AMD) + - 25.0.0+ + - -Dgallium-drivers=radeonsi -Dvulkan-drivers=amd -Damdgpu-virtio=true + * - virtio-gpu-gl (vDRM native context/Freedreno) + - 23.1.0+ + - -Dgallium-drivers=freedreno -Dvulkan-drivers=freedreno + * - virtio-gpu-gl (vDRM native context/Intel i915) + - `mr29870`_ + - -Dgallium-drivers=iris -Dvulkan-drivers=intel -Dintel-virtio-experimental=true + * - virtio-gpu-gl (vDRM native context/Asahi) + - 24.2.0+ + - -Dgallium-drivers=asahi -Dvulkan-drivers=asahi + +.. _mr29870: https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/29870 + virtio-gpu rutabaga ------------------- @@ -133,3 +218,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:: Host Requirements + :header-rows: 1 + + * - Mode + - Kernel + - Userspace + * - virtio-gpu-gl (rutabaga/gfxstream) + - GPU enabled + - aemu/rutabaga_gfx_ffi or vhost-user client with support + +.. list-table:: Guest Requirements + :header-rows: 1 + + * - Mode + - Mesa Version + - Mesa build flags + * - virtio-gpu-gl (rutabaga/gfxstream) + - 24.3.0+ + - -Dvulkan-drivers=gfxstream