Avoid abort on QMP attempt to add an object with duplicate id
v4 cover Avoid abort on QMP attempt to add an object with duplicate id
Attempting to add an object through QMP with an id that is already used leads to a qemu abort. This is a regression since d2623129a7de ("qom: Drop parameter @errp of object_property_add() & friends").
The first patch fixes the issue and the second patch adds a test to check the error is gracefully returned to the QMP client.
The last patch can be considered independently. It merges all the object-add tests into a single test function and cover new failure cases.
Best Regards
Eric
This series can be found at:
https://github.com/eauger/qemu/tree/qom-graceful-v4
History:
- v3 -> v4:
- addressed style comment from Markus
- added patch 3
- v2 -> v3:
- don't take the object reference on failure in object_property_try_add_child
- add g_assert_nonnull(resp) in 2/2 while keeping Thomas A-b
- v1 -> v2:
- use the try terminology.
- turn object_property_try_add() into a non-static function
- add the test
Eric Auger (3):
qom: Introduce object_property_try_add_child() tests/qmp-cmd-test: Add qmp/object-add-duplicate-id tests/qmp-cmd-test: Add qmp/object-add-failure-modes
include/qom/object.h | 26 +++++++++- qom/object.c | 21 ++++++-- qom/object_interfaces.c | 7 ++- tests/qtest/qmp-cmd-test.c | 99 ++++++++++++++++++++++++++++++++++++-- 4 files changed, 140 insertions(+), 13 deletions(-)
Signature · 1 line
2.20.1
PATCH v4 1/3 qom: Introduce object_property_try_add_child()
object_property_add() does not allow object_property_try_add() to gracefully fail as &error_abort is passed as an error handle.
However such failure can easily be triggered from the QMP shell when, for instance, one attempts to create an object with an id that already exists. This is achieved from the following call path:
qmp_object_add -> user_creatable_add_dict -> user_creatable_add_type -> object_property_add_child -> object_property_add
For instance, from the qmp-shell, call twice:
object-add qom-type=memory-backend-ram id=mem1 props.size=1073741824 and QEMU aborts.
This behavior is undesired as a user/management application mistake in reusing a property ID shouldn't result in loss of the VM and live data within.
This patch introduces a new function, object_property_try_add_child() which takes an error handle and turn object_property_try_add() into a non-static one.
Now the call path becomes:
user_creatable_add_type -> object_property_try_add_child -> object_property_try_add
and the error is returned gracefully to the QMP client.
(QEMU) object-add qom-type=memory-backend-ram id=mem2 props.size=4294967296 {"return": {}}
(QEMU) object-add qom-type=memory-backend-ram id=mem2 props.size=4294967296 {"error": {"class": "GenericError", "desc": "attempt to add duplicate property 'mem2' to object (type 'container')"}}
---
v3 -> v4:
- Took into account Markus' style related comments
v2 -> v3:
- don't take the object reference on failure in
object_property_try_add_child
--- include/qom/object.h | 26 ++++++++++++++++++++++++-- qom/object.c | 21 ++++++++++++++++----- qom/object_interfaces.c | 7 +++++-- 3 files changed, 45 insertions(+), 9 deletions(-)
include/qom/object.h +24 -2
@@ -1039,7 +1039,7 @@ Object *object_ref(Object *obj);void object_unref (Object *obj);/** -* object_property_add: +* object_property_try_add: * @obj: the object to add a property to * @name: the name of the property. This can contain any character except for * a forward slash. In general, you should use hyphens '-' instead of
@@ -1056,10 +1056,23 @@ void object_unref(Object *obj);* meant to allow a property to free its opaque upon object * destruction. This may be NULL. * @opaque: an opaque pointer to pass to the callbacks for the property +* @errp: pointer to error object * * Returns: The #ObjectProperty; this can be used to set the @resolve * callback for child and link properties. */ +ObjectProperty *object_property_try_add (Object *obj,const char *name, +const char *type, +ObjectPropertyAccessor *get, +ObjectPropertyAccessor *set, +ObjectPropertyRelease *release, +void *opaque,Error **errp); + +/** +* object_property_add: +* Same as object_property_try_add() with @errp hardcoded to +* &error_abort. +*/ ObjectProperty *object_property_add(Object *obj, const char *name, const char *type, ObjectPropertyAccessor *get,
@@ -1495,10 +1508,11 @@ Object *object_resolve_path_type(const char *path, const char *typename,Object *object_resolve_path_component (Object *parent,const char *part);/** -* object_property_add_child: +* object_property_try_add_child: * @obj: the object to add a property to * @name: the name of the property * @child: the child object +* @errp: pointer to error object * * Child properties form the composition tree. All objects need to be a child * of another object. Objects can only be a child of one object.
@@ -1512,6 +1526,14 @@ Object *object_resolve_path_component(Object *parent, const char *part);* * Returns: The newly added property on success, or %NULL on failure. */ +ObjectProperty *object_property_try_add_child (Object *obj,const char *name, +Object *child,Error **errp); + +/** +* object_property_add_child: +* Same as object_property_try_add_child() with @errp hardcoded to +* &error_abort +*/ ObjectProperty *object_property_add_child (Object *obj,const char *name,Object *child);
qom/object.c +16 -5
@@ -1132,7 +1132,7 @@ void object_unref(Object *obj) } } -static ObjectProperty * +ObjectProperty * object_property_try_add(Object *obj, const char *name, const char *type, ObjectPropertyAccessor *get, ObjectPropertyAccessor *set,
@@ -1651,8 +1651,8 @@ static void object_finalize_child_property(Object *obj, const char *name, }ObjectProperty * -object_property_add_child (Object *obj,const char *name, -Object *child) +object_property_try_add_child (Object *obj,const char *name, +Object *child,Error **errp) { g_autofree char *type = NULL;ObjectProperty *op;
@@ -1661,14 +1661,25 @@ object_property_add_child(Object *obj, const char *name, type =g_strdup_printf ("child<%s>" ,object_get_typename (child)); - op =object_property_add (obj, name, type, object_get_child_property,NULL , - object_finalize_child_property, child); + op =object_property_try_add (obj, name, type, object_get_child_property, +NULL , object_finalize_child_property, + child, errp); +if (!op) { +return NULL ; + } op->resolve = object_resolve_child_property;object_ref (child); child->parent = obj;return op; } +ObjectProperty * +object_property_add_child (Object *obj,const char *name, +Object *child) +{ +return object_property_try_add_child (obj, name, child, &error_abort); +} +void object_property_allow_set_link (const Object *obj,const char *name,Object *val,Error **errp) {
qom/object_interfaces.c +5 -2
@@ -82,8 +82,11 @@ Object *user_creatable_add_type(const char *type, const char *id, }if (id !=NULL ) { -object_property_add_child (object_get_objects_root (), - id, obj); +object_property_try_add_child (object_get_objects_root (), + id, obj, &local_err); +if (local_err) { + goto out; + } }user_creatable_complete (USER_CREATABLE (obj), &local_err);
Signature · 1 line
2.20.1
PATCH v4 2/3 tests/qmp-cmd-test: Add qmp/object-add-duplicate-id
In reply to Eric AugerThis new test checks that attempting to create an object with an existing ID gracefully fails.
--- tests/qtest/qmp-cmd-test.c | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+)
tests/qtest/qmp-cmd-test.c +19 -0
@@ -213,6 +213,23 @@ static void test_object_add_without_props(void)qtest_quit (qts); } +static void test_object_add_with_duplicate_id (void ) +{ +QTestState *qts; +QDict *resp; + + qts =qtest_init (common_args); + resp =qtest_qmp (qts,"{'execute': 'object-add', 'arguments':" +" {'qom-type': 'memory-backend-ram', 'id': 'ram1', 'props': {'size': 4294967296 } } }" ); +g_assert_nonnull (resp); +g_assert (qdict_haskey (resp,"return" )); + resp =qtest_qmp (qts,"{'execute': 'object-add', 'arguments':" +" {'qom-type': 'memory-backend-ram', 'id': 'ram1', 'props': {'size': 4294967296 } } }" ); +g_assert_nonnull (resp); +qmp_assert_error_class (resp,"GenericError" ); +qtest_quit (qts); +} +int main (int argc,char *argv[]) {QmpSchema schema;
@@ -225,6 +242,8 @@ int main(int argc, char *argv[])qtest_add_func ("qmp/object-add-without-props" , test_object_add_without_props); +qtest_add_func ("qmp/object-add-duplicate-id" , + test_object_add_with_duplicate_id);/* TODO: add coverage of generic object-add failure modes */ ret =g_test_run ();
Signature · 1 line
2.20.1
PATCH v4 3/3 tests/qmp-cmd-test: Add qmp/object-add-failure-modes
In reply to Eric AugerMerge the existing object-add test cases into a single test functions and cover more failure cases.
--- tests/qtest/qmp-cmd-test.c | 98 +++++++++++++++++++++++++++++++++----- 1 file changed, 85 insertions(+), 13 deletions(-)
tests/qtest/qmp-cmd-test.c +85 -13
@@ -200,25 +200,31 @@ static void add_query_tests(QmpSchema *schema) } } -static void test_object_add_without_props (void ) +static void test_object_add_failure_modes (void ) {QTestState *qts;QDict *resp; +/* attempt to create an object without props */ qts =qtest_init (common_args); resp =qtest_qmp (qts,"{'execute': 'object-add', 'arguments':" " {'qom-type': 'memory-backend-ram', 'id': 'ram1' } }" );g_assert_nonnull (resp);qmp_assert_error_class (resp,"GenericError" ); -qtest_quit (qts); -} -static void test_object_add_with_duplicate_id (void ) -{ -QTestState *qts; -QDict *resp; +/* attempt to create an object without qom-type */ + resp =qtest_qmp (qts,"{'execute': 'object-add', 'arguments':" +" {'id': 'ram1' } }" ); +g_assert_nonnull (resp); +qmp_assert_error_class (resp,"GenericError" ); - qts =qtest_init (common_args); +/* attempt to delete an object that does not exist */ + resp =qtest_qmp (qts,"{'execute': 'object-del', 'arguments':" +" {'id': 'ram1' } }" ); +g_assert_nonnull (resp); +qmp_assert_error_class (resp,"GenericError" ); + +/* attempt to create 2 objects with duplicate id */ resp =qtest_qmp (qts,"{'execute': 'object-add', 'arguments':" " {'qom-type': 'memory-backend-ram', 'id': 'ram1', 'props': {'size': 4294967296 } } }" );g_assert_nonnull (resp);
@@ -227,6 +233,75 @@ static void test_object_add_with_duplicate_id(void) " {'qom-type': 'memory-backend-ram', 'id': 'ram1', 'props': {'size': 4294967296 } } }");g_assert_nonnull (resp);qmp_assert_error_class (resp,"GenericError" ); + +/* delete ram1 object */ + resp =qtest_qmp (qts,"{'execute': 'object-del', 'arguments':" +" {'id': 'ram1' } }" ); +g_assert_nonnull (resp); +g_assert (qdict_haskey (resp,"return" )); + +/* attempt to create an object with a property of a wrong type */ + resp =qtest_qmp (qts,"{'execute': 'object-add', 'arguments':" +" {'qom-type': 'memory-backend-ram', 'id': 'ram1', 'props': {'size': '4294967296' } } }" ); +g_assert_nonnull (resp); +/* now do it right */ +qmp_assert_error_class (resp,"GenericError" ); + resp =qtest_qmp (qts,"{'execute': 'object-add', 'arguments':" +" {'qom-type': 'memory-backend-ram', 'id': 'ram1', 'props': {'size': 4294967296 } } }" ); +g_assert_nonnull (resp); +g_assert (qdict_haskey (resp,"return" )); + +/* delete ram1 object */ + resp =qtest_qmp (qts,"{'execute': 'object-del', 'arguments':" +" {'id': 'ram1' } }" ); +g_assert_nonnull (resp); +g_assert (qdict_haskey (resp,"return" )); + +/* attempt to create an object without the id */ + resp =qtest_qmp (qts,"{'execute': 'object-add', 'arguments':" +" {'qom-type': 'memory-backend-ram', 'props': {'size': '4294967296' } } }" ); +g_assert_nonnull (resp); +qmp_assert_error_class (resp,"GenericError" ); +/* now do it right */ + resp =qtest_qmp (qts,"{'execute': 'object-add', 'arguments':" +" {'qom-type': 'memory-backend-ram', 'id': 'ram1', 'props': {'size': 4294967296 } } }" ); +g_assert_nonnull (resp); +g_assert (qdict_haskey (resp,"return" )); + +/* delete ram1 object */ + resp =qtest_qmp (qts,"{'execute': 'object-del', 'arguments':" +" {'id': 'ram1' } }" ); +g_assert_nonnull (resp); +g_assert (qdict_haskey (resp,"return" )); + +/* attempt to set a non existing property */ + resp =qtest_qmp (qts,"{'execute': 'object-add', 'arguments':" +" {'qom-type': 'memory-backend-ram', 'id': 'ram1', 'props': {'sized': 4294967296 } } }" ); +g_assert_nonnull (resp); +qmp_assert_error_class (resp,"GenericError" ); +/* now do it right */ + resp =qtest_qmp (qts,"{'execute': 'object-add', 'arguments':" +" {'qom-type': 'memory-backend-ram', 'id': 'ram1', 'props': {'size': 4294967296 } } }" ); +g_assert_nonnull (resp); +g_assert (qdict_haskey (resp,"return" )); + +/* delete ram1 object without id */ + resp =qtest_qmp (qts,"{'execute': 'object-del', 'arguments':" +" {'ida': 'ram1' } }" ); +g_assert_nonnull (resp); + +/* delete ram1 object */ + resp =qtest_qmp (qts,"{'execute': 'object-del', 'arguments':" +" {'id': 'ram1' } }" ); +g_assert_nonnull (resp); +g_assert (qdict_haskey (resp,"return" )); + +/* delete ram1 object that does not exist anymore*/ + resp =qtest_qmp (qts,"{'execute': 'object-del', 'arguments':" +" {'id': 'ram1' } }" ); +g_assert_nonnull (resp); +qmp_assert_error_class (resp,"GenericError" ); +qtest_quit (qts); }
@@ -240,11 +315,8 @@ int main(int argc, char *argv[])qmp_schema_init (&schema);add_query_tests (&schema); -qtest_add_func ("qmp/object-add-without-props" , - test_object_add_without_props); -qtest_add_func ("qmp/object-add-duplicate-id" , - test_object_add_with_duplicate_id); -/* TODO: add coverage of generic object-add failure modes */ +qtest_add_func ("qmp/object-add-failure-modes" , + test_object_add_failure_modes); ret =g_test_run ();
Signature · 1 line
2.20.1
Patchew URL: https://patchew.org/QEMU/[email protected]/
Patchew URL: https://patchew.org/QEMU/[email protected]/
Hi,
This series failed the docker-quick@centos7 build test. Please find the testing commands and their output below. If you have Docker installed, you can probably reproduce it locally.
=== TEST SCRIPT BEGIN ===
#!/bin/bash
make docker-image-centos7 V=1 NETWORK=1
time make docker-test-quick@centos7 SHOW_ENV=1 J=14 NETWORK=1 === TEST SCRIPT END ===
qemu-system-x86_64: falling back to tcg
TEST iotest-qcow2: 154
**
ERROR:/tmp/qemu-test/src/tests/qtest/qmp-cmd-test.c:231:test_object_add_failure_modes: assertion failed: (qdict_haskey(resp, "return")) ERROR - Bail out! ERROR:/tmp/qemu-test/src/tests/qtest/qmp-cmd-test.c:231:test_object_add_failure_modes: assertion failed: (qdict_haskey(resp, "return"))
make: *** [check-qtest-aarch64] Error 1
make: *** Waiting for unfinished jobs....
TEST iotest-qcow2: 156
TEST iotest-qcow2: 158
---
TEST iotest-qcow2: 177
TEST iotest-qcow2: 179
**
ERROR:/tmp/qemu-test/src/tests/qtest/qmp-cmd-test.c:231:test_object_add_failure_modes: assertion failed: (qdict_haskey(resp, "return")) ERROR - Bail out! ERROR:/tmp/qemu-test/src/tests/qtest/qmp-cmd-test.c:231:test_object_add_failure_modes: assertion failed: (qdict_haskey(resp, "return"))
make: *** [check-qtest-x86_64] Error 1
TEST iotest-qcow2: 181 TEST iotest-qcow2: 184 TEST iotest-qcow2: 186
---
raise CalledProcessError(retcode, cmd)
subprocess.CalledProcessError: Command '['sudo', '-n', 'docker', 'run', '--label', 'com.qemu.instance.uuid=8d9c643afafb4baa8ee26c2263f14e74', '-u', '1001', '--security-opt', 'seccomp=unconfined', '--rm', '-e', 'TARGET_LIST=', '-e', 'EXTRA_CONFIGURE_OPTS=', '-e', 'V=', '-e', 'J=14', '-e', 'DEBUG=', '-e', 'SHOW_ENV=1', '-e', 'CCACHE_DIR=/var/tmp/ccache', '-v', '/home/patchew/.cache/qemu-docker-ccache:/var/tmp/ccache:z', '-v', '/var/tmp/patchew-tester-tmp-ang__6uf/src/docker-src.2020-06-29-07.40.57.28166:/var/tmp/qemu:z,ro', 'qemu:centos7', '/var/tmp/qemu/run', 'test-quick']' returned non-zero exit status 2. filter=--filter=label=com.qemu.instance.uuid=8d9c643afafb4baa8ee26c2263f14e74
make[1]: *** [docker-run] Error 1
make[1]: Leaving directory `/var/tmp/patchew-tester-tmp-ang__6uf/src'
make: *** [docker-run-test-quick@centos7] Error 2
real 17m6.183s
user 0m9.411s
The full log is available at
http://patchew.org/logs/[email protected]/testing.docker-quick@centos7/?type=message.
---
Email generated automatically by Patchew [https://patchew.org/].
Please send your feedback to [email protected]
Quoted 41 lines · Eric Auger
Attempting to add an object through QMP with an id that is already used leads to a qemu abort. This is a regression since
d2623129a7de("qom: Drop parameter @errp ofobject_property_add()& friends").The first patch fixes the issue and the second patch adds a test to check the error is gracefully returned to the QMP client.
The last patch can be considered independently. It merges all the object-add tests into a single test function and cover new failure cases.
Best Regards
Eric
This series can be found at:
https://github.com/eauger/qemu/tree/qom-graceful-v4History:
- v3 -> v4:
- addressed style comment from Markus
- added patch 3- v2 -> v3:
- don't take the object reference on failure inobject_property_try_add_child
- addg_assert_nonnull(resp)in 2/2 while keeping Thomas A-b- v1 -> v2:
- use the try terminology.
- turnobject_property_try_add()into a non-static function
- add the testEric Auger (3):
qom: Introduceobject_property_try_add_child()tests/qmp-cmd-test: Add qmp/object-add-duplicate-id tests/qmp-cmd-test: Add qmp/object-add-failure-modes
Quoted 6 lines
include/qom/object.h | 26 +++++++++- qom/object.c | 21 ++++++-- qom/object_interfaces.c | 7 ++- tests/qtest/qmp-cmd-test.c | 99 ++++++++++++++++++++++++++++++++++++-- 4 files changed, 140 insertions(+), 13 deletions(-)
Very nice. I see a failure reported by Patchew, I'll look into it as well if you don't have time.
Paolo
Hi Paolo,
Quoted 49 lines · Paolo Bonzini
Quoted 41 lines · Eric Auger
Attempting to add an object through QMP with an id that is already used leads to a qemu abort. This is a regression since
d2623129a7de("qom: Drop parameter @errp ofobject_property_add()& friends").The first patch fixes the issue and the second patch adds a test to check the error is gracefully returned to the QMP client.
The last patch can be considered independently. It merges all the object-add tests into a single test function and cover new failure cases.
Best Regards
Eric
This series can be found at:
https://github.com/eauger/qemu/tree/qom-graceful-v4History:
- v3 -> v4:
- addressed style comment from Markus
- added patch 3- v2 -> v3:
- don't take the object reference on failure inobject_property_try_add_child
- addg_assert_nonnull(resp)in 2/2 while keeping Thomas A-b- v1 -> v2:
- use the try terminology.
- turnobject_property_try_add()into a non-static function
- add the testEric Auger (3):
qom: Introduceobject_property_try_add_child()tests/qmp-cmd-test: Add qmp/object-add-duplicate-id tests/qmp-cmd-test: Add qmp/object-add-failure-modesQuoted 6 lines
include/qom/object.h | 26 +++++++++- qom/object.c | 21 ++++++-- qom/object_interfaces.c | 7 ++- tests/qtest/qmp-cmd-test.c | 99 ++++++++++++++++++++++++++++++++++++-- 4 files changed, 140 insertions(+), 13 deletions(-)
Quoted 2 lines
Very nice. I see a failure reported by Patchew, I'll look into it as well if you don't have time.
As I reported earlier, I am no able to reproduce on my end with both
sudo time make docker-test-mingw@fedora SHOW_ENV=1 J=14 NETWORK=1 sudo time make docker-test-quick@centos7 SHOW_ENV=1 J=14 NETWORK=1
It fails on the first memory-backend-ram object-add that should be valid.
resp = qtest_qmp(qts, "{'execute': 'object-add', 'arguments':"
" {'qom-type': 'memory-backend-ram', 'id': 'ram1','props': {'size': 4294967296 } } }");
Could it be that the size is too large (4GB)?
Thanks
Eric
Quoted 4 lines
Paolo
Hi Paolo,
Quoted 49 lines · Paolo Bonzini
Quoted 41 lines · Eric Auger
Attempting to add an object through QMP with an id that is already used leads to a qemu abort. This is a regression since
d2623129a7de("qom: Drop parameter @errp ofobject_property_add()& friends").The first patch fixes the issue and the second patch adds a test to check the error is gracefully returned to the QMP client.
The last patch can be considered independently. It merges all the object-add tests into a single test function and cover new failure cases.
Best Regards
Eric
This series can be found at:
https://github.com/eauger/qemu/tree/qom-graceful-v4History:
- v3 -> v4:
- addressed style comment from Markus
- added patch 3- v2 -> v3:
- don't take the object reference on failure inobject_property_try_add_child
- addg_assert_nonnull(resp)in 2/2 while keeping Thomas A-b- v1 -> v2:
- use the try terminology.
- turnobject_property_try_add()into a non-static function
- add the testEric Auger (3):
qom: Introduceobject_property_try_add_child()tests/qmp-cmd-test: Add qmp/object-add-duplicate-id tests/qmp-cmd-test: Add qmp/object-add-failure-modesQuoted 6 lines
include/qom/object.h | 26 +++++++++- qom/object.c | 21 ++++++-- qom/object_interfaces.c | 7 ++- tests/qtest/qmp-cmd-test.c | 99 ++++++++++++++++++++++++++++++++++++-- 4 files changed, 140 insertions(+), 13 deletions(-)
Quoted 2 lines
Very nice. I see a failure reported by Patchew, I'll look into it as well if you don't have time.
So "[PATCH v5 0/3] Avoid abort on QMP attempt to add an object with duplicate id" seems to have fixed the Patchew error (I decreased the size of the memory object downto 1MB).
Thanks
Eric
Quoted 3 lines
Paolo
Quoted 6 lines · Auger Eric
Quoted 2 lines
Very nice. I see a failure reported by Patchew, I'll look into it as well if you don't have time.
So "[PATCH v5 0/3] Avoid abort on QMP attempt to add an object with duplicate id" seems to have fixed the Patchew error (I decreased the size of the memory object downto 1MB).
Great, I queued that one. Thanks.
Paolo