[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 06/17] qom: Clean up object_property_get_enum()'s error value
From: |
Eduardo Habkost |
Subject: |
[PULL 06/17] qom: Clean up object_property_get_enum()'s error value |
Date: |
Fri, 18 Sep 2020 16:47:03 -0400 |
From: Markus Armbruster <armbru@redhat.com>
object_property_get_enum() is the only object_property_FOO() that is
documented to return an undefined value on error. It does no such
thing, actually: it returns 0 on some errors, and -1 on others.
Needlessly complicated. Always return -1 on error, and adjust the
contract.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Greg Kurz <groug@kaod.org>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Message-Id: <20200917125540.597786-2-armbru@redhat.com>
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
include/qom/object.h | 6 +++---
qom/object.c | 6 +++---
tests/check-qom-proplist.c | 2 ++
3 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/include/qom/object.h b/include/qom/object.h
index 6c0d424b51..494827b4d1 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -1687,9 +1687,9 @@ uint64_t object_property_get_uint(Object *obj, const char
*name,
* @typename: the name of the enum data type
* @errp: returns an error if this function fails
*
- * Returns: the value of the property, converted to an integer, or
- * undefined if an error occurs (including when the property value is not
- * an enum).
+ * Returns: the value of the property, converted to an integer (which
+ * can't be negative), or -1 on error (including when the property
+ * value is not an enum).
*/
int object_property_get_enum(Object *obj, const char *name,
const char *typename, Error **errp);
diff --git a/qom/object.c b/qom/object.c
index 387efb25eb..cecad35b99 100644
--- a/qom/object.c
+++ b/qom/object.c
@@ -1564,21 +1564,21 @@ int object_property_get_enum(Object *obj, const char
*name,
EnumProperty *enumprop;
if (prop == NULL) {
- return 0;
+ return -1;
}
if (!g_str_equal(prop->type, typename)) {
error_setg(errp, "Property %s on %s is not '%s' enum type",
name, object_class_get_name(
object_get_class(obj)), typename);
- return 0;
+ return -1;
}
enumprop = prop->opaque;
str = object_property_get_str(obj, name, errp);
if (!str) {
- return 0;
+ return -1;
}
ret = qapi_enum_parse(enumprop->lookup, str, -1, errp);
diff --git a/tests/check-qom-proplist.c b/tests/check-qom-proplist.c
index 1571606c1c..1b76581980 100644
--- a/tests/check-qom-proplist.c
+++ b/tests/check-qom-proplist.c
@@ -491,6 +491,7 @@ static void test_dummy_getenum(void)
"av",
"BadAnimal",
&err);
+ g_assert(val == -1);
error_free_or_abort(&err);
/* A non-enum property name */
@@ -498,6 +499,7 @@ static void test_dummy_getenum(void)
"iv",
"DummyAnimal",
&err);
+ g_assert(val == -1);
error_free_or_abort(&err);
object_unparent(OBJECT(dobj));
--
2.26.2
- [PULL 00/17] QOM queue, 2020-09-18, Eduardo Habkost, 2020/09/18
- [PULL 04/17] sifive: Use DECLARE_*CHECKER* macros, Eduardo Habkost, 2020/09/18
- [PULL 02/17] sifive_u: Rename memmap enum constants, Eduardo Habkost, 2020/09/18
- [PULL 05/17] qom: Correct object_class_dynamic_cast_assert() documentation, Eduardo Habkost, 2020/09/18
- [PULL 01/17] sifive_e: Rename memmap enum constants, Eduardo Habkost, 2020/09/18
- [PULL 08/17] qom: Allow objects to be allocated with increased alignment, Eduardo Habkost, 2020/09/18
- [PULL 10/17] target/ppc: Set instance_align on PowerPCCPU TypeInfo, Eduardo Habkost, 2020/09/18
- [PULL 03/17] sifive: Move QOM typedefs and add missing includes, Eduardo Habkost, 2020/09/18
- [PULL 07/17] qom: Correct error values in two contracts, Eduardo Habkost, 2020/09/18
- [PULL 06/17] qom: Clean up object_property_get_enum()'s error value,
Eduardo Habkost <=
- [PULL 14/17] qom: Remove ParentClassType argument from OBJECT_DECLARE_SIMPLE_TYPE, Eduardo Habkost, 2020/09/18
- [PULL 11/17] target/riscv: Set instance_align on RISCVCPU TypeInfo, Eduardo Habkost, 2020/09/18
- [PULL 09/17] target/arm: Set instance_align on CPUARM TypeInfo, Eduardo Habkost, 2020/09/18
- [PULL 12/17] target/s390x: Set instance_align on S390CPU TypeInfo, Eduardo Habkost, 2020/09/18
- [PULL 13/17] scripts/codeconverter: Update to latest version, Eduardo Habkost, 2020/09/18
- [PULL 15/17] qom: Remove module_obj_name parameter from OBJECT_DECLARE* macros, Eduardo Habkost, 2020/09/18
- [PULL 16/17] Use OBJECT_DECLARE_TYPE when possible, Eduardo Habkost, 2020/09/18
- [PULL 17/17] Use OBJECT_DECLARE_SIMPLE_TYPE when possible, Eduardo Habkost, 2020/09/18
- Re: [PULL 00/17] QOM queue, 2020-09-18, no-reply, 2020/09/18
- Re: [PULL 00/17] QOM queue, 2020-09-18, no-reply, 2020/09/18