mbox series

[v2,0/2] hw/block/block.c: improve confusing error

Message ID cover.1706023972.git.manos.pitsidianakis@linaro.org (mailing list archive)
Headers show
Series hw/block/block.c: improve confusing error | expand

Message

Manos Pitsidianakis Jan. 23, 2024, 3:35 p.m. UTC 
In cases where a device tries to read more bytes than the block device
contains with the blk_check_size_and_read_all() function, the error is
vague: "device requires X bytes, block backend provides Y bytes".

This patch changes the errors of this function to include the block
backend name, the device id and device type name where appropriate.

Version 2:
- Assert dev is not NULL on qdev_get_human_name
    (thanks Phil Mathieu-Daudé <philmd@linaro.org>)

Manos Pitsidianakis (2):
  hw/core/qdev.c: add qdev_get_human_name()
  hw/block/block.c: improve confusing blk_check_size_and_read_all()
    error

 hw/block/block.c         | 25 +++++++++++++++----------
 hw/block/m25p80.c        |  3 ++-
 hw/block/pflash_cfi01.c  |  4 ++--
 hw/block/pflash_cfi02.c  |  2 +-
 hw/core/qdev.c           |  8 ++++++++
 include/hw/block/block.h |  4 ++--
 include/hw/qdev-core.h   | 14 ++++++++++++++
 7 files changed, 44 insertions(+), 16 deletions(-)

Range-diff against v1:
1:  15b15d6d4f ! 1:  5fb5879708 hw/core/qdev.c: add qdev_get_human_name()
    @@ hw/core/qdev.c: Object *qdev_get_machine(void)
      
     +char *qdev_get_human_name(DeviceState *dev)
     +{
    -+    if (!dev) {
    -+        return g_strdup("");
    -+    }
    ++    g_assert(dev != NULL);
     +
     +    return dev->id ?
     +           g_strdup(dev->id) : object_get_canonical_path(OBJECT(dev));
    @@ include/hw/qdev-core.h: const char *qdev_fw_name(DeviceState *dev);
      
     +/**
     + * qdev_get_human_name() - Return a human-readable name for a device
    -+ * @dev: The device
    ++ * @dev: The device. Must be a valid and non-NULL pointer.
     + *
     + * .. note::
     + *    This function is intended for user friendly error messages.
     + *
     + * Returns: A newly allocated string containing the device id if not null,
    -+ * else the object canonical path if not null. If @dev is NULL, it returns an
    -+ * allocated empty string.
    ++ * else the object canonical path.
     + *
     + * Use g_free() to free it.
     + */
2:  e3701762ed ! 2:  8e7eb17fbd hw/block/block.c: improve confusing blk_check_size_and_read_all() error
    @@ Commit message
         This patch changes the errors of this function to include the block
         backend name, the device id and device type name where appropriate.
     
    +    Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
         Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
     
      ## hw/block/block.c ##

base-commit: 09be34717190c1620f0c6e5c8765b8da354aeb4b