Browse Source

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.

Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
Message-id: 8b566bfced98ae44be1fcc1f8e7215f0c3393aa1.1706598705.git.manos.pitsidianakis@linaro.org
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Manos Pitsidianakis 1 year ago
parent
commit
956ef49990
2 changed files with 22 additions and 0 deletions
  1. 8 0
      hw/core/qdev.c
  2. 14 0
      include/hw/qdev-core.h

+ 8 - 0
hw/core/qdev.c

@@ -879,6 +879,14 @@ Object *qdev_get_machine(void)
     return dev;
     return dev;
 }
 }
 
 
+char *qdev_get_human_name(DeviceState *dev)
+{
+    g_assert(dev != NULL);
+
+    return dev->id ?
+           g_strdup(dev->id) : object_get_canonical_path(OBJECT(dev));
+}
+
 static MachineInitPhase machine_phase;
 static MachineInitPhase machine_phase;
 
 
 bool phase_check(MachineInitPhase phase)
 bool phase_check(MachineInitPhase phase)

+ 14 - 0
include/hw/qdev-core.h

@@ -993,6 +993,20 @@ const char *qdev_fw_name(DeviceState *dev);
 void qdev_assert_realized_properly(void);
 void qdev_assert_realized_properly(void);
 Object *qdev_get_machine(void);
 Object *qdev_get_machine(void);
 
 
+/**
+ * qdev_get_human_name() - Return a human-readable name for a 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.
+ *
+ * Use g_free() to free it.
+ */
+char *qdev_get_human_name(DeviceState *dev);
+
 /* FIXME: make this a link<> */
 /* FIXME: make this a link<> */
 bool qdev_set_parent_bus(DeviceState *dev, BusState *bus, Error **errp);
 bool qdev_set_parent_bus(DeviceState *dev, BusState *bus, Error **errp);