[Qemu-devel] [PATCH v4 08/28] qmp-input-visitor: Favor new visit_free() function

[Eric Blake]

Now that we have a polymorphic visit_free(), we no longer need
qmp_input_visitor_cleanup(); which in turn means we no longer
need to return a subtype from qmp_input_visitor_new() nor a
public upcast function.

Generated code changes to qmp-marshal look like:

|@@ -52,11 +52,10 @@ void qmp_marshal_add_fd(QDict *args, QOb
| {
|     Error *err = NULL;
|     AddfdInfo *retval;
|-    QmpInputVisitor *qiv = qmp_input_visitor_new(QOBJECT(args), true);
|     Visitor *v;
|     q_obj_add_fd_arg arg = {0};
|
|-    v = qmp_input_get_visitor(qiv);
|+    v = qmp_input_visitor_new(QOBJECT(args), true);
|     visit_start_struct(v, NULL, NULL, 0, &err);
|     if (err) {
|         goto out;

Signed-off-by: Eric Blake <address@hidden>

---
v4: new patch
---
 scripts/qapi-commands.py           |  3 +--
 include/qapi/qmp-input-visitor.h   |  6 +-----
 qapi/qmp-input-visitor.c           | 17 ++++-------------
 qmp.c                              |  9 ++++-----
 qom/qom-qobject.c                  |  9 ++++-----
 replay/replay-input.c              |  6 ++----
 tests/check-qnull.c                |  6 +++---
 tests/test-qmp-commands.c          |  8 ++++----
 tests/test-qmp-input-strict.c      | 12 +++---------
 tests/test-qmp-input-visitor.c     | 12 +++---------
 tests/test-visitor-serialization.c |  6 +++---
 util/qemu-sockets.c                |  6 ++----
 docs/qapi-code-gen.txt             |  3 +--
 13 files changed, 35 insertions(+), 68 deletions(-)

diff --git a/scripts/qapi-commands.py b/scripts/qapi-commands.py
index 77ecd47..49d4ce2 100644
--- a/scripts/qapi-commands.py
+++ b/scripts/qapi-commands.py
@@ -113,11 +113,10 @@ def gen_marshal(name, arg_type, ret_type):

     if arg_type and arg_type.members:
         ret += mcgen('''
-    QmpInputVisitor *qiv = qmp_input_visitor_new(QOBJECT(args), true);
     Visitor *v;
     %(c_name)s arg = {0};

-    v = qmp_input_get_visitor(qiv);
+    v = qmp_input_visitor_new(QOBJECT(args), true);
     visit_start_struct(v, NULL, NULL, 0, &err);
     if (err) {
         goto out;
diff --git a/include/qapi/qmp-input-visitor.h b/include/qapi/qmp-input-visitor.h
index b0624d8..f3ff5f3 100644
--- a/include/qapi/qmp-input-visitor.h
+++ b/include/qapi/qmp-input-visitor.h
@@ -25,10 +25,6 @@ typedef struct QmpInputVisitor QmpInputVisitor;
  * Set @strict to reject a parse that doesn't consume all keys of a
  * dictionary; otherwise excess input is ignored.
  */
-QmpInputVisitor *qmp_input_visitor_new(QObject *obj, bool strict);
-
-void qmp_input_visitor_cleanup(QmpInputVisitor *v);
-
-Visitor *qmp_input_get_visitor(QmpInputVisitor *v);
+Visitor *qmp_input_visitor_new(QObject *obj, bool strict);

 #endif
diff --git a/qapi/qmp-input-visitor.c b/qapi/qmp-input-visitor.c
index 3ca192e..cb128e2 100644
--- a/qapi/qmp-input-visitor.c
+++ b/qapi/qmp-input-visitor.c
@@ -370,24 +370,15 @@ static void qmp_input_optional(Visitor *v, const char 
*name, bool *present)
     *present = true;
 }

-Visitor *qmp_input_get_visitor(QmpInputVisitor *v)
-{
-    return &v->visitor;
-}
-
 static void qmp_input_free(Visitor *v)
 {
     QmpInputVisitor *qiv = to_qiv(v);
-    qmp_input_visitor_cleanup(qiv);
-}

-void qmp_input_visitor_cleanup(QmpInputVisitor *v)
-{
-    qobject_decref(v->root);
-    g_free(v);
+    qobject_decref(qiv->root);
+    g_free(qiv);
 }

-QmpInputVisitor *qmp_input_visitor_new(QObject *obj, bool strict)
+Visitor *qmp_input_visitor_new(QObject *obj, bool strict)
 {
     QmpInputVisitor *v;

@@ -415,5 +406,5 @@ QmpInputVisitor *qmp_input_visitor_new(QObject *obj, bool 
strict)
     v->root = obj;
     qobject_incref(obj);

-    return v;
+    return &v->visitor;
 }
diff --git a/qmp.c b/qmp.c
index e784a67..8c7a051 100644
--- a/qmp.c
+++ b/qmp.c
@@ -652,7 +652,7 @@ void qmp_object_add(const char *type, const char *id,
                     bool has_props, QObject *props, Error **errp)
 {
     const QDict *pdict = NULL;
-    QmpInputVisitor *qiv;
+    Visitor *v;
     Object *obj;

     if (props) {
@@ -663,10 +663,9 @@ void qmp_object_add(const char *type, const char *id,
         }
     }

-    qiv = qmp_input_visitor_new(props, true);
-    obj = user_creatable_add_type(type, id, pdict,
-                                  qmp_input_get_visitor(qiv), errp);
-    qmp_input_visitor_cleanup(qiv);
+    v = qmp_input_visitor_new(props, true);
+    obj = user_creatable_add_type(type, id, pdict, v, errp);
+    visit_free(v);
     if (obj) {
         object_unref(obj);
     }
diff --git a/qom/qom-qobject.c b/qom/qom-qobject.c
index b66088d..c3c9188 100644
--- a/qom/qom-qobject.c
+++ b/qom/qom-qobject.c
@@ -21,12 +21,11 @@
 void object_property_set_qobject(Object *obj, QObject *value,
                                  const char *name, Error **errp)
 {
-    QmpInputVisitor *qiv;
+    Visitor *v;
     /* TODO: Should we reject, rather than ignore, excess input? */
-    qiv = qmp_input_visitor_new(value, false);
-    object_property_set(obj, qmp_input_get_visitor(qiv), name, errp);
-
-    qmp_input_visitor_cleanup(qiv);
+    v = qmp_input_visitor_new(value, false);
+    object_property_set(obj, v, name, errp);
+    visit_free(v);
 }

 QObject *object_property_get_qobject(Object *obj, const char *name,
diff --git a/replay/replay-input.c b/replay/replay-input.c
index 03e99d5..7b6fa93 100644
--- a/replay/replay-input.c
+++ b/replay/replay-input.c
@@ -23,7 +23,6 @@
 static InputEvent *qapi_clone_InputEvent(InputEvent *src)
 {
     QmpOutputVisitor *qov;
-    QmpInputVisitor *qiv;
     Visitor *ov, *iv;
     QObject *obj;
     InputEvent *dst = NULL;
@@ -37,10 +36,9 @@ static InputEvent *qapi_clone_InputEvent(InputEvent *src)
         return NULL;
     }

-    qiv = qmp_input_visitor_new(obj, true);
-    iv = qmp_input_get_visitor(qiv);
+    iv = qmp_input_visitor_new(obj, true);
     visit_type_InputEvent(iv, NULL, &dst, &error_abort);
-    qmp_input_visitor_cleanup(qiv);
+    visit_free(iv);
     qobject_decref(obj);

     return dst;
diff --git a/tests/check-qnull.c b/tests/check-qnull.c
index fd9c68f..c8021dc 100644
--- a/tests/check-qnull.c
+++ b/tests/check-qnull.c
@@ -39,7 +39,7 @@ static void qnull_visit_test(void)
 {
     QObject *obj;
     QmpOutputVisitor *qov;
-    QmpInputVisitor *qiv;
+    Visitor *qiv;

     /*
      * Most tests of interactions between QObject and visitors are in
@@ -51,8 +51,8 @@ static void qnull_visit_test(void)
     obj = qnull();
     qiv = qmp_input_visitor_new(obj, true);
     qobject_decref(obj);
-    visit_type_null(qmp_input_get_visitor(qiv), NULL, &error_abort);
-    qmp_input_visitor_cleanup(qiv);
+    visit_type_null(qiv, NULL, &error_abort);
+    visit_free(qiv);

     qov = qmp_output_visitor_new();
     visit_type_null(qmp_output_get_visitor(qov), NULL, &error_abort);
diff --git a/tests/test-qmp-commands.c b/tests/test-qmp-commands.c
index 5c3edd7..87fc759 100644
--- a/tests/test-qmp-commands.c
+++ b/tests/test-qmp-commands.c
@@ -217,14 +217,14 @@ static void test_dealloc_partial(void)
     /* create partial object */
     {
         QDict *ud2_dict;
-        QmpInputVisitor *qiv;
+        Visitor *v;

         ud2_dict = qdict_new();
         qdict_put_obj(ud2_dict, "string0", QOBJECT(qstring_from_str(text)));

-        qiv = qmp_input_visitor_new(QOBJECT(ud2_dict), true);
-        visit_type_UserDefTwo(qmp_input_get_visitor(qiv), NULL, &ud2, &err);
-        qmp_input_visitor_cleanup(qiv);
+        v = qmp_input_visitor_new(QOBJECT(ud2_dict), true);
+        visit_type_UserDefTwo(v, NULL, &ud2, &err);
+        visit_free(v);
         QDECREF(ud2_dict);
     }

diff --git a/tests/test-qmp-input-strict.c b/tests/test-qmp-input-strict.c
index edb4b31..89947f5 100644
--- a/tests/test-qmp-input-strict.c
+++ b/tests/test-qmp-input-strict.c
@@ -27,7 +27,7 @@

 typedef struct TestInputVisitorData {
     QObject *obj;
-    QmpInputVisitor *qiv;
+    Visitor *qiv;
 } TestInputVisitorData;

 static void validate_teardown(TestInputVisitorData *data,
@@ -37,7 +37,7 @@ static void validate_teardown(TestInputVisitorData *data,
     data->obj = NULL;

     if (data->qiv) {
-        qmp_input_visitor_cleanup(data->qiv);
+        visit_free(data->qiv);
         data->qiv = NULL;
     }
 }
@@ -49,8 +49,6 @@ static Visitor 
*validate_test_init_internal(TestInputVisitorData *data,
                                             const char *json_string,
                                             va_list *ap)
 {
-    Visitor *v;
-
     validate_teardown(data, NULL);

     data->obj = qobject_from_jsonv(json_string, ap);
@@ -58,11 +56,7 @@ static Visitor 
*validate_test_init_internal(TestInputVisitorData *data,

     data->qiv = qmp_input_visitor_new(data->obj, true);
     g_assert(data->qiv);
-
-    v = qmp_input_get_visitor(data->qiv);
-    g_assert(v);
-
-    return v;
+    return data->qiv;
 }

 static GCC_FMT_ATTR(2, 3)
diff --git a/tests/test-qmp-input-visitor.c b/tests/test-qmp-input-visitor.c
index 56ee943..9137e10 100644
--- a/tests/test-qmp-input-visitor.c
+++ b/tests/test-qmp-input-visitor.c
@@ -23,7 +23,7 @@

 typedef struct TestInputVisitorData {
     QObject *obj;
-    QmpInputVisitor *qiv;
+    Visitor *qiv;
 } TestInputVisitorData;

 static void visitor_input_teardown(TestInputVisitorData *data,
@@ -33,7 +33,7 @@ static void visitor_input_teardown(TestInputVisitorData *data,
     data->obj = NULL;

     if (data->qiv) {
-        qmp_input_visitor_cleanup(data->qiv);
+        visit_free(data->qiv);
         data->qiv = NULL;
     }
 }
@@ -45,8 +45,6 @@ static Visitor 
*visitor_input_test_init_internal(TestInputVisitorData *data,
                                                  const char *json_string,
                                                  va_list *ap)
 {
-    Visitor *v;
-
     visitor_input_teardown(data, NULL);

     data->obj = qobject_from_jsonv(json_string, ap);
@@ -54,11 +52,7 @@ static Visitor 
*visitor_input_test_init_internal(TestInputVisitorData *data,

     data->qiv = qmp_input_visitor_new(data->obj, false);
     g_assert(data->qiv);
-
-    v = qmp_input_get_visitor(data->qiv);
-    g_assert(v);
-
-    return v;
+    return data->qiv;
 }

 static GCC_FMT_ATTR(2, 3)
diff --git a/tests/test-visitor-serialization.c 
b/tests/test-visitor-serialization.c
index 49107f7..bc1afd3 100644
--- a/tests/test-visitor-serialization.c
+++ b/tests/test-visitor-serialization.c
@@ -1014,7 +1014,7 @@ static PrimitiveType pt_values[] = {

 typedef struct QmpSerializeData {
     QmpOutputVisitor *qov;
-    QmpInputVisitor *qiv;
+    Visitor *qiv;
 } QmpSerializeData;

 static void qmp_serialize(void *native_in, void **datap,
@@ -1042,14 +1042,14 @@ static void qmp_deserialize(void **native_out, void 
*datap,
     d->qiv = qmp_input_visitor_new(obj, true);
     qobject_decref(obj_orig);
     qobject_decref(obj);
-    visit(qmp_input_get_visitor(d->qiv), native_out, errp);
+    visit(d->qiv, native_out, errp);
 }

 static void qmp_cleanup(void *datap)
 {
     QmpSerializeData *d = datap;
     qmp_output_visitor_cleanup(d->qov);
-    qmp_input_visitor_cleanup(d->qiv);
+    visit_free(d->qiv);

     g_free(d);
 }
diff --git a/util/qemu-sockets.c b/util/qemu-sockets.c
index 2a2c524..5b55eb2 100644
--- a/util/qemu-sockets.c
+++ b/util/qemu-sockets.c
@@ -1130,7 +1130,6 @@ void qapi_copy_SocketAddress(SocketAddress **p_dest,
                              SocketAddress *src)
 {
     QmpOutputVisitor *qov;
-    QmpInputVisitor *qiv;
     Visitor *ov, *iv;
     QObject *obj;

@@ -1145,9 +1144,8 @@ void qapi_copy_SocketAddress(SocketAddress **p_dest,
         return;
     }

-    qiv = qmp_input_visitor_new(obj, true);
-    iv = qmp_input_get_visitor(qiv);
+    iv = qmp_input_visitor_new(obj, true);
     visit_type_SocketAddress(iv, NULL, p_dest, &error_abort);
-    qmp_input_visitor_cleanup(qiv);
+    visit_free(iv);
     qobject_decref(obj);
 }
diff --git a/docs/qapi-code-gen.txt b/docs/qapi-code-gen.txt
index 2830e02..aefc29e 100644
--- a/docs/qapi-code-gen.txt
+++ b/docs/qapi-code-gen.txt
@@ -1002,11 +1002,10 @@ Example:
     {
         Error *err = NULL;
         UserDefOne *retval;
-        QmpInputVisitor *qiv = qmp_input_visitor_new(QOBJECT(args), true);
         Visitor *v;
         UserDefOneList *arg1 = NULL;

-        v = qmp_input_get_visitor(qiv);
+        v = qmp_input_visitor_new(QOBJECT(args), true);
         visit_start_struct(v, NULL, NULL, 0, &err);
         if (err) {
             goto out;
-- 
2.5.5