Re: [Qemu-devel] [PATCH 16/17] RFC: qdict: add uint

[Markus Armbruster]

Marc-André Lureau <address@hidden> writes:

> Similar to int support, add uint support.
>
> Note this is RFC because this is currently unused in qemu, I haven't
> found a good user for it yet (kaslr qemu-ga code did use it though).
>
> Signed-off-by: Marc-André Lureau <address@hidden>

Do we think future use is reasonably likely?  If yes, let's stop
worrying and take the patch.

> ---
>  include/qapi/qmp/qdict.h |  5 +++++
>  qobject/qdict.c          | 38 ++++++++++++++++++++++++++++++++++++++
>  tests/check-qdict.c      | 32 ++++++++++++++++++++++++++++++++
>  3 files changed, 75 insertions(+)
>
> diff --git a/include/qapi/qmp/qdict.h b/include/qapi/qmp/qdict.h
> index 363e431106..8c7c2b762b 100644
> --- a/include/qapi/qmp/qdict.h
> +++ b/include/qapi/qmp/qdict.h
> @@ -56,6 +56,8 @@ void qdict_destroy_obj(QObject *obj);
>  /* Helpers for int, bool, and string */
>  #define qdict_put_int(qdict, key, value) \
>          qdict_put(qdict, key, qnum_from_int(value))
> +#define qdict_put_uint(qdict, key, value)        \
> +        qdict_put(qdict, key, qnum_from_uint(value))
>  #define qdict_put_bool(qdict, key, value) \
>          qdict_put(qdict, key, qbool_from_bool(value))
>  #define qdict_put_str(qdict, key, value) \
> @@ -64,12 +66,15 @@ void qdict_destroy_obj(QObject *obj);
>  /* High level helpers */
>  double qdict_get_double(const QDict *qdict, const char *key);
>  int64_t qdict_get_int(const QDict *qdict, const char *key);
> +uint64_t qdict_get_uint(const QDict *qdict, const char *key);
>  bool qdict_get_bool(const QDict *qdict, const char *key);
>  QList *qdict_get_qlist(const QDict *qdict, const char *key);
>  QDict *qdict_get_qdict(const QDict *qdict, const char *key);
>  const char *qdict_get_str(const QDict *qdict, const char *key);
>  int64_t qdict_get_try_int(const QDict *qdict, const char *key,
>                            int64_t def_value);
> +uint64_t qdict_get_try_uint(const QDict *qdict, const char *key,
> +                            uint64_t def_value);
>  bool qdict_get_try_bool(const QDict *qdict, const char *key, bool def_value);
>  const char *qdict_get_try_str(const QDict *qdict, const char *key);
>  
> diff --git a/qobject/qdict.c b/qobject/qdict.c
> index ad5bab9572..34478fbdd4 100644
> --- a/qobject/qdict.c
> +++ b/qobject/qdict.c
> @@ -202,6 +202,19 @@ int64_t qdict_get_int(const QDict *qdict, const char 
> *key)
>  }
>  
>  /**
> + * qdict_get_uint(): Get an unsigned integer mapped by 'key'
> + *
> + * This function assumes that 'key' exists and it stores a
> + * QNum int object.
> + *
> + * Return unsigned integer mapped by 'key'.
> + */
> +uint64_t qdict_get_uint(const QDict *qdict, const char *key)
> +{
> +    return qnum_get_uint(qobject_to_qnum(qdict_get(qdict, key)), 
> &error_abort);
> +}
> +
> +/**
>   * qdict_get_bool(): Get a bool mapped by 'key'
>   *
>   * This function assumes that 'key' exists and it stores a
> @@ -270,6 +283,31 @@ int64_t qdict_get_try_int(const QDict *qdict, const char 
> *key,
>  }
>  
>  /**
> + * qdict_get_try_uint(): Try to get usigned integer mapped by 'key'
> + *
> + * Return unsigned integer mapped by 'key', if it is not present in
> + * the dictionary or if the stored object is not of QNum type
> + * 'def_value' will be returned.
> + */
> +uint64_t qdict_get_try_uint(const QDict *qdict, const char *key,
> +                            uint64_t def_value)
> +{
> +    Error *err = NULL;
> +    QNum *qnum = qobject_to_qnum(qdict_get(qdict, key));
> +    uint64_t val = def_value;
> +
> +    if (qnum) {
> +        val = qnum_get_uint(qnum, &err);
> +    }
> +    if (err) {
> +        error_free(err);
> +        val = def_value;
> +    }
> +
> +    return val;
> +}
> +
> +/**
>   * qdict_get_try_bool(): Try to get a bool mapped by 'key'
>   *
>   * Return bool mapped by 'key', if it is not present in the
> diff --git a/tests/check-qdict.c b/tests/check-qdict.c
> index bcd06a7d6b..7f9ea67862 100644
> --- a/tests/check-qdict.c
> +++ b/tests/check-qdict.c
> @@ -105,6 +105,21 @@ static void qdict_get_int_test(void)
>      QDECREF(tests_dict);
>  }
>  
> +static void qdict_get_uint_test(void)
> +{
> +    uint64_t ret;
> +    const uint64_t value = UINT64_MAX;
> +    const char *key = "uint";
> +    QDict *tests_dict = qdict_new();
> +
> +    qdict_put_uint(tests_dict, key, value);
> +
> +    ret = qdict_get_uint(tests_dict, key);
> +    g_assert(ret == value);
> +
> +    QDECREF(tests_dict);
> +}
> +
>  static void qdict_get_try_int_test(void)
>  {
>      int ret;
> @@ -120,6 +135,21 @@ static void qdict_get_try_int_test(void)
>      QDECREF(tests_dict);
>  }
>  
> +static void qdict_get_try_uint_test(void)
> +{
> +    uint64_t ret;
> +    const uint64_t value = UINT64_MAX;
> +    const char *key = "uint";
> +    QDict *tests_dict = qdict_new();
> +
> +    qdict_put_uint(tests_dict, key, value);
> +
> +    ret = qdict_get_try_uint(tests_dict, key, 0);
> +    g_assert(ret == value);
> +
> +    QDECREF(tests_dict);
> +}
> +

Just as spotty as its signed buddy.  Both should at least also test
cases "key is not in dict" and "key maps to a value that isn't QNum".

>  static void qdict_get_str_test(void)
>  {
>      const char *p;
> @@ -852,7 +882,9 @@ int main(int argc, char **argv)
>      /* Continue, but now with fixtures */
>      g_test_add_func("/public/get", qdict_get_test);
>      g_test_add_func("/public/get_int", qdict_get_int_test);
> +    g_test_add_func("/public/get_uint", qdict_get_uint_test);
>      g_test_add_func("/public/get_try_int", qdict_get_try_int_test);
> +    g_test_add_func("/public/get_try_uint", qdict_get_try_uint_test);
>      g_test_add_func("/public/get_str", qdict_get_str_test);
>      g_test_add_func("/public/get_try_str", qdict_get_try_str_test);
>      g_test_add_func("/public/defaults", qdict_defaults_test);