qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Zhao Liu <zhao1.liu@linux.intel.com>
To: "Thomas Huth" <thuth@redhat.com>,
	"Markus Armbruster" <armbru@redhat.com>,
	"Michael Roth" <michael.roth@amd.com>,
	"Michael Tokarev" <mjt@tls.msk.ru>,
	"Philippe Mathieu-Daudé" <philmd@linaro.org>,
	qemu-devel@nongnu.org
Cc: qemu-trivial@nongnu.org, "Zhao Liu" <zhao1.liu@intel.com>,
	"Alex Williamson" <alex.williamson@redhat.com>,
	"Cédric Le Goater" <clg@redhat.com>
Subject: [PATCH v2 20/29] hw/vfio/helpers: Fix missing ERRP_GUARD() for error_prepend()
Date: Mon, 11 Mar 2024 11:38:13 +0800	[thread overview]
Message-ID: <20240311033822.3142585-21-zhao1.liu@linux.intel.com> (raw)
In-Reply-To: <20240311033822.3142585-1-zhao1.liu@linux.intel.com>

From: Zhao Liu <zhao1.liu@intel.com>

As the comment in qapi/error, passing @errp to error_prepend() requires
ERRP_GUARD():

* = Why, when and how to use ERRP_GUARD() =
*
* Without ERRP_GUARD(), use of the @errp parameter is restricted:
...
* - It should not be passed to error_prepend(), error_vprepend() or
*   error_append_hint(), because that doesn't work with &error_fatal.
* ERRP_GUARD() lifts these restrictions.
*
* To use ERRP_GUARD(), add it right at the beginning of the function.
* @errp can then be used without worrying about the argument being
* NULL or &error_fatal.

ERRP_GUARD() could avoid the case when @errp is &error_fatal, the user
can't see this additional information, because exit() happens in
error_setg earlier than information is added [1].

In hw/vfio/helpers.c, there are 3 functions passing @errp to
error_prepend() without ERRP_GUARD():
 - vfio_set_irq_signaling()
 - vfio_device_get_name()
 - vfio_device_set_fd()

There are too many possible callers to check the impact of this defect;
it may or may not be harmless. Thus it is necessary to protect their
@errp with ERRP_GUARD().

To avoid the issue like [1] said, add missing ERRP_GUARD() at their
beginning.

[1]: Issue description in the commit message of commit ae7c80a7bd73
     ("error: New macro ERRP_GUARD()").

Cc: Alex Williamson <alex.williamson@redhat.com>
Cc: "Cédric Le Goater" <clg@redhat.com>
Signed-off-by: Zhao Liu <zhao1.liu@intel.com>
Reviewed-by: Cédric Le Goater <clg@redhat.com>
---
v2: Use Markus' sentence to polish commit message. (Markus)
---
 hw/vfio/helpers.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/hw/vfio/helpers.c b/hw/vfio/helpers.c
index 678987080228..47b4096c05ee 100644
--- a/hw/vfio/helpers.c
+++ b/hw/vfio/helpers.c
@@ -110,6 +110,7 @@ static const char *index_to_str(VFIODevice *vbasedev, int index)
 int vfio_set_irq_signaling(VFIODevice *vbasedev, int index, int subindex,
                            int action, int fd, Error **errp)
 {
+    ERRP_GUARD();
     struct vfio_irq_set *irq_set;
     int argsz, ret = 0;
     const char *name;
@@ -613,6 +614,7 @@ bool vfio_has_region_cap(VFIODevice *vbasedev, int region, uint16_t cap_type)
 
 int vfio_device_get_name(VFIODevice *vbasedev, Error **errp)
 {
+    ERRP_GUARD();
     struct stat st;
 
     if (vbasedev->fd < 0) {
@@ -644,6 +646,7 @@ int vfio_device_get_name(VFIODevice *vbasedev, Error **errp)
 
 void vfio_device_set_fd(VFIODevice *vbasedev, const char *str, Error **errp)
 {
+    ERRP_GUARD();
     int fd = monitor_fd_param(monitor_cur(), str, errp);
 
     if (fd < 0) {
-- 
2.34.1



  parent reply	other threads:[~2024-03-11  3:27 UTC|newest]

Thread overview: 45+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-11  3:37 [PATCH v2 00/29] Cleanup up to fix missing ERRP_GUARD() for error_prepend() Zhao Liu
2024-03-11  3:37 ` [PATCH v2 01/29] error: Add error_vprepend() in comment of ERRP_GUARD() rules Zhao Liu
2024-03-11  3:37 ` [PATCH v2 02/29] backends/iommufd: Fix missing ERRP_GUARD() for error_prepend() Zhao Liu
2024-03-11  9:32   ` Eric Auger
2024-03-11  3:37 ` [PATCH v2 03/29] block: " Zhao Liu
2024-03-11  3:37 ` [PATCH v2 04/29] block/copy-before-write: " Zhao Liu
2024-03-11  3:37 ` [PATCH v2 05/29] block/nbd: " Zhao Liu
2024-03-11  3:37 ` [PATCH v2 06/29] block/nvme: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 07/29] block/qcow2-bitmap: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 08/29] block/qcow2: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 09/29] block/qed: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 10/29] block/snapshot: " Zhao Liu
2024-03-12  8:11   ` Thomas Huth
2024-03-11  3:38 ` [PATCH v2 11/29] block/vdi: " Zhao Liu
2024-03-12  8:14   ` Thomas Huth
2024-03-11  3:38 ` [PATCH v2 12/29] block/vmdk: " Zhao Liu
2024-03-12  8:23   ` Thomas Huth
2024-03-11  3:38 ` [PATCH v2 13/29] block/virtio-blk: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 14/29] hw/core/loader-fit: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 15/29] hw/core/qdev-properties-system: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 16/29] hw/misc/ivshmem: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 17/29] hw/scsi/vhost-scsi: " Zhao Liu
2024-03-12  8:48   ` Thomas Huth
2024-03-11  3:38 ` [PATCH v2 18/29] hw/vfio/ap: " Zhao Liu
2024-03-11  7:42   ` Cédric Le Goater
2024-03-11  3:38 ` [PATCH v2 19/29] hw/vfio/container: " Zhao Liu
2024-03-11  3:38 ` Zhao Liu [this message]
2024-03-11  3:38 ` [PATCH v2 21/29] hw/vfio/iommufd: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 22/29] hw/vfio/pci-quirks: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 23/29] hw/vfio/pci: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 24/29] hw/vfio/platform: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 25/29] hw/virtio/vhost-vsock: " Zhao Liu
2024-03-12  8:53   ` Thomas Huth
2024-03-11  3:38 ` [PATCH v2 26/29] hw/virtio/vhost: " Zhao Liu
2024-03-12  9:09   ` Thomas Huth
2024-03-11  3:38 ` [PATCH v2 27/29] migration/option: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 28/29] net/vhost-vdpa: " Zhao Liu
2024-03-11  3:38 ` [PATCH v2 29/29] target/s390x/cpu_models: " Zhao Liu
2024-03-11  7:41   ` Cédric Le Goater
2024-03-11  7:42   ` Cédric Le Goater
2024-03-12  8:17 ` [PATCH v2 00/29] Cleanup up to fix " Philippe Mathieu-Daudé
2024-03-12  8:43   ` Zhao Liu
2024-03-12  8:50     ` Thomas Huth
2024-03-12 10:26       ` Zhao Liu
2024-03-12 10:42         ` Thomas Huth

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240311033822.3142585-21-zhao1.liu@linux.intel.com \
    --to=zhao1.liu@linux.intel.com \
    --cc=alex.williamson@redhat.com \
    --cc=armbru@redhat.com \
    --cc=clg@redhat.com \
    --cc=michael.roth@amd.com \
    --cc=mjt@tls.msk.ru \
    --cc=philmd@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu-trivial@nongnu.org \
    --cc=thuth@redhat.com \
    --cc=zhao1.liu@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).