Commit 51e72bc1 authored by Eric Blake's avatar Eric Blake Committed by Markus Armbruster
Browse files

qapi: Swap visit_* arguments for consistent 'name' placement 



JSON uses "name":value, but many of our visitor interfaces were
called with visit_type_FOO(v, &value, name, errp).  This can be
a bit confusing to have to mentally swap the parameter order to
match JSON order.  It's particularly bad for visit_start_struct(),
where the 'name' parameter is smack in the middle of the
otherwise-related group of 'obj, kind, size' parameters! It's
time to do a global swap of the parameter ordering, so that the
'name' parameter is always immediately after the Visitor argument.

Additional reason in favor of the swap: the existing include/qjson.h
prefers listing 'name' first in json_prop_*(), and I have plans to
unify that file with the qapi visitors; listing 'name' first in
qapi will minimize churn to the (admittedly few) qjson.h clients.

Later patches will then fix docs, object.h, visitor-impl.h, and
those clients to match.

Done by first patching scripts/qapi*.py by hand to make generated
files do what I want, then by running the following Coccinelle
script to affect the rest of the code base:
 $ spatch --sp-file script `git grep -l '\bvisit_' -- '**/*.[ch]'`
I then had to apply some touchups (Coccinelle insisted on TAB
indentation in visitor.h, and botched the signature of
visit_type_enum() by rewriting 'const char *const strings[]' to
the syntactically invalid 'const char*const[] strings').  The
movement of parameters is sufficient to provoke compiler errors
if any callers were missed.

    // Part 1: Swap declaration order
    @@
    type TV, TErr, TObj, T1, T2;
    identifier OBJ, ARG1, ARG2;
    @@
     void visit_start_struct
    -(TV v, TObj OBJ, T1 ARG1, const char *name, T2 ARG2, TErr errp)
    +(TV v, const char *name, TObj OBJ, T1 ARG1, T2 ARG2, TErr errp)
     { ... }

    @@
    type bool, TV, T1;
    identifier ARG1;
    @@
     bool visit_optional
    -(TV v, T1 ARG1, const char *name)
    +(TV v, const char *name, T1 ARG1)
     { ... }

    @@
    type TV, TErr, TObj, T1;
    identifier OBJ, ARG1;
    @@
     void visit_get_next_type
    -(TV v, TObj OBJ, T1 ARG1, const char *name, TErr errp)
    +(TV v, const char *name, TObj OBJ, T1 ARG1, TErr errp)
     { ... }

    @@
    type TV, TErr, TObj, T1, T2;
    identifier OBJ, ARG1, ARG2;
    @@
     void visit_type_enum
    -(TV v, TObj OBJ, T1 ARG1, T2 ARG2, const char *name, TErr errp)
    +(TV v, const char *name, TObj OBJ, T1 ARG1, T2 ARG2, TErr errp)
     { ... }

    @@
    type TV, TErr, TObj;
    identifier OBJ;
    identifier VISIT_TYPE =~ "^visit_type_";
    @@
     void VISIT_TYPE
    -(TV v, TObj OBJ, const char *name, TErr errp)
    +(TV v, const char *name, TObj OBJ, TErr errp)
     { ... }

    // Part 2: swap caller order
    @@
    expression V, NAME, OBJ, ARG1, ARG2, ERR;
    identifier VISIT_TYPE =~ "^visit_type_";
    @@
    (
    -visit_start_struct(V, OBJ, ARG1, NAME, ARG2, ERR)
    +visit_start_struct(V, NAME, OBJ, ARG1, ARG2, ERR)
    |
    -visit_optional(V, ARG1, NAME)
    +visit_optional(V, NAME, ARG1)
    |
    -visit_get_next_type(V, OBJ, ARG1, NAME, ERR)
    +visit_get_next_type(V, NAME, OBJ, ARG1, ERR)
    |
    -visit_type_enum(V, OBJ, ARG1, ARG2, NAME, ERR)
    +visit_type_enum(V, NAME, OBJ, ARG1, ARG2, ERR)
    |
    -VISIT_TYPE(V, OBJ, NAME, ERR)
    +VISIT_TYPE(V, NAME, OBJ, ERR)
    )

Signed-off-by: default avatarEric Blake <eblake@redhat.com>
Reviewed-by: default avatarMarc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <1454075341-13658-19-git-send-email-eblake@redhat.com>
Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
parent 4fa45492

backends/hostmem.c

+4 −4
Original line number Diff line number Diff line
@@ -33,7 +33,7 @@ host_memory_backend_get_size(Object *obj, Visitor *v, void *opaque, 
    HostMemoryBackend *backend = MEMORY_BACKEND(obj);

    uint64_t value = backend->size;



    visit_type_size(v, &value, name, errp);

    visit_type_size(v, name, &value, errp);

}



static void
@@ -49,7 +49,7 @@ host_memory_backend_set_size(Object *obj, Visitor *v, void *opaque, 
        goto out;

    }



    visit_type_size(v, &value, name, &local_err);

    visit_type_size(v, name, &value, &local_err);

    if (local_err) {

        goto out;

    }
@@ -92,7 +92,7 @@ host_memory_backend_get_host_nodes(Object *obj, Visitor *v, void *opaque, 
        node = &(*node)->next;

    } while (true);



    visit_type_uint16List(v, &host_nodes, name, errp);

    visit_type_uint16List(v, name, &host_nodes, errp);

}



static void
@@ -103,7 +103,7 @@ host_memory_backend_set_host_nodes(Object *obj, Visitor *v, void *opaque, 
    HostMemoryBackend *backend = MEMORY_BACKEND(obj);

    uint16List *l = NULL;



    visit_type_uint16List(v, &l, name, errp);

    visit_type_uint16List(v, name, &l, errp);



    while (l) {

        bitmap_set(backend->host_nodes, l->value, 1);

block/qapi.c

+1 −1
Original line number Diff line number Diff line
@@ -641,7 +641,7 @@ void bdrv_image_info_specific_dump(fprintf_function func_fprintf, void *f, 
    QmpOutputVisitor *ov = qmp_output_visitor_new();

    QObject *obj, *data;



    visit_type_ImageInfoSpecific(qmp_output_get_visitor(ov), &info_spec, NULL,

    visit_type_ImageInfoSpecific(qmp_output_get_visitor(ov), NULL, &info_spec,

                                 &error_abort);

    obj = qmp_output_get_qobject(ov);

    assert(qobject_type(obj) == QTYPE_QDICT);

blockdev.c

+2 −2
Original line number Diff line number Diff line
@@ -3860,8 +3860,8 @@ void qmp_blockdev_add(BlockdevOptions *options, Error **errp) 
        }

    }



    visit_type_BlockdevOptions(qmp_output_get_visitor(ov),

                               &options, NULL, &local_err);

    visit_type_BlockdevOptions(qmp_output_get_visitor(ov), NULL, &options,

                               &local_err);

    if (local_err) {

        error_propagate(errp, local_err);

        goto fail;

bootdevice.c

+2 −2
Original line number Diff line number Diff line
@@ -275,7 +275,7 @@ static void device_get_bootindex(Object *obj, Visitor *v, void *opaque, 
                                 const char *name, Error **errp)

{

    BootIndexProperty *prop = opaque;

    visit_type_int32(v, prop->bootindex, name, errp);

    visit_type_int32(v, name, prop->bootindex, errp);

}



static void device_set_bootindex(Object *obj, Visitor *v, void *opaque,
@@ -285,7 +285,7 @@ static void device_set_bootindex(Object *obj, Visitor *v, void *opaque, 
    int32_t boot_index;

    Error *local_err = NULL;



    visit_type_int32(v, &boot_index, name, &local_err);

    visit_type_int32(v, name, &boot_index, &local_err);

    if (local_err) {

        goto out;

    }

hmp.c

+4 −4
Original line number Diff line number Diff line
@@ -1676,13 +1676,13 @@ void hmp_object_add(Monitor *mon, const QDict *qdict) 
    }



    qdict_del(pdict, "qom-type");

    visit_type_str(v, &type, "qom-type", &err);

    visit_type_str(v, "qom-type", &type, &err);

    if (err) {

        goto out_end;

    }



    qdict_del(pdict, "id");

    visit_type_str(v, &id, "id", &err);

    visit_type_str(v, "id", &id, &err);

    if (err) {

        goto out_end;

    }
@@ -1948,8 +1948,8 @@ void hmp_info_memdev(Monitor *mon, const QDict *qdict) 


    while (m) {

        ov = string_output_visitor_new(false);

        visit_type_uint16List(string_output_get_visitor(ov),

                              &m->value->host_nodes, NULL, NULL);

        visit_type_uint16List(string_output_get_visitor(ov), NULL,

                              &m->value->host_nodes, NULL);

        monitor_printf(mon, "memory backend: %d\n", i);

        monitor_printf(mon, "  size:  %" PRId64 "\n", m->value->size);

        monitor_printf(mon, "  merge: %s\n",