From nobody Wed Nov 27 00:36:41 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=1701961025; cv=none; d=zohomail.com; s=zohoarc; b=gAVQWQOBiqup0AcuBL3OnCDf8XBxDM6a3BmMKbpbcRP8Yl5EAyHD0ApH+TGZGahTNqIe9y7S3NdXnUyZ7jBd5txqy3XnMCg/UM0no2T6Ns90FwodZZkf1EZgPaUGlEmDSNOZ56KU6Ku3SQeHzOOQMsQwtCnN+T3Y241Xb7ln1G8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1701961025; 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=USj2+qT/n6WeZx783xFOJ1a/OTnmQweQXultk8j1NQg=; b=neXtlVaBzfMRst9s0krQplnGP4Vk9k87iRMMU3KgstpDvUcVFHSJSY43wFgz7nrlwmuTv0BN/CL9Uf4l/civK1DcWgXnprmLVDOcvEpdiN2577B/ZIeqyuwn7ZT71l4956dNc+8QAFLy/wyiP23CXcsGHSWyUa0Ddn0Kz4N/Ero= 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 1701961025240217.7608566218388; Thu, 7 Dec 2023 06:57:05 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rBFnD-0000QE-Uh; Thu, 07 Dec 2023 09:56:00 -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 1rBFnB-0000Q2-F3 for qemu-devel@nongnu.org; Thu, 07 Dec 2023 09:55:57 -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 1rBFn8-0003py-1z for qemu-devel@nongnu.org; Thu, 07 Dec 2023 09:55:57 -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-237-pceHpKMSPZ6fz2At2ANHrA-1; Thu, 07 Dec 2023 09:55:50 -0500 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (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 EF4EF85A58B; Thu, 7 Dec 2023 14:55:49 +0000 (UTC) Received: from fedora.redhat.com (unknown [10.45.224.225]) by smtp.corp.redhat.com (Postfix) with ESMTP id 68B3C492BC6; Thu, 7 Dec 2023 14:55:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1701960951; 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=USj2+qT/n6WeZx783xFOJ1a/OTnmQweQXultk8j1NQg=; b=MI3G3ppLlxmiUXB/SygGGYoq9X+E3LxMdRbo724hETMdxytZD6spY8JL5F43u3kev0o/6t PdkSHDw02BTWPSEzKVbvKE5ls1hFrJ6x29zkwv/u67IO6B79e3QRPxa6jEo05ZKz0Od7qG 9EQpc0PZc88Z13zpHFli7upVIxWLg0c= X-MC-Unique: pceHpKMSPZ6fz2At2ANHrA-1 From: Albert Esteve To: qemu-devel@nongnu.org Cc: marcandre.lureau@gmail.com, kraxel@redhat.com, "Michael S. Tsirkin" , stefanha@gmail.com, Albert Esteve Subject: [PATCH v2 1/3] hw/virtio: check owner for removing objects Date: Thu, 7 Dec 2023 15:55:43 +0100 Message-ID: <20231207145545.783877-2-aesteve@redhat.com> In-Reply-To: <20231207145545.783877-1-aesteve@redhat.com> References: <20231207145545.783877-1-aesteve@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.9 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: -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, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=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: 1701961025668100001 Content-Type: text/plain; charset="utf-8" Shared objects lack spoofing protection. For VHOST_USER_BACKEND_SHARED_OBJECT_REMOVE messages received by the vhost-user interface, any backend was allowed to remove entries from the shared table just by knowing the UUID. Only the owner of the entry shall be allowed to removed their resources from the table. To fix that, add a check for all *SHARED_OBJECT_REMOVE messages received. A vhost device can only remove TYPE_VHOST_DEV entries that are owned by them, otherwise skip the removal, and inform the device that the entry has not been removed in the answer. Signed-off-by: Albert Esteve Acked-by: Stefan Hajnoczi --- hw/virtio/vhost-user.c | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/hw/virtio/vhost-user.c b/hw/virtio/vhost-user.c index f214df804b..1c3f2357be 100644 --- a/hw/virtio/vhost-user.c +++ b/hw/virtio/vhost-user.c @@ -1611,11 +1611,27 @@ vhost_user_backend_handle_shared_object_add(struct = vhost_dev *dev, } =20 static int -vhost_user_backend_handle_shared_object_remove(VhostUserShared *object) +vhost_user_backend_handle_shared_object_remove(struct vhost_dev *dev, + VhostUserShared *object) { QemuUUID uuid; =20 memcpy(uuid.data, object->uuid, sizeof(object->uuid)); + switch (virtio_object_type(&uuid)) { + case TYPE_VHOST_DEV: + { + struct vhost_dev *owner =3D virtio_lookup_vhost_device(&uuid); + if (owner =3D=3D NULL || dev !=3D owner) { + /* Not allowed to remove non-owned entries */ + return 0; + } + break; + } + default: + /* Not allowed to remove non-owned entries */ + return 0; + } + return virtio_remove_resource(&uuid); } =20 @@ -1794,7 +1810,8 @@ static gboolean backend_read(QIOChannel *ioc, GIOCond= ition condition, ret =3D vhost_user_backend_handle_shared_object_add(dev, &payload.= object); break; case VHOST_USER_BACKEND_SHARED_OBJECT_REMOVE: - ret =3D vhost_user_backend_handle_shared_object_remove(&payload.ob= ject); + ret =3D vhost_user_backend_handle_shared_object_remove(dev, + &payload.obje= ct); break; case VHOST_USER_BACKEND_SHARED_OBJECT_LOOKUP: ret =3D vhost_user_backend_handle_shared_object_lookup(dev->opaque= , ioc, --=20 2.43.0 From nobody Wed Nov 27 00:36:41 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=1701961014; cv=none; d=zohomail.com; s=zohoarc; b=OULDifMuAk82Mjs9KYJ3ueTJgyu1JmSyZMXXXM5cqdORiYQMp1h677iDU2fS3/q7BDkIBRxqPOqDsgOPE23K2Zw7/qCfiphBGvae1n8ENyS0XV5ciHc0yUvWEoGnyhKR3Kece/nXNbOu1F7Xf4zFP/uzd8jySEghxdhUmX60qrM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1701961014; 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=KhOQAePB0BA6U/nirwPICwhYqwf/8rINFazTdgTaKws=; b=Z2bvwHiDKLC1yC7R/psbT4ZcQ1VLyd01IR8hkktNITV1WpHVPwGmZrItCQg+zCDVtaU6hGCww5SOoRvHbLW6ZgIdX9E70Fmlj11zCLn+1A2mnJCB1oFEgMaqWuM+th+/SpQFMk9cAgA3ethcM77q5yg62emtZGDHwJi9xEfS0OM= 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 1701961014477301.87805291325697; Thu, 7 Dec 2023 06:56:54 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rBFnE-0000R3-Ss; Thu, 07 Dec 2023 09:56:00 -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 1rBFnD-0000Qe-Rs for qemu-devel@nongnu.org; Thu, 07 Dec 2023 09:55:59 -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 1rBFnB-0003rG-1F for qemu-devel@nongnu.org; Thu, 07 Dec 2023 09:55:58 -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-517-rxsT-JgbNcidfypEgzw1Zw-1; Thu, 07 Dec 2023 09:55:52 -0500 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (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 C7240185A7A6; Thu, 7 Dec 2023 14:55:51 +0000 (UTC) Received: from fedora.redhat.com (unknown [10.45.224.225]) by smtp.corp.redhat.com (Postfix) with ESMTP id 5B410492BC6; Thu, 7 Dec 2023 14:55:50 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1701960955; 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=KhOQAePB0BA6U/nirwPICwhYqwf/8rINFazTdgTaKws=; b=LFXPobafquCA6nasoooF8yXnuZbcwW5ZZwzObw0ePRo9TkjSgKLoHJw2VB6UIs/aSFLcs4 G8nPEuf3djzWTjbK/cs/IzHdqV56kpFT3/T9bMS94tl3nofRQwTtL41NIb/vD9Yj0StRPX SUKf9LU9iATY2CorWG9Up7R/YkbUkYM= X-MC-Unique: rxsT-JgbNcidfypEgzw1Zw-1 From: Albert Esteve To: qemu-devel@nongnu.org Cc: marcandre.lureau@gmail.com, kraxel@redhat.com, "Michael S. Tsirkin" , stefanha@gmail.com, Albert Esteve Subject: [PATCH v2 2/3] hw/virtio: cleanup shared resources Date: Thu, 7 Dec 2023 15:55:44 +0100 Message-ID: <20231207145545.783877-3-aesteve@redhat.com> In-Reply-To: <20231207145545.783877-1-aesteve@redhat.com> References: <20231207145545.783877-1-aesteve@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.9 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: -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, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=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: 1701961015462100008 Content-Type: text/plain; charset="utf-8" Ensure that we cleanup all virtio shared resources when the vhost devices is cleaned up (after a hot unplug, or a crash). To do so, we add a new function to the virtio_dmabuf API called `virtio_dmabuf_vhost_cleanup`, which loop through the table and removes all resources owned by the vhost device parameter. Also, add a test to verify that the new function in the API behaves as expected. Signed-off-by: Albert Esteve Acked-by: Stefan Hajnoczi --- hw/display/virtio-dmabuf.c | 22 +++++++++++++++++++++ hw/virtio/vhost.c | 3 +++ include/hw/virtio/virtio-dmabuf.h | 10 ++++++++++ tests/unit/test-virtio-dmabuf.c | 33 +++++++++++++++++++++++++++++++ 4 files changed, 68 insertions(+) diff --git a/hw/display/virtio-dmabuf.c b/hw/display/virtio-dmabuf.c index 3dba4577ca..6688809777 100644 --- a/hw/display/virtio-dmabuf.c +++ b/hw/display/virtio-dmabuf.c @@ -136,6 +136,28 @@ SharedObjectType virtio_object_type(const QemuUUID *uu= id) return vso->type; } =20 +static bool virtio_dmabuf_resource_is_owned(gpointer key, + gpointer value, + gpointer dev) +{ + VirtioSharedObject *vso; + + vso =3D (VirtioSharedObject *) value; + return vso->type =3D=3D TYPE_VHOST_DEV && vso->value =3D=3D dev; +} + +int virtio_dmabuf_vhost_cleanup(struct vhost_dev *dev) +{ + int num_removed; + + g_mutex_lock(&lock); + num_removed =3D g_hash_table_foreach_remove( + resource_uuids, (GHRFunc) virtio_dmabuf_resource_is_owned, dev); + g_mutex_unlock(&lock); + + return num_removed; +} + void virtio_free_resources(void) { g_mutex_lock(&lock); diff --git a/hw/virtio/vhost.c b/hw/virtio/vhost.c index 2c9ac79468..c5622eac14 100644 --- a/hw/virtio/vhost.c +++ b/hw/virtio/vhost.c @@ -16,6 +16,7 @@ #include "qemu/osdep.h" #include "qapi/error.h" #include "hw/virtio/vhost.h" +#include "hw/virtio/virtio-dmabuf.h" #include "qemu/atomic.h" #include "qemu/range.h" #include "qemu/error-report.h" @@ -1599,6 +1600,8 @@ void vhost_dev_cleanup(struct vhost_dev *hdev) migrate_del_blocker(&hdev->migration_blocker); g_free(hdev->mem); g_free(hdev->mem_sections); + /* free virtio shared objects */ + virtio_dmabuf_vhost_cleanup(hdev); if (hdev->vhost_ops) { hdev->vhost_ops->vhost_backend_cleanup(hdev); } diff --git a/include/hw/virtio/virtio-dmabuf.h b/include/hw/virtio/virtio-d= mabuf.h index 627c3b6db7..73f70fb482 100644 --- a/include/hw/virtio/virtio-dmabuf.h +++ b/include/hw/virtio/virtio-dmabuf.h @@ -91,6 +91,16 @@ struct vhost_dev *virtio_lookup_vhost_device(const QemuU= UID *uuid); */ SharedObjectType virtio_object_type(const QemuUUID *uuid); =20 +/** + * virtio_dmabuf_vhost_cleanup() - Destroys all entries of the shared + * resources lookup table that are owned by the vhost backend + * @dev: the pointer to the vhost device that owns the entries. Data is ow= ned + * by the called of the function. + *=20 + * Return: the number of resource entries removed. + */ +int virtio_dmabuf_vhost_cleanup(struct vhost_dev *dev); + /** * virtio_free_resources() - Destroys all keys and values of the shared * resources lookup table, and frees them diff --git a/tests/unit/test-virtio-dmabuf.c b/tests/unit/test-virtio-dmabu= f.c index a45ec52f42..1c8123c2d2 100644 --- a/tests/unit/test-virtio-dmabuf.c +++ b/tests/unit/test-virtio-dmabuf.c @@ -103,6 +103,38 @@ static void test_add_invalid_resource(void) } } =20 +static void test_cleanup_res(void) +{ + QemuUUID uuids[20], uuid_alt; + struct vhost_dev *dev =3D g_new0(struct vhost_dev, 1); + struct vhost_dev *dev_alt =3D g_new0(struct vhost_dev, 1); + int i, num_removed; + + for (i =3D 0; i < ARRAY_SIZE(uuids); ++i) { + qemu_uuid_generate(&uuids[i]); + virtio_add_vhost_device(&uuids[i], dev); + /* vhost device is found */ + g_assert(virtio_lookup_vhost_device(&uuids[i]) !=3D NULL); + } + qemu_uuid_generate(&uuid_alt); + virtio_add_vhost_device(&uuid_alt, dev_alt); + /* vhost device is found */ + g_assert(virtio_lookup_vhost_device(&uuid_alt) !=3D NULL); + /* cleanup all dev resources */ + num_removed =3D virtio_dmabuf_vhost_cleanup(dev); + g_assert_cmpint(num_removed, =3D=3D, ARRAY_SIZE(uuids)); + for (i =3D 0; i < ARRAY_SIZE(uuids); ++i) { + /* None of the dev resources is found after free'd */ + g_assert_cmpint(virtio_lookup_dmabuf(&uuids[i]), =3D=3D, -1); + } + /* uuid_alt is still in the hash table */ + g_assert(virtio_lookup_vhost_device(&uuid_alt) !=3D NULL); + + virtio_free_resources(); + g_free(dev); + g_free(dev_alt); +} + static void test_free_resources(void) { QemuUUID uuids[20]; @@ -131,6 +163,7 @@ int main(int argc, char **argv) test_remove_invalid_resource); g_test_add_func("/virtio-dmabuf/add_invalid_res", test_add_invalid_resource); + g_test_add_func("/virtio-dmabuf/cleanup_dev", test_cleanup_res); g_test_add_func("/virtio-dmabuf/free_res", test_free_resources); =20 return g_test_run(); --=20 2.43.0 From nobody Wed Nov 27 00:36:41 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=1701961014; cv=none; d=zohomail.com; s=zohoarc; b=eMMnWh3vrYbKhwxHgL52yQ2E9xMOc2w20ck2tyjFbFTPLvMruI3dhTP0I7+B2hZYOGXhq4WELGJO9C7cTgT3GP/kFbaLTs/9WJe094uL61NlOfxTpiUDk4ZPc41l2YPbLhql45OWeDLbEhx7LYMRLO7FY94f6QqpY/pSkWCAdmU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1701961014; 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=QBRx27/qQ/Roe1g7sLnDhSTKHcE1DGB5YASgOjq2noY=; b=AjPRIkFkHXbDT3zIpPjR4qvf3xCu/hkvPlDk3ctNf2gOVWyj/ZBCRw3Req5xzCwVJab6mKCfpcgeKlgxTosxVHfcJG0Yp3Y6lXDJn2ut5LnHiIoRaF/7JykHbP2r27kyDUt3L5MgHgaXSItZv0BHw9chFgoekPyy8g5ZF1igaFI= 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 1701961014546696.3671532843948; Thu, 7 Dec 2023 06:56:54 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rBFnK-0000S4-66; Thu, 07 Dec 2023 09:56: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 1rBFnI-0000Rg-Q9 for qemu-devel@nongnu.org; Thu, 07 Dec 2023 09:56:04 -0500 Received: from us-smtp-delivery-124.mimecast.com ([216.145.221.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rBFnF-0003ru-0Z for qemu-devel@nongnu.org; Thu, 07 Dec 2023 09:56:04 -0500 Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-2-c-ApOOhNMweT7RbZGEUGQg-1; Thu, 07 Dec 2023 09:55:54 -0500 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (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 C85D51C0CCC7; Thu, 7 Dec 2023 14:55:53 +0000 (UTC) Received: from fedora.redhat.com (unknown [10.45.224.225]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3541B492BC6; Thu, 7 Dec 2023 14:55:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1701960959; 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=QBRx27/qQ/Roe1g7sLnDhSTKHcE1DGB5YASgOjq2noY=; b=HKbKx45fu1sQ7goVwDy1chtsPwRHvHCyZFr54Hu2UP+5fAQZUCUEN7+CneaQi4omTJM4k2 GdVgXenLerBfq3JtSL3JYtfI/vCBofFoU6jA2RBl4MLqVr86y9aVjq4MVdOThaaQ0K1m23 69g/zWvynJj6dFyGUK31QoeNwBY5mGw= X-MC-Unique: c-ApOOhNMweT7RbZGEUGQg-1 From: Albert Esteve To: qemu-devel@nongnu.org Cc: marcandre.lureau@gmail.com, kraxel@redhat.com, "Michael S. Tsirkin" , stefanha@gmail.com, Albert Esteve Subject: [PATCH v2 3/3] hw/virtio: rename virtio dmabuf API Date: Thu, 7 Dec 2023 15:55:45 +0100 Message-ID: <20231207145545.783877-4-aesteve@redhat.com> In-Reply-To: <20231207145545.783877-1-aesteve@redhat.com> References: <20231207145545.783877-1-aesteve@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.9 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=216.145.221.124; envelope-from=aesteve@redhat.com; helo=us-smtp-delivery-124.mimecast.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, 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: 1701961015592100011 Content-Type: text/plain; charset="utf-8" Functions in the virtio-dmabuf module start with 'virtio_*', which is too generic and may not correctly identify them as part of the virtio dmabuf API. Rename all functions to 'virtio_dmabuf_*' instead to avoid confusion. Signed-off-by: Albert Esteve Acked-by: Stefan Hajnoczi --- hw/display/virtio-dmabuf.c | 14 +++++----- hw/virtio/vhost-user.c | 14 +++++----- include/hw/virtio/virtio-dmabuf.h | 33 ++++++++++++----------- tests/unit/test-virtio-dmabuf.c | 44 +++++++++++++++---------------- 4 files changed, 53 insertions(+), 52 deletions(-) diff --git a/hw/display/virtio-dmabuf.c b/hw/display/virtio-dmabuf.c index 6688809777..42495f87ec 100644 --- a/hw/display/virtio-dmabuf.c +++ b/hw/display/virtio-dmabuf.c @@ -48,7 +48,7 @@ static bool virtio_add_resource(QemuUUID *uuid, VirtioSha= redObject *value) return result; } =20 -bool virtio_add_dmabuf(QemuUUID *uuid, int udmabuf_fd) +bool virtio_dmabuf_add(QemuUUID *uuid, int udmabuf_fd) { bool result; VirtioSharedObject *vso; @@ -66,7 +66,7 @@ bool virtio_add_dmabuf(QemuUUID *uuid, int udmabuf_fd) return result; } =20 -bool virtio_add_vhost_device(QemuUUID *uuid, struct vhost_dev *dev) +bool virtio_dmabuf_add_vhost_device(QemuUUID *uuid, struct vhost_dev *dev) { bool result; VirtioSharedObject *vso; @@ -84,7 +84,7 @@ bool virtio_add_vhost_device(QemuUUID *uuid, struct vhost= _dev *dev) return result; } =20 -bool virtio_remove_resource(const QemuUUID *uuid) +bool virtio_dmabuf_remove_resource(const QemuUUID *uuid) { bool result; g_mutex_lock(&lock); @@ -107,7 +107,7 @@ static VirtioSharedObject *get_shared_object(const Qemu= UUID *uuid) return (VirtioSharedObject *) lookup_res; } =20 -int virtio_lookup_dmabuf(const QemuUUID *uuid) +int virtio_dmabuf_lookup(const QemuUUID *uuid) { VirtioSharedObject *vso =3D get_shared_object(uuid); if (vso =3D=3D NULL) { @@ -117,7 +117,7 @@ int virtio_lookup_dmabuf(const QemuUUID *uuid) return GPOINTER_TO_INT(vso->value); } =20 -struct vhost_dev *virtio_lookup_vhost_device(const QemuUUID *uuid) +struct vhost_dev *virtio_dmabuf_lookup_vhost_device(const QemuUUID *uuid) { VirtioSharedObject *vso =3D get_shared_object(uuid); if (vso =3D=3D NULL) { @@ -127,7 +127,7 @@ struct vhost_dev *virtio_lookup_vhost_device(const Qemu= UUID *uuid) return (struct vhost_dev *) vso->value; } =20 -SharedObjectType virtio_object_type(const QemuUUID *uuid) +SharedObjectType virtio_dmabuf_object_type(const QemuUUID *uuid) { VirtioSharedObject *vso =3D get_shared_object(uuid); if (vso =3D=3D NULL) { @@ -158,7 +158,7 @@ int virtio_dmabuf_vhost_cleanup(struct vhost_dev *dev) return num_removed; } =20 -void virtio_free_resources(void) +void virtio_dmabuf_free_resources(void) { g_mutex_lock(&lock); g_hash_table_destroy(resource_uuids); diff --git a/hw/virtio/vhost-user.c b/hw/virtio/vhost-user.c index 1c3f2357be..2ab9e13f9e 100644 --- a/hw/virtio/vhost-user.c +++ b/hw/virtio/vhost-user.c @@ -1607,7 +1607,7 @@ vhost_user_backend_handle_shared_object_add(struct vh= ost_dev *dev, QemuUUID uuid; =20 memcpy(uuid.data, object->uuid, sizeof(object->uuid)); - return virtio_add_vhost_device(&uuid, dev); + return virtio_dmabuf_add_vhost_device(&uuid, dev); } =20 static int @@ -1617,10 +1617,10 @@ vhost_user_backend_handle_shared_object_remove(stru= ct vhost_dev *dev, QemuUUID uuid; =20 memcpy(uuid.data, object->uuid, sizeof(object->uuid)); - switch (virtio_object_type(&uuid)) { + switch (virtio_dmabuf_object_type(&uuid)) { case TYPE_VHOST_DEV: { - struct vhost_dev *owner =3D virtio_lookup_vhost_device(&uuid); + struct vhost_dev *owner =3D virtio_dmabuf_lookup_vhost_device(&uui= d); if (owner =3D=3D NULL || dev !=3D owner) { /* Not allowed to remove non-owned entries */ return 0; @@ -1632,7 +1632,7 @@ vhost_user_backend_handle_shared_object_remove(struct= vhost_dev *dev, return 0; } =20 - return virtio_remove_resource(&uuid); + return virtio_dmabuf_remove_resource(&uuid); } =20 static bool vhost_user_send_resp(QIOChannel *ioc, VhostUserHeader *hdr, @@ -1710,13 +1710,13 @@ vhost_user_backend_handle_shared_object_lookup(stru= ct vhost_user *u, memcpy(uuid.data, payload->object.uuid, sizeof(payload->object.uuid)); =20 payload->u64 =3D 0; - switch (virtio_object_type(&uuid)) { + switch (virtio_dmabuf_object_type(&uuid)) { case TYPE_DMABUF: - dmabuf_fd =3D virtio_lookup_dmabuf(&uuid); + dmabuf_fd =3D virtio_dmabuf_lookup(&uuid); break; case TYPE_VHOST_DEV: { - struct vhost_dev *dev =3D virtio_lookup_vhost_device(&uuid); + struct vhost_dev *dev =3D virtio_dmabuf_lookup_vhost_device(&uuid); if (dev =3D=3D NULL) { payload->u64 =3D -EINVAL; break; diff --git a/include/hw/virtio/virtio-dmabuf.h b/include/hw/virtio/virtio-d= mabuf.h index 73f70fb482..186a18a33b 100644 --- a/include/hw/virtio/virtio-dmabuf.h +++ b/include/hw/virtio/virtio-dmabuf.h @@ -28,7 +28,7 @@ typedef struct VirtioSharedObject { } VirtioSharedObject; =20 /** - * virtio_add_dmabuf() - Add a new dma-buf resource to the lookup table + * virtio_dmabuf_add() - Add a new dma-buf resource to the lookup table * @uuid: new resource's UUID * @dmabuf_fd: the dma-buf descriptor that will be stored and shared with * other virtio devices. The caller retains ownership over the @@ -41,11 +41,11 @@ typedef struct VirtioSharedObject { * Note that if it finds a repeated UUID, the resource is not inserted in * the lookup table. */ -bool virtio_add_dmabuf(QemuUUID *uuid, int dmabuf_fd); +bool virtio_dmabuf_add(QemuUUID *uuid, int dmabuf_fd); =20 /** - * virtio_add_vhost_device() - Add a new exporter vhost device that holds = the - * resource with the associated UUID + * virtio_dmabuf_add_vhost_device() - Add a new exporter vhost device that + * holds the resource with the associated UUID * @uuid: new resource's UUID * @dev: the pointer to the vhost device that holds the resource. The call= er * retains ownership over the device struct and its lifecycle. @@ -55,41 +55,42 @@ bool virtio_add_dmabuf(QemuUUID *uuid, int dmabuf_fd); * Note that if it finds a repeated UUID, the resource is not inserted in * the lookup table. */ -bool virtio_add_vhost_device(QemuUUID *uuid, struct vhost_dev *dev); +bool virtio_dmabuf_add_vhost_device(QemuUUID *uuid, struct vhost_dev *dev); =20 /** - * virtio_remove_resource() - Removes a resource from the lookup table + * virtio_dmabuf_remove_resource() - Removes a resource from the lookup ta= ble * @uuid: resource's UUID * * Return: true if the UUID has been found and removed from the lookup tab= le. */ -bool virtio_remove_resource(const QemuUUID *uuid); +bool virtio_dmabuf_remove_resource(const QemuUUID *uuid); =20 /** - * virtio_lookup_dmabuf() - Looks for a dma-buf resource in the lookup tab= le + * virtio_dmabuf_lookup() - Looks for a dma-buf resource in the lookup tab= le * @uuid: resource's UUID * * Return: the dma-buf file descriptor integer, or -1 if the key is not fo= und. */ -int virtio_lookup_dmabuf(const QemuUUID *uuid); +int virtio_dmabuf_lookup(const QemuUUID *uuid); =20 /** - * virtio_lookup_vhost_device() - Looks for an exporter vhost device in the - * lookup table + * virtio_dmabuf_lookup_vhost_device() - Looks for an exporter vhost device + * in the lookup table * @uuid: resource's UUID * * Return: pointer to the vhost_dev struct, or NULL if the key is not foun= d. */ -struct vhost_dev *virtio_lookup_vhost_device(const QemuUUID *uuid); +struct vhost_dev *virtio_dmabuf_lookup_vhost_device(const QemuUUID *uuid); =20 /** - * virtio_object_type() - Looks for the type of resource in the lookup tab= le + * virtio_dmabuf_object_type() - Looks for the type of resource in the + * lookup table * @uuid: resource's UUID * * Return: the type of resource associated with the UUID, or TYPE_INVALID = if * the key is not found. */ -SharedObjectType virtio_object_type(const QemuUUID *uuid); +SharedObjectType virtio_dmabuf_object_type(const QemuUUID *uuid); =20 /** * virtio_dmabuf_vhost_cleanup() - Destroys all entries of the shared @@ -102,9 +103,9 @@ SharedObjectType virtio_object_type(const QemuUUID *uui= d); int virtio_dmabuf_vhost_cleanup(struct vhost_dev *dev); =20 /** - * virtio_free_resources() - Destroys all keys and values of the shared + * virtio_dmabuf_free_resources() - Destroys all keys and values of the sh= ared * resources lookup table, and frees them */ -void virtio_free_resources(void); +void virtio_dmabuf_free_resources(void); =20 #endif /* VIRTIO_DMABUF_H */ diff --git a/tests/unit/test-virtio-dmabuf.c b/tests/unit/test-virtio-dmabu= f.c index 1c8123c2d2..7471ed4fbd 100644 --- a/tests/unit/test-virtio-dmabuf.c +++ b/tests/unit/test-virtio-dmabuf.c @@ -31,12 +31,12 @@ static void test_add_remove_resources(void) qemu_uuid_generate(&uuid); dmabuf_fd =3D g_random_int_range(3, 500); /* Add a new resource */ - g_assert(virtio_add_dmabuf(&uuid, dmabuf_fd)); - g_assert_cmpint(virtio_lookup_dmabuf(&uuid), =3D=3D, dmabuf_fd); + g_assert(virtio_dmabuf_add(&uuid, dmabuf_fd)); + g_assert_cmpint(virtio_dmabuf_lookup(&uuid), =3D=3D, dmabuf_fd); /* Remove the resource */ - g_assert(virtio_remove_resource(&uuid)); + g_assert(virtio_dmabuf_remove_resource(&uuid)); /* Resource is not found anymore */ - g_assert_cmpint(virtio_lookup_dmabuf(&uuid), =3D=3D, -1); + g_assert_cmpint(virtio_dmabuf_lookup(&uuid), =3D=3D, -1); } } =20 @@ -48,13 +48,13 @@ static void test_add_remove_dev(void) =20 for (i =3D 0; i < 100; ++i) { qemu_uuid_generate(&uuid); - virtio_add_vhost_device(&uuid, dev); + virtio_dmabuf_add_vhost_device(&uuid, dev); /* vhost device is found */ - g_assert(virtio_lookup_vhost_device(&uuid) !=3D NULL); + g_assert(virtio_dmabuf_lookup_vhost_device(&uuid) !=3D NULL); /* Remove the vhost device */ - g_assert(virtio_remove_resource(&uuid)); + g_assert(virtio_dmabuf_remove_resource(&uuid)); /* vhost device is not found anymore */ - g_assert(virtio_lookup_vhost_device(&uuid) =3D=3D NULL); + g_assert(virtio_dmabuf_lookup_vhost_device(&uuid) =3D=3D NULL); } g_free(dev); } @@ -66,9 +66,9 @@ static void test_remove_invalid_resource(void) =20 for (i =3D 0; i < 20; ++i) { qemu_uuid_generate(&uuid); - g_assert_cmpint(virtio_lookup_dmabuf(&uuid), =3D=3D, -1); + g_assert_cmpint(virtio_dmabuf_lookup(&uuid), =3D=3D, -1); /* Removing a resource that does not exist returns false */ - g_assert_false(virtio_remove_resource(&uuid)); + g_assert_false(virtio_dmabuf_remove_resource(&uuid)); } } =20 @@ -81,25 +81,25 @@ static void test_add_invalid_resource(void) for (i =3D 0; i < 20; ++i) { qemu_uuid_generate(&uuid); /* Add a new resource with invalid (negative) resource fd */ - g_assert_false(virtio_add_dmabuf(&uuid, dmabuf_fd)); + g_assert_false(virtio_dmabuf_add(&uuid, dmabuf_fd)); /* Resource is not found */ - g_assert_cmpint(virtio_lookup_dmabuf(&uuid), =3D=3D, -1); + g_assert_cmpint(virtio_dmabuf_lookup(&uuid), =3D=3D, -1); /* Add a new vhost device with invalid (NULL) pointer */ - g_assert_false(virtio_add_vhost_device(&uuid, dev)); + g_assert_false(virtio_dmabuf_add_vhost_device(&uuid, dev)); /* vhost device is not found */ - g_assert(virtio_lookup_vhost_device(&uuid) =3D=3D NULL); + g_assert(virtio_dmabuf_lookup_vhost_device(&uuid) =3D=3D NULL); } =20 for (i =3D 0; i < 20; ++i) { /* Add a valid resource */ qemu_uuid_generate(&uuid); dmabuf_fd =3D g_random_int_range(3, 500); - g_assert(virtio_add_dmabuf(&uuid, dmabuf_fd)); - g_assert_cmpint(virtio_lookup_dmabuf(&uuid), =3D=3D, dmabuf_fd); + g_assert(virtio_dmabuf_add(&uuid, dmabuf_fd)); + g_assert_cmpint(virtio_dmabuf_lookup(&uuid), =3D=3D, dmabuf_fd); /* Add a new resource with repeated uuid returns false */ - g_assert_false(virtio_add_dmabuf(&uuid, alt_dmabuf)); + g_assert_false(virtio_dmabuf_add(&uuid, alt_dmabuf)); /* The value for the uuid key is not replaced */ - g_assert_cmpint(virtio_lookup_dmabuf(&uuid), =3D=3D, dmabuf_fd); + g_assert_cmpint(virtio_dmabuf_lookup(&uuid), =3D=3D, dmabuf_fd); } } =20 @@ -143,13 +143,13 @@ static void test_free_resources(void) for (i =3D 0; i < ARRAY_SIZE(uuids); ++i) { qemu_uuid_generate(&uuids[i]); dmabuf_fd =3D g_random_int_range(3, 500); - g_assert(virtio_add_dmabuf(&uuids[i], dmabuf_fd)); - g_assert_cmpint(virtio_lookup_dmabuf(&uuids[i]), =3D=3D, dmabuf_fd= ); + g_assert(virtio_dmabuf_add(&uuids[i], dmabuf_fd)); + g_assert_cmpint(virtio_dmabuf_lookup(&uuids[i]), =3D=3D, dmabuf_fd= ); } - virtio_free_resources(); + virtio_dmabuf_free_resources(); for (i =3D 0; i < ARRAY_SIZE(uuids); ++i) { /* None of the resources is found after free'd */ - g_assert_cmpint(virtio_lookup_dmabuf(&uuids[i]), =3D=3D, -1); + g_assert_cmpint(virtio_dmabuf_lookup(&uuids[i]), =3D=3D, -1); } =20 } --=20 2.43.0