Skip to contentSkip to conversation

qom: Field properties type safety

PATCH In review Eduardo Habkost 3 participants 12 messages Nov 4, 2020 – Nov 10, 2020

lore
Share & tools
lore
#0 lore raw

cover qom: Field properties type safety

Based-on: [email protected]
Git branch: https://gitlab.com/ehabkost/qemu/-/commits/work/qdev-size-validation

This adds additional validation to field properties, to ensure the field property usage and implementation agree about the struct field size.

The first patch in the series fixes one bug found using the new safety mechanism. I hope it's the only one.

Eduardo Habkost (7):
sparc: Fix property/field size mismatch for iu-version
qom: Save size of struct field in Property struct
qdev: Don't register unreadable legacy properties
qom: Replace void* parameter with Property* on field getters/setters
qom: Replace void* parameter with Property* on PropertyInfo.release
qom: Add FIELD_PTR, a type-safe wrapper for object_field_prop_ptr()
sparc: Use FIELD_PTR at nwindows getter/setter

 include/qom/field-property-internal.h |   8 +-
 include/qom/field-property.h          |  61 ++++++++--
 include/qom/property-types.h          |   1 +
 target/sparc/cpu.h                    |   2 +-
 backends/tpm/tpm_util.c               |  18 ++-
 hw/block/xen-block.c                  |  10 +-
 hw/core/qdev-properties-system.c      | 140 +++++++++-------------
 hw/core/qdev-properties.c             |   4 +-
 hw/s390x/css.c                        |  10 +-
 hw/s390x/s390-pci-bus.c               |  10 +-
 hw/vfio/pci-quirks.c                  |  14 +--
 qom/field-property.c                  |  16 ++-
 qom/property-types.c                  | 166 +++++++++++---------------
 target/sparc/cpu.c                    |  17 ++-
 14 files changed, 231 insertions(+), 246 deletions(-)
Signature · 1 line
2.28.0
#1 lore raw

PATCH 1/7 sparc: Fix property/field size mismatch for iu-version

The "iu-version" property is declared as uint64_t but points to a target_ulong struct field. On the sparc 32-bit target, This makes every write of iu-version corrupt the 4 bytes after sparc_def_t.iu_version (where the fpu_version field is located).

Change the type of the iu_version struct field to uint64_t, and just use DEFINE_PROP_UINT64.

The only place where env.def.iu_version field is read is the

    env->version = env->def.iu_version;

assignment at sparc_cpu_realizefn(). This means behavior will be kept exactly the same (except for the memory corruption bug fix).

It would be nice to explicitly validate iu_version against target_ulong limits, but that would be a new feature (since the first version of this code, iu-version was parsed as 64-bit value value). It can be done later, once we have an appropriate API to define limits for integer properties.

Fixes de05005bf785 ("sparc: convert cpu features to qdev properties")

---
Cc: Mark Cave-Ayland <[email protected]>
Cc: Artyom Tarasenko <[email protected]>
Cc: [email protected]

---
 target/sparc/cpu.h | 2 +-
 target/sparc/cpu.c | 5 ++---
 2 files changed, 3 insertions(+), 4 deletions(-)
target/sparc/cpu.h +1 -1
index b9369398f2..8ed0f4fef3 100644
@@ -252,7 +252,7 @@ typedef struct trap_state {
 
 struct sparc_def_t {
     const char *name;
-    target_ulong iu_version;
+    uint64_t iu_version;
     uint32_t fpu_version;
     uint32_t mmu_version;
     uint32_t mmu_bm;
target/sparc/cpu.c +2 -3
index ec59a13eb8..5a9397f19a 100644
@@ -576,7 +576,7 @@ void sparc_cpu_list(void)
     unsigned int i;
 
     for (i = 0; i < ARRAY_SIZE(sparc_defs); i++) {
-        qemu_printf("Sparc %16s IU " TARGET_FMT_lx
+        qemu_printf("Sparc %16s IU %" PRIx64
                     " FPU %08x MMU %08x NWINS %d ",
                     sparc_defs[i].name,
                     sparc_defs[i].iu_version,
@@ -838,8 +838,7 @@ static Property sparc_cpu_properties[] = {
     DEFINE_PROP_BIT("hypv",     SPARCCPU, env.def.features, 11, false),
     DEFINE_PROP_BIT("cmt",      SPARCCPU, env.def.features, 12, false),
     DEFINE_PROP_BIT("gl",       SPARCCPU, env.def.features, 13, false),
-    DEFINE_PROP_UNSIGNED("iu-version", SPARCCPU, env.def.iu_version, 0,
-                         prop_info_uint64, target_ulong),
+    DEFINE_PROP_UINT64("iu-version", SPARCCPU, env.def.iu_version, 0),
     DEFINE_PROP_UINT32("fpu-version", SPARCCPU, env.def.fpu_version, 0),
     DEFINE_PROP_UINT32("mmu-version", SPARCCPU, env.def.mmu_version, 0),
     DEFINE_PROP("nwindows",     SPARCCPU, env.def.nwindows,
Signature · 1 line
2.28.0
Acked-by on v1 1/7
#2 lore raw

Re: [PATCH 1/7] sparc: Fix property/field size mismatch for iu-version

Quoted 57 lines · Eduardo Habkost

The "iu-version" property is declared as uint64_t but points to a target_ulong struct field. On the sparc 32-bit target, This makes every write of iu-version corrupt the 4 bytes after sparc_def_t.iu_version (where the fpu_version field is located).

Change the type of the iu_version struct field to uint64_t, and just use DEFINE_PROP_UINT64.

The only place where env.def.iu_version field is read is the

     env->version = env->def.iu_version;

assignment at sparc_cpu_realizefn(). This means behavior will be kept exactly the same (except for the memory corruption bug fix).

It would be nice to explicitly validate iu_version against target_ulong limits, but that would be a new feature (since the first version of this code, iu-version was parsed as 64-bit value value). It can be done later, once we have an appropriate API to define limits for integer properties.

Fixes de05005bf785 ("sparc: convert cpu features to qdev properties")

---
Cc: Mark Cave-Ayland <[email protected]>
Cc: Artyom Tarasenko <[email protected]>
Cc: [email protected]

---
  target/sparc/cpu.h | 2 +-
  target/sparc/cpu.c | 5 ++---
  2 files changed, 3 insertions(+), 4 deletions(-)
target/sparc/cpu.h +1 -1
index b9369398f2..8ed0f4fef3 100644
@@ -252,7 +252,7 @@ typedef struct trap_state {
 
  struct sparc_def_t {
      const char *name;
-    target_ulong iu_version;
+    uint64_t iu_version;
      uint32_t fpu_version;
      uint32_t mmu_version;
      uint32_t mmu_bm;
target/sparc/cpu.c +1 -1
index ec59a13eb8..5a9397f19a 100644
@@ -576,7 +576,7 @@ void sparc_cpu_list(void)
      unsigned int i;
 
      for (i = 0; i < ARRAY_SIZE(sparc_defs); i++) {
-        qemu_printf("Sparc %16s IU " TARGET_FMT_lx
+        qemu_printf("Sparc %16s IU %" PRIx64
                      " FPU %08x MMU %08x NWINS %d ",
                      sparc_defs[i].name,
                      sparc_defs[i].iu_version,

target/sparc/cpu.c static Property sparc_cpu_properties[] = { · line 844

Quoted 9 lines
target/sparc/cpu.c +1 -2
@@ -838,8 +838,7 @@ static Property sparc_cpu_properties[] = {
      DEFINE_PROP_BIT("hypv",     SPARCCPU, env.def.features, 11, false),
      DEFINE_PROP_BIT("cmt",      SPARCCPU, env.def.features, 12, false),
      DEFINE_PROP_BIT("gl",       SPARCCPU, env.def.features, 13, false),
-    DEFINE_PROP_UNSIGNED("iu-version", SPARCCPU, env.def.iu_version, 0,
-                         prop_info_uint64, target_ulong),
+    DEFINE_PROP_UINT64("iu-version", SPARCCPU, env.def.iu_version, 0),
      DEFINE_PROP_UINT32("fpu-version", SPARCCPU, env.def.fpu_version, 0),
      DEFINE_PROP_UINT32("mmu-version", SPARCCPU, env.def.mmu_version, 0),
      DEFINE_PROP("nwindows",     SPARCCPU, env.def.nwindows,

ATB,

Mark.

#3 lore raw

PATCH 2/7 qom: Save size of struct field in Property struct

In reply to Eduardo Habkost

This will let the code that reads/writes the field ensure it will never go out of bounds.

---
Cc: Paolo Bonzini <[email protected]>
Cc: "Daniel P. Berrangé" <[email protected]>
Cc: Eduardo Habkost <[email protected]>
Cc: [email protected]

---
 include/qom/field-property.h | 3 +++
 include/qom/property-types.h | 1 +
 qom/property-types.c         | 1 +
 3 files changed, 5 insertions(+)
include/qom/field-property.h +3 -0
index bc866e1c93..e64a2b3c07 100644
@@ -27,7 +27,10 @@ struct Property {
      */
     const char   *qdev_prop_name;
     const PropertyInfo *info;
+    /** @offset: offset of field in object instance struct */
     ptrdiff_t    offset;
+    /** @size: size of field in object instance struct */
+    size_t       size;
     uint8_t      bitnr;
     /**
      * @set_default: true if the default value should be set from @defval,
include/qom/property-types.h +1 -0
index 3a36e1fec5..17bf007234 100644
@@ -28,6 +28,7 @@ extern const PropertyInfo prop_info_link;
         .info      = &(_prop),                                   \
         .offset    = offsetof(_state, _field)                    \
             + type_check(_type, typeof_field(_state, _field)),   \
+        .size      = sizeof(typeof_field(_state, _field)),       \
         __VA_ARGS__                                              \
         }
 
qom/property-types.c +1 -0
index f566c05ec2..856b5ae76d 100644
@@ -485,6 +485,7 @@ static void set_prop_arraylen(Object *obj, Visitor *v, const char *name,
          * being inside the device struct.
          */
         arrayprop->offset = eltptr - (void *)obj;
+        arrayprop->size = prop->arrayfieldsize;
         assert(object_field_prop_ptr(obj, arrayprop) == eltptr);
         object_property_add_field(obj, propname, arrayprop, op->allow_set);
     }
Signature · 1 line
2.28.0
#4 lore raw

PATCH 3/7 qdev: Don't register unreadable legacy properties

In reply to Eduardo Habkost

The existing code at qdev_class_add_legacy_property() will register a property if both .print and .get are NULL, which is useless as it will register a property that can't be read or written.

The only PropertyInfo struct in the whole tree that has both .print and .get set to NULL is qdev_prop_link. This means every link property in the code had a useless "legacy-" property being registered.

Fix this by only registering legacy properties if a .print method exists.

---
Cc: Paolo Bonzini <[email protected]>
Cc: "Daniel P. Berrangé" <[email protected]>
Cc: Eduardo Habkost <[email protected]>
Cc: [email protected]

---
 hw/core/qdev-properties.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
hw/core/qdev-properties.c +2 -2
index 5bb4ff5f46..73884a212a 100644
@@ -264,13 +264,13 @@ static void qdev_class_add_legacy_property(DeviceClass *dc, Property *prop)
     g_autofree char *name = NULL;
 
     /* Register pointer properties as legacy properties */
-    if (!prop->info->print && prop->info->get) {
+    if (!prop->info->print) {
         return;
     }
 
     name = g_strdup_printf("legacy-%s", prop->qdev_prop_name);
     object_class_property_add(OBJECT_CLASS(dc), name, "str",
-        prop->info->print ? qdev_get_legacy_property : prop->info->get,
+        qdev_get_legacy_property,
         NULL, NULL, prop);
 }
 
Signature · 1 line
2.28.0
#5 lore raw

PATCH 4/7 qom: Replace void* parameter with Property* on field getters/setters

In reply to Eduardo Habkost

All field property getters and setters must interpret the fourth argument as Property*. Change the function signature of field property getters and setters to indicate that.

---
Cc: Stefan Berger <[email protected]>
Cc: Stefano Stabellini <[email protected]>
Cc: Anthony Perard <[email protected]>
Cc: Paul Durrant <[email protected]>
Cc: Kevin Wolf <[email protected]>
Cc: Max Reitz <[email protected]>
Cc: Paolo Bonzini <[email protected]>
Cc: "Daniel P. Berrangé" <[email protected]>
Cc: Eduardo Habkost <[email protected]>
Cc: Richard Henderson <[email protected]>
Cc: David Hildenbrand <[email protected]>
Cc: Cornelia Huck <[email protected]>
Cc: Thomas Huth <[email protected]>
Cc: Halil Pasic <[email protected]>
Cc: Christian Borntraeger <[email protected]>
Cc: Matthew Rosato <[email protected]>
Cc: Alex Williamson <[email protected]>
Cc: Mark Cave-Ayland <[email protected]>
Cc: Artyom Tarasenko <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]

---
 include/qom/field-property-internal.h |   8 +-
 include/qom/field-property.h          |  26 ++++---
 backends/tpm/tpm_util.c               |  11 ++-
 hw/block/xen-block.c                  |   6 +-
 hw/core/qdev-properties-system.c      |  86 +++++++++-------------
 hw/s390x/css.c                        |   6 +-
 hw/s390x/s390-pci-bus.c               |   6 +-
 hw/vfio/pci-quirks.c                  |  10 +--
 qom/property-types.c                  | 102 +++++++++-----------------
 target/sparc/cpu.c                    |   4 +-
 10 files changed, 105 insertions(+), 160 deletions(-)
include/qom/field-property-internal.h +4 -4
index 7aa27ce836..bc7d25033d 100644
@@ -9,9 +9,9 @@
 #define QOM_STATIC_PROPERTY_INTERNAL_H
 
 void field_prop_get_enum(Object *obj, Visitor *v, const char *name,
-                         void *opaque, Error **errp);
+                         Property *prop, Error **errp);
 void field_prop_set_enum(Object *obj, Visitor *v, const char *name,
-                         void *opaque, Error **errp);
+                         Property *prop, Error **errp);
 
 void field_prop_set_default_value_enum(ObjectProperty *op,
                                        const Property *prop);
@@ -21,9 +21,9 @@ void field_prop_set_default_value_uint(ObjectProperty *op,
                                        const Property *prop);
 
 void field_prop_get_int32(Object *obj, Visitor *v, const char *name,
-                          void *opaque, Error **errp);
+                          Property *prop, Error **errp);
 void field_prop_get_size32(Object *obj, Visitor *v, const char *name,
-                           void *opaque, Error **errp);
+                           Property *prop, Error **errp);
 
 /**
  * object_property_add_field: Add a field property to an object instance
include/qom/field-property.h +16 -10
index e64a2b3c07..438bb25896 100644
@@ -54,6 +54,18 @@ struct Property {
     const char   *link_type;
 };
 
+/**
+ * typedef FieldAccessor: a field property getter or setter function
+ * @obj: the object instance
+ * @v: the visitor that contains the property data
+ * @name: the name of the property
+ * @prop: Field property definition
+ * @errp: pointer to error information
+ */
+typedef void FieldAccessor(Object *obj, Visitor *v,
+                           const char *name, Property *prop,
+                           Error **errp);
+
 /**
  * struct PropertyInfo: information on a specific QOM property type
  */
@@ -71,16 +83,10 @@ struct PropertyInfo {
     /** @create: Optional callback for creation of property */
     ObjectProperty *(*create)(ObjectClass *oc, const char *name,
                               Property *prop);
-    /**
-     * @get: Property getter.  The opaque parameter will point to
-     *        the &Property struct for the property.
-     */
-    ObjectPropertyAccessor *get;
-    /**
-     * @set: Property setter.  The opaque parameter will point to
-     *        the &Property struct for the property.
-     */
-    ObjectPropertyAccessor *set;
+    /** @get: Property getter */
+    FieldAccessor *get;
+    /** @set: Property setter */
+    FieldAccessor *set;
     /**
      * @release: Optional release function, called when the object
      * is destroyed
backends/tpm/tpm_util.c +5 -6
index bb1ab34a75..e8837938e5 100644
@@ -32,10 +32,10 @@
 
 /* tpm backend property */
 
-static void get_tpm(Object *obj, Visitor *v, const char *name, void *opaque,
-                    Error **errp)
+static void get_tpm(Object *obj, Visitor *v, const char *name,
+                    Property *prop, Error **errp)
 {
-    TPMBackend **be = object_field_prop_ptr(obj, opaque);
+    TPMBackend **be = object_field_prop_ptr(obj, prop);
     char *p;
 
     p = g_strdup(*be ? (*be)->id : "");
@@ -43,10 +43,9 @@ static void get_tpm(Object *obj, Visitor *v, const char *name, void *opaque,
     g_free(p);
 }
 
-static void set_tpm(Object *obj, Visitor *v, const char *name, void *opaque,
-                    Error **errp)
+static void set_tpm(Object *obj, Visitor *v, const char *name,
+                    Property *prop, Error **errp)
 {
-    Property *prop = opaque;
     TPMBackend *s, **be = object_field_prop_ptr(obj, prop);
     char *str;
 
hw/block/xen-block.c +2 -4
index 718d886e5c..c1ee634639 100644
@@ -333,9 +333,8 @@ static char *disk_to_vbd_name(unsigned int disk)
 }
 
 static void xen_block_get_vdev(Object *obj, Visitor *v, const char *name,
-                               void *opaque, Error **errp)
+                                Property *prop, Error **errp)
 {
-    Property *prop = opaque;
     XenBlockVdev *vdev = object_field_prop_ptr(obj, prop);
     char *str;
 
@@ -393,9 +392,8 @@ static int vbd_name_to_disk(const char *name, const char **endp,
 }
 
 static void xen_block_set_vdev(Object *obj, Visitor *v, const char *name,
-                               void *opaque, Error **errp)
+                                Property *prop, Error **errp)
 {
-    Property *prop = opaque;
     XenBlockVdev *vdev = object_field_prop_ptr(obj, prop);
     char *str, *p;
     const char *end;
hw/core/qdev-properties-system.c +33 -53

246 lines not on this page · raw message

hw/s390x/css.c +2 -4
index fe47751df4..1400d80689 100644
@@ -2341,9 +2341,8 @@ void css_reset(void)
 }
 
 static void get_css_devid(Object *obj, Visitor *v, const char *name,
-                          void *opaque, Error **errp)
+                           Property *prop, Error **errp)
 {
-    Property *prop = opaque;
     CssDevId *dev_id = object_field_prop_ptr(obj, prop);
     char buffer[] = "xx.x.xxxx";
     char *p = buffer;
@@ -2370,9 +2369,8 @@ static void get_css_devid(Object *obj, Visitor *v, const char *name,
  * parse <cssid>.<ssid>.<devid> and assert valid range for cssid/ssid
  */
 static void set_css_devid(Object *obj, Visitor *v, const char *name,
-                          void *opaque, Error **errp)
+                           Property *prop, Error **errp)
 {
-    Property *prop = opaque;
     CssDevId *dev_id = object_field_prop_ptr(obj, prop);
     char *str;
     int num, n1, n2;
hw/s390x/s390-pci-bus.c +2 -4
index 99b18d56ba..a29bba17b4 100644
@@ -1320,19 +1320,17 @@ static void s390_pci_device_reset(DeviceState *dev)
 }
 
 static void s390_pci_get_fid(Object *obj, Visitor *v, const char *name,
-                         void *opaque, Error **errp)
+                          Property *prop, Error **errp)
 {
-    Property *prop = opaque;
     uint32_t *ptr = object_field_prop_ptr(obj, prop);
 
     visit_type_uint32(v, name, ptr, errp);
 }
 
 static void s390_pci_set_fid(Object *obj, Visitor *v, const char *name,
-                         void *opaque, Error **errp)
+                          Property *prop, Error **errp)
 {
     S390PCIBusDevice *zpci = S390_PCI_DEVICE(obj);
-    Property *prop = opaque;
     uint32_t *ptr = object_field_prop_ptr(obj, prop);
 
     if (!visit_type_uint32(v, name, ptr, errp)) {
hw/vfio/pci-quirks.c +4 -6
index fc8d63c850..34f5f5dce2 100644
@@ -1485,20 +1485,18 @@ void vfio_setup_resetfn_quirk(VFIOPCIDevice *vdev)
  * https://lists.gnu.org/archive/html/qemu-devel/2017-08/pdfUda5iEpgOS.pdf
  */
 static void get_nv_gpudirect_clique_id(Object *obj, Visitor *v,
-                                       const char *name, void *opaque,
-                                       Error **errp)
+                                       const char *name,
+                                       Property *prop, Error **errp)
 {
-    Property *prop = opaque;
     uint8_t *ptr = object_field_prop_ptr(obj, prop);
 
     visit_type_uint8(v, name, ptr, errp);
 }
 
 static void set_nv_gpudirect_clique_id(Object *obj, Visitor *v,
-                                       const char *name, void *opaque,
-                                       Error **errp)
+                                       const char *name,
+                                       Property *prop, Error **errp)
 {
-    Property *prop = opaque;
     uint8_t value, *ptr = object_field_prop_ptr(obj, prop);
 
     if (!visit_type_uint8(v, name, &value, errp)) {
qom/property-types.c +35 -67

287 lines not on this page · raw message

target/sparc/cpu.c +2 -2
index 5a9397f19a..3acc99c29c 100644
@@ -787,7 +787,7 @@ static void sparc_cpu_initfn(Object *obj)
 }
 
 static void sparc_get_nwindows(Object *obj, Visitor *v, const char *name,
-                               void *opaque, Error **errp)
+                               Property *prop, Error **errp)
 {
     SPARCCPU *cpu = SPARC_CPU(obj);
     int64_t value = cpu->env.def.nwindows;
@@ -796,7 +796,7 @@ static void sparc_get_nwindows(Object *obj, Visitor *v, const char *name,
 }
 
 static void sparc_set_nwindows(Object *obj, Visitor *v, const char *name,
-                               void *opaque, Error **errp)
+                               Property *prop, Error **errp)
 {
     const int64_t min = MIN_NWINDOWS;
     const int64_t max = MAX_NWINDOWS;
Signature · 1 line
2.28.0
Acked-by on v1 4/7
#6 lore raw

Re: [PATCH 4/7] qom: Replace void* parameter with Property* on field getters/setters

Quoted 29 lines · On Wed, 4 Nov 2020 12:25:09 -0500 Eduardo Habkost <[email protected]> wrote:

All field property getters and setters must interpret the fourth argument as Property*. Change the function signature of field property getters and setters to indicate that.

---
Cc: Stefan Berger <[email protected]>
Cc: Stefano Stabellini <[email protected]>
Cc: Anthony Perard <[email protected]>
Cc: Paul Durrant <[email protected]>
Cc: Kevin Wolf <[email protected]>
Cc: Max Reitz <[email protected]>
Cc: Paolo Bonzini <[email protected]>
Cc: "Daniel P. Berrangé" <[email protected]>
Cc: Eduardo Habkost <[email protected]>
Cc: Richard Henderson <[email protected]>
Cc: David Hildenbrand <[email protected]>
Cc: Cornelia Huck <[email protected]>
Cc: Thomas Huth <[email protected]>
Cc: Halil Pasic <[email protected]>
Cc: Christian Borntraeger <[email protected]>
Cc: Matthew Rosato <[email protected]>
Cc: Alex Williamson <[email protected]>
Cc: Mark Cave-Ayland <[email protected]>
Cc: Artyom Tarasenko <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]

Quoted 12 lines
---
 include/qom/field-property-internal.h |   8 +-
 include/qom/field-property.h          |  26 ++++---
 backends/tpm/tpm_util.c               |  11 ++-
 hw/block/xen-block.c                  |   6 +-
 hw/core/qdev-properties-system.c      |  86 +++++++++-------------
 hw/s390x/css.c                        |   6 +-
 hw/s390x/s390-pci-bus.c               |   6 +-
 hw/vfio/pci-quirks.c                  |  10 +--
 qom/property-types.c                  | 102 +++++++++-----------------
 target/sparc/cpu.c                    |   4 +-
 10 files changed, 105 insertions(+), 160 deletions(-)
#7 lore raw

PATCH 5/7 qom: Replace void* parameter with Property* on PropertyInfo.release

In reply to Eduardo Habkost

The release function must interpret the third argument as Property*. Change the signature of PropertyInfo.release to indicate that.

---
Cc: Stefan Berger <[email protected]>
Cc: Paolo Bonzini <[email protected]>
Cc: "Daniel P. Berrangé" <[email protected]>
Cc: Eduardo Habkost <[email protected]>
Cc: [email protected]

---
 include/qom/field-property.h     | 11 ++++++++++-
 backends/tpm/tpm_util.c          |  3 +--
 hw/core/qdev-properties-system.c |  6 ++----
 qom/field-property.c             | 13 +++++++++++--
 qom/property-types.c             |  3 +--
 5 files changed, 25 insertions(+), 11 deletions(-)
include/qom/field-property.h +10 -1
index 438bb25896..1d3bf9699b 100644
@@ -66,6 +66,15 @@ typedef void FieldAccessor(Object *obj, Visitor *v,
                            const char *name, Property *prop,
                            Error **errp);
 
+/**
+ * typedef FieldRelease:
+ * @obj: the object instance
+ * @name: the name of the property
+ * @prop: Field property definition
+ */
+typedef void FieldRelease(Object *obj, const char *name, Property *prop);
+
+
 /**
  * struct PropertyInfo: information on a specific QOM property type
  */
@@ -91,7 +100,7 @@ struct PropertyInfo {
      * @release: Optional release function, called when the object
      * is destroyed
      */
-    ObjectPropertyRelease *release;
+    FieldRelease *release;
 };
 
 /**
backends/tpm/tpm_util.c +1 -2
index e8837938e5..556e21388c 100644
@@ -63,9 +63,8 @@ static void set_tpm(Object *obj, Visitor *v, const char *name,
     g_free(str);
 }
 
-static void release_tpm(Object *obj, const char *name, void *opaque)
+static void release_tpm(Object *obj, const char *name, Property *prop)
 {
-    Property *prop = opaque;
     TPMBackend **be = object_field_prop_ptr(obj, prop);
 
     if (*be) {
hw/core/qdev-properties-system.c +2 -4
index 4c649cb4b2..2fdd5863bb 100644
@@ -176,10 +176,9 @@ static void set_drive_iothread(Object *obj, Visitor *v, const char *name,
     set_drive_helper(obj, v, name, prop, true, errp);
 }
 
-static void release_drive(Object *obj, const char *name, void *opaque)
+static void release_drive(Object *obj, const char *name, Property *prop)
 {
     DeviceState *dev = DEVICE(obj);
-    Property *prop = opaque;
     BlockBackend **ptr = object_field_prop_ptr(obj, prop);
 
     if (*ptr) {
@@ -257,9 +256,8 @@ static void set_chr(Object *obj, Visitor *v, const char *name,
     g_free(str);
 }
 
-static void release_chr(Object *obj, const char *name, void *opaque)
+static void release_chr(Object *obj, const char *name, Property *prop)
 {
-    Property *prop = opaque;
     CharBackend *be = object_field_prop_ptr(obj, prop);
 
     qemu_chr_fe_deinit(be, false);
qom/field-property.c +11 -2
index 25a818bb69..865d4929a3 100644
@@ -47,6 +47,15 @@ static ObjectPropertyAccessor *field_prop_setter(const PropertyInfo *info)
     return info->set ? field_prop_set : NULL;
 }
 
+static void field_prop_release(Object *obj, const char *name, void *opaque)
+{
+    Property *prop = opaque;
+    if (prop->info->release) {
+        prop->info->release(obj, name, prop);
+    }
+}
+
+
 ObjectProperty *
 object_property_add_field(Object *obj, const char *name, Property *prop,
                           ObjectPropertyAllowSet allow_set)
@@ -59,7 +68,7 @@ object_property_add_field(Object *obj, const char *name, Property *prop,
     op = object_property_add(obj, name, prop->info->name,
                              field_prop_getter(prop->info),
                              field_prop_setter(prop->info),
-                             prop->info->release,
+                             field_prop_release,
                              prop);
 
     object_property_set_description(obj, name,
@@ -92,7 +101,7 @@ object_class_property_add_field(ObjectClass *oc, const char *name,
                                        name, prop->info->name,
                                        field_prop_getter(prop->info),
                                        field_prop_setter(prop->info),
-                                       prop->info->release,
+                                       field_prop_release,
                                        prop);
     }
     if (prop->set_default) {
qom/property-types.c +1 -2
index 82a5932f4a..0182a73e38 100644
@@ -321,9 +321,8 @@ const PropertyInfo prop_info_int64 = {
 
 /* --- string --- */
 
-static void release_string(Object *obj, const char *name, void *opaque)
+static void release_string(Object *obj, const char *name, Property *prop)
 {
-    Property *prop = opaque;
     g_free(*(char **)object_field_prop_ptr(obj, prop));
 }
 
Signature · 1 line
2.28.0
#8 lore raw

PATCH 6/7 qom: Add FIELD_PTR, a type-safe wrapper for object_field_prop_ptr()

In reply to Eduardo Habkost

Introduce a FIELD_PTR macro that will ensure the size of the area we are accessing has the correct size, and will return a pointer of the correct type.

---
Cc: Stefan Berger <[email protected]>
Cc: Stefano Stabellini <[email protected]>
Cc: Anthony Perard <[email protected]>
Cc: Paul Durrant <[email protected]>
Cc: Kevin Wolf <[email protected]>
Cc: Max Reitz <[email protected]>
Cc: Paolo Bonzini <[email protected]>
Cc: "Daniel P. Berrangé" <[email protected]>
Cc: Eduardo Habkost <[email protected]>
Cc: Cornelia Huck <[email protected]>
Cc: Thomas Huth <[email protected]>
Cc: Halil Pasic <[email protected]>
Cc: Christian Borntraeger <[email protected]>
Cc: Richard Henderson <[email protected]>
Cc: David Hildenbrand <[email protected]>
Cc: Matthew Rosato <[email protected]>
Cc: Alex Williamson <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]

---
 include/qom/field-property.h     | 21 ++++++++++-
 backends/tpm/tpm_util.c          |  6 ++--
 hw/block/xen-block.c             |  4 +--
 hw/core/qdev-properties-system.c | 50 +++++++++++++-------------
 hw/s390x/css.c                   |  4 +--
 hw/s390x/s390-pci-bus.c          |  4 +--
 hw/vfio/pci-quirks.c             |  4 +--
 qom/field-property.c             |  3 +-
 qom/property-types.c             | 60 +++++++++++++++++---------------
 9 files changed, 89 insertions(+), 67 deletions(-)
include/qom/field-property.h +20 -1
index 1d3bf9699b..58baaca160 100644
@@ -125,6 +125,25 @@ object_class_property_add_field(ObjectClass *oc, const char *name,
                                 Property *prop,
                                 ObjectPropertyAllowSet allow_set);
 
-void *object_field_prop_ptr(Object *obj, Property *prop);
+/**
+ * object_field_prop_ptr: Get pointer to property field
+ * @obj: the object instance
+ * @prop: field property definition
+ * @expected_size: expected size of struct field
+ *
+ * Don't use this function directly, use the FIELD_PTR() macro instead.
+ */
+void *object_field_prop_ptr(Object *obj, Property *prop, size_t expected_size);
+
+/**
+ * FIELD_PTR: Get pointer to struct field for property
+ *
+ * This returns a pointer to type @type, pointing to the struct
+ * field containing the property value.
+ *
+ * @type must match the expected type for the property.
+ */
+#define FIELD_PTR(obj, prop, type) \
+    ((type *)object_field_prop_ptr((obj), (prop), sizeof(type)))
 
 #endif
backends/tpm/tpm_util.c +3 -3
index 556e21388c..da80379404 100644
@@ -35,7 +35,7 @@
 static void get_tpm(Object *obj, Visitor *v, const char *name,
                     Property *prop, Error **errp)
 {
-    TPMBackend **be = object_field_prop_ptr(obj, prop);
+    TPMBackend **be = FIELD_PTR(obj, prop, TPMBackend *);
     char *p;
 
     p = g_strdup(*be ? (*be)->id : "");
@@ -46,7 +46,7 @@ static void get_tpm(Object *obj, Visitor *v, const char *name,
 static void set_tpm(Object *obj, Visitor *v, const char *name,
                     Property *prop, Error **errp)
 {
-    TPMBackend *s, **be = object_field_prop_ptr(obj, prop);
+    TPMBackend *s, **be = FIELD_PTR(obj, prop, TPMBackend *);
     char *str;
 
     if (!visit_type_str(v, name, &str, errp)) {
@@ -65,7 +65,7 @@ static void set_tpm(Object *obj, Visitor *v, const char *name,
 
 static void release_tpm(Object *obj, const char *name, Property *prop)
 {
-    TPMBackend **be = object_field_prop_ptr(obj, prop);
+    TPMBackend **be = FIELD_PTR(obj, prop, TPMBackend *);
 
     if (*be) {
         tpm_backend_reset(*be);
hw/block/xen-block.c +2 -2
index c1ee634639..390bf417ab 100644
@@ -335,7 +335,7 @@ static char *disk_to_vbd_name(unsigned int disk)
 static void xen_block_get_vdev(Object *obj, Visitor *v, const char *name,
                                 Property *prop, Error **errp)
 {
-    XenBlockVdev *vdev = object_field_prop_ptr(obj, prop);
+    XenBlockVdev *vdev = FIELD_PTR(obj, prop, XenBlockVdev);
     char *str;
 
     switch (vdev->type) {
@@ -394,7 +394,7 @@ static int vbd_name_to_disk(const char *name, const char **endp,
 static void xen_block_set_vdev(Object *obj, Visitor *v, const char *name,
                                 Property *prop, Error **errp)
 {
-    XenBlockVdev *vdev = object_field_prop_ptr(obj, prop);
+    XenBlockVdev *vdev = FIELD_PTR(obj, prop, XenBlockVdev);
     char *str, *p;
     const char *end;
 
hw/core/qdev-properties-system.c +25 -25

200 lines not on this page · raw message

hw/s390x/css.c +2 -2
index 1400d80689..5a38919a05 100644
@@ -2343,7 +2343,7 @@ void css_reset(void)
 static void get_css_devid(Object *obj, Visitor *v, const char *name,
                            Property *prop, Error **errp)
 {
-    CssDevId *dev_id = object_field_prop_ptr(obj, prop);
+    CssDevId *dev_id = FIELD_PTR(obj, prop, CssDevId);
     char buffer[] = "xx.x.xxxx";
     char *p = buffer;
     int r;
@@ -2371,7 +2371,7 @@ static void get_css_devid(Object *obj, Visitor *v, const char *name,
 static void set_css_devid(Object *obj, Visitor *v, const char *name,
                            Property *prop, Error **errp)
 {
-    CssDevId *dev_id = object_field_prop_ptr(obj, prop);
+    CssDevId *dev_id = FIELD_PTR(obj, prop, CssDevId);
     char *str;
     int num, n1, n2;
     unsigned int cssid, ssid, devid;
hw/s390x/s390-pci-bus.c +2 -2
index a29bba17b4..8e38787c99 100644
@@ -1322,7 +1322,7 @@ static void s390_pci_device_reset(DeviceState *dev)
 static void s390_pci_get_fid(Object *obj, Visitor *v, const char *name,
                           Property *prop, Error **errp)
 {
-    uint32_t *ptr = object_field_prop_ptr(obj, prop);
+    uint32_t *ptr = FIELD_PTR(obj, prop, uint32_t);
 
     visit_type_uint32(v, name, ptr, errp);
 }
@@ -1331,7 +1331,7 @@ static void s390_pci_set_fid(Object *obj, Visitor *v, const char *name,
                           Property *prop, Error **errp)
 {
     S390PCIBusDevice *zpci = S390_PCI_DEVICE(obj);
-    uint32_t *ptr = object_field_prop_ptr(obj, prop);
+    uint32_t *ptr = FIELD_PTR(obj, prop, uint32_t);
 
     if (!visit_type_uint32(v, name, ptr, errp)) {
         return;
hw/vfio/pci-quirks.c +2 -2
index 34f5f5dce2..93fb507ec4 100644
@@ -1488,7 +1488,7 @@ static void get_nv_gpudirect_clique_id(Object *obj, Visitor *v,
                                        const char *name,
                                        Property *prop, Error **errp)
 {
-    uint8_t *ptr = object_field_prop_ptr(obj, prop);
+    uint8_t *ptr = FIELD_PTR(obj, prop, uint8_t);
 
     visit_type_uint8(v, name, ptr, errp);
 }
@@ -1497,7 +1497,7 @@ static void set_nv_gpudirect_clique_id(Object *obj, Visitor *v,
                                        const char *name,
                                        Property *prop, Error **errp)
 {
-    uint8_t value, *ptr = object_field_prop_ptr(obj, prop);
+    uint8_t value, *ptr = FIELD_PTR(obj, prop, uint8_t);
 
     if (!visit_type_uint8(v, name, &value, errp)) {
         return;
qom/field-property.c +2 -1
index 865d4929a3..0932a799de 100644
@@ -5,10 +5,11 @@
 #include "qom/field-property.h"
 #include "qom/field-property-internal.h"
 
-void *object_field_prop_ptr(Object *obj, Property *prop)
+void *object_field_prop_ptr(Object *obj, Property *prop, size_t expected_size)
 {
     void *ptr = obj;
     ptr += prop->offset;
+    assert(prop->size == expected_size);
     return ptr;
 }
 
qom/property-types.c +31 -29

233 lines not on this page · raw message

Signature · 1 line
2.28.0
Acked-by on v1 6/7
#9 lore raw

Re: [PATCH 6/7] qom: Add FIELD_PTR, a type-safe wrapper for object_field_prop_ptr()

Quoted 27 lines · On Wed, 4 Nov 2020 12:25:11 -0500 Eduardo Habkost <[email protected]> wrote:

Introduce a FIELD_PTR macro that will ensure the size of the area we are accessing has the correct size, and will return a pointer of the correct type.

---
Cc: Stefan Berger <[email protected]>
Cc: Stefano Stabellini <[email protected]>
Cc: Anthony Perard <[email protected]>
Cc: Paul Durrant <[email protected]>
Cc: Kevin Wolf <[email protected]>
Cc: Max Reitz <[email protected]>
Cc: Paolo Bonzini <[email protected]>
Cc: "Daniel P. Berrangé" <[email protected]>
Cc: Eduardo Habkost <[email protected]>
Cc: Cornelia Huck <[email protected]>
Cc: Thomas Huth <[email protected]>
Cc: Halil Pasic <[email protected]>
Cc: Christian Borntraeger <[email protected]>
Cc: Richard Henderson <[email protected]>
Cc: David Hildenbrand <[email protected]>
Cc: Matthew Rosato <[email protected]>
Cc: Alex Williamson <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]

Quoted 11 lines
---
 include/qom/field-property.h     | 21 ++++++++++-
 backends/tpm/tpm_util.c          |  6 ++--
 hw/block/xen-block.c             |  4 +--
 hw/core/qdev-properties-system.c | 50 +++++++++++++-------------
 hw/s390x/css.c                   |  4 +--
 hw/s390x/s390-pci-bus.c          |  4 +--
 hw/vfio/pci-quirks.c             |  4 +--
 qom/field-property.c             |  3 +-
 qom/property-types.c             | 60 +++++++++++++++++---------------
 9 files changed, 89 insertions(+), 67 deletions(-)
#10 lore raw

PATCH 7/7 sparc: Use FIELD_PTR at nwindows getter/setter

In reply to Eduardo Habkost

This makes the nwindows getter and setter more consistent with the other field getters and setters (which work with any struct field).

---
Cc: Mark Cave-Ayland <[email protected]>
Cc: Artyom Tarasenko <[email protected]>
Cc: [email protected]

---
 target/sparc/cpu.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
target/sparc/cpu.c +4 -4
index 3acc99c29c..8bf02a4fe0 100644
@@ -789,8 +789,8 @@ static void sparc_cpu_initfn(Object *obj)
 static void sparc_get_nwindows(Object *obj, Visitor *v, const char *name,
                                Property *prop, Error **errp)
 {
-    SPARCCPU *cpu = SPARC_CPU(obj);
-    int64_t value = cpu->env.def.nwindows;
+    uint32_t *ptr = FIELD_PTR(obj, prop, uint32_t);
+    int64_t value = *ptr;
 
     visit_type_int(v, name, &value, errp);
 }
@@ -798,9 +798,9 @@ static void sparc_get_nwindows(Object *obj, Visitor *v, const char *name,
 static void sparc_set_nwindows(Object *obj, Visitor *v, const char *name,
                                Property *prop, Error **errp)
 {
+    uint32_t *ptr = FIELD_PTR(obj, prop, uint32_t);
     const int64_t min = MIN_NWINDOWS;
     const int64_t max = MAX_NWINDOWS;
-    SPARCCPU *cpu = SPARC_CPU(obj);
     int64_t value;
 
     if (!visit_type_int(v, name, &value, errp)) {
@@ -814,7 +814,7 @@ static void sparc_set_nwindows(Object *obj, Visitor *v, const char *name,
                    value, min, max);
         return;
     }
-    cpu->env.def.nwindows = value;
+    *ptr = value;
 }
 
 static PropertyInfo qdev_prop_nwindows = {
Signature · 1 line
2.28.0
Acked-by on v1 7/7
#11 lore raw

Re: [PATCH 7/7] sparc: Use FIELD_PTR at nwindows getter/setter

Quoted 40 lines · Eduardo Habkost

This makes the nwindows getter and setter more consistent with the other field getters and setters (which work with any struct field).

---
Cc: Mark Cave-Ayland <[email protected]>
Cc: Artyom Tarasenko <[email protected]>
Cc: [email protected]

---
  target/sparc/cpu.c | 8 ++++----
  1 file changed, 4 insertions(+), 4 deletions(-)
target/sparc/cpu.c +3 -3
index 3acc99c29c..8bf02a4fe0 100644
@@ -789,8 +789,8 @@ static void sparc_cpu_initfn(Object *obj)
  static void sparc_get_nwindows(Object *obj, Visitor *v, const char *name,
                                 Property *prop, Error **errp)
  {
-    SPARCCPU *cpu = SPARC_CPU(obj);
-    int64_t value = cpu->env.def.nwindows;
+    uint32_t *ptr = FIELD_PTR(obj, prop, uint32_t);
+    int64_t value = *ptr;
 
      visit_type_int(v, name, &value, errp);
  }
@@ -798,9 +798,9 @@ static void sparc_get_nwindows(Object *obj, Visitor *v, const char *name,
  static void sparc_set_nwindows(Object *obj, Visitor *v, const char *name,
                                 Property *prop, Error **errp)
  {
+    uint32_t *ptr = FIELD_PTR(obj, prop, uint32_t);
      const int64_t min = MIN_NWINDOWS;
      const int64_t max = MAX_NWINDOWS;
-    SPARCCPU *cpu = SPARC_CPU(obj);
      int64_t value;
 
      if (!visit_type_int(v, name, &value, errp)) {

target/sparc/cpu.c static void sparc_set_nwindows(Object *obj, Visitor *v, const char *name, · line 820

Quoted 8 lines
target/sparc/cpu.c +1 -1
@@ -814,7 +814,7 @@ static void sparc_set_nwindows(Object *obj, Visitor *v, const char *name,
                     value, min, max);
          return;
      }
-    cpu->env.def.nwindows = value;
+    *ptr = value;
  }
 
  static PropertyInfo qdev_prop_nwindows = {

This looks correct to me:

ATB,

Mark.