From nobody Thu Nov 28 10:56:37 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=chromium.org ARC-Seal: i=1; a=rsa-sha256; t=1693269518; cv=none; d=zohomail.com; s=zohoarc; b=AG3Iu4pQm+KnyMKynpQJ23OY4LRnqXOTwJ4dKt1BgpFlr9hUq+EWCIWZnJC3RRwgP2jJfmeiz+qixKZWP1+nV7WkCIqFR3gsLHz7RqdZg4EfFQGvxVcf/iXx48rd6DwTwaSf6aZl6l7sQdz75tYVxfKBez+6IP3jvUeVELB8YY8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1693269518; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=qQDMRgOIZ7Xr/VkYBGa5ttujJNGzWAat0davifSMgxM=; b=oJSpFHKUWLiGoSG1VRICXPINpzM1ZiaoFYw8jllmmIsfv630o8AR/GYuM8D/t8UjjBwTfFI2s4dWKxyAxI/ma4uWfIqhTSpfXmfz4hwf5fEBZ2bUmuTBNPnwdIYfYEeQdSAFRPZzfTkQsaEo67fkss1h0VfaVOO5t4lDR7SFJL8= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1693269518256690.1393935457461; Mon, 28 Aug 2023 17:38:38 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qamjM-0007fw-Re; Mon, 28 Aug 2023 20:37:17 -0400 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 1qamjA-0007dc-Lf for qemu-devel@nongnu.org; Mon, 28 Aug 2023 20:37:06 -0400 Received: from mail-oi1-x22a.google.com ([2607:f8b0:4864:20::22a]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qamj5-0007fW-Ho for qemu-devel@nongnu.org; Mon, 28 Aug 2023 20:37:03 -0400 Received: by mail-oi1-x22a.google.com with SMTP id 5614622812f47-3a86a0355dfso2710437b6e.0 for ; Mon, 28 Aug 2023 17:36:45 -0700 (PDT) Received: from gurchetansingh0.mtv.corp.google.com ([2620:15c:a7:2:5fa1:f455:2676:5eee]) by smtp.gmail.com with ESMTPSA id c3-20020aa78c03000000b0068890c19c49sm7214782pfd.180.2023.08.28.17.36.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 28 Aug 2023 17:36:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1693269404; x=1693874204; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=qQDMRgOIZ7Xr/VkYBGa5ttujJNGzWAat0davifSMgxM=; b=hRz7M3RCk+E6XTxpzDBVEVjRID1TrNSHtmImL+pGgttzYoYxTKbcz7J2HNyCOwAwAa qZ63ypYpyz/EF80+G7hM5fCx2xcDgxwSElmUiGdF8ZNpU/dCPxMhH/NXgVb65grS43xA 4y7JKFbsoRNcaHhzPKaafXit3568bft+IC+zY= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1693269404; x=1693874204; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=qQDMRgOIZ7Xr/VkYBGa5ttujJNGzWAat0davifSMgxM=; b=NYTehviQGP7asCt1rSvhPVMcKwlJ4qn9ipb7fHdyB7GotCUwtpoeYeN37CLOOfDRlH IZuABJ19xxSHUdAv8e23PGJemDCes3qaNuDgp/GDyPhhl6C+f7kVwiJcWeh4xf4RQ6fz 10zmYDJIPUkmeNmDqnA8135s1/YAx8nbu4yAeOxIRLmjXfS8xeEHiGWH22o3+hAVWUWH YTFFMI4uFuV2auKQawIA+c4GxKNOJHc5HLXKUlgEvwukwnoO1Z9ig5qNsLkC7XV9TPF2 LTEpYVFytmPQGuv6cUq3ClN9syq4aKum8bJZHe9SixGNhIh0bkWt/CU571MhXQeKf31I 5guA== X-Gm-Message-State: AOJu0Yy9pUYzJrAYbapeo7BV1Vc1N+iyJQGCz9uXu4dnSj/zwDdUCPnK XCFDGE4aGOiZSkZwWbrQeLcwuZTc5ebo0w0wrj8= X-Google-Smtp-Source: AGHT+IH8nIaUF3HX0KCGLZT8dlbHtBoTnXaNx0nzCd7AUGgEu7njdbrtOuoo5u7YB8gbh4QVoaiMag== X-Received: by 2002:a05:6808:199e:b0:3a7:208c:4406 with SMTP id bj30-20020a056808199e00b003a7208c4406mr14256207oib.1.1693269404326; Mon, 28 Aug 2023 17:36:44 -0700 (PDT) From: Gurchetan Singh To: qemu-devel@nongnu.org Cc: marcandre.lureau@redhat.com, akihiko.odaki@gmail.com, ray.huang@amd.com, alex.bennee@linaro.org, shentey@gmail.com, hi@alyssa.is, ernunes@redhat.com, manos.pitsidianakis@linaro.org, philmd@linaro.org, mark.cave-ayland@ilande.co.uk Subject: [PATCH v13 9/9] docs/system: add basic virtio-gpu documentation Date: Mon, 28 Aug 2023 17:36:29 -0700 Message-Id: <20230829003629.410-10-gurchetansingh@chromium.org> X-Mailer: git-send-email 2.31.0 In-Reply-To: <20230829003629.410-1-gurchetansingh@chromium.org> References: <20230829003629.410-1-gurchetansingh@chromium.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::22a; envelope-from=gurchetansingh@chromium.org; helo=mail-oi1-x22a.google.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, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @chromium.org) X-ZM-MESSAGEID: 1693269519813100001 Content-Type: text/plain; charset="utf-8" This adds basic documentation for virtio-gpu. Suggested-by: Akihiko Odaki Signed-off-by: Gurchetan Singh Tested-by: Alyssa Ross Tested-by: Emmanouil Pitsidianakis Tested-by: Akihiko Odaki Reviewed-by: Emmanouil Pitsidianakis Reviewed-by: Antonio Caggiano Reviewed-by: Akihiko Odaki --- docs/system/device-emulation.rst | 1 + docs/system/devices/virtio-gpu.rst | 112 +++++++++++++++++++++++++++++ 2 files changed, 113 insertions(+) create mode 100644 docs/system/devices/virtio-gpu.rst diff --git a/docs/system/device-emulation.rst b/docs/system/device-emulatio= n.rst index 4491c4cbf7..1167f3a9f2 100644 --- a/docs/system/device-emulation.rst +++ b/docs/system/device-emulation.rst @@ -91,6 +91,7 @@ Emulated Devices devices/nvme.rst devices/usb.rst devices/vhost-user.rst + devices/virtio-gpu.rst devices/virtio-pmem.rst devices/vhost-user-rng.rst devices/canokey.rst diff --git a/docs/system/devices/virtio-gpu.rst b/docs/system/devices/virti= o-gpu.rst new file mode 100644 index 0000000000..21465e4ce2 --- /dev/null +++ b/docs/system/devices/virtio-gpu.rst @@ -0,0 +1,112 @@ +.. + SPDX-License-Identifier: GPL-2.0-or-later + +virtio-gpu +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +This document explains the setup and usage of the virtio-gpu device. +The virtio-gpu device paravirtualizes the GPU and display controller. + +Linux kernel support +-------------------- + +virtio-gpu requires a guest Linux kernel built with the +``CONFIG_DRM_VIRTIO_GPU`` option. + +QEMU virtio-gpu variants +------------------------ + +QEMU virtio-gpu device variants come in the following form: + + * ``virtio-vga[-BACKEND]`` + * ``virtio-gpu[-BACKEND][-INTERFACE]`` + * ``vhost-user-vga`` + * ``vhost-user-pci`` + +**Backends:** QEMU provides a 2D virtio-gpu backend, and two accelerated +backends: virglrenderer ('gl' device label) and rutabaga_gfx ('rutabaga' +device label). There is a vhost-user backend that runs the graphics stack +in a separate process for improved isolation. + +**Interfaces:** QEMU further categorizes virtio-gpu device variants based +on the interface exposed to the guest. The interfaces can be classified +into VGA and non-VGA variants. The VGA ones are prefixed with virtio-vga +or vhost-user-vga while the non-VGA ones are prefixed with virtio-gpu or +vhost-user-gpu. + +The VGA ones always use the PCI interface, but for the non-VGA ones, the +user can further pick between MMIO or PCI. For MMIO, the user can suffix +the device name with -device, though vhost-user-gpu does not support MMIO. +For PCI, the user can suffix it with -pci. Without these suffixes, the +platform default will be chosen. + +virtio-gpu 2d +------------- + +The default 2D backend only performs 2D operations. The guest needs to +employ a software renderer for 3D graphics. + +Typically, the software renderer is provided by `Mesa`_ or `SwiftShader`_. +Mesa's implementations (LLVMpipe, Lavapipe and virgl below) work out of box +on typical modern Linux distributions. + +.. parsed-literal:: + -device virtio-gpu + +.. _Mesa: https://www.mesa3d.org/ +.. _SwiftShader: https://github.com/google/swiftshader + +virtio-gpu virglrenderer +------------------------ + +When using virgl accelerated graphics mode in the guest, OpenGL API calls +are translated into an intermediate representation (see `Gallium3D`_). The +intermediate representation is communicated to the host and the +`virglrenderer`_ library on the host translates the intermediate +representation back to OpenGL API calls. + +.. parsed-literal:: + -device virtio-gpu-gl + +.. _Gallium3D: https://www.freedesktop.org/wiki/Software/gallium/ +.. _virglrenderer: https://gitlab.freedesktop.org/virgl/virglrenderer/ + +virtio-gpu rutabaga +------------------- + +virtio-gpu can also leverage rutabaga_gfx to provide `gfxstream`_ +rendering and `Wayland display passthrough`_. With the gfxstream rendering +mode, GLES and Vulkan calls are forwarded to the host with minimal +modification. + +The crosvm book provides directions on how to build a `gfxstream-enabled +rutabaga`_ and launch a `guest Wayland proxy`_. + +This device does require host blob support (``hostmem`` field below). The +``hostmem`` field specifies the size of virtio-gpu host memory window. +This is typically between 256M and 8G. + +At least one capset (see colon separated ``capset_names`` below) must be +specified when starting the device. The currently supported +``capset_names`` are ``gfxstream-vulkan`` and ``cross-domain`` on Linux +guests. For Android guests, ``gfxstream-gles`` is also supported. + +The device will try to auto-detect the wayland socket path if the +``cross-domain`` capset name is set. The user may optionally specify +``wayland_socket_path`` for non-standard paths. + +The ``wsi`` option can be set to ``surfaceless`` or ``headless``. +Surfaceless doesn't create a native window surface, but does copy from the +render target to the Pixman buffer if a virtio-gpu 2D hypercall is issued. +Headless is like surfaceless, but doesn't copy to the Pixman buffer. +Surfaceless is the default if ``wsi`` is not specified. + +.. parsed-literal:: + -device virtio-gpu-rutabaga,capset_names=3Dgfxstream-vulkan:cross-doma= in, + hostmem=3D8G,wayland_socket_path=3D/tmp/nonstandard/mock_wayland.so= ck, + wsi=3Dheadless + +.. _gfxstream: https://android.googlesource.com/platform/hardware/google/g= fxstream/ +.. _Wayland display passthrough: https://www.youtube.com/watch?v=3DOZJiHMt= IQ2M +.. _gfxstream-enabled rutabaga: https://crosvm.dev/book/appendix/rutabaga_= gfx.html +.. _guest Wayland proxy: https://crosvm.dev/book/devices/wayland.html --=20 2.42.0.rc2.253.gd59a3bf2b4-goog