[03/17] hw/remote/remote-obj: hw/misc/ivshmem: Fix missing ERRP_GUARD() for error_prepend()

Commit Message

Zhao Liu Feb. 29, 2024, 2:39 p.m. UTC

From: Zhao Liu <[e-mail]>

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 the pointer of
error_fatal, the user can't see this additional information, because
exit() happens in error_setg earlier than information is added [1].

The remote_object_set_fd() passes @errp to error_prepend(), and as a
PropertyInfo.set method, its @errp is so widely sourced that it is
necessary to protect it with ERRP_GUARD().

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

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

Cc: Elena Ufimtseva <[e-mail]>
Cc: Jagannathan Raman <[e-mail]>
Signed-off-by: Zhao Liu <[e-mail]>
---
 hw/remote/remote-obj.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Thomas Huth Feb. 29, 2024, 5:26 p.m. UTC | #1

On 29/02/2024 15.39, Zhao Liu wrote:
> From: Zhao Liu <[e-mail]>
> 
> 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 the pointer of
> error_fatal, the user can't see this additional information, because
> exit() happens in error_setg earlier than information is added [1].
> 
> The remote_object_set_fd() passes @errp to error_prepend(), and as a
> PropertyInfo.set method, its @errp is so widely sourced that it is
> necessary to protect it with ERRP_GUARD().
> 
> To avoid the issue like [1] said, add missing ERRP_GUARD() at the
> beginning of this function.
> 
> [1]: Issue description in the commit message of commit ae7c80a7bd73
>       ("error: New macro ERRP_GUARD()").
> 
> Cc: Elena Ufimtseva <[e-mail]>
> Cc: Jagannathan Raman <[e-mail]>
> Signed-off-by: Zhao Liu <[e-mail]>
> ---
>   hw/remote/remote-obj.c | 1 +
>   1 file changed, 1 insertion(+)
> 
> diff --git a/hw/remote/remote-obj.c b/hw/remote/remote-obj.c
> index 65b6f7cc863f..dc27cc8da1f3 100644
> --- a/hw/remote/remote-obj.c
> +++ b/hw/remote/remote-obj.c
> @@ -49,6 +49,7 @@ struct RemoteObject {
>   
>   static void remote_object_set_fd(Object *obj, const char *str, Error **errp)
>   {
> +    ERRP_GUARD();
>       RemoteObject *o = REMOTE_OBJECT(obj);
>       int fd = -1;
>   

Reviewed-by: Thomas Huth <[e-mail]>

Patch

diff --git a/hw/remote/remote-obj.c b/hw/remote/remote-obj.c
index 65b6f7cc863f..dc27cc8da1f3 100644
--- a/hw/remote/remote-obj.c
+++ b/hw/remote/remote-obj.c
@@ -49,6 +49,7 @@  struct RemoteObject {
 
 static void remote_object_set_fd(Object *obj, const char *str, Error **errp)
 {
+    ERRP_GUARD();
     RemoteObject *o = REMOTE_OBJECT(obj);
     int fd = -1;