From nobody Thu Nov 14 18:14:13 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=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1708353303; cv=none; d=zohomail.com; s=zohoarc; b=WgI6eS1mYP7BlXBKdLtPCf0y96lw/meCa+GSsjcBujMZdKZMuWhlG1eAtsWQLqhI7TrsTdRGOURohhj8Gf4hxg+KbZl2nunVng0QWr5e7sZISP7eluEe2Aj++AVdTeD1T2q2ZrdVPwpSNg8/nsd9fprPdd47NF0S5pDn6ydpuXM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1708353303; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=viv1ei9TE6PclCvoUv4smop7x8HeIq1N/VAQZhMnZNE=; b=guV+g3cKVYtZ2DuqTFzCQ9W/KBMy5OR9OAmkBExbMkE97T/HT14zvVIusAR7LJClX/TkHJCe7Gzr2Njhmxa84nuQdmQ5QIqzx3uFLlZQB+Vwq8gVuWqjLXJ6cmjITx3MLTcABlvZX7J6PnkpygVOUIYihKpj8/xqNwdphmo0wSc= 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 170835330334384.97228683805758; Mon, 19 Feb 2024 06:35:03 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rc4jK-0007iv-Rs; Mon, 19 Feb 2024 09:34:53 -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 1rc4jE-0007hA-D5 for qemu-devel@nongnu.org; Mon, 19 Feb 2024 09:34:44 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rc4jB-0003qy-Pu for qemu-devel@nongnu.org; Mon, 19 Feb 2024 09:34:44 -0500 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-283-HAIu5jTfNNeKbuMEEzIO2Q-1; Mon, 19 Feb 2024 09:34:37 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 06FE685A588; Mon, 19 Feb 2024 14:34:37 +0000 (UTC) Received: from localhost.localdomain (unknown [10.45.224.250]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0604F20229A3; Mon, 19 Feb 2024 14:34:34 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1708353280; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=viv1ei9TE6PclCvoUv4smop7x8HeIq1N/VAQZhMnZNE=; b=FrDNwlZZybS8P1emhNZ0B2dZ+B0WXxvckpKmz31naqTNr1KyBbjk0eE23t8XU9aaWtdwPB CVPI7TWtMCZuDVIS9yIti/9W8onrjsH9qixj8RIqix3qEntUpfDBAOmcpusVI2SpuxxAAL +ptYfK9matYfYUQnIQsbMiEztDRIySs= X-MC-Unique: HAIu5jTfNNeKbuMEEzIO2Q-1 From: Albert Esteve To: qemu-devel@nongnu.org Cc: "Michael S. Tsirkin" , stefanha@gmail.com, alex.bennee@linaro.org, philmd@linaro.org, kraxel@redhat.com, marcandre.lureau@gmail.com, Albert Esteve Subject: [PATCH v4 2/5] hw/virtio: document SharedObject structures Date: Mon, 19 Feb 2024 15:34:20 +0100 Message-ID: <20240219143423.272012-3-aesteve@redhat.com> In-Reply-To: <20240219143423.272012-1-aesteve@redhat.com> References: <20240219143423.272012-1-aesteve@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.4 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=170.10.129.124; envelope-from=aesteve@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.072, 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.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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1708353303706100006 Content-Type: text/plain; charset="utf-8" Change VirtioSharedObject value type from a generic pointer to a union storing the different supported underlying types, which makes naming less confusing. With the update, use the chance to add kdoc to both the SharedObjectType enum and VirtioSharedObject struct. Signed-off-by: Albert Esteve --- hw/display/virtio-dmabuf.c | 8 ++++---- include/hw/virtio/virtio-dmabuf.h | 25 ++++++++++++++++++++++++- 2 files changed, 28 insertions(+), 5 deletions(-) diff --git a/hw/display/virtio-dmabuf.c b/hw/display/virtio-dmabuf.c index 3dba4577ca..497cb6fa7c 100644 --- a/hw/display/virtio-dmabuf.c +++ b/hw/display/virtio-dmabuf.c @@ -57,7 +57,7 @@ bool virtio_add_dmabuf(QemuUUID *uuid, int udmabuf_fd) } vso =3D g_new(VirtioSharedObject, 1); vso->type =3D TYPE_DMABUF; - vso->value =3D GINT_TO_POINTER(udmabuf_fd); + vso->value.udma_buf =3D udmabuf_fd; result =3D virtio_add_resource(uuid, vso); if (!result) { g_free(vso); @@ -75,7 +75,7 @@ bool virtio_add_vhost_device(QemuUUID *uuid, struct vhost= _dev *dev) } vso =3D g_new(VirtioSharedObject, 1); vso->type =3D TYPE_VHOST_DEV; - vso->value =3D dev; + vso->value.dev =3D dev; result =3D virtio_add_resource(uuid, vso); if (!result) { g_free(vso); @@ -114,7 +114,7 @@ int virtio_lookup_dmabuf(const QemuUUID *uuid) return -1; } assert(vso->type =3D=3D TYPE_DMABUF); - return GPOINTER_TO_INT(vso->value); + return vso->value.udma_buf; } =20 struct vhost_dev *virtio_lookup_vhost_device(const QemuUUID *uuid) @@ -124,7 +124,7 @@ struct vhost_dev *virtio_lookup_vhost_device(const Qemu= UUID *uuid) return NULL; } assert(vso->type =3D=3D TYPE_VHOST_DEV); - return (struct vhost_dev *) vso->value; + return (struct vhost_dev *) vso->value.dev; } =20 SharedObjectType virtio_object_type(const QemuUUID *uuid) diff --git a/include/hw/virtio/virtio-dmabuf.h b/include/hw/virtio/virtio-d= mabuf.h index 627c3b6db7..891a43162d 100644 --- a/include/hw/virtio/virtio-dmabuf.h +++ b/include/hw/virtio/virtio-dmabuf.h @@ -16,15 +16,38 @@ #include "qemu/uuid.h" #include "vhost.h" =20 +/** + * SharedObjectType: + *=20 + * Identifies the type of the underlying type that the current lookup + * table entry is holding. + *=20 + * TYPE_INVALID: Invalid entry + * TYPE_DMABUF: Entry is a dmabuf file descriptor that can be directly + * shared with the requestor + * TYPE_VHOST_DEV: Entry is a pointer to a vhost device that is holding + * the shared object. + */ typedef enum SharedObjectType { TYPE_INVALID =3D 0, TYPE_DMABUF, TYPE_VHOST_DEV, } SharedObjectType; =20 +/** + * VirtioSharedObject: + * @type: Shared object type identifier + * @value: Union containing to the underlying type + *=20 + * The VirtioSharedObject object provides a way to distinguish, + * store, and handle the different types supported by the lookup table. + */ typedef struct VirtioSharedObject { SharedObjectType type; - gpointer value; + union { + struct vhost_dev *dev; /* TYPE_VHOST_DEV */ + int udma_buf; /* TYPE_DMABUF */ + } value; } VirtioSharedObject; =20 /** --=20 2.43.1