The only way object_property_add() can fail is when a property with the same name already exists. Since our property names are all hardcoded, failure is a programming error, and the appropriate way to handle it is passing &error_abort. Same for its variants, except for object_property_add_child(), which additionally fails when the child already has a parent. Parentage is also under program control, so this is a programming error, too. We have a bit over 500 callers. Almost half of them pass &error_abort, slightly fewer ignore errors, one test case handles errors, and the remaining few callers pass them to their own callers. The previous few commits demonstrated once again that ignoring programming errors is a bad idea. Of the few ones that pass on errors, several violate the Error API. The Error ** argument must be NULL, &error_abort, &error_fatal, or a pointer to a variable containing NULL. Passing an argument of the latter kind twice without clearing it in between is wrong: if the first call sets an error, it no longer points to NULL for the second call. ich9_pm_add_properties(), sparc32_ledma_realize(), sparc32_dma_realize(), xilinx_axidma_realize(), xilinx_enet_realize() are wrong that way. When the one appropriate choice of argument is &error_abort, letting users pick the argument is a bad idea. Drop parameter @errp and assert the preconditions instead. There's one exception to "duplicate property name is a programming error": the way object_property_add() implements the magic (and undocumented) "automatic arrayification". Don't drop @errp there. Instead, rename object_property_add() to object_property_try_add(), and add the obvious wrapper object_property_add(). Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Reviewed-by: Paolo Bonzini <pbonzini@redhat.com> Message-Id: <20200505152926.18877-15-armbru@redhat.com> [Two semantic rebase conflicts resolved]
315 lines
9.1 KiB
C
315 lines
9.1 KiB
C
/*
|
|
* Test code for qdev global-properties handling
|
|
*
|
|
* Copyright (c) 2012 Red Hat Inc.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
#include "qemu/osdep.h"
|
|
|
|
#include "hw/qdev-properties.h"
|
|
#include "qom/object.h"
|
|
#include "qapi/visitor.h"
|
|
|
|
|
|
#define TYPE_STATIC_PROPS "static_prop_type"
|
|
#define STATIC_TYPE(obj) \
|
|
OBJECT_CHECK(MyType, (obj), TYPE_STATIC_PROPS)
|
|
|
|
#define TYPE_SUBCLASS "static_prop_subtype"
|
|
|
|
#define PROP_DEFAULT 100
|
|
|
|
typedef struct MyType {
|
|
DeviceState parent_obj;
|
|
|
|
uint32_t prop1;
|
|
uint32_t prop2;
|
|
} MyType;
|
|
|
|
static Property static_props[] = {
|
|
DEFINE_PROP_UINT32("prop1", MyType, prop1, PROP_DEFAULT),
|
|
DEFINE_PROP_UINT32("prop2", MyType, prop2, PROP_DEFAULT),
|
|
DEFINE_PROP_END_OF_LIST()
|
|
};
|
|
|
|
static void static_prop_class_init(ObjectClass *oc, void *data)
|
|
{
|
|
DeviceClass *dc = DEVICE_CLASS(oc);
|
|
|
|
dc->realize = NULL;
|
|
device_class_set_props(dc, static_props);
|
|
}
|
|
|
|
static const TypeInfo static_prop_type = {
|
|
.name = TYPE_STATIC_PROPS,
|
|
.parent = TYPE_DEVICE,
|
|
.instance_size = sizeof(MyType),
|
|
.class_init = static_prop_class_init,
|
|
};
|
|
|
|
static const TypeInfo subclass_type = {
|
|
.name = TYPE_SUBCLASS,
|
|
.parent = TYPE_STATIC_PROPS,
|
|
};
|
|
|
|
/* Test simple static property setting to default value */
|
|
static void test_static_prop_subprocess(void)
|
|
{
|
|
MyType *mt;
|
|
|
|
mt = STATIC_TYPE(object_new(TYPE_STATIC_PROPS));
|
|
qdev_init_nofail(DEVICE(mt));
|
|
|
|
g_assert_cmpuint(mt->prop1, ==, PROP_DEFAULT);
|
|
}
|
|
|
|
static void test_static_prop(void)
|
|
{
|
|
g_test_trap_subprocess("/qdev/properties/static/default/subprocess", 0, 0);
|
|
g_test_trap_assert_passed();
|
|
g_test_trap_assert_stderr("");
|
|
g_test_trap_assert_stdout("");
|
|
}
|
|
|
|
static void register_global_properties(GlobalProperty *props)
|
|
{
|
|
int i;
|
|
|
|
for (i = 0; props[i].driver != NULL; i++) {
|
|
qdev_prop_register_global(props + i);
|
|
}
|
|
}
|
|
|
|
|
|
/* Test setting of static property using global properties */
|
|
static void test_static_globalprop_subprocess(void)
|
|
{
|
|
MyType *mt;
|
|
static GlobalProperty props[] = {
|
|
{ TYPE_STATIC_PROPS, "prop1", "200" },
|
|
{}
|
|
};
|
|
|
|
register_global_properties(props);
|
|
|
|
mt = STATIC_TYPE(object_new(TYPE_STATIC_PROPS));
|
|
qdev_init_nofail(DEVICE(mt));
|
|
|
|
g_assert_cmpuint(mt->prop1, ==, 200);
|
|
g_assert_cmpuint(mt->prop2, ==, PROP_DEFAULT);
|
|
}
|
|
|
|
static void test_static_globalprop(void)
|
|
{
|
|
g_test_trap_subprocess("/qdev/properties/static/global/subprocess", 0, 0);
|
|
g_test_trap_assert_passed();
|
|
g_test_trap_assert_stderr("");
|
|
g_test_trap_assert_stdout("");
|
|
}
|
|
|
|
#define TYPE_DYNAMIC_PROPS "dynamic-prop-type"
|
|
#define DYNAMIC_TYPE(obj) \
|
|
OBJECT_CHECK(MyType, (obj), TYPE_DYNAMIC_PROPS)
|
|
|
|
#define TYPE_UNUSED_HOTPLUG "hotplug-type"
|
|
#define TYPE_UNUSED_NOHOTPLUG "nohotplug-type"
|
|
|
|
static void prop1_accessor(Object *obj, Visitor *v, const char *name,
|
|
void *opaque, Error **errp)
|
|
{
|
|
MyType *mt = DYNAMIC_TYPE(obj);
|
|
|
|
visit_type_uint32(v, name, &mt->prop1, errp);
|
|
}
|
|
|
|
static void prop2_accessor(Object *obj, Visitor *v, const char *name,
|
|
void *opaque, Error **errp)
|
|
{
|
|
MyType *mt = DYNAMIC_TYPE(obj);
|
|
|
|
visit_type_uint32(v, name, &mt->prop2, errp);
|
|
}
|
|
|
|
static void dynamic_instance_init(Object *obj)
|
|
{
|
|
object_property_add(obj, "prop1", "uint32", prop1_accessor, prop1_accessor,
|
|
NULL, NULL);
|
|
object_property_add(obj, "prop2", "uint32", prop2_accessor, prop2_accessor,
|
|
NULL, NULL);
|
|
}
|
|
|
|
static void dynamic_class_init(ObjectClass *oc, void *data)
|
|
{
|
|
DeviceClass *dc = DEVICE_CLASS(oc);
|
|
|
|
dc->realize = NULL;
|
|
}
|
|
|
|
|
|
static const TypeInfo dynamic_prop_type = {
|
|
.name = TYPE_DYNAMIC_PROPS,
|
|
.parent = TYPE_DEVICE,
|
|
.instance_size = sizeof(MyType),
|
|
.instance_init = dynamic_instance_init,
|
|
.class_init = dynamic_class_init,
|
|
};
|
|
|
|
static void hotplug_class_init(ObjectClass *oc, void *data)
|
|
{
|
|
DeviceClass *dc = DEVICE_CLASS(oc);
|
|
|
|
dc->realize = NULL;
|
|
dc->hotpluggable = true;
|
|
}
|
|
|
|
static const TypeInfo hotplug_type = {
|
|
.name = TYPE_UNUSED_HOTPLUG,
|
|
.parent = TYPE_DEVICE,
|
|
.instance_size = sizeof(MyType),
|
|
.instance_init = dynamic_instance_init,
|
|
.class_init = hotplug_class_init,
|
|
};
|
|
|
|
static void nohotplug_class_init(ObjectClass *oc, void *data)
|
|
{
|
|
DeviceClass *dc = DEVICE_CLASS(oc);
|
|
|
|
dc->realize = NULL;
|
|
dc->hotpluggable = false;
|
|
}
|
|
|
|
static const TypeInfo nohotplug_type = {
|
|
.name = TYPE_UNUSED_NOHOTPLUG,
|
|
.parent = TYPE_DEVICE,
|
|
.instance_size = sizeof(MyType),
|
|
.instance_init = dynamic_instance_init,
|
|
.class_init = nohotplug_class_init,
|
|
};
|
|
|
|
#define TYPE_NONDEVICE "nondevice-type"
|
|
|
|
static const TypeInfo nondevice_type = {
|
|
.name = TYPE_NONDEVICE,
|
|
.parent = TYPE_OBJECT,
|
|
};
|
|
|
|
/* Test setting of dynamic properties using global properties */
|
|
static void test_dynamic_globalprop_subprocess(void)
|
|
{
|
|
MyType *mt;
|
|
static GlobalProperty props[] = {
|
|
{ TYPE_DYNAMIC_PROPS, "prop1", "101", },
|
|
{ TYPE_DYNAMIC_PROPS, "prop2", "102", },
|
|
{ TYPE_DYNAMIC_PROPS"-bad", "prop3", "103", },
|
|
{ TYPE_UNUSED_HOTPLUG, "prop4", "104", },
|
|
{ TYPE_UNUSED_NOHOTPLUG, "prop5", "105", },
|
|
{ TYPE_NONDEVICE, "prop6", "106", },
|
|
{}
|
|
};
|
|
int global_error;
|
|
|
|
register_global_properties(props);
|
|
|
|
mt = DYNAMIC_TYPE(object_new(TYPE_DYNAMIC_PROPS));
|
|
qdev_init_nofail(DEVICE(mt));
|
|
|
|
g_assert_cmpuint(mt->prop1, ==, 101);
|
|
g_assert_cmpuint(mt->prop2, ==, 102);
|
|
global_error = qdev_prop_check_globals();
|
|
g_assert_cmpuint(global_error, ==, 1);
|
|
g_assert(props[0].used);
|
|
g_assert(props[1].used);
|
|
g_assert(!props[2].used);
|
|
g_assert(!props[3].used);
|
|
g_assert(!props[4].used);
|
|
g_assert(!props[5].used);
|
|
}
|
|
|
|
static void test_dynamic_globalprop(void)
|
|
{
|
|
g_test_trap_subprocess("/qdev/properties/dynamic/global/subprocess", 0, 0);
|
|
g_test_trap_assert_passed();
|
|
g_test_trap_assert_stderr_unmatched("*prop1*");
|
|
g_test_trap_assert_stderr_unmatched("*prop2*");
|
|
g_test_trap_assert_stderr("*warning: global dynamic-prop-type-bad.prop3 has invalid class name\n*");
|
|
g_test_trap_assert_stderr_unmatched("*prop4*");
|
|
g_test_trap_assert_stderr("*warning: global nohotplug-type.prop5=105 not used\n*");
|
|
g_test_trap_assert_stderr("*warning: global nondevice-type.prop6 has invalid class name\n*");
|
|
g_test_trap_assert_stdout("");
|
|
}
|
|
|
|
/* Test if global props affecting subclasses are applied in the right order */
|
|
static void test_subclass_global_props(void)
|
|
{
|
|
MyType *mt;
|
|
/* Global properties must be applied in the order they were registered */
|
|
static GlobalProperty props[] = {
|
|
{ TYPE_STATIC_PROPS, "prop1", "101" },
|
|
{ TYPE_SUBCLASS, "prop1", "102" },
|
|
{ TYPE_SUBCLASS, "prop2", "103" },
|
|
{ TYPE_STATIC_PROPS, "prop2", "104" },
|
|
{}
|
|
};
|
|
|
|
register_global_properties(props);
|
|
|
|
mt = STATIC_TYPE(object_new(TYPE_SUBCLASS));
|
|
qdev_init_nofail(DEVICE(mt));
|
|
|
|
g_assert_cmpuint(mt->prop1, ==, 102);
|
|
g_assert_cmpuint(mt->prop2, ==, 104);
|
|
}
|
|
|
|
int main(int argc, char **argv)
|
|
{
|
|
g_test_init(&argc, &argv, NULL);
|
|
|
|
module_call_init(MODULE_INIT_QOM);
|
|
type_register_static(&static_prop_type);
|
|
type_register_static(&subclass_type);
|
|
type_register_static(&dynamic_prop_type);
|
|
type_register_static(&hotplug_type);
|
|
type_register_static(&nohotplug_type);
|
|
type_register_static(&nondevice_type);
|
|
|
|
g_test_add_func("/qdev/properties/static/default/subprocess",
|
|
test_static_prop_subprocess);
|
|
g_test_add_func("/qdev/properties/static/default",
|
|
test_static_prop);
|
|
|
|
g_test_add_func("/qdev/properties/static/global/subprocess",
|
|
test_static_globalprop_subprocess);
|
|
g_test_add_func("/qdev/properties/static/global",
|
|
test_static_globalprop);
|
|
|
|
g_test_add_func("/qdev/properties/dynamic/global/subprocess",
|
|
test_dynamic_globalprop_subprocess);
|
|
g_test_add_func("/qdev/properties/dynamic/global",
|
|
test_dynamic_globalprop);
|
|
|
|
g_test_add_func("/qdev/properties/global/subclass",
|
|
test_subclass_global_props);
|
|
|
|
g_test_run();
|
|
|
|
return 0;
|
|
}
|