This more accurately reflects that these properties are held within the class and not the object. Update the documentation to describe the few cases where static properties should be used.
Signed-off-by: Mark Cave-Ayland <[email protected]> --- include/qom/object.h | 56 +++++++++++++++++++++++++++++++------------- hw/riscv/spike.c | 5 ++-- qom/object.c | 28 ++++++++++++---------- 3 files changed, 59 insertions(+), 30 deletions(-) diff --git a/include/qom/object.h b/include/qom/object.h index 272c41cac7..11b1c9d2dc 100644 --- a/include/qom/object.h +++ b/include/qom/object.h @@ -2034,18 +2034,24 @@ ObjectProperty *object_property_add_uint8_ptr(Object *obj, const char *name, ObjectPropertyFlags flags); /** - * object_class_property_add_uint8_ptr: - * @klass: the object class to add a property to + * object_class_static_property_add_uint8_ptr: + * @klass: the object class to add a static property to * @name: the name of the property * @v: pointer to value * @flags: bitwise-or'd ObjectPropertyFlags * - * Add an integer property in memory. This function will add a + * Add a static integer property in memory. This function will add a * property of type 'uint8'. * + * A static property is one which is stored outside of the object instance, + * typically in global variables. It is only appropriate to use static + * properties when the class is designed as a singleton. If there is a + * possibility of multiple instances, then properties must be stored + * per-instance. + * * Returns: The newly added property on success, or %NULL on failure. */ -ObjectProperty *object_class_property_add_uint8_ptr(ObjectClass *klass, +ObjectProperty *object_class_static_property_add_uint8_ptr(ObjectClass *klass, const char *name, const uint8_t *v, ObjectPropertyFlags flags); @@ -2067,18 +2073,24 @@ ObjectProperty *object_property_add_uint16_ptr(Object *obj, const char *name, ObjectPropertyFlags flags); /** - * object_class_property_add_uint16_ptr: - * @klass: the object class to add a property to + * object_class_static_property_add_uint16_ptr: + * @klass: the object class to add a static property to * @name: the name of the property * @v: pointer to value * @flags: bitwise-or'd ObjectPropertyFlags * - * Add an integer property in memory. This function will add a + * Add a static integer property in memory. This function will add a * property of type 'uint16'. * + * A static property is one which is stored outside of the object instance, + * typically in global variables. It is only appropriate to use static + * properties when the class is designed as a singleton. If there is a + * possibility of multiple instances, then properties must be stored + * per-instance. + * * Returns: The newly added property on success, or %NULL on failure. */ -ObjectProperty *object_class_property_add_uint16_ptr(ObjectClass *klass, +ObjectProperty *object_class_static_property_add_uint16_ptr(ObjectClass *klass, const char *name, const uint16_t *v, ObjectPropertyFlags flags); @@ -2100,18 +2112,24 @@ ObjectProperty *object_property_add_uint32_ptr(Object *obj, const char *name, ObjectPropertyFlags flags); /** - * object_class_property_add_uint32_ptr: - * @klass: the object class to add a property to + * object_class_static_property_add_uint32_ptr: + * @klass: the object class to add a static property to * @name: the name of the property * @v: pointer to value * @flags: bitwise-or'd ObjectPropertyFlags * - * Add an integer property in memory. This function will add a + * Add a static integer property in memory. This function will add a * property of type 'uint32'. * + * A static property is one which is stored outside of the object instance, + * typically in global variables. It is only appropriate to use static + * properties when the class is designed as a singleton. If there is a + * possibility of multiple instances, then properties must be stored + * per-instance. + * * Returns: The newly added property on success, or %NULL on failure. */ -ObjectProperty *object_class_property_add_uint32_ptr(ObjectClass *klass, +ObjectProperty *object_class_static_property_add_uint32_ptr(ObjectClass *klass, const char *name, const uint32_t *v, ObjectPropertyFlags flags); @@ -2133,18 +2151,24 @@ ObjectProperty *object_property_add_uint64_ptr(Object *obj, const char *name, ObjectPropertyFlags flags); /** - * object_class_property_add_uint64_ptr: - * @klass: the object class to add a property to + * object_class_static_property_add_uint64_ptr: + * @klass: the object class to add a static property to * @name: the name of the property * @v: pointer to value * @flags: bitwise-or'd ObjectPropertyFlags * - * Add an integer property in memory. This function will add a + * Add a static integer property in memory. This function will add a * property of type 'uint64'. * + * A static property is one which is stored outside of the object instance, + * typically in global variables. It is only appropriate to use static + * properties when the class is designed as a singleton. If there is a + * possibility of multiple instances, then properties must be stored + * per-instance. + * * Returns: The newly added property on success, or %NULL on failure. */ -ObjectProperty *object_class_property_add_uint64_ptr(ObjectClass *klass, +ObjectProperty *object_class_static_property_add_uint64_ptr(ObjectClass *klass, const char *name, const uint64_t *v, ObjectPropertyFlags flags); diff --git a/hw/riscv/spike.c b/hw/riscv/spike.c index 9fde0faf39..630b65f569 100644 --- a/hw/riscv/spike.c +++ b/hw/riscv/spike.c @@ -278,8 +278,9 @@ static void spike_machine_class_init(ObjectClass *oc, const void *data) object_class_property_add_str(oc, "signature", NULL, spike_set_signature); object_class_property_set_description(oc, "signature", "File to write ACT test signature"); - object_class_property_add_uint8_ptr(oc, "signature-granularity", - &line_size, OBJ_PROP_FLAG_WRITE); + object_class_static_property_add_uint8_ptr(oc, "signature-granularity", + &line_size, + OBJ_PROP_FLAG_WRITE); object_class_property_set_description(oc, "signature-granularity", "Size of each line in ACT signature " "file"); diff --git a/qom/object.c b/qom/object.c index 622840f9f8..47977b1f44 100644 --- a/qom/object.c +++ b/qom/object.c @@ -2724,9 +2724,10 @@ object_property_add_uint8_ptr(Object *obj, const char *name, } ObjectProperty * -object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name, - const uint8_t *v, - ObjectPropertyFlags flags) +object_class_static_property_add_uint8_ptr(ObjectClass *klass, + const char *name, + const uint8_t *v, + ObjectPropertyFlags flags) { ObjectPropertyAccessor *getter = NULL; ObjectPropertyAccessor *setter = NULL; @@ -2764,9 +2765,10 @@ object_property_add_uint16_ptr(Object *obj, const char *name, } ObjectProperty * -object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name, - const uint16_t *v, - ObjectPropertyFlags flags) +object_class_static_property_add_uint16_ptr(ObjectClass *klass, + const char *name, + const uint16_t *v, + ObjectPropertyFlags flags) { ObjectPropertyAccessor *getter = NULL; ObjectPropertyAccessor *setter = NULL; @@ -2804,9 +2806,10 @@ object_property_add_uint32_ptr(Object *obj, const char *name, } ObjectProperty * -object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name, - const uint32_t *v, - ObjectPropertyFlags flags) +object_class_static_property_add_uint32_ptr(ObjectClass *klass, + const char *name, + const uint32_t *v, + ObjectPropertyFlags flags) { ObjectPropertyAccessor *getter = NULL; ObjectPropertyAccessor *setter = NULL; @@ -2844,9 +2847,10 @@ object_property_add_uint64_ptr(Object *obj, const char *name, } ObjectProperty * -object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name, - const uint64_t *v, - ObjectPropertyFlags flags) +object_class_static_property_add_uint64_ptr(ObjectClass *klass, + const char *name, + const uint64_t *v, + ObjectPropertyFlags flags) { ObjectPropertyAccessor *getter = NULL; ObjectPropertyAccessor *setter = NULL; -- 2.43.0
