[qemu.git] / tests / test-qdev-global-props.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.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;
    dc->props = 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, NULL);
    object_property_add(obj, "prop2", "uint32", prop2_accessor, prop2_accessor,
                        NULL, 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;
}
Commit	Line	Data
747b0cb4 EH	1	/*
	2	* Test code for qdev global-properties handling
	3	*
	4	* Copyright (c) 2012 Red Hat Inc.
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	19	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	22	* THE SOFTWARE.
	23	*/
	24
681c28a3	25	#include "qemu/osdep.h"
747b0cb4 EH	26
747b0cb4 EH	27	#include "hw/qdev.h"
99a0b036 EH	28	#include "qom/object.h"
99a0b036 EH	29	#include "qapi/visitor.h"
747b0cb4 EH	30
	31
	32	#define TYPE_STATIC_PROPS "static_prop_type"
	33	#define STATIC_TYPE(obj) \
	34	OBJECT_CHECK(MyType, (obj), TYPE_STATIC_PROPS)
	35
3caca555 EH	36	#define TYPE_SUBCLASS "static_prop_subtype"
3caca555 EH	37
747b0cb4 EH	38	#define PROP_DEFAULT 100
	39
	40	typedef struct MyType {
	41	DeviceState parent_obj;
	42
	43	uint32_t prop1;
	44	uint32_t prop2;
	45	} MyType;
	46
	47	static Property static_props[] = {
	48	DEFINE_PROP_UINT32("prop1", MyType, prop1, PROP_DEFAULT),
	49	DEFINE_PROP_UINT32("prop2", MyType, prop2, PROP_DEFAULT),
	50	DEFINE_PROP_END_OF_LIST()
	51	};
	52
	53	static void static_prop_class_init(ObjectClass oc, void data)
	54	{
	55	DeviceClass *dc = DEVICE_CLASS(oc);
	56
	57	dc->realize = NULL;
	58	dc->props = static_props;
	59	}
	60
	61	static const TypeInfo static_prop_type = {
	62	.name = TYPE_STATIC_PROPS,
	63	.parent = TYPE_DEVICE,
	64	.instance_size = sizeof(MyType),
	65	.class_init = static_prop_class_init,
	66	};
	67
3caca555 EH	68	static const TypeInfo subclass_type = {
	69	.name = TYPE_SUBCLASS,
	70	.parent = TYPE_STATIC_PROPS,
	71	};
	72
747b0cb4	73	/* Test simple static property setting to default value */
2177801a	74	static void test_static_prop_subprocess(void)
747b0cb4 EH	75	{
	76	MyType *mt;
	77
	78	mt = STATIC_TYPE(object_new(TYPE_STATIC_PROPS));
	79	qdev_init_nofail(DEVICE(mt));
	80
	81	g_assert_cmpuint(mt->prop1, ==, PROP_DEFAULT);
	82	}
	83
2177801a EH	84	static void test_static_prop(void)
	85	{
	86	g_test_trap_subprocess("/qdev/properties/static/default/subprocess", 0, 0);
	87	g_test_trap_assert_passed();
	88	g_test_trap_assert_stderr("");
	89	g_test_trap_assert_stdout("");
	90	}
	91
e6add65b MAL	92	static void register_global_properties(GlobalProperty *props)
	93	{
	94	int i;
	95
	96	for (i = 0; props[i].driver != NULL; i++) {
	97	qdev_prop_register_global(props + i);
	98	}
	99	}
	100
	101
747b0cb4	102	/* Test setting of static property using global properties */
2177801a	103	static void test_static_globalprop_subprocess(void)
747b0cb4 EH	104	{
	105	MyType *mt;
	106	static GlobalProperty props[] = {
	107	{ TYPE_STATIC_PROPS, "prop1", "200" },
	108	{}
	109	};
	110
e6add65b	111	register_global_properties(props);
747b0cb4 EH	112
	113	mt = STATIC_TYPE(object_new(TYPE_STATIC_PROPS));
	114	qdev_init_nofail(DEVICE(mt));
	115
	116	g_assert_cmpuint(mt->prop1, ==, 200);
	117	g_assert_cmpuint(mt->prop2, ==, PROP_DEFAULT);
	118	}
	119
2177801a EH	120	static void test_static_globalprop(void)
	121	{
	122	g_test_trap_subprocess("/qdev/properties/static/global/subprocess", 0, 0);
	123	g_test_trap_assert_passed();
	124	g_test_trap_assert_stderr("");
	125	g_test_trap_assert_stdout("");
	126	}
	127
99a0b036 EH	128	#define TYPE_DYNAMIC_PROPS "dynamic-prop-type"
	129	#define DYNAMIC_TYPE(obj) \
	130	OBJECT_CHECK(MyType, (obj), TYPE_DYNAMIC_PROPS)
	131
08ac80cd EH	132	#define TYPE_UNUSED_HOTPLUG "hotplug-type"
	133	#define TYPE_UNUSED_NOHOTPLUG "nohotplug-type"
	134
d7bce999 EB	135	static void prop1_accessor(Object obj, Visitor v, const char *name,
d7bce999 EB	136	void opaque, Error *errp)
99a0b036 EH	137	{
	138	MyType *mt = DYNAMIC_TYPE(obj);
	139
51e72bc1	140	visit_type_uint32(v, name, &mt->prop1, errp);
99a0b036 EH	141	}
99a0b036 EH	142
d7bce999 EB	143	static void prop2_accessor(Object obj, Visitor v, const char *name,
d7bce999 EB	144	void opaque, Error *errp)
99a0b036 EH	145	{
	146	MyType *mt = DYNAMIC_TYPE(obj);
	147
51e72bc1	148	visit_type_uint32(v, name, &mt->prop2, errp);
99a0b036 EH	149	}
	150
	151	static void dynamic_instance_init(Object *obj)
	152	{
	153	object_property_add(obj, "prop1", "uint32", prop1_accessor, prop1_accessor,
	154	NULL, NULL, NULL);
	155	object_property_add(obj, "prop2", "uint32", prop2_accessor, prop2_accessor,
	156	NULL, NULL, NULL);
	157	}
	158
	159	static void dynamic_class_init(ObjectClass oc, void data)
	160	{
	161	DeviceClass *dc = DEVICE_CLASS(oc);
	162
	163	dc->realize = NULL;
	164	}
	165
	166
	167	static const TypeInfo dynamic_prop_type = {
	168	.name = TYPE_DYNAMIC_PROPS,
	169	.parent = TYPE_DEVICE,
	170	.instance_size = sizeof(MyType),
	171	.instance_init = dynamic_instance_init,
	172	.class_init = dynamic_class_init,
	173	};
	174
08ac80cd EH	175	static void hotplug_class_init(ObjectClass oc, void data)
	176	{
	177	DeviceClass *dc = DEVICE_CLASS(oc);
	178
	179	dc->realize = NULL;
	180	dc->hotpluggable = true;
	181	}
	182
	183	static const TypeInfo hotplug_type = {
	184	.name = TYPE_UNUSED_HOTPLUG,
	185	.parent = TYPE_DEVICE,
	186	.instance_size = sizeof(MyType),
	187	.instance_init = dynamic_instance_init,
	188	.class_init = hotplug_class_init,
	189	};
	190
	191	static void nohotplug_class_init(ObjectClass oc, void data)
	192	{
	193	DeviceClass *dc = DEVICE_CLASS(oc);
	194
	195	dc->realize = NULL;
	196	dc->hotpluggable = false;
	197	}
	198
	199	static const TypeInfo nohotplug_type = {
	200	.name = TYPE_UNUSED_NOHOTPLUG,
	201	.parent = TYPE_DEVICE,
	202	.instance_size = sizeof(MyType),
	203	.instance_init = dynamic_instance_init,
	204	.class_init = nohotplug_class_init,
	205	};
	206
	207	#define TYPE_NONDEVICE "nondevice-type"
	208
	209	static const TypeInfo nondevice_type = {
	210	.name = TYPE_NONDEVICE,
	211	.parent = TYPE_OBJECT,
	212	};
	213
70e98b23	214	/* Test setting of dynamic properties using global properties */
2177801a	215	static void test_dynamic_globalprop_subprocess(void)
99a0b036 EH	216	{
	217	MyType *mt;
	218	static GlobalProperty props[] = {
55df8e1a MAL	219	{ TYPE_DYNAMIC_PROPS, "prop1", "101", },
	220	{ TYPE_DYNAMIC_PROPS, "prop2", "102", },
	221	{ TYPE_DYNAMIC_PROPS"-bad", "prop3", "103", },
	222	{ TYPE_UNUSED_HOTPLUG, "prop4", "104", },
	223	{ TYPE_UNUSED_NOHOTPLUG, "prop5", "105", },
	224	{ TYPE_NONDEVICE, "prop6", "106", },
99a0b036 EH	225	{}
99a0b036 EH	226	};
ef240523	227	int global_error;
99a0b036	228
e6add65b	229	register_global_properties(props);
99a0b036 EH	230
	231	mt = DYNAMIC_TYPE(object_new(TYPE_DYNAMIC_PROPS));
	232	qdev_init_nofail(DEVICE(mt));
	233
	234	g_assert_cmpuint(mt->prop1, ==, 101);
	235	g_assert_cmpuint(mt->prop2, ==, 102);
ef240523 MAL	236	global_error = qdev_prop_check_globals();
ef240523 MAL	237	g_assert_cmpuint(global_error, ==, 1);
b3ce84fe EH	238	g_assert(props[0].used);
	239	g_assert(props[1].used);
	240	g_assert(!props[2].used);
	241	g_assert(!props[3].used);
	242	g_assert(!props[4].used);
	243	g_assert(!props[5].used);
99a0b036 EH	244	}
99a0b036 EH	245
2177801a EH	246	static void test_dynamic_globalprop(void)
	247	{
	248	g_test_trap_subprocess("/qdev/properties/dynamic/global/subprocess", 0, 0);
	249	g_test_trap_assert_passed();
	250	g_test_trap_assert_stderr_unmatched("prop1");
	251	g_test_trap_assert_stderr_unmatched("prop2");
3dc6f869	252	g_test_trap_assert_stderr("warning: global dynamic-prop-type-bad.prop3 has invalid class name\n");
08ac80cd	253	g_test_trap_assert_stderr_unmatched("prop4");
3dc6f869 AF	254	g_test_trap_assert_stderr("warning: global nohotplug-type.prop5=105 not used\n");
3dc6f869 AF	255	g_test_trap_assert_stderr("warning: global nondevice-type.prop6 has invalid class name\n");
b3ce84fe EH	256	g_test_trap_assert_stdout("");
	257	}
	258
3caca555 EH	259	/* Test if global props affecting subclasses are applied in the right order */
	260	static void test_subclass_global_props(void)
	261	{
	262	MyType *mt;
	263	/* Global properties must be applied in the order they were registered */
	264	static GlobalProperty props[] = {
	265	{ TYPE_STATIC_PROPS, "prop1", "101" },
	266	{ TYPE_SUBCLASS, "prop1", "102" },
	267	{ TYPE_SUBCLASS, "prop2", "103" },
	268	{ TYPE_STATIC_PROPS, "prop2", "104" },
	269	{}
	270	};
	271
e6add65b	272	register_global_properties(props);
3caca555 EH	273
	274	mt = STATIC_TYPE(object_new(TYPE_SUBCLASS));
	275	qdev_init_nofail(DEVICE(mt));
	276
	277	g_assert_cmpuint(mt->prop1, ==, 102);
	278	g_assert_cmpuint(mt->prop2, ==, 104);
	279	}
	280
747b0cb4 EH	281	int main(int argc, char **argv)
	282	{
	283	g_test_init(&argc, &argv, NULL);
	284
	285	module_call_init(MODULE_INIT_QOM);
	286	type_register_static(&static_prop_type);
3caca555	287	type_register_static(&subclass_type);
99a0b036	288	type_register_static(&dynamic_prop_type);
08ac80cd EH	289	type_register_static(&hotplug_type);
	290	type_register_static(&nohotplug_type);
	291	type_register_static(&nondevice_type);
747b0cb4	292
2177801a EH	293	g_test_add_func("/qdev/properties/static/default/subprocess",
	294	test_static_prop_subprocess);
	295	g_test_add_func("/qdev/properties/static/default",
	296	test_static_prop);
	297
	298	g_test_add_func("/qdev/properties/static/global/subprocess",
	299	test_static_globalprop_subprocess);
	300	g_test_add_func("/qdev/properties/static/global",
	301	test_static_globalprop);
	302
	303	g_test_add_func("/qdev/properties/dynamic/global/subprocess",
	304	test_dynamic_globalprop_subprocess);
	305	g_test_add_func("/qdev/properties/dynamic/global",
	306	test_dynamic_globalprop);
747b0cb4	307
3caca555 EH	308	g_test_add_func("/qdev/properties/global/subclass",
	309	test_subclass_global_props);
	310
747b0cb4 EH	311	g_test_run();
	312
	313	return 0;
	314	}