diff mbox

[17/24] qapi: New qobject_input_visitor_new_str() for convenience

Message ID 1488194450-28056-18-git-send-email-armbru@redhat.com
State New
Headers show

Commit Message

Markus Armbruster Feb. 27, 2017, 11:20 a.m. UTC
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 include/qapi/qobject-input-visitor.h | 12 ++++++++++++
 qapi/qobject-input-visitor.c         | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 45 insertions(+)

Comments

Kevin Wolf Feb. 28, 2017, 5:18 p.m. UTC | #1
Am 27.02.2017 um 12:20 hat Markus Armbruster geschrieben:
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  include/qapi/qobject-input-visitor.h | 12 ++++++++++++
>  qapi/qobject-input-visitor.c         | 33 +++++++++++++++++++++++++++++++++
>  2 files changed, 45 insertions(+)
> 
> diff --git a/include/qapi/qobject-input-visitor.h b/include/qapi/qobject-input-visitor.h
> index 282f9d2..b399285 100644
> --- a/include/qapi/qobject-input-visitor.h
> +++ b/include/qapi/qobject-input-visitor.h
> @@ -68,4 +68,16 @@ Visitor *qobject_input_visitor_new(QObject *obj);
>   */
>  Visitor *qobject_input_visitor_new_keyval(QObject *obj);
>  
> +/*
> + * Create a QObject input visitor for parsing @str.
> + *
> + * If @str looks like JSON, parse it as JSON, else as KEY=VALUE,...
> + * @implied_key applies to KEY=VALUE, and works as in keyval_parse().
> + * On failure, store an error through @errp and return NULL.
> + * On success, return a new QObject input visitor for the parse.
> + */
> +Visitor *qobject_input_visitor_new_str(const char *str,
> +                                       const char *implied_key,
> +                                       Error **errp);
> +
>  #endif
> diff --git a/qapi/qobject-input-visitor.c b/qapi/qobject-input-visitor.c
> index 3db5850..64a08d3 100644
> --- a/qapi/qobject-input-visitor.c
> +++ b/qapi/qobject-input-visitor.c
> @@ -18,9 +18,11 @@
>  #include "qapi/visitor-impl.h"
>  #include "qemu/queue.h"
>  #include "qemu-common.h"
> +#include "qapi/qmp/qjson.h"
>  #include "qapi/qmp/types.h"
>  #include "qapi/qmp/qerror.h"
>  #include "qemu/cutils.h"
> +#include "qemu/option.h"
>  
>  typedef struct StackObject {
>      const char *name;            /* Name of @obj in its parent, if any */
> @@ -655,3 +657,34 @@ Visitor *qobject_input_visitor_new_keyval(QObject *obj)
>  
>      return &v->visitor;
>  }
> +
> +Visitor *qobject_input_visitor_new_str(const char *str,
> +                                       const char *implied_key,
> +                                       Error **errp)
> +{
> +    bool is_json = str[0] == '{';

Should the keyval_parse() grammar just forbid { in key names then (and
ideally employ assertions to enforce this) to avoid any ambiguity here?
therwise the behaviour might depend on the order of options in a
key/value string, which could be somewhat confusing.

> +    QObject *obj;
> +    QDict *args;
> +    Visitor *v;
> +
> +    if (is_json) {
> +        obj = qobject_from_json(str, errp);
> +        if (!obj) {
> +            /* Work around qobject_from_json() lossage TODO fix that */
> +            if (errp && !*errp) {
> +                error_setg(errp, "JSON parse error");
> +                return NULL;
> +            }
> +            return NULL;
> +        }
> +        args = qobject_to_qdict(obj);
> +        assert(args);
> +        v = qobject_input_visitor_new(QOBJECT(args));
> +    } else {
> +        args = keyval_parse(optarg, implied_key, errp);
> +        v = qobject_input_visitor_new_keyval(QOBJECT(args));

If keyval_parse() fails and returns args == NULL, won't we run into the
assertion in qobject_input_visitor_base_new() now?

> +    }
> +    QDECREF(args);
> +
> +    return v;
> +}

Kevin
Kevin Wolf Feb. 28, 2017, 5:33 p.m. UTC | #2
Am 27.02.2017 um 12:20 hat Markus Armbruster geschrieben:
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  include/qapi/qobject-input-visitor.h | 12 ++++++++++++
>  qapi/qobject-input-visitor.c         | 33 +++++++++++++++++++++++++++++++++
>  2 files changed, 45 insertions(+)
> 
> diff --git a/include/qapi/qobject-input-visitor.h b/include/qapi/qobject-input-visitor.h
> index 282f9d2..b399285 100644
> --- a/include/qapi/qobject-input-visitor.h
> +++ b/include/qapi/qobject-input-visitor.h
> @@ -68,4 +68,16 @@ Visitor *qobject_input_visitor_new(QObject *obj);
>   */
>  Visitor *qobject_input_visitor_new_keyval(QObject *obj);
>  
> +/*
> + * Create a QObject input visitor for parsing @str.
> + *
> + * If @str looks like JSON, parse it as JSON, else as KEY=VALUE,...
> + * @implied_key applies to KEY=VALUE, and works as in keyval_parse().
> + * On failure, store an error through @errp and return NULL.
> + * On success, return a new QObject input visitor for the parse.
> + */
> +Visitor *qobject_input_visitor_new_str(const char *str,
> +                                       const char *implied_key,
> +                                       Error **errp);
> +
>  #endif
> diff --git a/qapi/qobject-input-visitor.c b/qapi/qobject-input-visitor.c
> index 3db5850..64a08d3 100644
> --- a/qapi/qobject-input-visitor.c
> +++ b/qapi/qobject-input-visitor.c
> @@ -18,9 +18,11 @@
>  #include "qapi/visitor-impl.h"
>  #include "qemu/queue.h"
>  #include "qemu-common.h"
> +#include "qapi/qmp/qjson.h"
>  #include "qapi/qmp/types.h"
>  #include "qapi/qmp/qerror.h"
>  #include "qemu/cutils.h"
> +#include "qemu/option.h"
>  
>  typedef struct StackObject {
>      const char *name;            /* Name of @obj in its parent, if any */
> @@ -655,3 +657,34 @@ Visitor *qobject_input_visitor_new_keyval(QObject *obj)
>  
>      return &v->visitor;
>  }
> +
> +Visitor *qobject_input_visitor_new_str(const char *str,
> +                                       const char *implied_key,
> +                                       Error **errp)
> +{
> +    bool is_json = str[0] == '{';
> +    QObject *obj;
> +    QDict *args;
> +    Visitor *v;
> +
> +    if (is_json) {
> +        obj = qobject_from_json(str, errp);
> +        if (!obj) {
> +            /* Work around qobject_from_json() lossage TODO fix that */
> +            if (errp && !*errp) {
> +                error_setg(errp, "JSON parse error");
> +                return NULL;
> +            }
> +            return NULL;
> +        }
> +        args = qobject_to_qdict(obj);
> +        assert(args);
> +        v = qobject_input_visitor_new(QOBJECT(args));
> +    } else {
> +        args = keyval_parse(optarg, implied_key, errp);

No, you don't mean optarg.

Makes all attempts to use -blockdev segfault for me.

> +        v = qobject_input_visitor_new_keyval(QOBJECT(args));
> +    }
> +    QDECREF(args);
> +
> +    return v;
> +}

Kevin
Markus Armbruster Feb. 28, 2017, 6:45 p.m. UTC | #3
Kevin Wolf <kwolf@redhat.com> writes:

> Am 27.02.2017 um 12:20 hat Markus Armbruster geschrieben:
>> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>> ---
>>  include/qapi/qobject-input-visitor.h | 12 ++++++++++++
>>  qapi/qobject-input-visitor.c         | 33 +++++++++++++++++++++++++++++++++
>>  2 files changed, 45 insertions(+)
>> 
>> diff --git a/include/qapi/qobject-input-visitor.h b/include/qapi/qobject-input-visitor.h
>> index 282f9d2..b399285 100644
>> --- a/include/qapi/qobject-input-visitor.h
>> +++ b/include/qapi/qobject-input-visitor.h
>> @@ -68,4 +68,16 @@ Visitor *qobject_input_visitor_new(QObject *obj);
>>   */
>>  Visitor *qobject_input_visitor_new_keyval(QObject *obj);
>>  
>> +/*
>> + * Create a QObject input visitor for parsing @str.
>> + *
>> + * If @str looks like JSON, parse it as JSON, else as KEY=VALUE,...
>> + * @implied_key applies to KEY=VALUE, and works as in keyval_parse().
>> + * On failure, store an error through @errp and return NULL.
>> + * On success, return a new QObject input visitor for the parse.
>> + */
>> +Visitor *qobject_input_visitor_new_str(const char *str,
>> +                                       const char *implied_key,
>> +                                       Error **errp);
>> +
>>  #endif
>> diff --git a/qapi/qobject-input-visitor.c b/qapi/qobject-input-visitor.c
>> index 3db5850..64a08d3 100644
>> --- a/qapi/qobject-input-visitor.c
>> +++ b/qapi/qobject-input-visitor.c
>> @@ -18,9 +18,11 @@
>>  #include "qapi/visitor-impl.h"
>>  #include "qemu/queue.h"
>>  #include "qemu-common.h"
>> +#include "qapi/qmp/qjson.h"
>>  #include "qapi/qmp/types.h"
>>  #include "qapi/qmp/qerror.h"
>>  #include "qemu/cutils.h"
>> +#include "qemu/option.h"
>>  
>>  typedef struct StackObject {
>>      const char *name;            /* Name of @obj in its parent, if any */
>> @@ -655,3 +657,34 @@ Visitor *qobject_input_visitor_new_keyval(QObject *obj)
>>  
>>      return &v->visitor;
>>  }
>> +
>> +Visitor *qobject_input_visitor_new_str(const char *str,
>> +                                       const char *implied_key,
>> +                                       Error **errp)
>> +{
>> +    bool is_json = str[0] == '{';
>> +    QObject *obj;
>> +    QDict *args;
>> +    Visitor *v;
>> +
>> +    if (is_json) {
>> +        obj = qobject_from_json(str, errp);
>> +        if (!obj) {
>> +            /* Work around qobject_from_json() lossage TODO fix that */
>> +            if (errp && !*errp) {
>> +                error_setg(errp, "JSON parse error");
>> +                return NULL;
>> +            }
>> +            return NULL;
>> +        }
>> +        args = qobject_to_qdict(obj);
>> +        assert(args);
>> +        v = qobject_input_visitor_new(QOBJECT(args));
>> +    } else {
>> +        args = keyval_parse(optarg, implied_key, errp);
>
> No, you don't mean optarg.
>
> Makes all attempts to use -blockdev segfault for me.

Okay, I guess I get to stay after class and write "Late night last
minute changes are a bad idea" one hundred times.

Including the kitchen sink can hide stupid bugs...

>
>> +        v = qobject_input_visitor_new_keyval(QOBJECT(args));
>> +    }
>> +    QDECREF(args);
>> +
>> +    return v;
>> +}
>
> Kevin
Markus Armbruster Feb. 28, 2017, 6:48 p.m. UTC | #4
Kevin Wolf <kwolf@redhat.com> writes:

> Am 27.02.2017 um 12:20 hat Markus Armbruster geschrieben:
>> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>> ---
>>  include/qapi/qobject-input-visitor.h | 12 ++++++++++++
>>  qapi/qobject-input-visitor.c         | 33 +++++++++++++++++++++++++++++++++
>>  2 files changed, 45 insertions(+)
>> 
>> diff --git a/include/qapi/qobject-input-visitor.h b/include/qapi/qobject-input-visitor.h
>> index 282f9d2..b399285 100644
>> --- a/include/qapi/qobject-input-visitor.h
>> +++ b/include/qapi/qobject-input-visitor.h
>> @@ -68,4 +68,16 @@ Visitor *qobject_input_visitor_new(QObject *obj);
>>   */
>>  Visitor *qobject_input_visitor_new_keyval(QObject *obj);
>>  
>> +/*
>> + * Create a QObject input visitor for parsing @str.
>> + *
>> + * If @str looks like JSON, parse it as JSON, else as KEY=VALUE,...
>> + * @implied_key applies to KEY=VALUE, and works as in keyval_parse().
>> + * On failure, store an error through @errp and return NULL.
>> + * On success, return a new QObject input visitor for the parse.
>> + */
>> +Visitor *qobject_input_visitor_new_str(const char *str,
>> +                                       const char *implied_key,
>> +                                       Error **errp);
>> +
>>  #endif
>> diff --git a/qapi/qobject-input-visitor.c b/qapi/qobject-input-visitor.c
>> index 3db5850..64a08d3 100644
>> --- a/qapi/qobject-input-visitor.c
>> +++ b/qapi/qobject-input-visitor.c
>> @@ -18,9 +18,11 @@
>>  #include "qapi/visitor-impl.h"
>>  #include "qemu/queue.h"
>>  #include "qemu-common.h"
>> +#include "qapi/qmp/qjson.h"
>>  #include "qapi/qmp/types.h"
>>  #include "qapi/qmp/qerror.h"
>>  #include "qemu/cutils.h"
>> +#include "qemu/option.h"
>>  
>>  typedef struct StackObject {
>>      const char *name;            /* Name of @obj in its parent, if any */
>> @@ -655,3 +657,34 @@ Visitor *qobject_input_visitor_new_keyval(QObject *obj)
>>  
>>      return &v->visitor;
>>  }
>> +
>> +Visitor *qobject_input_visitor_new_str(const char *str,
>> +                                       const char *implied_key,
>> +                                       Error **errp)
>> +{
>> +    bool is_json = str[0] == '{';
>
> Should the keyval_parse() grammar just forbid { in key names then (and
> ideally employ assertions to enforce this) to avoid any ambiguity here?
> therwise the behaviour might depend on the order of options in a
> key/value string, which could be somewhat confusing.

You're absolutely right.  Fortunately, PATCH 23 does.  I guess the
easiest fix is to move it before this one.

>> +    QObject *obj;
>> +    QDict *args;
>> +    Visitor *v;
>> +
>> +    if (is_json) {
>> +        obj = qobject_from_json(str, errp);
>> +        if (!obj) {
>> +            /* Work around qobject_from_json() lossage TODO fix that */
>> +            if (errp && !*errp) {
>> +                error_setg(errp, "JSON parse error");
>> +                return NULL;
>> +            }
>> +            return NULL;
>> +        }
>> +        args = qobject_to_qdict(obj);
>> +        assert(args);
>> +        v = qobject_input_visitor_new(QOBJECT(args));
>> +    } else {
>> +        args = keyval_parse(optarg, implied_key, errp);
>> +        v = qobject_input_visitor_new_keyval(QOBJECT(args));
>
> If keyval_parse() fails and returns args == NULL, won't we run into the
> assertion in qobject_input_visitor_base_new() now?

Lacks error checking, will fix.

>> +    }
>> +    QDECREF(args);
>> +
>> +    return v;
>> +}
>
> Kevin

Thanks!
Kevin Wolf Feb. 28, 2017, 7:29 p.m. UTC | #5
Am 28.02.2017 um 19:48 hat Markus Armbruster geschrieben:
> Kevin Wolf <kwolf@redhat.com> writes:
> 
> > Am 27.02.2017 um 12:20 hat Markus Armbruster geschrieben:
> >> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> >> ---
> >>  include/qapi/qobject-input-visitor.h | 12 ++++++++++++
> >>  qapi/qobject-input-visitor.c         | 33 +++++++++++++++++++++++++++++++++
> >>  2 files changed, 45 insertions(+)
> >> 
> >> diff --git a/include/qapi/qobject-input-visitor.h b/include/qapi/qobject-input-visitor.h
> >> index 282f9d2..b399285 100644
> >> --- a/include/qapi/qobject-input-visitor.h
> >> +++ b/include/qapi/qobject-input-visitor.h
> >> @@ -68,4 +68,16 @@ Visitor *qobject_input_visitor_new(QObject *obj);
> >>   */
> >>  Visitor *qobject_input_visitor_new_keyval(QObject *obj);
> >>  
> >> +/*
> >> + * Create a QObject input visitor for parsing @str.
> >> + *
> >> + * If @str looks like JSON, parse it as JSON, else as KEY=VALUE,...
> >> + * @implied_key applies to KEY=VALUE, and works as in keyval_parse().
> >> + * On failure, store an error through @errp and return NULL.
> >> + * On success, return a new QObject input visitor for the parse.
> >> + */
> >> +Visitor *qobject_input_visitor_new_str(const char *str,
> >> +                                       const char *implied_key,
> >> +                                       Error **errp);
> >> +
> >>  #endif
> >> diff --git a/qapi/qobject-input-visitor.c b/qapi/qobject-input-visitor.c
> >> index 3db5850..64a08d3 100644
> >> --- a/qapi/qobject-input-visitor.c
> >> +++ b/qapi/qobject-input-visitor.c
> >> @@ -18,9 +18,11 @@
> >>  #include "qapi/visitor-impl.h"
> >>  #include "qemu/queue.h"
> >>  #include "qemu-common.h"
> >> +#include "qapi/qmp/qjson.h"
> >>  #include "qapi/qmp/types.h"
> >>  #include "qapi/qmp/qerror.h"
> >>  #include "qemu/cutils.h"
> >> +#include "qemu/option.h"
> >>  
> >>  typedef struct StackObject {
> >>      const char *name;            /* Name of @obj in its parent, if any */
> >> @@ -655,3 +657,34 @@ Visitor *qobject_input_visitor_new_keyval(QObject *obj)
> >>  
> >>      return &v->visitor;
> >>  }
> >> +
> >> +Visitor *qobject_input_visitor_new_str(const char *str,
> >> +                                       const char *implied_key,
> >> +                                       Error **errp)
> >> +{
> >> +    bool is_json = str[0] == '{';
> >
> > Should the keyval_parse() grammar just forbid { in key names then (and
> > ideally employ assertions to enforce this) to avoid any ambiguity here?
> > therwise the behaviour might depend on the order of options in a
> > key/value string, which could be somewhat confusing.
> 
> You're absolutely right.  Fortunately, PATCH 23 does.  I guess the
> easiest fix is to move it before this one.

Don't bother. I'm just reviewing the patches in order, so I didn't see
at this point that there is a fix in a later patch.

Kevin
diff mbox

Patch

diff --git a/include/qapi/qobject-input-visitor.h b/include/qapi/qobject-input-visitor.h
index 282f9d2..b399285 100644
--- a/include/qapi/qobject-input-visitor.h
+++ b/include/qapi/qobject-input-visitor.h
@@ -68,4 +68,16 @@  Visitor *qobject_input_visitor_new(QObject *obj);
  */
 Visitor *qobject_input_visitor_new_keyval(QObject *obj);
 
+/*
+ * Create a QObject input visitor for parsing @str.
+ *
+ * If @str looks like JSON, parse it as JSON, else as KEY=VALUE,...
+ * @implied_key applies to KEY=VALUE, and works as in keyval_parse().
+ * On failure, store an error through @errp and return NULL.
+ * On success, return a new QObject input visitor for the parse.
+ */
+Visitor *qobject_input_visitor_new_str(const char *str,
+                                       const char *implied_key,
+                                       Error **errp);
+
 #endif
diff --git a/qapi/qobject-input-visitor.c b/qapi/qobject-input-visitor.c
index 3db5850..64a08d3 100644
--- a/qapi/qobject-input-visitor.c
+++ b/qapi/qobject-input-visitor.c
@@ -18,9 +18,11 @@ 
 #include "qapi/visitor-impl.h"
 #include "qemu/queue.h"
 #include "qemu-common.h"
+#include "qapi/qmp/qjson.h"
 #include "qapi/qmp/types.h"
 #include "qapi/qmp/qerror.h"
 #include "qemu/cutils.h"
+#include "qemu/option.h"
 
 typedef struct StackObject {
     const char *name;            /* Name of @obj in its parent, if any */
@@ -655,3 +657,34 @@  Visitor *qobject_input_visitor_new_keyval(QObject *obj)
 
     return &v->visitor;
 }
+
+Visitor *qobject_input_visitor_new_str(const char *str,
+                                       const char *implied_key,
+                                       Error **errp)
+{
+    bool is_json = str[0] == '{';
+    QObject *obj;
+    QDict *args;
+    Visitor *v;
+
+    if (is_json) {
+        obj = qobject_from_json(str, errp);
+        if (!obj) {
+            /* Work around qobject_from_json() lossage TODO fix that */
+            if (errp && !*errp) {
+                error_setg(errp, "JSON parse error");
+                return NULL;
+            }
+            return NULL;
+        }
+        args = qobject_to_qdict(obj);
+        assert(args);
+        v = qobject_input_visitor_new(QOBJECT(args));
+    } else {
+        args = keyval_parse(optarg, implied_key, errp);
+        v = qobject_input_visitor_new_keyval(QOBJECT(args));
+    }
+    QDECREF(args);
+
+    return v;
+}