Skip to contentSkip to conversation

hw/block/block.c: improve confusing error

PATCH Superseded Manos Pitsidianakis 2 participants 7 messages Jan 23, 2024

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

cover hw/block/block.c: improve confusing error

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.

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           | 10 ++++++++++
 include/hw/block/block.h |  4 ++--
 include/hw/qdev-core.h   | 15 +++++++++++++++
 7 files changed, 47 insertions(+), 16 deletions(-)

base-commit: 09be34717190c1620f0c6e5c8765b8da354aeb4b

Signature · 1 line
γαῖα πυρί μιχθήτω
#1 lore raw

PATCH 1/2 hw/core/qdev.c: add qdev_get_human_name()

Add a simple method to return some kind of human readable identifier for use in error messages.

---
 hw/core/qdev.c         | 10 ++++++++++
 include/hw/qdev-core.h | 15 +++++++++++++++
 2 files changed, 25 insertions(+)
hw/core/qdev.c +10 -0
index 43d863b0c5..499f191826 100644
@@ -879,6 +879,16 @@ Object *qdev_get_machine(void)
     return dev;
 }
 
+char *qdev_get_human_name(DeviceState *dev)
+{
+    if (!dev) {
+        return g_strdup("");
+    }
+
+    return dev->id ?
+           g_strdup(dev->id) : object_get_canonical_path(OBJECT(dev));
+}
+
 static MachineInitPhase machine_phase;
 
 bool phase_check(MachineInitPhase phase)
include/hw/qdev-core.h +15 -0
index 151d968238..a8c742b4a3 100644
@@ -993,6 +993,21 @@ const char *qdev_fw_name(DeviceState *dev);
 void qdev_assert_realized_properly(void);
 Object *qdev_get_machine(void);
 
+/**
+ * qdev_get_human_name() - Return a human-readable name for a device
+ * @dev: The device
+ *
+ * .. 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.
+ *
+ * Use g_free() to free it.
+ */
+char *qdev_get_human_name(DeviceState *dev);
+
 /* FIXME: make this a link<> */
 bool qdev_set_parent_bus(DeviceState *dev, BusState *bus, Error **errp);
 
Signature · 1 line
γαῖα πυρί μιχθήτω
#2 lore raw

Re: [PATCH 1/2] hw/core/qdev.c: add qdev_get_human_name()

Hi Manos,

Quoted 38 lines · Manos Pitsidianakis

Add a simple method to return some kind of human readable identifier for use in error messages.

---
  hw/core/qdev.c         | 10 ++++++++++
  include/hw/qdev-core.h | 15 +++++++++++++++
  2 files changed, 25 insertions(+)
hw/core/qdev.c +10 -0
index 43d863b0c5..499f191826 100644
@@ -879,6 +879,16 @@ Object *qdev_get_machine(void)
      return dev;
  }
 
+char *qdev_get_human_name(DeviceState *dev)
+{
+    if (!dev) {
+        return g_strdup("");
+    }
+
+    return dev->id ?
+           g_strdup(dev->id) : object_get_canonical_path(OBJECT(dev));
+}
+
  static MachineInitPhase machine_phase;
 
  bool phase_check(MachineInitPhase phase)
include/hw/qdev-core.h +0 -0
index 151d968238..a8c742b4a3 100644
@@ -993,6 +993,21 @@ const char *qdev_fw_name(DeviceState *dev);
  void qdev_assert_realized_properly(void);
  Object *qdev_get_machine(void);
 

include/hw/qdev-core.h const char *qdev_fw_name(DeviceState *dev); · line 1005

Quoted 10 lines
include/hw/qdev-core.h +10 -0
+/**
+ * qdev_get_human_name() - Return a human-readable name for a device
+ * @dev: The device
+ *
+ * .. 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.

In which case do we want to call this with NULL?

Quoted 8 lines
include/hw/qdev-core.h +5 -0
+ *
+ * Use g_free() to free it.
+ */
+char *qdev_get_human_name(DeviceState *dev);
+
  /* FIXME: make this a link<> */
  bool qdev_set_parent_bus(DeviceState *dev, BusState *bus, Error **errp);
 
#3 lore raw

Re: [PATCH 1/2] hw/core/qdev.c: add qdev_get_human_name()

Quoted 41 lines · Philippe Mathieu-Daudé

Hi Manos,

Quoted 38 lines · Manos Pitsidianakis

Add a simple method to return some kind of human readable identifier for use in error messages.

---
  hw/core/qdev.c         | 10 ++++++++++
  include/hw/qdev-core.h | 15 +++++++++++++++
  2 files changed, 25 insertions(+)
hw/core/qdev.c +10 -0
index 43d863b0c5..499f191826 100644
@@ -879,6 +879,16 @@ Object *qdev_get_machine(void)
      return dev;
  }
 
+char *qdev_get_human_name(DeviceState *dev)
+{
+    if (!dev) {
+        return g_strdup("");
+    }
+
+    return dev->id ?
+           g_strdup(dev->id) : object_get_canonical_path(OBJECT(dev));
+}
+
  static MachineInitPhase machine_phase;
 
  bool phase_check(MachineInitPhase phase)
include/hw/qdev-core.h +0 -0
index 151d968238..a8c742b4a3 100644
@@ -993,6 +993,21 @@ const char *qdev_fw_name(DeviceState *dev);
  void qdev_assert_realized_properly(void);
  Object *qdev_get_machine(void);
 
Quoted 12 lines

include/hw/qdev-core.h const char *qdev_fw_name(DeviceState *dev); · line 1005

Quoted 10 lines
include/hw/qdev-core.h +10 -0
+/**
+ * qdev_get_human_name() - Return a human-readable name for a device
+ * @dev: The device
+ *
+ * .. 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.

In which case do we want to call this with NULL?

None I could think of, just future-proofing the NULL case.

Quoted 9 lines
Quoted 8 lines
include/hw/qdev-core.h +5 -0
+ *
+ * Use g_free() to free it.
+ */
+char *qdev_get_human_name(DeviceState *dev);
+
  /* FIXME: make this a link<> */
  bool qdev_set_parent_bus(DeviceState *dev, BusState *bus, Error **errp);
 
#4 lore raw

Re: [PATCH 1/2] hw/core/qdev.c: add qdev_get_human_name()

Quoted 54 lines · Manos Pitsidianakis
Quoted 44 lines · Philippe Mathieu-Daudé

Hi Manos,

Quoted 41 lines · Manos Pitsidianakis

Add a simple method to return some kind of human readable identifier for use in error messages.

---
  hw/core/qdev.c         | 10 ++++++++++
  include/hw/qdev-core.h | 15 +++++++++++++++

  2 files changed, 25 insertions(+)
hw/core/qdev.c +10 -0
index 43d863b0c5..499f191826 100644
@@ -879,6 +879,16 @@ Object *qdev_get_machine(void)
       return dev;
   }
+char *qdev_get_human_name(DeviceState *dev)
+{
+    if (!dev) {
+        return g_strdup("");
+    }
+
+    return dev->id ?
+           g_strdup(dev->id) : object_get_canonical_path(OBJECT(dev));
+}
+
   static MachineInitPhase machine_phase;
   bool phase_check(MachineInitPhase phase)
include/hw/qdev-core.h +6 -0
index 151d968238..a8c742b4a3 100644
@@ -993,6 +993,21 @@ const char *qdev_fw_name(DeviceState *dev);
   void qdev_assert_realized_properly(void);
   Object *qdev_get_machine(void);
+/**
+ * qdev_get_human_name() - Return a human-readable name for a device
+ * @dev: The device
+ *
+ * .. note::
+ *    This function is intended for user friendly error messages.
Quoted 8 lines
Quoted 6 lines
include/hw/qdev-core.h +3 -0
+ *
+ * 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.

In which case do we want to call this with NULL?

Quoted 1 line

None I could think of, just future-proofing the NULL case.

I'd rather have a raw assert() as future-proof API, avoiding dubious corner cases :)

Quoted 9 lines
Quoted 9 lines
Quoted 8 lines

+ *
+ * Use g_free() to free it.
+ */

include/hw/qdev-core.h +2 -0
+char *qdev_get_human_name(DeviceState *dev);
+

  /* FIXME: make this a link<> */
  bool qdev_set_parent_bus(DeviceState *dev, BusState *bus, Error **errp);

#5 lore raw

PATCH 2/2 hw/block/block.c: improve confusing blk_check_size_and_read_all() error

In reply to Manos Pitsidianakis

In cases where a device tries to read more bytes than the block device contains, 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.

---
 hw/block/block.c         | 25 +++++++++++++++----------
 hw/block/m25p80.c        |  3 ++-
 hw/block/pflash_cfi01.c  |  4 ++--
 hw/block/pflash_cfi02.c  |  2 +-
 include/hw/block/block.h |  4 ++--
 5 files changed, 22 insertions(+), 16 deletions(-)
hw/block/block.c +15 -10
index 9f52ee6e72..624389d62d 100644
@@ -54,29 +54,30 @@ static int blk_pread_nonzeroes(BlockBackend *blk, hwaddr size, void *buf)
  * BDRV_REQUEST_MAX_BYTES.
  * On success, return true.
  * On failure, store an error through @errp and return false.
- * Note that the error messages do not identify the block backend.
- * TODO Since callers don't either, this can result in confusing
- * errors.
+ *
  * This function not intended for actual block devices, which read on
  * demand.  It's for things like memory devices that (ab)use a block
  * backend to provide persistence.
  */
-bool blk_check_size_and_read_all(BlockBackend *blk, void *buf, hwaddr size,
-                                 Error **errp)
+bool blk_check_size_and_read_all(BlockBackend *blk, DeviceState *dev,
+                                 void *buf, hwaddr size, Error **errp)
 {
     int64_t blk_len;
     int ret;
+    g_autofree char *dev_id = NULL;
 
     blk_len = blk_getlength(blk);
     if (blk_len < 0) {
         error_setg_errno(errp, -blk_len,
-                         "can't get size of block backend");
+                         "can't get size of %s block backend", blk_name(blk));
         return false;
     }
     if (blk_len != size) {
-        error_setg(errp, "device requires %" HWADDR_PRIu " bytes, "
-                   "block backend provides %" PRIu64 " bytes",
-                   size, blk_len);
+        dev_id = qdev_get_human_name(dev);
+        error_setg(errp, "%s device with id='%s' requires %" HWADDR_PRIu
+                   " bytes, %s block backend provides %" PRIu64 " bytes",
+                   object_get_typename(OBJECT(dev)), dev_id, size,
+                   blk_name(blk), blk_len);
         return false;
     }
 
@@ -89,7 +90,11 @@ bool blk_check_size_and_read_all(BlockBackend *blk, void *buf, hwaddr size,
     assert(size <= BDRV_REQUEST_MAX_BYTES);
     ret = blk_pread_nonzeroes(blk, size, buf);
     if (ret < 0) {
-        error_setg_errno(errp, -ret, "can't read block backend");
+        dev_id = qdev_get_human_name(dev);
+        error_setg_errno(errp, -ret, "can't read %s block backend"
+                         "for %s device with id='%s'",
+                         blk_name(blk), object_get_typename(OBJECT(dev)),
+                         dev_id);
         return false;
     }
     return true;
hw/block/m25p80.c +2 -1
index 26ce895628..0a12030a3a 100644
@@ -1617,7 +1617,8 @@ static void m25p80_realize(SSIPeripheral *ss, Error **errp)
         trace_m25p80_binding(s);
         s->storage = blk_blockalign(s->blk, s->size);
 
-        if (!blk_check_size_and_read_all(s->blk, s->storage, s->size, errp)) {
+        if (!blk_check_size_and_read_all(s->blk, DEVICE(s),
+                                         s->storage, s->size, errp)) {
             return;
         }
     } else {
hw/block/pflash_cfi01.c +2 -2
index f956f8bcf7..1bda8424b9 100644
@@ -848,8 +848,8 @@ static void pflash_cfi01_realize(DeviceState *dev, Error **errp)
     }
 
     if (pfl->blk) {
-        if (!blk_check_size_and_read_all(pfl->blk, pfl->storage, total_len,
-                                         errp)) {
+        if (!blk_check_size_and_read_all(pfl->blk, dev, pfl->storage,
+                                         total_len, errp)) {
             vmstate_unregister_ram(&pfl->mem, DEVICE(pfl));
             return;
         }
hw/block/pflash_cfi02.c +1 -1
index 6fa56f14c0..2314142373 100644
@@ -902,7 +902,7 @@ static void pflash_cfi02_realize(DeviceState *dev, Error **errp)
     }
 
     if (pfl->blk) {
-        if (!blk_check_size_and_read_all(pfl->blk, pfl->storage,
+        if (!blk_check_size_and_read_all(pfl->blk, dev, pfl->storage,
                                          pfl->chip_len, errp)) {
             vmstate_unregister_ram(&pfl->orig_mem, DEVICE(pfl));
             return;
include/hw/block/block.h +2 -2
index 15fff66435..de3946a5f1 100644
@@ -88,8 +88,8 @@ static inline unsigned int get_physical_block_exp(BlockConf *conf)
 
 /* Backend access helpers */
 
-bool blk_check_size_and_read_all(BlockBackend *blk, void *buf, hwaddr size,
-                                 Error **errp);
+bool blk_check_size_and_read_all(BlockBackend *blk, DeviceState *dev,
+                                 void *buf, hwaddr size, Error **errp);
 
 /* Configuration helpers */
 
Signature · 1 line
γαῖα πυρί μιχθήτω
Reviewed-by on v1 2/2
#6 lore raw

Re: [PATCH 2/2] hw/block/block.c: improve confusing blk_check_size_and_read_all() error

Quoted 7 lines · Manos Pitsidianakis

In cases where a device tries to read more bytes than the block device contains, 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.

Quoted 8 lines
---
  hw/block/block.c         | 25 +++++++++++++++----------
  hw/block/m25p80.c        |  3 ++-
  hw/block/pflash_cfi01.c  |  4 ++--
  hw/block/pflash_cfi02.c  |  2 +-
  include/hw/block/block.h |  4 ++--
  5 files changed, 22 insertions(+), 16 deletions(-)